This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Use Unicode 11.0
[perl5.git] / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #  include "INTERN.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 EXTERN_C const struct regexp_engine my_reg_engine;
85 #else
86 #  include "regcomp.h"
87 #endif
88
89 #include "dquote_inline.h"
90 #include "invlist_inline.h"
91 #include "unicode_constants.h"
92
93 #define HAS_NONLATIN1_FOLD_CLOSURE(i) \
94  _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
96  _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
97 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
98 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
99
100 #ifndef STATIC
101 #define STATIC  static
102 #endif
103
104 /* this is a chain of data about sub patterns we are processing that
105    need to be handled separately/specially in study_chunk. Its so
106    we can simulate recursion without losing state.  */
107 struct scan_frame;
108 typedef struct scan_frame {
109     regnode *last_regnode;      /* last node to process in this frame */
110     regnode *next_regnode;      /* next node to process when last is reached */
111     U32 prev_recursed_depth;
112     I32 stopparen;              /* what stopparen do we use */
113
114     struct scan_frame *this_prev_frame; /* this previous frame */
115     struct scan_frame *prev_frame;      /* previous frame */
116     struct scan_frame *next_frame;      /* next frame */
117 } scan_frame;
118
119 /* Certain characters are output as a sequence with the first being a
120  * backslash. */
121 #define isBACKSLASHED_PUNCT(c)  strchr("-[]\\^", c)
122
123
124 struct RExC_state_t {
125     U32         flags;                  /* RXf_* are we folding, multilining? */
126     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
127     char        *precomp;               /* uncompiled string. */
128     char        *precomp_end;           /* pointer to end of uncompiled string. */
129     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
130     regexp      *rx;                    /* perl core regexp structure */
131     regexp_internal     *rxi;           /* internal data for regexp object
132                                            pprivate field */
133     char        *start;                 /* Start of input for compile */
134     char        *end;                   /* End of input for compile */
135     char        *parse;                 /* Input-scan pointer. */
136     char        *adjusted_start;        /* 'start', adjusted.  See code use */
137     STRLEN      precomp_adj;            /* an offset beyond precomp.  See code use */
138     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
139     regnode     *emit_start;            /* Start of emitted-code area */
140     regnode     *emit_bound;            /* First regnode outside of the
141                                            allocated space */
142     regnode     *emit;                  /* Code-emit pointer; if = &emit_dummy,
143                                            implies compiling, so don't emit */
144     regnode_ssc emit_dummy;             /* placeholder for emit to point to;
145                                            large enough for the largest
146                                            non-EXACTish node, so can use it as
147                                            scratch in pass1 */
148     I32         naughty;                /* How bad is this pattern? */
149     I32         sawback;                /* Did we see \1, ...? */
150     U32         seen;
151     SSize_t     size;                   /* Code size. */
152     I32         npar;                   /* Capture buffer count, (OPEN) plus
153                                            one. ("par" 0 is the whole
154                                            pattern)*/
155     I32         nestroot;               /* root parens we are in - used by
156                                            accept */
157     I32         extralen;
158     I32         seen_zerolen;
159     regnode     **open_parens;          /* pointers to open parens */
160     regnode     **close_parens;         /* pointers to close parens */
161     regnode     *end_op;                /* END node in program */
162     I32         utf8;           /* whether the pattern is utf8 or not */
163     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
164                                 /* XXX use this for future optimisation of case
165                                  * where pattern must be upgraded to utf8. */
166     I32         uni_semantics;  /* If a d charset modifier should use unicode
167                                    rules, even if the pattern is not in
168                                    utf8 */
169     HV          *paren_names;           /* Paren names */
170
171     regnode     **recurse;              /* Recurse regops */
172     I32                recurse_count;                /* Number of recurse regops we have generated */
173     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
174                                            through */
175     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
176     I32         in_lookbehind;
177     I32         contains_locale;
178     I32         override_recoding;
179 #ifdef EBCDIC
180     I32         recode_x_to_native;
181 #endif
182     I32         in_multi_char_class;
183     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
184                                             within pattern */
185     int         code_index;             /* next code_blocks[] slot */
186     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
187     scan_frame *frame_head;
188     scan_frame *frame_last;
189     U32         frame_count;
190     AV         *warn_text;
191 #ifdef ADD_TO_REGEXEC
192     char        *starttry;              /* -Dr: where regtry was called. */
193 #define RExC_starttry   (pRExC_state->starttry)
194 #endif
195     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
196 #ifdef DEBUGGING
197     const char  *lastparse;
198     I32         lastnum;
199     AV          *paren_name_list;       /* idx -> name */
200     U32         study_chunk_recursed_count;
201     SV          *mysv1;
202     SV          *mysv2;
203 #define RExC_lastparse  (pRExC_state->lastparse)
204 #define RExC_lastnum    (pRExC_state->lastnum)
205 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
206 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
207 #define RExC_mysv       (pRExC_state->mysv1)
208 #define RExC_mysv1      (pRExC_state->mysv1)
209 #define RExC_mysv2      (pRExC_state->mysv2)
210
211 #endif
212     bool        seen_unfolded_sharp_s;
213     bool        strict;
214     bool        study_started;
215     bool        in_script_run;
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 #define RExC_in_script_run      (pRExC_state->in_script_run)
283
284 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
285  * a flag to disable back-off on the fixed/floating substrings - if it's
286  * a high complexity pattern we assume the benefit of avoiding a full match
287  * is worth the cost of checking for the substrings even if they rarely help.
288  */
289 #define RExC_naughty    (pRExC_state->naughty)
290 #define TOO_NAUGHTY (10)
291 #define MARK_NAUGHTY(add) \
292     if (RExC_naughty < TOO_NAUGHTY) \
293         RExC_naughty += (add)
294 #define MARK_NAUGHTY_EXP(exp, add) \
295     if (RExC_naughty < TOO_NAUGHTY) \
296         RExC_naughty += RExC_naughty / (exp) + (add)
297
298 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
299 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
300         ((*s) == '{' && regcurly(s)))
301
302 /*
303  * Flags to be passed up and down.
304  */
305 #define WORST           0       /* Worst case. */
306 #define HASWIDTH        0x01    /* Known to match non-null strings. */
307
308 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
309  * character.  (There needs to be a case: in the switch statement in regexec.c
310  * for any node marked SIMPLE.)  Note that this is not the same thing as
311  * REGNODE_SIMPLE */
312 #define SIMPLE          0x02
313 #define SPSTART         0x04    /* Starts with * or + */
314 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
315 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
316 #define RESTART_PASS1   0x20    /* Need to restart sizing pass */
317 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PASS1, need to
318                                    calcuate sizes as UTF-8 */
319
320 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
321
322 /* whether trie related optimizations are enabled */
323 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
324 #define TRIE_STUDY_OPT
325 #define FULL_TRIE_STUDY
326 #define TRIE_STCLASS
327 #endif
328
329
330
331 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
332 #define PBITVAL(paren) (1 << ((paren) & 7))
333 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
334 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
335 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
336
337 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
338                                      if (!UTF) {                           \
339                                          assert(PASS1);                    \
340                                          *flagp = RESTART_PASS1|NEED_UTF8; \
341                                          return NULL;                      \
342                                      }                                     \
343                              } STMT_END
344
345 /* Change from /d into /u rules, and restart the parse if we've already seen
346  * something whose size would increase as a result, by setting *flagp and
347  * returning 'restart_retval'.  RExC_uni_semantics is a flag that indicates
348  * we've changed to /u during the parse.  */
349 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
350     STMT_START {                                                            \
351             if (DEPENDS_SEMANTICS) {                                        \
352                 assert(PASS1);                                              \
353                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
354                 RExC_uni_semantics = 1;                                     \
355                 if (RExC_seen_unfolded_sharp_s) {                           \
356                     *flagp |= RESTART_PASS1;                                \
357                     return restart_retval;                                  \
358                 }                                                           \
359             }                                                               \
360     } STMT_END
361
362 /* Executes a return statement with the value 'X', if 'flags' contains any of
363  * 'RESTART_PASS1', 'NEED_UTF8', or 'extra'.  If so, *flagp is set to those
364  * flags */
365 #define RETURN_X_ON_RESTART_OR_FLAGS(X, flags, flagp, extra)                \
366     STMT_START {                                                            \
367             if ((flags) & (RESTART_PASS1|NEED_UTF8|(extra))) {              \
368                 *(flagp) = (flags) & (RESTART_PASS1|NEED_UTF8|(extra));     \
369                 return X;                                                   \
370             }                                                               \
371     } STMT_END
372
373 #define RETURN_NULL_ON_RESTART_OR_FLAGS(flags,flagp,extra)                  \
374                     RETURN_X_ON_RESTART_OR_FLAGS(NULL,flags,flagp,extra)
375
376 #define RETURN_X_ON_RESTART(X, flags,flagp)                                 \
377                         RETURN_X_ON_RESTART_OR_FLAGS( X, flags, flagp, 0)
378
379
380 #define RETURN_NULL_ON_RESTART_FLAGP_OR_FLAGS(flagp,extra)                  \
381             if (*(flagp) & (RESTART_PASS1|(extra))) return NULL
382
383 #define MUST_RESTART(flags) ((flags) & (RESTART_PASS1))
384
385 #define RETURN_NULL_ON_RESTART(flags,flagp)                                 \
386                                     RETURN_X_ON_RESTART(NULL, flags,flagp)
387 #define RETURN_NULL_ON_RESTART_FLAGP(flagp)                                 \
388                             RETURN_NULL_ON_RESTART_FLAGP_OR_FLAGS(flagp,0)
389
390 /* This converts the named class defined in regcomp.h to its equivalent class
391  * number defined in handy.h. */
392 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
393 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
394
395 #define _invlist_union_complement_2nd(a, b, output) \
396                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
397 #define _invlist_intersection_complement_2nd(a, b, output) \
398                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
399
400 /* About scan_data_t.
401
402   During optimisation we recurse through the regexp program performing
403   various inplace (keyhole style) optimisations. In addition study_chunk
404   and scan_commit populate this data structure with information about
405   what strings MUST appear in the pattern. We look for the longest
406   string that must appear at a fixed location, and we look for the
407   longest string that may appear at a floating location. So for instance
408   in the pattern:
409
410     /FOO[xX]A.*B[xX]BAR/
411
412   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
413   strings (because they follow a .* construct). study_chunk will identify
414   both FOO and BAR as being the longest fixed and floating strings respectively.
415
416   The strings can be composites, for instance
417
418      /(f)(o)(o)/
419
420   will result in a composite fixed substring 'foo'.
421
422   For each string some basic information is maintained:
423
424   - min_offset
425     This is the position the string must appear at, or not before.
426     It also implicitly (when combined with minlenp) tells us how many
427     characters must match before the string we are searching for.
428     Likewise when combined with minlenp and the length of the string it
429     tells us how many characters must appear after the string we have
430     found.
431
432   - max_offset
433     Only used for floating strings. This is the rightmost point that
434     the string can appear at. If set to SSize_t_MAX it indicates that the
435     string can occur infinitely far to the right.
436     For fixed strings, it is equal to min_offset.
437
438   - minlenp
439     A pointer to the minimum number of characters of the pattern that the
440     string was found inside. This is important as in the case of positive
441     lookahead or positive lookbehind we can have multiple patterns
442     involved. Consider
443
444     /(?=FOO).*F/
445
446     The minimum length of the pattern overall is 3, the minimum length
447     of the lookahead part is 3, but the minimum length of the part that
448     will actually match is 1. So 'FOO's minimum length is 3, but the
449     minimum length for the F is 1. This is important as the minimum length
450     is used to determine offsets in front of and behind the string being
451     looked for.  Since strings can be composites this is the length of the
452     pattern at the time it was committed with a scan_commit. Note that
453     the length is calculated by study_chunk, so that the minimum lengths
454     are not known until the full pattern has been compiled, thus the
455     pointer to the value.
456
457   - lookbehind
458
459     In the case of lookbehind the string being searched for can be
460     offset past the start point of the final matching string.
461     If this value was just blithely removed from the min_offset it would
462     invalidate some of the calculations for how many chars must match
463     before or after (as they are derived from min_offset and minlen and
464     the length of the string being searched for).
465     When the final pattern is compiled and the data is moved from the
466     scan_data_t structure into the regexp structure the information
467     about lookbehind is factored in, with the information that would
468     have been lost precalculated in the end_shift field for the
469     associated string.
470
471   The fields pos_min and pos_delta are used to store the minimum offset
472   and the delta to the maximum offset at the current point in the pattern.
473
474 */
475
476 struct scan_data_substrs {
477     SV      *str;       /* longest substring found in pattern */
478     SSize_t min_offset; /* earliest point in string it can appear */
479     SSize_t max_offset; /* latest point in string it can appear */
480     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
481     SSize_t lookbehind; /* is the pos of the string modified by LB */
482     I32 flags;          /* per substring SF_* and SCF_* flags */
483 };
484
485 typedef struct scan_data_t {
486     /*I32 len_min;      unused */
487     /*I32 len_delta;    unused */
488     SSize_t pos_min;
489     SSize_t pos_delta;
490     SV *last_found;
491     SSize_t last_end;       /* min value, <0 unless valid. */
492     SSize_t last_start_min;
493     SSize_t last_start_max;
494     U8      cur_is_floating; /* whether the last_* values should be set as
495                               * the next fixed (0) or floating (1)
496                               * substring */
497
498     /* [0] is longest fixed substring so far, [1] is longest float so far */
499     struct scan_data_substrs  substrs[2];
500
501     I32 flags;             /* common SF_* and SCF_* flags */
502     I32 whilem_c;
503     SSize_t *last_closep;
504     regnode_ssc *start_class;
505 } scan_data_t;
506
507 /*
508  * Forward declarations for pregcomp()'s friends.
509  */
510
511 static const scan_data_t zero_scan_data = {
512     0, 0, NULL, 0, 0, 0, 0,
513     {
514         { NULL, 0, 0, 0, 0, 0 },
515         { NULL, 0, 0, 0, 0, 0 },
516     },
517     0, 0, NULL, NULL
518 };
519
520 /* study flags */
521
522 #define SF_BEFORE_SEOL          0x0001
523 #define SF_BEFORE_MEOL          0x0002
524 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
525
526 #define SF_IS_INF               0x0040
527 #define SF_HAS_PAR              0x0080
528 #define SF_IN_PAR               0x0100
529 #define SF_HAS_EVAL             0x0200
530
531
532 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
533  * longest substring in the pattern. When it is not set the optimiser keeps
534  * track of position, but does not keep track of the actual strings seen,
535  *
536  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
537  * /foo/i will not.
538  *
539  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
540  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
541  * turned off because of the alternation (BRANCH). */
542 #define SCF_DO_SUBSTR           0x0400
543
544 #define SCF_DO_STCLASS_AND      0x0800
545 #define SCF_DO_STCLASS_OR       0x1000
546 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
547 #define SCF_WHILEM_VISITED_POS  0x2000
548
549 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
550 #define SCF_SEEN_ACCEPT         0x8000
551 #define SCF_TRIE_DOING_RESTUDY 0x10000
552 #define SCF_IN_DEFINE          0x20000
553
554
555
556
557 #define UTF cBOOL(RExC_utf8)
558
559 /* The enums for all these are ordered so things work out correctly */
560 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
561 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
562                                                      == REGEX_DEPENDS_CHARSET)
563 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
564 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
565                                                      >= REGEX_UNICODE_CHARSET)
566 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
567                                             == REGEX_ASCII_RESTRICTED_CHARSET)
568 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
569                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
570 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
571                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
572
573 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
574
575 /* For programs that want to be strictly Unicode compatible by dying if any
576  * attempt is made to match a non-Unicode code point against a Unicode
577  * property.  */
578 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
579
580 #define OOB_NAMEDCLASS          -1
581
582 /* There is no code point that is out-of-bounds, so this is problematic.  But
583  * its only current use is to initialize a variable that is always set before
584  * looked at. */
585 #define OOB_UNICODE             0xDEADBEEF
586
587 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
588
589
590 /* length of regex to show in messages that don't mark a position within */
591 #define RegexLengthToShowInErrorMessages 127
592
593 /*
594  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
595  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
596  * op/pragma/warn/regcomp.
597  */
598 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
599 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
600
601 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
602                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
603
604 /* The code in this file in places uses one level of recursion with parsing
605  * rebased to an alternate string constructed by us in memory.  This can take
606  * the form of something that is completely different from the input, or
607  * something that uses the input as part of the alternate.  In the first case,
608  * there should be no possibility of an error, as we are in complete control of
609  * the alternate string.  But in the second case we don't control the input
610  * portion, so there may be errors in that.  Here's an example:
611  *      /[abc\x{DF}def]/ui
612  * is handled specially because \x{df} folds to a sequence of more than one
613  * character, 'ss'.  What is done is to create and parse an alternate string,
614  * which looks like this:
615  *      /(?:\x{DF}|[abc\x{DF}def])/ui
616  * where it uses the input unchanged in the middle of something it constructs,
617  * which is a branch for the DF outside the character class, and clustering
618  * parens around the whole thing. (It knows enough to skip the DF inside the
619  * class while in this substitute parse.) 'abc' and 'def' may have errors that
620  * need to be reported.  The general situation looks like this:
621  *
622  *              sI                       tI               xI       eI
623  * Input:       ----------------------------------------------------
624  * Constructed:         ---------------------------------------------------
625  *                      sC               tC               xC       eC     EC
626  *
627  * The input string sI..eI is the input pattern.  The string sC..EC is the
628  * constructed substitute parse string.  The portions sC..tC and eC..EC are
629  * constructed by us.  The portion tC..eC is an exact duplicate of the input
630  * pattern tI..eI.  In the diagram, these are vertically aligned.  Suppose that
631  * while parsing, we find an error at xC.  We want to display a message showing
632  * the real input string.  Thus we need to find the point xI in it which
633  * corresponds to xC.  xC >= tC, since the portion of the string sC..tC has
634  * been constructed by us, and so shouldn't have errors.  We get:
635  *
636  *      xI = sI + (tI - sI) + (xC - tC)
637  *
638  * and, the offset into sI is:
639  *
640  *      (xI - sI) = (tI - sI) + (xC - tC)
641  *
642  * When the substitute is constructed, we save (tI -sI) as RExC_precomp_adj,
643  * and we save tC as RExC_adjusted_start.
644  *
645  * During normal processing of the input pattern, everything points to that,
646  * with RExC_precomp_adj set to 0, and RExC_adjusted_start set to sI.
647  */
648
649 #define tI_sI           RExC_precomp_adj
650 #define tC              RExC_adjusted_start
651 #define sC              RExC_precomp
652 #define xI_offset(xC)   ((IV) (tI_sI + (xC - tC)))
653 #define xI(xC)          (sC + xI_offset(xC))
654 #define eC              RExC_precomp_end
655
656 #define REPORT_LOCATION_ARGS(xC)                                            \
657     UTF8fARG(UTF,                                                           \
658              (xI(xC) > eC) /* Don't run off end */                          \
659               ? eC - sC   /* Length before the <--HERE */                   \
660               : ((xI_offset(xC) >= 0)                                       \
661                  ? xI_offset(xC)                                            \
662                  : (Perl_croak(aTHX_ "panic: %s: %d: negative offset: %"    \
663                                     IVdf " trying to output message for "   \
664                                     " pattern %.*s",                        \
665                                     __FILE__, __LINE__, xI_offset(xC),      \
666                                     ((int) (eC - sC)), sC), 0)),            \
667              sC),         /* The input pattern printed up to the <--HERE */ \
668     UTF8fARG(UTF,                                                           \
669              (xI(xC) > eC) ? 0 : eC - xI(xC), /* Length after <--HERE */    \
670              (xI(xC) > eC) ? eC : xI(xC))     /* pattern after <--HERE */
671
672 /* Used to point after bad bytes for an error message, but avoid skipping
673  * past a nul byte. */
674 #define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
675
676 /*
677  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
678  * arg. Show regex, up to a maximum length. If it's too long, chop and add
679  * "...".
680  */
681 #define _FAIL(code) STMT_START {                                        \
682     const char *ellipses = "";                                          \
683     IV len = RExC_precomp_end - RExC_precomp;                                   \
684                                                                         \
685     if (!SIZE_ONLY)                                                     \
686         SAVEFREESV(RExC_rx_sv);                                         \
687     if (len > RegexLengthToShowInErrorMessages) {                       \
688         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
689         len = RegexLengthToShowInErrorMessages - 10;                    \
690         ellipses = "...";                                               \
691     }                                                                   \
692     code;                                                               \
693 } STMT_END
694
695 #define FAIL(msg) _FAIL(                            \
696     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
697             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
698
699 #define FAIL2(msg,arg) _FAIL(                       \
700     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
701             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
702
703 /*
704  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
705  */
706 #define Simple_vFAIL(m) STMT_START {                                    \
707     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
708             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
709 } STMT_END
710
711 /*
712  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
713  */
714 #define vFAIL(m) STMT_START {                           \
715     if (!SIZE_ONLY)                                     \
716         SAVEFREESV(RExC_rx_sv);                         \
717     Simple_vFAIL(m);                                    \
718 } STMT_END
719
720 /*
721  * Like Simple_vFAIL(), but accepts two arguments.
722  */
723 #define Simple_vFAIL2(m,a1) STMT_START {                        \
724     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,              \
725                       REPORT_LOCATION_ARGS(RExC_parse));        \
726 } STMT_END
727
728 /*
729  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
730  */
731 #define vFAIL2(m,a1) STMT_START {                       \
732     if (!SIZE_ONLY)                                     \
733         SAVEFREESV(RExC_rx_sv);                         \
734     Simple_vFAIL2(m, a1);                               \
735 } STMT_END
736
737
738 /*
739  * Like Simple_vFAIL(), but accepts three arguments.
740  */
741 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
742     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
743             REPORT_LOCATION_ARGS(RExC_parse));                  \
744 } STMT_END
745
746 /*
747  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
748  */
749 #define vFAIL3(m,a1,a2) STMT_START {                    \
750     if (!SIZE_ONLY)                                     \
751         SAVEFREESV(RExC_rx_sv);                         \
752     Simple_vFAIL3(m, a1, a2);                           \
753 } STMT_END
754
755 /*
756  * Like Simple_vFAIL(), but accepts four arguments.
757  */
758 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
759     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,      \
760             REPORT_LOCATION_ARGS(RExC_parse));                  \
761 } STMT_END
762
763 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
764     if (!SIZE_ONLY)                                     \
765         SAVEFREESV(RExC_rx_sv);                         \
766     Simple_vFAIL4(m, a1, a2, a3);                       \
767 } STMT_END
768
769 /* A specialized version of vFAIL2 that works with UTF8f */
770 #define vFAIL2utf8f(m, a1) STMT_START {             \
771     if (!SIZE_ONLY)                                 \
772         SAVEFREESV(RExC_rx_sv);                     \
773     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,  \
774             REPORT_LOCATION_ARGS(RExC_parse));      \
775 } STMT_END
776
777 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
778     if (!SIZE_ONLY)                                     \
779         SAVEFREESV(RExC_rx_sv);                         \
780     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
781             REPORT_LOCATION_ARGS(RExC_parse));          \
782 } STMT_END
783
784 /* These have asserts in them because of [perl #122671] Many warnings in
785  * regcomp.c can occur twice.  If they get output in pass1 and later in that
786  * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
787  * would get output again.  So they should be output in pass2, and these
788  * asserts make sure new warnings follow that paradigm. */
789
790 /* m is not necessarily a "literal string", in this macro */
791 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
792     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
793                                        "%s" REPORT_LOCATION,            \
794                                   m, REPORT_LOCATION_ARGS(loc));        \
795 } STMT_END
796
797 #define ckWARNreg(loc,m) STMT_START {                                   \
798     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
799                                           m REPORT_LOCATION,            \
800                                           REPORT_LOCATION_ARGS(loc));   \
801 } STMT_END
802
803 #define vWARN(loc, m) STMT_START {                                      \
804     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
805                                        m REPORT_LOCATION,               \
806                                        REPORT_LOCATION_ARGS(loc));      \
807 } STMT_END
808
809 #define vWARN_dep(loc, m) STMT_START {                                  \
810     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),       \
811                                        m REPORT_LOCATION,               \
812                                        REPORT_LOCATION_ARGS(loc));      \
813 } STMT_END
814
815 #define ckWARNdep(loc,m) STMT_START {                                   \
816     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),  \
817                                             m REPORT_LOCATION,          \
818                                             REPORT_LOCATION_ARGS(loc)); \
819 } STMT_END
820
821 #define ckWARNregdep(loc,m) STMT_START {                                    \
822     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,      \
823                                                       WARN_REGEXP),         \
824                                              m REPORT_LOCATION,             \
825                                              REPORT_LOCATION_ARGS(loc));    \
826 } STMT_END
827
828 #define ckWARN2reg_d(loc,m, a1) STMT_START {                                \
829     __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),          \
830                                             m REPORT_LOCATION,              \
831                                             a1, REPORT_LOCATION_ARGS(loc)); \
832 } STMT_END
833
834 #define ckWARN2reg(loc, m, a1) STMT_START {                                 \
835     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
836                                           m REPORT_LOCATION,                \
837                                           a1, REPORT_LOCATION_ARGS(loc));   \
838 } STMT_END
839
840 #define vWARN3(loc, m, a1, a2) STMT_START {                                 \
841     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),               \
842                                        m REPORT_LOCATION,                   \
843                                        a1, a2, REPORT_LOCATION_ARGS(loc));  \
844 } STMT_END
845
846 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                             \
847     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),            \
848                                           m REPORT_LOCATION,                \
849                                           a1, a2,                           \
850                                           REPORT_LOCATION_ARGS(loc));       \
851 } STMT_END
852
853 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
854     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
855                                        m REPORT_LOCATION,               \
856                                        a1, a2, a3,                      \
857                                        REPORT_LOCATION_ARGS(loc));      \
858 } STMT_END
859
860 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
861     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
862                                           m REPORT_LOCATION,            \
863                                           a1, a2, a3,                   \
864                                           REPORT_LOCATION_ARGS(loc));   \
865 } STMT_END
866
867 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
868     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
869                                        m REPORT_LOCATION,               \
870                                        a1, a2, a3, a4,                  \
871                                        REPORT_LOCATION_ARGS(loc));      \
872 } STMT_END
873
874 /* Macros for recording node offsets.   20001227 mjd@plover.com
875  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
876  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
877  * Element 0 holds the number n.
878  * Position is 1 indexed.
879  */
880 #ifndef RE_TRACK_PATTERN_OFFSETS
881 #define Set_Node_Offset_To_R(node,byte)
882 #define Set_Node_Offset(node,byte)
883 #define Set_Cur_Node_Offset
884 #define Set_Node_Length_To_R(node,len)
885 #define Set_Node_Length(node,len)
886 #define Set_Node_Cur_Length(node,start)
887 #define Node_Offset(n)
888 #define Node_Length(n)
889 #define Set_Node_Offset_Length(node,offset,len)
890 #define ProgLen(ri) ri->u.proglen
891 #define SetProgLen(ri,x) ri->u.proglen = x
892 #else
893 #define ProgLen(ri) ri->u.offsets[0]
894 #define SetProgLen(ri,x) ri->u.offsets[0] = x
895 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
896     if (! SIZE_ONLY) {                                                  \
897         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
898                     __LINE__, (int)(node), (int)(byte)));               \
899         if((node) < 0) {                                                \
900             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
901                                          (int)(node));                  \
902         } else {                                                        \
903             RExC_offsets[2*(node)-1] = (byte);                          \
904         }                                                               \
905     }                                                                   \
906 } STMT_END
907
908 #define Set_Node_Offset(node,byte) \
909     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
910 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
911
912 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
913     if (! SIZE_ONLY) {                                                  \
914         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
915                 __LINE__, (int)(node), (int)(len)));                    \
916         if((node) < 0) {                                                \
917             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
918                                          (int)(node));                  \
919         } else {                                                        \
920             RExC_offsets[2*(node)] = (len);                             \
921         }                                                               \
922     }                                                                   \
923 } STMT_END
924
925 #define Set_Node_Length(node,len) \
926     Set_Node_Length_To_R((node)-RExC_emit_start, len)
927 #define Set_Node_Cur_Length(node, start)                \
928     Set_Node_Length(node, RExC_parse - start)
929
930 /* Get offsets and lengths */
931 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
932 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
933
934 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
935     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
936     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
937 } STMT_END
938 #endif
939
940 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
941 #define EXPERIMENTAL_INPLACESCAN
942 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
943
944 #ifdef DEBUGGING
945 int
946 Perl_re_printf(pTHX_ const char *fmt, ...)
947 {
948     va_list ap;
949     int result;
950     PerlIO *f= Perl_debug_log;
951     PERL_ARGS_ASSERT_RE_PRINTF;
952     va_start(ap, fmt);
953     result = PerlIO_vprintf(f, fmt, ap);
954     va_end(ap);
955     return result;
956 }
957
958 int
959 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
960 {
961     va_list ap;
962     int result;
963     PerlIO *f= Perl_debug_log;
964     PERL_ARGS_ASSERT_RE_INDENTF;
965     va_start(ap, depth);
966     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
967     result = PerlIO_vprintf(f, fmt, ap);
968     va_end(ap);
969     return result;
970 }
971 #endif /* DEBUGGING */
972
973 #define DEBUG_RExC_seen()                                                   \
974         DEBUG_OPTIMISE_MORE_r({                                             \
975             Perl_re_printf( aTHX_ "RExC_seen: ");                                       \
976                                                                             \
977             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
978                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                            \
979                                                                             \
980             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
981                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");                          \
982                                                                             \
983             if (RExC_seen & REG_GPOS_SEEN)                                  \
984                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                                \
985                                                                             \
986             if (RExC_seen & REG_RECURSE_SEEN)                               \
987                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                             \
988                                                                             \
989             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
990                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");                  \
991                                                                             \
992             if (RExC_seen & REG_VERBARG_SEEN)                               \
993                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                             \
994                                                                             \
995             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
996                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                            \
997                                                                             \
998             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
999                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");                      \
1000                                                                             \
1001             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
1002                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");                      \
1003                                                                             \
1004             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
1005                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");                \
1006                                                                             \
1007             Perl_re_printf( aTHX_ "\n");                                                \
1008         });
1009
1010 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
1011   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
1012
1013
1014 #ifdef DEBUGGING
1015 static void
1016 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
1017                                     const char *close_str)
1018 {
1019     if (!flags)
1020         return;
1021
1022     Perl_re_printf( aTHX_  "%s", open_str);
1023     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
1024     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
1025     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
1026     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
1027     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
1028     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
1029     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
1030     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
1031     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
1032     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
1033     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
1034     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
1035     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1036     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1037     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1038     Perl_re_printf( aTHX_  "%s", close_str);
1039 }
1040
1041
1042 static void
1043 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1044                     U32 depth, int is_inf)
1045 {
1046     GET_RE_DEBUG_FLAGS_DECL;
1047
1048     DEBUG_OPTIMISE_MORE_r({
1049         if (!data)
1050             return;
1051         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1052             depth,
1053             where,
1054             (IV)data->pos_min,
1055             (IV)data->pos_delta,
1056             (UV)data->flags
1057         );
1058
1059         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1060
1061         Perl_re_printf( aTHX_
1062             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1063             (IV)data->whilem_c,
1064             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1065             is_inf ? "INF " : ""
1066         );
1067
1068         if (data->last_found) {
1069             int i;
1070             Perl_re_printf(aTHX_
1071                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1072                     SvPVX_const(data->last_found),
1073                     (IV)data->last_end,
1074                     (IV)data->last_start_min,
1075                     (IV)data->last_start_max
1076             );
1077
1078             for (i = 0; i < 2; i++) {
1079                 Perl_re_printf(aTHX_
1080                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1081                     data->cur_is_floating == i ? "*" : "",
1082                     i ? "Float" : "Fixed",
1083                     SvPVX_const(data->substrs[i].str),
1084                     (IV)data->substrs[i].min_offset,
1085                     (IV)data->substrs[i].max_offset
1086                 );
1087                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1088             }
1089         }
1090
1091         Perl_re_printf( aTHX_ "\n");
1092     });
1093 }
1094
1095
1096 static void
1097 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1098                 regnode *scan, U32 depth, U32 flags)
1099 {
1100     GET_RE_DEBUG_FLAGS_DECL;
1101
1102     DEBUG_OPTIMISE_r({
1103         regnode *Next;
1104
1105         if (!scan)
1106             return;
1107         Next = regnext(scan);
1108         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1109         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1110             depth,
1111             str,
1112             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1113             Next ? (REG_NODE_NUM(Next)) : 0 );
1114         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1115         Perl_re_printf( aTHX_  "\n");
1116    });
1117 }
1118
1119
1120 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1121                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1122
1123 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1124                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1125
1126 #else
1127 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1128 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1129 #endif
1130
1131
1132 /* =========================================================
1133  * BEGIN edit_distance stuff.
1134  *
1135  * This calculates how many single character changes of any type are needed to
1136  * transform a string into another one.  It is taken from version 3.1 of
1137  *
1138  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1139  */
1140
1141 /* Our unsorted dictionary linked list.   */
1142 /* Note we use UVs, not chars. */
1143
1144 struct dictionary{
1145   UV key;
1146   UV value;
1147   struct dictionary* next;
1148 };
1149 typedef struct dictionary item;
1150
1151
1152 PERL_STATIC_INLINE item*
1153 push(UV key,item* curr)
1154 {
1155     item* head;
1156     Newx(head, 1, item);
1157     head->key = key;
1158     head->value = 0;
1159     head->next = curr;
1160     return head;
1161 }
1162
1163
1164 PERL_STATIC_INLINE item*
1165 find(item* head, UV key)
1166 {
1167     item* iterator = head;
1168     while (iterator){
1169         if (iterator->key == key){
1170             return iterator;
1171         }
1172         iterator = iterator->next;
1173     }
1174
1175     return NULL;
1176 }
1177
1178 PERL_STATIC_INLINE item*
1179 uniquePush(item* head,UV key)
1180 {
1181     item* iterator = head;
1182
1183     while (iterator){
1184         if (iterator->key == key) {
1185             return head;
1186         }
1187         iterator = iterator->next;
1188     }
1189
1190     return push(key,head);
1191 }
1192
1193 PERL_STATIC_INLINE void
1194 dict_free(item* head)
1195 {
1196     item* iterator = head;
1197
1198     while (iterator) {
1199         item* temp = iterator;
1200         iterator = iterator->next;
1201         Safefree(temp);
1202     }
1203
1204     head = NULL;
1205 }
1206
1207 /* End of Dictionary Stuff */
1208
1209 /* All calculations/work are done here */
1210 STATIC int
1211 S_edit_distance(const UV* src,
1212                 const UV* tgt,
1213                 const STRLEN x,             /* length of src[] */
1214                 const STRLEN y,             /* length of tgt[] */
1215                 const SSize_t maxDistance
1216 )
1217 {
1218     item *head = NULL;
1219     UV swapCount,swapScore,targetCharCount,i,j;
1220     UV *scores;
1221     UV score_ceil = x + y;
1222
1223     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1224
1225     /* intialize matrix start values */
1226     Newx(scores, ( (x + 2) * (y + 2)), UV);
1227     scores[0] = score_ceil;
1228     scores[1 * (y + 2) + 0] = score_ceil;
1229     scores[0 * (y + 2) + 1] = score_ceil;
1230     scores[1 * (y + 2) + 1] = 0;
1231     head = uniquePush(uniquePush(head,src[0]),tgt[0]);
1232
1233     /* work loops    */
1234     /* i = src index */
1235     /* j = tgt index */
1236     for (i=1;i<=x;i++) {
1237         if (i < x)
1238             head = uniquePush(head,src[i]);
1239         scores[(i+1) * (y + 2) + 1] = i;
1240         scores[(i+1) * (y + 2) + 0] = score_ceil;
1241         swapCount = 0;
1242
1243         for (j=1;j<=y;j++) {
1244             if (i == 1) {
1245                 if(j < y)
1246                 head = uniquePush(head,tgt[j]);
1247                 scores[1 * (y + 2) + (j + 1)] = j;
1248                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1249             }
1250
1251             targetCharCount = find(head,tgt[j-1])->value;
1252             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1253
1254             if (src[i-1] != tgt[j-1]){
1255                 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));
1256             }
1257             else {
1258                 swapCount = j;
1259                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1260             }
1261         }
1262
1263         find(head,src[i-1])->value = i;
1264     }
1265
1266     {
1267         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1268         dict_free(head);
1269         Safefree(scores);
1270         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1271     }
1272 }
1273
1274 /* END of edit_distance() stuff
1275  * ========================================================= */
1276
1277 /* is c a control character for which we have a mnemonic? */
1278 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1279
1280 STATIC const char *
1281 S_cntrl_to_mnemonic(const U8 c)
1282 {
1283     /* Returns the mnemonic string that represents character 'c', if one
1284      * exists; NULL otherwise.  The only ones that exist for the purposes of
1285      * this routine are a few control characters */
1286
1287     switch (c) {
1288         case '\a':       return "\\a";
1289         case '\b':       return "\\b";
1290         case ESC_NATIVE: return "\\e";
1291         case '\f':       return "\\f";
1292         case '\n':       return "\\n";
1293         case '\r':       return "\\r";
1294         case '\t':       return "\\t";
1295     }
1296
1297     return NULL;
1298 }
1299
1300 /* Mark that we cannot extend a found fixed substring at this point.
1301    Update the longest found anchored substring or the longest found
1302    floating substrings if needed. */
1303
1304 STATIC void
1305 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1306                     SSize_t *minlenp, int is_inf)
1307 {
1308     const STRLEN l = CHR_SVLEN(data->last_found);
1309     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1310     const STRLEN old_l = CHR_SVLEN(longest_sv);
1311     GET_RE_DEBUG_FLAGS_DECL;
1312
1313     PERL_ARGS_ASSERT_SCAN_COMMIT;
1314
1315     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1316         const U8 i = data->cur_is_floating;
1317         SvSetMagicSV(longest_sv, data->last_found);
1318         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1319
1320         if (!i) /* fixed */
1321             data->substrs[0].max_offset = data->substrs[0].min_offset;
1322         else { /* float */
1323             data->substrs[1].max_offset = (l
1324                           ? data->last_start_max
1325                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1326                                          ? SSize_t_MAX
1327                                          : data->pos_min + data->pos_delta));
1328             if (is_inf
1329                  || (STRLEN)data->substrs[1].max_offset > (STRLEN)SSize_t_MAX)
1330                 data->substrs[1].max_offset = SSize_t_MAX;
1331         }
1332
1333         if (data->flags & SF_BEFORE_EOL)
1334             data->substrs[i].flags |= (data->flags & SF_BEFORE_EOL);
1335         else
1336             data->substrs[i].flags &= ~SF_BEFORE_EOL;
1337         data->substrs[i].minlenp = minlenp;
1338         data->substrs[i].lookbehind = 0;
1339     }
1340
1341     SvCUR_set(data->last_found, 0);
1342     {
1343         SV * const sv = data->last_found;
1344         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1345             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1346             if (mg)
1347                 mg->mg_len = 0;
1348         }
1349     }
1350     data->last_end = -1;
1351     data->flags &= ~SF_BEFORE_EOL;
1352     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1353 }
1354
1355 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1356  * list that describes which code points it matches */
1357
1358 STATIC void
1359 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1360 {
1361     /* Set the SSC 'ssc' to match an empty string or any code point */
1362
1363     PERL_ARGS_ASSERT_SSC_ANYTHING;
1364
1365     assert(is_ANYOF_SYNTHETIC(ssc));
1366
1367     /* mortalize so won't leak */
1368     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1369     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1370 }
1371
1372 STATIC int
1373 S_ssc_is_anything(const regnode_ssc *ssc)
1374 {
1375     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1376      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1377      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1378      * in any way, so there's no point in using it */
1379
1380     UV start, end;
1381     bool ret;
1382
1383     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1384
1385     assert(is_ANYOF_SYNTHETIC(ssc));
1386
1387     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1388         return FALSE;
1389     }
1390
1391     /* See if the list consists solely of the range 0 - Infinity */
1392     invlist_iterinit(ssc->invlist);
1393     ret = invlist_iternext(ssc->invlist, &start, &end)
1394           && start == 0
1395           && end == UV_MAX;
1396
1397     invlist_iterfinish(ssc->invlist);
1398
1399     if (ret) {
1400         return TRUE;
1401     }
1402
1403     /* If e.g., both \w and \W are set, matches everything */
1404     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1405         int i;
1406         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1407             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1408                 return TRUE;
1409             }
1410         }
1411     }
1412
1413     return FALSE;
1414 }
1415
1416 STATIC void
1417 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1418 {
1419     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1420      * string, any code point, or any posix class under locale */
1421
1422     PERL_ARGS_ASSERT_SSC_INIT;
1423
1424     Zero(ssc, 1, regnode_ssc);
1425     set_ANYOF_SYNTHETIC(ssc);
1426     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1427     ssc_anything(ssc);
1428
1429     /* If any portion of the regex is to operate under locale rules that aren't
1430      * fully known at compile time, initialization includes it.  The reason
1431      * this isn't done for all regexes is that the optimizer was written under
1432      * the assumption that locale was all-or-nothing.  Given the complexity and
1433      * lack of documentation in the optimizer, and that there are inadequate
1434      * test cases for locale, many parts of it may not work properly, it is
1435      * safest to avoid locale unless necessary. */
1436     if (RExC_contains_locale) {
1437         ANYOF_POSIXL_SETALL(ssc);
1438     }
1439     else {
1440         ANYOF_POSIXL_ZERO(ssc);
1441     }
1442 }
1443
1444 STATIC int
1445 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1446                         const regnode_ssc *ssc)
1447 {
1448     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1449      * to the list of code points matched, and locale posix classes; hence does
1450      * not check its flags) */
1451
1452     UV start, end;
1453     bool ret;
1454
1455     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1456
1457     assert(is_ANYOF_SYNTHETIC(ssc));
1458
1459     invlist_iterinit(ssc->invlist);
1460     ret = invlist_iternext(ssc->invlist, &start, &end)
1461           && start == 0
1462           && end == UV_MAX;
1463
1464     invlist_iterfinish(ssc->invlist);
1465
1466     if (! ret) {
1467         return FALSE;
1468     }
1469
1470     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1471         return FALSE;
1472     }
1473
1474     return TRUE;
1475 }
1476
1477 STATIC SV*
1478 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1479                                const regnode_charclass* const node)
1480 {
1481     /* Returns a mortal inversion list defining which code points are matched
1482      * by 'node', which is of type ANYOF.  Handles complementing the result if
1483      * appropriate.  If some code points aren't knowable at this time, the
1484      * returned list must, and will, contain every code point that is a
1485      * possibility. */
1486
1487     SV* invlist = NULL;
1488     SV* only_utf8_locale_invlist = NULL;
1489     unsigned int i;
1490     const U32 n = ARG(node);
1491     bool new_node_has_latin1 = FALSE;
1492
1493     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1494
1495     /* Look at the data structure created by S_set_ANYOF_arg() */
1496     if (n != ANYOF_ONLY_HAS_BITMAP) {
1497         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1498         AV * const av = MUTABLE_AV(SvRV(rv));
1499         SV **const ary = AvARRAY(av);
1500         assert(RExC_rxi->data->what[n] == 's');
1501
1502         if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1503             invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1504         }
1505         else if (ary[0] && ary[0] != &PL_sv_undef) {
1506
1507             /* Here, no compile-time swash, and there are things that won't be
1508              * known until runtime -- we have to assume it could be anything */
1509             invlist = sv_2mortal(_new_invlist(1));
1510             return _add_range_to_invlist(invlist, 0, UV_MAX);
1511         }
1512         else if (ary[3] && ary[3] != &PL_sv_undef) {
1513
1514             /* Here no compile-time swash, and no run-time only data.  Use the
1515              * node's inversion list */
1516             invlist = sv_2mortal(invlist_clone(ary[3]));
1517         }
1518
1519         /* Get the code points valid only under UTF-8 locales */
1520         if ((ANYOF_FLAGS(node) & ANYOFL_FOLD)
1521             && ary[2] && ary[2] != &PL_sv_undef)
1522         {
1523             only_utf8_locale_invlist = ary[2];
1524         }
1525     }
1526
1527     if (! invlist) {
1528         invlist = sv_2mortal(_new_invlist(0));
1529     }
1530
1531     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1532      * code points, and an inversion list for the others, but if there are code
1533      * points that should match only conditionally on the target string being
1534      * UTF-8, those are placed in the inversion list, and not the bitmap.
1535      * Since there are circumstances under which they could match, they are
1536      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1537      * to exclude them here, so that when we invert below, the end result
1538      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1539      * have to do this here before we add the unconditionally matched code
1540      * points */
1541     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1542         _invlist_intersection_complement_2nd(invlist,
1543                                              PL_UpperLatin1,
1544                                              &invlist);
1545     }
1546
1547     /* Add in the points from the bit map */
1548     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1549         if (ANYOF_BITMAP_TEST(node, i)) {
1550             unsigned int start = i++;
1551
1552             for (; i < NUM_ANYOF_CODE_POINTS && ANYOF_BITMAP_TEST(node, i); ++i) {
1553                 /* empty */
1554             }
1555             invlist = _add_range_to_invlist(invlist, start, i-1);
1556             new_node_has_latin1 = TRUE;
1557         }
1558     }
1559
1560     /* If this can match all upper Latin1 code points, have to add them
1561      * as well.  But don't add them if inverting, as when that gets done below,
1562      * it would exclude all these characters, including the ones it shouldn't
1563      * that were added just above */
1564     if (! (ANYOF_FLAGS(node) & ANYOF_INVERT) && OP(node) == ANYOFD
1565         && (ANYOF_FLAGS(node) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1566     {
1567         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1568     }
1569
1570     /* Similarly for these */
1571     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1572         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1573     }
1574
1575     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1576         _invlist_invert(invlist);
1577     }
1578     else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOFL_FOLD) {
1579
1580         /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1581          * locale.  We can skip this if there are no 0-255 at all. */
1582         _invlist_union(invlist, PL_Latin1, &invlist);
1583     }
1584
1585     /* Similarly add the UTF-8 locale possible matches.  These have to be
1586      * deferred until after the non-UTF-8 locale ones are taken care of just
1587      * above, or it leads to wrong results under ANYOF_INVERT */
1588     if (only_utf8_locale_invlist) {
1589         _invlist_union_maybe_complement_2nd(invlist,
1590                                             only_utf8_locale_invlist,
1591                                             ANYOF_FLAGS(node) & ANYOF_INVERT,
1592                                             &invlist);
1593     }
1594
1595     return invlist;
1596 }
1597
1598 /* These two functions currently do the exact same thing */
1599 #define ssc_init_zero           ssc_init
1600
1601 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1602 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1603
1604 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1605  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1606  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1607
1608 STATIC void
1609 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1610                 const regnode_charclass *and_with)
1611 {
1612     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1613      * another SSC or a regular ANYOF class.  Can create false positives. */
1614
1615     SV* anded_cp_list;
1616     U8  anded_flags;
1617
1618     PERL_ARGS_ASSERT_SSC_AND;
1619
1620     assert(is_ANYOF_SYNTHETIC(ssc));
1621
1622     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1623      * the code point inversion list and just the relevant flags */
1624     if (is_ANYOF_SYNTHETIC(and_with)) {
1625         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1626         anded_flags = ANYOF_FLAGS(and_with);
1627
1628         /* XXX This is a kludge around what appears to be deficiencies in the
1629          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1630          * there are paths through the optimizer where it doesn't get weeded
1631          * out when it should.  And if we don't make some extra provision for
1632          * it like the code just below, it doesn't get added when it should.
1633          * This solution is to add it only when AND'ing, which is here, and
1634          * only when what is being AND'ed is the pristine, original node
1635          * matching anything.  Thus it is like adding it to ssc_anything() but
1636          * only when the result is to be AND'ed.  Probably the same solution
1637          * could be adopted for the same problem we have with /l matching,
1638          * which is solved differently in S_ssc_init(), and that would lead to
1639          * fewer false positives than that solution has.  But if this solution
1640          * creates bugs, the consequences are only that a warning isn't raised
1641          * that should be; while the consequences for having /l bugs is
1642          * incorrect matches */
1643         if (ssc_is_anything((regnode_ssc *)and_with)) {
1644             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1645         }
1646     }
1647     else {
1648         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1649         if (OP(and_with) == ANYOFD) {
1650             anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1651         }
1652         else {
1653             anded_flags = ANYOF_FLAGS(and_with)
1654             &( ANYOF_COMMON_FLAGS
1655               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1656               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1657             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(and_with))) {
1658                 anded_flags &=
1659                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1660             }
1661         }
1662     }
1663
1664     ANYOF_FLAGS(ssc) &= anded_flags;
1665
1666     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1667      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1668      * 'and_with' may be inverted.  When not inverted, we have the situation of
1669      * computing:
1670      *  (C1 | P1) & (C2 | P2)
1671      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1672      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1673      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1674      *                    <=  ((C1 & C2) | P1 | P2)
1675      * Alternatively, the last few steps could be:
1676      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1677      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1678      *                    <=  (C1 | C2 | (P1 & P2))
1679      * We favor the second approach if either P1 or P2 is non-empty.  This is
1680      * because these components are a barrier to doing optimizations, as what
1681      * they match cannot be known until the moment of matching as they are
1682      * dependent on the current locale, 'AND"ing them likely will reduce or
1683      * eliminate them.
1684      * But we can do better if we know that C1,P1 are in their initial state (a
1685      * frequent occurrence), each matching everything:
1686      *  (<everything>) & (C2 | P2) =  C2 | P2
1687      * Similarly, if C2,P2 are in their initial state (again a frequent
1688      * occurrence), the result is a no-op
1689      *  (C1 | P1) & (<everything>) =  C1 | P1
1690      *
1691      * Inverted, we have
1692      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1693      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1694      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1695      * */
1696
1697     if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1698         && ! is_ANYOF_SYNTHETIC(and_with))
1699     {
1700         unsigned int i;
1701
1702         ssc_intersection(ssc,
1703                          anded_cp_list,
1704                          FALSE /* Has already been inverted */
1705                          );
1706
1707         /* If either P1 or P2 is empty, the intersection will be also; can skip
1708          * the loop */
1709         if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1710             ANYOF_POSIXL_ZERO(ssc);
1711         }
1712         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1713
1714             /* Note that the Posix class component P from 'and_with' actually
1715              * looks like:
1716              *      P = Pa | Pb | ... | Pn
1717              * where each component is one posix class, such as in [\w\s].
1718              * Thus
1719              *      ~P = ~(Pa | Pb | ... | Pn)
1720              *         = ~Pa & ~Pb & ... & ~Pn
1721              *        <= ~Pa | ~Pb | ... | ~Pn
1722              * The last is something we can easily calculate, but unfortunately
1723              * is likely to have many false positives.  We could do better
1724              * in some (but certainly not all) instances if two classes in
1725              * P have known relationships.  For example
1726              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1727              * So
1728              *      :lower: & :print: = :lower:
1729              * And similarly for classes that must be disjoint.  For example,
1730              * since \s and \w can have no elements in common based on rules in
1731              * the POSIX standard,
1732              *      \w & ^\S = nothing
1733              * Unfortunately, some vendor locales do not meet the Posix
1734              * standard, in particular almost everything by Microsoft.
1735              * The loop below just changes e.g., \w into \W and vice versa */
1736
1737             regnode_charclass_posixl temp;
1738             int add = 1;    /* To calculate the index of the complement */
1739
1740             Zero(&temp, 1, regnode_charclass_posixl);
1741             ANYOF_POSIXL_ZERO(&temp);
1742             for (i = 0; i < ANYOF_MAX; i++) {
1743                 assert(i % 2 != 0
1744                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1745                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1746
1747                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1748                     ANYOF_POSIXL_SET(&temp, i + add);
1749                 }
1750                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1751             }
1752             ANYOF_POSIXL_AND(&temp, ssc);
1753
1754         } /* else ssc already has no posixes */
1755     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1756          in its initial state */
1757     else if (! is_ANYOF_SYNTHETIC(and_with)
1758              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1759     {
1760         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1761          * copy it over 'ssc' */
1762         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1763             if (is_ANYOF_SYNTHETIC(and_with)) {
1764                 StructCopy(and_with, ssc, regnode_ssc);
1765             }
1766             else {
1767                 ssc->invlist = anded_cp_list;
1768                 ANYOF_POSIXL_ZERO(ssc);
1769                 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1770                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1771                 }
1772             }
1773         }
1774         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1775                  || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
1776         {
1777             /* One or the other of P1, P2 is non-empty. */
1778             if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1779                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1780             }
1781             ssc_union(ssc, anded_cp_list, FALSE);
1782         }
1783         else { /* P1 = P2 = empty */
1784             ssc_intersection(ssc, anded_cp_list, FALSE);
1785         }
1786     }
1787 }
1788
1789 STATIC void
1790 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1791                const regnode_charclass *or_with)
1792 {
1793     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1794      * another SSC or a regular ANYOF class.  Can create false positives if
1795      * 'or_with' is to be inverted. */
1796
1797     SV* ored_cp_list;
1798     U8 ored_flags;
1799
1800     PERL_ARGS_ASSERT_SSC_OR;
1801
1802     assert(is_ANYOF_SYNTHETIC(ssc));
1803
1804     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1805      * the code point inversion list and just the relevant flags */
1806     if (is_ANYOF_SYNTHETIC(or_with)) {
1807         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1808         ored_flags = ANYOF_FLAGS(or_with);
1809     }
1810     else {
1811         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1812         ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1813         if (OP(or_with) != ANYOFD) {
1814             ored_flags
1815             |= ANYOF_FLAGS(or_with)
1816              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1817                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1818             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(or_with))) {
1819                 ored_flags |=
1820                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1821             }
1822         }
1823     }
1824
1825     ANYOF_FLAGS(ssc) |= ored_flags;
1826
1827     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1828      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1829      * 'or_with' may be inverted.  When not inverted, we have the simple
1830      * situation of computing:
1831      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1832      * If P1|P2 yields a situation with both a class and its complement are
1833      * set, like having both \w and \W, this matches all code points, and we
1834      * can delete these from the P component of the ssc going forward.  XXX We
1835      * might be able to delete all the P components, but I (khw) am not certain
1836      * about this, and it is better to be safe.
1837      *
1838      * Inverted, we have
1839      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1840      *                         <=  (C1 | P1) | ~C2
1841      *                         <=  (C1 | ~C2) | P1
1842      * (which results in actually simpler code than the non-inverted case)
1843      * */
1844
1845     if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1846         && ! is_ANYOF_SYNTHETIC(or_with))
1847     {
1848         /* We ignore P2, leaving P1 going forward */
1849     }   /* else  Not inverted */
1850     else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
1851         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1852         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1853             unsigned int i;
1854             for (i = 0; i < ANYOF_MAX; i += 2) {
1855                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1856                 {
1857                     ssc_match_all_cp(ssc);
1858                     ANYOF_POSIXL_CLEAR(ssc, i);
1859                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1860                 }
1861             }
1862         }
1863     }
1864
1865     ssc_union(ssc,
1866               ored_cp_list,
1867               FALSE /* Already has been inverted */
1868               );
1869 }
1870
1871 PERL_STATIC_INLINE void
1872 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1873 {
1874     PERL_ARGS_ASSERT_SSC_UNION;
1875
1876     assert(is_ANYOF_SYNTHETIC(ssc));
1877
1878     _invlist_union_maybe_complement_2nd(ssc->invlist,
1879                                         invlist,
1880                                         invert2nd,
1881                                         &ssc->invlist);
1882 }
1883
1884 PERL_STATIC_INLINE void
1885 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1886                          SV* const invlist,
1887                          const bool invert2nd)
1888 {
1889     PERL_ARGS_ASSERT_SSC_INTERSECTION;
1890
1891     assert(is_ANYOF_SYNTHETIC(ssc));
1892
1893     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1894                                                invlist,
1895                                                invert2nd,
1896                                                &ssc->invlist);
1897 }
1898
1899 PERL_STATIC_INLINE void
1900 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1901 {
1902     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1903
1904     assert(is_ANYOF_SYNTHETIC(ssc));
1905
1906     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1907 }
1908
1909 PERL_STATIC_INLINE void
1910 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1911 {
1912     /* AND just the single code point 'cp' into the SSC 'ssc' */
1913
1914     SV* cp_list = _new_invlist(2);
1915
1916     PERL_ARGS_ASSERT_SSC_CP_AND;
1917
1918     assert(is_ANYOF_SYNTHETIC(ssc));
1919
1920     cp_list = add_cp_to_invlist(cp_list, cp);
1921     ssc_intersection(ssc, cp_list,
1922                      FALSE /* Not inverted */
1923                      );
1924     SvREFCNT_dec_NN(cp_list);
1925 }
1926
1927 PERL_STATIC_INLINE void
1928 S_ssc_clear_locale(regnode_ssc *ssc)
1929 {
1930     /* Set the SSC 'ssc' to not match any locale things */
1931     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1932
1933     assert(is_ANYOF_SYNTHETIC(ssc));
1934
1935     ANYOF_POSIXL_ZERO(ssc);
1936     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1937 }
1938
1939 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1940
1941 STATIC bool
1942 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1943 {
1944     /* The synthetic start class is used to hopefully quickly winnow down
1945      * places where a pattern could start a match in the target string.  If it
1946      * doesn't really narrow things down that much, there isn't much point to
1947      * having the overhead of using it.  This function uses some very crude
1948      * heuristics to decide if to use the ssc or not.
1949      *
1950      * It returns TRUE if 'ssc' rules out more than half what it considers to
1951      * be the "likely" possible matches, but of course it doesn't know what the
1952      * actual things being matched are going to be; these are only guesses
1953      *
1954      * For /l matches, it assumes that the only likely matches are going to be
1955      *      in the 0-255 range, uniformly distributed, so half of that is 127
1956      * For /a and /d matches, it assumes that the likely matches will be just
1957      *      the ASCII range, so half of that is 63
1958      * For /u and there isn't anything matching above the Latin1 range, it
1959      *      assumes that that is the only range likely to be matched, and uses
1960      *      half that as the cut-off: 127.  If anything matches above Latin1,
1961      *      it assumes that all of Unicode could match (uniformly), except for
1962      *      non-Unicode code points and things in the General Category "Other"
1963      *      (unassigned, private use, surrogates, controls and formats).  This
1964      *      is a much large number. */
1965
1966     U32 count = 0;      /* Running total of number of code points matched by
1967                            'ssc' */
1968     UV start, end;      /* Start and end points of current range in inversion
1969                            list */
1970     const U32 max_code_points = (LOC)
1971                                 ?  256
1972                                 : ((   ! UNI_SEMANTICS
1973                                      || invlist_highest(ssc->invlist) < 256)
1974                                   ? 128
1975                                   : NON_OTHER_COUNT);
1976     const U32 max_match = max_code_points / 2;
1977
1978     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1979
1980     invlist_iterinit(ssc->invlist);
1981     while (invlist_iternext(ssc->invlist, &start, &end)) {
1982         if (start >= max_code_points) {
1983             break;
1984         }
1985         end = MIN(end, max_code_points - 1);
1986         count += end - start + 1;
1987         if (count >= max_match) {
1988             invlist_iterfinish(ssc->invlist);
1989             return FALSE;
1990         }
1991     }
1992
1993     return TRUE;
1994 }
1995
1996
1997 STATIC void
1998 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1999 {
2000     /* The inversion list in the SSC is marked mortal; now we need a more
2001      * permanent copy, which is stored the same way that is done in a regular
2002      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
2003      * map */
2004
2005     SV* invlist = invlist_clone(ssc->invlist);
2006
2007     PERL_ARGS_ASSERT_SSC_FINALIZE;
2008
2009     assert(is_ANYOF_SYNTHETIC(ssc));
2010
2011     /* The code in this file assumes that all but these flags aren't relevant
2012      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
2013      * by the time we reach here */
2014     assert(! (ANYOF_FLAGS(ssc)
2015         & ~( ANYOF_COMMON_FLAGS
2016             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
2017             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
2018
2019     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
2020
2021     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
2022                                 NULL, NULL, NULL, FALSE);
2023
2024     /* Make sure is clone-safe */
2025     ssc->invlist = NULL;
2026
2027     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
2028         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
2029     }
2030
2031     if (RExC_contains_locale) {
2032         OP(ssc) = ANYOFL;
2033     }
2034
2035     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
2036 }
2037
2038 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
2039 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
2040 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
2041 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
2042                                ? (TRIE_LIST_CUR( idx ) - 1)           \
2043                                : 0 )
2044
2045
2046 #ifdef DEBUGGING
2047 /*
2048    dump_trie(trie,widecharmap,revcharmap)
2049    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
2050    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
2051
2052    These routines dump out a trie in a somewhat readable format.
2053    The _interim_ variants are used for debugging the interim
2054    tables that are used to generate the final compressed
2055    representation which is what dump_trie expects.
2056
2057    Part of the reason for their existence is to provide a form
2058    of documentation as to how the different representations function.
2059
2060 */
2061
2062 /*
2063   Dumps the final compressed table form of the trie to Perl_debug_log.
2064   Used for debugging make_trie().
2065 */
2066
2067 STATIC void
2068 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
2069             AV *revcharmap, U32 depth)
2070 {
2071     U32 state;
2072     SV *sv=sv_newmortal();
2073     int colwidth= widecharmap ? 6 : 4;
2074     U16 word;
2075     GET_RE_DEBUG_FLAGS_DECL;
2076
2077     PERL_ARGS_ASSERT_DUMP_TRIE;
2078
2079     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
2080         depth+1, "Match","Base","Ofs" );
2081
2082     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2083         SV ** const tmp = av_fetch( revcharmap, state, 0);
2084         if ( tmp ) {
2085             Perl_re_printf( aTHX_  "%*s",
2086                 colwidth,
2087                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2088                             PL_colors[0], PL_colors[1],
2089                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2090                             PERL_PV_ESCAPE_FIRSTCHAR
2091                 )
2092             );
2093         }
2094     }
2095     Perl_re_printf( aTHX_  "\n");
2096     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2097
2098     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2099         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2100     Perl_re_printf( aTHX_  "\n");
2101
2102     for( state = 1 ; state < trie->statecount ; state++ ) {
2103         const U32 base = trie->states[ state ].trans.base;
2104
2105         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2106
2107         if ( trie->states[ state ].wordnum ) {
2108             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2109         } else {
2110             Perl_re_printf( aTHX_  "%6s", "" );
2111         }
2112
2113         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2114
2115         if ( base ) {
2116             U32 ofs = 0;
2117
2118             while( ( base + ofs  < trie->uniquecharcount ) ||
2119                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2120                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2121                                                                     != state))
2122                     ofs++;
2123
2124             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2125
2126             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2127                 if ( ( base + ofs >= trie->uniquecharcount )
2128                         && ( base + ofs - trie->uniquecharcount
2129                                                         < trie->lasttrans )
2130                         && trie->trans[ base + ofs
2131                                     - trie->uniquecharcount ].check == state )
2132                 {
2133                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2134                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2135                    );
2136                 } else {
2137                     Perl_re_printf( aTHX_  "%*s",colwidth,"   ." );
2138                 }
2139             }
2140
2141             Perl_re_printf( aTHX_  "]");
2142
2143         }
2144         Perl_re_printf( aTHX_  "\n" );
2145     }
2146     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2147                                 depth);
2148     for (word=1; word <= trie->wordcount; word++) {
2149         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2150             (int)word, (int)(trie->wordinfo[word].prev),
2151             (int)(trie->wordinfo[word].len));
2152     }
2153     Perl_re_printf( aTHX_  "\n" );
2154 }
2155 /*
2156   Dumps a fully constructed but uncompressed trie in list form.
2157   List tries normally only are used for construction when the number of
2158   possible chars (trie->uniquecharcount) is very high.
2159   Used for debugging make_trie().
2160 */
2161 STATIC void
2162 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2163                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2164                          U32 depth)
2165 {
2166     U32 state;
2167     SV *sv=sv_newmortal();
2168     int colwidth= widecharmap ? 6 : 4;
2169     GET_RE_DEBUG_FLAGS_DECL;
2170
2171     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2172
2173     /* print out the table precompression.  */
2174     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2175             depth+1 );
2176     Perl_re_indentf( aTHX_  "%s",
2177             depth+1, "------:-----+-----------------\n" );
2178
2179     for( state=1 ; state < next_alloc ; state ++ ) {
2180         U16 charid;
2181
2182         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2183             depth+1, (UV)state  );
2184         if ( ! trie->states[ state ].wordnum ) {
2185             Perl_re_printf( aTHX_  "%5s| ","");
2186         } else {
2187             Perl_re_printf( aTHX_  "W%4x| ",
2188                 trie->states[ state ].wordnum
2189             );
2190         }
2191         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2192             SV ** const tmp = av_fetch( revcharmap,
2193                                         TRIE_LIST_ITEM(state,charid).forid, 0);
2194             if ( tmp ) {
2195                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2196                     colwidth,
2197                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2198                               colwidth,
2199                               PL_colors[0], PL_colors[1],
2200                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2201                               | PERL_PV_ESCAPE_FIRSTCHAR
2202                     ) ,
2203                     TRIE_LIST_ITEM(state,charid).forid,
2204                     (UV)TRIE_LIST_ITEM(state,charid).newstate
2205                 );
2206                 if (!(charid % 10))
2207                     Perl_re_printf( aTHX_  "\n%*s| ",
2208                         (int)((depth * 2) + 14), "");
2209             }
2210         }
2211         Perl_re_printf( aTHX_  "\n");
2212     }
2213 }
2214
2215 /*
2216   Dumps a fully constructed but uncompressed trie in table form.
2217   This is the normal DFA style state transition table, with a few
2218   twists to facilitate compression later.
2219   Used for debugging make_trie().
2220 */
2221 STATIC void
2222 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2223                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2224                           U32 depth)
2225 {
2226     U32 state;
2227     U16 charid;
2228     SV *sv=sv_newmortal();
2229     int colwidth= widecharmap ? 6 : 4;
2230     GET_RE_DEBUG_FLAGS_DECL;
2231
2232     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2233
2234     /*
2235        print out the table precompression so that we can do a visual check
2236        that they are identical.
2237      */
2238
2239     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2240
2241     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2242         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2243         if ( tmp ) {
2244             Perl_re_printf( aTHX_  "%*s",
2245                 colwidth,
2246                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2247                             PL_colors[0], PL_colors[1],
2248                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2249                             PERL_PV_ESCAPE_FIRSTCHAR
2250                 )
2251             );
2252         }
2253     }
2254
2255     Perl_re_printf( aTHX_ "\n");
2256     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2257
2258     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2259         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2260     }
2261
2262     Perl_re_printf( aTHX_  "\n" );
2263
2264     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2265
2266         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2267             depth+1,
2268             (UV)TRIE_NODENUM( state ) );
2269
2270         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2271             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2272             if (v)
2273                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2274             else
2275                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2276         }
2277         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2278             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2279                                             (UV)trie->trans[ state ].check );
2280         } else {
2281             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2282                                             (UV)trie->trans[ state ].check,
2283             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2284         }
2285     }
2286 }
2287
2288 #endif
2289
2290
2291 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2292   startbranch: the first branch in the whole branch sequence
2293   first      : start branch of sequence of branch-exact nodes.
2294                May be the same as startbranch
2295   last       : Thing following the last branch.
2296                May be the same as tail.
2297   tail       : item following the branch sequence
2298   count      : words in the sequence
2299   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2300   depth      : indent depth
2301
2302 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2303
2304 A trie is an N'ary tree where the branches are determined by digital
2305 decomposition of the key. IE, at the root node you look up the 1st character and
2306 follow that branch repeat until you find the end of the branches. Nodes can be
2307 marked as "accepting" meaning they represent a complete word. Eg:
2308
2309   /he|she|his|hers/
2310
2311 would convert into the following structure. Numbers represent states, letters
2312 following numbers represent valid transitions on the letter from that state, if
2313 the number is in square brackets it represents an accepting state, otherwise it
2314 will be in parenthesis.
2315
2316       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2317       |    |
2318       |   (2)
2319       |    |
2320      (1)   +-i->(6)-+-s->[7]
2321       |
2322       +-s->(3)-+-h->(4)-+-e->[5]
2323
2324       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2325
2326 This shows that when matching against the string 'hers' we will begin at state 1
2327 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2328 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2329 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2330 single traverse. We store a mapping from accepting to state to which word was
2331 matched, and then when we have multiple possibilities we try to complete the
2332 rest of the regex in the order in which they occurred in the alternation.
2333
2334 The only prior NFA like behaviour that would be changed by the TRIE support is
2335 the silent ignoring of duplicate alternations which are of the form:
2336
2337  / (DUPE|DUPE) X? (?{ ... }) Y /x
2338
2339 Thus EVAL blocks following a trie may be called a different number of times with
2340 and without the optimisation. With the optimisations dupes will be silently
2341 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2342 the following demonstrates:
2343
2344  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2345
2346 which prints out 'word' three times, but
2347
2348  'words'=~/(word|word|word)(?{ print $1 })S/
2349
2350 which doesnt print it out at all. This is due to other optimisations kicking in.
2351
2352 Example of what happens on a structural level:
2353
2354 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2355
2356    1: CURLYM[1] {1,32767}(18)
2357    5:   BRANCH(8)
2358    6:     EXACT <ac>(16)
2359    8:   BRANCH(11)
2360    9:     EXACT <ad>(16)
2361   11:   BRANCH(14)
2362   12:     EXACT <ab>(16)
2363   16:   SUCCEED(0)
2364   17:   NOTHING(18)
2365   18: END(0)
2366
2367 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2368 and should turn into:
2369
2370    1: CURLYM[1] {1,32767}(18)
2371    5:   TRIE(16)
2372         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2373           <ac>
2374           <ad>
2375           <ab>
2376   16:   SUCCEED(0)
2377   17:   NOTHING(18)
2378   18: END(0)
2379
2380 Cases where tail != last would be like /(?foo|bar)baz/:
2381
2382    1: BRANCH(4)
2383    2:   EXACT <foo>(8)
2384    4: BRANCH(7)
2385    5:   EXACT <bar>(8)
2386    7: TAIL(8)
2387    8: EXACT <baz>(10)
2388   10: END(0)
2389
2390 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2391 and would end up looking like:
2392
2393     1: TRIE(8)
2394       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2395         <foo>
2396         <bar>
2397    7: TAIL(8)
2398    8: EXACT <baz>(10)
2399   10: END(0)
2400
2401     d = uvchr_to_utf8_flags(d, uv, 0);
2402
2403 is the recommended Unicode-aware way of saying
2404
2405     *(d++) = uv;
2406 */
2407
2408 #define TRIE_STORE_REVCHAR(val)                                            \
2409     STMT_START {                                                           \
2410         if (UTF) {                                                         \
2411             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2412             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2413             unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
2414             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2415             SvPOK_on(zlopp);                                               \
2416             SvUTF8_on(zlopp);                                              \
2417             av_push(revcharmap, zlopp);                                    \
2418         } else {                                                           \
2419             char ooooff = (char)val;                                           \
2420             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2421         }                                                                  \
2422         } STMT_END
2423
2424 /* This gets the next character from the input, folding it if not already
2425  * folded. */
2426 #define TRIE_READ_CHAR STMT_START {                                           \
2427     wordlen++;                                                                \
2428     if ( UTF ) {                                                              \
2429         /* if it is UTF then it is either already folded, or does not need    \
2430          * folding */                                                         \
2431         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2432     }                                                                         \
2433     else if (folder == PL_fold_latin1) {                                      \
2434         /* This folder implies Unicode rules, which in the range expressible  \
2435          *  by not UTF is the lower case, with the two exceptions, one of     \
2436          *  which should have been taken care of before calling this */       \
2437         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2438         uvc = toLOWER_L1(*uc);                                                \
2439         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2440         len = 1;                                                              \
2441     } else {                                                                  \
2442         /* raw data, will be folded later if needed */                        \
2443         uvc = (U32)*uc;                                                       \
2444         len = 1;                                                              \
2445     }                                                                         \
2446 } STMT_END
2447
2448
2449
2450 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2451     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2452         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2453         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2454         TRIE_LIST_LEN( state ) = ging;                          \
2455     }                                                           \
2456     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2457     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2458     TRIE_LIST_CUR( state )++;                                   \
2459 } STMT_END
2460
2461 #define TRIE_LIST_NEW(state) STMT_START {                       \
2462     Newx( trie->states[ state ].trans.list,                     \
2463         4, reg_trie_trans_le );                                 \
2464      TRIE_LIST_CUR( state ) = 1;                                \
2465      TRIE_LIST_LEN( state ) = 4;                                \
2466 } STMT_END
2467
2468 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2469     U16 dupe= trie->states[ state ].wordnum;                    \
2470     regnode * const noper_next = regnext( noper );              \
2471                                                                 \
2472     DEBUG_r({                                                   \
2473         /* store the word for dumping */                        \
2474         SV* tmp;                                                \
2475         if (OP(noper) != NOTHING)                               \
2476             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2477         else                                                    \
2478             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2479         av_push( trie_words, tmp );                             \
2480     });                                                         \
2481                                                                 \
2482     curword++;                                                  \
2483     trie->wordinfo[curword].prev   = 0;                         \
2484     trie->wordinfo[curword].len    = wordlen;                   \
2485     trie->wordinfo[curword].accept = state;                     \
2486                                                                 \
2487     if ( noper_next < tail ) {                                  \
2488         if (!trie->jump)                                        \
2489             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2490                                                  sizeof(U16) ); \
2491         trie->jump[curword] = (U16)(noper_next - convert);      \
2492         if (!jumper)                                            \
2493             jumper = noper_next;                                \
2494         if (!nextbranch)                                        \
2495             nextbranch= regnext(cur);                           \
2496     }                                                           \
2497                                                                 \
2498     if ( dupe ) {                                               \
2499         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2500         /* chain, so that when the bits of chain are later    */\
2501         /* linked together, the dups appear in the chain      */\
2502         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2503         trie->wordinfo[dupe].prev = curword;                    \
2504     } else {                                                    \
2505         /* we haven't inserted this word yet.                */ \
2506         trie->states[ state ].wordnum = curword;                \
2507     }                                                           \
2508 } STMT_END
2509
2510
2511 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2512      ( ( base + charid >=  ucharcount                                   \
2513          && base + charid < ubound                                      \
2514          && state == trie->trans[ base - ucharcount + charid ].check    \
2515          && trie->trans[ base - ucharcount + charid ].next )            \
2516            ? trie->trans[ base - ucharcount + charid ].next             \
2517            : ( state==1 ? special : 0 )                                 \
2518       )
2519
2520 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2521 STMT_START {                                                \
2522     TRIE_BITMAP_SET(trie, uvc);                             \
2523     /* store the folded codepoint */                        \
2524     if ( folder )                                           \
2525         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2526                                                             \
2527     if ( !UTF ) {                                           \
2528         /* store first byte of utf8 representation of */    \
2529         /* variant codepoints */                            \
2530         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2531             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2532         }                                                   \
2533     }                                                       \
2534 } STMT_END
2535 #define MADE_TRIE       1
2536 #define MADE_JUMP_TRIE  2
2537 #define MADE_EXACT_TRIE 4
2538
2539 STATIC I32
2540 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2541                   regnode *first, regnode *last, regnode *tail,
2542                   U32 word_count, U32 flags, U32 depth)
2543 {
2544     /* first pass, loop through and scan words */
2545     reg_trie_data *trie;
2546     HV *widecharmap = NULL;
2547     AV *revcharmap = newAV();
2548     regnode *cur;
2549     STRLEN len = 0;
2550     UV uvc = 0;
2551     U16 curword = 0;
2552     U32 next_alloc = 0;
2553     regnode *jumper = NULL;
2554     regnode *nextbranch = NULL;
2555     regnode *convert = NULL;
2556     U32 *prev_states; /* temp array mapping each state to previous one */
2557     /* we just use folder as a flag in utf8 */
2558     const U8 * folder = NULL;
2559
2560     /* in the below add_data call we are storing either 'tu' or 'tuaa'
2561      * which stands for one trie structure, one hash, optionally followed
2562      * by two arrays */
2563 #ifdef DEBUGGING
2564     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuaa"));
2565     AV *trie_words = NULL;
2566     /* along with revcharmap, this only used during construction but both are
2567      * useful during debugging so we store them in the struct when debugging.
2568      */
2569 #else
2570     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2571     STRLEN trie_charcount=0;
2572 #endif
2573     SV *re_trie_maxbuff;
2574     GET_RE_DEBUG_FLAGS_DECL;
2575
2576     PERL_ARGS_ASSERT_MAKE_TRIE;
2577 #ifndef DEBUGGING
2578     PERL_UNUSED_ARG(depth);
2579 #endif
2580
2581     switch (flags) {
2582         case EXACT: case EXACTL: break;
2583         case EXACTFAA:
2584         case EXACTFU_SS:
2585         case EXACTFU:
2586         case EXACTFLU8: folder = PL_fold_latin1; break;
2587         case EXACTF:  folder = PL_fold; break;
2588         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2589     }
2590
2591     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2592     trie->refcount = 1;
2593     trie->startstate = 1;
2594     trie->wordcount = word_count;
2595     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2596     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2597     if (flags == EXACT || flags == EXACTL)
2598         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2599     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2600                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2601
2602     DEBUG_r({
2603         trie_words = newAV();
2604     });
2605
2606     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2607     assert(re_trie_maxbuff);
2608     if (!SvIOK(re_trie_maxbuff)) {
2609         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2610     }
2611     DEBUG_TRIE_COMPILE_r({
2612         Perl_re_indentf( aTHX_
2613           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2614           depth+1,
2615           REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2616           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2617     });
2618
2619    /* Find the node we are going to overwrite */
2620     if ( first == startbranch && OP( last ) != BRANCH ) {
2621         /* whole branch chain */
2622         convert = first;
2623     } else {
2624         /* branch sub-chain */
2625         convert = NEXTOPER( first );
2626     }
2627
2628     /*  -- First loop and Setup --
2629
2630        We first traverse the branches and scan each word to determine if it
2631        contains widechars, and how many unique chars there are, this is
2632        important as we have to build a table with at least as many columns as we
2633        have unique chars.
2634
2635        We use an array of integers to represent the character codes 0..255
2636        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2637        the native representation of the character value as the key and IV's for
2638        the coded index.
2639
2640        *TODO* If we keep track of how many times each character is used we can
2641        remap the columns so that the table compression later on is more
2642        efficient in terms of memory by ensuring the most common value is in the
2643        middle and the least common are on the outside.  IMO this would be better
2644        than a most to least common mapping as theres a decent chance the most
2645        common letter will share a node with the least common, meaning the node
2646        will not be compressible. With a middle is most common approach the worst
2647        case is when we have the least common nodes twice.
2648
2649      */
2650
2651     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2652         regnode *noper = NEXTOPER( cur );
2653         const U8 *uc;
2654         const U8 *e;
2655         int foldlen = 0;
2656         U32 wordlen      = 0;         /* required init */
2657         STRLEN minchars = 0;
2658         STRLEN maxchars = 0;
2659         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2660                                                bitmap?*/
2661
2662         if (OP(noper) == NOTHING) {
2663             /* skip past a NOTHING at the start of an alternation
2664              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2665              */
2666             regnode *noper_next= regnext(noper);
2667             if (noper_next < tail)
2668                 noper= noper_next;
2669         }
2670
2671         if ( noper < tail &&
2672                 (
2673                     OP(noper) == flags ||
2674                     (
2675                         flags == EXACTFU &&
2676                         OP(noper) == EXACTFU_SS
2677                     )
2678                 )
2679         ) {
2680             uc= (U8*)STRING(noper);
2681             e= uc + STR_LEN(noper);
2682         } else {
2683             trie->minlen= 0;
2684             continue;
2685         }
2686
2687
2688         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2689             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2690                                           regardless of encoding */
2691             if (OP( noper ) == EXACTFU_SS) {
2692                 /* false positives are ok, so just set this */
2693                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2694             }
2695         }
2696
2697         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2698                                            branch */
2699             TRIE_CHARCOUNT(trie)++;
2700             TRIE_READ_CHAR;
2701
2702             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2703              * is in effect.  Under /i, this character can match itself, or
2704              * anything that folds to it.  If not under /i, it can match just
2705              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2706              * all fold to k, and all are single characters.   But some folds
2707              * expand to more than one character, so for example LATIN SMALL
2708              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2709              * the string beginning at 'uc' is 'ffi', it could be matched by
2710              * three characters, or just by the one ligature character. (It
2711              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2712              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2713              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2714              * match.)  The trie needs to know the minimum and maximum number
2715              * of characters that could match so that it can use size alone to
2716              * quickly reject many match attempts.  The max is simple: it is
2717              * the number of folded characters in this branch (since a fold is
2718              * never shorter than what folds to it. */
2719
2720             maxchars++;
2721
2722             /* And the min is equal to the max if not under /i (indicated by
2723              * 'folder' being NULL), or there are no multi-character folds.  If
2724              * there is a multi-character fold, the min is incremented just
2725              * once, for the character that folds to the sequence.  Each
2726              * character in the sequence needs to be added to the list below of
2727              * characters in the trie, but we count only the first towards the
2728              * min number of characters needed.  This is done through the
2729              * variable 'foldlen', which is returned by the macros that look
2730              * for these sequences as the number of bytes the sequence
2731              * occupies.  Each time through the loop, we decrement 'foldlen' by
2732              * how many bytes the current char occupies.  Only when it reaches
2733              * 0 do we increment 'minchars' or look for another multi-character
2734              * sequence. */
2735             if (folder == NULL) {
2736                 minchars++;
2737             }
2738             else if (foldlen > 0) {
2739                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2740             }
2741             else {
2742                 minchars++;
2743
2744                 /* See if *uc is the beginning of a multi-character fold.  If
2745                  * so, we decrement the length remaining to look at, to account
2746                  * for the current character this iteration.  (We can use 'uc'
2747                  * instead of the fold returned by TRIE_READ_CHAR because for
2748                  * non-UTF, the latin1_safe macro is smart enough to account
2749                  * for all the unfolded characters, and because for UTF, the
2750                  * string will already have been folded earlier in the
2751                  * compilation process */
2752                 if (UTF) {
2753                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2754                         foldlen -= UTF8SKIP(uc);
2755                     }
2756                 }
2757                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2758                     foldlen--;
2759                 }
2760             }
2761
2762             /* The current character (and any potential folds) should be added
2763              * to the possible matching characters for this position in this
2764              * branch */
2765             if ( uvc < 256 ) {
2766                 if ( folder ) {
2767                     U8 folded= folder[ (U8) uvc ];
2768                     if ( !trie->charmap[ folded ] ) {
2769                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2770                         TRIE_STORE_REVCHAR( folded );
2771                     }
2772                 }
2773                 if ( !trie->charmap[ uvc ] ) {
2774                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2775                     TRIE_STORE_REVCHAR( uvc );
2776                 }
2777                 if ( set_bit ) {
2778                     /* store the codepoint in the bitmap, and its folded
2779                      * equivalent. */
2780                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2781                     set_bit = 0; /* We've done our bit :-) */
2782                 }
2783             } else {
2784
2785                 /* XXX We could come up with the list of code points that fold
2786                  * to this using PL_utf8_foldclosures, except not for
2787                  * multi-char folds, as there may be multiple combinations
2788                  * there that could work, which needs to wait until runtime to
2789                  * resolve (The comment about LIGATURE FFI above is such an
2790                  * example */
2791
2792                 SV** svpp;
2793                 if ( !widecharmap )
2794                     widecharmap = newHV();
2795
2796                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2797
2798                 if ( !svpp )
2799                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2800
2801                 if ( !SvTRUE( *svpp ) ) {
2802                     sv_setiv( *svpp, ++trie->uniquecharcount );
2803                     TRIE_STORE_REVCHAR(uvc);
2804                 }
2805             }
2806         } /* end loop through characters in this branch of the trie */
2807
2808         /* We take the min and max for this branch and combine to find the min
2809          * and max for all branches processed so far */
2810         if( cur == first ) {
2811             trie->minlen = minchars;
2812             trie->maxlen = maxchars;
2813         } else if (minchars < trie->minlen) {
2814             trie->minlen = minchars;
2815         } else if (maxchars > trie->maxlen) {
2816             trie->maxlen = maxchars;
2817         }
2818     } /* end first pass */
2819     DEBUG_TRIE_COMPILE_r(
2820         Perl_re_indentf( aTHX_
2821                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2822                 depth+1,
2823                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2824                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2825                 (int)trie->minlen, (int)trie->maxlen )
2826     );
2827
2828     /*
2829         We now know what we are dealing with in terms of unique chars and
2830         string sizes so we can calculate how much memory a naive
2831         representation using a flat table  will take. If it's over a reasonable
2832         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2833         conservative but potentially much slower representation using an array
2834         of lists.
2835
2836         At the end we convert both representations into the same compressed
2837         form that will be used in regexec.c for matching with. The latter
2838         is a form that cannot be used to construct with but has memory
2839         properties similar to the list form and access properties similar
2840         to the table form making it both suitable for fast searches and
2841         small enough that its feasable to store for the duration of a program.
2842
2843         See the comment in the code where the compressed table is produced
2844         inplace from the flat tabe representation for an explanation of how
2845         the compression works.
2846
2847     */
2848
2849
2850     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2851     prev_states[1] = 0;
2852
2853     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2854                                                     > SvIV(re_trie_maxbuff) )
2855     {
2856         /*
2857             Second Pass -- Array Of Lists Representation
2858
2859             Each state will be represented by a list of charid:state records
2860             (reg_trie_trans_le) the first such element holds the CUR and LEN
2861             points of the allocated array. (See defines above).
2862
2863             We build the initial structure using the lists, and then convert
2864             it into the compressed table form which allows faster lookups
2865             (but cant be modified once converted).
2866         */
2867
2868         STRLEN transcount = 1;
2869
2870         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
2871             depth+1));
2872
2873         trie->states = (reg_trie_state *)
2874             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2875                                   sizeof(reg_trie_state) );
2876         TRIE_LIST_NEW(1);
2877         next_alloc = 2;
2878
2879         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2880
2881             regnode *noper   = NEXTOPER( cur );
2882             U32 state        = 1;         /* required init */
2883             U16 charid       = 0;         /* sanity init */
2884             U32 wordlen      = 0;         /* required init */
2885
2886             if (OP(noper) == NOTHING) {
2887                 regnode *noper_next= regnext(noper);
2888                 if (noper_next < tail)
2889                     noper= noper_next;
2890             }
2891
2892             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
2893                 const U8 *uc= (U8*)STRING(noper);
2894                 const U8 *e= uc + STR_LEN(noper);
2895
2896                 for ( ; uc < e ; uc += len ) {
2897
2898                     TRIE_READ_CHAR;
2899
2900                     if ( uvc < 256 ) {
2901                         charid = trie->charmap[ uvc ];
2902                     } else {
2903                         SV** const svpp = hv_fetch( widecharmap,
2904                                                     (char*)&uvc,
2905                                                     sizeof( UV ),
2906                                                     0);
2907                         if ( !svpp ) {
2908                             charid = 0;
2909                         } else {
2910                             charid=(U16)SvIV( *svpp );
2911                         }
2912                     }
2913                     /* charid is now 0 if we dont know the char read, or
2914                      * nonzero if we do */
2915                     if ( charid ) {
2916
2917                         U16 check;
2918                         U32 newstate = 0;
2919
2920                         charid--;
2921                         if ( !trie->states[ state ].trans.list ) {
2922                             TRIE_LIST_NEW( state );
2923                         }
2924                         for ( check = 1;
2925                               check <= TRIE_LIST_USED( state );
2926                               check++ )
2927                         {
2928                             if ( TRIE_LIST_ITEM( state, check ).forid
2929                                                                     == charid )
2930                             {
2931                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2932                                 break;
2933                             }
2934                         }
2935                         if ( ! newstate ) {
2936                             newstate = next_alloc++;
2937                             prev_states[newstate] = state;
2938                             TRIE_LIST_PUSH( state, charid, newstate );
2939                             transcount++;
2940                         }
2941                         state = newstate;
2942                     } else {
2943                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
2944                     }
2945                 }
2946             }
2947             TRIE_HANDLE_WORD(state);
2948
2949         } /* end second pass */
2950
2951         /* next alloc is the NEXT state to be allocated */
2952         trie->statecount = next_alloc;
2953         trie->states = (reg_trie_state *)
2954             PerlMemShared_realloc( trie->states,
2955                                    next_alloc
2956                                    * sizeof(reg_trie_state) );
2957
2958         /* and now dump it out before we compress it */
2959         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2960                                                          revcharmap, next_alloc,
2961                                                          depth+1)
2962         );
2963
2964         trie->trans = (reg_trie_trans *)
2965             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2966         {
2967             U32 state;
2968             U32 tp = 0;
2969             U32 zp = 0;
2970
2971
2972             for( state=1 ; state < next_alloc ; state ++ ) {
2973                 U32 base=0;
2974
2975                 /*
2976                 DEBUG_TRIE_COMPILE_MORE_r(
2977                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
2978                 );
2979                 */
2980
2981                 if (trie->states[state].trans.list) {
2982                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2983                     U16 maxid=minid;
2984                     U16 idx;
2985
2986                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2987                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2988                         if ( forid < minid ) {
2989                             minid=forid;
2990                         } else if ( forid > maxid ) {
2991                             maxid=forid;
2992                         }
2993                     }
2994                     if ( transcount < tp + maxid - minid + 1) {
2995                         transcount *= 2;
2996                         trie->trans = (reg_trie_trans *)
2997                             PerlMemShared_realloc( trie->trans,
2998                                                      transcount
2999                                                      * sizeof(reg_trie_trans) );
3000                         Zero( trie->trans + (transcount / 2),
3001                               transcount / 2,
3002                               reg_trie_trans );
3003                     }
3004                     base = trie->uniquecharcount + tp - minid;
3005                     if ( maxid == minid ) {
3006                         U32 set = 0;
3007                         for ( ; zp < tp ; zp++ ) {
3008                             if ( ! trie->trans[ zp ].next ) {
3009                                 base = trie->uniquecharcount + zp - minid;
3010                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
3011                                                                    1).newstate;
3012                                 trie->trans[ zp ].check = state;
3013                                 set = 1;
3014                                 break;
3015                             }
3016                         }
3017                         if ( !set ) {
3018                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
3019                                                                    1).newstate;
3020                             trie->trans[ tp ].check = state;
3021                             tp++;
3022                             zp = tp;
3023                         }
3024                     } else {
3025                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3026                             const U32 tid = base
3027                                            - trie->uniquecharcount
3028                                            + TRIE_LIST_ITEM( state, idx ).forid;
3029                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
3030                                                                 idx ).newstate;
3031                             trie->trans[ tid ].check = state;
3032                         }
3033                         tp += ( maxid - minid + 1 );
3034                     }
3035                     Safefree(trie->states[ state ].trans.list);
3036                 }
3037                 /*
3038                 DEBUG_TRIE_COMPILE_MORE_r(
3039                     Perl_re_printf( aTHX_  " base: %d\n",base);
3040                 );
3041                 */
3042                 trie->states[ state ].trans.base=base;
3043             }
3044             trie->lasttrans = tp + 1;
3045         }
3046     } else {
3047         /*
3048            Second Pass -- Flat Table Representation.
3049
3050            we dont use the 0 slot of either trans[] or states[] so we add 1 to
3051            each.  We know that we will need Charcount+1 trans at most to store
3052            the data (one row per char at worst case) So we preallocate both
3053            structures assuming worst case.
3054
3055            We then construct the trie using only the .next slots of the entry
3056            structs.
3057
3058            We use the .check field of the first entry of the node temporarily
3059            to make compression both faster and easier by keeping track of how
3060            many non zero fields are in the node.
3061
3062            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
3063            transition.
3064
3065            There are two terms at use here: state as a TRIE_NODEIDX() which is
3066            a number representing the first entry of the node, and state as a
3067            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
3068            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
3069            if there are 2 entrys per node. eg:
3070
3071              A B       A B
3072           1. 2 4    1. 3 7
3073           2. 0 3    3. 0 5
3074           3. 0 0    5. 0 0
3075           4. 0 0    7. 0 0
3076
3077            The table is internally in the right hand, idx form. However as we
3078            also have to deal with the states array which is indexed by nodenum
3079            we have to use TRIE_NODENUM() to convert.
3080
3081         */
3082         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
3083             depth+1));
3084
3085         trie->trans = (reg_trie_trans *)
3086             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
3087                                   * trie->uniquecharcount + 1,
3088                                   sizeof(reg_trie_trans) );
3089         trie->states = (reg_trie_state *)
3090             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3091                                   sizeof(reg_trie_state) );
3092         next_alloc = trie->uniquecharcount + 1;
3093
3094
3095         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3096
3097             regnode *noper   = NEXTOPER( cur );
3098
3099             U32 state        = 1;         /* required init */
3100
3101             U16 charid       = 0;         /* sanity init */
3102             U32 accept_state = 0;         /* sanity init */
3103
3104             U32 wordlen      = 0;         /* required init */
3105
3106             if (OP(noper) == NOTHING) {
3107                 regnode *noper_next= regnext(noper);
3108                 if (noper_next < tail)
3109                     noper= noper_next;
3110             }
3111
3112             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
3113                 const U8 *uc= (U8*)STRING(noper);
3114                 const U8 *e= uc + STR_LEN(noper);
3115
3116                 for ( ; uc < e ; uc += len ) {
3117
3118                     TRIE_READ_CHAR;
3119
3120                     if ( uvc < 256 ) {
3121                         charid = trie->charmap[ uvc ];
3122                     } else {
3123                         SV* const * const svpp = hv_fetch( widecharmap,
3124                                                            (char*)&uvc,
3125                                                            sizeof( UV ),
3126                                                            0);
3127                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3128                     }
3129                     if ( charid ) {
3130                         charid--;
3131                         if ( !trie->trans[ state + charid ].next ) {
3132                             trie->trans[ state + charid ].next = next_alloc;
3133                             trie->trans[ state ].check++;
3134                             prev_states[TRIE_NODENUM(next_alloc)]
3135                                     = TRIE_NODENUM(state);
3136                             next_alloc += trie->uniquecharcount;
3137                         }
3138                         state = trie->trans[ state + charid ].next;
3139                     } else {
3140                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3141                     }
3142                     /* charid is now 0 if we dont know the char read, or
3143                      * nonzero if we do */
3144                 }
3145             }
3146             accept_state = TRIE_NODENUM( state );
3147             TRIE_HANDLE_WORD(accept_state);
3148
3149         } /* end second pass */
3150
3151         /* and now dump it out before we compress it */
3152         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3153                                                           revcharmap,
3154                                                           next_alloc, depth+1));
3155
3156         {
3157         /*
3158            * Inplace compress the table.*
3159
3160            For sparse data sets the table constructed by the trie algorithm will
3161            be mostly 0/FAIL transitions or to put it another way mostly empty.
3162            (Note that leaf nodes will not contain any transitions.)
3163
3164            This algorithm compresses the tables by eliminating most such
3165            transitions, at the cost of a modest bit of extra work during lookup:
3166
3167            - Each states[] entry contains a .base field which indicates the
3168            index in the state[] array wheres its transition data is stored.
3169
3170            - If .base is 0 there are no valid transitions from that node.
3171
3172            - If .base is nonzero then charid is added to it to find an entry in
3173            the trans array.
3174
3175            -If trans[states[state].base+charid].check!=state then the
3176            transition is taken to be a 0/Fail transition. Thus if there are fail
3177            transitions at the front of the node then the .base offset will point
3178            somewhere inside the previous nodes data (or maybe even into a node
3179            even earlier), but the .check field determines if the transition is
3180            valid.
3181
3182            XXX - wrong maybe?
3183            The following process inplace converts the table to the compressed
3184            table: We first do not compress the root node 1,and mark all its
3185            .check pointers as 1 and set its .base pointer as 1 as well. This
3186            allows us to do a DFA construction from the compressed table later,
3187            and ensures that any .base pointers we calculate later are greater
3188            than 0.
3189
3190            - We set 'pos' to indicate the first entry of the second node.
3191
3192            - We then iterate over the columns of the node, finding the first and
3193            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3194            and set the .check pointers accordingly, and advance pos
3195            appropriately and repreat for the next node. Note that when we copy
3196            the next pointers we have to convert them from the original
3197            NODEIDX form to NODENUM form as the former is not valid post
3198            compression.
3199
3200            - If a node has no transitions used we mark its base as 0 and do not
3201            advance the pos pointer.
3202
3203            - If a node only has one transition we use a second pointer into the
3204            structure to fill in allocated fail transitions from other states.
3205            This pointer is independent of the main pointer and scans forward
3206            looking for null transitions that are allocated to a state. When it
3207            finds one it writes the single transition into the "hole".  If the
3208            pointer doesnt find one the single transition is appended as normal.
3209
3210            - Once compressed we can Renew/realloc the structures to release the
3211            excess space.
3212
3213            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3214            specifically Fig 3.47 and the associated pseudocode.
3215
3216            demq
3217         */
3218         const U32 laststate = TRIE_NODENUM( next_alloc );
3219         U32 state, charid;
3220         U32 pos = 0, zp=0;
3221         trie->statecount = laststate;
3222
3223         for ( state = 1 ; state < laststate ; state++ ) {
3224             U8 flag = 0;
3225             const U32 stateidx = TRIE_NODEIDX( state );
3226             const U32 o_used = trie->trans[ stateidx ].check;
3227             U32 used = trie->trans[ stateidx ].check;
3228             trie->trans[ stateidx ].check = 0;
3229
3230             for ( charid = 0;
3231                   used && charid < trie->uniquecharcount;
3232                   charid++ )
3233             {
3234                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3235                     if ( trie->trans[ stateidx + charid ].next ) {
3236                         if (o_used == 1) {
3237                             for ( ; zp < pos ; zp++ ) {
3238                                 if ( ! trie->trans[ zp ].next ) {
3239                                     break;
3240                                 }
3241                             }
3242                             trie->states[ state ].trans.base
3243                                                     = zp
3244                                                       + trie->uniquecharcount
3245                                                       - charid ;
3246                             trie->trans[ zp ].next
3247                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3248                                                              + charid ].next );
3249                             trie->trans[ zp ].check = state;
3250                             if ( ++zp > pos ) pos = zp;
3251                             break;
3252                         }
3253                         used--;
3254                     }
3255                     if ( !flag ) {
3256                         flag = 1;
3257                         trie->states[ state ].trans.base
3258                                        = pos + trie->uniquecharcount - charid ;
3259                     }
3260                     trie->trans[ pos ].next
3261                         = SAFE_TRIE_NODENUM(
3262                                        trie->trans[ stateidx + charid ].next );
3263                     trie->trans[ pos ].check = state;
3264                     pos++;
3265                 }
3266             }
3267         }
3268         trie->lasttrans = pos + 1;
3269         trie->states = (reg_trie_state *)
3270             PerlMemShared_realloc( trie->states, laststate
3271                                    * sizeof(reg_trie_state) );
3272         DEBUG_TRIE_COMPILE_MORE_r(
3273             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3274                 depth+1,
3275                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3276                        + 1 ),
3277                 (IV)next_alloc,
3278                 (IV)pos,
3279                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3280             );
3281
3282         } /* end table compress */
3283     }
3284     DEBUG_TRIE_COMPILE_MORE_r(
3285             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3286                 depth+1,
3287                 (UV)trie->statecount,
3288                 (UV)trie->lasttrans)
3289     );
3290     /* resize the trans array to remove unused space */
3291     trie->trans = (reg_trie_trans *)
3292         PerlMemShared_realloc( trie->trans, trie->lasttrans
3293                                * sizeof(reg_trie_trans) );
3294
3295     {   /* Modify the program and insert the new TRIE node */
3296         U8 nodetype =(U8)(flags & 0xFF);
3297         char *str=NULL;
3298
3299 #ifdef DEBUGGING
3300         regnode *optimize = NULL;
3301 #ifdef RE_TRACK_PATTERN_OFFSETS
3302
3303         U32 mjd_offset = 0;
3304         U32 mjd_nodelen = 0;
3305 #endif /* RE_TRACK_PATTERN_OFFSETS */
3306 #endif /* DEBUGGING */
3307         /*
3308            This means we convert either the first branch or the first Exact,
3309            depending on whether the thing following (in 'last') is a branch
3310            or not and whther first is the startbranch (ie is it a sub part of
3311            the alternation or is it the whole thing.)
3312            Assuming its a sub part we convert the EXACT otherwise we convert
3313            the whole branch sequence, including the first.
3314          */
3315         /* Find the node we are going to overwrite */
3316         if ( first != startbranch || OP( last ) == BRANCH ) {
3317             /* branch sub-chain */
3318             NEXT_OFF( first ) = (U16)(last - first);
3319 #ifdef RE_TRACK_PATTERN_OFFSETS
3320             DEBUG_r({
3321                 mjd_offset= Node_Offset((convert));
3322                 mjd_nodelen= Node_Length((convert));
3323             });
3324 #endif
3325             /* whole branch chain */
3326         }
3327 #ifdef RE_TRACK_PATTERN_OFFSETS
3328         else {
3329             DEBUG_r({
3330                 const  regnode *nop = NEXTOPER( convert );
3331                 mjd_offset= Node_Offset((nop));
3332                 mjd_nodelen= Node_Length((nop));
3333             });
3334         }
3335         DEBUG_OPTIMISE_r(
3336             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3337                 depth+1,
3338                 (UV)mjd_offset, (UV)mjd_nodelen)
3339         );
3340 #endif
3341         /* But first we check to see if there is a common prefix we can
3342            split out as an EXACT and put in front of the TRIE node.  */
3343         trie->startstate= 1;
3344         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3345             /* we want to find the first state that has more than
3346              * one transition, if that state is not the first state
3347              * then we have a common prefix which we can remove.
3348              */
3349             U32 state;
3350             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3351                 U32 ofs = 0;
3352                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3353                                        transition, -1 means none */
3354                 U32 count = 0;
3355                 const U32 base = trie->states[ state ].trans.base;
3356
3357                 /* does this state terminate an alternation? */
3358                 if ( trie->states[state].wordnum )
3359                         count = 1;
3360
3361                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3362                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3363                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3364                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3365                     {
3366                         if ( ++count > 1 ) {
3367                             /* we have more than one transition */
3368                             SV **tmp;
3369                             U8 *ch;
3370                             /* if this is the first state there is no common prefix
3371                              * to extract, so we can exit */
3372                             if ( state == 1 ) break;
3373                             tmp = av_fetch( revcharmap, ofs, 0);
3374                             ch = (U8*)SvPV_nolen_const( *tmp );
3375
3376                             /* if we are on count 2 then we need to initialize the
3377                              * bitmap, and store the previous char if there was one
3378                              * in it*/
3379                             if ( count == 2 ) {
3380                                 /* clear the bitmap */
3381                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3382                                 DEBUG_OPTIMISE_r(
3383                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3384                                         depth+1,
3385                                         (UV)state));
3386                                 if (first_ofs >= 0) {
3387                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3388                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3389
3390                                     TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3391                                     DEBUG_OPTIMISE_r(
3392                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3393                                     );
3394                                 }
3395                             }
3396                             /* store the current firstchar in the bitmap */
3397                             TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3398                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3399                         }
3400                         first_ofs = ofs;
3401                     }
3402                 }
3403                 if ( count == 1 ) {
3404                     /* This state has only one transition, its transition is part
3405                      * of a common prefix - we need to concatenate the char it
3406                      * represents to what we have so far. */
3407                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3408                     STRLEN len;
3409                     char *ch = SvPV( *tmp, len );
3410                     DEBUG_OPTIMISE_r({
3411                         SV *sv=sv_newmortal();
3412                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3413                             depth+1,
3414                             (UV)state, (UV)first_ofs,
3415                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3416                                 PL_colors[0], PL_colors[1],
3417                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3418                                 PERL_PV_ESCAPE_FIRSTCHAR
3419                             )
3420                         );
3421                     });
3422                     if ( state==1 ) {
3423                         OP( convert ) = nodetype;
3424                         str=STRING(convert);
3425                         STR_LEN(convert)=0;
3426                     }
3427                     STR_LEN(convert) += len;
3428                     while (len--)
3429                         *str++ = *ch++;
3430                 } else {
3431 #ifdef DEBUGGING
3432                     if (state>1)
3433                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3434 #endif
3435                     break;
3436                 }
3437             }
3438             trie->prefixlen = (state-1);
3439             if (str) {
3440                 regnode *n = convert+NODE_SZ_STR(convert);
3441                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3442                 trie->startstate = state;
3443                 trie->minlen -= (state - 1);
3444                 trie->maxlen -= (state - 1);
3445 #ifdef DEBUGGING
3446                /* At least the UNICOS C compiler choked on this
3447                 * being argument to DEBUG_r(), so let's just have
3448                 * it right here. */
3449                if (
3450 #ifdef PERL_EXT_RE_BUILD
3451                    1
3452 #else
3453                    DEBUG_r_TEST
3454 #endif
3455                    ) {
3456                    regnode *fix = convert;
3457                    U32 word = trie->wordcount;
3458                    mjd_nodelen++;
3459                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3460                    while( ++fix < n ) {
3461                        Set_Node_Offset_Length(fix, 0, 0);
3462                    }
3463                    while (word--) {
3464                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3465                        if (tmp) {
3466                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3467                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3468                            else
3469                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3470                        }
3471                    }
3472                }
3473 #endif
3474                 if (trie->maxlen) {
3475                     convert = n;
3476                 } else {
3477                     NEXT_OFF(convert) = (U16)(tail - convert);
3478                     DEBUG_r(optimize= n);
3479                 }
3480             }
3481         }
3482         if (!jumper)
3483             jumper = last;
3484         if ( trie->maxlen ) {
3485             NEXT_OFF( convert ) = (U16)(tail - convert);
3486             ARG_SET( convert, data_slot );
3487             /* Store the offset to the first unabsorbed branch in
3488                jump[0], which is otherwise unused by the jump logic.
3489                We use this when dumping a trie and during optimisation. */
3490             if (trie->jump)
3491                 trie->jump[0] = (U16)(nextbranch - convert);
3492
3493             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3494              *   and there is a bitmap
3495              *   and the first "jump target" node we found leaves enough room
3496              * then convert the TRIE node into a TRIEC node, with the bitmap
3497              * embedded inline in the opcode - this is hypothetically faster.
3498              */
3499             if ( !trie->states[trie->startstate].wordnum
3500                  && trie->bitmap
3501                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3502             {
3503                 OP( convert ) = TRIEC;
3504                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3505                 PerlMemShared_free(trie->bitmap);
3506                 trie->bitmap= NULL;
3507             } else
3508                 OP( convert ) = TRIE;
3509
3510             /* store the type in the flags */
3511             convert->flags = nodetype;
3512             DEBUG_r({
3513             optimize = convert
3514                       + NODE_STEP_REGNODE
3515                       + regarglen[ OP( convert ) ];
3516             });
3517             /* XXX We really should free up the resource in trie now,
3518                    as we won't use them - (which resources?) dmq */
3519         }
3520         /* needed for dumping*/
3521         DEBUG_r(if (optimize) {
3522             regnode *opt = convert;
3523
3524             while ( ++opt < optimize) {
3525                 Set_Node_Offset_Length(opt,0,0);
3526             }
3527             /*
3528                 Try to clean up some of the debris left after the
3529                 optimisation.
3530              */
3531             while( optimize < jumper ) {
3532                 mjd_nodelen += Node_Length((optimize));
3533                 OP( optimize ) = OPTIMIZED;
3534                 Set_Node_Offset_Length(optimize,0,0);
3535                 optimize++;
3536             }
3537             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
3538         });
3539     } /* end node insert */
3540
3541     /*  Finish populating the prev field of the wordinfo array.  Walk back
3542      *  from each accept state until we find another accept state, and if
3543      *  so, point the first word's .prev field at the second word. If the
3544      *  second already has a .prev field set, stop now. This will be the
3545      *  case either if we've already processed that word's accept state,
3546      *  or that state had multiple words, and the overspill words were
3547      *  already linked up earlier.
3548      */
3549     {
3550         U16 word;
3551         U32 state;
3552         U16 prev;
3553
3554         for (word=1; word <= trie->wordcount; word++) {
3555             prev = 0;
3556             if (trie->wordinfo[word].prev)
3557                 continue;
3558             state = trie->wordinfo[word].accept;
3559             while (state) {
3560                 state = prev_states[state];
3561                 if (!state)
3562                     break;
3563                 prev = trie->states[state].wordnum;
3564                 if (prev)
3565                     break;
3566             }
3567             trie->wordinfo[word].prev = prev;
3568         }
3569         Safefree(prev_states);
3570     }
3571
3572
3573     /* and now dump out the compressed format */
3574     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3575
3576     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3577 #ifdef DEBUGGING
3578     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3579     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3580 #else
3581     SvREFCNT_dec_NN(revcharmap);
3582 #endif
3583     return trie->jump
3584            ? MADE_JUMP_TRIE
3585            : trie->startstate>1
3586              ? MADE_EXACT_TRIE
3587              : MADE_TRIE;
3588 }
3589
3590 STATIC regnode *
3591 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3592 {
3593 /* The Trie is constructed and compressed now so we can build a fail array if
3594  * it's needed
3595
3596    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3597    3.32 in the
3598    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3599    Ullman 1985/88
3600    ISBN 0-201-10088-6
3601
3602    We find the fail state for each state in the trie, this state is the longest
3603    proper suffix of the current state's 'word' that is also a proper prefix of
3604    another word in our trie. State 1 represents the word '' and is thus the
3605    default fail state. This allows the DFA not to have to restart after its
3606    tried and failed a word at a given point, it simply continues as though it
3607    had been matching the other word in the first place.
3608    Consider
3609       'abcdgu'=~/abcdefg|cdgu/
3610    When we get to 'd' we are still matching the first word, we would encounter
3611    'g' which would fail, which would bring us to the state representing 'd' in
3612    the second word where we would try 'g' and succeed, proceeding to match
3613    'cdgu'.
3614  */
3615  /* add a fail transition */
3616     const U32 trie_offset = ARG(source);
3617     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3618     U32 *q;
3619     const U32 ucharcount = trie->uniquecharcount;
3620     const U32 numstates = trie->statecount;
3621     const U32 ubound = trie->lasttrans + ucharcount;
3622     U32 q_read = 0;
3623     U32 q_write = 0;
3624     U32 charid;
3625     U32 base = trie->states[ 1 ].trans.base;
3626     U32 *fail;
3627     reg_ac_data *aho;
3628     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3629     regnode *stclass;
3630     GET_RE_DEBUG_FLAGS_DECL;
3631
3632     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3633     PERL_UNUSED_CONTEXT;
3634 #ifndef DEBUGGING
3635     PERL_UNUSED_ARG(depth);
3636 #endif
3637
3638     if ( OP(source) == TRIE ) {
3639         struct regnode_1 *op = (struct regnode_1 *)
3640             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3641         StructCopy(source,op,struct regnode_1);
3642         stclass = (regnode *)op;
3643     } else {
3644         struct regnode_charclass *op = (struct regnode_charclass *)
3645             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3646         StructCopy(source,op,struct regnode_charclass);
3647         stclass = (regnode *)op;
3648     }
3649     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3650
3651     ARG_SET( stclass, data_slot );
3652     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3653     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3654     aho->trie=trie_offset;
3655     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3656     Copy( trie->states, aho->states, numstates, reg_trie_state );
3657     Newx( q, numstates, U32);
3658     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3659     aho->refcount = 1;
3660     fail = aho->fail;
3661     /* initialize fail[0..1] to be 1 so that we always have
3662        a valid final fail state */
3663     fail[ 0 ] = fail[ 1 ] = 1;
3664
3665     for ( charid = 0; charid < ucharcount ; charid++ ) {
3666         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3667         if ( newstate ) {
3668             q[ q_write ] = newstate;
3669             /* set to point at the root */
3670             fail[ q[ q_write++ ] ]=1;
3671         }
3672     }
3673     while ( q_read < q_write) {
3674         const U32 cur = q[ q_read++ % numstates ];
3675         base = trie->states[ cur ].trans.base;
3676
3677         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3678             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3679             if (ch_state) {
3680                 U32 fail_state = cur;
3681                 U32 fail_base;
3682                 do {
3683                     fail_state = fail[ fail_state ];
3684                     fail_base = aho->states[ fail_state ].trans.base;
3685                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3686
3687                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3688                 fail[ ch_state ] = fail_state;
3689                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3690                 {
3691                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3692                 }
3693                 q[ q_write++ % numstates] = ch_state;
3694             }
3695         }
3696     }
3697     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3698        when we fail in state 1, this allows us to use the
3699        charclass scan to find a valid start char. This is based on the principle
3700        that theres a good chance the string being searched contains lots of stuff
3701        that cant be a start char.
3702      */
3703     fail[ 0 ] = fail[ 1 ] = 0;
3704     DEBUG_TRIE_COMPILE_r({
3705         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3706                       depth, (UV)numstates
3707         );
3708         for( q_read=1; q_read<numstates; q_read++ ) {
3709             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3710         }
3711         Perl_re_printf( aTHX_  "\n");
3712     });
3713     Safefree(q);
3714     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3715     return stclass;
3716 }
3717
3718
3719 /* The below joins as many adjacent EXACTish nodes as possible into a single
3720  * one.  The regop may be changed if the node(s) contain certain sequences that
3721  * require special handling.  The joining is only done if:
3722  * 1) there is room in the current conglomerated node to entirely contain the
3723  *    next one.
3724  * 2) they are the exact same node type
3725  *
3726  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3727  * these get optimized out
3728  *
3729  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3730  * as possible, even if that means splitting an existing node so that its first
3731  * part is moved to the preceeding node.  This would maximise the efficiency of
3732  * memEQ during matching.
3733  *
3734  * If a node is to match under /i (folded), the number of characters it matches
3735  * can be different than its character length if it contains a multi-character
3736  * fold.  *min_subtract is set to the total delta number of characters of the
3737  * input nodes.
3738  *
3739  * And *unfolded_multi_char is set to indicate whether or not the node contains
3740  * an unfolded multi-char fold.  This happens when it won't be known until
3741  * runtime whether the fold is valid or not; namely
3742  *  1) for EXACTF nodes that contain LATIN SMALL LETTER SHARP S, as only if the
3743  *      target string being matched against turns out to be UTF-8 is that fold
3744  *      valid; or
3745  *  2) for EXACTFL nodes whose folding rules depend on the locale in force at
3746  *      runtime.
3747  * (Multi-char folds whose components are all above the Latin1 range are not
3748  * run-time locale dependent, and have already been folded by the time this
3749  * function is called.)
3750  *
3751  * This is as good a place as any to discuss the design of handling these
3752  * multi-character fold sequences.  It's been wrong in Perl for a very long
3753  * time.  There are three code points in Unicode whose multi-character folds
3754  * were long ago discovered to mess things up.  The previous designs for
3755  * dealing with these involved assigning a special node for them.  This
3756  * approach doesn't always work, as evidenced by this example:
3757  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3758  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3759  * would match just the \xDF, it won't be able to handle the case where a
3760  * successful match would have to cross the node's boundary.  The new approach
3761  * that hopefully generally solves the problem generates an EXACTFU_SS node
3762  * that is "sss" in this case.
3763  *
3764  * It turns out that there are problems with all multi-character folds, and not
3765  * just these three.  Now the code is general, for all such cases.  The
3766  * approach taken is:
3767  * 1)   This routine examines each EXACTFish node that could contain multi-
3768  *      character folded sequences.  Since a single character can fold into
3769  *      such a sequence, the minimum match length for this node is less than
3770  *      the number of characters in the node.  This routine returns in
3771  *      *min_subtract how many characters to subtract from the the actual
3772  *      length of the string to get a real minimum match length; it is 0 if
3773  *      there are no multi-char foldeds.  This delta is used by the caller to
3774  *      adjust the min length of the match, and the delta between min and max,
3775  *      so that the optimizer doesn't reject these possibilities based on size
3776  *      constraints.
3777  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3778  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3779  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3780  *      there is a possible fold length change.  That means that a regular
3781  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3782  *      with length changes, and so can be processed faster.  regexec.c takes
3783  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3784  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3785  *      known until runtime).  This saves effort in regex matching.  However,
3786  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3787  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3788  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3789  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3790  *      possibilities for the non-UTF8 patterns are quite simple, except for
3791  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3792  *      members of a fold-pair, and arrays are set up for all of them so that
3793  *      the other member of the pair can be found quickly.  Code elsewhere in
3794  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3795  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3796  *      described in the next item.
3797  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3798  *      validity of the fold won't be known until runtime, and so must remain
3799  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFAA
3800  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3801  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3802  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3803  *      The reason this is a problem is that the optimizer part of regexec.c
3804  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3805  *      that a character in the pattern corresponds to at most a single
3806  *      character in the target string.  (And I do mean character, and not byte
3807  *      here, unlike other parts of the documentation that have never been
3808  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3809  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFAA
3810  *      nodes it can match "\x{17F}\x{17F}".  These, along with other ones in
3811  *      EXACTFL nodes, violate the assumption, and they are the only instances
3812  *      where it is violated.  I'm reluctant to try to change the assumption,
3813  *      as the code involved is impenetrable to me (khw), so instead the code
3814  *      here punts.  This routine examines EXACTFL nodes, and (when the pattern
3815  *      isn't UTF-8) EXACTF and EXACTFAA for such unfolded folds, and returns a
3816  *      boolean indicating whether or not the node contains such a fold.  When
3817  *      it is true, the caller sets a flag that later causes the optimizer in
3818  *      this file to not set values for the floating and fixed string lengths,
3819  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3820  *      assumption.  Thus, there is no optimization based on string lengths for
3821  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3822  *      EXACTF and EXACTFAA nodes that contain the sharp s.  (The reason the
3823  *      assumption is wrong only in these cases is that all other non-UTF-8
3824  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3825  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3826  *      EXACTF nodes because we don't know at compile time if it actually
3827  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3828  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3829  *      always matches; and EXACTFAA where it never does.  In an EXACTFAA node
3830  *      in a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3831  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3832  *      string would require the pattern to be forced into UTF-8, the overhead
3833  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3834  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3835  *      locale.)
3836  *
3837  *      Similarly, the code that generates tries doesn't currently handle
3838  *      not-already-folded multi-char folds, and it looks like a pain to change
3839  *      that.  Therefore, trie generation of EXACTFAA nodes with the sharp s
3840  *      doesn't work.  Instead, such an EXACTFAA is turned into a new regnode,
3841  *      EXACTFAA_NO_TRIE, which the trie code knows not to handle.  Most people
3842  *      using /iaa matching will be doing so almost entirely with ASCII
3843  *      strings, so this should rarely be encountered in practice */
3844
3845 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3846     if (PL_regkind[OP(scan)] == EXACT) \
3847         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3848
3849 STATIC U32
3850 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3851                    UV *min_subtract, bool *unfolded_multi_char,
3852                    U32 flags,regnode *val, U32 depth)
3853 {
3854     /* Merge several consecutive EXACTish nodes into one. */
3855     regnode *n = regnext(scan);
3856     U32 stringok = 1;
3857     regnode *next = scan + NODE_SZ_STR(scan);
3858     U32 merged = 0;
3859     U32 stopnow = 0;
3860 #ifdef DEBUGGING
3861     regnode *stop = scan;
3862     GET_RE_DEBUG_FLAGS_DECL;
3863 #else
3864     PERL_UNUSED_ARG(depth);
3865 #endif
3866
3867     PERL_ARGS_ASSERT_JOIN_EXACT;
3868 #ifndef EXPERIMENTAL_INPLACESCAN
3869     PERL_UNUSED_ARG(flags);
3870     PERL_UNUSED_ARG(val);
3871 #endif
3872     DEBUG_PEEP("join", scan, depth, 0);
3873
3874     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3875      * EXACT ones that are mergeable to the current one. */
3876     while (n
3877            && (PL_regkind[OP(n)] == NOTHING
3878                || (stringok && OP(n) == OP(scan)))
3879            && NEXT_OFF(n)
3880            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3881     {
3882
3883         if (OP(n) == TAIL || n > next)
3884             stringok = 0;
3885         if (PL_regkind[OP(n)] == NOTHING) {
3886             DEBUG_PEEP("skip:", n, depth, 0);
3887             NEXT_OFF(scan) += NEXT_OFF(n);
3888             next = n + NODE_STEP_REGNODE;
3889 #ifdef DEBUGGING
3890             if (stringok)
3891                 stop = n;
3892 #endif
3893             n = regnext(n);
3894         }
3895         else if (stringok) {
3896             const unsigned int oldl = STR_LEN(scan);
3897             regnode * const nnext = regnext(n);
3898
3899             /* XXX I (khw) kind of doubt that this works on platforms (should
3900              * Perl ever run on one) where U8_MAX is above 255 because of lots
3901              * of other assumptions */
3902             /* Don't join if the sum can't fit into a single node */
3903             if (oldl + STR_LEN(n) > U8_MAX)
3904                 break;
3905
3906             DEBUG_PEEP("merg", n, depth, 0);
3907             merged++;
3908
3909             NEXT_OFF(scan) += NEXT_OFF(n);
3910             STR_LEN(scan) += STR_LEN(n);
3911             next = n + NODE_SZ_STR(n);
3912             /* Now we can overwrite *n : */
3913             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3914 #ifdef DEBUGGING
3915             stop = next - 1;
3916 #endif
3917             n = nnext;
3918             if (stopnow) break;
3919         }
3920
3921 #ifdef EXPERIMENTAL_INPLACESCAN
3922         if (flags && !NEXT_OFF(n)) {
3923             DEBUG_PEEP("atch", val, depth, 0);
3924             if (reg_off_by_arg[OP(n)]) {
3925                 ARG_SET(n, val - n);
3926             }
3927             else {
3928                 NEXT_OFF(n) = val - n;
3929             }
3930             stopnow = 1;
3931         }
3932 #endif
3933     }
3934
3935     *min_subtract = 0;
3936     *unfolded_multi_char = FALSE;
3937
3938     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3939      * can now analyze for sequences of problematic code points.  (Prior to
3940      * this final joining, sequences could have been split over boundaries, and
3941      * hence missed).  The sequences only happen in folding, hence for any
3942      * non-EXACT EXACTish node */
3943     if (OP(scan) != EXACT && OP(scan) != EXACTL) {
3944         U8* s0 = (U8*) STRING(scan);
3945         U8* s = s0;
3946         U8* s_end = s0 + STR_LEN(scan);
3947
3948         int total_count_delta = 0;  /* Total delta number of characters that
3949                                        multi-char folds expand to */
3950
3951         /* One pass is made over the node's string looking for all the
3952          * possibilities.  To avoid some tests in the loop, there are two main
3953          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3954          * non-UTF-8 */
3955         if (UTF) {
3956             U8* folded = NULL;
3957
3958             if (OP(scan) == EXACTFL) {
3959                 U8 *d;
3960
3961                 /* An EXACTFL node would already have been changed to another
3962                  * node type unless there is at least one character in it that
3963                  * is problematic; likely a character whose fold definition
3964                  * won't be known until runtime, and so has yet to be folded.
3965                  * For all but the UTF-8 locale, folds are 1-1 in length, but
3966                  * to handle the UTF-8 case, we need to create a temporary
3967                  * folded copy using UTF-8 locale rules in order to analyze it.
3968                  * This is because our macros that look to see if a sequence is
3969                  * a multi-char fold assume everything is folded (otherwise the
3970                  * tests in those macros would be too complicated and slow).
3971                  * Note that here, the non-problematic folds will have already
3972                  * been done, so we can just copy such characters.  We actually
3973                  * don't completely fold the EXACTFL string.  We skip the
3974                  * unfolded multi-char folds, as that would just create work
3975                  * below to figure out the size they already are */
3976
3977                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3978                 d = folded;
3979                 while (s < s_end) {
3980                     STRLEN s_len = UTF8SKIP(s);
3981                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3982                         Copy(s, d, s_len, U8);
3983                         d += s_len;
3984                     }
3985                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
3986                         *unfolded_multi_char = TRUE;
3987                         Copy(s, d, s_len, U8);
3988                         d += s_len;
3989                     }
3990                     else if (isASCII(*s)) {
3991                         *(d++) = toFOLD(*s);
3992                     }
3993                     else {
3994                         STRLEN len;
3995                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
3996                         d += len;
3997                     }
3998                     s += s_len;
3999                 }
4000
4001                 /* Point the remainder of the routine to look at our temporary
4002                  * folded copy */
4003                 s = folded;
4004                 s_end = d;
4005             } /* End of creating folded copy of EXACTFL string */
4006
4007             /* Examine the string for a multi-character fold sequence.  UTF-8
4008              * patterns have all characters pre-folded by the time this code is
4009              * executed */
4010             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
4011                                      length sequence we are looking for is 2 */
4012             {
4013                 int count = 0;  /* How many characters in a multi-char fold */
4014                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
4015                 if (! len) {    /* Not a multi-char fold: get next char */
4016                     s += UTF8SKIP(s);
4017                     continue;
4018                 }
4019
4020                 /* Nodes with 'ss' require special handling, except for
4021                  * EXACTFAA-ish for which there is no multi-char fold to this */
4022                 if (len == 2 && *s == 's' && *(s+1) == 's'
4023                     && OP(scan) != EXACTFAA
4024                     && OP(scan) != EXACTFAA_NO_TRIE)
4025                 {
4026                     count = 2;
4027                     if (OP(scan) != EXACTFL) {
4028                         OP(scan) = EXACTFU_SS;
4029                     }
4030                     s += 2;
4031                 }
4032                 else { /* Here is a generic multi-char fold. */
4033                     U8* multi_end  = s + len;
4034
4035                     /* Count how many characters are in it.  In the case of
4036                      * /aa, no folds which contain ASCII code points are
4037                      * allowed, so check for those, and skip if found. */
4038                     if (OP(scan) != EXACTFAA && OP(scan) != EXACTFAA_NO_TRIE) {
4039                         count = utf8_length(s, multi_end);
4040                         s = multi_end;
4041                     }
4042                     else {
4043                         while (s < multi_end) {
4044                             if (isASCII(*s)) {
4045                                 s++;
4046                                 goto next_iteration;
4047                             }
4048                             else {
4049                                 s += UTF8SKIP(s);
4050                             }
4051                             count++;
4052                         }
4053                     }
4054                 }
4055
4056                 /* The delta is how long the sequence is minus 1 (1 is how long
4057                  * the character that folds to the sequence is) */
4058                 total_count_delta += count - 1;
4059               next_iteration: ;
4060             }
4061
4062             /* We created a temporary folded copy of the string in EXACTFL
4063              * nodes.  Therefore we need to be sure it doesn't go below zero,
4064              * as the real string could be shorter */
4065             if (OP(scan) == EXACTFL) {
4066                 int total_chars = utf8_length((U8*) STRING(scan),
4067                                            (U8*) STRING(scan) + STR_LEN(scan));
4068                 if (total_count_delta > total_chars) {
4069                     total_count_delta = total_chars;
4070                 }
4071             }
4072
4073             *min_subtract += total_count_delta;
4074             Safefree(folded);
4075         }
4076         else if (OP(scan) == EXACTFAA) {
4077
4078             /* Non-UTF-8 pattern, EXACTFAA node.  There can't be a multi-char
4079              * fold to the ASCII range (and there are no existing ones in the
4080              * upper latin1 range).  But, as outlined in the comments preceding
4081              * this function, we need to flag any occurrences of the sharp s.
4082              * This character forbids trie formation (because of added
4083              * complexity) */
4084 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
4085    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
4086                                       || UNICODE_DOT_DOT_VERSION > 0)
4087             while (s < s_end) {
4088                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
4089                     OP(scan) = EXACTFAA_NO_TRIE;
4090                     *unfolded_multi_char = TRUE;
4091                     break;
4092                 }
4093                 s++;
4094             }
4095         }
4096         else {
4097
4098             /* Non-UTF-8 pattern, not EXACTFAA node.  Look for the multi-char
4099              * folds that are all Latin1.  As explained in the comments
4100              * preceding this function, we look also for the sharp s in EXACTF
4101              * and EXACTFL nodes; it can be in the final position.  Otherwise
4102              * we can stop looking 1 byte earlier because have to find at least
4103              * two characters for a multi-fold */
4104             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
4105                               ? s_end
4106                               : s_end -1;
4107
4108             while (s < upper) {
4109                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
4110                 if (! len) {    /* Not a multi-char fold. */
4111                     if (*s == LATIN_SMALL_LETTER_SHARP_S
4112                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
4113                     {
4114                         *unfolded_multi_char = TRUE;
4115                     }
4116                     s++;
4117                     continue;
4118                 }
4119
4120                 if (len == 2
4121                     && isALPHA_FOLD_EQ(*s, 's')
4122                     && isALPHA_FOLD_EQ(*(s+1), 's'))
4123                 {
4124
4125                     /* EXACTF nodes need to know that the minimum length
4126                      * changed so that a sharp s in the string can match this
4127                      * ss in the pattern, but they remain EXACTF nodes, as they
4128                      * won't match this unless the target string is is UTF-8,
4129                      * which we don't know until runtime.  EXACTFL nodes can't
4130                      * transform into EXACTFU nodes */
4131                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
4132                         OP(scan) = EXACTFU_SS;
4133                     }
4134                 }
4135
4136                 *min_subtract += len - 1;
4137                 s += len;
4138             }
4139 #endif
4140         }
4141     }
4142
4143 #ifdef DEBUGGING
4144     /* Allow dumping but overwriting the collection of skipped
4145      * ops and/or strings with fake optimized ops */
4146     n = scan + NODE_SZ_STR(scan);
4147     while (n <= stop) {
4148         OP(n) = OPTIMIZED;
4149         FLAGS(n) = 0;
4150         NEXT_OFF(n) = 0;
4151         n++;
4152     }
4153 #endif
4154     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl", scan, depth, 0);});
4155     return stopnow;
4156 }
4157
4158 /* REx optimizer.  Converts nodes into quicker variants "in place".
4159    Finds fixed substrings.  */
4160
4161 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
4162    to the position after last scanned or to NULL. */
4163
4164 #define INIT_AND_WITHP \
4165     assert(!and_withp); \
4166     Newx(and_withp,1, regnode_ssc); \
4167     SAVEFREEPV(and_withp)
4168
4169
4170 static void
4171 S_unwind_scan_frames(pTHX_ const void *p)
4172 {
4173     scan_frame *f= (scan_frame *)p;
4174     do {
4175         scan_frame *n= f->next_frame;
4176         Safefree(f);
4177         f= n;
4178     } while (f);
4179 }
4180
4181 /* the return from this sub is the minimum length that could possibly match */
4182 STATIC SSize_t
4183 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
4184                         SSize_t *minlenp, SSize_t *deltap,
4185                         regnode *last,
4186                         scan_data_t *data,
4187                         I32 stopparen,
4188                         U32 recursed_depth,
4189                         regnode_ssc *and_withp,
4190                         U32 flags, U32 depth)
4191                         /* scanp: Start here (read-write). */
4192                         /* deltap: Write maxlen-minlen here. */
4193                         /* last: Stop before this one. */
4194                         /* data: string data about the pattern */
4195                         /* stopparen: treat close N as END */
4196                         /* recursed: which subroutines have we recursed into */
4197                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
4198 {
4199     /* There must be at least this number of characters to match */
4200     SSize_t min = 0;
4201     I32 pars = 0, code;
4202     regnode *scan = *scanp, *next;
4203     SSize_t delta = 0;
4204     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
4205     int is_inf_internal = 0;            /* The studied chunk is infinite */
4206     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
4207     scan_data_t data_fake;
4208     SV *re_trie_maxbuff = NULL;
4209     regnode *first_non_open = scan;
4210     SSize_t stopmin = SSize_t_MAX;
4211     scan_frame *frame = NULL;
4212     GET_RE_DEBUG_FLAGS_DECL;
4213
4214     PERL_ARGS_ASSERT_STUDY_CHUNK;
4215     RExC_study_started= 1;
4216
4217     Zero(&data_fake, 1, scan_data_t);
4218
4219     if ( depth == 0 ) {
4220         while (first_non_open && OP(first_non_open) == OPEN)
4221             first_non_open=regnext(first_non_open);
4222     }
4223
4224
4225   fake_study_recurse:
4226     DEBUG_r(
4227         RExC_study_chunk_recursed_count++;
4228     );
4229     DEBUG_OPTIMISE_MORE_r(
4230     {
4231         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4232             depth, (long)stopparen,
4233             (unsigned long)RExC_study_chunk_recursed_count,
4234             (unsigned long)depth, (unsigned long)recursed_depth,
4235             scan,
4236             last);
4237         if (recursed_depth) {
4238             U32 i;
4239             U32 j;
4240             for ( j = 0 ; j < recursed_depth ; j++ ) {
4241                 for ( i = 0 ; i < (U32)RExC_npar ; i++ ) {
4242                     if (
4243                         PAREN_TEST(RExC_study_chunk_recursed +
4244                                    ( j * RExC_study_chunk_recursed_bytes), i )
4245                         && (
4246                             !j ||
4247                             !PAREN_TEST(RExC_study_chunk_recursed +
4248                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
4249                         )
4250                     ) {
4251                         Perl_re_printf( aTHX_ " %d",(int)i);
4252                         break;
4253                     }
4254                 }
4255                 if ( j + 1 < recursed_depth ) {
4256                     Perl_re_printf( aTHX_  ",");
4257                 }
4258             }
4259         }
4260         Perl_re_printf( aTHX_ "\n");
4261     }
4262     );
4263     while ( scan && OP(scan) != END && scan < last ){
4264         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4265                                    node length to get a real minimum (because
4266                                    the folded version may be shorter) */
4267         bool unfolded_multi_char = FALSE;
4268         /* Peephole optimizer: */
4269         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4270         DEBUG_PEEP("Peep", scan, depth, flags);
4271
4272
4273         /* The reason we do this here is that we need to deal with things like
4274          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4275          * parsing code, as each (?:..) is handled by a different invocation of
4276          * reg() -- Yves
4277          */
4278         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
4279
4280         /* Follow the next-chain of the current node and optimize
4281            away all the NOTHINGs from it.  */
4282         if (OP(scan) != CURLYX) {
4283             const int max = (reg_off_by_arg[OP(scan)]
4284                        ? I32_MAX
4285                        /* I32 may be smaller than U16 on CRAYs! */
4286                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4287             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
4288             int noff;
4289             regnode *n = scan;
4290
4291             /* Skip NOTHING and LONGJMP. */
4292             while ((n = regnext(n))
4293                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4294                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
4295                    && off + noff < max)
4296                 off += noff;
4297             if (reg_off_by_arg[OP(scan)])
4298                 ARG(scan) = off;
4299             else
4300                 NEXT_OFF(scan) = off;
4301         }
4302
4303         /* The principal pseudo-switch.  Cannot be a switch, since we
4304            look into several different things.  */
4305         if ( OP(scan) == DEFINEP ) {
4306             SSize_t minlen = 0;
4307             SSize_t deltanext = 0;
4308             SSize_t fake_last_close = 0;
4309             I32 f = SCF_IN_DEFINE;
4310
4311             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4312             scan = regnext(scan);
4313             assert( OP(scan) == IFTHEN );
4314             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4315
4316             data_fake.last_closep= &fake_last_close;
4317             minlen = *minlenp;
4318             next = regnext(scan);
4319             scan = NEXTOPER(NEXTOPER(scan));
4320             DEBUG_PEEP("scan", scan, depth, flags);
4321             DEBUG_PEEP("next", next, depth, flags);
4322
4323             /* we suppose the run is continuous, last=next...
4324              * NOTE we dont use the return here! */
4325             /* DEFINEP study_chunk() recursion */
4326             (void)study_chunk(pRExC_state, &scan, &minlen,
4327                               &deltanext, next, &data_fake, stopparen,
4328                               recursed_depth, NULL, f, depth+1);
4329
4330             scan = next;
4331         } else
4332         if (
4333             OP(scan) == BRANCH  ||
4334             OP(scan) == BRANCHJ ||
4335             OP(scan) == IFTHEN
4336         ) {
4337             next = regnext(scan);
4338             code = OP(scan);
4339
4340             /* The op(next)==code check below is to see if we
4341              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4342              * IFTHEN is special as it might not appear in pairs.
4343              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4344              * we dont handle it cleanly. */
4345             if (OP(next) == code || code == IFTHEN) {
4346                 /* NOTE - There is similar code to this block below for
4347                  * handling TRIE nodes on a re-study.  If you change stuff here
4348                  * check there too. */
4349                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
4350                 regnode_ssc accum;
4351                 regnode * const startbranch=scan;
4352
4353                 if (flags & SCF_DO_SUBSTR) {
4354                     /* Cannot merge strings after this. */
4355                     scan_commit(pRExC_state, data, minlenp, is_inf);
4356                 }
4357
4358                 if (flags & SCF_DO_STCLASS)
4359                     ssc_init_zero(pRExC_state, &accum);
4360
4361                 while (OP(scan) == code) {
4362                     SSize_t deltanext, minnext, fake;
4363                     I32 f = 0;
4364                     regnode_ssc this_class;
4365
4366                     DEBUG_PEEP("Branch", scan, depth, flags);
4367
4368                     num++;
4369                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4370                     if (data) {
4371                         data_fake.whilem_c = data->whilem_c;
4372                         data_fake.last_closep = data->last_closep;
4373                     }
4374                     else
4375                         data_fake.last_closep = &fake;
4376
4377                     data_fake.pos_delta = delta;
4378                     next = regnext(scan);
4379
4380                     scan = NEXTOPER(scan); /* everything */
4381                     if (code != BRANCH)    /* everything but BRANCH */
4382                         scan = NEXTOPER(scan);
4383
4384                     if (flags & SCF_DO_STCLASS) {
4385                         ssc_init(pRExC_state, &this_class);
4386                         data_fake.start_class = &this_class;
4387                         f = SCF_DO_STCLASS_AND;
4388                     }
4389                     if (flags & SCF_WHILEM_VISITED_POS)
4390                         f |= SCF_WHILEM_VISITED_POS;
4391
4392                     /* we suppose the run is continuous, last=next...*/
4393                     /* recurse study_chunk() for each BRANCH in an alternation */
4394                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4395                                       &deltanext, next, &data_fake, stopparen,
4396                                       recursed_depth, NULL, f,depth+1);
4397
4398                     if (min1 > minnext)
4399                         min1 = minnext;
4400                     if (deltanext == SSize_t_MAX) {
4401                         is_inf = is_inf_internal = 1;
4402                         max1 = SSize_t_MAX;
4403                     } else if (max1 < minnext + deltanext)
4404                         max1 = minnext + deltanext;
4405                     scan = next;
4406                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4407                         pars++;
4408                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4409                         if ( stopmin > minnext)
4410                             stopmin = min + min1;
4411                         flags &= ~SCF_DO_SUBSTR;
4412                         if (data)
4413                             data->flags |= SCF_SEEN_ACCEPT;
4414                     }
4415                     if (data) {
4416                         if (data_fake.flags & SF_HAS_EVAL)
4417                             data->flags |= SF_HAS_EVAL;
4418                         data->whilem_c = data_fake.whilem_c;
4419                     }
4420                     if (flags & SCF_DO_STCLASS)
4421                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4422                 }
4423                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4424                     min1 = 0;
4425                 if (flags & SCF_DO_SUBSTR) {
4426                     data->pos_min += min1;
4427                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
4428                         data->pos_delta = SSize_t_MAX;
4429                     else
4430                         data->pos_delta += max1 - min1;
4431                     if (max1 != min1 || is_inf)
4432                         data->cur_is_floating = 1;
4433                 }
4434                 min += min1;
4435                 if (delta == SSize_t_MAX
4436                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4437                     delta = SSize_t_MAX;
4438                 else
4439                     delta += max1 - min1;
4440                 if (flags & SCF_DO_STCLASS_OR) {
4441                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4442                     if (min1) {
4443                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4444                         flags &= ~SCF_DO_STCLASS;
4445                     }
4446                 }
4447                 else if (flags & SCF_DO_STCLASS_AND) {
4448                     if (min1) {
4449                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4450                         flags &= ~SCF_DO_STCLASS;
4451                     }
4452                     else {
4453                         /* Switch to OR mode: cache the old value of
4454                          * data->start_class */
4455                         INIT_AND_WITHP;
4456                         StructCopy(data->start_class, and_withp, regnode_ssc);
4457                         flags &= ~SCF_DO_STCLASS_AND;
4458                         StructCopy(&accum, data->start_class, regnode_ssc);
4459                         flags |= SCF_DO_STCLASS_OR;
4460                     }
4461                 }
4462
4463                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4464                         OP( startbranch ) == BRANCH )
4465                 {
4466                 /* demq.
4467
4468                    Assuming this was/is a branch we are dealing with: 'scan'
4469                    now points at the item that follows the branch sequence,
4470                    whatever it is. We now start at the beginning of the
4471                    sequence and look for subsequences of
4472
4473                    BRANCH->EXACT=>x1
4474                    BRANCH->EXACT=>x2
4475                    tail
4476
4477                    which would be constructed from a pattern like
4478                    /A|LIST|OF|WORDS/
4479
4480                    If we can find such a subsequence we need to turn the first
4481                    element into a trie and then add the subsequent branch exact
4482                    strings to the trie.
4483
4484                    We have two cases
4485
4486                      1. patterns where the whole set of branches can be
4487                         converted.
4488
4489                      2. patterns where only a subset can be converted.
4490
4491                    In case 1 we can replace the whole set with a single regop
4492                    for the trie. In case 2 we need to keep the start and end
4493                    branches so
4494
4495                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4496                      becomes BRANCH TRIE; BRANCH X;
4497
4498                   There is an additional case, that being where there is a
4499                   common prefix, which gets split out into an EXACT like node
4500                   preceding the TRIE node.
4501
4502                   If x(1..n)==tail then we can do a simple trie, if not we make
4503                   a "jump" trie, such that when we match the appropriate word
4504                   we "jump" to the appropriate tail node. Essentially we turn
4505                   a nested if into a case structure of sorts.
4506
4507                 */
4508
4509                     int made=0;
4510                     if (!re_trie_maxbuff) {
4511                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4512                         if (!SvIOK(re_trie_maxbuff))
4513                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4514                     }
4515                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4516                         regnode *cur;
4517                         regnode *first = (regnode *)NULL;
4518                         regnode *last = (regnode *)NULL;
4519                         regnode *tail = scan;
4520                         U8 trietype = 0;
4521                         U32 count=0;
4522
4523                         /* var tail is used because there may be a TAIL
4524                            regop in the way. Ie, the exacts will point to the
4525                            thing following the TAIL, but the last branch will
4526                            point at the TAIL. So we advance tail. If we
4527                            have nested (?:) we may have to move through several
4528                            tails.
4529                          */
4530
4531                         while ( OP( tail ) == TAIL ) {
4532                             /* this is the TAIL generated by (?:) */
4533                             tail = regnext( tail );
4534                         }
4535
4536
4537                         DEBUG_TRIE_COMPILE_r({
4538                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4539                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4540                               depth+1,
4541                               "Looking for TRIE'able sequences. Tail node is ",
4542                               (UV)(tail - RExC_emit_start),
4543                               SvPV_nolen_const( RExC_mysv )
4544                             );
4545                         });
4546
4547                         /*
4548
4549                             Step through the branches
4550                                 cur represents each branch,
4551                                 noper is the first thing to be matched as part
4552                                       of that branch
4553                                 noper_next is the regnext() of that node.
4554
4555                             We normally handle a case like this
4556                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4557                             support building with NOJUMPTRIE, which restricts
4558                             the trie logic to structures like /FOO|BAR/.
4559
4560                             If noper is a trieable nodetype then the branch is
4561                             a possible optimization target. If we are building
4562                             under NOJUMPTRIE then we require that noper_next is
4563                             the same as scan (our current position in the regex
4564                             program).
4565
4566                             Once we have two or more consecutive such branches
4567                             we can create a trie of the EXACT's contents and
4568                             stitch it in place into the program.
4569
4570                             If the sequence represents all of the branches in
4571                             the alternation we replace the entire thing with a
4572                             single TRIE node.
4573
4574                             Otherwise when it is a subsequence we need to
4575                             stitch it in place and replace only the relevant
4576                             branches. This means the first branch has to remain
4577                             as it is used by the alternation logic, and its
4578                             next pointer, and needs to be repointed at the item
4579                             on the branch chain following the last branch we
4580                             have optimized away.
4581
4582                             This could be either a BRANCH, in which case the
4583                             subsequence is internal, or it could be the item
4584                             following the branch sequence in which case the
4585                             subsequence is at the end (which does not
4586                             necessarily mean the first node is the start of the
4587                             alternation).
4588
4589                             TRIE_TYPE(X) is a define which maps the optype to a
4590                             trietype.
4591
4592                                 optype          |  trietype
4593                                 ----------------+-----------
4594                                 NOTHING         | NOTHING
4595                                 EXACT           | EXACT
4596                                 EXACTFU         | EXACTFU
4597                                 EXACTFU_SS      | EXACTFU
4598                                 EXACTFAA         | EXACTFAA
4599                                 EXACTL          | EXACTL
4600                                 EXACTFLU8       | EXACTFLU8
4601
4602
4603                         */
4604 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4605                        ? NOTHING                                            \
4606                        : ( EXACT == (X) )                                   \
4607                          ? EXACT                                            \
4608                          : ( EXACTFU == (X) || EXACTFU_SS == (X) )          \
4609                            ? EXACTFU                                        \
4610                            : ( EXACTFAA == (X) )                             \
4611                              ? EXACTFAA                                      \
4612                              : ( EXACTL == (X) )                            \
4613                                ? EXACTL                                     \
4614                                : ( EXACTFLU8 == (X) )                        \
4615                                  ? EXACTFLU8                                 \
4616                                  : 0 )
4617
4618                         /* dont use tail as the end marker for this traverse */
4619                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4620                             regnode * const noper = NEXTOPER( cur );
4621                             U8 noper_type = OP( noper );
4622                             U8 noper_trietype = TRIE_TYPE( noper_type );
4623 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4624                             regnode * const noper_next = regnext( noper );
4625                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4626                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4627 #endif
4628
4629                             DEBUG_TRIE_COMPILE_r({
4630                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4631                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4632                                    depth+1,
4633                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4634
4635                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4636                                 Perl_re_printf( aTHX_  " -> %d:%s",
4637                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
4638
4639                                 if ( noper_next ) {
4640                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4641                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
4642                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
4643                                 }
4644                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
4645                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4646                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4647                                 );
4648                             });
4649
4650                             /* Is noper a trieable nodetype that can be merged
4651                              * with the current trie (if there is one)? */
4652                             if ( noper_trietype
4653                                   &&
4654                                   (
4655                                         ( noper_trietype == NOTHING )
4656                                         || ( trietype == NOTHING )
4657                                         || ( trietype == noper_trietype )
4658                                   )
4659 #ifdef NOJUMPTRIE
4660                                   && noper_next >= tail
4661 #endif
4662                                   && count < U16_MAX)
4663                             {
4664                                 /* Handle mergable triable node Either we are
4665                                  * the first node in a new trieable sequence,
4666                                  * in which case we do some bookkeeping,
4667                                  * otherwise we update the end pointer. */
4668                                 if ( !first ) {
4669                                     first = cur;
4670                                     if ( noper_trietype == NOTHING ) {
4671 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4672                                         regnode * const noper_next = regnext( noper );
4673                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4674                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4675 #endif
4676
4677                                         if ( noper_next_trietype ) {
4678                                             trietype = noper_next_trietype;
4679                                         } else if (noper_next_type)  {
4680                                             /* a NOTHING regop is 1 regop wide.
4681                                              * We need at least two for a trie
4682                                              * so we can't merge this in */
4683                                             first = NULL;
4684                                         }
4685                                     } else {
4686                                         trietype = noper_trietype;
4687                                     }
4688                                 } else {
4689                                     if ( trietype == NOTHING )
4690                                         trietype = noper_trietype;
4691                                     last = cur;
4692                                 }
4693                                 if (first)
4694                                     count++;
4695                             } /* end handle mergable triable node */
4696                             else {
4697                                 /* handle unmergable node -
4698                                  * noper may either be a triable node which can
4699                                  * not be tried together with the current trie,
4700                                  * or a non triable node */
4701                                 if ( last ) {
4702                                     /* If last is set and trietype is not
4703                                      * NOTHING then we have found at least two
4704                                      * triable branch sequences in a row of a
4705                                      * similar trietype so we can turn them
4706                                      * into a trie. If/when we allow NOTHING to
4707                                      * start a trie sequence this condition
4708                                      * will be required, and it isn't expensive
4709                                      * so we leave it in for now. */
4710                                     if ( trietype && trietype != NOTHING )
4711                                         make_trie( pRExC_state,
4712                                                 startbranch, first, cur, tail,
4713                                                 count, trietype, depth+1 );
4714                                     last = NULL; /* note: we clear/update
4715                                                     first, trietype etc below,
4716                                                     so we dont do it here */
4717                                 }
4718                                 if ( noper_trietype
4719 #ifdef NOJUMPTRIE
4720                                      && noper_next >= tail
4721 #endif
4722                                 ){
4723                                     /* noper is triable, so we can start a new
4724                                      * trie sequence */
4725                                     count = 1;
4726                                     first = cur;
4727                                     trietype = noper_trietype;
4728                                 } else if (first) {
4729                                     /* if we already saw a first but the
4730                                      * current node is not triable then we have
4731                                      * to reset the first information. */
4732                                     count = 0;
4733                                     first = NULL;
4734                                     trietype = 0;
4735                                 }
4736                             } /* end handle unmergable node */
4737                         } /* loop over branches */
4738                         DEBUG_TRIE_COMPILE_r({
4739                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4740                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
4741                               depth+1, SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4742                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
4743                                REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4744                                PL_reg_name[trietype]
4745                             );
4746
4747                         });
4748                         if ( last && trietype ) {
4749                             if ( trietype != NOTHING ) {
4750                                 /* the last branch of the sequence was part of
4751                                  * a trie, so we have to construct it here
4752                                  * outside of the loop */
4753                                 made= make_trie( pRExC_state, startbranch,
4754                                                  first, scan, tail, count,
4755                                                  trietype, depth+1 );
4756 #ifdef TRIE_STUDY_OPT
4757                                 if ( ((made == MADE_EXACT_TRIE &&
4758                                      startbranch == first)
4759                                      || ( first_non_open == first )) &&
4760                                      depth==0 ) {
4761                                     flags |= SCF_TRIE_RESTUDY;
4762                                     if ( startbranch == first
4763                                          && scan >= tail )
4764                                     {
4765                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
4766                                     }
4767                                 }
4768 #endif
4769                             } else {
4770                                 /* at this point we know whatever we have is a
4771                                  * NOTHING sequence/branch AND if 'startbranch'
4772                                  * is 'first' then we can turn the whole thing
4773                                  * into a NOTHING
4774                                  */
4775                                 if ( startbranch == first ) {
4776                                     regnode *opt;
4777                                     /* the entire thing is a NOTHING sequence,
4778                                      * something like this: (?:|) So we can
4779                                      * turn it into a plain NOTHING op. */
4780                                     DEBUG_TRIE_COMPILE_r({
4781                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4782                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
4783                                           depth+1,
4784                                           SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4785
4786                                     });
4787                                     OP(startbranch)= NOTHING;
4788                                     NEXT_OFF(startbranch)= tail - startbranch;
4789                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
4790                                         OP(opt)= OPTIMIZED;
4791                                 }
4792                             }
4793                         } /* end if ( last) */
4794                     } /* TRIE_MAXBUF is non zero */
4795
4796                 } /* do trie */
4797
4798             }
4799             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
4800                 scan = NEXTOPER(NEXTOPER(scan));
4801             } else                      /* single branch is optimized. */
4802                 scan = NEXTOPER(scan);
4803             continue;
4804         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
4805             I32 paren = 0;
4806             regnode *start = NULL;
4807             regnode *end = NULL;
4808             U32 my_recursed_depth= recursed_depth;
4809
4810             if (OP(scan) != SUSPEND) { /* GOSUB */
4811                 /* Do setup, note this code has side effects beyond
4812                  * the rest of this block. Specifically setting
4813                  * RExC_recurse[] must happen at least once during
4814                  * study_chunk(). */
4815                 paren = ARG(scan);
4816                 RExC_recurse[ARG2L(scan)] = scan;
4817                 start = RExC_open_parens[paren];
4818                 end   = RExC_close_parens[paren];
4819
4820                 /* NOTE we MUST always execute the above code, even
4821                  * if we do nothing with a GOSUB */
4822                 if (
4823                     ( flags & SCF_IN_DEFINE )
4824                     ||
4825                     (
4826                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
4827                         &&
4828                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
4829                     )
4830                 ) {
4831                     /* no need to do anything here if we are in a define. */
4832                     /* or we are after some kind of infinite construct
4833                      * so we can skip recursing into this item.
4834                      * Since it is infinite we will not change the maxlen
4835                      * or delta, and if we miss something that might raise
4836                      * the minlen it will merely pessimise a little.
4837                      *
4838                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
4839                      * might result in a minlen of 1 and not of 4,
4840                      * but this doesn't make us mismatch, just try a bit
4841                      * harder than we should.
4842                      * */
4843                     scan= regnext(scan);
4844                     continue;
4845                 }
4846
4847                 if (
4848                     !recursed_depth
4849                     ||
4850                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
4851                 ) {
4852                     /* it is quite possible that there are more efficient ways
4853                      * to do this. We maintain a bitmap per level of recursion
4854                      * of which patterns we have entered so we can detect if a
4855                      * pattern creates a possible infinite loop. When we
4856                      * recurse down a level we copy the previous levels bitmap
4857                      * down. When we are at recursion level 0 we zero the top
4858                      * level bitmap. It would be nice to implement a different
4859                      * more efficient way of doing this. In particular the top
4860                      * level bitmap may be unnecessary.
4861                      */
4862                     if (!recursed_depth) {
4863                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
4864                     } else {
4865                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
4866                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
4867                              RExC_study_chunk_recursed_bytes, U8);
4868                     }
4869                     /* we havent recursed into this paren yet, so recurse into it */
4870                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
4871                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
4872                     my_recursed_depth= recursed_depth + 1;
4873                 } else {
4874                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
4875                     /* some form of infinite recursion, assume infinite length
4876                      * */
4877                     if (flags & SCF_DO_SUBSTR) {
4878                         scan_commit(pRExC_state, data, minlenp, is_inf);
4879                         data->cur_is_floating = 1;
4880                     }
4881                     is_inf = is_inf_internal = 1;
4882                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4883                         ssc_anything(data->start_class);
4884                     flags &= ~SCF_DO_STCLASS;
4885
4886                     start= NULL; /* reset start so we dont recurse later on. */
4887                 }
4888             } else {
4889                 paren = stopparen;
4890                 start = scan + 2;
4891                 end = regnext(scan);
4892             }
4893             if (start) {
4894                 scan_frame *newframe;
4895                 assert(end);
4896                 if (!RExC_frame_last) {
4897                     Newxz(newframe, 1, scan_frame);
4898                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
4899                     RExC_frame_head= newframe;
4900                     RExC_frame_count++;
4901                 } else if (!RExC_frame_last->next_frame) {
4902                     Newxz(newframe,1,scan_frame);
4903                     RExC_frame_last->next_frame= newframe;
4904                     newframe->prev_frame= RExC_frame_last;
4905                     RExC_frame_count++;
4906                 } else {
4907                     newframe= RExC_frame_last->next_frame;
4908                 }
4909                 RExC_frame_last= newframe;
4910
4911                 newframe->next_regnode = regnext(scan);
4912                 newframe->last_regnode = last;
4913                 newframe->stopparen = stopparen;
4914                 newframe->prev_recursed_depth = recursed_depth;
4915                 newframe->this_prev_frame= frame;
4916
4917                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
4918                 DEBUG_PEEP("fnew", scan, depth, flags);
4919
4920                 frame = newframe;
4921                 scan =  start;
4922                 stopparen = paren;
4923                 last = end;
4924                 depth = depth + 1;
4925                 recursed_depth= my_recursed_depth;
4926
4927                 continue;
4928             }
4929         }
4930         else if (OP(scan) == EXACT || OP(scan) == EXACTL) {
4931             SSize_t l = STR_LEN(scan);
4932             UV uc;
4933             assert(l);
4934             if (UTF) {
4935                 const U8 * const s = (U8*)STRING(scan);
4936                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
4937                 l = utf8_length(s, s + l);
4938             } else {
4939                 uc = *((U8*)STRING(scan));
4940             }
4941             min += l;
4942             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
4943                 /* The code below prefers earlier match for fixed
4944                    offset, later match for variable offset.  */
4945                 if (data->last_end == -1) { /* Update the start info. */
4946                     data->last_start_min = data->pos_min;
4947                     data->last_start_max = is_inf
4948                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
4949                 }
4950                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
4951                 if (UTF)
4952                     SvUTF8_on(data->last_found);
4953                 {
4954                     SV * const sv = data->last_found;
4955                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4956                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4957                     if (mg && mg->mg_len >= 0)
4958                         mg->mg_len += utf8_length((U8*)STRING(scan),
4959                                               (U8*)STRING(scan)+STR_LEN(scan));
4960                 }
4961                 data->last_end = data->pos_min + l;
4962                 data->pos_min += l; /* As in the first entry. */
4963                 data->flags &= ~SF_BEFORE_EOL;
4964             }
4965
4966             /* ANDing the code point leaves at most it, and not in locale, and
4967              * can't match null string */
4968             if (flags & SCF_DO_STCLASS_AND) {
4969                 ssc_cp_and(data->start_class, uc);
4970                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4971                 ssc_clear_locale(data->start_class);
4972             }
4973             else if (flags & SCF_DO_STCLASS_OR) {
4974                 ssc_add_cp(data->start_class, uc);
4975                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4976
4977                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4978                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4979             }
4980             flags &= ~SCF_DO_STCLASS;
4981         }
4982         else if (PL_regkind[OP(scan)] == EXACT) {
4983             /* But OP != EXACT!, so is EXACTFish */
4984             SSize_t l = STR_LEN(scan);
4985             const U8 * s = (U8*)STRING(scan);
4986
4987             /* Search for fixed substrings supports EXACT only. */
4988             if (flags & SCF_DO_SUBSTR) {
4989                 assert(data);
4990                 scan_commit(pRExC_state, data, minlenp, is_inf);
4991             }
4992             if (UTF) {
4993                 l = utf8_length(s, s + l);
4994             }
4995             if (unfolded_multi_char) {
4996                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
4997             }
4998             min += l - min_subtract;
4999             assert (min >= 0);
5000             delta += min_subtract;
5001             if (flags & SCF_DO_SUBSTR) {
5002                 data->pos_min += l - min_subtract;
5003                 if (data->pos_min < 0) {
5004                     data->pos_min = 0;
5005                 }
5006                 data->pos_delta += min_subtract;
5007                 if (min_subtract) {
5008                     data->cur_is_floating = 1; /* float */
5009                 }
5010             }
5011
5012             if (flags & SCF_DO_STCLASS) {
5013                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
5014
5015                 assert(EXACTF_invlist);
5016                 if (flags & SCF_DO_STCLASS_AND) {
5017                     if (OP(scan) != EXACTFL)
5018                         ssc_clear_locale(data->start_class);
5019                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5020                     ANYOF_POSIXL_ZERO(data->start_class);
5021                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
5022                 }
5023                 else {  /* SCF_DO_STCLASS_OR */
5024                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
5025                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5026
5027                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5028                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5029                 }
5030                 flags &= ~SCF_DO_STCLASS;
5031                 SvREFCNT_dec(EXACTF_invlist);
5032             }
5033         }
5034         else if (REGNODE_VARIES(OP(scan))) {
5035             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
5036             I32 fl = 0, f = flags;
5037             regnode * const oscan = scan;
5038             regnode_ssc this_class;
5039             regnode_ssc *oclass = NULL;
5040             I32 next_is_eval = 0;
5041
5042             switch (PL_regkind[OP(scan)]) {
5043             case WHILEM:                /* End of (?:...)* . */
5044                 scan = NEXTOPER(scan);
5045                 goto finish;
5046             case PLUS:
5047                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5048                     next = NEXTOPER(scan);
5049                     if (OP(next) == EXACT
5050                         || OP(next) == EXACTL
5051                         || (flags & SCF_DO_STCLASS))
5052                     {
5053                         mincount = 1;
5054                         maxcount = REG_INFTY;
5055                         next = regnext(scan);
5056                         scan = NEXTOPER(scan);
5057                         goto do_curly;
5058                     }
5059                 }
5060                 if (flags & SCF_DO_SUBSTR)
5061                     data->pos_min++;
5062                 min++;
5063                 /* FALLTHROUGH */
5064             case STAR:
5065                 if (flags & SCF_DO_STCLASS) {
5066                     mincount = 0;
5067                     maxcount = REG_INFTY;
5068                     next = regnext(scan);
5069                     scan = NEXTOPER(scan);
5070                     goto do_curly;
5071                 }
5072                 if (flags & SCF_DO_SUBSTR) {
5073                     scan_commit(pRExC_state, data, minlenp, is_inf);
5074                     /* Cannot extend fixed substrings */
5075                     data->cur_is_floating = 1; /* float */
5076                 }
5077                 is_inf = is_inf_internal = 1;
5078                 scan = regnext(scan);
5079                 goto optimize_curly_tail;
5080             case CURLY:
5081                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5082                     && (scan->flags == stopparen))
5083                 {
5084                     mincount = 1;
5085                     maxcount = 1;
5086                 } else {
5087                     mincount = ARG1(scan);
5088                     maxcount = ARG2(scan);
5089                 }
5090                 next = regnext(scan);
5091                 if (OP(scan) == CURLYX) {
5092                     I32 lp = (data ? *(data->last_closep) : 0);
5093                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5094                 }
5095                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5096                 next_is_eval = (OP(scan) == EVAL);
5097               do_curly:
5098                 if (flags & SCF_DO_SUBSTR) {
5099                     if (mincount == 0)
5100                         scan_commit(pRExC_state, data, minlenp, is_inf);
5101                     /* Cannot extend fixed substrings */
5102                     pos_before = data->pos_min;
5103                 }
5104                 if (data) {
5105                     fl = data->flags;
5106                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5107                     if (is_inf)
5108                         data->flags |= SF_IS_INF;
5109                 }
5110                 if (flags & SCF_DO_STCLASS) {
5111                     ssc_init(pRExC_state, &this_class);
5112                     oclass = data->start_class;
5113                     data->start_class = &this_class;
5114                     f |= SCF_DO_STCLASS_AND;
5115                     f &= ~SCF_DO_STCLASS_OR;
5116                 }
5117                 /* Exclude from super-linear cache processing any {n,m}
5118                    regops for which the combination of input pos and regex
5119                    pos is not enough information to determine if a match
5120                    will be possible.
5121
5122                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5123                    regex pos at the \s*, the prospects for a match depend not
5124                    only on the input position but also on how many (bar\s*)
5125                    repeats into the {4,8} we are. */
5126                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5127                     f &= ~SCF_WHILEM_VISITED_POS;
5128
5129                 /* This will finish on WHILEM, setting scan, or on NULL: */
5130                 /* recurse study_chunk() on loop bodies */
5131                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5132                                   last, data, stopparen, recursed_depth, NULL,
5133                                   (mincount == 0
5134                                    ? (f & ~SCF_DO_SUBSTR)
5135                                    : f)
5136                                   ,depth+1);
5137
5138                 if (flags & SCF_DO_STCLASS)
5139                     data->start_class = oclass;
5140                 if (mincount == 0 || minnext == 0) {
5141                     if (flags & SCF_DO_STCLASS_OR) {
5142                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5143                     }
5144                     else if (flags & SCF_DO_STCLASS_AND) {
5145                         /* Switch to OR mode: cache the old value of
5146                          * data->start_class */
5147                         INIT_AND_WITHP;
5148                         StructCopy(data->start_class, and_withp, regnode_ssc);
5149                         flags &= ~SCF_DO_STCLASS_AND;
5150                         StructCopy(&this_class, data->start_class, regnode_ssc);
5151                         flags |= SCF_DO_STCLASS_OR;
5152                         ANYOF_FLAGS(data->start_class)
5153                                                 |= SSC_MATCHES_EMPTY_STRING;
5154                     }
5155                 } else {                /* Non-zero len */
5156                     if (flags & SCF_DO_STCLASS_OR) {
5157                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5158                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5159                     }
5160                     else if (flags & SCF_DO_STCLASS_AND)
5161                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5162                     flags &= ~SCF_DO_STCLASS;
5163                 }
5164                 if (!scan)              /* It was not CURLYX, but CURLY. */
5165                     scan = next;
5166                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5167                     /* ? quantifier ok, except for (?{ ... }) */
5168                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5169                     && (minnext == 0) && (deltanext == 0)
5170                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5171                     && maxcount <= REG_INFTY/3) /* Complement check for big
5172                                                    count */
5173                 {
5174                     /* Fatal warnings may leak the regexp without this: */
5175                     SAVEFREESV(RExC_rx_sv);
5176                     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5177                         "Quantifier unexpected on zero-length expression "
5178                         "in regex m/%" UTF8f "/",
5179                          UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5180                                   RExC_precomp));
5181                     (void)ReREFCNT_inc(RExC_rx_sv);
5182                 }
5183
5184                 min += minnext * mincount;
5185                 is_inf_internal |= deltanext == SSize_t_MAX
5186                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5187                 is_inf |= is_inf_internal;
5188                 if (is_inf) {
5189                     delta = SSize_t_MAX;
5190                 } else {
5191                     delta += (minnext + deltanext) * maxcount
5192                              - minnext * mincount;
5193                 }
5194                 /* Try powerful optimization CURLYX => CURLYN. */
5195                 if (  OP(oscan) == CURLYX && data
5196                       && data->flags & SF_IN_PAR
5197                       && !(data->flags & SF_HAS_EVAL)
5198                       && !deltanext && minnext == 1 ) {
5199                     /* Try to optimize to CURLYN.  */
5200                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5201                     regnode * const nxt1 = nxt;
5202 #ifdef DEBUGGING
5203                     regnode *nxt2;
5204 #endif
5205
5206                     /* Skip open. */
5207                     nxt = regnext(nxt);
5208                     if (!REGNODE_SIMPLE(OP(nxt))
5209                         && !(PL_regkind[OP(nxt)] == EXACT
5210                              && STR_LEN(nxt) == 1))
5211                         goto nogo;
5212 #ifdef DEBUGGING
5213                     nxt2 = nxt;
5214 #endif
5215                     nxt = regnext(nxt);
5216                     if (OP(nxt) != CLOSE)
5217                         goto nogo;
5218                     if (RExC_open_parens) {
5219                         RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5220                         RExC_close_parens[ARG(nxt1)]=nxt+2; /*close->while*/
5221                     }
5222                     /* Now we know that nxt2 is the only contents: */
5223                     oscan->flags = (U8)ARG(nxt);
5224                     OP(oscan) = CURLYN;
5225                     OP(nxt1) = NOTHING; /* was OPEN. */
5226
5227 #ifdef DEBUGGING
5228                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5229                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5230                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5231                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5232                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5233                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5234 #endif
5235                 }
5236               nogo:
5237
5238                 /* Try optimization CURLYX => CURLYM. */
5239                 if (  OP(oscan) == CURLYX && data
5240                       && !(data->flags & SF_HAS_PAR)
5241                       && !(data->flags & SF_HAS_EVAL)
5242                       && !deltanext     /* atom is fixed width */
5243                       && minnext != 0   /* CURLYM can't handle zero width */
5244
5245                          /* Nor characters whose fold at run-time may be
5246                           * multi-character */
5247                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5248                 ) {
5249                     /* XXXX How to optimize if data == 0? */
5250                     /* Optimize to a simpler form.  */
5251                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5252                     regnode *nxt2;
5253
5254                     OP(oscan) = CURLYM;
5255                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5256                             && (OP(nxt2) != WHILEM))
5257                         nxt = nxt2;
5258                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5259                     /* Need to optimize away parenths. */
5260                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5261                         /* Set the parenth number.  */
5262                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5263
5264                         oscan->flags = (U8)ARG(nxt);
5265                         if (RExC_open_parens) {
5266                             RExC_open_parens[ARG(nxt1)]=oscan; /*open->CURLYM*/
5267                             RExC_close_parens[ARG(nxt1)]=nxt2+1; /*close->NOTHING*/
5268                         }
5269                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5270                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5271
5272 #ifdef DEBUGGING
5273                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5274                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5275                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5276                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5277 #endif
5278 #if 0
5279                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5280                             regnode *nnxt = regnext(nxt1);
5281                             if (nnxt == nxt) {
5282                                 if (reg_off_by_arg[OP(nxt1)])
5283                                     ARG_SET(nxt1, nxt2 - nxt1);
5284                                 else if (nxt2 - nxt1 < U16_MAX)
5285                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5286                                 else
5287                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5288                             }
5289                             nxt1 = nnxt;
5290                         }
5291 #endif
5292                         /* Optimize again: */
5293                         /* recurse study_chunk() on optimised CURLYX => CURLYM */
5294                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5295                                     NULL, stopparen, recursed_depth, NULL, 0,depth+1);
5296                     }
5297                     else
5298                         oscan->flags = 0;
5299                 }
5300                 else if ((OP(oscan) == CURLYX)
5301                          && (flags & SCF_WHILEM_VISITED_POS)
5302                          /* See the comment on a similar expression above.
5303                             However, this time it's not a subexpression
5304                             we care about, but the expression itself. */
5305                          && (maxcount == REG_INFTY)
5306                          && data) {
5307                     /* This stays as CURLYX, we can put the count/of pair. */
5308                     /* Find WHILEM (as in regexec.c) */
5309                     regnode *nxt = oscan + NEXT_OFF(oscan);
5310
5311                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5312                         nxt += ARG(nxt);
5313                     nxt = PREVOPER(nxt);
5314                     if (nxt->flags & 0xf) {
5315                         /* we've already set whilem count on this node */
5316                     } else if (++data->whilem_c < 16) {
5317                         assert(data->whilem_c <= RExC_whilem_seen);
5318                         nxt->flags = (U8)(data->whilem_c
5319                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5320                     }
5321                 }
5322                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5323                     pars++;
5324                 if (flags & SCF_DO_SUBSTR) {
5325                     SV *last_str = NULL;
5326                     STRLEN last_chrs = 0;
5327                     int counted = mincount != 0;
5328
5329                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5330                                                                   string. */
5331                         SSize_t b = pos_before >= data->last_start_min
5332                             ? pos_before : data->last_start_min;
5333                         STRLEN l;
5334                         const char * const s = SvPV_const(data->last_found, l);
5335                         SSize_t old = b - data->last_start_min;
5336
5337                         if (UTF)
5338                             old = utf8_hop((U8*)s, old) - (U8*)s;
5339                         l -= old;
5340                         /* Get the added string: */
5341                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5342                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5343                                             (U8*)(s + old + l)) : l;
5344                         if (deltanext == 0 && pos_before == b) {
5345                             /* What was added is a constant string */
5346                             if (mincount > 1) {
5347
5348                                 SvGROW(last_str, (mincount * l) + 1);
5349                                 repeatcpy(SvPVX(last_str) + l,
5350                                           SvPVX_const(last_str), l,
5351                                           mincount - 1);
5352                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5353                                 /* Add additional parts. */
5354                                 SvCUR_set(data->last_found,
5355                                           SvCUR(data->last_found) - l);
5356                                 sv_catsv(data->last_found, last_str);
5357                                 {
5358                                     SV * sv = data->last_found;
5359                                     MAGIC *mg =
5360                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5361                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5362                                     if (mg && mg->mg_len >= 0)
5363                                         mg->mg_len += last_chrs * (mincount-1);
5364                                 }
5365                                 last_chrs *= mincount;
5366                                 data->last_end += l * (mincount - 1);
5367                             }
5368                         } else {
5369                             /* start offset must point into the last copy */
5370                             data->last_start_min += minnext * (mincount - 1);
5371                             data->last_start_max =
5372                               is_inf
5373                                ? SSize_t_MAX
5374                                : data->last_start_max +
5375                                  (maxcount - 1) * (minnext + data->pos_delta);
5376                         }
5377                     }
5378                     /* It is counted once already... */
5379                     data->pos_min += minnext * (mincount - counted);
5380 #if 0
5381 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5382                               " SSize_t_MAX=%" UVuf " minnext=%" UVuf
5383                               " maxcount=%" UVuf " mincount=%" UVuf "\n",
5384     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
5385     (UV)mincount);
5386 if (deltanext != SSize_t_MAX)
5387 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5388     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5389           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
5390 #endif
5391                     if (deltanext == SSize_t_MAX
5392                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
5393                         data->pos_delta = SSize_t_MAX;
5394                     else
5395                         data->pos_delta += - counted * deltanext +
5396                         (minnext + deltanext) * maxcount - minnext * mincount;
5397                     if (mincount != maxcount) {
5398                          /* Cannot extend fixed substrings found inside
5399                             the group.  */
5400                         scan_commit(pRExC_state, data, minlenp, is_inf);
5401                         if (mincount && last_str) {
5402                             SV * const sv = data->last_found;
5403                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5404                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5405
5406                             if (mg)
5407                                 mg->mg_len = -1;
5408                             sv_setsv(sv, last_str);
5409                             data->last_end = data->pos_min;
5410                             data->last_start_min = data->pos_min - last_chrs;
5411                             data->last_start_max = is_inf
5412                                 ? SSize_t_MAX
5413                                 : data->pos_min + data->pos_delta - last_chrs;
5414                         }
5415                         data->cur_is_floating = 1; /* float */
5416                     }
5417                     SvREFCNT_dec(last_str);
5418                 }
5419                 if (data && (fl & SF_HAS_EVAL))
5420                     data->flags |= SF_HAS_EVAL;
5421               optimize_curly_tail:
5422                 if (OP(oscan) != CURLYX) {
5423                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
5424                            && NEXT_OFF(next))
5425                         NEXT_OFF(oscan) += NEXT_OFF(next);
5426                 }
5427                 continue;
5428
5429             default:
5430 #ifdef DEBUGGING
5431                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5432                                                                     OP(scan));
5433 #endif
5434             case REF:
5435             case CLUMP:
5436                 if (flags & SCF_DO_SUBSTR) {
5437                     /* Cannot expect anything... */
5438                     scan_commit(pRExC_state, data, minlenp, is_inf);
5439                     data->cur_is_floating = 1; /* float */
5440                 }
5441                 is_inf = is_inf_internal = 1;
5442                 if (flags & SCF_DO_STCLASS_OR) {
5443                     if (OP(scan) == CLUMP) {
5444                         /* Actually is any start char, but very few code points
5445                          * aren't start characters */
5446                         ssc_match_all_cp(data->start_class);
5447                     }
5448                     else {
5449                         ssc_anything(data->start_class);
5450                     }
5451                 }
5452                 flags &= ~SCF_DO_STCLASS;
5453                 break;
5454             }
5455         }
5456         else if (OP(scan) == LNBREAK) {
5457             if (flags & SCF_DO_STCLASS) {
5458                 if (flags & SCF_DO_STCLASS_AND) {
5459                     ssc_intersection(data->start_class,
5460                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5461                     ssc_clear_locale(data->start_class);
5462                     ANYOF_FLAGS(data->start_class)
5463                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5464                 }
5465                 else if (flags & SCF_DO_STCLASS_OR) {
5466                     ssc_union(data->start_class,
5467                               PL_XPosix_ptrs[_CC_VERTSPACE],
5468                               FALSE);
5469                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5470
5471                     /* See commit msg for
5472                      * 749e076fceedeb708a624933726e7989f2302f6a */
5473                     ANYOF_FLAGS(data->start_class)
5474                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5475                 }
5476                 flags &= ~SCF_DO_STCLASS;
5477             }
5478             min++;
5479             if (delta != SSize_t_MAX)
5480                 delta++;    /* Because of the 2 char string cr-lf */
5481             if (flags & SCF_DO_SUBSTR) {
5482                 /* Cannot expect anything... */
5483                 scan_commit(pRExC_state, data, minlenp, is_inf);
5484                 data->pos_min += 1;
5485                 if (data->pos_delta != SSize_t_MAX) {
5486                     data->pos_delta += 1;
5487                 }
5488                 data->cur_is_floating = 1; /* float */
5489             }
5490         }
5491         else if (REGNODE_SIMPLE(OP(scan))) {
5492
5493             if (flags & SCF_DO_SUBSTR) {
5494                 scan_commit(pRExC_state, data, minlenp, is_inf);
5495                 data->pos_min++;
5496             }
5497             min++;
5498             if (flags & SCF_DO_STCLASS) {
5499                 bool invert = 0;
5500                 SV* my_invlist = NULL;
5501                 U8 namedclass;
5502
5503                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5504                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5505
5506                 /* Some of the logic below assumes that switching
5507                    locale on will only add false positives. */
5508                 switch (OP(scan)) {
5509
5510                 default:
5511 #ifdef DEBUGGING
5512                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5513                                                                      OP(scan));
5514 #endif
5515                 case SANY:
5516                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5517                         ssc_match_all_cp(data->start_class);
5518                     break;
5519
5520                 case REG_ANY:
5521                     {
5522                         SV* REG_ANY_invlist = _new_invlist(2);
5523                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5524                                                             '\n');
5525                         if (flags & SCF_DO_STCLASS_OR) {
5526                             ssc_union(data->start_class,
5527                                       REG_ANY_invlist,
5528                                       TRUE /* TRUE => invert, hence all but \n
5529                                             */
5530                                       );
5531                         }
5532                         else if (flags & SCF_DO_STCLASS_AND) {
5533                             ssc_intersection(data->start_class,
5534                                              REG_ANY_invlist,
5535                                              TRUE  /* TRUE => invert */
5536                                              );
5537                             ssc_clear_locale(data->start_class);
5538                         }
5539                         SvREFCNT_dec_NN(REG_ANY_invlist);
5540                     }
5541                     break;
5542
5543                 case ANYOFD:
5544                 case ANYOFL:
5545                 case ANYOF:
5546                     if (flags & SCF_DO_STCLASS_AND)
5547                         ssc_and(pRExC_state, data->start_class,
5548                                 (regnode_charclass *) scan);
5549                     else
5550                         ssc_or(pRExC_state, data->start_class,
5551                                                           (regnode_charclass *) scan);
5552                     break;
5553
5554                 case ANYOFM:
5555                   {
5556                     SV* cp_list = get_ANYOFM_contents(scan);
5557
5558                     if (flags & SCF_DO_STCLASS_OR) {
5559                         ssc_union(data->start_class,
5560                                   cp_list,
5561                                   FALSE /* don't invert */
5562                                   );
5563                     }
5564                     else if (flags & SCF_DO_STCLASS_AND) {
5565                         ssc_intersection(data->start_class,
5566                                          cp_list,
5567                                          FALSE /* don't invert */
5568                                          );
5569                     }
5570
5571                     SvREFCNT_dec_NN(cp_list);
5572                     break;
5573                   }
5574
5575                 case NPOSIXL:
5576                     invert = 1;
5577                     /* FALLTHROUGH */
5578
5579                 case POSIXL:
5580                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5581                     if (flags & SCF_DO_STCLASS_AND) {
5582                         bool was_there = cBOOL(
5583                                           ANYOF_POSIXL_TEST(data->start_class,
5584                                                                  namedclass));
5585                         ANYOF_POSIXL_ZERO(data->start_class);
5586                         if (was_there) {    /* Do an AND */
5587                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5588                         }
5589                         /* No individual code points can now match */
5590                         data->start_class->invlist
5591                                                 = sv_2mortal(_new_invlist(0));
5592                     }
5593                     else {
5594                         int complement = namedclass + ((invert) ? -1 : 1);
5595
5596                         assert(flags & SCF_DO_STCLASS_OR);
5597
5598                         /* If the complement of this class was already there,
5599                          * the result is that they match all code points,
5600                          * (\d + \D == everything).  Remove the classes from
5601                          * future consideration.  Locale is not relevant in
5602                          * this case */
5603                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5604                             ssc_match_all_cp(data->start_class);
5605                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5606                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5607                         }
5608                         else {  /* The usual case; just add this class to the
5609                                    existing set */
5610                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5611                         }
5612                     }
5613                     break;
5614
5615                 case NASCII:
5616                     invert = 1;
5617                     /* FALLTHROUGH */
5618                 case ASCII:
5619                     my_invlist = invlist_clone(PL_Posix_ptrs[_CC_ASCII]);
5620
5621                     /* This can be handled as a Posix class */
5622                     goto join_posix_and_ascii;
5623
5624                 case NPOSIXA:   /* For these, we always know the exact set of
5625                                    what's matched */
5626                     invert = 1;
5627                     /* FALLTHROUGH */
5628                 case POSIXA:
5629                     assert(FLAGS(scan) != _CC_ASCII);
5630                     my_invlist = invlist_clone(PL_Posix_ptrs[FLAGS(scan)]);
5631                     goto join_posix_and_ascii;
5632
5633                 case NPOSIXD:
5634                 case NPOSIXU:
5635                     invert = 1;
5636                     /* FALLTHROUGH */
5637                 case POSIXD:
5638                 case POSIXU:
5639                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)]);
5640
5641                     /* NPOSIXD matches all upper Latin1 code points unless the
5642                      * target string being matched is UTF-8, which is
5643                      * unknowable until match time.  Since we are going to
5644                      * invert, we want to get rid of all of them so that the
5645                      * inversion will match all */
5646                     if (OP(scan) == NPOSIXD) {
5647                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5648                                           &my_invlist);
5649                     }
5650
5651                   join_posix_and_ascii:
5652
5653                     if (flags & SCF_DO_STCLASS_AND) {
5654                         ssc_intersection(data->start_class, my_invlist, invert);
5655                         ssc_clear_locale(data->start_class);
5656                     }
5657                     else {
5658                         assert(flags & SCF_DO_STCLASS_OR);
5659                         ssc_union(data->start_class, my_invlist, invert);
5660                     }
5661                     SvREFCNT_dec(my_invlist);
5662                 }
5663                 if (flags & SCF_DO_STCLASS_OR)
5664                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5665                 flags &= ~SCF_DO_STCLASS;
5666             }
5667         }
5668         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5669             data->flags |= (OP(scan) == MEOL
5670                             ? SF_BEFORE_MEOL
5671                             : SF_BEFORE_SEOL);
5672             scan_commit(pRExC_state, data, minlenp, is_inf);
5673
5674         }
5675         else if (  PL_regkind[OP(scan)] == BRANCHJ
5676                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5677                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5678                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5679         {
5680             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5681                 || OP(scan) == UNLESSM )
5682             {
5683                 /* Negative Lookahead/lookbehind
5684                    In this case we can't do fixed string optimisation.
5685                 */
5686
5687                 SSize_t deltanext, minnext, fake = 0;
5688                 regnode *nscan;
5689                 regnode_ssc intrnl;
5690                 int f = 0;
5691
5692                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5693                 if (data) {
5694                     data_fake.whilem_c = data->whilem_c;
5695                     data_fake.last_closep = data->last_closep;
5696                 }
5697                 else
5698                     data_fake.last_closep = &fake;
5699                 data_fake.pos_delta = delta;
5700                 if ( flags & SCF_DO_STCLASS && !scan->flags
5701                      && OP(scan) == IFMATCH ) { /* Lookahead */
5702                     ssc_init(pRExC_state, &intrnl);
5703                     data_fake.start_class = &intrnl;
5704                     f |= SCF_DO_STCLASS_AND;
5705                 }
5706                 if (flags & SCF_WHILEM_VISITED_POS)
5707                     f |= SCF_WHILEM_VISITED_POS;
5708                 next = regnext(scan);
5709                 nscan = NEXTOPER(NEXTOPER(scan));
5710
5711                 /* recurse study_chunk() for lookahead body */
5712                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
5713                                       last, &data_fake, stopparen,
5714                                       recursed_depth, NULL, f, depth+1);
5715                 if (scan->flags) {
5716                     if (deltanext) {
5717                         FAIL("Variable length lookbehind not implemented");
5718                     }
5719                     else if (minnext > (I32)U8_MAX) {
5720                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5721                               (UV)U8_MAX);
5722                     }
5723                     scan->flags = (U8)minnext;
5724                 }
5725                 if (data) {
5726                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5727                         pars++;
5728                     if (data_fake.flags & SF_HAS_EVAL)
5729                         data->flags |= SF_HAS_EVAL;
5730                     data->whilem_c = data_fake.whilem_c;
5731                 }
5732                 if (f & SCF_DO_STCLASS_AND) {
5733                     if (flags & SCF_DO_STCLASS_OR) {
5734                         /* OR before, AND after: ideally we would recurse with
5735                          * data_fake to get the AND applied by study of the
5736                          * remainder of the pattern, and then derecurse;
5737                          * *** HACK *** for now just treat as "no information".
5738                          * See [perl #56690].
5739                          */
5740                         ssc_init(pRExC_state, data->start_class);
5741                     }  else {
5742                         /* AND before and after: combine and continue.  These
5743                          * assertions are zero-length, so can match an EMPTY
5744                          * string */
5745                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5746                         ANYOF_FLAGS(data->start_class)
5747                                                    |= SSC_MATCHES_EMPTY_STRING;
5748                     }
5749                 }
5750             }
5751 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5752             else {
5753                 /* Positive Lookahead/lookbehind
5754                    In this case we can do fixed string optimisation,
5755                    but we must be careful about it. Note in the case of
5756                    lookbehind the positions will be offset by the minimum
5757                    length of the pattern, something we won't know about
5758                    until after the recurse.
5759                 */
5760                 SSize_t deltanext, fake = 0;
5761                 regnode *nscan;
5762                 regnode_ssc intrnl;
5763                 int f = 0;
5764                 /* We use SAVEFREEPV so that when the full compile
5765                     is finished perl will clean up the allocated
5766                     minlens when it's all done. This way we don't
5767                     have to worry about freeing them when we know
5768                     they wont be used, which would be a pain.
5769                  */
5770                 SSize_t *minnextp;
5771                 Newx( minnextp, 1, SSize_t );
5772                 SAVEFREEPV(minnextp);
5773
5774                 if (data) {
5775                     StructCopy(data, &data_fake, scan_data_t);
5776                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
5777                         f |= SCF_DO_SUBSTR;
5778                         if (scan->flags)
5779                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
5780                         data_fake.last_found=newSVsv(data->last_found);
5781                     }
5782                 }
5783                 else
5784                     data_fake.last_closep = &fake;
5785                 data_fake.flags = 0;
5786                 data_fake.substrs[0].flags = 0;
5787                 data_fake.substrs[1].flags = 0;
5788                 data_fake.pos_delta = delta;
5789                 if (is_inf)
5790                     data_fake.flags |= SF_IS_INF;
5791                 if ( flags & SCF_DO_STCLASS && !scan->flags
5792                      && OP(scan) == IFMATCH ) { /* Lookahead */
5793                     ssc_init(pRExC_state, &intrnl);
5794                     data_fake.start_class = &intrnl;
5795                     f |= SCF_DO_STCLASS_AND;
5796                 }
5797                 if (flags & SCF_WHILEM_VISITED_POS)
5798                     f |= SCF_WHILEM_VISITED_POS;
5799                 next = regnext(scan);
5800                 nscan = NEXTOPER(NEXTOPER(scan));
5801
5802                 /* positive lookahead study_chunk() recursion */
5803                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
5804                                         &deltanext, last, &data_fake,
5805                                         stopparen, recursed_depth, NULL,
5806                                         f,depth+1);
5807                 if (scan->flags) {
5808                     if (deltanext) {
5809                         FAIL("Variable length lookbehind not implemented");
5810                     }
5811                     else if (*minnextp > (I32)U8_MAX) {
5812                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
5813                               (UV)U8_MAX);
5814                     }
5815                     scan->flags = (U8)*minnextp;
5816                 }
5817
5818                 *minnextp += min;
5819
5820                 if (f & SCF_DO_STCLASS_AND) {
5821                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5822                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
5823                 }
5824                 if (data) {
5825                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5826                         pars++;
5827                     if (data_fake.flags & SF_HAS_EVAL)
5828                         data->flags |= SF_HAS_EVAL;
5829                     data->whilem_c = data_fake.whilem_c;
5830                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
5831                         int i;
5832                         if (RExC_rx->minlen<*minnextp)
5833                             RExC_rx->minlen=*minnextp;
5834                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
5835                         SvREFCNT_dec_NN(data_fake.last_found);
5836
5837                         for (i = 0; i < 2; i++) {
5838                             if (data_fake.substrs[i].minlenp != minlenp) {
5839                                 data->substrs[i].min_offset =
5840                                             data_fake.substrs[i].min_offset;
5841                                 data->substrs[i].max_offset =
5842                                             data_fake.substrs[i].max_offset;
5843                                 data->substrs[i].minlenp =
5844                                             data_fake.substrs[i].minlenp;
5845                                 data->substrs[i].lookbehind += scan->flags;
5846                             }
5847                         }
5848                     }
5849                 }
5850             }
5851 #endif
5852         }
5853
5854         else if (OP(scan) == OPEN) {
5855             if (stopparen != (I32)ARG(scan))
5856                 pars++;
5857         }
5858         else if (OP(scan) == CLOSE) {
5859             if (stopparen == (I32)ARG(scan)) {
5860                 break;
5861             }
5862             if ((I32)ARG(scan) == is_par) {
5863                 next = regnext(scan);
5864
5865                 if ( next && (OP(next) != WHILEM) && next < last)
5866                     is_par = 0;         /* Disable optimization */
5867             }
5868             if (data)
5869                 *(data->last_closep) = ARG(scan);
5870         }
5871         else if (OP(scan) == EVAL) {
5872                 if (data)
5873                     data->flags |= SF_HAS_EVAL;
5874         }
5875         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
5876             if (flags & SCF_DO_SUBSTR) {
5877                 scan_commit(pRExC_state, data, minlenp, is_inf);
5878                 flags &= ~SCF_DO_SUBSTR;
5879             }
5880             if (data && OP(scan)==ACCEPT) {
5881                 data->flags |= SCF_SEEN_ACCEPT;
5882                 if (stopmin > min)
5883                     stopmin = min;
5884             }
5885         }
5886         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
5887         {
5888                 if (flags & SCF_DO_SUBSTR) {
5889                     scan_commit(pRExC_state, data, minlenp, is_inf);
5890                     data->cur_is_floating = 1; /* float */
5891                 }
5892                 is_inf = is_inf_internal = 1;
5893                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5894                     ssc_anything(data->start_class);
5895                 flags &= ~SCF_DO_STCLASS;
5896         }
5897         else if (OP(scan) == GPOS) {
5898             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
5899                 !(delta || is_inf || (data && data->pos_delta)))
5900             {
5901                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
5902                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
5903                 if (RExC_rx->gofs < (STRLEN)min)
5904                     RExC_rx->gofs = min;
5905             } else {
5906                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
5907                 RExC_rx->gofs = 0;
5908             }
5909         }
5910 #ifdef TRIE_STUDY_OPT
5911 #ifdef FULL_TRIE_STUDY
5912         else if (PL_regkind[OP(scan)] == TRIE) {
5913             /* NOTE - There is similar code to this block above for handling
5914                BRANCH nodes on the initial study.  If you change stuff here
5915                check there too. */
5916             regnode *trie_node= scan;
5917             regnode *tail= regnext(scan);
5918             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5919             SSize_t max1 = 0, min1 = SSize_t_MAX;
5920             regnode_ssc accum;
5921
5922             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
5923                 /* Cannot merge strings after this. */
5924                 scan_commit(pRExC_state, data, minlenp, is_inf);
5925             }
5926             if (flags & SCF_DO_STCLASS)
5927                 ssc_init_zero(pRExC_state, &accum);
5928
5929             if (!trie->jump) {
5930                 min1= trie->minlen;
5931                 max1= trie->maxlen;
5932             } else {
5933                 const regnode *nextbranch= NULL;
5934                 U32 word;
5935
5936                 for ( word=1 ; word <= trie->wordcount ; word++)
5937                 {
5938                     SSize_t deltanext=0, minnext=0, f = 0, fake;
5939                     regnode_ssc this_class;
5940
5941                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5942                     if (data) {
5943                         data_fake.whilem_c = data->whilem_c;
5944                         data_fake.last_closep = data->last_closep;
5945                     }
5946                     else
5947                         data_fake.last_closep = &fake;
5948                     data_fake.pos_delta = delta;
5949                     if (flags & SCF_DO_STCLASS) {
5950                         ssc_init(pRExC_state, &this_class);
5951                         data_fake.start_class = &this_class;
5952                         f = SCF_DO_STCLASS_AND;
5953                     }
5954                     if (flags & SCF_WHILEM_VISITED_POS)
5955                         f |= SCF_WHILEM_VISITED_POS;
5956
5957                     if (trie->jump[word]) {
5958                         if (!nextbranch)
5959                             nextbranch = trie_node + trie->jump[0];
5960                         scan= trie_node + trie->jump[word];
5961                         /* We go from the jump point to the branch that follows
5962                            it. Note this means we need the vestigal unused
5963                            branches even though they arent otherwise used. */
5964                         /* optimise study_chunk() for TRIE */
5965                         minnext = study_chunk(pRExC_state, &scan, minlenp,
5966                             &deltanext, (regnode *)nextbranch, &data_fake,
5967                             stopparen, recursed_depth, NULL, f,depth+1);
5968                     }
5969                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
5970                         nextbranch= regnext((regnode*)nextbranch);
5971
5972                     if (min1 > (SSize_t)(minnext + trie->minlen))
5973                         min1 = minnext + trie->minlen;
5974                     if (deltanext == SSize_t_MAX) {
5975                         is_inf = is_inf_internal = 1;
5976                         max1 = SSize_t_MAX;
5977                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
5978                         max1 = minnext + deltanext + trie->maxlen;
5979
5980                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5981                         pars++;
5982                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
5983                         if ( stopmin > min + min1)
5984                             stopmin = min + min1;
5985                         flags &= ~SCF_DO_SUBSTR;
5986                         if (data)
5987                             data->flags |= SCF_SEEN_ACCEPT;
5988                     }
5989                     if (data) {
5990                         if (data_fake.flags & SF_HAS_EVAL)
5991                             data->flags |= SF_HAS_EVAL;
5992                         data->whilem_c = data_fake.whilem_c;
5993                     }
5994                     if (flags & SCF_DO_STCLASS)
5995                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
5996                 }
5997             }
5998             if (flags & SCF_DO_SUBSTR) {
5999                 data->pos_min += min1;
6000                 data->pos_delta += max1 - min1;
6001                 if (max1 != min1 || is_inf)
6002                     data->cur_is_floating = 1; /* float */
6003             }
6004             min += min1;
6005             if (delta != SSize_t_MAX) {
6006                 if (SSize_t_MAX - (max1 - min1) >= delta)
6007                     delta += max1 - min1;
6008                 else
6009                     delta = SSize_t_MAX;
6010             }
6011             if (flags & SCF_DO_STCLASS_OR) {
6012                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6013                 if (min1) {
6014                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6015                     flags &= ~SCF_DO_STCLASS;
6016                 }
6017             }
6018             else if (flags & SCF_DO_STCLASS_AND) {
6019                 if (min1) {
6020                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6021                     flags &= ~SCF_DO_STCLASS;
6022                 }
6023                 else {
6024                     /* Switch to OR mode: cache the old value of
6025                      * data->start_class */
6026                     INIT_AND_WITHP;
6027                     StructCopy(data->start_class, and_withp, regnode_ssc);
6028                     flags &= ~SCF_DO_STCLASS_AND;
6029                     StructCopy(&accum, data->start_class, regnode_ssc);
6030                     flags |= SCF_DO_STCLASS_OR;
6031                 }
6032             }
6033             scan= tail;
6034             continue;
6035         }
6036 #else
6037         else if (PL_regkind[OP(scan)] == TRIE) {
6038             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6039             U8*bang=NULL;
6040
6041             min += trie->minlen;
6042             delta += (trie->maxlen - trie->minlen);
6043             flags &= ~SCF_DO_STCLASS; /* xxx */
6044             if (flags & SCF_DO_SUBSTR) {
6045                 /* Cannot expect anything... */
6046                 scan_commit(pRExC_state, data, minlenp, is_inf);
6047                 data->pos_min += trie->minlen;
6048                 data->pos_delta += (trie->maxlen - trie->minlen);
6049                 if (trie->maxlen != trie->minlen)
6050                     data->cur_is_floating = 1; /* float */
6051             }
6052             if (trie->jump) /* no more substrings -- for now /grr*/
6053                flags &= ~SCF_DO_SUBSTR;
6054         }
6055 #endif /* old or new */
6056 #endif /* TRIE_STUDY_OPT */
6057
6058         /* Else: zero-length, ignore. */
6059         scan = regnext(scan);
6060     }
6061
6062   finish:
6063     if (frame) {
6064         /* we need to unwind recursion. */
6065         depth = depth - 1;
6066
6067         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
6068         DEBUG_PEEP("fend", scan, depth, flags);
6069
6070         /* restore previous context */
6071         last = frame->last_regnode;
6072         scan = frame->next_regnode;
6073         stopparen = frame->stopparen;
6074         recursed_depth = frame->prev_recursed_depth;
6075
6076         RExC_frame_last = frame->prev_frame;
6077         frame = frame->this_prev_frame;
6078         goto fake_study_recurse;
6079     }
6080
6081     assert(!frame);
6082     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6083
6084     *scanp = scan;
6085     *deltap = is_inf_internal ? SSize_t_MAX : delta;
6086
6087     if (flags & SCF_DO_SUBSTR && is_inf)
6088         data->pos_delta = SSize_t_MAX - data->pos_min;
6089     if (is_par > (I32)U8_MAX)
6090         is_par = 0;
6091     if (is_par && pars==1 && data) {
6092         data->flags |= SF_IN_PAR;
6093         data->flags &= ~SF_HAS_PAR;
6094     }
6095     else if (pars && data) {
6096         data->flags |= SF_HAS_PAR;
6097         data->flags &= ~SF_IN_PAR;
6098     }
6099     if (flags & SCF_DO_STCLASS_OR)
6100         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6101     if (flags & SCF_TRIE_RESTUDY)
6102         data->flags |=  SCF_TRIE_RESTUDY;
6103
6104     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6105
6106     {
6107         SSize_t final_minlen= min < stopmin ? min : stopmin;
6108
6109         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6110             if (final_minlen > SSize_t_MAX - delta)
6111                 RExC_maxlen = SSize_t_MAX;
6112             else if (RExC_maxlen < final_minlen + delta)
6113                 RExC_maxlen = final_minlen + delta;
6114         }
6115         return final_minlen;
6116     }
6117     NOT_REACHED; /* NOTREACHED */
6118 }
6119
6120 STATIC U32
6121 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6122 {
6123     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6124
6125     PERL_ARGS_ASSERT_ADD_DATA;
6126
6127     Renewc(RExC_rxi->data,
6128            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6129            char, struct reg_data);
6130     if(count)
6131         Renew(RExC_rxi->data->what, count + n, U8);
6132     else
6133         Newx(RExC_rxi->data->what, n, U8);
6134     RExC_rxi->data->count = count + n;
6135     Copy(s, RExC_rxi->data->what + count, n, U8);
6136     return count;
6137 }
6138
6139 /*XXX: todo make this not included in a non debugging perl, but appears to be
6140  * used anyway there, in 'use re' */
6141 #ifndef PERL_IN_XSUB_RE
6142 void
6143 Perl_reginitcolors(pTHX)
6144 {
6145     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6146     if (s) {
6147         char *t = savepv(s);
6148         int i = 0;
6149         PL_colors[0] = t;
6150         while (++i < 6) {
6151             t = strchr(t, '\t');
6152             if (t) {
6153                 *t = '\0';
6154                 PL_colors[i] = ++t;
6155             }
6156             else
6157                 PL_colors[i] = t = (char *)"";
6158         }
6159     } else {
6160         int i = 0;
6161         while (i < 6)
6162             PL_colors[i++] = (char *)"";
6163     }
6164     PL_colorset = 1;
6165 }
6166 #endif
6167
6168
6169 #ifdef TRIE_STUDY_OPT
6170 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6171     STMT_START {                                            \
6172         if (                                                \
6173               (data.flags & SCF_TRIE_RESTUDY)               \
6174               && ! restudied++                              \
6175         ) {                                                 \
6176             dOsomething;                                    \
6177             goto reStudy;                                   \
6178         }                                                   \
6179     } STMT_END
6180 #else
6181 #define CHECK_RESTUDY_GOTO_butfirst
6182 #endif
6183
6184 /*
6185  * pregcomp - compile a regular expression into internal code
6186  *
6187  * Decides which engine's compiler to call based on the hint currently in
6188  * scope
6189  */
6190
6191 #ifndef PERL_IN_XSUB_RE
6192
6193 /* return the currently in-scope regex engine (or the default if none)  */
6194
6195 regexp_engine const *
6196 Perl_current_re_engine(pTHX)
6197 {
6198     if (IN_PERL_COMPILETIME) {
6199         HV * const table = GvHV(PL_hintgv);
6200         SV **ptr;
6201
6202         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6203             return &PL_core_reg_engine;
6204         ptr = hv_fetchs(table, "regcomp", FALSE);
6205         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6206             return &PL_core_reg_engine;
6207         return INT2PTR(regexp_engine*,SvIV(*ptr));
6208     }
6209     else {
6210         SV *ptr;
6211         if (!PL_curcop->cop_hints_hash)
6212             return &PL_core_reg_engine;
6213         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6214         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6215             return &PL_core_reg_engine;
6216         return INT2PTR(regexp_engine*,SvIV(ptr));
6217     }
6218 }
6219
6220
6221 REGEXP *
6222 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6223 {
6224     regexp_engine const *eng = current_re_engine();
6225     GET_RE_DEBUG_FLAGS_DECL;
6226
6227     PERL_ARGS_ASSERT_PREGCOMP;
6228
6229     /* Dispatch a request to compile a regexp to correct regexp engine. */
6230     DEBUG_COMPILE_r({
6231         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6232                         PTR2UV(eng));
6233     });
6234     return CALLREGCOMP_ENG(eng, pattern, flags);
6235 }
6236 #endif
6237
6238 /* public(ish) entry point for the perl core's own regex compiling code.
6239  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6240  * pattern rather than a list of OPs, and uses the internal engine rather
6241  * than the current one */
6242
6243 REGEXP *
6244 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6245 {
6246     SV *pat = pattern; /* defeat constness! */
6247     PERL_ARGS_ASSERT_RE_COMPILE;
6248     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6249 #ifdef PERL_IN_XSUB_RE
6250                                 &my_reg_engine,
6251 #else
6252                                 &PL_core_reg_engine,
6253 #endif
6254                                 NULL, NULL, rx_flags, 0);
6255 }
6256
6257
6258 static void
6259 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6260 {
6261     int n;
6262
6263     if (--cbs->refcnt > 0)
6264         return;
6265     for (n = 0; n < cbs->count; n++) {
6266         REGEXP *rx = cbs->cb[n].src_regex;
6267         cbs->cb[n].src_regex = NULL;
6268         SvREFCNT_dec(rx);
6269     }
6270     Safefree(cbs->cb);
6271     Safefree(cbs);
6272 }
6273
6274
6275 static struct reg_code_blocks *
6276 S_alloc_code_blocks(pTHX_  int ncode)
6277 {
6278      struct reg_code_blocks *cbs;
6279     Newx(cbs, 1, struct reg_code_blocks);
6280     cbs->count = ncode;
6281     cbs->refcnt = 1;
6282     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6283     if (ncode)
6284         Newx(cbs->cb, ncode, struct reg_code_block);
6285     else
6286         cbs->cb = NULL;
6287     return cbs;
6288 }
6289
6290
6291 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6292  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6293  * point to the realloced string and length.
6294  *
6295  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6296  * stuff added */
6297
6298 static void
6299 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6300                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6301 {
6302     U8 *const src = (U8*)*pat_p;
6303     U8 *dst, *d;
6304     int n=0;
6305     STRLEN s = 0;
6306     bool do_end = 0;
6307     GET_RE_DEBUG_FLAGS_DECL;
6308
6309     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6310         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6311
6312     Newx(dst, *plen_p * 2 + 1, U8);
6313     d = dst;
6314
6315     while (s < *plen_p) {
6316         append_utf8_from_native_byte(src[s], &d);
6317
6318         if (n < num_code_blocks) {
6319             assert(pRExC_state->code_blocks);
6320             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6321                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6322                 assert(*(d - 1) == '(');
6323                 do_end = 1;
6324             }
6325             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6326                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6327                 assert(*(d - 1) == ')');
6328                 do_end = 0;
6329                 n++;
6330             }
6331         }
6332         s++;
6333     }
6334     *d = '\0';
6335     *plen_p = d - dst;
6336     *pat_p = (char*) dst;
6337     SAVEFREEPV(*pat_p);
6338     RExC_orig_utf8 = RExC_utf8 = 1;
6339 }
6340
6341
6342
6343 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6344  * while recording any code block indices, and handling overloading,
6345  * nested qr// objects etc.  If pat is null, it will allocate a new
6346  * string, or just return the first arg, if there's only one.
6347  *
6348  * Returns the malloced/updated pat.
6349  * patternp and pat_count is the array of SVs to be concatted;
6350  * oplist is the optional list of ops that generated the SVs;
6351  * recompile_p is a pointer to a boolean that will be set if
6352  *   the regex will need to be recompiled.
6353  * delim, if non-null is an SV that will be inserted between each element
6354  */
6355
6356 static SV*
6357 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6358                 SV *pat, SV ** const patternp, int pat_count,
6359                 OP *oplist, bool *recompile_p, SV *delim)
6360 {
6361     SV **svp;
6362     int n = 0;
6363     bool use_delim = FALSE;
6364     bool alloced = FALSE;
6365
6366     /* if we know we have at least two args, create an empty string,
6367      * then concatenate args to that. For no args, return an empty string */
6368     if (!pat && pat_count != 1) {
6369         pat = newSVpvs("");
6370         SAVEFREESV(pat);
6371         alloced = TRUE;
6372     }
6373
6374     for (svp = patternp; svp < patternp + pat_count; svp++) {
6375         SV *sv;
6376         SV *rx  = NULL;
6377         STRLEN orig_patlen = 0;
6378         bool code = 0;
6379         SV *msv = use_delim ? delim : *svp;
6380         if (!msv) msv = &PL_sv_undef;
6381
6382         /* if we've got a delimiter, we go round the loop twice for each
6383          * svp slot (except the last), using the delimiter the second
6384          * time round */
6385         if (use_delim) {
6386             svp--;
6387             use_delim = FALSE;
6388         }
6389         else if (delim)
6390             use_delim = TRUE;
6391
6392         if (SvTYPE(msv) == SVt_PVAV) {
6393             /* we've encountered an interpolated array within
6394              * the pattern, e.g. /...@a..../. Expand the list of elements,
6395              * then recursively append elements.
6396              * The code in this block is based on S_pushav() */
6397
6398             AV *const av = (AV*)msv;
6399             const SSize_t maxarg = AvFILL(av) + 1;
6400             SV **array;
6401
6402             if (oplist) {
6403                 assert(oplist->op_type == OP_PADAV
6404                     || oplist->op_type == OP_RV2AV);
6405                 oplist = OpSIBLING(oplist);
6406             }
6407
6408             if (SvRMAGICAL(av)) {
6409                 SSize_t i;
6410
6411                 Newx(array, maxarg, SV*);
6412                 SAVEFREEPV(array);
6413                 for (i=0; i < maxarg; i++) {
6414                     SV ** const svp = av_fetch(av, i, FALSE);
6415                     array[i] = svp ? *svp : &PL_sv_undef;
6416                 }
6417             }
6418             else
6419                 array = AvARRAY(av);
6420
6421             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6422                                 array, maxarg, NULL, recompile_p,
6423                                 /* $" */
6424                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6425
6426             continue;
6427         }
6428
6429
6430         /* we make the assumption here that each op in the list of
6431          * op_siblings maps to one SV pushed onto the stack,
6432          * except for code blocks, with have both an OP_NULL and
6433          * and OP_CONST.
6434          * This allows us to match up the list of SVs against the
6435          * list of OPs to find the next code block.
6436          *
6437          * Note that       PUSHMARK PADSV PADSV ..
6438          * is optimised to
6439          *                 PADRANGE PADSV  PADSV  ..
6440          * so the alignment still works. */
6441
6442         if (oplist) {
6443             if (oplist->op_type == OP_NULL
6444                 && (oplist->op_flags & OPf_SPECIAL))
6445             {
6446                 assert(n < pRExC_state->code_blocks->count);
6447                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6448                 pRExC_state->code_blocks->cb[n].block = oplist;
6449                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6450                 n++;
6451                 code = 1;
6452                 oplist = OpSIBLING(oplist); /* skip CONST */
6453                 assert(oplist);
6454             }
6455             oplist = OpSIBLING(oplist);;
6456         }
6457
6458         /* apply magic and QR overloading to arg */
6459
6460         SvGETMAGIC(msv);
6461         if (SvROK(msv) && SvAMAGIC(msv)) {
6462             SV *sv = AMG_CALLunary(msv, regexp_amg);
6463             if (sv) {
6464                 if (SvROK(sv))
6465                     sv = SvRV(sv);
6466                 if (SvTYPE(sv) != SVt_REGEXP)
6467                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6468                 msv = sv;
6469             }
6470         }
6471
6472         /* try concatenation overload ... */
6473         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6474                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6475         {
6476             sv_setsv(pat, sv);
6477             /* overloading involved: all bets are off over literal
6478              * code. Pretend we haven't seen it */
6479             if (n)
6480                 pRExC_state->code_blocks->count -= n;
6481             n = 0;
6482         }
6483         else  {
6484             /* ... or failing that, try "" overload */
6485             while (SvAMAGIC(msv)
6486                     && (sv = AMG_CALLunary(msv, string_amg))
6487                     && sv != msv
6488                     &&  !(   SvROK(msv)
6489                           && SvROK(sv)
6490                           && SvRV(msv) == SvRV(sv))
6491             ) {
6492                 msv = sv;
6493                 SvGETMAGIC(msv);
6494             }
6495             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6496                 msv = SvRV(msv);
6497
6498             if (pat) {
6499                 /* this is a partially unrolled
6500                  *     sv_catsv_nomg(pat, msv);
6501                  * that allows us to adjust code block indices if
6502                  * needed */
6503                 STRLEN dlen;
6504                 char *dst = SvPV_force_nomg(pat, dlen);
6505                 orig_patlen = dlen;
6506                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6507                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6508                     sv_setpvn(pat, dst, dlen);
6509                     SvUTF8_on(pat);
6510                 }
6511                 sv_catsv_nomg(pat, msv);
6512                 rx = msv;
6513             }
6514             else {
6515                 /* We have only one SV to process, but we need to verify
6516                  * it is properly null terminated or we will fail asserts
6517                  * later. In theory we probably shouldn't get such SV's,
6518                  * but if we do we should handle it gracefully. */
6519                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) || SvIsCOW_shared_hash(msv) ) {
6520                     /* not a string, or a string with a trailing null */
6521                     pat = msv;
6522                 } else {
6523                     /* a string with no trailing null, we need to copy it
6524                      * so it has a trailing null */
6525                     pat = sv_2mortal(newSVsv(msv));
6526                 }
6527             }
6528
6529             if (code)
6530                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
6531         }
6532
6533         /* extract any code blocks within any embedded qr//'s */
6534         if (rx && SvTYPE(rx) == SVt_REGEXP
6535             && RX_ENGINE((REGEXP*)rx)->op_comp)
6536         {
6537
6538             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6539             if (ri->code_blocks && ri->code_blocks->count) {
6540                 int i;
6541                 /* the presence of an embedded qr// with code means
6542                  * we should always recompile: the text of the
6543                  * qr// may not have changed, but it may be a
6544                  * different closure than last time */
6545                 *recompile_p = 1;
6546                 if (pRExC_state->code_blocks) {
6547                     int new_count = pRExC_state->code_blocks->count
6548                             + ri->code_blocks->count;
6549                     Renew(pRExC_state->code_blocks->cb,
6550                             new_count, struct reg_code_block);
6551                     pRExC_state->code_blocks->count = new_count;
6552                 }
6553                 else
6554                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
6555                                                     ri->code_blocks->count);
6556
6557                 for (i=0; i < ri->code_blocks->count; i++) {
6558                     struct reg_code_block *src, *dst;
6559                     STRLEN offset =  orig_patlen
6560                         + ReANY((REGEXP *)rx)->pre_prefix;
6561                     assert(n < pRExC_state->code_blocks->count);
6562                     src = &ri->code_blocks->cb[i];
6563                     dst = &pRExC_state->code_blocks->cb[n];
6564                     dst->start      = src->start + offset;
6565                     dst->end        = src->end   + offset;
6566                     dst->block      = src->block;
6567                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6568                                             src->src_regex
6569                                                 ? src->src_regex
6570                                                 : (REGEXP*)rx);
6571                     n++;
6572                 }
6573             }
6574         }
6575     }
6576     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6577     if (alloced)
6578         SvSETMAGIC(pat);
6579
6580     return pat;
6581 }
6582
6583
6584
6585 /* see if there are any run-time code blocks in the pattern.
6586  * False positives are allowed */
6587
6588 static bool
6589 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6590                     char *pat, STRLEN plen)
6591 {
6592     int n = 0;
6593     STRLEN s;
6594     
6595     PERL_UNUSED_CONTEXT;
6596
6597     for (s = 0; s < plen; s++) {
6598         if (   pRExC_state->code_blocks
6599             && n < pRExC_state->code_blocks->count
6600             && s == pRExC_state->code_blocks->cb[n].start)
6601         {
6602             s = pRExC_state->code_blocks->cb[n].end;
6603             n++;
6604             continue;
6605         }
6606         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6607          * positives here */
6608         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6609             (pat[s+2] == '{'
6610                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6611         )
6612             return 1;
6613     }
6614     return 0;
6615 }
6616
6617 /* Handle run-time code blocks. We will already have compiled any direct
6618  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6619  * copy of it, but with any literal code blocks blanked out and
6620  * appropriate chars escaped; then feed it into
6621  *
6622  *    eval "qr'modified_pattern'"
6623  *
6624  * For example,
6625  *
6626  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6627  *
6628  * becomes
6629  *
6630  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6631  *
6632  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6633  * and merge them with any code blocks of the original regexp.
6634  *
6635  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6636  * instead, just save the qr and return FALSE; this tells our caller that
6637  * the original pattern needs upgrading to utf8.
6638  */
6639
6640 static bool
6641 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6642     char *pat, STRLEN plen)
6643 {
6644     SV *qr;
6645
6646     GET_RE_DEBUG_FLAGS_DECL;
6647
6648     if (pRExC_state->runtime_code_qr) {
6649         /* this is the second time we've been called; this should
6650          * only happen if the main pattern got upgraded to utf8
6651          * during compilation; re-use the qr we compiled first time
6652          * round (which should be utf8 too)
6653          */
6654         qr = pRExC_state->runtime_code_qr;
6655         pRExC_state->runtime_code_qr = NULL;
6656         assert(RExC_utf8 && SvUTF8(qr));
6657     }
6658     else {
6659         int n = 0;
6660         STRLEN s;
6661         char *p, *newpat;
6662         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
6663         SV *sv, *qr_ref;
6664         dSP;
6665
6666         /* determine how many extra chars we need for ' and \ escaping */
6667         for (s = 0; s < plen; s++) {
6668             if (pat[s] == '\'' || pat[s] == '\\')
6669                 newlen++;
6670         }
6671
6672         Newx(newpat, newlen, char);
6673         p = newpat;
6674         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6675
6676         for (s = 0; s < plen; s++) {
6677             if (   pRExC_state->code_blocks
6678                 && n < pRExC_state->code_blocks->count
6679                 && s == pRExC_state->code_blocks->cb[n].start)
6680             {
6681                 /* blank out literal code block */
6682                 assert(pat[s] == '(');
6683                 while (s <= pRExC_state->code_blocks->cb[n].end) {
6684                     *p++ = '_';
6685                     s++;
6686                 }
6687                 s--;
6688                 n++;
6689                 continue;
6690             }
6691             if (pat[s] == '\'' || pat[s] == '\\')
6692                 *p++ = '\\';
6693             *p++ = pat[s];
6694         }
6695         *p++ = '\'';
6696         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
6697             *p++ = 'x';
6698             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
6699                 *p++ = 'x';
6700             }
6701         }
6702         *p++ = '\0';
6703         DEBUG_COMPILE_r({
6704             Perl_re_printf( aTHX_
6705                 "%sre-parsing pattern for runtime code:%s %s\n",
6706                 PL_colors[4],PL_colors[5],newpat);
6707         });
6708
6709         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
6710         Safefree(newpat);
6711
6712         ENTER;
6713         SAVETMPS;
6714         save_re_context();
6715         PUSHSTACKi(PERLSI_REQUIRE);
6716         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
6717          * parsing qr''; normally only q'' does this. It also alters
6718          * hints handling */
6719         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
6720         SvREFCNT_dec_NN(sv);
6721         SPAGAIN;
6722         qr_ref = POPs;
6723         PUTBACK;
6724         {
6725             SV * const errsv = ERRSV;
6726             if (SvTRUE_NN(errsv))
6727                 /* use croak_sv ? */
6728                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
6729         }
6730         assert(SvROK(qr_ref));
6731         qr = SvRV(qr_ref);
6732         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
6733         /* the leaving below frees the tmp qr_ref.
6734          * Give qr a life of its own */
6735         SvREFCNT_inc(qr);
6736         POPSTACK;
6737         FREETMPS;
6738         LEAVE;
6739
6740     }
6741
6742     if (!RExC_utf8 && SvUTF8(qr)) {
6743         /* first time through; the pattern got upgraded; save the
6744          * qr for the next time through */
6745         assert(!pRExC_state->runtime_code_qr);
6746         pRExC_state->runtime_code_qr = qr;
6747         return 0;
6748     }
6749
6750
6751     /* extract any code blocks within the returned qr//  */
6752
6753
6754     /* merge the main (r1) and run-time (r2) code blocks into one */
6755     {
6756         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
6757         struct reg_code_block *new_block, *dst;
6758         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
6759         int i1 = 0, i2 = 0;
6760         int r1c, r2c;
6761
6762         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
6763         {
6764             SvREFCNT_dec_NN(qr);
6765             return 1;
6766         }
6767
6768         if (!r1->code_blocks)
6769             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
6770
6771         r1c = r1->code_blocks->count;
6772         r2c = r2->code_blocks->count;
6773
6774         Newx(new_block, r1c + r2c, struct reg_code_block);
6775
6776         dst = new_block;
6777
6778         while (i1 < r1c || i2 < r2c) {
6779             struct reg_code_block *src;
6780             bool is_qr = 0;
6781
6782             if (i1 == r1c) {
6783                 src = &r2->code_blocks->cb[i2++];
6784                 is_qr = 1;
6785             }
6786             else if (i2 == r2c)
6787                 src = &r1->code_blocks->cb[i1++];
6788             else if (  r1->code_blocks->cb[i1].start
6789                      < r2->code_blocks->cb[i2].start)
6790             {
6791                 src = &r1->code_blocks->cb[i1++];
6792                 assert(src->end < r2->code_blocks->cb[i2].start);
6793             }
6794             else {
6795                 assert(  r1->code_blocks->cb[i1].start
6796                        > r2->code_blocks->cb[i2].start);
6797                 src = &r2->code_blocks->cb[i2++];
6798                 is_qr = 1;
6799                 assert(src->end < r1->code_blocks->cb[i1].start);
6800             }
6801
6802             assert(pat[src->start] == '(');
6803             assert(pat[src->end]   == ')');
6804             dst->start      = src->start;
6805             dst->end        = src->end;
6806             dst->block      = src->block;
6807             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
6808                                     : src->src_regex;
6809             dst++;
6810         }
6811         r1->code_blocks->count += r2c;
6812         Safefree(r1->code_blocks->cb);
6813         r1->code_blocks->cb = new_block;
6814     }
6815
6816     SvREFCNT_dec_NN(qr);
6817     return 1;
6818 }
6819
6820
6821 STATIC bool
6822 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
6823                       struct reg_substr_datum  *rsd,
6824                       struct scan_data_substrs *sub,
6825                       STRLEN longest_length)
6826 {
6827     /* This is the common code for setting up the floating and fixed length
6828      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
6829      * as to whether succeeded or not */
6830
6831     I32 t;
6832     SSize_t ml;
6833     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
6834     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
6835
6836     if (! (longest_length
6837            || (eol /* Can't have SEOL and MULTI */
6838                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
6839           )
6840             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
6841         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
6842     {
6843         return FALSE;
6844     }
6845
6846     /* copy the information about the longest from the reg_scan_data
6847         over to the program. */
6848     if (SvUTF8(sub->str)) {
6849         rsd->substr      = NULL;
6850         rsd->utf8_substr = sub->str;
6851     } else {
6852         rsd->substr      = sub->str;
6853         rsd->utf8_substr = NULL;
6854     }
6855     /* end_shift is how many chars that must be matched that
6856         follow this item. We calculate it ahead of time as once the
6857         lookbehind offset is added in we lose the ability to correctly
6858         calculate it.*/
6859     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
6860     rsd->end_shift = ml - sub->min_offset
6861         - longest_length
6862             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
6863              * intead? - DAPM
6864             + (SvTAIL(sub->str) != 0)
6865             */
6866         + sub->lookbehind;
6867
6868     t = (eol/* Can't have SEOL and MULTI */
6869          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
6870     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
6871
6872     return TRUE;
6873 }
6874
6875 /*
6876  * Perl_re_op_compile - the perl internal RE engine's function to compile a
6877  * regular expression into internal code.
6878  * The pattern may be passed either as:
6879  *    a list of SVs (patternp plus pat_count)
6880  *    a list of OPs (expr)
6881  * If both are passed, the SV list is used, but the OP list indicates
6882  * which SVs are actually pre-compiled code blocks
6883  *
6884  * The SVs in the list have magic and qr overloading applied to them (and
6885  * the list may be modified in-place with replacement SVs in the latter
6886  * case).
6887  *
6888  * If the pattern hasn't changed from old_re, then old_re will be
6889  * returned.
6890  *
6891  * eng is the current engine. If that engine has an op_comp method, then
6892  * handle directly (i.e. we assume that op_comp was us); otherwise, just
6893  * do the initial concatenation of arguments and pass on to the external
6894  * engine.
6895  *
6896  * If is_bare_re is not null, set it to a boolean indicating whether the
6897  * arg list reduced (after overloading) to a single bare regex which has
6898  * been returned (i.e. /$qr/).
6899  *
6900  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
6901  *
6902  * pm_flags contains the PMf_* flags, typically based on those from the
6903  * pm_flags field of the related PMOP. Currently we're only interested in
6904  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
6905  *
6906  * We can't allocate space until we know how big the compiled form will be,
6907  * but we can't compile it (and thus know how big it is) until we've got a
6908  * place to put the code.  So we cheat:  we compile it twice, once with code
6909  * generation turned off and size counting turned on, and once "for real".
6910  * This also means that we don't allocate space until we are sure that the
6911  * thing really will compile successfully, and we never have to move the
6912  * code and thus invalidate pointers into it.  (Note that it has to be in
6913  * one piece because free() must be able to free it all.) [NB: not true in perl]
6914  *
6915  * Beware that the optimization-preparation code in here knows about some
6916  * of the structure of the compiled regexp.  [I'll say.]
6917  */
6918
6919 REGEXP *
6920 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
6921                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
6922                      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
6923 {
6924     REGEXP *rx;
6925     struct regexp *r;
6926     regexp_internal *ri;
6927     STRLEN plen;
6928     char *exp;
6929     regnode *scan;
6930     I32 flags;
6931     SSize_t minlen = 0;
6932     U32 rx_flags;
6933     SV *pat;
6934     SV** new_patternp = patternp;
6935
6936     /* these are all flags - maybe they should be turned
6937      * into a single int with different bit masks */
6938     I32 sawlookahead = 0;
6939     I32 sawplus = 0;
6940     I32 sawopen = 0;
6941     I32 sawminmod = 0;
6942
6943     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
6944     bool recompile = 0;
6945     bool runtime_code = 0;
6946     scan_data_t data;
6947     RExC_state_t RExC_state;
6948     RExC_state_t * const pRExC_state = &RExC_state;
6949 #ifdef TRIE_STUDY_OPT
6950     int restudied = 0;
6951     RExC_state_t copyRExC_state;
6952 #endif
6953     GET_RE_DEBUG_FLAGS_DECL;
6954
6955     PERL_ARGS_ASSERT_RE_OP_COMPILE;
6956
6957     DEBUG_r(if (!PL_colorset) reginitcolors());
6958
6959     /* Initialize these here instead of as-needed, as is quick and avoids
6960      * having to test them each time otherwise */
6961     if (! PL_InBitmap) {
6962 #ifdef DEBUGGING
6963         char * dump_len_string;
6964 #endif
6965
6966         /* This is calculated here, because the Perl program that generates the
6967          * static global ones doesn't currently have access to
6968          * NUM_ANYOF_CODE_POINTS */
6969         PL_InBitmap = _new_invlist(2);
6970         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
6971                                                     NUM_ANYOF_CODE_POINTS - 1);
6972 #ifdef DEBUGGING
6973         dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
6974         if (   ! dump_len_string
6975             || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
6976         {
6977             PL_dump_re_max_len = 60;    /* A reasonable default */
6978         }
6979 #endif
6980     }
6981
6982     pRExC_state->warn_text = NULL;
6983     pRExC_state->code_blocks = NULL;
6984
6985     if (is_bare_re)
6986         *is_bare_re = FALSE;
6987
6988     if (expr && (expr->op_type == OP_LIST ||
6989                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
6990         /* allocate code_blocks if needed */
6991         OP *o;
6992         int ncode = 0;
6993
6994         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
6995             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
6996                 ncode++; /* count of DO blocks */
6997
6998         if (ncode)
6999             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
7000     }
7001
7002     if (!pat_count) {
7003         /* compile-time pattern with just OP_CONSTs and DO blocks */
7004
7005         int n;
7006         OP *o;
7007
7008         /* find how many CONSTs there are */
7009         assert(expr);
7010         n = 0;
7011         if (expr->op_type == OP_CONST)
7012             n = 1;
7013         else
7014             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7015                 if (o->op_type == OP_CONST)
7016                     n++;
7017             }
7018
7019         /* fake up an SV array */
7020
7021         assert(!new_patternp);
7022         Newx(new_patternp, n, SV*);
7023         SAVEFREEPV(new_patternp);
7024         pat_count = n;
7025
7026         n = 0;
7027         if (expr->op_type == OP_CONST)
7028             new_patternp[n] = cSVOPx_sv(expr);
7029         else
7030             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7031                 if (o->op_type == OP_CONST)
7032                     new_patternp[n++] = cSVOPo_sv;
7033             }
7034
7035     }
7036
7037     DEBUG_PARSE_r(Perl_re_printf( aTHX_
7038         "Assembling pattern from %d elements%s\n", pat_count,
7039             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7040
7041     /* set expr to the first arg op */
7042
7043     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
7044          && expr->op_type != OP_CONST)
7045     {
7046             expr = cLISTOPx(expr)->op_first;
7047             assert(   expr->op_type == OP_PUSHMARK
7048                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
7049                    || expr->op_type == OP_PADRANGE);
7050             expr = OpSIBLING(expr);
7051     }
7052
7053     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
7054                         expr, &recompile, NULL);
7055
7056     /* handle bare (possibly after overloading) regex: foo =~ $re */
7057     {
7058         SV *re = pat;
7059         if (SvROK(re))
7060             re = SvRV(re);
7061         if (SvTYPE(re) == SVt_REGEXP) {
7062             if (is_bare_re)
7063                 *is_bare_re = TRUE;
7064             SvREFCNT_inc(re);
7065             DEBUG_PARSE_r(Perl_re_printf( aTHX_
7066                 "Precompiled pattern%s\n",
7067                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7068
7069             return (REGEXP*)re;
7070         }
7071     }
7072
7073     exp = SvPV_nomg(pat, plen);
7074
7075     if (!eng->op_comp) {
7076         if ((SvUTF8(pat) && IN_BYTES)
7077                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7078         {
7079             /* make a temporary copy; either to convert to bytes,
7080              * or to avoid repeating get-magic / overloaded stringify */
7081             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7082                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7083         }
7084         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7085     }
7086
7087     /* ignore the utf8ness if the pattern is 0 length */
7088     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7089
7090     RExC_uni_semantics = 0;
7091     RExC_seen_unfolded_sharp_s = 0;
7092     RExC_contains_locale = 0;
7093     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7094     RExC_in_script_run = 0;
7095     RExC_study_started = 0;
7096     pRExC_state->runtime_code_qr = NULL;
7097     RExC_frame_head= NULL;
7098     RExC_frame_last= NULL;
7099     RExC_frame_count= 0;
7100
7101     DEBUG_r({
7102         RExC_mysv1= sv_newmortal();
7103         RExC_mysv2= sv_newmortal();
7104     });
7105     DEBUG_COMPILE_r({
7106             SV *dsv= sv_newmortal();
7107             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7108             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7109                           PL_colors[4],PL_colors[5],s);
7110         });
7111
7112   redo_first_pass:
7113     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7114      * to utf8 */
7115
7116     if ((pm_flags & PMf_USE_RE_EVAL)
7117                 /* this second condition covers the non-regex literal case,
7118                  * i.e.  $foo =~ '(?{})'. */
7119                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7120     )
7121         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7122
7123     /* return old regex if pattern hasn't changed */
7124     /* XXX: note in the below we have to check the flags as well as the
7125      * pattern.
7126      *
7127      * Things get a touch tricky as we have to compare the utf8 flag
7128      * independently from the compile flags.  */
7129
7130     if (   old_re
7131         && !recompile
7132         && !!RX_UTF8(old_re) == !!RExC_utf8
7133         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7134         && RX_PRECOMP(old_re)
7135         && RX_PRELEN(old_re) == plen
7136         && memEQ(RX_PRECOMP(old_re), exp, plen)
7137         && !runtime_code /* with runtime code, always recompile */ )
7138     {
7139         return old_re;
7140     }
7141
7142     rx_flags = orig_rx_flags;
7143
7144     if (   initial_charset == REGEX_DEPENDS_CHARSET
7145         && (RExC_utf8 ||RExC_uni_semantics))
7146     {
7147
7148         /* Set to use unicode semantics if the pattern is in utf8 and has the
7149          * 'depends' charset specified, as it means unicode when utf8  */
7150         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7151     }
7152
7153     RExC_precomp = exp;
7154     RExC_precomp_adj = 0;
7155     RExC_flags = rx_flags;
7156     RExC_pm_flags = pm_flags;
7157
7158     if (runtime_code) {
7159         assert(TAINTING_get || !TAINT_get);
7160         if (TAINT_get)
7161             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7162
7163         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7164             /* whoops, we have a non-utf8 pattern, whilst run-time code
7165              * got compiled as utf8. Try again with a utf8 pattern */
7166             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7167                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7168             goto redo_first_pass;
7169         }
7170     }
7171     assert(!pRExC_state->runtime_code_qr);
7172
7173     RExC_sawback = 0;
7174
7175     RExC_seen = 0;
7176     RExC_maxlen = 0;
7177     RExC_in_lookbehind = 0;
7178     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7179     RExC_extralen = 0;
7180 #ifdef EBCDIC
7181     RExC_recode_x_to_native = 0;
7182 #endif
7183     RExC_in_multi_char_class = 0;
7184
7185     /* First pass: determine size, legality. */
7186     RExC_parse = exp;
7187     RExC_start = RExC_adjusted_start = exp;
7188     RExC_end = exp + plen;
7189     RExC_precomp_end = RExC_end;
7190     RExC_naughty = 0;
7191     RExC_npar = 1;
7192     RExC_nestroot = 0;
7193     RExC_size = 0L;
7194     RExC_emit = (regnode *) &RExC_emit_dummy;
7195     RExC_whilem_seen = 0;
7196     RExC_open_parens = NULL;
7197     RExC_close_parens = NULL;
7198     RExC_end_op = NULL;
7199     RExC_paren_names = NULL;
7200 #ifdef DEBUGGING
7201     RExC_paren_name_list = NULL;
7202 #endif
7203     RExC_recurse = NULL;
7204     RExC_study_chunk_recursed = NULL;
7205     RExC_study_chunk_recursed_bytes= 0;
7206     RExC_recurse_count = 0;
7207     pRExC_state->code_index = 0;
7208
7209     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7210      * code makes sure the final byte is an uncounted NUL.  But should this
7211      * ever not be the case, lots of things could read beyond the end of the
7212      * buffer: loops like
7213      *      while(isFOO(*RExC_parse)) RExC_parse++;
7214      *      strchr(RExC_parse, "foo");
7215      * etc.  So it is worth noting. */
7216     assert(*RExC_end == '\0');
7217
7218     DEBUG_PARSE_r(
7219         Perl_re_printf( aTHX_  "Starting first pass (sizing)\n");
7220         RExC_lastnum=0;
7221         RExC_lastparse=NULL;
7222     );
7223
7224     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7225         /* It's possible to write a regexp in ascii that represents Unicode
7226         codepoints outside of the byte range, such as via \x{100}. If we
7227         detect such a sequence we have to convert the entire pattern to utf8
7228         and then recompile, as our sizing calculation will have been based
7229         on 1 byte == 1 character, but we will need to use utf8 to encode
7230         at least some part of the pattern, and therefore must convert the whole
7231         thing.
7232         -- dmq */
7233         if (MUST_RESTART(flags)) {
7234             if (flags & NEED_UTF8) {
7235                 S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7236                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7237                 DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo pass 1 after upgrade\n"));
7238             }
7239             else {
7240                 DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo pass 1\n"));
7241             }
7242
7243             goto redo_first_pass;
7244         }
7245         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#" UVxf, (UV) flags);
7246     }
7247
7248     DEBUG_PARSE_r({
7249         Perl_re_printf( aTHX_
7250             "Required size %" IVdf " nodes\n"
7251             "Starting second pass (creation)\n",
7252             (IV)RExC_size);
7253         RExC_lastnum=0;
7254         RExC_lastparse=NULL;
7255     });
7256
7257     /* The first pass could have found things that force Unicode semantics */
7258     if ((RExC_utf8 || RExC_uni_semantics)
7259          && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
7260     {
7261         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7262     }
7263
7264     /* Small enough for pointer-storage convention?
7265        If extralen==0, this means that we will not need long jumps. */
7266     if (RExC_size >= 0x10000L && RExC_extralen)
7267         RExC_size += RExC_extralen;
7268     else
7269         RExC_extralen = 0;
7270     if (RExC_whilem_seen > 15)
7271         RExC_whilem_seen = 15;
7272
7273     /* Allocate space and zero-initialize. Note, the two step process
7274        of zeroing when in debug mode, thus anything assigned has to
7275        happen after that */
7276     rx = (REGEXP*) newSV_type(SVt_REGEXP);
7277     r = ReANY(rx);
7278     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7279          char, regexp_internal);
7280     if ( r == NULL || ri == NULL )
7281         FAIL("Regexp out of space");
7282 #ifdef DEBUGGING
7283     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
7284     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
7285          char);
7286 #else
7287     /* bulk initialize base fields with 0. */
7288     Zero(ri, sizeof(regexp_internal), char);
7289 #endif
7290
7291     /* non-zero initialization begins here */
7292     RXi_SET( r, ri );
7293     r->engine= eng;
7294     r->extflags = rx_flags;
7295     RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7296
7297     if (pm_flags & PMf_IS_QR) {
7298         ri->code_blocks = pRExC_state->code_blocks;
7299         if (ri->code_blocks)
7300             ri->code_blocks->refcnt++;
7301     }
7302
7303     {
7304         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7305         bool has_charset = (get_regex_charset(r->extflags)
7306                                                     != REGEX_DEPENDS_CHARSET);
7307
7308         /* The caret is output if there are any defaults: if not all the STD
7309          * flags are set, or if no character set specifier is needed */
7310         bool has_default =
7311                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7312                     || ! has_charset);
7313         bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7314                                                    == REG_RUN_ON_COMMENT_SEEN);
7315         U8 reganch = (U8)((r->extflags & RXf_PMf_STD_PMMOD)
7316                             >> RXf_PMf_STD_PMMOD_SHIFT);
7317         const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7318         char *p;
7319
7320         /* We output all the necessary flags; we never output a minus, as all
7321          * those are defaults, so are
7322          * covered by the caret */
7323         const STRLEN wraplen = plen + has_p + has_runon
7324             + has_default       /* If needs a caret */
7325             + PL_bitcount[reganch] /* 1 char for each set standard flag */
7326
7327                 /* If needs a character set specifier */
7328             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7329             + (sizeof("(?:)") - 1);
7330
7331         /* make sure PL_bitcount bounds not exceeded */
7332         assert(sizeof(STD_PAT_MODS) <= 8);
7333
7334         p = sv_grow(MUTABLE_SV(rx), wraplen + 1); /* +1 for the ending NUL */
7335         SvPOK_on(rx);
7336         if (RExC_utf8)
7337             SvFLAGS(rx) |= SVf_UTF8;
7338         *p++='('; *p++='?';
7339
7340         /* If a default, cover it using the caret */
7341         if (has_default) {
7342             *p++= DEFAULT_PAT_MOD;
7343         }
7344         if (has_charset) {
7345             STRLEN len;
7346             const char* const name = get_regex_charset_name(r->extflags, &len);
7347             Copy(name, p, len, char);
7348             p += len;
7349         }
7350         if (has_p)
7351             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7352         {
7353             char ch;
7354             while((ch = *fptr++)) {
7355                 if(reganch & 1)
7356                     *p++ = ch;
7357                 reganch >>= 1;
7358             }
7359         }
7360
7361         *p++ = ':';
7362         Copy(RExC_precomp, p, plen, char);
7363         assert ((RX_WRAPPED(rx) - p) < 16);
7364         r->pre_prefix = p - RX_WRAPPED(rx);
7365         p += plen;
7366         if (has_runon)
7367             *p++ = '\n';
7368         *p++ = ')';
7369         *p = 0;
7370         SvCUR_set(rx, p - RX_WRAPPED(rx));
7371     }
7372
7373     r->intflags = 0;
7374     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
7375
7376     /* Useful during FAIL. */
7377 #ifdef RE_TRACK_PATTERN_OFFSETS
7378     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
7379     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7380                           "%s %" UVuf " bytes for offset annotations.\n",
7381                           ri->u.offsets ? "Got" : "Couldn't get",
7382                           (UV)((2*RExC_size+1) * sizeof(U32))));
7383 #endif
7384     SetProgLen(ri,RExC_size);
7385     RExC_rx_sv = rx;
7386     RExC_rx = r;
7387     RExC_rxi = ri;
7388
7389     /* Second pass: emit code. */
7390     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7391     RExC_pm_flags = pm_flags;
7392     RExC_parse = exp;
7393     RExC_end = exp + plen;
7394     RExC_naughty = 0;
7395     RExC_emit_start = ri->program;
7396     RExC_emit = ri->program;
7397     RExC_emit_bound = ri->program + RExC_size + 1;
7398     pRExC_state->code_index = 0;
7399
7400     *((char*) RExC_emit++) = (char) REG_MAGIC;
7401     /* setup various meta data about recursion, this all requires
7402      * RExC_npar to be correctly set, and a bit later on we clear it */
7403     if (RExC_seen & REG_RECURSE_SEEN) {
7404         DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
7405             "%*s%*s Setting up open/close parens\n",
7406                   22, "|    |", (int)(0 * 2 + 1), ""));
7407
7408         /* setup RExC_open_parens, which holds the address of each
7409          * OPEN tag, and to make things simpler for the 0 index
7410          * the start of the program - this is used later for offsets */
7411         Newxz(RExC_open_parens, RExC_npar,regnode *);
7412         SAVEFREEPV(RExC_open_parens);
7413         RExC_open_parens[0] = RExC_emit;
7414
7415         /* setup RExC_close_parens, which holds the address of each
7416          * CLOSE tag, and to make things simpler for the 0 index
7417          * the end of the program - this is used later for offsets */
7418         Newxz(RExC_close_parens, RExC_npar,regnode *);
7419         SAVEFREEPV(RExC_close_parens);
7420         /* we dont know where end op starts yet, so we dont
7421          * need to set RExC_close_parens[0] like we do RExC_open_parens[0] above */
7422
7423         /* Note, RExC_npar is 1 + the number of parens in a pattern.
7424          * So its 1 if there are no parens. */
7425         RExC_study_chunk_recursed_bytes= (RExC_npar >> 3) +
7426                                          ((RExC_npar & 0x07) != 0);
7427         Newx(RExC_study_chunk_recursed,
7428              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7429         SAVEFREEPV(RExC_study_chunk_recursed);
7430     }
7431     RExC_npar = 1;
7432     if (reg(pRExC_state, 0, &flags,1) == NULL) {
7433         ReREFCNT_dec(rx);
7434         Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#" UVxf, (UV) flags);
7435     }
7436     DEBUG_OPTIMISE_r(
7437         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
7438     );
7439
7440     /* XXXX To minimize changes to RE engine we always allocate
7441        3-units-long substrs field. */
7442     Newx(r->substrs, 1, struct reg_substr_data);
7443     if (RExC_recurse_count) {
7444         Newx(RExC_recurse,RExC_recurse_count,regnode *);
7445         SAVEFREEPV(RExC_recurse);
7446     }
7447
7448   reStudy:
7449     r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
7450     DEBUG_r(
7451         RExC_study_chunk_recursed_count= 0;
7452     );
7453     Zero(r->substrs, 1, struct reg_substr_data);
7454     if (RExC_study_chunk_recursed) {
7455         Zero(RExC_study_chunk_recursed,
7456              RExC_study_chunk_recursed_bytes * RExC_npar, U8);
7457     }
7458
7459
7460 #ifdef TRIE_STUDY_OPT
7461     if (!restudied) {
7462         StructCopy(&zero_scan_data, &data, scan_data_t);
7463         copyRExC_state = RExC_state;
7464     } else {
7465         U32 seen=RExC_seen;
7466         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
7467
7468         RExC_state = copyRExC_state;
7469         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
7470             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
7471         else
7472             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
7473         StructCopy(&zero_scan_data, &data, scan_data_t);
7474     }
7475 #else
7476     StructCopy(&zero_scan_data, &data, scan_data_t);
7477 #endif
7478
7479     /* Dig out information for optimizations. */
7480     r->extflags = RExC_flags; /* was pm_op */
7481     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
7482
7483     if (UTF)
7484         SvUTF8_on(rx);  /* Unicode in it? */
7485     ri->regstclass = NULL;
7486     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
7487         r->intflags |= PREGf_NAUGHTY;
7488     scan = ri->program + 1;             /* First BRANCH. */
7489
7490     /* testing for BRANCH here tells us whether there is "must appear"
7491        data in the pattern. If there is then we can use it for optimisations */
7492     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
7493                                                   */
7494         SSize_t fake;
7495         STRLEN longest_length[2];
7496         regnode_ssc ch_class; /* pointed to by data */
7497         int stclass_flag;
7498         SSize_t last_close = 0; /* pointed to by data */
7499         regnode *first= scan;
7500         regnode *first_next= regnext(first);
7501         int i;
7502
7503         /*
7504          * Skip introductions and multiplicators >= 1
7505          * so that we can extract the 'meat' of the pattern that must
7506          * match in the large if() sequence following.
7507          * NOTE that EXACT is NOT covered here, as it is normally
7508          * picked up by the optimiser separately.
7509          *
7510          * This is unfortunate as the optimiser isnt handling lookahead
7511          * properly currently.
7512          *
7513          */
7514         while ((OP(first) == OPEN && (sawopen = 1)) ||
7515                /* An OR of *one* alternative - should not happen now. */
7516             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
7517             /* for now we can't handle lookbehind IFMATCH*/
7518             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
7519             (OP(first) == PLUS) ||
7520             (OP(first) == MINMOD) ||
7521                /* An {n,m} with n>0 */
7522             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
7523             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
7524         {
7525                 /*
7526                  * the only op that could be a regnode is PLUS, all the rest
7527                  * will be regnode_1 or regnode_2.
7528                  *
7529                  * (yves doesn't think this is true)
7530                  */
7531                 if (OP(first) == PLUS)
7532                     sawplus = 1;
7533                 else {
7534                     if (OP(first) == MINMOD)
7535                         sawminmod = 1;
7536                     first += regarglen[OP(first)];
7537                 }
7538                 first = NEXTOPER(first);
7539                 first_next= regnext(first);
7540         }
7541
7542         /* Starting-point info. */
7543       again:
7544         DEBUG_PEEP("first:", first, 0, 0);
7545         /* Ignore EXACT as we deal with it later. */
7546         if (PL_regkind[OP(first)] == EXACT) {
7547             if (OP(first) == EXACT || OP(first) == EXACTL)
7548                 NOOP;   /* Empty, get anchored substr later. */
7549             else
7550                 ri->regstclass = first;
7551         }
7552 #ifdef TRIE_STCLASS
7553         else if (PL_regkind[OP(first)] == TRIE &&
7554                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
7555         {
7556             /* this can happen only on restudy */
7557             ri->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7558         }
7559 #endif
7560         else if (REGNODE_SIMPLE(OP(first)))
7561             ri->regstclass = first;
7562         else if (PL_regkind[OP(first)] == BOUND ||
7563                  PL_regkind[OP(first)] == NBOUND)
7564             ri->regstclass = first;
7565         else if (PL_regkind[OP(first)] == BOL) {
7566             r->intflags |= (OP(first) == MBOL
7567                            ? PREGf_ANCH_MBOL
7568                            : PREGf_ANCH_SBOL);
7569             first = NEXTOPER(first);
7570             goto again;
7571         }
7572         else if (OP(first) == GPOS) {
7573             r->intflags |= PREGf_ANCH_GPOS;
7574             first = NEXTOPER(first);
7575             goto again;
7576         }
7577         else if ((!sawopen || !RExC_sawback) &&
7578             !sawlookahead &&
7579             (OP(first) == STAR &&
7580             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
7581             !(r->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
7582         {
7583             /* turn .* into ^.* with an implied $*=1 */
7584             const int type =
7585                 (OP(NEXTOPER(first)) == REG_ANY)
7586                     ? PREGf_ANCH_MBOL
7587                     : PREGf_ANCH_SBOL;
7588             r->intflags |= (type | PREGf_IMPLICIT);
7589             first = NEXTOPER(first);
7590             goto again;
7591         }
7592         if (sawplus && !sawminmod && !sawlookahead
7593             && (!sawopen || !RExC_sawback)
7594             && !pRExC_state->code_blocks) /* May examine pos and $& */
7595             /* x+ must match at the 1st pos of run of x's */
7596             r->intflags |= PREGf_SKIP;
7597
7598         /* Scan is after the zeroth branch, first is atomic matcher. */
7599 #ifdef TRIE_STUDY_OPT
7600         DEBUG_PARSE_r(
7601             if (!restudied)
7602                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7603                               (IV)(first - scan + 1))
7604         );
7605 #else
7606         DEBUG_PARSE_r(
7607             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
7608                 (IV)(first - scan + 1))
7609         );
7610 #endif
7611
7612
7613         /*
7614         * If there's something expensive in the r.e., find the
7615         * longest literal string that must appear and make it the
7616         * regmust.  Resolve ties in favor of later strings, since
7617         * the regstart check works with the beginning of the r.e.
7618         * and avoiding duplication strengthens checking.  Not a
7619         * strong reason, but sufficient in the absence of others.
7620         * [Now we resolve ties in favor of the earlier string if
7621         * it happens that c_offset_min has been invalidated, since the
7622         * earlier string may buy us something the later one won't.]
7623         */
7624
7625         data.substrs[0].str = newSVpvs("");
7626         data.substrs[1].str = newSVpvs("");
7627         data.last_found = newSVpvs("");
7628         data.cur_is_floating = 0; /* initially any found substring is fixed */
7629         ENTER_with_name("study_chunk");
7630         SAVEFREESV(data.substrs[0].str);
7631         SAVEFREESV(data.substrs[1].str);
7632         SAVEFREESV(data.last_found);
7633         first = scan;
7634         if (!ri->regstclass) {
7635             ssc_init(pRExC_state, &ch_class);
7636             data.start_class = &ch_class;
7637             stclass_flag = SCF_DO_STCLASS_AND;
7638         } else                          /* XXXX Check for BOUND? */
7639             stclass_flag = 0;
7640         data.last_closep = &last_close;
7641
7642         DEBUG_RExC_seen();
7643         /*
7644          * MAIN ENTRY FOR study_chunk() FOR m/PATTERN/
7645          * (NO top level branches)
7646          */
7647         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
7648                              scan + RExC_size, /* Up to end */
7649             &data, -1, 0, NULL,
7650             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
7651                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
7652             0);
7653
7654
7655         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
7656
7657
7658         if ( RExC_npar == 1 && !data.cur_is_floating
7659              && data.last_start_min == 0 && data.last_end > 0
7660              && !RExC_seen_zerolen
7661              && !(RExC_seen & REG_VERBARG_SEEN)
7662              && !(RExC_seen & REG_GPOS_SEEN)
7663         ){
7664             r->extflags |= RXf_CHECK_ALL;
7665         }
7666         scan_commit(pRExC_state, &data,&minlen,0);
7667
7668
7669         /* XXX this is done in reverse order because that's the way the
7670          * code was before it was parameterised. Don't know whether it
7671          * actually needs doing in reverse order. DAPM */
7672         for (i = 1; i >= 0; i--) {
7673             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
7674
7675             if (   !(   i
7676                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
7677                      &&    data.substrs[0].min_offset
7678                         == data.substrs[1].min_offset
7679                      &&    SvCUR(data.substrs[0].str)
7680                         == SvCUR(data.substrs[1].str)
7681                     )
7682                 && S_setup_longest (aTHX_ pRExC_state,
7683                                         &(r->substrs->data[i]),
7684                                         &(data.substrs[i]),
7685                                         longest_length[i]))
7686             {
7687                 r->substrs->data[i].min_offset =
7688                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
7689
7690                 r->substrs->data[i].max_offset = data.substrs[i].max_offset;
7691                 /* Don't offset infinity */
7692                 if (data.substrs[i].max_offset < SSize_t_MAX)
7693                     r->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
7694                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
7695             }
7696             else {
7697                 r->substrs->data[i].substr      = NULL;
7698                 r->substrs->data[i].utf8_substr = NULL;
7699                 longest_length[i] = 0;
7700             }
7701         }
7702
7703         LEAVE_with_name("study_chunk");
7704
7705         if (ri->regstclass
7706             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
7707             ri->regstclass = NULL;
7708
7709         if ((!(r->substrs->data[0].substr || r->substrs->data[0].utf8_substr)
7710               || r->substrs->data[0].min_offset)
7711             && stclass_flag
7712             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7713             && is_ssc_worth_it(pRExC_state, data.start_class))
7714         {
7715             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7716
7717             ssc_finalize(pRExC_state, data.start_class);
7718
7719             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7720             StructCopy(data.start_class,
7721                        (regnode_ssc*)RExC_rxi->data->data[n],
7722                        regnode_ssc);
7723             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7724             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7725             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
7726                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7727                       Perl_re_printf( aTHX_
7728                                     "synthetic stclass \"%s\".\n",
7729                                     SvPVX_const(sv));});
7730             data.start_class = NULL;
7731         }
7732
7733         /* A temporary algorithm prefers floated substr to fixed one of
7734          * same length to dig more info. */
7735         i = (longest_length[0] <= longest_length[1]);
7736         r->substrs->check_ix = i;
7737         r->check_end_shift  = r->substrs->data[i].end_shift;
7738         r->check_substr     = r->substrs->data[i].substr;
7739         r->check_utf8       = r->substrs->data[i].utf8_substr;
7740         r->check_offset_min = r->substrs->data[i].min_offset;
7741         r->check_offset_max = r->substrs->data[i].max_offset;
7742         if (!i && (r->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
7743             r->intflags |= PREGf_NOSCAN;
7744
7745         if ((r->check_substr || r->check_utf8) ) {
7746             r->extflags |= RXf_USE_INTUIT;
7747             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
7748                 r->extflags |= RXf_INTUIT_TAIL;
7749         }
7750
7751         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
7752         if ( (STRLEN)minlen < longest_length[1] )
7753             minlen= longest_length[1];
7754         if ( (STRLEN)minlen < longest_length[0] )
7755             minlen= longest_length[0];
7756         */
7757     }
7758     else {
7759         /* Several toplevels. Best we can is to set minlen. */
7760         SSize_t fake;
7761         regnode_ssc ch_class;
7762         SSize_t last_close = 0;
7763
7764         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
7765
7766         scan = ri->program + 1;
7767         ssc_init(pRExC_state, &ch_class);
7768         data.start_class = &ch_class;
7769         data.last_closep = &last_close;
7770
7771         DEBUG_RExC_seen();
7772         /*
7773          * MAIN ENTRY FOR study_chunk() FOR m/P1|P2|.../
7774          * (patterns WITH top level branches)
7775          */
7776         minlen = study_chunk(pRExC_state,
7777             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
7778             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
7779                                                       ? SCF_TRIE_DOING_RESTUDY
7780                                                       : 0),
7781             0);
7782
7783         CHECK_RESTUDY_GOTO_butfirst(NOOP);
7784
7785         r->check_substr = NULL;
7786         r->check_utf8 = NULL;
7787         r->substrs->data[0].substr      = NULL;
7788         r->substrs->data[0].utf8_substr = NULL;
7789         r->substrs->data[1].substr      = NULL;
7790         r->substrs->data[1].utf8_substr = NULL;
7791
7792         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7793             && is_ssc_worth_it(pRExC_state, data.start_class))
7794         {
7795             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7796
7797             ssc_finalize(pRExC_state, data.start_class);
7798
7799             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7800             StructCopy(data.start_class,
7801                        (regnode_ssc*)RExC_rxi->data->data[n],
7802                        regnode_ssc);
7803             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7804             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7805             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
7806                       regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7807                       Perl_re_printf( aTHX_
7808                                     "synthetic stclass \"%s\".\n",
7809                                     SvPVX_const(sv));});
7810             data.start_class = NULL;
7811         }
7812     }
7813
7814     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
7815         r->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
7816         r->maxlen = REG_INFTY;
7817     }
7818     else {
7819         r->maxlen = RExC_maxlen;
7820     }
7821
7822     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
7823        the "real" pattern. */
7824     DEBUG_OPTIMISE_r({
7825         Perl_re_printf( aTHX_ "minlen: %" IVdf " r->minlen:%" IVdf " maxlen:%" IVdf "\n",
7826                       (IV)minlen, (IV)r->minlen, (IV)RExC_maxlen);
7827     });
7828     r->minlenret = minlen;
7829     if (r->minlen < minlen)
7830         r->minlen = minlen;
7831
7832     if (RExC_seen & REG_RECURSE_SEEN ) {
7833         r->intflags |= PREGf_RECURSE_SEEN;
7834         Newx(r->recurse_locinput, r->nparens + 1, char *);
7835     }
7836     if (RExC_seen & REG_GPOS_SEEN)
7837         r->intflags |= PREGf_GPOS_SEEN;
7838     if (RExC_seen & REG_LOOKBEHIND_SEEN)
7839         r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
7840                                                 lookbehind */
7841     if (pRExC_state->code_blocks)
7842         r->extflags |= RXf_EVAL_SEEN;
7843     if (RExC_seen & REG_VERBARG_SEEN)
7844     {
7845         r->intflags |= PREGf_VERBARG_SEEN;
7846         r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
7847     }
7848     if (RExC_seen & REG_CUTGROUP_SEEN)
7849         r->intflags |= PREGf_CUTGROUP_SEEN;
7850     if (pm_flags & PMf_USE_RE_EVAL)
7851         r->intflags |= PREGf_USE_RE_EVAL;
7852     if (RExC_paren_names)
7853         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
7854     else
7855         RXp_PAREN_NAMES(r) = NULL;
7856
7857     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
7858      * so it can be used in pp.c */
7859     if (r->intflags & PREGf_ANCH)
7860         r->extflags |= RXf_IS_ANCHORED;
7861
7862
7863     {
7864         /* this is used to identify "special" patterns that might result
7865          * in Perl NOT calling the regex engine and instead doing the match "itself",
7866          * particularly special cases in split//. By having the regex compiler
7867          * do this pattern matching at a regop level (instead of by inspecting the pattern)
7868          * we avoid weird issues with equivalent patterns resulting in different behavior,
7869          * AND we allow non Perl engines to get the same optimizations by the setting the
7870          * flags appropriately - Yves */
7871         regnode *first = ri->program + 1;
7872         U8 fop = OP(first);
7873         regnode *next = regnext(first);
7874         U8 nop = OP(next);
7875
7876         if (PL_regkind[fop] == NOTHING && nop == END)
7877             r->extflags |= RXf_NULL;
7878         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
7879             /* when fop is SBOL first->flags will be true only when it was
7880              * produced by parsing /\A/, and not when parsing /^/. This is
7881              * very important for the split code as there we want to
7882              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
7883              * See rt #122761 for more details. -- Yves */
7884             r->extflags |= RXf_START_ONLY;
7885         else if (fop == PLUS
7886                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
7887                  && nop == END)
7888             r->extflags |= RXf_WHITE;
7889         else if ( r->extflags & RXf_SPLIT
7890                   && (fop == EXACT || fop == EXACTL)
7891                   && STR_LEN(first) == 1
7892                   && *(STRING(first)) == ' '
7893                   && nop == END )
7894             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
7895
7896     }
7897
7898     if (RExC_contains_locale) {
7899         RXp_EXTFLAGS(r) |= RXf_TAINTED;
7900     }
7901
7902 #ifdef DEBUGGING
7903     if (RExC_paren_names) {
7904         ri->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
7905         ri->data->data[ri->name_list_idx]
7906                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
7907     } else
7908 #endif
7909     ri->name_list_idx = 0;
7910
7911     while ( RExC_recurse_count > 0 ) {
7912         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
7913         /*
7914          * This data structure is set up in study_chunk() and is used
7915          * to calculate the distance between a GOSUB regopcode and
7916          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
7917          * it refers to.
7918          *
7919          * If for some reason someone writes code that optimises
7920          * away a GOSUB opcode then the assert should be changed to
7921          * an if(scan) to guard the ARG2L_SET() - Yves
7922          *
7923          */
7924         assert(scan && OP(scan) == GOSUB);
7925         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - scan );
7926     }
7927
7928     Newxz(r->offs, RExC_npar, regexp_paren_pair);
7929     /* assume we don't need to swap parens around before we match */
7930     DEBUG_TEST_r({
7931         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
7932             (unsigned long)RExC_study_chunk_recursed_count);
7933     });
7934     DEBUG_DUMP_r({
7935         DEBUG_RExC_seen();
7936         Perl_re_printf( aTHX_ "Final program:\n");
7937         regdump(r);
7938     });
7939 #ifdef RE_TRACK_PATTERN_OFFSETS
7940     DEBUG_OFFSETS_r(if (ri->u.offsets) {
7941         const STRLEN len = ri->u.offsets[0];
7942         STRLEN i;
7943         GET_RE_DEBUG_FLAGS_DECL;
7944         Perl_re_printf( aTHX_
7945                       "Offsets: [%" UVuf "]\n\t", (UV)ri->u.offsets[0]);
7946         for (i = 1; i <= len; i++) {
7947             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
7948                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7949                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
7950             }
7951         Perl_re_printf( aTHX_  "\n");
7952     });
7953 #endif
7954
7955 #ifdef USE_ITHREADS
7956     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
7957      * by setting the regexp SV to readonly-only instead. If the
7958      * pattern's been recompiled, the USEDness should remain. */
7959     if (old_re && SvREADONLY(old_re))
7960         SvREADONLY_on(rx);
7961 #endif
7962     return rx;
7963 }
7964
7965
7966 SV*
7967 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
7968                     const U32 flags)
7969 {
7970     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
7971
7972     PERL_UNUSED_ARG(value);
7973
7974     if (flags & RXapif_FETCH) {
7975         return reg_named_buff_fetch(rx, key, flags);
7976     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
7977         Perl_croak_no_modify();
7978         return NULL;
7979     } else if (flags & RXapif_EXISTS) {
7980         return reg_named_buff_exists(rx, key, flags)
7981             ? &PL_sv_yes
7982             : &PL_sv_no;
7983     } else if (flags & RXapif_REGNAMES) {
7984         return reg_named_buff_all(rx, flags);
7985     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
7986         return reg_named_buff_scalar(rx, flags);
7987     } else {
7988         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
7989         return NULL;
7990     }
7991 }
7992
7993 SV*
7994 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
7995                          const U32 flags)
7996 {
7997     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
7998     PERL_UNUSED_ARG(lastkey);
7999
8000     if (flags & RXapif_FIRSTKEY)
8001         return reg_named_buff_firstkey(rx, flags);
8002     else if (flags & RXapif_NEXTKEY)
8003         return reg_named_buff_nextkey(rx, flags);
8004     else {
8005         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
8006                                             (int)flags);
8007         return NULL;
8008     }
8009 }
8010
8011 SV*
8012 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
8013                           const U32 flags)
8014 {
8015     SV *ret;
8016     struct regexp *const rx = ReANY(r);
8017
8018     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
8019
8020     if (rx && RXp_PAREN_NAMES(rx)) {
8021         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
8022         if (he_str) {
8023             IV i;
8024             SV* sv_dat=HeVAL(he_str);
8025             I32 *nums=(I32*)SvPVX(sv_dat);
8026             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
8027             for ( i=0; i<SvIVX(sv_dat); i++ ) {
8028                 if ((I32)(rx->nparens) >= nums[i]
8029                     && rx->offs[nums[i]].start != -1
8030                     && rx->offs[nums[i]].end != -1)
8031                 {
8032                     ret = newSVpvs("");
8033                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
8034                     if (!retarray)
8035                         return ret;
8036                 } else {
8037                     if (retarray)
8038                         ret = newSVsv(&PL_sv_undef);
8039                 }
8040                 if (retarray)
8041                     av_push(retarray, ret);
8042             }
8043             if (retarray)
8044                 return newRV_noinc(MUTABLE_SV(retarray));
8045         }
8046     }
8047     return NULL;
8048 }
8049
8050 bool
8051 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
8052                            const U32 flags)
8053 {
8054     struct regexp *const rx = ReANY(r);
8055
8056     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
8057
8058     if (rx && RXp_PAREN_NAMES(rx)) {
8059         if (flags & RXapif_ALL) {
8060             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
8061         } else {
8062             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
8063             if (sv) {
8064                 SvREFCNT_dec_NN(sv);
8065                 return TRUE;
8066             } else {
8067                 return FALSE;
8068             }
8069         }
8070     } else {
8071         return FALSE;
8072     }
8073 }
8074
8075 SV*
8076 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8077 {
8078     struct regexp *const rx = ReANY(r);
8079
8080     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8081
8082     if ( rx && RXp_PAREN_NAMES(rx) ) {
8083         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8084
8085         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8086     } else {
8087         return FALSE;
8088     }
8089 }
8090
8091 SV*
8092 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8093 {
8094     struct regexp *const rx = ReANY(r);
8095     GET_RE_DEBUG_FLAGS_DECL;
8096
8097     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8098
8099     if (rx && RXp_PAREN_NAMES(rx)) {
8100         HV *hv = RXp_PAREN_NAMES(rx);
8101         HE *temphe;
8102         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8103             IV i;
8104             IV parno = 0;
8105             SV* sv_dat = HeVAL(temphe);
8106             I32 *nums = (I32*)SvPVX(sv_dat);
8107             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8108                 if ((I32)(rx->lastparen) >= nums[i] &&
8109                     rx->offs[nums[i]].start != -1 &&
8110                     rx->offs[nums[i]].end != -1)
8111                 {
8112                     parno = nums[i];
8113                     break;
8114                 }
8115             }
8116             if (parno || flags & RXapif_ALL) {
8117                 return newSVhek(HeKEY_hek(temphe));
8118             }
8119         }
8120     }
8121     return NULL;
8122 }
8123
8124 SV*
8125 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8126 {
8127     SV *ret;
8128     AV *av;
8129     SSize_t length;
8130     struct regexp *const rx = ReANY(r);
8131
8132     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8133
8134     if (rx && RXp_PAREN_NAMES(rx)) {
8135         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8136             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8137         } else if (flags & RXapif_ONE) {
8138             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8139             av = MUTABLE_AV(SvRV(ret));
8140             length = av_tindex(av);
8141             SvREFCNT_dec_NN(ret);
8142             return newSViv(length + 1);
8143         } else {
8144             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8145                                                 (int)flags);
8146             return NULL;
8147         }
8148     }
8149     return &PL_sv_undef;
8150 }
8151
8152 SV*
8153 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8154 {
8155     struct regexp *const rx = ReANY(r);
8156     AV *av = newAV();
8157
8158     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8159
8160     if (rx && RXp_PAREN_NAMES(rx)) {
8161         HV *hv= RXp_PAREN_NAMES(rx);
8162         HE *temphe;
8163         (void)hv_iterinit(hv);
8164         while ( (temphe = hv_iternext_flags(hv,0)) ) {
8165             IV i;
8166             IV parno = 0;
8167             SV* sv_dat = HeVAL(temphe);
8168             I32 *nums = (I32*)SvPVX(sv_dat);
8169             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8170                 if ((I32)(rx->lastparen) >= nums[i] &&
8171                     rx->offs[nums[i]].start != -1 &&
8172                     rx->offs[nums[i]].end != -1)
8173                 {
8174                     parno = nums[i];
8175                     break;
8176                 }
8177             }
8178             if (parno || flags & RXapif_ALL) {
8179                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8180             }
8181         }
8182     }
8183
8184     return newRV_noinc(MUTABLE_SV(av));
8185 }
8186
8187 void
8188 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8189                              SV * const sv)
8190 {
8191     struct regexp *const rx = ReANY(r);
8192     char *s = NULL;
8193     SSize_t i = 0;
8194     SSize_t s1, t1;
8195     I32 n = paren;
8196
8197     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8198
8199     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8200            || n == RX_BUFF_IDX_CARET_FULLMATCH
8201            || n == RX_BUFF_IDX_CARET_POSTMATCH
8202        )
8203     {
8204         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8205         if (!keepcopy) {
8206             /* on something like
8207              *    $r = qr/.../;
8208              *    /$qr/p;
8209              * the KEEPCOPY is set on the PMOP rather than the regex */
8210             if (PL_curpm && r == PM_GETRE(PL_curpm))
8211                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8212         }
8213         if (!keepcopy)
8214             goto ret_undef;
8215     }
8216
8217     if (!rx->subbeg)
8218         goto ret_undef;
8219
8220     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8221         /* no need to distinguish between them any more */
8222         n = RX_BUFF_IDX_FULLMATCH;
8223
8224     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8225         && rx->offs[0].start != -1)
8226     {
8227         /* $`, ${^PREMATCH} */
8228         i = rx->offs[0].start;
8229         s = rx->subbeg;
8230     }
8231     else
8232     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8233         && rx->offs[0].end != -1)
8234     {
8235         /* $', ${^POSTMATCH} */
8236         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8237         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8238     }
8239     else
8240     if ( 0 <= n && n <= (I32)rx->nparens &&
8241         (s1 = rx->offs[n].start) != -1 &&
8242         (t1 = rx->offs[n].end) != -1)
8243     {
8244         /* $&, ${^MATCH},  $1 ... */
8245         i = t1 - s1;
8246         s = rx->subbeg + s1 - rx->suboffset;
8247     } else {
8248         goto ret_undef;
8249     }
8250
8251     assert(s >= rx->subbeg);
8252     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8253     if (i >= 0) {
8254 #ifdef NO_TAINT_SUPPORT
8255         sv_setpvn(sv, s, i);
8256 #else
8257         const int oldtainted = TAINT_get;
8258         TAINT_NOT;
8259         sv_setpvn(sv, s, i);
8260         TAINT_set(oldtainted);
8261 #endif
8262         if (RXp_MATCH_UTF8(rx))
8263             SvUTF8_on(sv);
8264         else
8265             SvUTF8_off(sv);
8266         if (TAINTING_get) {
8267             if (RXp_MATCH_TAINTED(rx)) {
8268                 if (SvTYPE(sv) >= SVt_PVMG) {
8269                     MAGIC* const mg = SvMAGIC(sv);
8270                     MAGIC* mgt;
8271                     TAINT;
8272                     SvMAGIC_set(sv, mg->mg_moremagic);
8273                     SvTAINT(sv);
8274                     if ((mgt = SvMAGIC(sv))) {
8275                         mg->mg_moremagic = mgt;
8276                         SvMAGIC_set(sv, mg);
8277                     }
8278                 } else {
8279                     TAINT;
8280                     SvTAINT(sv);
8281                 }
8282             } else
8283                 SvTAINTED_off(sv);
8284         }
8285     } else {
8286       ret_undef:
8287         sv_set_undef(sv);
8288         return;
8289     }
8290 }
8291
8292 void
8293 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8294                                                          SV const * const value)
8295 {
8296     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8297
8298     PERL_UNUSED_ARG(rx);
8299     PERL_UNUSED_ARG(paren);
8300     PERL_UNUSED_ARG(value);
8301
8302     if (!PL_localizing)
8303         Perl_croak_no_modify();
8304 }
8305
8306 I32
8307 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8308                               const I32 paren)
8309 {
8310     struct regexp *const rx = ReANY(r);
8311     I32 i;
8312     I32 s1, t1;
8313
8314     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8315
8316     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8317         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8318         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8319     )
8320     {
8321         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8322         if (!keepcopy) {
8323             /* on something like
8324              *    $r = qr/.../;
8325              *    /$qr/p;
8326              * the KEEPCOPY is set on the PMOP rather than the regex */
8327             if (PL_curpm && r == PM_GETRE(PL_curpm))
8328                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8329         }
8330         if (!keepcopy)
8331             goto warn_undef;
8332     }
8333
8334     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8335     switch (paren) {
8336       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8337       case RX_BUFF_IDX_PREMATCH:       /* $` */
8338         if (rx->offs[0].start != -1) {
8339                         i = rx->offs[0].start;
8340                         if (i > 0) {
8341                                 s1 = 0;
8342                                 t1 = i;
8343                                 goto getlen;
8344                         }
8345             }
8346         return 0;
8347
8348       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8349       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8350             if (rx->offs[0].end != -1) {
8351                         i = rx->sublen - rx->offs[0].end;
8352                         if (i > 0) {
8353                                 s1 = rx->offs[0].end;
8354                                 t1 = rx->sublen;
8355                                 goto getlen;
8356                         }
8357             }
8358         return 0;
8359
8360       default: /* $& / ${^MATCH}, $1, $2, ... */
8361             if (paren <= (I32)rx->nparens &&
8362             (s1 = rx->offs[paren].start) != -1 &&
8363             (t1 = rx->offs[paren].end) != -1)
8364             {
8365             i = t1 - s1;
8366             goto getlen;
8367         } else {
8368           warn_undef:
8369             if (ckWARN(WARN_UNINITIALIZED))
8370                 report_uninit((const SV *)sv);
8371             return 0;
8372         }
8373     }
8374   getlen:
8375     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8376         const char * const s = rx->subbeg - rx->suboffset + s1;
8377         const U8 *ep;
8378         STRLEN el;
8379
8380         i = t1 - s1;
8381         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8382                         i = el;
8383     }
8384     return i;
8385 }
8386
8387 SV*
8388 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8389 {
8390     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8391         PERL_UNUSED_ARG(rx);
8392         if (0)
8393             return NULL;
8394         else
8395             return newSVpvs("Regexp");
8396 }
8397
8398 /* Scans the name of a named buffer from the pattern.
8399  * If flags is REG_RSN_RETURN_NULL returns null.
8400  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8401  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8402  * to the parsed name as looked up in the RExC_paren_names hash.
8403  * If there is an error throws a vFAIL().. type exception.
8404  */
8405
8406 #define REG_RSN_RETURN_NULL    0
8407 #define REG_RSN_RETURN_NAME    1
8408 #define REG_RSN_RETURN_DATA    2
8409
8410 STATIC SV*
8411 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8412 {
8413     char *name_start = RExC_parse;
8414
8415     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8416
8417     assert (RExC_parse <= RExC_end);
8418     if (RExC_parse == RExC_end) NOOP;
8419     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8420          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8421           * using do...while */
8422         if (UTF)
8423             do {
8424                 RExC_parse += UTF8SKIP(RExC_parse);
8425             } while (   RExC_parse < RExC_end
8426                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
8427         else
8428             do {
8429                 RExC_parse++;
8430             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
8431     } else {
8432         RExC_parse++; /* so the <- from the vFAIL is after the offending
8433                          character */
8434         vFAIL("Group name must start with a non-digit word character");
8435     }
8436     if ( flags ) {
8437         SV* sv_name
8438             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
8439                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
8440         if ( flags == REG_RSN_RETURN_NAME)
8441             return sv_name;
8442         else if (flags==REG_RSN_RETURN_DATA) {
8443             HE *he_str = NULL;
8444             SV *sv_dat = NULL;
8445             if ( ! sv_name )      /* should not happen*/
8446                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
8447             if (RExC_paren_names)
8448                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
8449             if ( he_str )
8450                 sv_dat = HeVAL(he_str);
8451             if ( ! sv_dat )
8452                 vFAIL("Reference to nonexistent named group");
8453             return sv_dat;
8454         }
8455         else {
8456             Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
8457                        (unsigned long) flags);
8458         }
8459         NOT_REACHED; /* NOTREACHED */
8460     }
8461     return NULL;
8462 }
8463
8464 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
8465     int num;                                                    \
8466     if (RExC_lastparse!=RExC_parse) {                           \
8467         Perl_re_printf( aTHX_  "%s",                                        \
8468             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
8469                 RExC_end - RExC_parse, 16,                      \
8470                 "", "",                                         \
8471                 PERL_PV_ESCAPE_UNI_DETECT |                     \
8472                 PERL_PV_PRETTY_ELLIPSES   |                     \
8473                 PERL_PV_PRETTY_LTGT       |                     \
8474                 PERL_PV_ESCAPE_RE         |                     \
8475                 PERL_PV_PRETTY_EXACTSIZE                        \
8476             )                                                   \
8477         );                                                      \
8478     } else                                                      \
8479         Perl_re_printf( aTHX_ "%16s","");                                   \
8480                                                                 \
8481     if (SIZE_ONLY)                                              \
8482        num = RExC_size + 1;                                     \
8483     else                                                        \
8484        num=REG_NODE_NUM(RExC_emit);                             \
8485     if (RExC_lastnum!=num)                                      \
8486        Perl_re_printf( aTHX_ "|%4d",num);                                   \
8487     else                                                        \
8488        Perl_re_printf( aTHX_ "|%4s","");                                    \
8489     Perl_re_printf( aTHX_ "|%*s%-4s",                                       \
8490         (int)((depth*2)), "",                                   \
8491         (funcname)                                              \
8492     );                                                          \
8493     RExC_lastnum=num;                                           \
8494     RExC_lastparse=RExC_parse;                                  \
8495 })
8496
8497
8498
8499 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
8500     DEBUG_PARSE_MSG((funcname));                            \
8501     Perl_re_printf( aTHX_ "%4s","\n");                                  \
8502 })
8503 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
8504     DEBUG_PARSE_MSG((funcname));                            \
8505     Perl_re_printf( aTHX_ fmt "\n",args);                               \
8506 })
8507
8508 /* This section of code defines the inversion list object and its methods.  The
8509  * interfaces are highly subject to change, so as much as possible is static to
8510  * this file.  An inversion list is here implemented as a malloc'd C UV array
8511  * as an SVt_INVLIST scalar.
8512  *
8513  * An inversion list for Unicode is an array of code points, sorted by ordinal
8514  * number.  Each element gives the code point that begins a range that extends
8515  * up-to but not including the code point given by the next element.  The final
8516  * element gives the first code point of a range that extends to the platform's
8517  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
8518  * ...) give ranges whose code points are all in the inversion list.  We say
8519  * that those ranges are in the set.  The odd-numbered elements give ranges
8520  * whose code points are not in the inversion list, and hence not in the set.
8521  * Thus, element [0] is the first code point in the list.  Element [1]
8522  * is the first code point beyond that not in the list; and element [2] is the
8523  * first code point beyond that that is in the list.  In other words, the first
8524  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
8525  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
8526  * all code points in that range are not in the inversion list.  The third
8527  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
8528  * list, and so forth.  Thus every element whose index is divisible by two
8529  * gives the beginning of a range that is in the list, and every element whose
8530  * index is not divisible by two gives the beginning of a range not in the
8531  * list.  If the final element's index is divisible by two, the inversion list
8532  * extends to the platform's infinity; otherwise the highest code point in the
8533  * inversion list is the contents of that element minus 1.
8534  *
8535  * A range that contains just a single code point N will look like
8536  *  invlist[i]   == N
8537  *  invlist[i+1] == N+1
8538  *
8539  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
8540  * impossible to represent, so element [i+1] is omitted.  The single element
8541  * inversion list
8542  *  invlist[0] == UV_MAX
8543  * contains just UV_MAX, but is interpreted as matching to infinity.
8544  *
8545  * Taking the complement (inverting) an inversion list is quite simple, if the
8546  * first element is 0, remove it; otherwise add a 0 element at the beginning.
8547  * This implementation reserves an element at the beginning of each inversion
8548  * list to always contain 0; there is an additional flag in the header which
8549  * indicates if the list begins at the 0, or is offset to begin at the next
8550  * element.  This means that the inversion list can be inverted without any
8551  * copying; just flip the flag.
8552  *
8553  * More about inversion lists can be found in "Unicode Demystified"
8554  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
8555  *
8556  * The inversion list data structure is currently implemented as an SV pointing
8557  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
8558  * array of UV whose memory management is automatically handled by the existing
8559  * facilities for SV's.
8560  *
8561  * Some of the methods should always be private to the implementation, and some
8562  * should eventually be made public */
8563
8564 /* The header definitions are in F<invlist_inline.h> */
8565
8566 #ifndef PERL_IN_XSUB_RE
8567
8568 PERL_STATIC_INLINE UV*
8569 S__invlist_array_init(SV* const invlist, const bool will_have_0)
8570 {
8571     /* Returns a pointer to the first element in the inversion list's array.
8572      * This is called upon initialization of an inversion list.  Where the
8573      * array begins depends on whether the list has the code point U+0000 in it
8574      * or not.  The other parameter tells it whether the code that follows this
8575      * call is about to put a 0 in the inversion list or not.  The first
8576      * element is either the element reserved for 0, if TRUE, or the element
8577      * after it, if FALSE */
8578
8579     bool* offset = get_invlist_offset_addr(invlist);
8580     UV* zero_addr = (UV *) SvPVX(invlist);
8581
8582     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
8583
8584     /* Must be empty */
8585     assert(! _invlist_len(invlist));
8586
8587     *zero_addr = 0;
8588
8589     /* 1^1 = 0; 1^0 = 1 */
8590     *offset = 1 ^ will_have_0;
8591     return zero_addr + *offset;
8592 }
8593
8594 #endif
8595
8596 PERL_STATIC_INLINE void
8597 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8598 {
8599     /* Sets the current number of elements stored in the inversion list.
8600      * Updates SvCUR correspondingly */
8601     PERL_UNUSED_CONTEXT;
8602     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8603
8604     assert(SvTYPE(invlist) == SVt_INVLIST);
8605
8606     SvCUR_set(invlist,
8607               (len == 0)
8608                ? 0
8609                : TO_INTERNAL_SIZE(len + offset));
8610     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8611 }
8612
8613 #ifndef PERL_IN_XSUB_RE
8614
8615 STATIC void
8616 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
8617 {
8618     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
8619      * steals the list from 'src', so 'src' is made to have a NULL list.  This
8620      * is similar to what SvSetMagicSV() would do, if it were implemented on
8621      * inversion lists, though this routine avoids a copy */
8622
8623     const UV src_len          = _invlist_len(src);
8624     const bool src_offset     = *get_invlist_offset_addr(src);
8625     const STRLEN src_byte_len = SvLEN(src);
8626     char * array              = SvPVX(src);
8627
8628     const int oldtainted = TAINT_get;
8629
8630     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
8631
8632     assert(SvTYPE(src) == SVt_INVLIST);
8633     assert(SvTYPE(dest) == SVt_INVLIST);
8634     assert(! invlist_is_iterating(src));
8635     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
8636
8637     /* Make sure it ends in the right place with a NUL, as our inversion list
8638      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
8639      * asserts it */
8640     array[src_byte_len - 1] = '\0';
8641
8642     TAINT_NOT;      /* Otherwise it breaks */
8643     sv_usepvn_flags(dest,
8644                     (char *) array,
8645                     src_byte_len - 1,
8646
8647                     /* This flag is documented to cause a copy to be avoided */
8648                     SV_HAS_TRAILING_NUL);
8649     TAINT_set(oldtainted);
8650     SvPV_set(src, 0);
8651     SvLEN_set(src, 0);
8652     SvCUR_set(src, 0);
8653
8654     /* Finish up copying over the other fields in an inversion list */
8655     *get_invlist_offset_addr(dest) = src_offset;
8656     invlist_set_len(dest, src_len, src_offset);
8657     *get_invlist_previous_index_addr(dest) = 0;
8658     invlist_iterfinish(dest);
8659 }
8660
8661 PERL_STATIC_INLINE IV*
8662 S_get_invlist_previous_index_addr(SV* invlist)
8663 {
8664     /* Return the address of the IV that is reserved to hold the cached index
8665      * */
8666     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8667
8668     assert(SvTYPE(invlist) == SVt_INVLIST);
8669
8670     return &(((XINVLIST*) SvANY(invlist))->prev_index);
8671 }
8672
8673 PERL_STATIC_INLINE IV
8674 S_invlist_previous_index(SV* const invlist)
8675 {
8676     /* Returns cached index of previous search */
8677
8678     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8679
8680     return *get_invlist_previous_index_addr(invlist);
8681 }
8682
8683 PERL_STATIC_INLINE void
8684 S_invlist_set_previous_index(SV* const invlist, const IV index)
8685 {
8686     /* Caches <index> for later retrieval */
8687
8688     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8689
8690     assert(index == 0 || index < (int) _invlist_len(invlist));
8691
8692     *get_invlist_previous_index_addr(invlist) = index;
8693 }
8694
8695 PERL_STATIC_INLINE void
8696 S_invlist_trim(SV* invlist)
8697 {
8698     /* Free the not currently-being-used space in an inversion list */
8699
8700     /* But don't free up the space needed for the 0 UV that is always at the
8701      * beginning of the list, nor the trailing NUL */
8702     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
8703
8704     PERL_ARGS_ASSERT_INVLIST_TRIM;
8705
8706     assert(SvTYPE(invlist) == SVt_INVLIST);
8707
8708     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
8709 }
8710
8711 PERL_STATIC_INLINE void
8712 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
8713 {
8714     PERL_ARGS_ASSERT_INVLIST_CLEAR;
8715
8716     assert(SvTYPE(invlist) == SVt_INVLIST);
8717
8718     invlist_set_len(invlist, 0, 0);
8719     invlist_trim(invlist);
8720 }
8721
8722 #endif /* ifndef PERL_IN_XSUB_RE */
8723
8724 PERL_STATIC_INLINE bool
8725 S_invlist_is_iterating(SV* const invlist)
8726 {
8727     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8728
8729     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8730 }
8731
8732 #ifndef PERL_IN_XSUB_RE
8733
8734 PERL_STATIC_INLINE UV
8735 S_invlist_max(SV* const invlist)
8736 {
8737     /* Returns the maximum number of elements storable in the inversion list's
8738      * array, without having to realloc() */
8739
8740     PERL_ARGS_ASSERT_INVLIST_MAX;
8741
8742     assert(SvTYPE(invlist) == SVt_INVLIST);
8743
8744     /* Assumes worst case, in which the 0 element is not counted in the
8745      * inversion list, so subtracts 1 for that */
8746     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8747            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8748            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8749 }
8750 SV*
8751 Perl__new_invlist(pTHX_ IV initial_size)
8752 {
8753
8754     /* Return a pointer to a newly constructed inversion list, with enough
8755      * space to store 'initial_size' elements.  If that number is negative, a
8756      * system default is used instead */
8757
8758     SV* new_list;
8759
8760     if (initial_size < 0) {
8761         initial_size = 10;
8762     }
8763
8764     /* Allocate the initial space */
8765     new_list = newSV_type(SVt_INVLIST);
8766
8767     /* First 1 is in case the zero element isn't in the list; second 1 is for
8768      * trailing NUL */
8769     SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8770     invlist_set_len(new_list, 0, 0);
8771
8772     /* Force iterinit() to be used to get iteration to work */
8773     *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
8774
8775     *get_invlist_previous_index_addr(new_list) = 0;
8776
8777     return new_list;
8778 }
8779
8780 SV*
8781 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8782 {
8783     /* Return a pointer to a newly constructed inversion list, initialized to
8784      * point to <list>, which has to be in the exact correct inversion list
8785      * form, including internal fields.  Thus this is a dangerous routine that
8786      * should not be used in the wrong hands.  The passed in 'list' contains
8787      * several header fields at the beginning that are not part of the
8788      * inversion list body proper */
8789
8790     const STRLEN length = (STRLEN) list[0];
8791     const UV version_id =          list[1];
8792     const bool offset   =    cBOOL(list[2]);
8793 #define HEADER_LENGTH 3
8794     /* If any of the above changes in any way, you must change HEADER_LENGTH
8795      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8796      *      perl -E 'say int(rand 2**31-1)'
8797      */
8798 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8799                                         data structure type, so that one being
8800                                         passed in can be validated to be an
8801                                         inversion list of the correct vintage.
8802                                        */
8803
8804     SV* invlist = newSV_type(SVt_INVLIST);
8805
8806     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8807
8808     if (version_id != INVLIST_VERSION_ID) {
8809         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8810     }
8811
8812     /* The generated array passed in includes header elements that aren't part
8813      * of the list proper, so start it just after them */
8814     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8815
8816     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8817                                shouldn't touch it */
8818
8819     *(get_invlist_offset_addr(invlist)) = offset;
8820
8821     /* The 'length' passed to us is the physical number of elements in the
8822      * inversion list.  But if there is an offset the logical number is one
8823      * less than that */
8824     invlist_set_len(invlist, length  - offset, offset);
8825
8826     invlist_set_previous_index(invlist, 0);
8827
8828     /* Initialize the iteration pointer. */
8829     invlist_iterfinish(invlist);
8830
8831     SvREADONLY_on(invlist);
8832
8833     return invlist;
8834 }
8835
8836 STATIC void
8837 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8838 {
8839     /* Grow the maximum size of an inversion list */
8840
8841     PERL_ARGS_ASSERT_INVLIST_EXTEND;
8842
8843     assert(SvTYPE(invlist) == SVt_INVLIST);
8844
8845     /* Add one to account for the zero element at the beginning which may not
8846      * be counted by the calling parameters */
8847     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8848 }
8849
8850 STATIC void
8851 S__append_range_to_invlist(pTHX_ SV* const invlist,
8852                                  const UV start, const UV end)
8853 {
8854    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8855     * the end of the inversion list.  The range must be above any existing
8856     * ones. */
8857
8858     UV* array;
8859     UV max = invlist_max(invlist);
8860     UV len = _invlist_len(invlist);
8861     bool offset;
8862
8863     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8864
8865     if (len == 0) { /* Empty lists must be initialized */
8866         offset = start != 0;
8867         array = _invlist_array_init(invlist, ! offset);
8868     }
8869     else {
8870         /* Here, the existing list is non-empty. The current max entry in the
8871          * list is generally the first value not in the set, except when the
8872          * set extends to the end of permissible values, in which case it is
8873          * the first entry in that final set, and so this call is an attempt to
8874          * append out-of-order */
8875
8876         UV final_element = len - 1;
8877         array = invlist_array(invlist);
8878         if (   array[final_element] > start
8879             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8880         {
8881             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",
8882                      array[final_element], start,
8883                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8884         }
8885
8886         /* Here, it is a legal append.  If the new range begins 1 above the end
8887          * of the range below it, it is extending the range below it, so the
8888          * new first value not in the set is one greater than the newly
8889          * extended range.  */
8890         offset = *get_invlist_offset_addr(invlist);
8891         if (array[final_element] == start) {
8892             if (end != UV_MAX) {
8893                 array[final_element] = end + 1;
8894             }
8895             else {
8896                 /* But if the end is the maximum representable on the machine,
8897                  * assume that infinity was actually what was meant.  Just let
8898                  * the range that this would extend to have no end */
8899                 invlist_set_len(invlist, len - 1, offset);
8900             }
8901             return;
8902         }
8903     }
8904
8905     /* Here the new range doesn't extend any existing set.  Add it */
8906
8907     len += 2;   /* Includes an element each for the start and end of range */
8908
8909     /* If wll overflow the existing space, extend, which may cause the array to
8910      * be moved */
8911     if (max < len) {
8912         invlist_extend(invlist, len);
8913
8914         /* Have to set len here to avoid assert failure in invlist_array() */
8915         invlist_set_len(invlist, len, offset);
8916
8917         array = invlist_array(invlist);
8918     }
8919     else {
8920         invlist_set_len(invlist, len, offset);
8921     }
8922
8923     /* The next item on the list starts the range, the one after that is
8924      * one past the new range.  */
8925     array[len - 2] = start;
8926     if (end != UV_MAX) {
8927         array[len - 1] = end + 1;
8928     }
8929     else {
8930         /* But if the end is the maximum representable on the machine, just let
8931          * the range have no end */
8932         invlist_set_len(invlist, len - 1, offset);
8933     }
8934 }
8935
8936 SSize_t
8937 Perl__invlist_search(SV* const invlist, const UV cp)
8938 {
8939     /* Searches the inversion list for the entry that contains the input code
8940      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8941      * return value is the index into the list's array of the range that
8942      * contains <cp>, that is, 'i' such that
8943      *  array[i] <= cp < array[i+1]
8944      */
8945
8946     IV low = 0;
8947     IV mid;
8948     IV high = _invlist_len(invlist);
8949     const IV highest_element = high - 1;
8950     const UV* array;
8951
8952     PERL_ARGS_ASSERT__INVLIST_SEARCH;
8953
8954     /* If list is empty, return failure. */
8955     if (high == 0) {
8956         return -1;
8957     }
8958
8959     /* (We can't get the array unless we know the list is non-empty) */
8960     array = invlist_array(invlist);
8961
8962     mid = invlist_previous_index(invlist);
8963     assert(mid >=0);
8964     if (mid > highest_element) {
8965         mid = highest_element;
8966     }
8967
8968     /* <mid> contains the cache of the result of the previous call to this
8969      * function (0 the first time).  See if this call is for the same result,
8970      * or if it is for mid-1.  This is under the theory that calls to this
8971      * function will often be for related code points that are near each other.
8972      * And benchmarks show that caching gives better results.  We also test
8973      * here if the code point is within the bounds of the list.  These tests
8974      * replace others that would have had to be made anyway to make sure that
8975      * the array bounds were not exceeded, and these give us extra information
8976      * at the same time */
8977     if (cp >= array[mid]) {
8978         if (cp >= array[highest_element]) {
8979             return highest_element;
8980         }
8981
8982         /* Here, array[mid] <= cp < array[highest_element].  This means that
8983          * the final element is not the answer, so can exclude it; it also
8984          * means that <mid> is not the final element, so can refer to 'mid + 1'
8985          * safely */
8986         if (cp < array[mid + 1]) {
8987             return mid;
8988         }
8989         high--;
8990         low = mid + 1;
8991     }
8992     else { /* cp < aray[mid] */
8993         if (cp < array[0]) { /* Fail if outside the array */
8994             return -1;
8995         }
8996         high = mid;
8997         if (cp >= array[mid - 1]) {
8998             goto found_entry;
8999         }
9000     }
9001
9002     /* Binary search.  What we are looking for is <i> such that
9003      *  array[i] <= cp < array[i+1]
9004      * The loop below converges on the i+1.  Note that there may not be an
9005      * (i+1)th element in the array, and things work nonetheless */
9006     while (low < high) {
9007         mid = (low + high) / 2;
9008         assert(mid <= highest_element);
9009         if (array[mid] <= cp) { /* cp >= array[mid] */
9010             low = mid + 1;
9011
9012             /* We could do this extra test to exit the loop early.
9013             if (cp < array[low]) {
9014                 return mid;
9015             }
9016             */
9017         }
9018         else { /* cp < array[mid] */
9019             high = mid;
9020         }
9021     }
9022
9023   found_entry:
9024     high--;
9025     invlist_set_previous_index(invlist, high);
9026     return high;
9027 }
9028
9029 void
9030 Perl__invlist_populate_swatch(SV* const invlist,
9031                               const UV start, const UV end, U8* swatch)
9032 {
9033     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
9034      * but is used when the swash has an inversion list.  This makes this much
9035      * faster, as it uses a binary search instead of a linear one.  This is
9036      * intimately tied to that function, and perhaps should be in utf8.c,
9037      * except it is intimately tied to inversion lists as well.  It assumes
9038      * that <swatch> is all 0's on input */
9039
9040     UV current = start;
9041     const IV len = _invlist_len(invlist);
9042     IV i;
9043     const UV * array;
9044
9045     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
9046
9047     if (len == 0) { /* Empty inversion list */
9048         return;
9049     }
9050
9051     array = invlist_array(invlist);
9052
9053     /* Find which element it is */
9054     i = _invlist_search(invlist, start);
9055
9056     /* We populate from <start> to <end> */
9057     while (current < end) {
9058         UV upper;
9059
9060         /* The inversion list gives the results for every possible code point
9061          * after the first one in the list.  Only those ranges whose index is
9062          * even are ones that the inversion list matches.  For the odd ones,
9063          * and if the initial code point is not in the list, we have to skip
9064          * forward to the next element */
9065         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
9066             i++;
9067             if (i >= len) { /* Finished if beyond the end of the array */
9068                 return;
9069             }
9070             current = array[i];
9071             if (current >= end) {   /* Finished if beyond the end of what we
9072                                        are populating */
9073                 if (LIKELY(end < UV_MAX)) {
9074                     return;
9075                 }
9076
9077                 /* We get here when the upper bound is the maximum
9078                  * representable on the machine, and we are looking for just
9079                  * that code point.  Have to special case it */
9080                 i = len;
9081                 goto join_end_of_list;
9082             }
9083         }
9084         assert(current >= start);
9085
9086         /* The current range ends one below the next one, except don't go past
9087          * <end> */
9088         i++;
9089         upper = (i < len && array[i] < end) ? array[i] : end;
9090
9091         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
9092          * for each code point in it */
9093         for (; current < upper; current++) {
9094             const STRLEN offset = (STRLEN)(current - start);
9095             swatch[offset >> 3] |= 1 << (offset & 7);
9096         }
9097
9098       join_end_of_list:
9099
9100         /* Quit if at the end of the list */
9101         if (i >= len) {
9102
9103             /* But first, have to deal with the highest possible code point on
9104              * the platform.  The previous code assumes that <end> is one
9105              * beyond where we want to populate, but that is impossible at the
9106              * platform's infinity, so have to handle it specially */
9107             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
9108             {
9109                 const STRLEN offset = (STRLEN)(end - start);
9110                 swatch[offset >> 3] |= 1 << (offset & 7);
9111             }
9112             return;
9113         }
9114
9115         /* Advance to the next range, which will be for code points not in the
9116          * inversion list */
9117         current = array[i];
9118     }
9119
9120     return;
9121 }
9122
9123 void
9124 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9125                                          const bool complement_b, SV** output)
9126 {
9127     /* Take the union of two inversion lists and point '*output' to it.  On
9128      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9129      * even 'a' or 'b').  If to an inversion list, the contents of the original
9130      * list will be replaced by the union.  The first list, 'a', may be
9131      * NULL, in which case a copy of the second list is placed in '*output'.
9132      * If 'complement_b' is TRUE, the union is taken of the complement
9133      * (inversion) of 'b' instead of b itself.
9134      *
9135      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9136      * Richard Gillam, published by Addison-Wesley, and explained at some
9137      * length there.  The preface says to incorporate its examples into your
9138      * code at your own risk.
9139      *
9140      * The algorithm is like a merge sort. */
9141
9142     const UV* array_a;    /* a's array */
9143     const UV* array_b;
9144     UV len_a;       /* length of a's array */
9145     UV len_b;
9146
9147     SV* u;                      /* the resulting union */
9148     UV* array_u;
9149     UV len_u = 0;
9150
9151     UV i_a = 0;             /* current index into a's array */
9152     UV i_b = 0;
9153     UV i_u = 0;
9154
9155     /* running count, as explained in the algorithm source book; items are
9156      * stopped accumulating and are output when the count changes to/from 0.
9157      * The count is incremented when we start a range that's in an input's set,
9158      * and decremented when we start a range that's not in a set.  So this
9159      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9160      * and hence nothing goes into the union; 1, just one of the inputs is in
9161      * its set (and its current range gets added to the union); and 2 when both
9162      * inputs are in their sets.  */
9163     UV count = 0;
9164
9165     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9166     assert(a != b);
9167     assert(*output == NULL || SvTYPE(*output) == SVt_INVLIST);
9168
9169     len_b = _invlist_len(b);
9170     if (len_b == 0) {
9171
9172         /* Here, 'b' is empty, hence it's complement is all possible code
9173          * points.  So if the union includes the complement of 'b', it includes
9174          * everything, and we need not even look at 'a'.  It's easiest to
9175          * create a new inversion list that matches everything.  */
9176         if (complement_b) {
9177             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9178
9179             if (*output == NULL) { /* If the output didn't exist, just point it
9180                                       at the new list */
9181                 *output = everything;
9182             }
9183             else { /* Otherwise, replace its contents with the new list */
9184                 invlist_replace_list_destroys_src(*output, everything);
9185                 SvREFCNT_dec_NN(everything);
9186             }
9187
9188             return;
9189         }
9190
9191         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9192          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9193          * output will be empty */
9194
9195         if (a == NULL || _invlist_len(a) == 0) {
9196             if (*output == NULL) {
9197                 *output = _new_invlist(0);
9198             }
9199             else {
9200                 invlist_clear(*output);
9201             }
9202             return;
9203         }
9204
9205         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9206          * union.  We can just return a copy of 'a' if '*output' doesn't point
9207          * to an existing list */
9208         if (*output == NULL) {
9209             *output = invlist_clone(a);
9210             return;
9211         }
9212
9213         /* If the output is to overwrite 'a', we have a no-op, as it's
9214          * already in 'a' */
9215         if (*output == a) {
9216             return;
9217         }
9218
9219         /* Here, '*output' is to be overwritten by 'a' */
9220         u = invlist_clone(a);
9221         invlist_replace_list_destroys_src(*output, u);
9222         SvREFCNT_dec_NN(u);
9223
9224         return;
9225     }
9226
9227     /* Here 'b' is not empty.  See about 'a' */
9228
9229     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9230
9231         /* Here, 'a' is empty (and b is not).  That means the union will come
9232          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9233          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9234          * the clone */
9235
9236         SV ** dest = (*output == NULL) ? output : &u;
9237         *dest = invlist_clone(b);
9238         if (complement_b) {
9239             _invlist_invert(*dest);
9240         }
9241
9242         if (dest == &u) {
9243             invlist_replace_list_destroys_src(*output, u);
9244             SvREFCNT_dec_NN(u);
9245         }
9246
9247         return;
9248     }
9249
9250     /* Here both lists exist and are non-empty */
9251     array_a = invlist_array(a);
9252     array_b = invlist_array(b);
9253
9254     /* If are to take the union of 'a' with the complement of b, set it
9255      * up so are looking at b's complement. */
9256     if (complement_b) {
9257
9258         /* To complement, we invert: if the first element is 0, remove it.  To
9259          * do this, we just pretend the array starts one later */
9260         if (array_b[0] == 0) {
9261             array_b++;
9262             len_b--;
9263         }
9264         else {
9265
9266             /* But if the first element is not zero, we pretend the list starts
9267              * at the 0 that is always stored immediately before the array. */
9268             array_b--;
9269             len_b++;
9270         }
9271     }
9272
9273     /* Size the union for the worst case: that the sets are completely
9274      * disjoint */
9275     u = _new_invlist(len_a + len_b);
9276
9277     /* Will contain U+0000 if either component does */
9278     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9279                                       || (len_b > 0 && array_b[0] == 0));
9280
9281     /* Go through each input list item by item, stopping when have exhausted
9282      * one of them */
9283     while (i_a < len_a && i_b < len_b) {
9284         UV cp;      /* The element to potentially add to the union's array */
9285         bool cp_in_set;   /* is it in the the input list's set or not */
9286
9287         /* We need to take one or the other of the two inputs for the union.
9288          * Since we are merging two sorted lists, we take the smaller of the
9289          * next items.  In case of a tie, we take first the one that is in its
9290          * set.  If we first took the one not in its set, it would decrement
9291          * the count, possibly to 0 which would cause it to be output as ending
9292          * the range, and the next time through we would take the same number,
9293          * and output it again as beginning the next range.  By doing it the
9294          * opposite way, there is no possibility that the count will be
9295          * momentarily decremented to 0, and thus the two adjoining ranges will
9296          * be seamlessly merged.  (In a tie and both are in the set or both not
9297          * in the set, it doesn't matter which we take first.) */
9298         if (       array_a[i_a] < array_b[i_b]
9299             || (   array_a[i_a] == array_b[i_b]
9300                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9301         {
9302             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9303             cp = array_a[i_a++];
9304         }
9305         else {
9306             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9307             cp = array_b[i_b++];
9308         }
9309
9310         /* Here, have chosen which of the two inputs to look at.  Only output
9311          * if the running count changes to/from 0, which marks the
9312          * beginning/end of a range that's in the set */
9313         if (cp_in_set) {
9314             if (count == 0) {
9315                 array_u[i_u++] = cp;
9316             }
9317             count++;
9318         }
9319         else {
9320             count--;
9321             if (count == 0) {
9322                 array_u[i_u++] = cp;
9323             }
9324         }
9325     }
9326
9327
9328     /* The loop above increments the index into exactly one of the input lists
9329      * each iteration, and ends when either index gets to its list end.  That
9330      * means the other index is lower than its end, and so something is
9331      * remaining in that one.  We decrement 'count', as explained below, if
9332      * that list is in its set.  (i_a and i_b each currently index the element
9333      * beyond the one we care about.) */
9334     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9335         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9336     {
9337         count--;
9338     }
9339
9340     /* Above we decremented 'count' if the list that had unexamined elements in
9341      * it was in its set.  This has made it so that 'count' being non-zero
9342      * means there isn't anything left to output; and 'count' equal to 0 means
9343      * that what is left to output is precisely that which is left in the
9344      * non-exhausted input list.
9345      *
9346      * To see why, note first that the exhausted input obviously has nothing
9347      * left to add to the union.  If it was in its set at its end, that means
9348      * the set extends from here to the platform's infinity, and hence so does
9349      * the union and the non-exhausted set is irrelevant.  The exhausted set
9350      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9351      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9352      * 'count' remains at 1.  This is consistent with the decremented 'count'
9353      * != 0 meaning there's nothing left to add to the union.
9354      *
9355      * But if the exhausted input wasn't in its set, it contributed 0 to
9356      * 'count', and the rest of the union will be whatever the other input is.
9357      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9358      * otherwise it gets decremented to 0.  This is consistent with 'count'
9359      * == 0 meaning the remainder of the union is whatever is left in the
9360      * non-exhausted list. */
9361     if (count != 0) {
9362         len_u = i_u;
9363     }
9364     else {
9365         IV copy_count = len_a - i_a;
9366         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9367             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9368         }
9369         else { /* The non-exhausted input is b */
9370             copy_count = len_b - i_b;
9371             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9372         }
9373         len_u = i_u + copy_count;
9374     }
9375
9376     /* Set the result to the final length, which can change the pointer to
9377      * array_u, so re-find it.  (Note that it is unlikely that this will
9378      * change, as we are shrinking the space, not enlarging it) */
9379     if (len_u != _invlist_len(u)) {
9380         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9381         invlist_trim(u);
9382         array_u = invlist_array(u);
9383     }
9384
9385     if (*output == NULL) {  /* Simply return the new inversion list */
9386         *output = u;
9387     }
9388     else {
9389         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9390          * could instead free '*output', and then set it to 'u', but experience
9391          * has shown [perl #127392] that if the input is a mortal, we can get a
9392          * huge build-up of these during regex compilation before they get
9393          * freed. */
9394         invlist_replace_list_destroys_src(*output, u);
9395         SvREFCNT_dec_NN(u);
9396     }
9397
9398     return;
9399 }
9400
9401 void
9402 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9403                                                const bool complement_b, SV** i)
9404 {
9405     /* Take the intersection of two inversion lists and point '*i' to it.  On
9406      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9407      * even 'a' or 'b').  If to an inversion list, the contents of the original
9408      * list will be replaced by the intersection.  The first list, 'a', may be
9409      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9410      * TRUE, the result will be the intersection of 'a' and the complement (or
9411      * inversion) of 'b' instead of 'b' directly.
9412      *
9413      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9414      * Richard Gillam, published by Addison-Wesley, and explained at some
9415      * length there.  The preface says to incorporate its examples into your
9416      * code at your own risk.  In fact, it had bugs
9417      *
9418      * The algorithm is like a merge sort, and is essentially the same as the
9419      * union above
9420      */
9421
9422     const UV* array_a;          /* a's array */
9423     const UV* array_b;
9424     UV len_a;   /* length of a's array */
9425     UV len_b;
9426
9427     SV* r;                   /* the resulting intersection */
9428     UV* array_r;
9429     UV len_r = 0;
9430
9431     UV i_a = 0;             /* current index into a's array */
9432     UV i_b = 0;
9433     UV i_r = 0;
9434
9435     /* running count of how many of the two inputs are postitioned at ranges
9436      * that are in their sets.  As explained in the algorithm source book,
9437      * items are stopped accumulating and are output when the count changes
9438      * to/from 2.  The count is incremented when we start a range that's in an
9439      * input's set, and decremented when we start a range that's not in a set.
9440      * Only when it is 2 are we in the intersection. */
9441     UV count = 0;
9442
9443     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9444     assert(a != b);
9445     assert(*i == NULL || SvTYPE(*i) == SVt_INVLIST);
9446
9447     /* Special case if either one is empty */
9448     len_a = (a == NULL) ? 0 : _invlist_len(a);
9449     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9450         if (len_a != 0 && complement_b) {
9451
9452             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9453              * must be empty.  Here, also we are using 'b's complement, which
9454              * hence must be every possible code point.  Thus the intersection
9455              * is simply 'a'. */
9456
9457             if (*i == a) {  /* No-op */
9458                 return;
9459             }
9460
9461             if (*i == NULL) {
9462                 *i = invlist_clone(a);
9463                 return;
9464             }
9465
9466             r = invlist_clone(a);
9467             invlist_replace_list_destroys_src(*i, r);
9468             SvREFCNT_dec_NN(r);
9469             return;
9470         }
9471
9472         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9473          * intersection must be empty */
9474         if (*i == NULL) {
9475             *i = _new_invlist(0);
9476             return;
9477         }
9478
9479         invlist_clear(*i);
9480         return;
9481     }
9482
9483     /* Here both lists exist and are non-empty */
9484     array_a = invlist_array(a);
9485     array_b = invlist_array(b);
9486
9487     /* If are to take the intersection of 'a' with the complement of b, set it
9488      * up so are looking at b's complement. */
9489     if (complement_b) {
9490
9491         /* To complement, we invert: if the first element is 0, remove it.  To
9492          * do this, we just pretend the array starts one later */
9493         if (array_b[0] == 0) {
9494             array_b++;
9495             len_b--;
9496         }
9497         else {
9498
9499             /* But if the first element is not zero, we pretend the list starts
9500              * at the 0 that is always stored immediately before the array. */
9501             array_b--;
9502             len_b++;
9503         }
9504     }
9505
9506     /* Size the intersection for the worst case: that the intersection ends up
9507      * fragmenting everything to be completely disjoint */
9508     r= _new_invlist(len_a + len_b);
9509
9510     /* Will contain U+0000 iff both components do */
9511     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9512                                      && len_b > 0 && array_b[0] == 0);
9513
9514     /* Go through each list item by item, stopping when have exhausted one of
9515      * them */
9516     while (i_a < len_a && i_b < len_b) {
9517         UV cp;      /* The element to potentially add to the intersection's
9518                        array */
9519         bool cp_in_set; /* Is it in the input list's set or not */
9520
9521         /* We need to take one or the other of the two inputs for the
9522          * intersection.  Since we are merging two sorted lists, we take the
9523          * smaller of the next items.  In case of a tie, we take first the one
9524          * that is not in its set (a difference from the union algorithm).  If
9525          * we first took the one in its set, it would increment the count,
9526          * possibly to 2 which would cause it to be output as starting a range
9527          * in the intersection, and the next time through we would take that
9528          * same number, and output it again as ending the set.  By doing the
9529          * opposite of this, there is no possibility that the count will be
9530          * momentarily incremented to 2.  (In a tie and both are in the set or
9531          * both not in the set, it doesn't matter which we take first.) */
9532         if (       array_a[i_a] < array_b[i_b]
9533             || (   array_a[i_a] == array_b[i_b]
9534                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9535         {
9536             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9537             cp = array_a[i_a++];
9538         }
9539         else {
9540             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9541             cp= array_b[i_b++];
9542         }
9543
9544         /* Here, have chosen which of the two inputs to look at.  Only output
9545          * if the running count changes to/from 2, which marks the
9546          * beginning/end of a range that's in the intersection */
9547         if (cp_in_set) {
9548             count++;
9549             if (count == 2) {
9550                 array_r[i_r++] = cp;
9551             }
9552         }
9553         else {
9554             if (count == 2) {
9555                 array_r[i_r++] = cp;
9556             }
9557             count--;
9558         }
9559
9560     }
9561
9562     /* The loop above increments the index into exactly one of the input lists
9563      * each iteration, and ends when either index gets to its list end.  That
9564      * means the other index is lower than its end, and so something is
9565      * remaining in that one.  We increment 'count', as explained below, if the
9566      * exhausted list was in its set.  (i_a and i_b each currently index the
9567      * element beyond the one we care about.) */
9568     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9569         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9570     {
9571         count++;
9572     }
9573
9574     /* Above we incremented 'count' if the exhausted list was in its set.  This
9575      * has made it so that 'count' being below 2 means there is nothing left to
9576      * output; otheriwse what's left to add to the intersection is precisely
9577      * that which is left in the non-exhausted input list.
9578      *
9579      * To see why, note first that the exhausted input obviously has nothing
9580      * left to affect the intersection.  If it was in its set at its end, that
9581      * means the set extends from here to the platform's infinity, and hence
9582      * anything in the non-exhausted's list will be in the intersection, and
9583      * anything not in it won't be.  Hence, the rest of the intersection is
9584      * precisely what's in the non-exhausted list  The exhausted set also
9585      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9586      * it means 'count' is now at least 2.  This is consistent with the
9587      * incremented 'count' being >= 2 means to add the non-exhausted list to
9588      * the intersection.
9589      *
9590      * But if the exhausted input wasn't in its set, it contributed 0 to
9591      * 'count', and the intersection can't include anything further; the
9592      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9593      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9594      * further to add to the intersection. */
9595     if (count < 2) { /* Nothing left to put in the intersection. */
9596         len_r = i_r;
9597     }
9598     else { /* copy the non-exhausted list, unchanged. */
9599         IV copy_count = len_a - i_a;
9600         if (copy_count > 0) {   /* a is the one with stuff left */
9601             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9602         }
9603         else {  /* b is the one with stuff left */
9604             copy_count = len_b - i_b;
9605             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9606         }
9607         len_r = i_r + copy_count;
9608     }
9609
9610     /* Set the result to the final length, which can change the pointer to
9611      * array_r, so re-find it.  (Note that it is unlikely that this will
9612      * change, as we are shrinking the space, not enlarging it) */
9613     if (len_r != _invlist_len(r)) {
9614         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9615         invlist_trim(r);
9616         array_r = invlist_array(r);
9617     }
9618
9619     if (*i == NULL) { /* Simply return the calculated intersection */
9620         *i = r;
9621     }
9622     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9623               instead free '*i', and then set it to 'r', but experience has
9624               shown [perl #127392] that if the input is a mortal, we can get a
9625               huge build-up of these during regex compilation before they get
9626               freed. */
9627         if (len_r) {
9628             invlist_replace_list_destroys_src(*i, r);
9629         }
9630         else {
9631             invlist_clear(*i);
9632         }
9633         SvREFCNT_dec_NN(r);
9634     }
9635
9636     return;
9637 }
9638
9639 SV*
9640 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9641 {
9642     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9643      * set.  A pointer to the inversion list is returned.  This may actually be
9644      * a new list, in which case the passed in one has been destroyed.  The
9645      * passed-in inversion list can be NULL, in which case a new one is created
9646      * with just the one range in it.  The new list is not necessarily
9647      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9648      * result of this function.  The gain would not be large, and in many
9649      * cases, this is called multiple times on a single inversion list, so
9650      * anything freed may almost immediately be needed again.
9651      *
9652      * This used to mostly call the 'union' routine, but that is much more
9653      * heavyweight than really needed for a single range addition */
9654
9655     UV* array;              /* The array implementing the inversion list */
9656     UV len;                 /* How many elements in 'array' */
9657     SSize_t i_s;            /* index into the invlist array where 'start'
9658                                should go */
9659     SSize_t i_e = 0;        /* And the index where 'end' should go */
9660     UV cur_highest;         /* The highest code point in the inversion list
9661                                upon entry to this function */
9662
9663     /* This range becomes the whole inversion list if none already existed */
9664     if (invlist == NULL) {
9665         invlist = _new_invlist(2);
9666         _append_range_to_invlist(invlist, start, end);
9667         return invlist;
9668     }
9669
9670     /* Likewise, if the inversion list is currently empty */
9671     len = _invlist_len(invlist);
9672     if (len == 0) {
9673         _append_range_to_invlist(invlist, start, end);
9674         return invlist;
9675     }
9676
9677     /* Starting here, we have to know the internals of the list */
9678     array = invlist_array(invlist);
9679
9680     /* If the new range ends higher than the current highest ... */
9681     cur_highest = invlist_highest(invlist);
9682     if (end > cur_highest) {
9683
9684         /* If the whole range is higher, we can just append it */
9685         if (start > cur_highest) {
9686             _append_range_to_invlist(invlist, start, end);
9687             return invlist;
9688         }
9689
9690         /* Otherwise, add the portion that is higher ... */
9691         _append_range_to_invlist(invlist, cur_highest + 1, end);
9692
9693         /* ... and continue on below to handle the rest.  As a result of the
9694          * above append, we know that the index of the end of the range is the
9695          * final even numbered one of the array.  Recall that the final element
9696          * always starts a range that extends to infinity.  If that range is in
9697          * the set (meaning the set goes from here to infinity), it will be an
9698          * even index, but if it isn't in the set, it's odd, and the final
9699          * range in the set is one less, which is even. */
9700         if (end == UV_MAX) {
9701             i_e = len;
9702         }
9703         else {
9704             i_e = len - 2;
9705         }
9706     }
9707
9708     /* We have dealt with appending, now see about prepending.  If the new
9709      * range starts lower than the current lowest ... */
9710     if (start < array[0]) {
9711
9712         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
9713          * Let the union code handle it, rather than having to know the
9714          * trickiness in two code places.  */
9715         if (UNLIKELY(start == 0)) {
9716             SV* range_invlist;
9717
9718             range_invlist = _new_invlist(2);
9719             _append_range_to_invlist(range_invlist, start, end);
9720
9721             _invlist_union(invlist, range_invlist, &invlist);
9722
9723             SvREFCNT_dec_NN(range_invlist);
9724
9725             return invlist;
9726         }
9727
9728         /* If the whole new range comes before the first entry, and doesn't
9729          * extend it, we have to insert it as an additional range */
9730         if (end < array[0] - 1) {
9731             i_s = i_e = -1;
9732             goto splice_in_new_range;
9733         }
9734
9735         /* Here the new range adjoins the existing first range, extending it
9736          * downwards. */
9737         array[0] = start;
9738
9739         /* And continue on below to handle the rest.  We know that the index of
9740          * the beginning of the range is the first one of the array */
9741         i_s = 0;
9742     }
9743     else { /* Not prepending any part of the new range to the existing list.
9744             * Find where in the list it should go.  This finds i_s, such that:
9745             *     invlist[i_s] <= start < array[i_s+1]
9746             */
9747         i_s = _invlist_search(invlist, start);
9748     }
9749
9750     /* At this point, any extending before the beginning of the inversion list
9751      * and/or after the end has been done.  This has made it so that, in the
9752      * code below, each endpoint of the new range is either in a range that is
9753      * in the set, or is in a gap between two ranges that are.  This means we
9754      * don't have to worry about exceeding the array bounds.
9755      *
9756      * Find where in the list the new range ends (but we can skip this if we
9757      * have already determined what it is, or if it will be the same as i_s,
9758      * which we already have computed) */
9759     if (i_e == 0) {
9760         i_e = (start == end)
9761               ? i_s
9762               : _invlist_search(invlist, end);
9763     }
9764
9765     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
9766      * is a range that goes to infinity there is no element at invlist[i_e+1],
9767      * so only the first relation holds. */
9768
9769     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9770
9771         /* Here, the ranges on either side of the beginning of the new range
9772          * are in the set, and this range starts in the gap between them.
9773          *
9774          * The new range extends the range above it downwards if the new range
9775          * ends at or above that range's start */
9776         const bool extends_the_range_above = (   end == UV_MAX
9777                                               || end + 1 >= array[i_s+1]);
9778
9779         /* The new range extends the range below it upwards if it begins just
9780          * after where that range ends */
9781         if (start == array[i_s]) {
9782
9783             /* If the new range fills the entire gap between the other ranges,
9784              * they will get merged together.  Other ranges may also get
9785              * merged, depending on how many of them the new range spans.  In
9786              * the general case, we do the merge later, just once, after we
9787              * figure out how many to merge.  But in the case where the new
9788              * range exactly spans just this one gap (possibly extending into
9789              * the one above), we do the merge here, and an early exit.  This
9790              * is done here to avoid having to special case later. */
9791             if (i_e - i_s <= 1) {
9792
9793                 /* If i_e - i_s == 1, it means that the new range terminates
9794                  * within the range above, and hence 'extends_the_range_above'
9795                  * must be true.  (If the range above it extends to infinity,
9796                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
9797                  * will be 0, so no harm done.) */
9798                 if (extends_the_range_above) {
9799                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
9800                     invlist_set_len(invlist,
9801                                     len - 2,
9802                                     *(get_invlist_offset_addr(invlist)));
9803                     return invlist;
9804                 }
9805
9806                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
9807                  * to the same range, and below we are about to decrement i_s
9808                  * */
9809                 i_e--;
9810             }
9811
9812             /* Here, the new range is adjacent to the one below.  (It may also
9813              * span beyond the range above, but that will get resolved later.)
9814              * Extend the range below to include this one. */
9815             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
9816             i_s--;
9817             start = array[i_s];
9818         }
9819         else if (extends_the_range_above) {
9820
9821             /* Here the new range only extends the range above it, but not the
9822              * one below.  It merges with the one above.  Again, we keep i_e
9823              * and i_s in sync if they point to the same range */
9824             if (i_e == i_s) {
9825                 i_e++;
9826             }
9827             i_s++;
9828             array[i_s] = start;
9829         }
9830     }
9831
9832     /* Here, we've dealt with the new range start extending any adjoining
9833      * existing ranges.
9834      *
9835      * If the new range extends to infinity, it is now the final one,
9836      * regardless of what was there before */
9837     if (UNLIKELY(end == UV_MAX)) {
9838         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
9839         return invlist;
9840     }
9841
9842     /* If i_e started as == i_s, it has also been dealt with,
9843      * and been updated to the new i_s, which will fail the following if */
9844     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
9845
9846         /* Here, the ranges on either side of the end of the new range are in
9847          * the set, and this range ends in the gap between them.
9848          *
9849          * If this range is adjacent to (hence extends) the range above it, it
9850          * becomes part of that range; likewise if it extends the range below,
9851          * it becomes part of that range */
9852         if (end + 1 == array[i_e+1]) {
9853             i_e++;
9854             array[i_e] = start;
9855         }
9856         else if (start <= array[i_e]) {
9857             array[i_e] = end + 1;
9858             i_e--;
9859         }
9860     }
9861
9862     if (i_s == i_e) {
9863
9864         /* If the range fits entirely in an existing range (as possibly already
9865          * extended above), it doesn't add anything new */
9866         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9867             return invlist;
9868         }
9869
9870         /* Here, no part of the range is in the list.  Must add it.  It will
9871          * occupy 2 more slots */
9872       splice_in_new_range:
9873
9874         invlist_extend(invlist, len + 2);
9875         array = invlist_array(invlist);
9876         /* Move the rest of the array down two slots. Don't include any
9877          * trailing NUL */
9878         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
9879
9880         /* Do the actual splice */
9881         array[i_e+1] = start;
9882         array[i_e+2] = end + 1;
9883         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
9884         return invlist;
9885     }
9886
9887     /* Here the new range crossed the boundaries of a pre-existing range.  The
9888      * code above has adjusted things so that both ends are in ranges that are
9889      * in the set.  This means everything in between must also be in the set.
9890      * Just squash things together */
9891     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
9892     invlist_set_len(invlist,
9893                     len - i_e + i_s,
9894                     *(get_invlist_offset_addr(invlist)));
9895
9896     return invlist;
9897 }
9898
9899 SV*
9900 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9901                                  UV** other_elements_ptr)
9902 {
9903     /* Create and return an inversion list whose contents are to be populated
9904      * by the caller.  The caller gives the number of elements (in 'size') and
9905      * the very first element ('element0').  This function will set
9906      * '*other_elements_ptr' to an array of UVs, where the remaining elements
9907      * are to be placed.
9908      *
9909      * Obviously there is some trust involved that the caller will properly
9910      * fill in the other elements of the array.
9911      *
9912      * (The first element needs to be passed in, as the underlying code does
9913      * things differently depending on whether it is zero or non-zero) */
9914
9915     SV* invlist = _new_invlist(size);
9916     bool offset;
9917
9918     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9919
9920     invlist = add_cp_to_invlist(invlist, element0);
9921     offset = *get_invlist_offset_addr(invlist);
9922
9923     invlist_set_len(invlist, size, offset);
9924     *other_elements_ptr = invlist_array(invlist) + 1;
9925     return invlist;
9926 }
9927
9928 #endif
9929
9930 PERL_STATIC_INLINE SV*
9931 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9932     return _add_range_to_invlist(invlist, cp, cp);
9933 }
9934
9935 #ifndef PERL_IN_XSUB_RE
9936 void
9937 Perl__invlist_invert(pTHX_ SV* const invlist)
9938 {
9939     /* Complement the input inversion list.  This adds a 0 if the list didn't
9940      * have a zero; removes it otherwise.  As described above, the data
9941      * structure is set up so that this is very efficient */
9942
9943     PERL_ARGS_ASSERT__INVLIST_INVERT;
9944
9945     assert(! invlist_is_iterating(invlist));
9946
9947     /* The inverse of matching nothing is matching everything */
9948     if (_invlist_len(invlist) == 0) {
9949         _append_range_to_invlist(invlist, 0, UV_MAX);
9950         return;
9951     }
9952
9953     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9954 }
9955
9956 #endif
9957
9958 PERL_STATIC_INLINE SV*
9959 S_invlist_clone(pTHX_ SV* const invlist)
9960 {
9961
9962     /* Return a new inversion list that is a copy of the input one, which is
9963      * unchanged.  The new list will not be mortal even if the old one was. */
9964
9965     /* Need to allocate extra space to accommodate Perl's addition of a
9966      * trailing NUL to SvPV's, since it thinks they are always strings */
9967     SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
9968     STRLEN physical_length = SvCUR(invlist);
9969     bool offset = *(get_invlist_offset_addr(invlist));
9970
9971     PERL_ARGS_ASSERT_INVLIST_CLONE;
9972
9973     *(get_invlist_offset_addr(new_invlist)) = offset;
9974     invlist_set_len(new_invlist, _invlist_len(invlist), offset);
9975     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9976
9977     return new_invlist;
9978 }
9979
9980 PERL_STATIC_INLINE STRLEN*
9981 S_get_invlist_iter_addr(SV* invlist)
9982 {
9983     /* Return the address of the UV that contains the current iteration
9984      * position */
9985
9986     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
9987
9988     assert(SvTYPE(invlist) == SVt_INVLIST);
9989
9990     return &(((XINVLIST*) SvANY(invlist))->iterator);
9991 }
9992
9993 PERL_STATIC_INLINE void
9994 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
9995 {
9996     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
9997
9998     *get_invlist_iter_addr(invlist) = 0;
9999 }
10000
10001 PERL_STATIC_INLINE void
10002 S_invlist_iterfinish(SV* invlist)
10003 {
10004     /* Terminate iterator for invlist.  This is to catch development errors.
10005      * Any iteration that is interrupted before completed should call this
10006      * function.  Functions that add code points anywhere else but to the end
10007      * of an inversion list assert that they are not in the middle of an
10008      * iteration.  If they were, the addition would make the iteration
10009      * problematical: if the iteration hadn't reached the place where things
10010      * were being added, it would be ok */
10011
10012     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
10013
10014     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
10015 }
10016
10017 STATIC bool
10018 S_invlist_iternext(SV* invlist, UV* start, UV* end)
10019 {
10020     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
10021      * This call sets in <*start> and <*end>, the next range in <invlist>.
10022      * Returns <TRUE> if successful and the next call will return the next
10023      * range; <FALSE> if was already at the end of the list.  If the latter,
10024      * <*start> and <*end> are unchanged, and the next call to this function
10025      * will start over at the beginning of the list */
10026
10027     STRLEN* pos = get_invlist_iter_addr(invlist);
10028     UV len = _invlist_len(invlist);
10029     UV *array;
10030
10031     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
10032
10033     if (*pos >= len) {
10034         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
10035         return FALSE;
10036     }
10037
10038     array = invlist_array(invlist);
10039
10040     *start = array[(*pos)++];
10041
10042     if (*pos >= len) {
10043         *end = UV_MAX;
10044     }
10045     else {
10046         *end = array[(*pos)++] - 1;
10047     }
10048
10049     return TRUE;
10050 }
10051
10052 PERL_STATIC_INLINE UV
10053 S_invlist_highest(SV* const invlist)
10054 {
10055     /* Returns the highest code point that matches an inversion list.  This API
10056      * has an ambiguity, as it returns 0 under either the highest is actually
10057      * 0, or if the list is empty.  If this distinction matters to you, check
10058      * for emptiness before calling this function */
10059
10060     UV len = _invlist_len(invlist);
10061     UV *array;
10062
10063     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
10064
10065     if (len == 0) {
10066         return 0;
10067     }
10068
10069     array = invlist_array(invlist);
10070
10071     /* The last element in the array in the inversion list always starts a
10072      * range that goes to infinity.  That range may be for code points that are
10073      * matched in the inversion list, or it may be for ones that aren't
10074      * matched.  In the latter case, the highest code point in the set is one
10075      * less than the beginning of this range; otherwise it is the final element
10076      * of this range: infinity */
10077     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10078            ? UV_MAX
10079            : array[len - 1] - 1;
10080 }
10081
10082 STATIC SV *
10083 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10084 {
10085     /* Get the contents of an inversion list into a string SV so that they can
10086      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10087      * traditionally done for debug tracing; otherwise it uses a format
10088      * suitable for just copying to the output, with blanks between ranges and
10089      * a dash between range components */
10090
10091     UV start, end;
10092     SV* output;
10093     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10094     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10095
10096     if (traditional_style) {
10097         output = newSVpvs("\n");
10098     }
10099     else {
10100         output = newSVpvs("");
10101     }
10102
10103     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10104
10105     assert(! invlist_is_iterating(invlist));
10106
10107     invlist_iterinit(invlist);
10108     while (invlist_iternext(invlist, &start, &end)) {
10109         if (end == UV_MAX) {
10110             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFINITY%c",
10111                                           start, intra_range_delimiter,
10112                                                  inter_range_delimiter);
10113         }
10114         else if (end != start) {
10115             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10116                                           start,
10117                                                    intra_range_delimiter,
10118                                                   end, inter_range_delimiter);
10119         }
10120         else {
10121             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10122                                           start, inter_range_delimiter);
10123         }
10124     }
10125
10126     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10127         SvCUR_set(output, SvCUR(output) - 1);
10128     }
10129
10130     return output;
10131 }
10132
10133 #ifndef PERL_IN_XSUB_RE
10134 void
10135 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10136                          const char * const indent, SV* const invlist)
10137 {
10138     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10139      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10140      * the string 'indent'.  The output looks like this:
10141          [0] 0x000A .. 0x000D
10142          [2] 0x0085
10143          [4] 0x2028 .. 0x2029
10144          [6] 0x3104 .. INFINITY
10145      * This means that the first range of code points matched by the list are
10146      * 0xA through 0xD; the second range contains only the single code point
10147      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10148      * are used to define each range (except if the final range extends to
10149      * infinity, only a single element is needed).  The array index of the
10150      * first element for the corresponding range is given in brackets. */
10151
10152     UV start, end;
10153     STRLEN count = 0;
10154
10155     PERL_ARGS_ASSERT__INVLIST_DUMP;
10156
10157     if (invlist_is_iterating(invlist)) {
10158         Perl_dump_indent(aTHX_ level, file,
10159              "%sCan't dump inversion list because is in middle of iterating\n",
10160              indent);
10161         return;
10162     }
10163
10164     invlist_iterinit(invlist);
10165     while (invlist_iternext(invlist, &start, &end)) {
10166         if (end == UV_MAX) {
10167             Perl_dump_indent(aTHX_ level, file,
10168                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFINITY\n",
10169                                    indent, (UV)count, start);
10170         }
10171         else if (end != start) {
10172             Perl_dump_indent(aTHX_ level, file,
10173                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10174                                 indent, (UV)count, start,         end);
10175         }
10176         else {
10177             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10178                                             indent, (UV)count, start);
10179         }
10180         count += 2;
10181     }
10182 }
10183
10184 #endif
10185
10186 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10187 bool
10188 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10189 {
10190     /* Return a boolean as to if the two passed in inversion lists are
10191      * identical.  The final argument, if TRUE, says to take the complement of
10192      * the second inversion list before doing the comparison */
10193
10194     const UV* array_a = invlist_array(a);
10195     const UV* array_b = invlist_array(b);
10196     UV len_a = _invlist_len(a);
10197     UV len_b = _invlist_len(b);
10198
10199     PERL_ARGS_ASSERT__INVLISTEQ;
10200
10201     /* If are to compare 'a' with the complement of b, set it
10202      * up so are looking at b's complement. */
10203     if (complement_b) {
10204
10205         /* The complement of nothing is everything, so <a> would have to have
10206          * just one element, starting at zero (ending at infinity) */
10207         if (len_b == 0) {
10208             return (len_a == 1 && array_a[0] == 0);
10209         }
10210         else if (array_b[0] == 0) {
10211
10212             /* Otherwise, to complement, we invert.  Here, the first element is
10213              * 0, just remove it.  To do this, we just pretend the array starts
10214              * one later */
10215
10216             array_b++;
10217             len_b--;
10218         }
10219         else {
10220
10221             /* But if the first element is not zero, we pretend the list starts
10222              * at the 0 that is always stored immediately before the array. */
10223             array_b--;
10224             len_b++;
10225         }
10226     }
10227
10228     return    len_a == len_b
10229            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10230
10231 }
10232 #endif
10233
10234 /*
10235  * As best we can, determine the characters that can match the start of
10236  * the given EXACTF-ish node.
10237  *
10238  * Returns the invlist as a new SV*; it is the caller's responsibility to
10239  * call SvREFCNT_dec() when done with it.
10240  */
10241 STATIC SV*
10242 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10243 {
10244     const U8 * s = (U8*)STRING(node);
10245     SSize_t bytelen = STR_LEN(node);
10246     UV uc;
10247     /* Start out big enough for 2 separate code points */
10248     SV* invlist = _new_invlist(4);
10249
10250     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10251
10252     if (! UTF) {
10253         uc = *s;
10254
10255         /* We punt and assume can match anything if the node begins
10256          * with a multi-character fold.  Things are complicated.  For
10257          * example, /ffi/i could match any of:
10258          *  "\N{LATIN SMALL LIGATURE FFI}"
10259          *  "\N{LATIN SMALL LIGATURE FF}I"
10260          *  "F\N{LATIN SMALL LIGATURE FI}"
10261          *  plus several other things; and making sure we have all the
10262          *  possibilities is hard. */
10263         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10264             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10265         }
10266         else {
10267             /* Any Latin1 range character can potentially match any
10268              * other depending on the locale */
10269             if (OP(node) == EXACTFL) {
10270                 _invlist_union(invlist, PL_Latin1, &invlist);
10271             }
10272             else {
10273                 /* But otherwise, it matches at least itself.  We can
10274                  * quickly tell if it has a distinct fold, and if so,
10275                  * it matches that as well */
10276                 invlist = add_cp_to_invlist(invlist, uc);
10277                 if (IS_IN_SOME_FOLD_L1(uc))
10278                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10279             }
10280
10281             /* Some characters match above-Latin1 ones under /i.  This
10282              * is true of EXACTFL ones when the locale is UTF-8 */
10283             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10284                 && (! isASCII(uc) || (OP(node) != EXACTFAA
10285                                     && OP(node) != EXACTFAA_NO_TRIE)))
10286             {
10287                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10288             }
10289         }
10290     }
10291     else {  /* Pattern is UTF-8 */
10292         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10293         const U8* e = s + bytelen;
10294         IV fc;
10295
10296         fc = uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10297
10298         /* The only code points that aren't folded in a UTF EXACTFish
10299          * node are are the problematic ones in EXACTFL nodes */
10300         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10301             /* We need to check for the possibility that this EXACTFL
10302              * node begins with a multi-char fold.  Therefore we fold
10303              * the first few characters of it so that we can make that
10304              * check */
10305             U8 *d = folded;
10306             int i;
10307
10308             fc = -1;
10309             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10310                 if (isASCII(*s)) {
10311                     *(d++) = (U8) toFOLD(*s);
10312                     if (fc < 0) {       /* Save the first fold */
10313                         fc = *(d-1);
10314                     }
10315                     s++;
10316                 }
10317                 else {
10318                     STRLEN len;
10319                     UV fold = toFOLD_utf8_safe(s, e, d, &len);
10320                     if (fc < 0) {       /* Save the first fold */
10321                         fc = fold;
10322                     }
10323                     d += len;
10324                     s += UTF8SKIP(s);
10325                 }
10326             }
10327
10328             /* And set up so the code below that looks in this folded
10329              * buffer instead of the node's string */
10330             e = d;
10331             s = folded;
10332         }
10333
10334         /* When we reach here 's' points to the fold of the first
10335          * character(s) of the node; and 'e' points to far enough along
10336          * the folded string to be just past any possible multi-char
10337          * fold.
10338          *
10339          * Unlike the non-UTF-8 case, the macro for determining if a
10340          * string is a multi-char fold requires all the characters to
10341          * already be folded.  This is because of all the complications
10342          * if not.  Note that they are folded anyway, except in EXACTFL
10343          * nodes.  Like the non-UTF case above, we punt if the node
10344          * begins with a multi-char fold  */
10345
10346         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10347             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10348         }
10349         else {  /* Single char fold */
10350             unsigned int k;
10351             unsigned int first_folds_to;
10352             const unsigned int * remaining_folds_to_list;
10353             Size_t folds_to_count;
10354
10355             /* It matches itself */
10356             invlist = add_cp_to_invlist(invlist, fc);
10357
10358             /* ... plus all the things that fold to it, which are found in
10359              * PL_utf8_foldclosures */
10360             folds_to_count = _inverse_folds(fc, &first_folds_to,
10361                                                 &remaining_folds_to_list);
10362             for (k = 0; k < folds_to_count; k++) {
10363                 UV c = (k == 0) ? first_folds_to : remaining_folds_to_list[k-1];
10364
10365                 /* /aa doesn't allow folds between ASCII and non- */
10366                 if (   (OP(node) == EXACTFAA || OP(node) == EXACTFAA_NO_TRIE)
10367                     && isASCII(c) != isASCII(fc))
10368                 {
10369                     continue;
10370                 }
10371
10372                 invlist = add_cp_to_invlist(invlist, c);
10373             }
10374         }
10375     }
10376
10377     return invlist;
10378 }
10379
10380 #undef HEADER_LENGTH
10381 #undef TO_INTERNAL_SIZE
10382 #undef FROM_INTERNAL_SIZE
10383 #undef INVLIST_VERSION_ID
10384
10385 /* End of inversion list object */
10386
10387 STATIC void
10388 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10389 {
10390     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10391      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10392      * should point to the first flag; it is updated on output to point to the
10393      * final ')' or ':'.  There needs to be at least one flag, or this will
10394      * abort */
10395
10396     /* for (?g), (?gc), and (?o) warnings; warning
10397        about (?c) will warn about (?g) -- japhy    */
10398
10399 #define WASTED_O  0x01
10400 #define WASTED_G  0x02
10401 #define WASTED_C  0x04
10402 #define WASTED_GC (WASTED_G|WASTED_C)
10403     I32 wastedflags = 0x00;
10404     U32 posflags = 0, negflags = 0;
10405     U32 *flagsp = &posflags;
10406     char has_charset_modifier = '\0';
10407     regex_charset cs;
10408     bool has_use_defaults = FALSE;
10409     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10410     int x_mod_count = 0;
10411
10412     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10413
10414     /* '^' as an initial flag sets certain defaults */
10415     if (UCHARAT(RExC_parse) == '^') {
10416         RExC_parse++;
10417         has_use_defaults = TRUE;
10418         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10419         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
10420                                         ? REGEX_UNICODE_CHARSET
10421                                         : REGEX_DEPENDS_CHARSET);
10422     }
10423
10424     cs = get_regex_charset(RExC_flags);
10425     if (cs == REGEX_DEPENDS_CHARSET
10426         && (RExC_utf8 || RExC_uni_semantics))
10427     {
10428         cs = REGEX_UNICODE_CHARSET;
10429     }
10430
10431     while (RExC_parse < RExC_end) {
10432         /* && strchr("iogcmsx", *RExC_parse) */
10433         /* (?g), (?gc) and (?o) are useless here
10434            and must be globally applied -- japhy */
10435         switch (*RExC_parse) {
10436
10437             /* Code for the imsxn flags */
10438             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10439
10440             case LOCALE_PAT_MOD:
10441                 if (has_charset_modifier) {
10442                     goto excess_modifier;
10443                 }
10444                 else if (flagsp == &negflags) {
10445                     goto neg_modifier;
10446                 }
10447                 cs = REGEX_LOCALE_CHARSET;
10448                 has_charset_modifier = LOCALE_PAT_MOD;
10449                 break;
10450             case UNICODE_PAT_MOD:
10451                 if (has_charset_modifier) {
10452                     goto excess_modifier;
10453                 }
10454                 else if (flagsp == &negflags) {
10455                     goto neg_modifier;
10456                 }
10457                 cs = REGEX_UNICODE_CHARSET;
10458                 has_charset_modifier = UNICODE_PAT_MOD;
10459                 break;
10460             case ASCII_RESTRICT_PAT_MOD:
10461                 if (flagsp == &negflags) {
10462                     goto neg_modifier;
10463                 }
10464                 if (has_charset_modifier) {
10465                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10466                         goto excess_modifier;
10467                     }
10468                     /* Doubled modifier implies more restricted */
10469                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10470                 }
10471                 else {
10472                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10473                 }
10474                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10475                 break;
10476             case DEPENDS_PAT_MOD:
10477                 if (has_use_defaults) {
10478                     goto fail_modifiers;
10479                 }
10480                 else if (flagsp == &negflags) {
10481                     goto neg_modifier;
10482                 }
10483                 else if (has_charset_modifier) {
10484                     goto excess_modifier;
10485                 }
10486
10487                 /* The dual charset means unicode semantics if the
10488                  * pattern (or target, not known until runtime) are
10489                  * utf8, or something in the pattern indicates unicode
10490                  * semantics */
10491                 cs = (RExC_utf8 || RExC_uni_semantics)
10492                      ? REGEX_UNICODE_CHARSET
10493                      : REGEX_DEPENDS_CHARSET;
10494                 has_charset_modifier = DEPENDS_PAT_MOD;
10495                 break;
10496               excess_modifier:
10497                 RExC_parse++;
10498                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10499                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10500                 }
10501                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10502                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10503                                         *(RExC_parse - 1));
10504                 }
10505                 else {
10506                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10507                 }
10508                 NOT_REACHED; /*NOTREACHED*/
10509               neg_modifier:
10510                 RExC_parse++;
10511                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10512                                     *(RExC_parse - 1));
10513                 NOT_REACHED; /*NOTREACHED*/
10514             case ONCE_PAT_MOD: /* 'o' */
10515             case GLOBAL_PAT_MOD: /* 'g' */
10516                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10517                     const I32 wflagbit = *RExC_parse == 'o'
10518                                          ? WASTED_O
10519                                          : WASTED_G;
10520                     if (! (wastedflags & wflagbit) ) {
10521                         wastedflags |= wflagbit;
10522                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10523                         vWARN5(
10524                             RExC_parse + 1,
10525                             "Useless (%s%c) - %suse /%c modifier",
10526                             flagsp == &negflags ? "?-" : "?",
10527                             *RExC_parse,
10528                             flagsp == &negflags ? "don't " : "",
10529                             *RExC_parse
10530                         );
10531                     }
10532                 }
10533                 break;
10534
10535             case CONTINUE_PAT_MOD: /* 'c' */
10536                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10537                     if (! (wastedflags & WASTED_C) ) {
10538                         wastedflags |= WASTED_GC;
10539                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10540                         vWARN3(
10541                             RExC_parse + 1,
10542                             "Useless (%sc) - %suse /gc modifier",
10543                             flagsp == &negflags ? "?-" : "?",
10544                             flagsp == &negflags ? "don't " : ""
10545                         );
10546                     }
10547                 }
10548                 break;
10549             case KEEPCOPY_PAT_MOD: /* 'p' */
10550                 if (flagsp == &negflags) {
10551                     if (PASS2)
10552                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10553                 } else {
10554                     *flagsp |= RXf_PMf_KEEPCOPY;
10555                 }
10556                 break;
10557             case '-':
10558                 /* A flag is a default iff it is following a minus, so
10559                  * if there is a minus, it means will be trying to
10560                  * re-specify a default which is an error */
10561                 if (has_use_defaults || flagsp == &negflags) {
10562                     goto fail_modifiers;
10563                 }
10564                 flagsp = &negflags;
10565                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10566                 x_mod_count = 0;
10567                 break;
10568             case ':':
10569             case ')':
10570
10571                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10572                     negflags |= RXf_PMf_EXTENDED_MORE;
10573                 }
10574                 RExC_flags |= posflags;
10575
10576                 if (negflags & RXf_PMf_EXTENDED) {
10577                     negflags |= RXf_PMf_EXTENDED_MORE;
10578                 }
10579                 RExC_flags &= ~negflags;
10580                 set_regex_charset(&RExC_flags, cs);
10581
10582                 return;
10583             default:
10584               fail_modifiers:
10585                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10586                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10587                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10588                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10589                 NOT_REACHED; /*NOTREACHED*/
10590         }
10591
10592         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10593     }
10594
10595     vFAIL("Sequence (?... not terminated");
10596 }
10597
10598 /*
10599  - reg - regular expression, i.e. main body or parenthesized thing
10600  *
10601  * Caller must absorb opening parenthesis.
10602  *
10603  * Combining parenthesis handling with the base level of regular expression
10604  * is a trifle forced, but the need to tie the tails of the branches to what
10605  * follows makes it hard to avoid.
10606  */
10607 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
10608 #ifdef DEBUGGING
10609 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
10610 #else
10611 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
10612 #endif
10613
10614 PERL_STATIC_INLINE regnode *
10615 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
10616                              I32 *flagp,
10617                              char * parse_start,
10618                              char ch
10619                       )
10620 {
10621     regnode *ret;
10622     char* name_start = RExC_parse;
10623     U32 num = 0;
10624     SV *sv_dat = reg_scan_name(pRExC_state, SIZE_ONLY
10625                                             ? REG_RSN_RETURN_NULL
10626                                             : REG_RSN_RETURN_DATA);
10627     GET_RE_DEBUG_FLAGS_DECL;
10628
10629     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
10630
10631     if (RExC_parse == name_start || *RExC_parse != ch) {
10632         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
10633         vFAIL2("Sequence %.3s... not terminated",parse_start);
10634     }
10635
10636     if (!SIZE_ONLY) {
10637         num = add_data( pRExC_state, STR_WITH_LEN("S"));
10638         RExC_rxi->data->data[num]=(void*)sv_dat;
10639         SvREFCNT_inc_simple_void(sv_dat);
10640     }
10641     RExC_sawback = 1;
10642     ret = reganode(pRExC_state,
10643                    ((! FOLD)
10644                      ? NREF
10645                      : (ASCII_FOLD_RESTRICTED)
10646                        ? NREFFA
10647                        : (AT_LEAST_UNI_SEMANTICS)
10648                          ? NREFFU
10649                          : (LOC)
10650                            ? NREFFL
10651                            : NREFF),
10652                     num);
10653     *flagp |= HASWIDTH;
10654
10655     Set_Node_Offset(ret, parse_start+1);
10656     Set_Node_Cur_Length(ret, parse_start);
10657
10658     nextchar(pRExC_state);
10659     return ret;
10660 }
10661
10662 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
10663    flags. Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan
10664    needs to be restarted, or'd with NEED_UTF8 if the pattern needs to be
10665    upgraded to UTF-8.  Otherwise would only return NULL if regbranch() returns
10666    NULL, which cannot happen.  */
10667 STATIC regnode *
10668 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
10669     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
10670      * 2 is like 1, but indicates that nextchar() has been called to advance
10671      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
10672      * this flag alerts us to the need to check for that */
10673 {
10674     regnode *ret = NULL;    /* Will be the head of the group. */
10675     regnode *br;
10676     regnode *lastbr;
10677     regnode *ender = NULL;
10678     I32 parno = 0;
10679     I32 flags;
10680     U32 oregflags = RExC_flags;
10681     bool have_branch = 0;
10682     bool is_open = 0;
10683     I32 freeze_paren = 0;
10684     I32 after_freeze = 0;
10685     I32 num; /* numeric backreferences */
10686
10687     char * parse_start = RExC_parse; /* MJD */
10688     char * const oregcomp_parse = RExC_parse;
10689
10690     GET_RE_DEBUG_FLAGS_DECL;
10691
10692     PERL_ARGS_ASSERT_REG;
10693     DEBUG_PARSE("reg ");
10694
10695     *flagp = 0;                         /* Tentatively. */
10696
10697     /* Having this true makes it feasible to have a lot fewer tests for the
10698      * parse pointer being in scope.  For example, we can write
10699      *      while(isFOO(*RExC_parse)) RExC_parse++;
10700      * instead of
10701      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
10702      */
10703     assert(*RExC_end == '\0');
10704
10705     /* Make an OPEN node, if parenthesized. */
10706     if (paren) {
10707
10708         /* Under /x, space and comments can be gobbled up between the '(' and
10709          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
10710          * intervening space, as the sequence is a token, and a token should be
10711          * indivisible */
10712         bool has_intervening_patws = (paren == 2)
10713                                   && *(RExC_parse - 1) != '(';
10714
10715         if (RExC_parse >= RExC_end) {
10716             vFAIL("Unmatched (");
10717         }
10718
10719         if (paren == 'r') {     /* Atomic script run */
10720             paren = '>';
10721             goto parse_rest;
10722         }
10723         else if ( *RExC_parse == '*') { /* (*VERB:ARG), (*construct:...) */
10724             char *start_verb = RExC_parse + 1;
10725             STRLEN verb_len;
10726             char *start_arg = NULL;
10727             unsigned char op = 0;
10728             int arg_required = 0;
10729             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
10730             bool has_upper = FALSE;
10731
10732             if (has_intervening_patws) {
10733                 RExC_parse++;   /* past the '*' */
10734
10735                 /* For strict backwards compatibility, don't change the message
10736                  * now that we also have lowercase operands */
10737                 if (isUPPER(*RExC_parse)) {
10738                     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
10739                 }
10740                 else {
10741                     vFAIL("In '(*...)', the '(' and '*' must be adjacent");
10742                 }
10743             }
10744             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
10745                 if ( *RExC_parse == ':' ) {
10746                     start_arg = RExC_parse + 1;
10747                     break;
10748                 }
10749                 else if (! UTF) {
10750                     if (isUPPER(*RExC_parse)) {
10751                         has_upper = TRUE;
10752                     }
10753                     RExC_parse++;
10754                 }
10755                 else {
10756                     RExC_parse += UTF8SKIP(RExC_parse);
10757                 }
10758             }
10759             verb_len = RExC_parse - start_verb;
10760             if ( start_arg ) {
10761                 if (RExC_parse >= RExC_end) {
10762                     goto unterminated_verb_pattern;
10763                 }
10764
10765                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10766                 while ( RExC_parse < RExC_end && *RExC_parse != ')' ) {
10767                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10768                 }
10769                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
10770                   unterminated_verb_pattern:
10771                     if (has_upper) {
10772                         vFAIL("Unterminated verb pattern argument");
10773                     }
10774                     else {
10775                         vFAIL("Unterminated '(*...' argument");
10776                     }
10777                 }
10778             } else {
10779                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
10780                     if (has_upper) {
10781                         vFAIL("Unterminated verb pattern");
10782                     }
10783                     else {
10784                         vFAIL("Unterminated '(*...' construct");
10785                     }
10786                 }
10787             }
10788
10789             /* Here, we know that RExC_parse < RExC_end */
10790
10791             switch ( *start_verb ) {
10792             case 'A':  /* (*ACCEPT) */
10793                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
10794                     op = ACCEPT;
10795                     internal_argval = RExC_nestroot;
10796                 }
10797                 break;
10798             case 'C':  /* (*COMMIT) */
10799                 if ( memEQs(start_verb,verb_len,"COMMIT") )
10800                     op = COMMIT;
10801                 break;
10802             case 'F':  /* (*FAIL) */
10803                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
10804                     op = OPFAIL;
10805                 }
10806                 break;
10807             case ':':  /* (*:NAME) */
10808             case 'M':  /* (*MARK:NAME) */
10809                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
10810                     op = MARKPOINT;
10811                     arg_required = 1;
10812                 }
10813                 break;
10814             case 'P':  /* (*PRUNE) */
10815                 if ( memEQs(start_verb,verb_len,"PRUNE") )
10816                     op = PRUNE;
10817                 break;
10818             case 'S':   /* (*SKIP) */
10819                 if ( memEQs(start_verb,verb_len,"SKIP") )
10820                     op = SKIP;
10821                 break;
10822             case 'T':  /* (*THEN) */
10823                 /* [19:06] <TimToady> :: is then */
10824                 if ( memEQs(start_verb,verb_len,"THEN") ) {
10825                     op = CUTGROUP;
10826                     RExC_seen |= REG_CUTGROUP_SEEN;
10827                 }
10828                 break;
10829             case 'a':
10830                 if (   memEQs(start_verb, verb_len, "asr")
10831                     || memEQs(start_verb, verb_len, "atomic_script_run"))
10832                 {
10833                     paren = 'r';        /* Mnemonic: recursed run */
10834                     goto script_run;
10835                 }
10836                 else if (memEQs(start_verb, verb_len, "atomic")) {
10837                     paren = 't';    /* AtOMIC */
10838                     goto alpha_assertions;
10839                 }
10840                 break;
10841             case 'p':
10842                 if (   memEQs(start_verb, verb_len, "plb")
10843                     || memEQs(start_verb, verb_len, "positive_lookbehind"))
10844                 {
10845                     paren = 'b';
10846                     goto lookbehind_alpha_assertions;
10847                 }
10848                 else if (   memEQs(start_verb, verb_len, "pla")
10849                          || memEQs(start_verb, verb_len, "positive_lookahead"))
10850                 {
10851                     paren = 'a';
10852                     goto alpha_assertions;
10853                 }
10854                 break;
10855             case 'n':
10856                 if (   memEQs(start_verb, verb_len, "nlb")
10857                     || memEQs(start_verb, verb_len, "negative_lookbehind"))
10858                 {
10859                     paren = 'B';
10860                     goto lookbehind_alpha_assertions;
10861                 }
10862                 else if (   memEQs(start_verb, verb_len, "nla")
10863                          || memEQs(start_verb, verb_len, "negative_lookahead"))
10864                 {
10865                     paren = 'A';
10866                     goto alpha_assertions;
10867                 }
10868                 break;
10869             case 's':
10870                 if (   memEQs(start_verb, verb_len, "sr")
10871                     || memEQs(start_verb, verb_len, "script_run"))
10872                 {
10873                     regnode * atomic;
10874
10875                     paren = 's';
10876
10877                    script_run:
10878
10879                     /* This indicates Unicode rules. */
10880                     REQUIRE_UNI_RULES(flagp, NULL);
10881
10882                     if (! start_arg) {
10883                         goto no_colon;
10884                     }
10885
10886                     RExC_parse = start_arg;
10887
10888                     if (RExC_in_script_run) {
10889
10890                         /*  Nested script runs are treated as no-ops, because
10891                          *  if the nested one fails, the outer one must as
10892                          *  well.  It could fail sooner, and avoid (??{} with
10893                          *  side effects, but that is explicitly documented as
10894                          *  undefined behavior. */
10895
10896                         ret = NULL;
10897
10898                         if (paren == 's') {
10899                             paren = ':';
10900                             goto parse_rest;
10901                         }
10902
10903                         /* But, the atomic part of a nested atomic script run
10904                          * isn't a no-op, but can be treated just like a '(?>'
10905                          * */
10906                         paren = '>';
10907                         goto parse_rest;
10908                     }
10909
10910                     /* By doing this here, we avoid extra warnings for nested
10911                      * script runs */
10912                     if (PASS2) {
10913                         Perl_ck_warner_d(aTHX_
10914                             packWARN(WARN_EXPERIMENTAL__SCRIPT_RUN),
10915                             "The script_run feature is experimental"
10916                             REPORT_LOCATION, REPORT_LOCATION_ARGS(RExC_parse));
10917
10918                     }
10919
10920                     if (paren == 's') {
10921                         /* Here, we're starting a new regular script run */
10922                         ret = reg_node(pRExC_state, SROPEN);
10923                         RExC_in_script_run = 1;
10924                         is_open = 1;
10925                         goto parse_rest;
10926                     }
10927
10928                     /* Here, we are starting an atomic script run.  This is
10929                      * handled by recursing to deal with the atomic portion
10930                      * separately, enclosed in SROPEN ... SRCLOSE nodes */
10931
10932                     ret = reg_node(pRExC_state, SROPEN);
10933
10934                     RExC_in_script_run = 1;
10935
10936                     atomic = reg(pRExC_state, 'r', &flags, depth);
10937                     if (flags & (RESTART_PASS1|NEED_UTF8)) {
10938                         *flagp = flags & (RESTART_PASS1|NEED_UTF8);
10939                         return NULL;
10940                     }
10941
10942                     REGTAIL(pRExC_state, ret, atomic);
10943
10944                     REGTAIL(pRExC_state, atomic,
10945                            reg_node(pRExC_state, SRCLOSE));
10946
10947                     RExC_in_script_run = 0;
10948                     return ret;
10949                 }
10950
10951                 break;
10952
10953             lookbehind_alpha_assertions:
10954                 RExC_seen |= REG_LOOKBEHIND_SEEN;
10955                 RExC_in_lookbehind++;
10956                 /*FALLTHROUGH*/
10957
10958             alpha_assertions:
10959
10960                 if (PASS2) {
10961                     Perl_ck_warner_d(aTHX_
10962                         packWARN(WARN_EXPERIMENTAL__ALPHA_ASSERTIONS),
10963                         "The alpha_assertions feature is experimental"
10964                         REPORT_LOCATION, REPORT_LOCATION_ARGS(RExC_parse));
10965                 }
10966
10967                 RExC_seen_zerolen++;
10968
10969                 if (! start_arg) {
10970                     goto no_colon;
10971                 }
10972
10973                 /* An empty negative lookahead assertion simply is failure */
10974                 if (paren == 'A' && RExC_parse == start_arg) {
10975                     ret=reganode(pRExC_state, OPFAIL, 0);
10976                     nextchar(pRExC_state);
10977                     return ret;
10978                 }
10979
10980                 RExC_parse = start_arg;
10981                 goto parse_rest;
10982
10983               no_colon:
10984                 vFAIL2utf8f(
10985                 "'(*%" UTF8f "' requires a terminating ':'",
10986                 UTF8fARG(UTF, verb_len, start_verb));
10987                 NOT_REACHED; /*NOTREACHED*/
10988
10989             } /* End of switch */
10990             if ( ! op ) {
10991                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10992                 if (has_upper || verb_len == 0) {
10993                     vFAIL2utf8f(
10994                     "Unknown verb pattern '%" UTF8f "'",
10995                     UTF8fARG(UTF, verb_len, start_verb));
10996                 }
10997                 else {
10998                     vFAIL2utf8f(
10999                     "Unknown '(*...)' construct '%" UTF8f "'",
11000                     UTF8fARG(UTF, verb_len, start_verb));
11001                 }
11002             }
11003             if ( RExC_parse == start_arg ) {
11004                 start_arg = NULL;
11005             }
11006             if ( arg_required && !start_arg ) {
11007                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
11008                     verb_len, start_verb);
11009             }
11010             if (internal_argval == -1) {
11011                 ret = reganode(pRExC_state, op, 0);
11012             } else {
11013                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
11014             }
11015             RExC_seen |= REG_VERBARG_SEEN;
11016             if ( ! SIZE_ONLY ) {
11017                 if (start_arg) {
11018                     SV *sv = newSVpvn( start_arg,
11019                                        RExC_parse - start_arg);
11020                     ARG(ret) = add_data( pRExC_state,
11021                                          STR_WITH_LEN("S"));
11022                     RExC_rxi->data->data[ARG(ret)]=(void*)sv;
11023                     ret->flags = 1;
11024                 } else {
11025                     ret->flags = 0;
11026                 }
11027                 if ( internal_argval != -1 )
11028                     ARG2L_SET(ret, internal_argval);
11029             }
11030             nextchar(pRExC_state);
11031             return ret;
11032         }
11033         else if (*RExC_parse == '?') { /* (?...) */
11034             bool is_logical = 0;
11035             const char * const seqstart = RExC_parse;
11036             const char * endptr;
11037             if (has_intervening_patws) {
11038                 RExC_parse++;
11039                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
11040             }
11041
11042             RExC_parse++;           /* past the '?' */
11043             paren = *RExC_parse;    /* might be a trailing NUL, if not
11044                                        well-formed */
11045             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11046             if (RExC_parse > RExC_end) {
11047                 paren = '\0';
11048             }
11049             ret = NULL;                 /* For look-ahead/behind. */
11050             switch (paren) {
11051
11052             case 'P':   /* (?P...) variants for those used to PCRE/Python */
11053                 paren = *RExC_parse;
11054                 if ( paren == '<') {    /* (?P<...>) named capture */
11055                     RExC_parse++;
11056                     if (RExC_parse >= RExC_end) {
11057                         vFAIL("Sequence (?P<... not terminated");
11058                     }
11059                     goto named_capture;
11060                 }
11061                 else if (paren == '>') {   /* (?P>name) named recursion */
11062                     RExC_parse++;
11063                     if (RExC_parse >= RExC_end) {
11064                         vFAIL("Sequence (?P>... not terminated");
11065                     }
11066                     goto named_recursion;
11067                 }
11068                 else if (paren == '=') {   /* (?P=...)  named backref */
11069                     RExC_parse++;
11070                     return handle_named_backref(pRExC_state, flagp,
11071                                                 parse_start, ')');
11072                 }
11073                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
11074                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11075                 vFAIL3("Sequence (%.*s...) not recognized",
11076                                 RExC_parse-seqstart, seqstart);
11077                 NOT_REACHED; /*NOTREACHED*/
11078             case '<':           /* (?<...) */
11079                 if (*RExC_parse == '!')
11080                     paren = ',';
11081                 else if (*RExC_parse != '=')
11082               named_capture:
11083                 {               /* (?<...>) */
11084                     char *name_start;
11085                     SV *svname;
11086                     paren= '>';
11087                 /* FALLTHROUGH */
11088             case '\'':          /* (?'...') */
11089                     name_start = RExC_parse;
11090                     svname = reg_scan_name(pRExC_state,
11091                         SIZE_ONLY    /* reverse test from the others */
11092                         ? REG_RSN_RETURN_NAME
11093                         : REG_RSN_RETURN_NULL);
11094                     if (   RExC_parse == name_start
11095                         || RExC_parse >= RExC_end
11096                         || *RExC_parse != paren)
11097                     {
11098                         vFAIL2("Sequence (?%c... not terminated",
11099                             paren=='>' ? '<' : paren);
11100                     }
11101                     if (SIZE_ONLY) {
11102                         HE *he_str;
11103                         SV *sv_dat = NULL;
11104                         if (!svname) /* shouldn't happen */
11105                             Perl_croak(aTHX_
11106                                 "panic: reg_scan_name returned NULL");
11107                         if (!RExC_paren_names) {
11108                             RExC_paren_names= newHV();
11109                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
11110 #ifdef DEBUGGING
11111                             RExC_paren_name_list= newAV();
11112                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
11113 #endif
11114                         }
11115                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
11116                         if ( he_str )
11117                             sv_dat = HeVAL(he_str);
11118                         if ( ! sv_dat ) {
11119                             /* croak baby croak */
11120                             Perl_croak(aTHX_
11121                                 "panic: paren_name hash element allocation failed");
11122                         } else if ( SvPOK(sv_dat) ) {
11123                             /* (?|...) can mean we have dupes so scan to check
11124                                its already been stored. Maybe a flag indicating
11125                                we are inside such a construct would be useful,
11126                                but the arrays are likely to be quite small, so
11127                                for now we punt -- dmq */
11128                             IV count = SvIV(sv_dat);
11129                             I32 *pv = (I32*)SvPVX(sv_dat);
11130                             IV i;
11131                             for ( i = 0 ; i < count ; i++ ) {
11132                                 if ( pv[i] == RExC_npar ) {
11133                                     count = 0;
11134                                     break;
11135                                 }
11136                             }
11137                             if ( count ) {
11138                                 pv = (I32*)SvGROW(sv_dat,
11139                                                 SvCUR(sv_dat) + sizeof(I32)+1);
11140                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
11141                                 pv[count] = RExC_npar;
11142                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
11143                             }
11144                         } else {
11145                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
11146                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
11147                                                                 sizeof(I32));
11148                             SvIOK_on(sv_dat);
11149                             SvIV_set(sv_dat, 1);
11150                         }
11151 #ifdef DEBUGGING
11152                         /* Yes this does cause a memory leak in debugging Perls
11153                          * */
11154                         if (!av_store(RExC_paren_name_list,
11155                                       RExC_npar, SvREFCNT_inc(svname)))
11156                             SvREFCNT_dec_NN(svname);
11157 #endif
11158
11159                         /*sv_dump(sv_dat);*/
11160                     }
11161                     nextchar(pRExC_state);
11162                     paren = 1;
11163                     goto capturing_parens;
11164                 }
11165
11166                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11167                 RExC_in_lookbehind++;
11168                 RExC_parse++;
11169                 if (RExC_parse >= RExC_end) {
11170                     vFAIL("Sequence (?... not terminated");
11171                 }
11172
11173                 /* FALLTHROUGH */
11174             case '=':           /* (?=...) */
11175                 RExC_seen_zerolen++;
11176                 break;
11177             case '!':           /* (?!...) */
11178                 RExC_seen_zerolen++;
11179                 /* check if we're really just a "FAIL" assertion */
11180                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11181                                         FALSE /* Don't force to /x */ );
11182                 if (*RExC_parse == ')') {
11183                     ret=reganode(pRExC_state, OPFAIL, 0);
11184                     nextchar(pRExC_state);
11185                     return ret;
11186                 }
11187                 break;
11188             case '|':           /* (?|...) */
11189                 /* branch reset, behave like a (?:...) except that
11190                    buffers in alternations share the same numbers */
11191                 paren = ':';
11192                 after_freeze = freeze_paren = RExC_npar;
11193                 break;
11194             case ':':           /* (?:...) */
11195             case '>':           /* (?>...) */
11196                 break;
11197             case '$':           /* (?$...) */
11198             case '@':           /* (?@...) */
11199                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
11200                 break;
11201             case '0' :           /* (?0) */
11202             case 'R' :           /* (?R) */
11203                 if (RExC_parse == RExC_end || *RExC_parse != ')')
11204                     FAIL("Sequence (?R) not terminated");
11205                 num = 0;
11206                 RExC_seen |= REG_RECURSE_SEEN;
11207                 *flagp |= POSTPONED;
11208                 goto gen_recurse_regop;
11209                 /*notreached*/
11210             /* named and numeric backreferences */
11211             case '&':            /* (?&NAME) */
11212                 parse_start = RExC_parse - 1;
11213               named_recursion:
11214                 {
11215                     SV *sv_dat = reg_scan_name(pRExC_state,
11216                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11217                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
11218                 }
11219                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
11220                     vFAIL("Sequence (?&... not terminated");
11221                 goto gen_recurse_regop;
11222                 /* NOTREACHED */
11223             case '+':
11224                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
11225                     RExC_parse++;
11226                     vFAIL("Illegal pattern");
11227                 }
11228                 goto parse_recursion;
11229                 /* NOTREACHED*/
11230             case '-': /* (?-1) */
11231                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
11232                     RExC_parse--; /* rewind to let it be handled later */
11233                     goto parse_flags;
11234                 }
11235                 /* FALLTHROUGH */
11236             case '1': case '2': case '3': case '4': /* (?1) */
11237             case '5': case '6': case '7': case '8': case '9':
11238                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
11239               parse_recursion:
11240                 {
11241                     bool is_neg = FALSE;
11242                     UV unum;
11243                     parse_start = RExC_parse - 1; /* MJD */
11244                     if (*RExC_parse == '-') {
11245                         RExC_parse++;
11246                         is_neg = TRUE;
11247                     }
11248                     endptr = RExC_end;
11249                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11250                         && unum <= I32_MAX
11251                     ) {
11252                         num = (I32)unum;
11253                         RExC_parse = (char*)endptr;
11254                     } else
11255                         num = I32_MAX;
11256                     if (is_neg) {
11257                         /* Some limit for num? */
11258                         num = -num;
11259                     }
11260                 }
11261                 if (*RExC_parse!=')')
11262                     vFAIL("Expecting close bracket");
11263
11264               gen_recurse_regop:
11265                 if ( paren == '-' ) {
11266                     /*
11267                     Diagram of capture buffer numbering.
11268                     Top line is the normal capture buffer numbers
11269                     Bottom line is the negative indexing as from
11270                     the X (the (?-2))
11271
11272                     +   1 2    3 4 5 X          6 7
11273                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11274                     -   5 4    3 2 1 X          x x
11275
11276                     */
11277                     num = RExC_npar + num;
11278                     if (num < 1)  {
11279                         RExC_parse++;
11280                         vFAIL("Reference to nonexistent group");
11281                     }
11282                 } else if ( paren == '+' ) {
11283                     num = RExC_npar + num - 1;
11284                 }
11285                 /* We keep track how many GOSUB items we have produced.
11286                    To start off the ARG2L() of the GOSUB holds its "id",
11287                    which is used later in conjunction with RExC_recurse
11288                    to calculate the offset we need to jump for the GOSUB,
11289                    which it will store in the final representation.
11290                    We have to defer the actual calculation until much later
11291                    as the regop may move.
11292                  */
11293
11294                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11295                 if (!SIZE_ONLY) {
11296                     if (num > (I32)RExC_rx->nparens) {
11297                         RExC_parse++;
11298                         vFAIL("Reference to nonexistent group");
11299                     }
11300                     RExC_recurse_count++;
11301                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11302                         "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11303                               22, "|    |", (int)(depth * 2 + 1), "",
11304                               (UV)ARG(ret), (IV)ARG2L(ret)));
11305                 }
11306                 RExC_seen |= REG_RECURSE_SEEN;
11307
11308                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
11309                 Set_Node_Offset(ret, parse_start); /* MJD */
11310
11311                 *flagp |= POSTPONED;
11312                 assert(*RExC_parse == ')');
11313                 nextchar(pRExC_state);
11314                 return ret;
11315
11316             /* NOTREACHED */
11317
11318             case '?':           /* (??...) */
11319                 is_logical = 1;
11320                 if (*RExC_parse != '{') {
11321                     RExC_parse += SKIP_IF_CHAR(RExC_parse);
11322                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11323                     vFAIL2utf8f(
11324                         "Sequence (%" UTF8f "...) not recognized",
11325                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11326                     NOT_REACHED; /*NOTREACHED*/
11327                 }
11328                 *flagp |= POSTPONED;
11329                 paren = '{';
11330                 RExC_parse++;
11331                 /* FALLTHROUGH */
11332             case '{':           /* (?{...}) */
11333             {
11334                 U32 n = 0;
11335                 struct reg_code_block *cb;
11336
11337                 RExC_seen_zerolen++;
11338
11339                 if (   !pRExC_state->code_blocks
11340                     || pRExC_state->code_index
11341                                         >= pRExC_state->code_blocks->count
11342                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11343                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11344                             - RExC_start)
11345                 ) {
11346                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11347                         FAIL("panic: Sequence (?{...}): no code block found\n");
11348                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11349                 }
11350                 /* this is a pre-compiled code block (?{...}) */
11351                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11352                 RExC_parse = RExC_start + cb->end;
11353                 if (!SIZE_ONLY) {
11354                     OP *o = cb->block;
11355                     if (cb->src_regex) {
11356                         n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11357                         RExC_rxi->data->data[n] =
11358                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
11359                         RExC_rxi->data->data[n+1] = (void*)o;
11360                     }
11361                     else {
11362                         n = add_data(pRExC_state,
11363                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11364                         RExC_rxi->data->data[n] = (void*)o;
11365                     }
11366                 }
11367                 pRExC_state->code_index++;
11368                 nextchar(pRExC_state);
11369
11370                 if (is_logical) {
11371                     regnode *eval;
11372                     ret = reg_node(pRExC_state, LOGICAL);
11373
11374                     eval = reg2Lanode(pRExC_state, EVAL,
11375                                        n,
11376
11377                                        /* for later propagation into (??{})
11378                                         * return value */
11379                                        RExC_flags & RXf_PMf_COMPILETIME
11380                                       );
11381                     if (!SIZE_ONLY) {
11382                         ret->flags = 2;
11383                     }
11384                     REGTAIL(pRExC_state, ret, eval);
11385                     /* deal with the length of this later - MJD */
11386                     return ret;
11387                 }
11388                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11389                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
11390                 Set_Node_Offset(ret, parse_start);
11391                 return ret;
11392             }
11393             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11394             {
11395                 int is_define= 0;
11396                 const int DEFINE_len = sizeof("DEFINE") - 1;
11397                 if (    RExC_parse < RExC_end - 1
11398                     && (   (       RExC_parse[0] == '?'        /* (?(?...)) */
11399                             && (   RExC_parse[1] == '='
11400                                 || RExC_parse[1] == '!'
11401                                 || RExC_parse[1] == '<'
11402                                 || RExC_parse[1] == '{'))
11403                         || (       RExC_parse[0] == '*'        /* (?(*...)) */
11404                             && (   memBEGINs(RExC_parse + 1,
11405                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11406                                          "pla:")
11407                                 || memBEGINs(RExC_parse + 1,
11408                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11409                                          "plb:")
11410                                 || memBEGINs(RExC_parse + 1,
11411                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11412                                          "nla:")
11413                                 || memBEGINs(RExC_parse + 1,
11414                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11415                                          "nlb:")
11416                                 || memBEGINs(RExC_parse + 1,
11417                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11418                                          "positive_lookahead:")
11419                                 || memBEGINs(RExC_parse + 1,
11420                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11421                                          "positive_lookbehind:")
11422                                 || memBEGINs(RExC_parse + 1,
11423                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11424                                          "negative_lookahead:")
11425                                 || memBEGINs(RExC_parse + 1,
11426                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11427                                          "negative_lookbehind:"))))
11428                 ) { /* Lookahead or eval. */
11429                     I32 flag;
11430                     regnode *tail;
11431
11432                     ret = reg_node(pRExC_state, LOGICAL);
11433                     if (!SIZE_ONLY)
11434                         ret->flags = 1;
11435
11436                     tail = reg(pRExC_state, 1, &flag, depth+1);
11437                     RETURN_NULL_ON_RESTART(flag,flagp);
11438                     REGTAIL(pRExC_state, ret, tail);
11439                     goto insert_if;
11440                 }
11441                 else if (   RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11442                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11443                 {
11444                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11445                     char *name_start= RExC_parse++;
11446                     U32 num = 0;
11447                     SV *sv_dat=reg_scan_name(pRExC_state,
11448                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11449                     if (   RExC_parse == name_start
11450                         || RExC_parse >= RExC_end
11451                         || *RExC_parse != ch)
11452                     {
11453                         vFAIL2("Sequence (?(%c... not terminated",
11454                             (ch == '>' ? '<' : ch));
11455                     }
11456                     RExC_parse++;
11457                     if (!SIZE_ONLY) {
11458                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11459                         RExC_rxi->data->data[num]=(void*)sv_dat;
11460                         SvREFCNT_inc_simple_void(sv_dat);
11461                     }
11462                     ret = reganode(pRExC_state,NGROUPP,num);
11463                     goto insert_if_check_paren;
11464                 }
11465                 else if (memBEGINs(RExC_parse,
11466                                    (STRLEN) (RExC_end - RExC_parse),
11467                                    "DEFINE"))
11468                 {
11469                     ret = reganode(pRExC_state,DEFINEP,0);
11470                     RExC_parse += DEFINE_len;
11471                     is_define = 1;
11472                     goto insert_if_check_paren;
11473                 }
11474                 else if (RExC_parse[0] == 'R') {
11475                     RExC_parse++;
11476                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11477                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11478                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11479                      */
11480                     parno = 0;
11481                     if (RExC_parse[0] == '0') {
11482                         parno = 1;
11483                         RExC_parse++;
11484                     }
11485                     else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11486                         UV uv;
11487                         endptr = RExC_end;
11488                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11489                             && uv <= I32_MAX
11490                         ) {
11491                             parno = (I32)uv + 1;
11492                             RExC_parse = (char*)endptr;
11493                         }
11494                         /* else "Switch condition not recognized" below */
11495                     } else if (RExC_parse[0] == '&') {
11496                         SV *sv_dat;
11497                         RExC_parse++;
11498                         sv_dat = reg_scan_name(pRExC_state,
11499                             SIZE_ONLY
11500                             ? REG_RSN_RETURN_NULL
11501                             : REG_RSN_RETURN_DATA);
11502
11503                         /* we should only have a false sv_dat when
11504                          * SIZE_ONLY is true, and we always have false
11505                          * sv_dat when SIZE_ONLY is true.
11506                          * reg_scan_name() will VFAIL() if the name is
11507                          * unknown when SIZE_ONLY is false, and otherwise
11508                          * will return something, and when SIZE_ONLY is
11509                          * true, reg_scan_name() just parses the string,
11510                          * and doesnt return anything. (in theory) */
11511                         assert(SIZE_ONLY ? !sv_dat : !!sv_dat);
11512
11513                         if (sv_dat)
11514                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11515                     }
11516                     ret = reganode(pRExC_state,INSUBP,parno);
11517                     goto insert_if_check_paren;
11518                 }
11519                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11520                     /* (?(1)...) */
11521                     char c;
11522                     UV uv;
11523                     endptr = RExC_end;
11524                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11525                         && uv <= I32_MAX
11526                     ) {
11527                         parno = (I32)uv;
11528                         RExC_parse = (char*)endptr;
11529                     }
11530                     else {
11531                         vFAIL("panic: grok_atoUV returned FALSE");
11532                     }
11533                     ret = reganode(pRExC_state, GROUPP, parno);
11534
11535                  insert_if_check_paren:
11536                     if (UCHARAT(RExC_parse) != ')') {
11537                         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11538                         vFAIL("Switch condition not recognized");
11539                     }
11540                     nextchar(pRExC_state);
11541                   insert_if:
11542                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
11543                     br = regbranch(pRExC_state, &flags, 1,depth+1);
11544                     if (br == NULL) {
11545                         RETURN_NULL_ON_RESTART(flags,flagp);
11546                         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11547                               (UV) flags);
11548                     } else
11549                         REGTAIL(pRExC_state, br, reganode(pRExC_state,
11550                                                           LONGJMP, 0));
11551                     c = UCHARAT(RExC_parse);
11552                     nextchar(pRExC_state);
11553                     if (flags&HASWIDTH)
11554                         *flagp |= HASWIDTH;
11555                     if (c == '|') {
11556                         if (is_define)
11557                             vFAIL("(?(DEFINE)....) does not allow branches");
11558
11559                         /* Fake one for optimizer.  */
11560                         lastbr = reganode(pRExC_state, IFTHEN, 0);
11561
11562                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
11563                             RETURN_NULL_ON_RESTART(flags,flagp);
11564                             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11565                                   (UV) flags);
11566                         }
11567                         REGTAIL(pRExC_state, ret, lastbr);
11568                         if (flags&HASWIDTH)
11569                             *flagp |= HASWIDTH;
11570                         c = UCHARAT(RExC_parse);
11571                         nextchar(pRExC_state);
11572                     }
11573                     else
11574                         lastbr = NULL;
11575                     if (c != ')') {
11576                         if (RExC_parse >= RExC_end)
11577                             vFAIL("Switch (?(condition)... not terminated");
11578                         else
11579                             vFAIL("Switch (?(condition)... contains too many branches");
11580                     }
11581                     ender = reg_node(pRExC_state, TAIL);
11582                     REGTAIL(pRExC_state, br, ender);
11583                     if (lastbr) {
11584                         REGTAIL(pRExC_state, lastbr, ender);
11585                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11586                     }
11587                     else
11588                         REGTAIL(pRExC_state, ret, ender);
11589                     RExC_size++; /* XXX WHY do we need this?!!
11590                                     For large programs it seems to be required
11591                                     but I can't figure out why. -- dmq*/
11592                     return ret;
11593                 }
11594                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11595                 vFAIL("Unknown switch condition (?(...))");
11596             }
11597             case '[':           /* (?[ ... ]) */
11598                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
11599                                          oregcomp_parse);
11600             case 0: /* A NUL */
11601                 RExC_parse--; /* for vFAIL to print correctly */
11602                 vFAIL("Sequence (? incomplete");
11603                 break;
11604             default: /* e.g., (?i) */
11605                 RExC_parse = (char *) seqstart + 1;
11606               parse_flags:
11607                 parse_lparen_question_flags(pRExC_state);
11608                 if (UCHARAT(RExC_parse) != ':') {
11609                     if (RExC_parse < RExC_end)
11610                         nextchar(pRExC_state);
11611                     *flagp = TRYAGAIN;
11612                     return NULL;
11613                 }
11614                 paren = ':';
11615                 nextchar(pRExC_state);
11616                 ret = NULL;
11617                 goto parse_rest;
11618             } /* end switch */
11619         }
11620         else {
11621             if (*RExC_parse == '{' && PASS2) {
11622                 ckWARNregdep(RExC_parse + 1,
11623                             "Unescaped left brace in regex is "
11624                             "deprecated here (and will be fatal "
11625                             "in Perl 5.32), passed through");
11626             }
11627             /* Not bothering to indent here, as the above 'else' is temporary
11628              * */
11629         if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
11630           capturing_parens:
11631             parno = RExC_npar;
11632             RExC_npar++;
11633
11634             ret = reganode(pRExC_state, OPEN, parno);
11635             if (!SIZE_ONLY ){
11636                 if (!RExC_nestroot)
11637                     RExC_nestroot = parno;
11638                 if (RExC_open_parens && !RExC_open_parens[parno])
11639                 {
11640                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11641                         "%*s%*s Setting open paren #%" IVdf " to %d\n",
11642                         22, "|    |", (int)(depth * 2 + 1), "",
11643                         (IV)parno, REG_NODE_NUM(ret)));
11644                     RExC_open_parens[parno]= ret;
11645                 }
11646             }
11647             Set_Node_Length(ret, 1); /* MJD */
11648             Set_Node_Offset(ret, RExC_parse); /* MJD */
11649             is_open = 1;
11650         } else {
11651             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
11652             paren = ':';
11653             ret = NULL;
11654         }
11655         }
11656     }
11657     else                        /* ! paren */
11658         ret = NULL;
11659
11660    parse_rest:
11661     /* Pick up the branches, linking them together. */
11662     parse_start = RExC_parse;   /* MJD */
11663     br = regbranch(pRExC_state, &flags, 1,depth+1);
11664
11665     /*     branch_len = (paren != 0); */
11666
11667     if (br == NULL) {
11668         RETURN_NULL_ON_RESTART(flags,flagp);
11669         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11670     }
11671     if (*RExC_parse == '|') {
11672         if (!SIZE_ONLY && RExC_extralen) {
11673             reginsert(pRExC_state, BRANCHJ, br, depth+1);
11674         }
11675         else {                  /* MJD */
11676             reginsert(pRExC_state, BRANCH, br, depth+1);
11677             Set_Node_Length(br, paren != 0);
11678             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
11679         }
11680         have_branch = 1;
11681         if (SIZE_ONLY)
11682             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
11683     }
11684     else if (paren == ':') {
11685         *flagp |= flags&SIMPLE;
11686     }
11687     if (is_open) {                              /* Starts with OPEN. */
11688         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
11689     }
11690     else if (paren != '?')              /* Not Conditional */
11691         ret = br;
11692     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11693     lastbr = br;
11694     while (*RExC_parse == '|') {
11695         if (!SIZE_ONLY && RExC_extralen) {
11696             ender = reganode(pRExC_state, LONGJMP,0);
11697
11698             /* Append to the previous. */
11699             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11700         }
11701         if (SIZE_ONLY)
11702             RExC_extralen += 2;         /* Account for LONGJMP. */
11703         nextchar(pRExC_state);
11704         if (freeze_paren) {
11705             if (RExC_npar > after_freeze)
11706                 after_freeze = RExC_npar;
11707             RExC_npar = freeze_paren;
11708         }
11709         br = regbranch(pRExC_state, &flags, 0, depth+1);
11710
11711         if (br == NULL) {
11712             RETURN_NULL_ON_RESTART(flags,flagp);
11713             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11714         }
11715         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
11716         lastbr = br;
11717         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11718     }
11719
11720     if (have_branch || paren != ':') {
11721         /* Make a closing node, and hook it on the end. */
11722         switch (paren) {
11723         case ':':
11724             ender = reg_node(pRExC_state, TAIL);
11725             break;
11726         case 1: case 2:
11727             ender = reganode(pRExC_state, CLOSE, parno);
11728             if ( RExC_close_parens ) {
11729                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11730                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
11731                         22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
11732                 RExC_close_parens[parno]= ender;
11733                 if (RExC_nestroot == parno)
11734                     RExC_nestroot = 0;
11735             }
11736             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
11737             Set_Node_Length(ender,1); /* MJD */
11738             break;
11739         case 's':
11740             ender = reg_node(pRExC_state, SRCLOSE);
11741             RExC_in_script_run = 0;
11742             break;
11743         case '<':
11744         case 'a':
11745         case 'A':
11746         case 'b':
11747         case 'B':
11748         case ',':
11749         case '=':
11750         case '!':
11751             *flagp &= ~HASWIDTH;
11752             /* FALLTHROUGH */
11753         case 't':   /* aTomic */
11754         case '>':
11755             ender = reg_node(pRExC_state, SUCCEED);
11756             break;
11757         case 0:
11758             ender = reg_node(pRExC_state, END);
11759             if (!SIZE_ONLY) {
11760                 assert(!RExC_end_op); /* there can only be one! */
11761                 RExC_end_op = ender;
11762                 if (RExC_close_parens) {
11763                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11764                         "%*s%*s Setting close paren #0 (END) to %d\n",
11765                         22, "|    |", (int)(depth * 2 + 1), "", REG_NODE_NUM(ender)));
11766
11767                     RExC_close_parens[0]= ender;
11768                 }
11769             }
11770             break;
11771         }
11772         DEBUG_PARSE_r(if (!SIZE_ONLY) {
11773             DEBUG_PARSE_MSG("lsbr");
11774             regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
11775             regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11776             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11777                           SvPV_nolen_const(RExC_mysv1),
11778                           (IV)REG_NODE_NUM(lastbr),
11779                           SvPV_nolen_const(RExC_mysv2),
11780                           (IV)REG_NODE_NUM(ender),
11781                           (IV)(ender - lastbr)
11782             );
11783         });
11784         REGTAIL(pRExC_state, lastbr, ender);
11785
11786         if (have_branch && !SIZE_ONLY) {
11787             char is_nothing= 1;
11788             if (depth==1)
11789                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
11790
11791             /* Hook the tails of the branches to the closing node. */
11792             for (br = ret; br; br = regnext(br)) {
11793                 const U8 op = PL_regkind[OP(br)];
11794                 if (op == BRANCH) {
11795                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
11796                     if ( OP(NEXTOPER(br)) != NOTHING
11797                          || regnext(NEXTOPER(br)) != ender)
11798                         is_nothing= 0;
11799                 }
11800                 else if (op == BRANCHJ) {
11801                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
11802                     /* for now we always disable this optimisation * /
11803                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
11804                          || regnext(NEXTOPER(NEXTOPER(br))) != ender)
11805                     */
11806                         is_nothing= 0;
11807                 }
11808             }
11809             if (is_nothing) {
11810                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
11811                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
11812                     DEBUG_PARSE_MSG("NADA");
11813                     regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
11814                     regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11815                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11816                                   SvPV_nolen_const(RExC_mysv1),
11817                                   (IV)REG_NODE_NUM(ret),
11818                                   SvPV_nolen_const(RExC_mysv2),
11819                                   (IV)REG_NODE_NUM(ender),
11820                                   (IV)(ender - ret)
11821                     );
11822                 });
11823                 OP(br)= NOTHING;
11824                 if (OP(ender) == TAIL) {
11825                     NEXT_OFF(br)= 0;
11826                     RExC_emit= br + 1;
11827                 } else {
11828                     regnode *opt;
11829                     for ( opt= br + 1; opt < ender ; opt++ )
11830                         OP(opt)= OPTIMIZED;
11831                     NEXT_OFF(br)= ender - br;
11832                 }
11833             }
11834         }
11835     }
11836
11837     {
11838         const char *p;
11839          /* Even/odd or x=don't care: 010101x10x */
11840         static const char parens[] = "=!aA<,>Bbt";
11841          /* flag below is set to 0 up through 'A'; 1 for larger */
11842
11843         if (paren && (p = strchr(parens, paren))) {
11844             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
11845             int flag = (p - parens) > 3;
11846
11847             if (paren == '>' || paren == 't') {
11848                 node = SUSPEND, flag = 0;
11849             }
11850
11851             reginsert(pRExC_state, node,ret, depth+1);
11852             Set_Node_Cur_Length(ret, parse_start);
11853             Set_Node_Offset(ret, parse_start + 1);
11854             ret->flags = flag;
11855             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
11856         }
11857     }
11858
11859     /* Check for proper termination. */
11860     if (paren) {
11861         /* restore original flags, but keep (?p) and, if we've changed from /d
11862          * rules to /u, keep the /u */
11863         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
11864         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
11865             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
11866         }
11867         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
11868             RExC_parse = oregcomp_parse;
11869             vFAIL("Unmatched (");
11870         }
11871         nextchar(pRExC_state);
11872     }
11873     else if (!paren && RExC_parse < RExC_end) {
11874         if (*RExC_parse == ')') {
11875             RExC_parse++;
11876             vFAIL("Unmatched )");
11877         }
11878         else
11879             FAIL("Junk on end of regexp");      /* "Can't happen". */
11880         NOT_REACHED; /* NOTREACHED */
11881     }
11882
11883     if (RExC_in_lookbehind) {
11884         RExC_in_lookbehind--;
11885     }
11886     if (after_freeze > RExC_npar)
11887         RExC_npar = after_freeze;
11888     return(ret);
11889 }
11890
11891 /*
11892  - regbranch - one alternative of an | operator
11893  *
11894  * Implements the concatenation operator.
11895  *
11896  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11897  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11898  */
11899 STATIC regnode *
11900 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
11901 {
11902     regnode *ret;
11903     regnode *chain = NULL;
11904     regnode *latest;
11905     I32 flags = 0, c = 0;
11906     GET_RE_DEBUG_FLAGS_DECL;
11907
11908     PERL_ARGS_ASSERT_REGBRANCH;
11909
11910     DEBUG_PARSE("brnc");
11911
11912     if (first)
11913         ret = NULL;
11914     else {
11915         if (!SIZE_ONLY && RExC_extralen)
11916             ret = reganode(pRExC_state, BRANCHJ,0);
11917         else {
11918             ret = reg_node(pRExC_state, BRANCH);
11919             Set_Node_Length(ret, 1);
11920         }
11921     }
11922
11923     if (!first && SIZE_ONLY)
11924         RExC_extralen += 1;                     /* BRANCHJ */
11925
11926     *flagp = WORST;                     /* Tentatively. */
11927
11928     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11929                             FALSE /* Don't force to /x */ );
11930     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
11931         flags &= ~TRYAGAIN;
11932         latest = regpiece(pRExC_state, &flags,depth+1);
11933         if (latest == NULL) {
11934             if (flags & TRYAGAIN)
11935                 continue;
11936             RETURN_NULL_ON_RESTART(flags,flagp);
11937             FAIL2("panic: regpiece returned NULL, flags=%#" UVxf, (UV) flags);
11938         }
11939         else if (ret == NULL)
11940             ret = latest;
11941         *flagp |= flags&(HASWIDTH|POSTPONED);
11942         if (chain == NULL)      /* First piece. */
11943             *flagp |= flags&SPSTART;
11944         else {
11945             /* FIXME adding one for every branch after the first is probably
11946              * excessive now we have TRIE support. (hv) */
11947             MARK_NAUGHTY(1);
11948             REGTAIL(pRExC_state, chain, latest);
11949         }
11950         chain = latest;
11951         c++;
11952     }
11953     if (chain == NULL) {        /* Loop ran zero times. */
11954         chain = reg_node(pRExC_state, NOTHING);
11955         if (ret == NULL)
11956             ret = chain;
11957     }
11958     if (c == 1) {
11959         *flagp |= flags&SIMPLE;
11960     }
11961
11962     return ret;
11963 }
11964
11965 /*
11966  - regpiece - something followed by possible quantifier * + ? {n,m}
11967  *
11968  * Note that the branching code sequences used for ? and the general cases
11969  * of * and + are somewhat optimized:  they use the same NOTHING node as
11970  * both the endmarker for their branch list and the body of the last branch.
11971  * It might seem that this node could be dispensed with entirely, but the
11972  * endmarker role is not redundant.
11973  *
11974  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
11975  * TRYAGAIN.
11976  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11977  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11978  */
11979 STATIC regnode *
11980 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11981 {
11982     regnode *ret;
11983     char op;
11984     char *next;
11985     I32 flags;
11986     const char * const origparse = RExC_parse;
11987     I32 min;
11988     I32 max = REG_INFTY;
11989 #ifdef RE_TRACK_PATTERN_OFFSETS
11990     char *parse_start;
11991 #endif
11992     const char *maxpos = NULL;
11993     UV uv;
11994
11995     /* Save the original in case we change the emitted regop to a FAIL. */
11996     regnode * const orig_emit = RExC_emit;
11997
11998     GET_RE_DEBUG_FLAGS_DECL;
11999
12000     PERL_ARGS_ASSERT_REGPIECE;
12001
12002     DEBUG_PARSE("piec");
12003
12004     ret = regatom(pRExC_state, &flags,depth+1);
12005     if (ret == NULL) {
12006         RETURN_NULL_ON_RESTART_OR_FLAGS(flags,flagp,TRYAGAIN);
12007         FAIL2("panic: regatom returned NULL, flags=%#" UVxf, (UV) flags);
12008     }
12009
12010     op = *RExC_parse;
12011
12012     if (op == '{' && regcurly(RExC_parse)) {
12013         maxpos = NULL;
12014 #ifdef RE_TRACK_PATTERN_OFFSETS
12015         parse_start = RExC_parse; /* MJD */
12016 #endif
12017         next = RExC_parse + 1;
12018         while (isDIGIT(*next) || *next == ',') {
12019             if (*next == ',') {
12020                 if (maxpos)
12021                     break;
12022                 else
12023                     maxpos = next;
12024             }
12025             next++;
12026         }
12027         if (*next == '}') {             /* got one */
12028             const char* endptr;
12029             if (!maxpos)
12030                 maxpos = next;
12031             RExC_parse++;
12032             if (isDIGIT(*RExC_parse)) {
12033                 endptr = RExC_end;
12034                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
12035                     vFAIL("Invalid quantifier in {,}");
12036                 if (uv >= REG_INFTY)
12037                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12038                 min = (I32)uv;
12039             } else {
12040                 min = 0;
12041             }
12042             if (*maxpos == ',')
12043                 maxpos++;
12044             else
12045                 maxpos = RExC_parse;
12046             if (isDIGIT(*maxpos)) {
12047                 endptr = RExC_end;
12048                 if (!grok_atoUV(maxpos, &uv, &endptr))
12049                     vFAIL("Invalid quantifier in {,}");
12050                 if (uv >= REG_INFTY)
12051                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12052                 max = (I32)uv;
12053             } else {
12054                 max = REG_INFTY;                /* meaning "infinity" */
12055             }
12056             RExC_parse = next;
12057             nextchar(pRExC_state);
12058             if (max < min) {    /* If can't match, warn and optimize to fail
12059                                    unconditionally */
12060                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
12061                 if (PASS2) {
12062                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
12063                     NEXT_OFF(orig_emit)= regarglen[OPFAIL] + NODE_STEP_REGNODE;
12064                 }
12065                 return ret;
12066             }
12067             else if (min == max && *RExC_parse == '?')
12068             {
12069                 if (PASS2) {
12070                     ckWARN2reg(RExC_parse + 1,
12071                                "Useless use of greediness modifier '%c'",
12072                                *RExC_parse);
12073                 }
12074             }
12075
12076           do_curly:
12077             if ((flags&SIMPLE)) {
12078                 if (min == 0 && max == REG_INFTY) {
12079                     reginsert(pRExC_state, STAR, ret, depth+1);
12080                     MARK_NAUGHTY(4);
12081                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12082                     goto nest_check;
12083                 }
12084                 if (min == 1 && max == REG_INFTY) {
12085                     reginsert(pRExC_state, PLUS, ret, depth+1);
12086                     MARK_NAUGHTY(3);
12087                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12088                     goto nest_check;
12089                 }
12090                 MARK_NAUGHTY_EXP(2, 2);
12091                 reginsert(pRExC_state, CURLY, ret, depth+1);
12092                 Set_Node_Offset(ret, parse_start+1); /* MJD */
12093                 Set_Node_Cur_Length(ret, parse_start);
12094             }
12095             else {
12096                 regnode * const w = reg_node(pRExC_state, WHILEM);
12097
12098                 w->flags = 0;
12099                 REGTAIL(pRExC_state, ret, w);
12100                 if (!SIZE_ONLY && RExC_extralen) {
12101                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
12102                     reginsert(pRExC_state, NOTHING,ret, depth+1);
12103                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
12104                 }
12105                 reginsert(pRExC_state, CURLYX,ret, depth+1);
12106                                 /* MJD hk */
12107                 Set_Node_Offset(ret, parse_start+1);
12108                 Set_Node_Length(ret,
12109                                 op == '{' ? (RExC_parse - parse_start) : 1);
12110
12111                 if (!SIZE_ONLY && RExC_extralen)
12112                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
12113                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
12114                 if (SIZE_ONLY)
12115                     RExC_whilem_seen++, RExC_extralen += 3;
12116                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
12117             }
12118             ret->flags = 0;
12119
12120             if (min > 0)
12121                 *flagp = WORST;
12122             if (max > 0)
12123                 *flagp |= HASWIDTH;
12124             if (!SIZE_ONLY) {
12125                 ARG1_SET(ret, (U16)min);
12126                 ARG2_SET(ret, (U16)max);
12127             }
12128             if (max == REG_INFTY)
12129                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12130
12131             goto nest_check;
12132         }
12133     }
12134
12135     if (!ISMULT1(op)) {
12136         *flagp = flags;
12137         return(ret);
12138     }
12139
12140 #if 0                           /* Now runtime fix should be reliable. */
12141
12142     /* if this is reinstated, don't forget to put this back into perldiag:
12143
12144             =item Regexp *+ operand could be empty at {#} in regex m/%s/
12145
12146            (F) The part of the regexp subject to either the * or + quantifier
12147            could match an empty string. The {#} shows in the regular
12148            expression about where the problem was discovered.
12149
12150     */
12151
12152     if (!(flags&HASWIDTH) && op != '?')
12153       vFAIL("Regexp *+ operand could be empty");
12154 #endif
12155
12156 #ifdef RE_TRACK_PATTERN_OFFSETS
12157     parse_start = RExC_parse;
12158 #endif
12159     nextchar(pRExC_state);
12160
12161     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
12162
12163     if (op == '*') {
12164         min = 0;
12165         goto do_curly;
12166     }
12167     else if (op == '+') {
12168         min = 1;
12169         goto do_curly;
12170     }
12171     else if (op == '?') {
12172         min = 0; max = 1;
12173         goto do_curly;
12174     }
12175   nest_check:
12176     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
12177         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12178         ckWARN2reg(RExC_parse,
12179                    "%" UTF8f " matches null string many times",
12180                    UTF8fARG(UTF, (RExC_parse >= origparse
12181                                  ? RExC_parse - origparse
12182                                  : 0),
12183                    origparse));
12184         (void)ReREFCNT_inc(RExC_rx_sv);
12185     }
12186
12187     if (*RExC_parse == '?') {
12188         nextchar(pRExC_state);
12189         reginsert(pRExC_state, MINMOD, ret, depth+1);
12190         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
12191     }
12192     else if (*RExC_parse == '+') {
12193         regnode *ender;
12194         nextchar(pRExC_state);
12195         ender = reg_node(pRExC_state, SUCCEED);
12196         REGTAIL(pRExC_state, ret, ender);
12197         reginsert(pRExC_state, SUSPEND, ret, depth+1);
12198         ender = reg_node(pRExC_state, TAIL);
12199         REGTAIL(pRExC_state, ret, ender);
12200     }
12201
12202     if (ISMULT2(RExC_parse)) {
12203         RExC_parse++;
12204         vFAIL("Nested quantifiers");
12205     }
12206
12207     return(ret);
12208 }
12209
12210 STATIC bool
12211 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
12212                 regnode ** node_p,
12213                 UV * code_point_p,
12214                 int * cp_count,
12215                 I32 * flagp,
12216                 const bool strict,
12217                 const U32 depth
12218     )
12219 {
12220  /* This routine teases apart the various meanings of \N and returns
12221   * accordingly.  The input parameters constrain which meaning(s) is/are valid
12222   * in the current context.
12223   *
12224   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
12225   *
12226   * If <code_point_p> is not NULL, the context is expecting the result to be a
12227   * single code point.  If this \N instance turns out to a single code point,
12228   * the function returns TRUE and sets *code_point_p to that code point.
12229   *
12230   * If <node_p> is not NULL, the context is expecting the result to be one of
12231   * the things representable by a regnode.  If this \N instance turns out to be
12232   * one such, the function generates the regnode, returns TRUE and sets *node_p
12233   * to point to that regnode.
12234   *
12235   * If this instance of \N isn't legal in any context, this function will
12236   * generate a fatal error and not return.
12237   *
12238   * On input, RExC_parse should point to the first char following the \N at the
12239   * time of the call.  On successful return, RExC_parse will have been updated
12240   * to point to just after the sequence identified by this routine.  Also
12241   * *flagp has been updated as needed.
12242   *
12243   * When there is some problem with the current context and this \N instance,
12244   * the function returns FALSE, without advancing RExC_parse, nor setting
12245   * *node_p, nor *code_point_p, nor *flagp.
12246   *
12247   * If <cp_count> is not NULL, the caller wants to know the length (in code
12248   * points) that this \N sequence matches.  This is set, and the input is
12249   * parsed for errors, even if the function returns FALSE, as detailed below.
12250   *
12251   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
12252   *
12253   * Probably the most common case is for the \N to specify a single code point.
12254   * *cp_count will be set to 1, and *code_point_p will be set to that code
12255   * point.
12256   *
12257   * Another possibility is for the input to be an empty \N{}, which for
12258   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
12259   * will be set to a generated NOTHING node.
12260   *
12261   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
12262   * set to 0. *node_p will be set to a generated REG_ANY node.
12263   *
12264   * The fourth possibility is that \N resolves to a sequence of more than one
12265   * code points.  *cp_count will be set to the number of code points in the
12266   * sequence. *node_p * will be set to a generated node returned by this
12267   * function calling S_reg().
12268   *
12269   * The final possibility is that it is premature to be calling this function;
12270   * that pass1 needs to be restarted.  This can happen when this changes from
12271   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
12272   * latter occurs only when the fourth possibility would otherwise be in
12273   * effect, and is because one of those code points requires the pattern to be
12274   * recompiled as UTF-8.  The function returns FALSE, and sets the
12275   * RESTART_PASS1 and NEED_UTF8 flags in *flagp, as appropriate.  When this
12276   * happens, the caller needs to desist from continuing parsing, and return
12277   * this information to its caller.  This is not set for when there is only one
12278   * code point, as this can be called as part of an ANYOF node, and they can
12279   * store above-Latin1 code points without the pattern having to be in UTF-8.
12280   *
12281   * For non-single-quoted regexes, the tokenizer has resolved character and
12282   * sequence names inside \N{...} into their Unicode values, normalizing the
12283   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
12284   * hex-represented code points in the sequence.  This is done there because
12285   * the names can vary based on what charnames pragma is in scope at the time,
12286   * so we need a way to take a snapshot of what they resolve to at the time of
12287   * the original parse. [perl #56444].
12288   *
12289   * That parsing is skipped for single-quoted regexes, so we may here get
12290   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
12291   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
12292   * is legal and handled here.  The code point is Unicode, and has to be
12293   * translated into the native character set for non-ASCII platforms.
12294   */
12295
12296     char * endbrace;    /* points to '}' following the name */
12297     char* p = RExC_parse; /* Temporary */
12298
12299     SV * substitute_parse = NULL;
12300     char *orig_end;
12301     char *save_start;
12302     I32 flags;
12303     Size_t count = 0;   /* code point count kept internally by this function */
12304
12305     GET_RE_DEBUG_FLAGS_DECL;
12306
12307     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12308
12309     GET_RE_DEBUG_FLAGS;
12310
12311     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12312     assert(! (node_p && cp_count));               /* At most 1 should be set */
12313
12314     if (cp_count) {     /* Initialize return for the most common case */
12315         *cp_count = 1;
12316     }
12317
12318     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12319      * modifier.  The other meanings do not, so use a temporary until we find
12320      * out which we are being called with */
12321     skip_to_be_ignored_text(pRExC_state, &p,
12322                             FALSE /* Don't force to /x */ );
12323
12324     /* Disambiguate between \N meaning a named character versus \N meaning
12325      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12326      * quantifier, or there is no '{' at all */
12327     if (*p != '{' || regcurly(p)) {
12328         RExC_parse = p;
12329         if (cp_count) {
12330             *cp_count = -1;
12331         }
12332
12333         if (! node_p) {
12334             return FALSE;
12335         }
12336
12337         *node_p = reg_node(pRExC_state, REG_ANY);
12338         *flagp |= HASWIDTH|SIMPLE;
12339         MARK_NAUGHTY(1);
12340         Set_Node_Length(*node_p, 1); /* MJD */
12341         return TRUE;
12342     }
12343
12344     /* The test above made sure that the next real character is a '{', but
12345      * under the /x modifier, it could be separated by space (or a comment and
12346      * \n) and this is not allowed (for consistency with \x{...} and the
12347      * tokenizer handling of \N{NAME}). */
12348     if (*RExC_parse != '{') {
12349         vFAIL("Missing braces on \\N{}");
12350     }
12351
12352     RExC_parse++;       /* Skip past the '{' */
12353
12354     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12355     if (! endbrace) { /* no trailing brace */
12356         vFAIL2("Missing right brace on \\%c{}", 'N');
12357     }
12358
12359     /* Here, we have decided it should be a named character or sequence */
12360     REQUIRE_UNI_RULES(flagp, FALSE); /* Unicode named chars imply Unicode
12361                                         semantics */
12362
12363     if (endbrace == RExC_parse) {   /* empty: \N{} */
12364         if (strict) {
12365             RExC_parse++;   /* Position after the "}" */
12366             vFAIL("Zero length \\N{}");
12367         }
12368         if (cp_count) {
12369             *cp_count = 0;
12370         }
12371         nextchar(pRExC_state);
12372         if (! node_p) {
12373             return FALSE;
12374         }
12375
12376         *node_p = reg_node(pRExC_state,NOTHING);
12377         return TRUE;
12378     }
12379
12380     /* If we haven't got something that begins with 'U+', then it didn't get lexed. */
12381     if (   endbrace - RExC_parse < 2
12382         || strnNE(RExC_parse, "U+", 2))
12383     {
12384         RExC_parse = endbrace;  /* position msg's '<--HERE' */
12385         vFAIL("\\N{NAME} must be resolved by the lexer");
12386     }
12387
12388         /* This code purposely indented below because of future changes coming */
12389
12390         /* We can get to here when the input is \N{U+...} or when toke.c has
12391          * converted a name to the \N{U+...} form.  This include changing a
12392          * name that evaluates to multiple code points to \N{U+c1.c2.c3 ...} */
12393
12394         RExC_parse += 2;    /* Skip past the 'U+' */
12395
12396         /* Code points are separated by dots.  The '}' terminates the whole
12397          * thing. */
12398
12399         do {    /* Loop until the ending brace */
12400             UV cp = 0;
12401             char * start_digit;     /* The first of the current code point */
12402             if (! isXDIGIT(*RExC_parse)) {
12403                 RExC_parse++;
12404                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
12405             }
12406
12407             start_digit = RExC_parse;
12408             count++;
12409
12410             /* Loop through the hex digits of the current code point */
12411             do {
12412                 /* Adding this digit will shift the result 4 bits.  If that
12413                  * result would be above IV_MAX, it's overflow */
12414                 if (cp > IV_MAX >> 4) {
12415
12416                     /* Find the end of the code point */
12417                     do {
12418                         RExC_parse ++;
12419                     } while (isXDIGIT(*RExC_parse) || *RExC_parse == '_');
12420
12421                     /* Be sure to synchronize this message with the similar one
12422                      * in utf8.c */
12423                     vFAIL4("Use of code point 0x%.*s is not allowed; the"
12424                         " permissible max is 0x%" UVxf,
12425                         (int) (RExC_parse - start_digit), start_digit, IV_MAX);
12426                 }
12427
12428                 /* Accumulate this (valid) digit into the running total */
12429                 cp  = (cp << 4) + READ_XDIGIT(RExC_parse);
12430
12431                 /* READ_XDIGIT advanced the input pointer.  Ignore a single
12432                  * underscore separator */
12433                 if (*RExC_parse == '_' && isXDIGIT(RExC_parse[1])) {
12434                     RExC_parse++;
12435                 }
12436             } while (isXDIGIT(*RExC_parse));
12437
12438             /* Here, have accumulated the next code point */
12439             if (RExC_parse >= endbrace) {   /* If done ... */
12440                 if (count != 1) {
12441                     goto do_concat;
12442                 }
12443
12444                 /* Here, is a single code point; fail if doesn't want that */
12445                 if (! code_point_p) {
12446                     RExC_parse = p;
12447                     return FALSE;
12448                 }
12449
12450                 /* A single code point is easy to handle; just return it */
12451                 *code_point_p = UNI_TO_NATIVE(cp);
12452                 RExC_parse = endbrace;
12453                 nextchar(pRExC_state);
12454                 return TRUE;
12455             }
12456
12457             /* Here, the only legal thing would be a multiple character
12458              * sequence (of the form "\N{U+c1.c2. ... }".   So the next
12459              * character must be a dot (and the one after that can't be the
12460              * endbrace, or we'd have something like \N{U+100.} ) */
12461             if (*RExC_parse != '.' || RExC_parse + 1 >= endbrace) {
12462                 RExC_parse += (RExC_orig_utf8)  /* point to after 1st invalid */
12463                                 ? UTF8SKIP(RExC_parse)
12464                                 : 1;
12465                 if (RExC_parse >= endbrace) { /* Guard against malformed utf8 */
12466                     RExC_parse = endbrace;
12467                 }
12468                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
12469             }
12470
12471             /* Here, looks like its really a multiple character sequence.  Fail
12472              * if that's not what the caller wants.  But continue with counting
12473              * and error checking if they still want a count */
12474             if (! node_p && ! cp_count) {
12475                 return FALSE;
12476             }
12477
12478             /* What is done here is to convert this to a sub-pattern of the
12479              * form \x{char1}\x{char2}...  and then call reg recursively to
12480              * parse it (enclosing in "(?: ... )" ).  That way, it retains its
12481              * atomicness, while not having to worry about special handling
12482              * that some code points may have.  We don't create a subpattern,
12483              * but go through the motions of code point counting and error
12484              * checking, if the caller doesn't want a node returned. */
12485
12486             if (node_p && count == 1) {
12487                 substitute_parse = newSVpvs("?:");
12488             }
12489
12490           do_concat:
12491
12492             if (node_p) {
12493                 /* Convert to notation the rest of the code understands */
12494                 sv_catpv(substitute_parse, "\\x{");
12495                 sv_catpvn(substitute_parse, start_digit,
12496                                             RExC_parse - start_digit);
12497                 sv_catpv(substitute_parse, "}");
12498             }
12499
12500             /* Move to after the dot (or ending brace the final time through.)
12501              * */
12502             RExC_parse++;
12503             count++;
12504
12505         } while (RExC_parse < endbrace);
12506
12507         if (! node_p) { /* Doesn't want the node */
12508             assert (cp_count);
12509
12510             *cp_count = count;
12511             return FALSE;
12512         }
12513
12514         sv_catpv(substitute_parse, ")");
12515
12516 #ifdef EBCDIC
12517         /* The values are Unicode, and therefore have to be converted to native
12518          * on a non-Unicode (meaning non-ASCII) platform. */
12519         RExC_recode_x_to_native = 1;
12520 #endif
12521
12522     /* Here, we have the string the name evaluates to, ready to be parsed,
12523      * stored in 'substitute_parse' as a series of valid "\x{...}\x{...}"
12524      * constructs.  This can be called from within a substitute parse already.
12525      * The error reporting mechanism doesn't work for 2 levels of this, but the
12526      * code above has validated this new construct, so there should be no
12527      * errors generated by the below.*/
12528     save_start = RExC_start;
12529     orig_end = RExC_end;
12530
12531     RExC_parse = RExC_start = SvPVX(substitute_parse);
12532     RExC_end = RExC_parse + SvCUR(substitute_parse);
12533
12534     *node_p = reg(pRExC_state, 1, &flags, depth+1);
12535
12536     /* Restore the saved values */
12537     RExC_start = save_start;
12538     RExC_parse = endbrace;
12539     RExC_end = orig_end;
12540 #ifdef EBCDIC
12541     RExC_recode_x_to_native = 0;
12542 #endif
12543
12544     SvREFCNT_dec_NN(substitute_parse);
12545
12546     if (! *node_p) {
12547         RETURN_X_ON_RESTART(FALSE, flags,flagp);
12548         FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#" UVxf,
12549             (UV) flags);
12550     }
12551     *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12552
12553     nextchar(pRExC_state);
12554
12555     return TRUE;
12556 }
12557
12558
12559 PERL_STATIC_INLINE U8
12560 S_compute_EXACTish(RExC_state_t *pRExC_state)
12561 {
12562     U8 op;
12563
12564     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
12565
12566     if (! FOLD) {
12567         return (LOC)
12568                 ? EXACTL
12569                 : EXACT;
12570     }
12571
12572     op = get_regex_charset(RExC_flags);
12573     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
12574         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
12575                  been, so there is no hole */
12576     }
12577
12578     return op + EXACTF;
12579 }
12580
12581 PERL_STATIC_INLINE void
12582 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
12583                          regnode *node, I32* flagp, STRLEN len, UV code_point,
12584                          bool downgradable)
12585 {
12586     /* This knows the details about sizing an EXACTish node, setting flags for
12587      * it (by setting <*flagp>, and potentially populating it with a single
12588      * character.
12589      *
12590      * If <len> (the length in bytes) is non-zero, this function assumes that
12591      * the node has already been populated, and just does the sizing.  In this
12592      * case <code_point> should be the final code point that has already been
12593      * placed into the node.  This value will be ignored except that under some
12594      * circumstances <*flagp> is set based on it.
12595      *
12596      * If <len> is zero, the function assumes that the node is to contain only
12597      * the single character given by <code_point> and calculates what <len>
12598      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
12599      * additionally will populate the node's STRING with <code_point> or its
12600      * fold if folding.
12601      *
12602      * In both cases <*flagp> is appropriately set
12603      *
12604      * It knows that under FOLD, the Latin Sharp S and UTF characters above
12605      * 255, must be folded (the former only when the rules indicate it can
12606      * match 'ss')
12607      *
12608      * When it does the populating, it looks at the flag 'downgradable'.  If
12609      * true with a node that folds, it checks if the single code point
12610      * participates in a fold, and if not downgrades the node to an EXACT.
12611      * This helps the optimizer */
12612
12613     bool len_passed_in = cBOOL(len != 0);
12614     U8 character[UTF8_MAXBYTES_CASE+1];
12615
12616     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
12617
12618     /* Don't bother to check for downgrading in PASS1, as it doesn't make any
12619      * sizing difference, and is extra work that is thrown away */
12620     if (downgradable && ! PASS2) {
12621         downgradable = FALSE;
12622     }
12623
12624     if (! len_passed_in) {
12625         if (UTF) {
12626             if (UVCHR_IS_INVARIANT(code_point)) {
12627                 if (LOC || ! FOLD) {    /* /l defers folding until runtime */
12628                     *character = (U8) code_point;
12629                 }
12630                 else { /* Here is /i and not /l. (toFOLD() is defined on just
12631                           ASCII, which isn't the same thing as INVARIANT on
12632                           EBCDIC, but it works there, as the extra invariants
12633                           fold to themselves) */
12634                     *character = toFOLD((U8) code_point);
12635
12636                     /* We can downgrade to an EXACT node if this character
12637                      * isn't a folding one.  Note that this assumes that
12638                      * nothing above Latin1 folds to some other invariant than
12639                      * one of these alphabetics; otherwise we would also have
12640                      * to check:
12641                      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12642                      *      || ASCII_FOLD_RESTRICTED))
12643                      */
12644                     if (downgradable && PL_fold[code_point] == code_point) {
12645                         OP(node) = EXACT;
12646                     }
12647                 }
12648                 len = 1;
12649             }
12650             else if (FOLD && (! LOC
12651                               || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
12652             {   /* Folding, and ok to do so now */
12653                 UV folded = _to_uni_fold_flags(
12654                                    code_point,
12655                                    character,
12656                                    &len,
12657                                    FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12658                                                       ? FOLD_FLAGS_NOMIX_ASCII
12659                                                       : 0));
12660                 if (downgradable
12661                     && folded == code_point /* This quickly rules out many
12662                                                cases, avoiding the
12663                                                _invlist_contains_cp() overhead
12664                                                for those.  */
12665                     && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
12666                 {
12667                     OP(node) = (LOC)
12668                                ? EXACTL
12669                                : EXACT;
12670                 }
12671             }
12672             else if (code_point <= MAX_UTF8_TWO_BYTE) {
12673
12674                 /* Not folding this cp, and can output it directly */
12675                 *character = UTF8_TWO_BYTE_HI(code_point);
12676                 *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
12677                 len = 2;
12678             }
12679             else {
12680                 uvchr_to_utf8( character, code_point);
12681                 len = UTF8SKIP(character);
12682             }
12683         } /* Else pattern isn't UTF8.  */
12684         else if (! FOLD) {
12685             *character = (U8) code_point;
12686             len = 1;
12687         } /* Else is folded non-UTF8 */
12688 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12689    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12690                                       || UNICODE_DOT_DOT_VERSION > 0)
12691         else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
12692 #else
12693         else if (1) {
12694 #endif
12695             /* We don't fold any non-UTF8 except possibly the Sharp s  (see
12696              * comments at join_exact()); */
12697             *character = (U8) code_point;
12698             len = 1;
12699
12700             /* Can turn into an EXACT node if we know the fold at compile time,
12701              * and it folds to itself and doesn't particpate in other folds */
12702             if (downgradable
12703                 && ! LOC
12704                 && PL_fold_latin1[code_point] == code_point
12705                 && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12706                     || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
12707             {
12708                 OP(node) = EXACT;
12709             }
12710         } /* else is Sharp s.  May need to fold it */
12711         else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
12712             *character = 's';
12713             *(character + 1) = 's';
12714             len = 2;
12715         }
12716         else {
12717             *character = LATIN_SMALL_LETTER_SHARP_S;
12718             len = 1;
12719         }
12720     }
12721
12722     if (SIZE_ONLY) {
12723         RExC_size += STR_SZ(len);
12724     }
12725     else {
12726         RExC_emit += STR_SZ(len);
12727         STR_LEN(node) = len;
12728         if (! len_passed_in) {
12729             Copy((char *) character, STRING(node), len, char);
12730         }
12731     }
12732
12733     *flagp |= HASWIDTH;
12734
12735     /* A single character node is SIMPLE, except for the special-cased SHARP S
12736      * under /di. */
12737     if ((len == 1 || (UTF && len == UVCHR_SKIP(code_point)))
12738 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12739    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12740                                       || UNICODE_DOT_DOT_VERSION > 0)
12741         && ( code_point != LATIN_SMALL_LETTER_SHARP_S
12742             || ! FOLD || ! DEPENDS_SEMANTICS)
12743 #endif
12744     ) {
12745         *flagp |= SIMPLE;
12746     }
12747
12748     /* The OP may not be well defined in PASS1 */
12749     if (PASS2 && OP(node) == EXACTFL) {
12750         RExC_contains_locale = 1;
12751     }
12752 }
12753
12754 STATIC bool
12755 S_new_regcurly(const char *s, const char *e)
12756 {
12757     /* This is a temporary function designed to match the most lenient form of
12758      * a {m,n} quantifier we ever envision, with either number omitted, and
12759      * spaces anywhere between/before/after them.
12760      *
12761      * If this function fails, then the string it matches is very unlikely to
12762      * ever be considered a valid quantifier, so we can allow the '{' that
12763      * begins it to be considered as a literal */
12764
12765     bool has_min = FALSE;
12766     bool has_max = FALSE;
12767
12768     PERL_ARGS_ASSERT_NEW_REGCURLY;
12769
12770     if (s >= e || *s++ != '{')
12771         return FALSE;
12772
12773     while (s < e && isSPACE(*s)) {
12774         s++;
12775     }
12776     while (s < e && isDIGIT(*s)) {
12777         has_min = TRUE;
12778         s++;
12779     }
12780     while (s < e && isSPACE(*s)) {
12781         s++;
12782     }
12783
12784     if (*s == ',') {
12785         s++;
12786         while (s < e && isSPACE(*s)) {
12787             s++;
12788         }
12789         while (s < e && isDIGIT(*s)) {
12790             has_max = TRUE;
12791             s++;
12792         }
12793         while (s < e && isSPACE(*s)) {
12794             s++;
12795         }
12796     }
12797
12798     return s < e && *s == '}' && (has_min || has_max);
12799 }
12800
12801 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
12802  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
12803
12804 static I32
12805 S_backref_value(char *p, char *e)
12806 {
12807     const char* endptr = e;
12808     UV val;
12809     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
12810         return (I32)val;
12811     return I32_MAX;
12812 }
12813
12814
12815 /*
12816  - regatom - the lowest level
12817
12818    Try to identify anything special at the start of the current parse position.
12819    If there is, then handle it as required. This may involve generating a
12820    single regop, such as for an assertion; or it may involve recursing, such as
12821    to handle a () structure.
12822
12823    If the string doesn't start with something special then we gobble up
12824    as much literal text as we can.  If we encounter a quantifier, we have to
12825    back off the final literal character, as that quantifier applies to just it
12826    and not to the whole string of literals.
12827
12828    Once we have been able to handle whatever type of thing started the
12829    sequence, we return.
12830
12831    Note: we have to be careful with escapes, as they can be both literal
12832    and special, and in the case of \10 and friends, context determines which.
12833
12834    A summary of the code structure is:
12835
12836    switch (first_byte) {
12837         cases for each special:
12838             handle this special;
12839             break;
12840         case '\\':
12841             switch (2nd byte) {
12842                 cases for each unambiguous special:
12843                     handle this special;
12844                     break;
12845                 cases for each ambigous special/literal:
12846                     disambiguate;
12847                     if (special)  handle here
12848                     else goto defchar;
12849                 default: // unambiguously literal:
12850                     goto defchar;
12851             }
12852         default:  // is a literal char
12853             // FALL THROUGH
12854         defchar:
12855             create EXACTish node for literal;
12856             while (more input and node isn't full) {
12857                 switch (input_byte) {
12858                    cases for each special;
12859                        make sure parse pointer is set so that the next call to
12860                            regatom will see this special first
12861                        goto loopdone; // EXACTish node terminated by prev. char
12862                    default:
12863                        append char to EXACTISH node;
12864                 }
12865                 get next input byte;
12866             }
12867         loopdone:
12868    }
12869    return the generated node;
12870
12871    Specifically there are two separate switches for handling
12872    escape sequences, with the one for handling literal escapes requiring
12873    a dummy entry for all of the special escapes that are actually handled
12874    by the other.
12875
12876    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
12877    TRYAGAIN.
12878    Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
12879    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
12880    Otherwise does not return NULL.
12881 */
12882
12883 STATIC regnode *
12884 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12885 {
12886     regnode *ret = NULL;
12887     I32 flags = 0;
12888     char *parse_start;
12889     U8 op;
12890     int invert = 0;
12891     U8 arg;
12892
12893     GET_RE_DEBUG_FLAGS_DECL;
12894
12895     *flagp = WORST;             /* Tentatively. */
12896
12897     DEBUG_PARSE("atom");
12898
12899     PERL_ARGS_ASSERT_REGATOM;
12900
12901   tryagain:
12902     parse_start = RExC_parse;
12903     assert(RExC_parse < RExC_end);
12904     switch ((U8)*RExC_parse) {
12905     case '^':
12906         RExC_seen_zerolen++;
12907         nextchar(pRExC_state);
12908         if (RExC_flags & RXf_PMf_MULTILINE)
12909             ret = reg_node(pRExC_state, MBOL);
12910         else
12911             ret = reg_node(pRExC_state, SBOL);
12912         Set_Node_Length(ret, 1); /* MJD */
12913         break;
12914     case '$':
12915         nextchar(pRExC_state);
12916         if (*RExC_parse)
12917             RExC_seen_zerolen++;
12918         if (RExC_flags & RXf_PMf_MULTILINE)
12919             ret = reg_node(pRExC_state, MEOL);
12920         else
12921             ret = reg_node(pRExC_state, SEOL);
12922         Set_Node_Length(ret, 1); /* MJD */
12923         break;
12924     case '.':
12925         nextchar(pRExC_state);
12926         if (RExC_flags & RXf_PMf_SINGLELINE)
12927             ret = reg_node(pRExC_state, SANY);
12928         else
12929             ret = reg_node(pRExC_state, REG_ANY);
12930         *flagp |= HASWIDTH|SIMPLE;
12931         MARK_NAUGHTY(1);
12932         Set_Node_Length(ret, 1); /* MJD */
12933         break;
12934     case '[':
12935     {
12936         char * const oregcomp_parse = ++RExC_parse;
12937         ret = regclass(pRExC_state, flagp,depth+1,
12938                        FALSE, /* means parse the whole char class */
12939                        TRUE, /* allow multi-char folds */
12940                        FALSE, /* don't silence non-portable warnings. */
12941                        (bool) RExC_strict,
12942                        TRUE, /* Allow an optimized regnode result */
12943                        NULL,
12944                        NULL);
12945         if (ret == NULL) {
12946             RETURN_NULL_ON_RESTART_FLAGP_OR_FLAGS(flagp,NEED_UTF8);
12947             FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12948                   (UV) *flagp);
12949         }
12950         if (*RExC_parse != ']') {
12951             RExC_parse = oregcomp_parse;
12952             vFAIL("Unmatched [");
12953         }
12954         nextchar(pRExC_state);
12955         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
12956         break;
12957     }
12958     case '(':
12959         nextchar(pRExC_state);
12960         ret = reg(pRExC_state, 2, &flags,depth+1);
12961         if (ret == NULL) {
12962                 if (flags & TRYAGAIN) {
12963                     if (RExC_parse >= RExC_end) {
12964                          /* Make parent create an empty node if needed. */
12965                         *flagp |= TRYAGAIN;
12966                         return(NULL);
12967                     }
12968                     goto tryagain;
12969                 }
12970                 RETURN_NULL_ON_RESTART(flags,flagp);
12971                 FAIL2("panic: reg returned NULL to regatom, flags=%#" UVxf,
12972                                                                  (UV) flags);
12973         }
12974         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12975         break;
12976     case '|':
12977     case ')':
12978         if (flags & TRYAGAIN) {
12979             *flagp |= TRYAGAIN;
12980             return NULL;
12981         }
12982         vFAIL("Internal urp");
12983                                 /* Supposed to be caught earlier. */
12984         break;
12985     case '?':
12986     case '+':
12987     case '*':
12988         RExC_parse++;
12989         vFAIL("Quantifier follows nothing");
12990         break;
12991     case '\\':
12992         /* Special Escapes
12993
12994            This switch handles escape sequences that resolve to some kind
12995            of special regop and not to literal text. Escape sequnces that
12996            resolve to literal text are handled below in the switch marked
12997            "Literal Escapes".
12998
12999            Every entry in this switch *must* have a corresponding entry
13000            in the literal escape switch. However, the opposite is not
13001            required, as the default for this switch is to jump to the
13002            literal text handling code.
13003         */
13004         RExC_parse++;
13005         switch ((U8)*RExC_parse) {
13006         /* Special Escapes */
13007         case 'A':
13008             RExC_seen_zerolen++;
13009             ret = reg_node(pRExC_state, SBOL);
13010             /* SBOL is shared with /^/ so we set the flags so we can tell
13011              * /\A/ from /^/ in split. We check ret because first pass we
13012              * have no regop struct to set the flags on. */
13013             if (PASS2)
13014                 ret->flags = 1;
13015             *flagp |= SIMPLE;
13016             goto finish_meta_pat;
13017         case 'G':
13018             ret = reg_node(pRExC_state, GPOS);
13019             RExC_seen |= REG_GPOS_SEEN;
13020             *flagp |= SIMPLE;
13021             goto finish_meta_pat;
13022         case 'K':
13023             RExC_seen_zerolen++;
13024             ret = reg_node(pRExC_state, KEEPS);
13025             *flagp |= SIMPLE;
13026             /* XXX:dmq : disabling in-place substitution seems to
13027              * be necessary here to avoid cases of memory corruption, as
13028              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
13029              */
13030             RExC_seen |= REG_LOOKBEHIND_SEEN;
13031             goto finish_meta_pat;
13032         case 'Z':
13033             ret = reg_node(pRExC_state, SEOL);
13034             *flagp |= SIMPLE;
13035             RExC_seen_zerolen++;                /* Do not optimize RE away */
13036             goto finish_meta_pat;
13037         case 'z':
13038             ret = reg_node(pRExC_state, EOS);
13039             *flagp |= SIMPLE;
13040             RExC_seen_zerolen++;                /* Do not optimize RE away */
13041             goto finish_meta_pat;
13042         case 'C':
13043             vFAIL("\\C no longer supported");
13044         case 'X':
13045             ret = reg_node(pRExC_state, CLUMP);
13046             *flagp |= HASWIDTH;
13047             goto finish_meta_pat;
13048
13049         case 'W':
13050             invert = 1;
13051             /* FALLTHROUGH */
13052         case 'w':
13053             arg = ANYOF_WORDCHAR;
13054             goto join_posix;
13055
13056         case 'B':
13057             invert = 1;
13058             /* FALLTHROUGH */
13059         case 'b':
13060           {
13061             regex_charset charset = get_regex_charset(RExC_flags);
13062
13063             RExC_seen_zerolen++;
13064             RExC_seen |= REG_LOOKBEHIND_SEEN;
13065             op = BOUND + charset;
13066
13067             if (op == BOUNDL) {
13068                 RExC_contains_locale = 1;
13069             }
13070
13071             ret = reg_node(pRExC_state, op);
13072             *flagp |= SIMPLE;
13073             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
13074                 FLAGS(ret) = TRADITIONAL_BOUND;
13075                 if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
13076                     OP(ret) = BOUNDA;
13077                 }
13078             }
13079             else {
13080                 STRLEN length;
13081                 char name = *RExC_parse;
13082                 char * endbrace = NULL;
13083                 RExC_parse += 2;
13084                 if (RExC_parse < RExC_end) {
13085                     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
13086                 }
13087
13088                 if (! endbrace) {
13089                     vFAIL2("Missing right brace on \\%c{}", name);
13090                 }
13091                 /* XXX Need to decide whether to take spaces or not.  Should be
13092                  * consistent with \p{}, but that currently is SPACE, which
13093                  * means vertical too, which seems wrong
13094                  * while (isBLANK(*RExC_parse)) {
13095                     RExC_parse++;
13096                 }*/
13097                 if (endbrace == RExC_parse) {
13098                     RExC_parse++;  /* After the '}' */
13099                     vFAIL2("Empty \\%c{}", name);
13100                 }
13101                 length = endbrace - RExC_parse;
13102                 /*while (isBLANK(*(RExC_parse + length - 1))) {
13103                     length--;
13104                 }*/
13105                 switch (*RExC_parse) {
13106                     case 'g':
13107                         if (    length != 1
13108                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
13109                         {
13110                             goto bad_bound_type;
13111                         }
13112                         FLAGS(ret) = GCB_BOUND;
13113                         break;
13114                     case 'l':
13115                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13116                             goto bad_bound_type;
13117                         }
13118                         FLAGS(ret) = LB_BOUND;
13119                         break;
13120                     case 's':
13121                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13122                             goto bad_bound_type;
13123                         }
13124                         FLAGS(ret) = SB_BOUND;
13125                         break;
13126                     case 'w':
13127                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13128                             goto bad_bound_type;
13129                         }
13130                         FLAGS(ret) = WB_BOUND;
13131                         break;
13132                     default:
13133                       bad_bound_type:
13134                         RExC_parse = endbrace;
13135                         vFAIL2utf8f(
13136                             "'%" UTF8f "' is an unknown bound type",
13137                             UTF8fARG(UTF, length, endbrace - length));
13138                         NOT_REACHED; /*NOTREACHED*/
13139                 }
13140                 RExC_parse = endbrace;
13141                 REQUIRE_UNI_RULES(flagp, NULL);
13142
13143                 if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
13144                     OP(ret) = BOUNDU;
13145                     length += 4;
13146
13147                     /* Don't have to worry about UTF-8, in this message because
13148                      * to get here the contents of the \b must be ASCII */
13149                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
13150                               "Using /u for '%.*s' instead of /%s",
13151                               (unsigned) length,
13152                               endbrace - length + 1,
13153                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
13154                               ? ASCII_RESTRICT_PAT_MODS
13155                               : ASCII_MORE_RESTRICT_PAT_MODS);
13156                 }
13157             }
13158
13159             if (PASS2 && invert) {
13160                 OP(ret) += NBOUND - BOUND;
13161             }
13162             goto finish_meta_pat;
13163           }
13164
13165         case 'D':
13166             invert = 1;
13167             /* FALLTHROUGH */
13168         case 'd':
13169             arg = ANYOF_DIGIT;
13170             if (! DEPENDS_SEMANTICS) {
13171                 goto join_posix;
13172             }
13173
13174             /* \d doesn't have any matches in the upper Latin1 range, hence /d
13175              * is equivalent to /u.  Changing to /u saves some branches at
13176              * runtime */
13177             op = POSIXU;
13178             goto join_posix_op_known;
13179
13180         case 'R':
13181             ret = reg_node(pRExC_state, LNBREAK);
13182             *flagp |= HASWIDTH|SIMPLE;
13183             goto finish_meta_pat;
13184
13185         case 'H':
13186             invert = 1;
13187             /* FALLTHROUGH */
13188         case 'h':
13189             arg = ANYOF_BLANK;
13190             op = POSIXU;
13191             goto join_posix_op_known;
13192
13193         case 'V':
13194             invert = 1;
13195             /* FALLTHROUGH */
13196         case 'v':
13197             arg = ANYOF_VERTWS;
13198             op = POSIXU;
13199             goto join_posix_op_known;
13200
13201         case 'S':
13202             invert = 1;
13203             /* FALLTHROUGH */
13204         case 's':
13205             arg = ANYOF_SPACE;
13206
13207           join_posix:
13208
13209             op = POSIXD + get_regex_charset(RExC_flags);
13210             if (op > POSIXA) {  /* /aa is same as /a */
13211                 op = POSIXA;
13212             }
13213             else if (op == POSIXL) {
13214                 RExC_contains_locale = 1;
13215             }
13216
13217           join_posix_op_known:
13218
13219             if (invert) {
13220                 op += NPOSIXD - POSIXD;
13221             }
13222
13223             ret = reg_node(pRExC_state, op);
13224             if (! SIZE_ONLY) {
13225                 FLAGS(ret) = namedclass_to_classnum(arg);
13226             }
13227
13228             *flagp |= HASWIDTH|SIMPLE;
13229             /* FALLTHROUGH */
13230
13231           finish_meta_pat:
13232             if (   UCHARAT(RExC_parse + 1) == '{'
13233                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
13234             {
13235                 RExC_parse += 2;
13236                 vFAIL("Unescaped left brace in regex is illegal here");
13237             }
13238             nextchar(pRExC_state);
13239             Set_Node_Length(ret, 2); /* MJD */
13240             break;
13241         case 'p':
13242         case 'P':
13243             RExC_parse--;
13244
13245             ret = regclass(pRExC_state, flagp,depth+1,
13246                            TRUE, /* means just parse this element */
13247                            FALSE, /* don't allow multi-char folds */
13248                            FALSE, /* don't silence non-portable warnings.  It
13249                                      would be a bug if these returned
13250                                      non-portables */
13251                            (bool) RExC_strict,
13252                            TRUE, /* Allow an optimized regnode result */
13253                            NULL,
13254                            NULL);
13255             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13256             /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
13257              * multi-char folds are allowed.  */
13258             if (!ret)
13259                 FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
13260                       (UV) *flagp);
13261
13262             RExC_parse--;
13263
13264             Set_Node_Offset(ret, parse_start);
13265             Set_Node_Cur_Length(ret, parse_start - 2);
13266             nextchar(pRExC_state);
13267             break;
13268         case 'N':
13269             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
13270              * \N{...} evaluates to a sequence of more than one code points).
13271              * The function call below returns a regnode, which is our result.
13272              * The parameters cause it to fail if the \N{} evaluates to a
13273              * single code point; we handle those like any other literal.  The
13274              * reason that the multicharacter case is handled here and not as
13275              * part of the EXACtish code is because of quantifiers.  In
13276              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
13277              * this way makes that Just Happen. dmq.
13278              * join_exact() will join this up with adjacent EXACTish nodes
13279              * later on, if appropriate. */
13280             ++RExC_parse;
13281             if (grok_bslash_N(pRExC_state,
13282                               &ret,     /* Want a regnode returned */
13283                               NULL,     /* Fail if evaluates to a single code
13284                                            point */
13285                               NULL,     /* Don't need a count of how many code
13286                                            points */
13287                               flagp,
13288                               RExC_strict,
13289                               depth)
13290             ) {
13291                 break;
13292             }
13293
13294             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13295
13296             /* Here, evaluates to a single code point.  Go get that */
13297             RExC_parse = parse_start;
13298             goto defchar;
13299
13300         case 'k':    /* Handle \k<NAME> and \k'NAME' */
13301       parse_named_seq:
13302         {
13303             char ch;
13304             if (   RExC_parse >= RExC_end - 1
13305                 || ((   ch = RExC_parse[1]) != '<'
13306                                       && ch != '\''
13307                                       && ch != '{'))
13308             {
13309                 RExC_parse++;
13310                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13311                 vFAIL2("Sequence %.2s... not terminated",parse_start);
13312             } else {
13313                 RExC_parse += 2;
13314                 ret = handle_named_backref(pRExC_state,
13315                                            flagp,
13316                                            parse_start,
13317                                            (ch == '<')
13318                                            ? '>'
13319                                            : (ch == '{')
13320                                              ? '}'
13321                                              : '\'');
13322             }
13323             break;
13324         }
13325         case 'g':
13326         case '1': case '2': case '3': case '4':
13327         case '5': case '6': case '7': case '8': case '9':
13328             {
13329                 I32 num;
13330                 bool hasbrace = 0;
13331
13332                 if (*RExC_parse == 'g') {
13333                     bool isrel = 0;
13334
13335                     RExC_parse++;
13336                     if (*RExC_parse == '{') {
13337                         RExC_parse++;
13338                         hasbrace = 1;
13339                     }
13340                     if (*RExC_parse == '-') {
13341                         RExC_parse++;
13342                         isrel = 1;
13343                     }
13344                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13345                         if (isrel) RExC_parse--;
13346                         RExC_parse -= 2;
13347                         goto parse_named_seq;
13348                     }
13349
13350                     if (RExC_parse >= RExC_end) {
13351                         goto unterminated_g;
13352                     }
13353                     num = S_backref_value(RExC_parse, RExC_end);
13354                     if (num == 0)
13355                         vFAIL("Reference to invalid group 0");
13356                     else if (num == I32_MAX) {
13357                          if (isDIGIT(*RExC_parse))
13358                             vFAIL("Reference to nonexistent group");
13359                         else
13360                           unterminated_g:
13361                             vFAIL("Unterminated \\g... pattern");
13362                     }
13363
13364                     if (isrel) {
13365                         num = RExC_npar - num;
13366                         if (num < 1)
13367                             vFAIL("Reference to nonexistent or unclosed group");
13368                     }
13369                 }
13370                 else {
13371                     num = S_backref_value(RExC_parse, RExC_end);
13372                     /* bare \NNN might be backref or octal - if it is larger
13373                      * than or equal RExC_npar then it is assumed to be an
13374                      * octal escape. Note RExC_npar is +1 from the actual
13375                      * number of parens. */
13376                     /* Note we do NOT check if num == I32_MAX here, as that is
13377                      * handled by the RExC_npar check */
13378
13379                     if (
13380                         /* any numeric escape < 10 is always a backref */
13381                         num > 9
13382                         /* any numeric escape < RExC_npar is a backref */
13383                         && num >= RExC_npar
13384                         /* cannot be an octal escape if it starts with 8 */
13385                         && *RExC_parse != '8'
13386                         /* cannot be an octal escape it it starts with 9 */
13387                         && *RExC_parse != '9'
13388                     )
13389                     {
13390                         /* Probably not a backref, instead likely to be an
13391                          * octal character escape, e.g. \35 or \777.
13392                          * The above logic should make it obvious why using
13393                          * octal escapes in patterns is problematic. - Yves */
13394                         RExC_parse = parse_start;
13395                         goto defchar;
13396                     }
13397                 }
13398
13399                 /* At this point RExC_parse points at a numeric escape like
13400                  * \12 or \88 or something similar, which we should NOT treat
13401                  * as an octal escape. It may or may not be a valid backref
13402                  * escape. For instance \88888888 is unlikely to be a valid
13403                  * backref. */
13404                 while (isDIGIT(*RExC_parse))
13405                     RExC_parse++;
13406                 if (hasbrace) {
13407                     if (*RExC_parse != '}')
13408                         vFAIL("Unterminated \\g{...} pattern");
13409                     RExC_parse++;
13410                 }
13411                 if (!SIZE_ONLY) {
13412                     if (num > (I32)RExC_rx->nparens)
13413                         vFAIL("Reference to nonexistent group");
13414                 }
13415                 RExC_sawback = 1;
13416                 ret = reganode(pRExC_state,
13417                                ((! FOLD)
13418                                  ? REF
13419                                  : (ASCII_FOLD_RESTRICTED)
13420                                    ? REFFA
13421                                    : (AT_LEAST_UNI_SEMANTICS)
13422                                      ? REFFU
13423                                      : (LOC)
13424                                        ? REFFL
13425                                        : REFF),
13426                                 num);
13427                 *flagp |= HASWIDTH;
13428
13429                 /* override incorrect value set in reganode MJD */
13430                 Set_Node_Offset(ret, parse_start);
13431                 Set_Node_Cur_Length(ret, parse_start-1);
13432                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13433                                         FALSE /* Don't force to /x */ );
13434             }
13435             break;
13436         case '\0':
13437             if (RExC_parse >= RExC_end)
13438                 FAIL("Trailing \\");
13439             /* FALLTHROUGH */
13440         default:
13441             /* Do not generate "unrecognized" warnings here, we fall
13442                back into the quick-grab loop below */
13443             RExC_parse = parse_start;
13444             goto defchar;
13445         } /* end of switch on a \foo sequence */
13446         break;
13447
13448     case '#':
13449
13450         /* '#' comments should have been spaced over before this function was
13451          * called */
13452         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13453         /*
13454         if (RExC_flags & RXf_PMf_EXTENDED) {
13455             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13456             if (RExC_parse < RExC_end)
13457                 goto tryagain;
13458         }
13459         */
13460
13461         /* FALLTHROUGH */
13462
13463     default:
13464           defchar: {
13465
13466             /* Here, we have determined that the next thing is probably a
13467              * literal character.  RExC_parse points to the first byte of its
13468              * definition.  (It still may be an escape sequence that evaluates
13469              * to a single character) */
13470
13471             STRLEN len = 0;
13472             UV ender = 0;
13473             char *p;
13474             char *s;
13475
13476 /* This allows us to fill a node with just enough spare so that if the final
13477  * character folds, its expansion is guaranteed to fit */
13478 #define MAX_NODE_STRING_SIZE (255-UTF8_MAXBYTES_CASE)
13479             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE+1];
13480
13481             char *s0;
13482             U8 upper_parse = MAX_NODE_STRING_SIZE;
13483
13484             /* We start out as an EXACT node, even if under /i, until we find a
13485              * character which is in a fold.  The algorithm now segregates into
13486              * separate nodes, characters that fold from those that don't under
13487              * /i.  (This hopefull will create nodes that are fixed strings
13488              * even under /i, giving the optimizer something to grab onto to.)
13489              * So, if a node has something in it and the next character is in
13490              * the opposite category, that node is closed up, and the function
13491              * returns.  Then regatom is called again, and a new node is
13492              * created for the new category. */
13493             U8 node_type = EXACT;
13494
13495             bool next_is_quantifier;
13496             char * oldp = NULL;
13497
13498             /* We can convert EXACTF nodes to EXACTFU if they contain only
13499              * characters that match identically regardless of the target
13500              * string's UTF8ness.  The reason to do this is that EXACTF is not
13501              * trie-able, EXACTFU is.
13502              *
13503              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13504              * contain only above-Latin1 characters (hence must be in UTF8),
13505              * which don't participate in folds with Latin1-range characters,
13506              * as the latter's folds aren't known until runtime.  (We don't
13507              * need to figure this out until pass 2) */
13508             bool maybe_exactfu = PASS2;
13509
13510             /* To see if RExC_uni_semantics changes during parsing of the node.
13511              * */
13512             bool uni_semantics_at_node_start;
13513
13514             /* The node_type may change below, but since the size of the node
13515              * doesn't change, it works */
13516             ret = reg_node(pRExC_state, node_type);
13517
13518             /* In pass1, folded, we use a temporary buffer instead of the
13519              * actual node, as the node doesn't exist yet */
13520             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
13521
13522             s0 = s;
13523
13524           reparse:
13525
13526             /* This breaks under rare circumstances.  If folding, we do not
13527              * want to split a node at a character that is a non-final in a
13528              * multi-char fold, as an input string could just happen to want to
13529              * match across the node boundary.  The code at the end of the loop
13530              * looks for this, and backs off until it finds not such a
13531              * character, but it is possible (though extremely, extremely
13532              * unlikely) for all characters in the node to be non-final fold
13533              * ones, in which case we just leave the node fully filled, and
13534              * hope that it doesn't match the string in just the wrong place */
13535
13536             assert( ! UTF     /* Is at the beginning of a character */
13537                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
13538                    || UTF8_IS_START(UCHARAT(RExC_parse)));
13539
13540             uni_semantics_at_node_start = RExC_uni_semantics;
13541
13542             /* Here, we have a literal character.  Find the maximal string of
13543              * them in the input that we can fit into a single EXACTish node.
13544              * We quit at the first non-literal or when the node gets full, or
13545              * under /i the categorization of folding/non-folding character
13546              * changes */
13547             for (p = RExC_parse; len < upper_parse && p < RExC_end; ) {
13548
13549                 /* In most cases each iteration adds one byte to the output.
13550                  * The exceptions override this */
13551                 Size_t added_len = 1;
13552
13553                 oldp = p;
13554
13555                 /* White space has already been ignored */
13556                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
13557                        || ! is_PATWS_safe((p), RExC_end, UTF));
13558
13559                 switch ((U8)*p) {
13560                 case '^':
13561                 case '$':
13562                 case '.':
13563                 case '[':
13564                 case '(':
13565                 case ')':
13566                 case '|':
13567                     goto loopdone;
13568                 case '\\':
13569                     /* Literal Escapes Switch
13570
13571                        This switch is meant to handle escape sequences that
13572                        resolve to a literal character.
13573
13574                        Every escape sequence that represents something
13575                        else, like an assertion or a char class, is handled
13576                        in the switch marked 'Special Escapes' above in this
13577                        routine, but also has an entry here as anything that
13578                        isn't explicitly mentioned here will be treated as
13579                        an unescaped equivalent literal.
13580                     */
13581
13582                     switch ((U8)*++p) {
13583                     /* These are all the special escapes. */
13584                     case 'A':             /* Start assertion */
13585                     case 'b': case 'B':   /* Word-boundary assertion*/
13586                     case 'C':             /* Single char !DANGEROUS! */
13587                     case 'd': case 'D':   /* digit class */
13588                     case 'g': case 'G':   /* generic-backref, pos assertion */
13589                     case 'h': case 'H':   /* HORIZWS */
13590                     case 'k': case 'K':   /* named backref, keep marker */
13591                     case 'p': case 'P':   /* Unicode property */
13592                               case 'R':   /* LNBREAK */
13593                     case 's': case 'S':   /* space class */
13594                     case 'v': case 'V':   /* VERTWS */
13595                     case 'w': case 'W':   /* word class */
13596                     case 'X':             /* eXtended Unicode "combining
13597                                              character sequence" */
13598                     case 'z': case 'Z':   /* End of line/string assertion */
13599                         --p;
13600                         goto loopdone;
13601
13602                     /* Anything after here is an escape that resolves to a
13603                        literal. (Except digits, which may or may not)
13604                      */
13605                     case 'n':
13606                         ender = '\n';
13607                         p++;
13608                         break;
13609                     case 'N': /* Handle a single-code point named character. */
13610                         RExC_parse = p + 1;
13611                         if (! grok_bslash_N(pRExC_state,
13612                                             NULL,   /* Fail if evaluates to
13613                                                        anything other than a
13614                                                        single code point */
13615                                             &ender, /* The returned single code
13616                                                        point */
13617                                             NULL,   /* Don't need a count of
13618                                                        how many code points */
13619                                             flagp,
13620                                             RExC_strict,
13621                                             depth)
13622                         ) {
13623                             if (*flagp & NEED_UTF8)
13624                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
13625                             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13626
13627                             /* Here, it wasn't a single code point.  Go close
13628                              * up this EXACTish node.  The switch() prior to
13629                              * this switch handles the other cases */
13630                             RExC_parse = p = oldp;
13631                             goto loopdone;
13632                         }
13633                         p = RExC_parse;
13634                         RExC_parse = parse_start;
13635                         if (ender > 0xff) {
13636                             REQUIRE_UTF8(flagp);
13637                         }
13638                         break;
13639                     case 'r':
13640                         ender = '\r';
13641                         p++;
13642                         break;
13643                     case 't':
13644                         ender = '\t';
13645                         p++;
13646                         break;
13647                     case 'f':
13648                         ender = '\f';
13649                         p++;
13650                         break;
13651                     case 'e':
13652                         ender = ESC_NATIVE;
13653                         p++;
13654                         break;
13655                     case 'a':
13656                         ender = '\a';
13657                         p++;
13658                         break;
13659                     case 'o':
13660                         {
13661                             UV result;
13662                             const char* error_msg;
13663
13664                             bool valid = grok_bslash_o(&p,
13665                                                        RExC_end,
13666                                                        &result,
13667                                                        &error_msg,
13668                                                        PASS2, /* out warnings */
13669                                                        (bool) RExC_strict,
13670                                                        TRUE, /* Output warnings
13671                                                                 for non-
13672                                                                 portables */
13673                                                        UTF);
13674                             if (! valid) {
13675                                 RExC_parse = p; /* going to die anyway; point
13676                                                    to exact spot of failure */
13677                                 vFAIL(error_msg);
13678                             }
13679                             ender = result;
13680                             if (ender > 0xff) {
13681                                 REQUIRE_UTF8(flagp);
13682                             }
13683                             break;
13684                         }
13685                     case 'x':
13686                         {
13687                             UV result = UV_MAX; /* initialize to erroneous
13688                                                    value */
13689                             const char* error_msg;
13690
13691                             bool valid = grok_bslash_x(&p,
13692                                                        RExC_end,
13693                                                        &result,
13694                                                        &error_msg,
13695                                                        PASS2, /* out warnings */
13696                                                        (bool) RExC_strict,
13697                                                        TRUE, /* Silence warnings
13698                                                                 for non-
13699                                                                 portables */
13700                                                        UTF);
13701                             if (! valid) {
13702                                 RExC_parse = p; /* going to die anyway; point
13703                                                    to exact spot of failure */
13704                                 vFAIL(error_msg);
13705                             }
13706                             ender = result;
13707
13708                             if (ender < 0x100) {
13709 #ifdef EBCDIC
13710                                 if (RExC_recode_x_to_native) {
13711                                     ender = LATIN1_TO_NATIVE(ender);
13712                                 }
13713 #endif
13714                             }
13715                             else {
13716                                 REQUIRE_UTF8(flagp);
13717                             }
13718                             break;
13719                         }
13720                     case 'c':
13721                         p++;
13722                         ender = grok_bslash_c(*p++, PASS2);
13723                         break;
13724                     case '8': case '9': /* must be a backreference */
13725                         --p;
13726                         /* we have an escape like \8 which cannot be an octal escape
13727                          * so we exit the loop, and let the outer loop handle this
13728                          * escape which may or may not be a legitimate backref. */
13729                         goto loopdone;
13730                     case '1': case '2': case '3':case '4':
13731                     case '5': case '6': case '7':
13732                         /* When we parse backslash escapes there is ambiguity
13733                          * between backreferences and octal escapes. Any escape
13734                          * from \1 - \9 is a backreference, any multi-digit
13735                          * escape which does not start with 0 and which when
13736                          * evaluated as decimal could refer to an already
13737                          * parsed capture buffer is a back reference. Anything
13738                          * else is octal.
13739                          *
13740                          * Note this implies that \118 could be interpreted as
13741                          * 118 OR as "\11" . "8" depending on whether there
13742                          * were 118 capture buffers defined already in the
13743                          * pattern.  */
13744
13745                         /* NOTE, RExC_npar is 1 more than the actual number of
13746                          * parens we have seen so far, hence the < RExC_npar below. */
13747
13748                         if ( !isDIGIT(p[1]) || S_backref_value(p, RExC_end) < RExC_npar)
13749                         {  /* Not to be treated as an octal constant, go
13750                                    find backref */
13751                             --p;
13752                             goto loopdone;
13753                         }
13754                         /* FALLTHROUGH */
13755                     case '0':
13756                         {
13757                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
13758                             STRLEN numlen = 3;
13759                             ender = grok_oct(p, &numlen, &flags, NULL);
13760                             if (ender > 0xff) {
13761                                 REQUIRE_UTF8(flagp);
13762                             }
13763                             p += numlen;
13764                             if (PASS2   /* like \08, \178 */
13765                                 && numlen < 3
13766                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
13767                             {
13768                                 reg_warn_non_literal_string(
13769                                          p + 1,
13770                                          form_short_octal_warning(p, numlen));
13771                             }
13772                         }
13773                         break;
13774                     case '\0':
13775                         if (p >= RExC_end)
13776                             FAIL("Trailing \\");
13777                         /* FALLTHROUGH */
13778                     default:
13779                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
13780                             /* Include any left brace following the alpha to emphasize
13781                              * that it could be part of an escape at some point
13782                              * in the future */
13783                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
13784                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
13785                         }
13786                         goto normal_default;
13787                     } /* End of switch on '\' */
13788                     break;
13789                 case '{':
13790                     /* Trying to gain new uses for '{' without breaking too
13791                      * much existing code is hard.  The solution currently
13792                      * adopted is:
13793                      *  1)  If there is no ambiguity that a '{' should always
13794                      *      be taken literally, at the start of a construct, we
13795                      *      just do so.
13796                      *  2)  If the literal '{' conflicts with our desired use
13797                      *      of it as a metacharacter, we die.  The deprecation
13798                      *      cycles for this have come and gone.
13799                      *  3)  If there is ambiguity, we raise a simple warning.
13800                      *      This could happen, for example, if the user
13801                      *      intended it to introduce a quantifier, but slightly
13802                      *      misspelled the quantifier.  Without this warning,
13803                      *      the quantifier would silently be taken as a literal
13804                      *      string of characters instead of a meta construct */
13805                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
13806                         if (      RExC_strict
13807                             || (  p > parse_start + 1
13808                                 && isALPHA_A(*(p - 1))
13809                                 && *(p - 2) == '\\')
13810                             || new_regcurly(p, RExC_end))
13811                         {
13812                             RExC_parse = p + 1;
13813                             vFAIL("Unescaped left brace in regex is "
13814                                   "illegal here");
13815                         }
13816                         if (PASS2) {
13817                             ckWARNreg(p + 1, "Unescaped left brace in regex is"
13818                                              " passed through");
13819                         }
13820                     }
13821                     goto normal_default;
13822                 case '}':
13823                 case ']':
13824                     if (PASS2 && p > RExC_parse && RExC_strict) {
13825                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
13826                     }
13827                     /*FALLTHROUGH*/
13828                 default:    /* A literal character */
13829                   normal_default:
13830                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
13831                         STRLEN numlen;
13832                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
13833                                                &numlen, UTF8_ALLOW_DEFAULT);
13834                         p += numlen;
13835                     }
13836                     else
13837                         ender = (U8) *p++;
13838                     break;
13839                 } /* End of switch on the literal */
13840
13841                 /* Here, have looked at the literal character, and <ender>
13842                  * contains its ordinal; <p> points to the character after it.
13843                  * We need to check if the next non-ignored thing is a
13844                  * quantifier.  Move <p> to after anything that should be
13845                  * ignored, which, as a side effect, positions <p> for the next
13846                  * loop iteration */
13847                 skip_to_be_ignored_text(pRExC_state, &p,
13848                                         FALSE /* Don't force to /x */ );
13849
13850                 /* If the next thing is a quantifier, it applies to this
13851                  * character only, which means that this character has to be in
13852                  * its own node and can't just be appended to the string in an
13853                  * existing node, so if there are already other characters in
13854                  * the node, close the node with just them, and set up to do
13855                  * this character again next time through, when it will be the
13856                  * only thing in its new node */
13857
13858                 next_is_quantifier =    LIKELY(p < RExC_end)
13859                                      && UNLIKELY(ISMULT2(p));
13860
13861                 if (next_is_quantifier && LIKELY(len)) {
13862                     p = oldp;
13863                     goto loopdone;
13864                 }
13865
13866                 /* Ready to add 'ender' to the node */
13867
13868                 if (! FOLD) {  /* The simple case, just append the literal */
13869
13870                     /* In the sizing pass, we need only the size of the
13871                      * character we are appending, hence we can delay getting
13872                      * its representation until PASS2. */
13873                     if (SIZE_ONLY) {
13874                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13875                             const STRLEN unilen = UVCHR_SKIP(ender);
13876                             s += unilen;
13877                             added_len = unilen;
13878                         }
13879                         else {
13880                             s++;
13881                         }
13882                     } else { /* PASS2 */
13883                       not_fold_common:
13884                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13885                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
13886                             added_len = (char *) new_s - s;
13887                             s = (char *) new_s;
13888                         }
13889                         else {
13890                             *(s++) = (char) ender;
13891                         }
13892                     }
13893                 }
13894                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
13895
13896                     /* Here are folding under /l, and the code point is
13897                      * problematic.  If this is the first character in the
13898                      * node, change the node type to folding.   Otherwise, if
13899                      * this is the first problematic character, close up the
13900                      * existing node, so can start a new node with this one */
13901                     if (! len) {
13902                         node_type = EXACTFL;
13903                     }
13904                     else if (node_type == EXACT) {
13905                         p = oldp;
13906                         goto loopdone;
13907                     }
13908
13909                     /* This code point means we can't simplify things */
13910                     maybe_exactfu = FALSE;
13911
13912                     /* A problematic code point in this context means that its
13913                      * fold isn't known until runtime, so we can't fold it now.
13914                      * (The non-problematic code points are the above-Latin1
13915                      * ones that fold to also all above-Latin1.  Their folds
13916                      * don't vary no matter what the locale is.) But here we
13917                      * have characters whose fold depends on the locale.
13918                      * Unlike the non-folding case above, we have to keep track
13919                      * of these in the sizing pass, so that we can make sure we
13920                      * don't split too-long nodes in the middle of a potential
13921                      * multi-char fold.  And unlike the regular fold case
13922                      * handled in the else clauses below, we don't actually
13923                      * fold and don't have special cases to consider.  What we
13924                      * do for both passes is the PASS2 code for non-folding */
13925                     goto not_fold_common;
13926                 }
13927                 else                /* A regular FOLD code point */
13928                      if (! UTF)
13929                 {
13930                     /* Here, are folding and are not UTF-8 encoded; therefore
13931                      * the character must be in the range 0-255, and is not /l.
13932                      * (Not /l because we already handled these under /l in
13933                      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
13934                     if (! IS_IN_SOME_FOLD_L1(ender)) {
13935
13936                         /* Start a new node for this non-folding character if
13937                          * previous ones in the node were folded */
13938                         if (len && node_type != EXACT) {
13939                             p = oldp;
13940                             goto loopdone;
13941                         }
13942
13943                         *(s++) = (char) ender;
13944                     }
13945                     else {  /* Here, does participate in some fold */
13946
13947                         /* if this is the first character in the node, change
13948                          * its type to folding.  Otherwise, if this is the
13949                          * first folding character in the node, close up the
13950                          * existing node, so can start a new node with this
13951                          * one.  */
13952                         if (! len) {
13953                             node_type = compute_EXACTish(pRExC_state);
13954                         }
13955                         else if (node_type == EXACT) {
13956                             p = oldp;
13957                             goto loopdone;
13958                         }
13959
13960                         /* See if the character's fold differs between /d and
13961                          * /u.  On non-ancient Unicode versions, this includes
13962                          * the multi-char fold SHARP S to 'ss' */
13963
13964 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13965    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13966                                       || UNICODE_DOT_DOT_VERSION > 0)
13967
13968                         if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
13969
13970                             /* See comments for join_exact() as to why we fold
13971                              * this non-UTF at compile time */
13972                             if (node_type == EXACTFU) {
13973                                 *(s++) = 's';
13974
13975                                 /* Let the code below add in the extra 's' */
13976                                 ender = 's';
13977                                 added_len = 2;
13978                             }
13979                             else if (   uni_semantics_at_node_start
13980                                      != RExC_uni_semantics)
13981                             {
13982                                 /* Here, we are supossed to be using Unicode
13983                                  * rules, but this folding node is not.  This
13984                                  * happens during pass 1 when the node started
13985                                  * out not under Unicode rules, but a \N{} was
13986                                  * encountered during the processing of it,
13987                                  * causing Unicode rules to be switched into.
13988                                  * Pass 1 continues uninterrupted, as by the
13989                                  * time we get to pass 2, we will know enough
13990                                  * to generate the correct folds.  Except in
13991                                  * this one case, we need to restart the node,
13992                                  * because the fold of the sharp s requires 2
13993                                  * characters, and the sizing needs to account
13994                                  * for that. */
13995                                 p = oldp;
13996                                 goto loopdone;
13997                             }
13998                             else {
13999                                 RExC_seen_unfolded_sharp_s = 1;
14000                                 maybe_exactfu = FALSE;
14001                             }
14002                         }
14003                         else if (   len
14004                                  && isALPHA_FOLD_EQ(ender, 's')
14005                                  && isALPHA_FOLD_EQ(*(s-1), 's'))
14006                         {
14007                             maybe_exactfu = FALSE;
14008                         }
14009                         else
14010 #endif
14011
14012                         if (PL_fold[ender] != PL_fold_latin1[ender]) {
14013                             maybe_exactfu = FALSE;
14014                         }
14015
14016                         /* Even when folding, we store just the input
14017                          * character, as we have an array that finds its fold
14018                          * quickly */
14019                         *(s++) = (char) ender;
14020                     }
14021                 }
14022                 else {  /* FOLD, and UTF */
14023                     /* Unlike the non-fold case, we do actually have to
14024                      * calculate the fold in pass 1.  This is for two reasons,
14025                      * the folded length may be longer than the unfolded, and
14026                      * we have to calculate how many EXACTish nodes it will
14027                      * take; and we may run out of room in a node in the middle
14028                      * of a potential multi-char fold, and have to back off
14029                      * accordingly.  */
14030
14031                     if (isASCII_uni(ender)) {
14032
14033                         /* As above, we close up and start a new node if the
14034                          * previous characters don't match the fold/non-fold
14035                          * state of this one.  And if this is the first
14036                          * character in the node, and it folds, we change the
14037                          * node away from being EXACT */
14038                         if (! IS_IN_SOME_FOLD_L1(ender)) {
14039                             if (len && node_type != EXACT) {
14040                                 p = oldp;
14041                                 goto loopdone;
14042                             }
14043
14044                             *(s)++ = (U8) ender;
14045                         }
14046                         else {  /* Is in a fold */
14047
14048                             if (! len) {
14049                                 node_type = compute_EXACTish(pRExC_state);
14050                             }
14051                             else if (node_type == EXACT) {
14052                                 p = oldp;
14053                                 goto loopdone;
14054                             }
14055
14056                             *(s)++ = (U8) toFOLD(ender);
14057                         }
14058                     }
14059                     else {  /* Not ASCII */
14060                         STRLEN foldlen;
14061
14062                         /* As above, we close up and start a new node if the
14063                          * previous characters don't match the fold/non-fold
14064                          * state of this one.  And if this is the first
14065                          * character in the node, and it folds, we change the
14066                          * node away from being EXACT */
14067                         if (! _invlist_contains_cp(PL_utf8_foldable, ender)) {
14068                             if (len && node_type != EXACT) {
14069                                 p = oldp;
14070                                 goto loopdone;
14071                             }
14072
14073                             s = (char *) uvchr_to_utf8((U8 *) s, ender);
14074                             added_len = UVCHR_SKIP(ender);
14075                         }
14076                         else {
14077
14078                             if (! len) {
14079                                 node_type = compute_EXACTish(pRExC_state);
14080                             }
14081                             else if (node_type == EXACT) {
14082                                 p = oldp;
14083                                 goto loopdone;
14084                             }
14085
14086                             ender = _to_uni_fold_flags(
14087                                      ender,
14088                                      (U8 *) s,
14089                                      &foldlen,
14090                                      FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
14091                                                         ? FOLD_FLAGS_NOMIX_ASCII
14092                                                         : 0));
14093                             s += foldlen;
14094                             added_len = foldlen;
14095                         }
14096                     }
14097                 }
14098
14099                 len += added_len;
14100
14101                 if (next_is_quantifier) {
14102
14103                     /* Here, the next input is a quantifier, and to get here,
14104                      * the current character is the only one in the node. */
14105                     goto loopdone;
14106                 }
14107
14108             } /* End of loop through literal characters */
14109
14110             /* Here we have either exhausted the input or ran out of room in
14111              * the node.  (If we encountered a character that can't be in the
14112              * node, transfer is made directly to <loopdone>, and so we
14113              * wouldn't have fallen off the end of the loop.)  In the latter
14114              * case, we artificially have to split the node into two, because
14115              * we just don't have enough space to hold everything.  This
14116              * creates a problem if the final character participates in a
14117              * multi-character fold in the non-final position, as a match that
14118              * should have occurred won't, due to the way nodes are matched,
14119              * and our artificial boundary.  So back off until we find a non-
14120              * problematic character -- one that isn't at the beginning or
14121              * middle of such a fold.  (Either it doesn't participate in any
14122              * folds, or appears only in the final position of all the folds it
14123              * does participate in.)  A better solution with far fewer false
14124              * positives, and that would fill the nodes more completely, would
14125              * be to actually have available all the multi-character folds to
14126              * test against, and to back-off only far enough to be sure that
14127              * this node isn't ending with a partial one.  <upper_parse> is set
14128              * further below (if we need to reparse the node) to include just
14129              * up through that final non-problematic character that this code
14130              * identifies, so when it is set to less than the full node, we can
14131              * skip the rest of this */
14132             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
14133
14134                 const STRLEN full_len = len;
14135
14136                 assert(len >= MAX_NODE_STRING_SIZE);
14137
14138                 /* Here, <s> points to the final byte of the final character.
14139                  * Look backwards through the string until find a non-
14140                  * problematic character */
14141
14142                 if (! UTF) {
14143
14144                     /* This has no multi-char folds to non-UTF characters */
14145                     if (ASCII_FOLD_RESTRICTED) {
14146                         goto loopdone;
14147                     }
14148
14149                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
14150                     len = s - s0 + 1;
14151                 }
14152                 else {
14153
14154                     /* Point to the first byte of the final character */
14155                     s = (char *) utf8_hop((U8 *) s, -1);
14156
14157                     while (s >= s0) {   /* Search backwards until find
14158                                            a non-problematic char */
14159                         if (UTF8_IS_INVARIANT(*s)) {
14160
14161                             /* There are no ascii characters that participate
14162                              * in multi-char folds under /aa.  In EBCDIC, the
14163                              * non-ascii invariants are all control characters,
14164                              * so don't ever participate in any folds. */
14165                             if (ASCII_FOLD_RESTRICTED
14166                                 || ! IS_NON_FINAL_FOLD(*s))
14167                             {
14168                                 break;
14169                             }
14170                         }
14171                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
14172                             if (! IS_NON_FINAL_FOLD(EIGHT_BIT_UTF8_TO_NATIVE(
14173                                                                   *s, *(s+1))))
14174                             {
14175                                 break;
14176                             }
14177                         }
14178                         else if (! _invlist_contains_cp(
14179                                         PL_NonL1NonFinalFold,
14180                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
14181                         {
14182                             break;
14183                         }
14184
14185                         /* Here, the current character is problematic in that
14186                          * it does occur in the non-final position of some
14187                          * fold, so try the character before it, but have to
14188                          * special case the very first byte in the string, so
14189                          * we don't read outside the string */
14190                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
14191                     } /* End of loop backwards through the string */
14192
14193                     /* If there were only problematic characters in the string,
14194                      * <s> will point to before s0, in which case the length
14195                      * should be 0, otherwise include the length of the
14196                      * non-problematic character just found */
14197                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
14198                 }
14199
14200                 /* Here, have found the final character, if any, that is
14201                  * non-problematic as far as ending the node without splitting
14202                  * it across a potential multi-char fold.  <len> contains the
14203                  * number of bytes in the node up-to and including that
14204                  * character, or is 0 if there is no such character, meaning
14205                  * the whole node contains only problematic characters.  In
14206                  * this case, give up and just take the node as-is.  We can't
14207                  * do any better */
14208                 if (len == 0) {
14209                     len = full_len;
14210
14211                     /* If the node ends in an 's' we make sure it stays EXACTF,
14212                      * as if it turns into an EXACTFU, it could later get
14213                      * joined with another 's' that would then wrongly match
14214                      * the sharp s */
14215                     if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
14216                     {
14217                         maybe_exactfu = FALSE;
14218                     }
14219                 } else {
14220
14221                     /* Here, the node does contain some characters that aren't
14222                      * problematic.  If one such is the final character in the
14223                      * node, we are done */
14224                     if (len == full_len) {
14225                         goto loopdone;
14226                     }
14227                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
14228
14229                         /* If the final character is problematic, but the
14230                          * penultimate is not, back-off that last character to
14231                          * later start a new node with it */
14232                         p = oldp;
14233                         goto loopdone;
14234                     }
14235
14236                     /* Here, the final non-problematic character is earlier
14237                      * in the input than the penultimate character.  What we do
14238                      * is reparse from the beginning, going up only as far as
14239                      * this final ok one, thus guaranteeing that the node ends
14240                      * in an acceptable character.  The reason we reparse is
14241                      * that we know how far in the character is, but we don't
14242                      * know how to correlate its position with the input parse.
14243                      * An alternate implementation would be to build that
14244                      * correlation as we go along during the original parse,
14245                      * but that would entail extra work for every node, whereas
14246                      * this code gets executed only when the string is too
14247                      * large for the node, and the final two characters are
14248                      * problematic, an infrequent occurrence.  Yet another
14249                      * possible strategy would be to save the tail of the
14250                      * string, and the next time regatom is called, initialize
14251                      * with that.  The problem with this is that unless you
14252                      * back off one more character, you won't be guaranteed
14253                      * regatom will get called again, unless regbranch,
14254                      * regpiece ... are also changed.  If you do back off that
14255                      * extra character, so that there is input guaranteed to
14256                      * force calling regatom, you can't handle the case where
14257                      * just the first character in the node is acceptable.  I
14258                      * (khw) decided to try this method which doesn't have that
14259                      * pitfall; if performance issues are found, we can do a
14260                      * combination of the current approach plus that one */
14261                     upper_parse = len;
14262                     len = 0;
14263                     s = s0;
14264                     goto reparse;
14265                 }
14266             }   /* End of verifying node ends with an appropriate char */
14267
14268           loopdone:   /* Jumped to when encounters something that shouldn't be
14269                          in the node */
14270
14271             /* I (khw) don't know if you can get here with zero length, but the
14272              * old code handled this situation by creating a zero-length EXACT
14273              * node.  Might as well be NOTHING instead */
14274             if (len == 0) {
14275                 OP(ret) = NOTHING;
14276             }
14277             else {
14278                 OP(ret) = node_type;
14279
14280                 /* If the node type is EXACT here, check to see if it
14281                  * should be EXACTL. */
14282                 if (node_type == EXACT) {
14283                     if (LOC) {
14284                         OP(ret) = EXACTL;
14285                     }
14286                 }
14287
14288                 if (FOLD) {
14289                     /* If 'maybe_exactfu' is set, then there are no code points
14290                      * that match differently depending on UTF8ness of the
14291                      * target string (for /u), or depending on locale for /l */
14292                     if (maybe_exactfu) {
14293                         if (node_type == EXACTF) {
14294                             OP(ret) = EXACTFU;
14295                         }
14296                         else if (node_type == EXACTFL) {
14297                             OP(ret) = EXACTFLU8;
14298                         }
14299                     }
14300                 }
14301
14302                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
14303                                            FALSE /* Don't look to see if could
14304                                                     be turned into an EXACT
14305                                                     node, as we have already
14306                                                     computed that */
14307                                           );
14308             }
14309
14310             RExC_parse = p - 1;
14311             Set_Node_Cur_Length(ret, parse_start);
14312             RExC_parse = p;
14313             {
14314                 /* len is STRLEN which is unsigned, need to copy to signed */
14315                 IV iv = len;
14316                 if (iv < 0)
14317                     vFAIL("Internal disaster");
14318             }
14319
14320         } /* End of label 'defchar:' */
14321         break;
14322     } /* End of giant switch on input character */
14323
14324     /* Position parse to next real character */
14325     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14326                                             FALSE /* Don't force to /x */ );
14327     if (   PASS2 && *RExC_parse == '{'
14328         && OP(ret) != SBOL && ! regcurly(RExC_parse))
14329     {
14330         if (RExC_strict || new_regcurly(RExC_parse, RExC_end)) {
14331             RExC_parse++;
14332             vFAIL("Unescaped left brace in regex is illegal here");
14333         }
14334         ckWARNreg(RExC_parse + 1, "Unescaped left brace in regex is"
14335                                   " passed through");
14336     }
14337
14338     return(ret);
14339 }
14340
14341
14342 STATIC void
14343 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
14344 {
14345     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
14346      * sets up the bitmap and any flags, removing those code points from the
14347      * inversion list, setting it to NULL should it become completely empty */
14348
14349     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
14350     assert(PL_regkind[OP(node)] == ANYOF);
14351
14352     ANYOF_BITMAP_ZERO(node);
14353     if (*invlist_ptr) {
14354
14355         /* This gets set if we actually need to modify things */
14356         bool change_invlist = FALSE;
14357
14358         UV start, end;
14359
14360         /* Start looking through *invlist_ptr */
14361         invlist_iterinit(*invlist_ptr);
14362         while (invlist_iternext(*invlist_ptr, &start, &end)) {
14363             UV high;
14364             int i;
14365
14366             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
14367                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
14368             }
14369
14370             /* Quit if are above what we should change */
14371             if (start >= NUM_ANYOF_CODE_POINTS) {
14372                 break;
14373             }
14374
14375             change_invlist = TRUE;
14376
14377             /* Set all the bits in the range, up to the max that we are doing */
14378             high = (end < NUM_ANYOF_CODE_POINTS - 1)
14379                    ? end
14380                    : NUM_ANYOF_CODE_POINTS - 1;
14381             for (i = start; i <= (int) high; i++) {
14382                 if (! ANYOF_BITMAP_TEST(node, i)) {
14383                     ANYOF_BITMAP_SET(node, i);
14384                 }
14385             }
14386         }
14387         invlist_iterfinish(*invlist_ptr);
14388
14389         /* Done with loop; remove any code points that are in the bitmap from
14390          * *invlist_ptr; similarly for code points above the bitmap if we have
14391          * a flag to match all of them anyways */
14392         if (change_invlist) {
14393             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
14394         }
14395         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
14396             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
14397         }
14398
14399         /* If have completely emptied it, remove it completely */
14400         if (_invlist_len(*invlist_ptr) == 0) {
14401             SvREFCNT_dec_NN(*invlist_ptr);
14402             *invlist_ptr = NULL;
14403         }
14404     }
14405 }
14406
14407 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
14408    Character classes ([:foo:]) can also be negated ([:^foo:]).
14409    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
14410    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
14411    but trigger failures because they are currently unimplemented. */
14412
14413 #define POSIXCC_DONE(c)   ((c) == ':')
14414 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
14415 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
14416 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
14417
14418 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
14419 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
14420 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
14421
14422 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
14423
14424 /* 'posix_warnings' and 'warn_text' are names of variables in the following
14425  * routine. q.v. */
14426 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
14427         if (posix_warnings) {                                               \
14428             if (! RExC_warn_text ) RExC_warn_text = (AV *) sv_2mortal((SV *) newAV()); \
14429             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                          \
14430                                              WARNING_PREFIX                 \
14431                                              text                           \
14432                                              REPORT_LOCATION,               \
14433                                              REPORT_LOCATION_ARGS(p)));     \
14434         }                                                                   \
14435     } STMT_END
14436 #define CLEAR_POSIX_WARNINGS()                                              \
14437     STMT_START {                                                            \
14438         if (posix_warnings && RExC_warn_text)                               \
14439             av_clear(RExC_warn_text);                                       \
14440     } STMT_END
14441
14442 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
14443     STMT_START {                                                            \
14444         CLEAR_POSIX_WARNINGS();                                             \
14445         return ret;                                                         \
14446     } STMT_END
14447
14448 STATIC int
14449 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
14450
14451     const char * const s,      /* Where the putative posix class begins.
14452                                   Normally, this is one past the '['.  This
14453                                   parameter exists so it can be somewhere
14454                                   besides RExC_parse. */
14455     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
14456                                   NULL */
14457     AV ** posix_warnings,      /* Where to place any generated warnings, or
14458                                   NULL */
14459     const bool check_only      /* Don't die if error */
14460 )
14461 {
14462     /* This parses what the caller thinks may be one of the three POSIX
14463      * constructs:
14464      *  1) a character class, like [:blank:]
14465      *  2) a collating symbol, like [. .]
14466      *  3) an equivalence class, like [= =]
14467      * In the latter two cases, it croaks if it finds a syntactically legal
14468      * one, as these are not handled by Perl.
14469      *
14470      * The main purpose is to look for a POSIX character class.  It returns:
14471      *  a) the class number
14472      *      if it is a completely syntactically and semantically legal class.
14473      *      'updated_parse_ptr', if not NULL, is set to point to just after the
14474      *      closing ']' of the class
14475      *  b) OOB_NAMEDCLASS
14476      *      if it appears that one of the three POSIX constructs was meant, but
14477      *      its specification was somehow defective.  'updated_parse_ptr', if
14478      *      not NULL, is set to point to the character just after the end
14479      *      character of the class.  See below for handling of warnings.
14480      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
14481      *      if it  doesn't appear that a POSIX construct was intended.
14482      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
14483      *      raised.
14484      *
14485      * In b) there may be errors or warnings generated.  If 'check_only' is
14486      * TRUE, then any errors are discarded.  Warnings are returned to the
14487      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
14488      * instead it is NULL, warnings are suppressed.  This is done in all
14489      * passes.  The reason for this is that the rest of the parsing is heavily
14490      * dependent on whether this routine found a valid posix class or not.  If
14491      * it did, the closing ']' is absorbed as part of the class.  If no class,
14492      * or an invalid one is found, any ']' will be considered the terminator of
14493      * the outer bracketed character class, leading to very different results.
14494      * In particular, a '(?[ ])' construct will likely have a syntax error if
14495      * the class is parsed other than intended, and this will happen in pass1,
14496      * before the warnings would normally be output.  This mechanism allows the
14497      * caller to output those warnings in pass1 just before dieing, giving a
14498      * much better clue as to what is wrong.
14499      *
14500      * The reason for this function, and its complexity is that a bracketed
14501      * character class can contain just about anything.  But it's easy to
14502      * mistype the very specific posix class syntax but yielding a valid
14503      * regular bracketed class, so it silently gets compiled into something
14504      * quite unintended.
14505      *
14506      * The solution adopted here maintains backward compatibility except that
14507      * it adds a warning if it looks like a posix class was intended but
14508      * improperly specified.  The warning is not raised unless what is input
14509      * very closely resembles one of the 14 legal posix classes.  To do this,
14510      * it uses fuzzy parsing.  It calculates how many single-character edits it
14511      * would take to transform what was input into a legal posix class.  Only
14512      * if that number is quite small does it think that the intention was a
14513      * posix class.  Obviously these are heuristics, and there will be cases
14514      * where it errs on one side or another, and they can be tweaked as
14515      * experience informs.
14516      *
14517      * The syntax for a legal posix class is:
14518      *
14519      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
14520      *
14521      * What this routine considers syntactically to be an intended posix class
14522      * is this (the comments indicate some restrictions that the pattern
14523      * doesn't show):
14524      *
14525      *  qr/(?x: \[?                         # The left bracket, possibly
14526      *                                      # omitted
14527      *          \h*                         # possibly followed by blanks
14528      *          (?: \^ \h* )?               # possibly a misplaced caret
14529      *          [:;]?                       # The opening class character,
14530      *                                      # possibly omitted.  A typo
14531      *                                      # semi-colon can also be used.
14532      *          \h*
14533      *          \^?                         # possibly a correctly placed
14534      *                                      # caret, but not if there was also
14535      *                                      # a misplaced one
14536      *          \h*
14537      *          .{3,15}                     # The class name.  If there are
14538      *                                      # deviations from the legal syntax,
14539      *                                      # its edit distance must be close
14540      *                                      # to a real class name in order
14541      *                                      # for it to be considered to be
14542      *                                      # an intended posix class.
14543      *          \h*
14544      *          [[:punct:]]?                # The closing class character,
14545      *                                      # possibly omitted.  If not a colon
14546      *                                      # nor semi colon, the class name
14547      *                                      # must be even closer to a valid
14548      *                                      # one
14549      *          \h*
14550      *          \]?                         # The right bracket, possibly
14551      *                                      # omitted.
14552      *     )/
14553      *
14554      * In the above, \h must be ASCII-only.
14555      *
14556      * These are heuristics, and can be tweaked as field experience dictates.
14557      * There will be cases when someone didn't intend to specify a posix class
14558      * that this warns as being so.  The goal is to minimize these, while
14559      * maximizing the catching of things intended to be a posix class that
14560      * aren't parsed as such.
14561      */
14562
14563     const char* p             = s;
14564     const char * const e      = RExC_end;
14565     unsigned complement       = 0;      /* If to complement the class */
14566     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
14567     bool has_opening_bracket  = FALSE;
14568     bool has_opening_colon    = FALSE;
14569     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
14570                                                    valid class */
14571     const char * possible_end = NULL;   /* used for a 2nd parse pass */
14572     const char* name_start;             /* ptr to class name first char */
14573
14574     /* If the number of single-character typos the input name is away from a
14575      * legal name is no more than this number, it is considered to have meant
14576      * the legal name */
14577     int max_distance          = 2;
14578
14579     /* to store the name.  The size determines the maximum length before we
14580      * decide that no posix class was intended.  Should be at least
14581      * sizeof("alphanumeric") */
14582     UV input_text[15];
14583     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
14584
14585     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
14586
14587     CLEAR_POSIX_WARNINGS();
14588
14589     if (p >= e) {
14590         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
14591     }
14592
14593     if (*(p - 1) != '[') {
14594         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
14595         found_problem = TRUE;
14596     }
14597     else {
14598         has_opening_bracket = TRUE;
14599     }
14600
14601     /* They could be confused and think you can put spaces between the
14602      * components */
14603     if (isBLANK(*p)) {
14604         found_problem = TRUE;
14605
14606         do {
14607             p++;
14608         } while (p < e && isBLANK(*p));
14609
14610         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14611     }
14612
14613     /* For [. .] and [= =].  These are quite different internally from [: :],
14614      * so they are handled separately.  */
14615     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
14616                                             and 1 for at least one char in it
14617                                           */
14618     {
14619         const char open_char  = *p;
14620         const char * temp_ptr = p + 1;
14621
14622         /* These two constructs are not handled by perl, and if we find a
14623          * syntactically valid one, we croak.  khw, who wrote this code, finds
14624          * this explanation of them very unclear:
14625          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
14626          * And searching the rest of the internet wasn't very helpful either.
14627          * It looks like just about any byte can be in these constructs,
14628          * depending on the locale.  But unless the pattern is being compiled
14629          * under /l, which is very rare, Perl runs under the C or POSIX locale.
14630          * In that case, it looks like [= =] isn't allowed at all, and that
14631          * [. .] could be any single code point, but for longer strings the
14632          * constituent characters would have to be the ASCII alphabetics plus
14633          * the minus-hyphen.  Any sensible locale definition would limit itself
14634          * to these.  And any portable one definitely should.  Trying to parse
14635          * the general case is a nightmare (see [perl #127604]).  So, this code
14636          * looks only for interiors of these constructs that match:
14637          *      qr/.|[-\w]{2,}/
14638          * Using \w relaxes the apparent rules a little, without adding much
14639          * danger of mistaking something else for one of these constructs.
14640          *
14641          * [. .] in some implementations described on the internet is usable to
14642          * escape a character that otherwise is special in bracketed character
14643          * classes.  For example [.].] means a literal right bracket instead of
14644          * the ending of the class
14645          *
14646          * [= =] can legitimately contain a [. .] construct, but we don't
14647          * handle this case, as that [. .] construct will later get parsed
14648          * itself and croak then.  And [= =] is checked for even when not under
14649          * /l, as Perl has long done so.
14650          *
14651          * The code below relies on there being a trailing NUL, so it doesn't
14652          * have to keep checking if the parse ptr < e.
14653          */
14654         if (temp_ptr[1] == open_char) {
14655             temp_ptr++;
14656         }
14657         else while (    temp_ptr < e
14658                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
14659         {
14660             temp_ptr++;
14661         }
14662
14663         if (*temp_ptr == open_char) {
14664             temp_ptr++;
14665             if (*temp_ptr == ']') {
14666                 temp_ptr++;
14667                 if (! found_problem && ! check_only) {
14668                     RExC_parse = (char *) temp_ptr;
14669                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
14670                             "extensions", open_char, open_char);
14671                 }
14672
14673                 /* Here, the syntax wasn't completely valid, or else the call
14674                  * is to check-only */
14675                 if (updated_parse_ptr) {
14676                     *updated_parse_ptr = (char *) temp_ptr;
14677                 }
14678
14679                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
14680             }
14681         }
14682
14683         /* If we find something that started out to look like one of these
14684          * constructs, but isn't, we continue below so that it can be checked
14685          * for being a class name with a typo of '.' or '=' instead of a colon.
14686          * */
14687     }
14688
14689     /* Here, we think there is a possibility that a [: :] class was meant, and
14690      * we have the first real character.  It could be they think the '^' comes
14691      * first */
14692     if (*p == '^') {
14693         found_problem = TRUE;
14694         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
14695         complement = 1;
14696         p++;
14697
14698         if (isBLANK(*p)) {
14699             found_problem = TRUE;
14700
14701             do {
14702                 p++;
14703             } while (p < e && isBLANK(*p));
14704
14705             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14706         }
14707     }
14708
14709     /* But the first character should be a colon, which they could have easily
14710      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
14711      * distinguish from a colon, so treat that as a colon).  */
14712     if (*p == ':') {
14713         p++;
14714         has_opening_colon = TRUE;
14715     }
14716     else if (*p == ';') {
14717         found_problem = TRUE;
14718         p++;
14719         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14720         has_opening_colon = TRUE;
14721     }
14722     else {
14723         found_problem = TRUE;
14724         ADD_POSIX_WARNING(p, "there must be a starting ':'");
14725
14726         /* Consider an initial punctuation (not one of the recognized ones) to
14727          * be a left terminator */
14728         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
14729             p++;
14730         }
14731     }
14732
14733     /* They may think that you can put spaces between the components */
14734     if (isBLANK(*p)) {
14735         found_problem = TRUE;
14736
14737         do {
14738             p++;
14739         } while (p < e && isBLANK(*p));
14740
14741         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14742     }
14743
14744     if (*p == '^') {
14745
14746         /* We consider something like [^:^alnum:]] to not have been intended to
14747          * be a posix class, but XXX maybe we should */
14748         if (complement) {
14749             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14750         }
14751
14752         complement = 1;
14753         p++;
14754     }
14755
14756     /* Again, they may think that you can put spaces between the components */
14757     if (isBLANK(*p)) {
14758         found_problem = TRUE;
14759
14760         do {
14761             p++;
14762         } while (p < e && isBLANK(*p));
14763
14764         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14765     }
14766
14767     if (*p == ']') {
14768
14769         /* XXX This ']' may be a typo, and something else was meant.  But
14770          * treating it as such creates enough complications, that that
14771          * possibility isn't currently considered here.  So we assume that the
14772          * ']' is what is intended, and if we've already found an initial '[',
14773          * this leaves this construct looking like [:] or [:^], which almost
14774          * certainly weren't intended to be posix classes */
14775         if (has_opening_bracket) {
14776             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14777         }
14778
14779         /* But this function can be called when we parse the colon for
14780          * something like qr/[alpha:]]/, so we back up to look for the
14781          * beginning */
14782         p--;
14783
14784         if (*p == ';') {
14785             found_problem = TRUE;
14786             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14787         }
14788         else if (*p != ':') {
14789
14790             /* XXX We are currently very restrictive here, so this code doesn't
14791              * consider the possibility that, say, /[alpha.]]/ was intended to
14792              * be a posix class. */
14793             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14794         }
14795
14796         /* Here we have something like 'foo:]'.  There was no initial colon,
14797          * and we back up over 'foo.  XXX Unlike the going forward case, we
14798          * don't handle typos of non-word chars in the middle */
14799         has_opening_colon = FALSE;
14800         p--;
14801
14802         while (p > RExC_start && isWORDCHAR(*p)) {
14803             p--;
14804         }
14805         p++;
14806
14807         /* Here, we have positioned ourselves to where we think the first
14808          * character in the potential class is */
14809     }
14810
14811     /* Now the interior really starts.  There are certain key characters that
14812      * can end the interior, or these could just be typos.  To catch both
14813      * cases, we may have to do two passes.  In the first pass, we keep on
14814      * going unless we come to a sequence that matches
14815      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
14816      * This means it takes a sequence to end the pass, so two typos in a row if
14817      * that wasn't what was intended.  If the class is perfectly formed, just
14818      * this one pass is needed.  We also stop if there are too many characters
14819      * being accumulated, but this number is deliberately set higher than any
14820      * real class.  It is set high enough so that someone who thinks that
14821      * 'alphanumeric' is a correct name would get warned that it wasn't.
14822      * While doing the pass, we keep track of where the key characters were in
14823      * it.  If we don't find an end to the class, and one of the key characters
14824      * was found, we redo the pass, but stop when we get to that character.
14825      * Thus the key character was considered a typo in the first pass, but a
14826      * terminator in the second.  If two key characters are found, we stop at
14827      * the second one in the first pass.  Again this can miss two typos, but
14828      * catches a single one
14829      *
14830      * In the first pass, 'possible_end' starts as NULL, and then gets set to
14831      * point to the first key character.  For the second pass, it starts as -1.
14832      * */
14833
14834     name_start = p;
14835   parse_name:
14836     {
14837         bool has_blank               = FALSE;
14838         bool has_upper               = FALSE;
14839         bool has_terminating_colon   = FALSE;
14840         bool has_terminating_bracket = FALSE;
14841         bool has_semi_colon          = FALSE;
14842         unsigned int name_len        = 0;
14843         int punct_count              = 0;
14844
14845         while (p < e) {
14846
14847             /* Squeeze out blanks when looking up the class name below */
14848             if (isBLANK(*p) ) {
14849                 has_blank = TRUE;
14850                 found_problem = TRUE;
14851                 p++;
14852                 continue;
14853             }
14854
14855             /* The name will end with a punctuation */
14856             if (isPUNCT(*p)) {
14857                 const char * peek = p + 1;
14858
14859                 /* Treat any non-']' punctuation followed by a ']' (possibly
14860                  * with intervening blanks) as trying to terminate the class.
14861                  * ']]' is very likely to mean a class was intended (but
14862                  * missing the colon), but the warning message that gets
14863                  * generated shows the error position better if we exit the
14864                  * loop at the bottom (eventually), so skip it here. */
14865                 if (*p != ']') {
14866                     if (peek < e && isBLANK(*peek)) {
14867                         has_blank = TRUE;
14868                         found_problem = TRUE;
14869                         do {
14870                             peek++;
14871                         } while (peek < e && isBLANK(*peek));
14872                     }
14873
14874                     if (peek < e && *peek == ']') {
14875                         has_terminating_bracket = TRUE;
14876                         if (*p == ':') {
14877                             has_terminating_colon = TRUE;
14878                         }
14879                         else if (*p == ';') {
14880                             has_semi_colon = TRUE;
14881                             has_terminating_colon = TRUE;
14882                         }
14883                         else {
14884                             found_problem = TRUE;
14885                         }
14886                         p = peek + 1;
14887                         goto try_posix;
14888                     }
14889                 }
14890
14891                 /* Here we have punctuation we thought didn't end the class.
14892                  * Keep track of the position of the key characters that are
14893                  * more likely to have been class-enders */
14894                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
14895
14896                     /* Allow just one such possible class-ender not actually
14897                      * ending the class. */
14898                     if (possible_end) {
14899                         break;
14900                     }
14901                     possible_end = p;
14902                 }
14903
14904                 /* If we have too many punctuation characters, no use in
14905                  * keeping going */
14906                 if (++punct_count > max_distance) {
14907                     break;
14908                 }
14909
14910                 /* Treat the punctuation as a typo. */
14911                 input_text[name_len++] = *p;
14912                 p++;
14913             }
14914             else if (isUPPER(*p)) { /* Use lowercase for lookup */
14915                 input_text[name_len++] = toLOWER(*p);
14916                 has_upper = TRUE;
14917                 found_problem = TRUE;
14918                 p++;
14919             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
14920                 input_text[name_len++] = *p;
14921                 p++;
14922             }
14923             else {
14924                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
14925                 p+= UTF8SKIP(p);
14926             }
14927
14928             /* The declaration of 'input_text' is how long we allow a potential
14929              * class name to be, before saying they didn't mean a class name at
14930              * all */
14931             if (name_len >= C_ARRAY_LENGTH(input_text)) {
14932                 break;
14933             }
14934         }
14935
14936         /* We get to here when the possible class name hasn't been properly
14937          * terminated before:
14938          *   1) we ran off the end of the pattern; or
14939          *   2) found two characters, each of which might have been intended to
14940          *      be the name's terminator
14941          *   3) found so many punctuation characters in the purported name,
14942          *      that the edit distance to a valid one is exceeded
14943          *   4) we decided it was more characters than anyone could have
14944          *      intended to be one. */
14945
14946         found_problem = TRUE;
14947
14948         /* In the final two cases, we know that looking up what we've
14949          * accumulated won't lead to a match, even a fuzzy one. */
14950         if (   name_len >= C_ARRAY_LENGTH(input_text)
14951             || punct_count > max_distance)
14952         {
14953             /* If there was an intermediate key character that could have been
14954              * an intended end, redo the parse, but stop there */
14955             if (possible_end && possible_end != (char *) -1) {
14956                 possible_end = (char *) -1; /* Special signal value to say
14957                                                we've done a first pass */
14958                 p = name_start;
14959                 goto parse_name;
14960             }
14961
14962             /* Otherwise, it can't have meant to have been a class */
14963             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14964         }
14965
14966         /* If we ran off the end, and the final character was a punctuation
14967          * one, back up one, to look at that final one just below.  Later, we
14968          * will restore the parse pointer if appropriate */
14969         if (name_len && p == e && isPUNCT(*(p-1))) {
14970             p--;
14971             name_len--;
14972         }
14973
14974         if (p < e && isPUNCT(*p)) {
14975             if (*p == ']') {
14976                 has_terminating_bracket = TRUE;
14977
14978                 /* If this is a 2nd ']', and the first one is just below this
14979                  * one, consider that to be the real terminator.  This gives a
14980                  * uniform and better positioning for the warning message  */
14981                 if (   possible_end
14982                     && possible_end != (char *) -1
14983                     && *possible_end == ']'
14984                     && name_len && input_text[name_len - 1] == ']')
14985                 {
14986                     name_len--;
14987                     p = possible_end;
14988
14989                     /* And this is actually equivalent to having done the 2nd
14990                      * pass now, so set it to not try again */
14991                     possible_end = (char *) -1;
14992                 }
14993             }
14994             else {
14995                 if (*p == ':') {
14996                     has_terminating_colon = TRUE;
14997                 }
14998                 else if (*p == ';') {
14999                     has_semi_colon = TRUE;
15000                     has_terminating_colon = TRUE;
15001                 }
15002                 p++;
15003             }
15004         }
15005
15006     try_posix:
15007
15008         /* Here, we have a class name to look up.  We can short circuit the
15009          * stuff below for short names that can't possibly be meant to be a
15010          * class name.  (We can do this on the first pass, as any second pass
15011          * will yield an even shorter name) */
15012         if (name_len < 3) {
15013             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15014         }
15015
15016         /* Find which class it is.  Initially switch on the length of the name.
15017          * */
15018         switch (name_len) {
15019             case 4:
15020                 if (memEQs(name_start, 4, "word")) {
15021                     /* this is not POSIX, this is the Perl \w */
15022                     class_number = ANYOF_WORDCHAR;
15023                 }
15024                 break;
15025             case 5:
15026                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
15027                  *                        graph lower print punct space upper
15028                  * Offset 4 gives the best switch position.  */
15029                 switch (name_start[4]) {
15030                     case 'a':
15031                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
15032                             class_number = ANYOF_ALPHA;
15033                         break;
15034                     case 'e':
15035                         if (memBEGINs(name_start, 5, "spac")) /* space */
15036                             class_number = ANYOF_SPACE;
15037                         break;
15038                     case 'h':
15039                         if (memBEGINs(name_start, 5, "grap")) /* graph */
15040                             class_number = ANYOF_GRAPH;
15041                         break;
15042                     case 'i':
15043                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
15044                             class_number = ANYOF_ASCII;
15045                         break;
15046                     case 'k':
15047                         if (memBEGINs(name_start, 5, "blan")) /* blank */
15048                             class_number = ANYOF_BLANK;
15049                         break;
15050                     case 'l':
15051                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
15052                             class_number = ANYOF_CNTRL;
15053                         break;
15054                     case 'm':
15055                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
15056                             class_number = ANYOF_ALPHANUMERIC;
15057                         break;
15058                     case 'r':
15059                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
15060                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
15061                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
15062                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
15063                         break;
15064                     case 't':
15065                         if (memBEGINs(name_start, 5, "digi")) /* digit */
15066                             class_number = ANYOF_DIGIT;
15067                         else if (memBEGINs(name_start, 5, "prin")) /* print */
15068                             class_number = ANYOF_PRINT;
15069                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
15070                             class_number = ANYOF_PUNCT;
15071                         break;
15072                 }
15073                 break;
15074             case 6:
15075                 if (memEQs(name_start, 6, "xdigit"))
15076                     class_number = ANYOF_XDIGIT;
15077                 break;
15078         }
15079
15080         /* If the name exactly matches a posix class name the class number will
15081          * here be set to it, and the input almost certainly was meant to be a
15082          * posix class, so we can skip further checking.  If instead the syntax
15083          * is exactly correct, but the name isn't one of the legal ones, we
15084          * will return that as an error below.  But if neither of these apply,
15085          * it could be that no posix class was intended at all, or that one
15086          * was, but there was a typo.  We tease these apart by doing fuzzy
15087          * matching on the name */
15088         if (class_number == OOB_NAMEDCLASS && found_problem) {
15089             const UV posix_names[][6] = {
15090                                                 { 'a', 'l', 'n', 'u', 'm' },
15091                                                 { 'a', 'l', 'p', 'h', 'a' },
15092                                                 { 'a', 's', 'c', 'i', 'i' },
15093                                                 { 'b', 'l', 'a', 'n', 'k' },
15094                                                 { 'c', 'n', 't', 'r', 'l' },
15095                                                 { 'd', 'i', 'g', 'i', 't' },
15096                                                 { 'g', 'r', 'a', 'p', 'h' },
15097                                                 { 'l', 'o', 'w', 'e', 'r' },
15098                                                 { 'p', 'r', 'i', 'n', 't' },
15099                                                 { 'p', 'u', 'n', 'c', 't' },
15100                                                 { 's', 'p', 'a', 'c', 'e' },
15101                                                 { 'u', 'p', 'p', 'e', 'r' },
15102                                                 { 'w', 'o', 'r', 'd' },
15103                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
15104                                             };
15105             /* The names of the above all have added NULs to make them the same
15106              * size, so we need to also have the real lengths */
15107             const UV posix_name_lengths[] = {
15108                                                 sizeof("alnum") - 1,
15109                                                 sizeof("alpha") - 1,
15110                                                 sizeof("ascii") - 1,
15111                                                 sizeof("blank") - 1,
15112                                                 sizeof("cntrl") - 1,
15113                                                 sizeof("digit") - 1,
15114                                                 sizeof("graph") - 1,
15115                                                 sizeof("lower") - 1,
15116                                                 sizeof("print") - 1,
15117                                                 sizeof("punct") - 1,
15118                                                 sizeof("space") - 1,
15119                                                 sizeof("upper") - 1,
15120                                                 sizeof("word")  - 1,
15121                                                 sizeof("xdigit")- 1
15122                                             };
15123             unsigned int i;
15124             int temp_max = max_distance;    /* Use a temporary, so if we
15125                                                reparse, we haven't changed the
15126                                                outer one */
15127
15128             /* Use a smaller max edit distance if we are missing one of the
15129              * delimiters */
15130             if (   has_opening_bracket + has_opening_colon < 2
15131                 || has_terminating_bracket + has_terminating_colon < 2)
15132             {
15133                 temp_max--;
15134             }
15135
15136             /* See if the input name is close to a legal one */
15137             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
15138
15139                 /* Short circuit call if the lengths are too far apart to be
15140                  * able to match */
15141                 if (abs( (int) (name_len - posix_name_lengths[i]))
15142                     > temp_max)
15143                 {
15144                     continue;
15145                 }
15146
15147                 if (edit_distance(input_text,
15148                                   posix_names[i],
15149                                   name_len,
15150                                   posix_name_lengths[i],
15151                                   temp_max
15152                                  )
15153                     > -1)
15154                 { /* If it is close, it probably was intended to be a class */
15155                     goto probably_meant_to_be;
15156                 }
15157             }
15158
15159             /* Here the input name is not close enough to a valid class name
15160              * for us to consider it to be intended to be a posix class.  If
15161              * we haven't already done so, and the parse found a character that
15162              * could have been terminators for the name, but which we absorbed
15163              * as typos during the first pass, repeat the parse, signalling it
15164              * to stop at that character */
15165             if (possible_end && possible_end != (char *) -1) {
15166                 possible_end = (char *) -1;
15167                 p = name_start;
15168                 goto parse_name;
15169             }
15170
15171             /* Here neither pass found a close-enough class name */
15172             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15173         }
15174
15175     probably_meant_to_be:
15176
15177         /* Here we think that a posix specification was intended.  Update any
15178          * parse pointer */
15179         if (updated_parse_ptr) {
15180             *updated_parse_ptr = (char *) p;
15181         }
15182
15183         /* If a posix class name was intended but incorrectly specified, we
15184          * output or return the warnings */
15185         if (found_problem) {
15186
15187             /* We set flags for these issues in the parse loop above instead of
15188              * adding them to the list of warnings, because we can parse it
15189              * twice, and we only want one warning instance */
15190             if (has_upper) {
15191                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
15192             }
15193             if (has_blank) {
15194                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15195             }
15196             if (has_semi_colon) {
15197                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15198             }
15199             else if (! has_terminating_colon) {
15200                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
15201             }
15202             if (! has_terminating_bracket) {
15203                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
15204             }
15205
15206             if (posix_warnings && RExC_warn_text && av_top_index(RExC_warn_text) > -1) {
15207                 *posix_warnings = RExC_warn_text;
15208             }
15209         }
15210         else if (class_number != OOB_NAMEDCLASS) {
15211             /* If it is a known class, return the class.  The class number
15212              * #defines are structured so each complement is +1 to the normal
15213              * one */
15214             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
15215         }
15216         else if (! check_only) {
15217
15218             /* Here, it is an unrecognized class.  This is an error (unless the
15219             * call is to check only, which we've already handled above) */
15220             const char * const complement_string = (complement)
15221                                                    ? "^"
15222                                                    : "";
15223             RExC_parse = (char *) p;
15224             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
15225                         complement_string,
15226                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
15227         }
15228     }
15229
15230     return OOB_NAMEDCLASS;
15231 }
15232 #undef ADD_POSIX_WARNING
15233
15234 STATIC unsigned  int
15235 S_regex_set_precedence(const U8 my_operator) {
15236
15237     /* Returns the precedence in the (?[...]) construct of the input operator,
15238      * specified by its character representation.  The precedence follows
15239      * general Perl rules, but it extends this so that ')' and ']' have (low)
15240      * precedence even though they aren't really operators */
15241
15242     switch (my_operator) {
15243         case '!':
15244             return 5;
15245         case '&':
15246             return 4;
15247         case '^':
15248         case '|':
15249         case '+':
15250         case '-':
15251             return 3;
15252         case ')':
15253             return 2;
15254         case ']':
15255             return 1;
15256     }
15257
15258     NOT_REACHED; /* NOTREACHED */
15259     return 0;   /* Silence compiler warning */
15260 }
15261
15262 STATIC regnode *
15263 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
15264                     I32 *flagp, U32 depth,
15265                     char * const oregcomp_parse)
15266 {
15267     /* Handle the (?[...]) construct to do set operations */
15268
15269     U8 curchar;                     /* Current character being parsed */
15270     UV start, end;                  /* End points of code point ranges */
15271     SV* final = NULL;               /* The end result inversion list */
15272     SV* result_string;              /* 'final' stringified */
15273     AV* stack;                      /* stack of operators and operands not yet
15274                                        resolved */
15275     AV* fence_stack = NULL;         /* A stack containing the positions in
15276                                        'stack' of where the undealt-with left
15277                                        parens would be if they were actually
15278                                        put there */
15279     /* The 'volatile' is a workaround for an optimiser bug
15280      * in Solaris Studio 12.3. See RT #127455 */
15281     volatile IV fence = 0;          /* Position of where most recent undealt-
15282                                        with left paren in stack is; -1 if none.
15283                                      */
15284     STRLEN len;                     /* Temporary */
15285     regnode* node;                  /* Temporary, and final regnode returned by
15286                                        this function */
15287     const bool save_fold = FOLD;    /* Temporary */
15288     char *save_end, *save_parse;    /* Temporaries */
15289     const bool in_locale = LOC;     /* we turn off /l during processing */
15290     AV* posix_warnings = NULL;
15291
15292     GET_RE_DEBUG_FLAGS_DECL;
15293
15294     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
15295
15296     DEBUG_PARSE("xcls");
15297
15298     if (in_locale) {
15299         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
15300     }
15301
15302     REQUIRE_UNI_RULES(flagp, NULL);   /* The use of this operator implies /u.
15303                                          This is required so that the compile
15304                                          time values are valid in all runtime
15305                                          cases */
15306
15307     /* This will return only an ANYOF regnode, or (unlikely) something smaller
15308      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
15309      * call regclass to handle '[]' so as to not have to reinvent its parsing
15310      * rules here (throwing away the size it computes each time).  And, we exit
15311      * upon an unescaped ']' that isn't one ending a regclass.  To do both
15312      * these things, we need to realize that something preceded by a backslash
15313      * is escaped, so we have to keep track of backslashes */
15314     if (SIZE_ONLY) {
15315         UV nest_depth = 0; /* how many nested (?[...]) constructs */
15316
15317         while (RExC_parse < RExC_end) {
15318             SV* current = NULL;
15319
15320             skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15321                                     TRUE /* Force /x */ );
15322
15323             switch (*RExC_parse) {
15324                 case '(':
15325                     if (RExC_parse[1] == '?' && RExC_parse[2] == '[')
15326                         nest_depth++, RExC_parse+=2;
15327                     /* FALLTHROUGH */
15328                 default:
15329                     break;
15330                 case '\\':
15331                     /* Skip past this, so the next character gets skipped, after
15332                      * the switch */
15333                     RExC_parse++;
15334                     if (*RExC_parse == 'c') {
15335                             /* Skip the \cX notation for control characters */
15336                             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15337                     }
15338                     break;
15339
15340                 case '[':
15341                 {
15342                     /* See if this is a [:posix:] class. */
15343                     bool is_posix_class = (OOB_NAMEDCLASS
15344                             < handle_possible_posix(pRExC_state,
15345                                                 RExC_parse + 1,
15346                                                 NULL,
15347                                                 NULL,
15348                                                 TRUE /* checking only */));
15349                     /* If it is a posix class, leave the parse pointer at the
15350                      * '[' to fool regclass() into thinking it is part of a
15351                      * '[[:posix:]]'. */
15352                     if (! is_posix_class) {
15353                         RExC_parse++;
15354                     }
15355
15356                     /* regclass() can only return RESTART_PASS1 and NEED_UTF8
15357                      * if multi-char folds are allowed.  */
15358                     if (!regclass(pRExC_state, flagp,depth+1,
15359                                   is_posix_class, /* parse the whole char
15360                                                      class only if not a
15361                                                      posix class */
15362                                   FALSE, /* don't allow multi-char folds */
15363                                   TRUE, /* silence non-portable warnings. */
15364                                   TRUE, /* strict */
15365                                   FALSE, /* Require return to be an ANYOF */
15366                                   &current,
15367                                   &posix_warnings
15368                                  ))
15369                         FAIL2("panic: regclass returned NULL to handle_sets, "
15370                               "flags=%#" UVxf, (UV) *flagp);
15371
15372                     /* function call leaves parse pointing to the ']', except
15373                      * if we faked it */
15374                     if (is_posix_class) {
15375                         RExC_parse--;
15376                     }
15377
15378                     SvREFCNT_dec(current);   /* In case it returned something */
15379                     break;
15380                 }
15381
15382                 case ']':
15383                     if (RExC_parse[1] == ')') {
15384                         RExC_parse++;
15385                         if (nest_depth--) break;
15386                         node = reganode(pRExC_state, ANYOF, 0);
15387                         RExC_size += ANYOF_SKIP;
15388                         nextchar(pRExC_state);
15389                         Set_Node_Length(node,
15390                                 RExC_parse - oregcomp_parse + 1); /* MJD */
15391                         if (in_locale) {
15392                             set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
15393                         }
15394
15395                         return node;
15396                     }
15397                     /* We output the messages even if warnings are off, because we'll fail
15398                      * the very next thing, and these give a likely diagnosis for that */
15399                     if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15400                         output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15401                     }
15402                     RExC_parse++;
15403                     vFAIL("Unexpected ']' with no following ')' in (?[...");
15404             }
15405
15406             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15407         }
15408
15409         /* We output the messages even if warnings are off, because we'll fail
15410          * the very next thing, and these give a likely diagnosis for that */
15411         if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15412             output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15413         }
15414
15415         vFAIL("Syntax error in (?[...])");
15416     }
15417
15418     /* Pass 2 only after this. */
15419     Perl_ck_warner_d(aTHX_
15420         packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
15421         "The regex_sets feature is experimental" REPORT_LOCATION,
15422         REPORT_LOCATION_ARGS(RExC_parse));
15423
15424     /* Everything in this construct is a metacharacter.  Operands begin with
15425      * either a '\' (for an escape sequence), or a '[' for a bracketed
15426      * character class.  Any other character should be an operator, or
15427      * parenthesis for grouping.  Both types of operands are handled by calling
15428      * regclass() to parse them.  It is called with a parameter to indicate to
15429      * return the computed inversion list.  The parsing here is implemented via
15430      * a stack.  Each entry on the stack is a single character representing one
15431      * of the operators; or else a pointer to an operand inversion list. */
15432
15433 #define IS_OPERATOR(a) SvIOK(a)
15434 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15435
15436     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15437      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15438      * with pronouncing it called it Reverse Polish instead, but now that YOU
15439      * know how to pronounce it you can use the correct term, thus giving due
15440      * credit to the person who invented it, and impressing your geek friends.
15441      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15442      * it is now more like an English initial W (as in wonk) than an L.)
15443      *
15444      * This means that, for example, 'a | b & c' is stored on the stack as
15445      *
15446      * c  [4]
15447      * b  [3]
15448      * &  [2]
15449      * a  [1]
15450      * |  [0]
15451      *
15452      * where the numbers in brackets give the stack [array] element number.
15453      * In this implementation, parentheses are not stored on the stack.
15454      * Instead a '(' creates a "fence" so that the part of the stack below the
15455      * fence is invisible except to the corresponding ')' (this allows us to
15456      * replace testing for parens, by using instead subtraction of the fence
15457      * position).  As new operands are processed they are pushed onto the stack
15458      * (except as noted in the next paragraph).  New operators of higher
15459      * precedence than the current final one are inserted on the stack before
15460      * the lhs operand (so that when the rhs is pushed next, everything will be
15461      * in the correct positions shown above.  When an operator of equal or
15462      * lower precedence is encountered in parsing, all the stacked operations
15463      * of equal or higher precedence are evaluated, leaving the result as the
15464      * top entry on the stack.  This makes higher precedence operations
15465      * evaluate before lower precedence ones, and causes operations of equal
15466      * precedence to left associate.
15467      *
15468      * The only unary operator '!' is immediately pushed onto the stack when
15469      * encountered.  When an operand is encountered, if the top of the stack is
15470      * a '!", the complement is immediately performed, and the '!' popped.  The
15471      * resulting value is treated as a new operand, and the logic in the
15472      * previous paragraph is executed.  Thus in the expression
15473      *      [a] + ! [b]
15474      * the stack looks like
15475      *
15476      * !
15477      * a
15478      * +
15479      *
15480      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
15481      * becomes
15482      *
15483      * !b
15484      * a
15485      * +
15486      *
15487      * A ')' is treated as an operator with lower precedence than all the
15488      * aforementioned ones, which causes all operations on the stack above the
15489      * corresponding '(' to be evaluated down to a single resultant operand.
15490      * Then the fence for the '(' is removed, and the operand goes through the
15491      * algorithm above, without the fence.
15492      *
15493      * A separate stack is kept of the fence positions, so that the position of
15494      * the latest so-far unbalanced '(' is at the top of it.
15495      *
15496      * The ']' ending the construct is treated as the lowest operator of all,
15497      * so that everything gets evaluated down to a single operand, which is the
15498      * result */
15499
15500     sv_2mortal((SV *)(stack = newAV()));
15501     sv_2mortal((SV *)(fence_stack = newAV()));
15502
15503     while (RExC_parse < RExC_end) {
15504         I32 top_index;              /* Index of top-most element in 'stack' */
15505         SV** top_ptr;               /* Pointer to top 'stack' element */
15506         SV* current = NULL;         /* To contain the current inversion list
15507                                        operand */
15508         SV* only_to_avoid_leaks;
15509
15510         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15511                                 TRUE /* Force /x */ );
15512         if (RExC_parse >= RExC_end) {
15513             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
15514         }
15515
15516         curchar = UCHARAT(RExC_parse);
15517
15518 redo_curchar:
15519
15520 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15521                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
15522         DEBUG_U(dump_regex_sets_structures(pRExC_state,
15523                                            stack, fence, fence_stack));
15524 #endif
15525
15526         top_index = av_tindex_skip_len_mg(stack);
15527
15528         switch (curchar) {
15529             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
15530             char stacked_operator;  /* The topmost operator on the 'stack'. */
15531             SV* lhs;                /* Operand to the left of the operator */
15532             SV* rhs;                /* Operand to the right of the operator */
15533             SV* fence_ptr;          /* Pointer to top element of the fence
15534                                        stack */
15535
15536             case '(':
15537
15538                 if (   RExC_parse < RExC_end - 1
15539                     && (UCHARAT(RExC_parse + 1) == '?'))
15540                 {
15541                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
15542                      * This happens when we have some thing like
15543                      *
15544                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
15545                      *   ...
15546                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
15547                      *
15548                      * Here we would be handling the interpolated
15549                      * '$thai_or_lao'.  We handle this by a recursive call to
15550                      * ourselves which returns the inversion list the
15551                      * interpolated expression evaluates to.  We use the flags
15552                      * from the interpolated pattern. */
15553                     U32 save_flags = RExC_flags;
15554                     const char * save_parse;
15555
15556                     RExC_parse += 2;        /* Skip past the '(?' */
15557                     save_parse = RExC_parse;
15558
15559                     /* Parse any flags for the '(?' */
15560                     parse_lparen_question_flags(pRExC_state);
15561
15562                     if (RExC_parse == save_parse  /* Makes sure there was at
15563                                                      least one flag (or else
15564                                                      this embedding wasn't
15565                                                      compiled) */
15566                         || RExC_parse >= RExC_end - 4
15567                         || UCHARAT(RExC_parse) != ':'
15568                         || UCHARAT(++RExC_parse) != '('
15569                         || UCHARAT(++RExC_parse) != '?'
15570                         || UCHARAT(++RExC_parse) != '[')
15571                     {
15572
15573                         /* In combination with the above, this moves the
15574                          * pointer to the point just after the first erroneous
15575                          * character (or if there are no flags, to where they
15576                          * should have been) */
15577                         if (RExC_parse >= RExC_end - 4) {
15578                             RExC_parse = RExC_end;
15579                         }
15580                         else if (RExC_parse != save_parse) {
15581                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15582                         }
15583                         vFAIL("Expecting '(?flags:(?[...'");
15584                     }
15585
15586                     /* Recurse, with the meat of the embedded expression */
15587                     RExC_parse++;
15588                     (void) handle_regex_sets(pRExC_state, &current, flagp,
15589                                                     depth+1, oregcomp_parse);
15590
15591                     /* Here, 'current' contains the embedded expression's
15592                      * inversion list, and RExC_parse points to the trailing
15593                      * ']'; the next character should be the ')' */
15594                     RExC_parse++;
15595                     if (UCHARAT(RExC_parse) != ')')
15596                         vFAIL("Expecting close paren for nested extended charclass");
15597
15598                     /* Then the ')' matching the original '(' handled by this
15599                      * case: statement */
15600                     RExC_parse++;
15601                     if (UCHARAT(RExC_parse) != ')')
15602                         vFAIL("Expecting close paren for wrapper for nested extended charclass");
15603
15604                     RExC_parse++;
15605                     RExC_flags = save_flags;
15606                     goto handle_operand;
15607                 }
15608
15609                 /* A regular '('.  Look behind for illegal syntax */
15610                 if (top_index - fence >= 0) {
15611                     /* If the top entry on the stack is an operator, it had
15612                      * better be a '!', otherwise the entry below the top
15613                      * operand should be an operator */
15614                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
15615                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
15616                         || (   IS_OPERAND(*top_ptr)
15617                             && (   top_index - fence < 1
15618                                 || ! (stacked_ptr = av_fetch(stack,
15619                                                              top_index - 1,
15620                                                              FALSE))
15621                                 || ! IS_OPERATOR(*stacked_ptr))))
15622                     {
15623                         RExC_parse++;
15624                         vFAIL("Unexpected '(' with no preceding operator");
15625                     }
15626                 }
15627
15628                 /* Stack the position of this undealt-with left paren */
15629                 av_push(fence_stack, newSViv(fence));
15630                 fence = top_index + 1;
15631                 break;
15632
15633             case '\\':
15634                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15635                  * multi-char folds are allowed.  */
15636                 if (!regclass(pRExC_state, flagp,depth+1,
15637                               TRUE, /* means parse just the next thing */
15638                               FALSE, /* don't allow multi-char folds */
15639                               FALSE, /* don't silence non-portable warnings.  */
15640                               TRUE,  /* strict */
15641                               FALSE, /* Require return to be an ANYOF */
15642                               &current,
15643                               NULL))
15644                 {
15645                     FAIL2("panic: regclass returned NULL to handle_sets, "
15646                           "flags=%#" UVxf, (UV) *flagp);
15647                 }
15648
15649                 /* regclass() will return with parsing just the \ sequence,
15650                  * leaving the parse pointer at the next thing to parse */
15651                 RExC_parse--;
15652                 goto handle_operand;
15653
15654             case '[':   /* Is a bracketed character class */
15655             {
15656                 /* See if this is a [:posix:] class. */
15657                 bool is_posix_class = (OOB_NAMEDCLASS
15658                             < handle_possible_posix(pRExC_state,
15659                                                 RExC_parse + 1,
15660                                                 NULL,
15661                                                 NULL,
15662                                                 TRUE /* checking only */));
15663                 /* If it is a posix class, leave the parse pointer at the '['
15664                  * to fool regclass() into thinking it is part of a
15665                  * '[[:posix:]]'. */
15666                 if (! is_posix_class) {
15667                     RExC_parse++;
15668                 }
15669
15670                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15671                  * multi-char folds are allowed.  */
15672                 if (!regclass(pRExC_state, flagp,depth+1,
15673                                 is_posix_class, /* parse the whole char
15674                                                     class only if not a
15675                                                     posix class */
15676                                 FALSE, /* don't allow multi-char folds */
15677                                 TRUE, /* silence non-portable warnings. */
15678                                 TRUE, /* strict */
15679                                 FALSE, /* Require return to be an ANYOF */
15680                                 &current,
15681                                 NULL
15682                                 ))
15683                 {
15684                     FAIL2("panic: regclass returned NULL to handle_sets, "
15685                           "flags=%#" UVxf, (UV) *flagp);
15686                 }
15687
15688                 /* function call leaves parse pointing to the ']', except if we
15689                  * faked it */
15690                 if (is_posix_class) {
15691                     RExC_parse--;
15692                 }
15693
15694                 goto handle_operand;
15695             }
15696
15697             case ']':
15698                 if (top_index >= 1) {
15699                     goto join_operators;
15700                 }
15701
15702                 /* Only a single operand on the stack: are done */
15703                 goto done;
15704
15705             case ')':
15706                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
15707                     RExC_parse++;
15708                     vFAIL("Unexpected ')'");
15709                 }
15710
15711                 /* If nothing after the fence, is missing an operand */
15712                 if (top_index - fence < 0) {
15713                     RExC_parse++;
15714                     goto bad_syntax;
15715                 }
15716                 /* If at least two things on the stack, treat this as an
15717                   * operator */
15718                 if (top_index - fence >= 1) {
15719                     goto join_operators;
15720                 }
15721
15722                 /* Here only a single thing on the fenced stack, and there is a
15723                  * fence.  Get rid of it */
15724                 fence_ptr = av_pop(fence_stack);
15725                 assert(fence_ptr);
15726                 fence = SvIV(fence_ptr);
15727                 SvREFCNT_dec_NN(fence_ptr);
15728                 fence_ptr = NULL;
15729
15730                 if (fence < 0) {
15731                     fence = 0;
15732                 }
15733
15734                 /* Having gotten rid of the fence, we pop the operand at the
15735                  * stack top and process it as a newly encountered operand */
15736                 current = av_pop(stack);
15737                 if (IS_OPERAND(current)) {
15738                     goto handle_operand;
15739                 }
15740
15741                 RExC_parse++;
15742                 goto bad_syntax;
15743
15744             case '&':
15745             case '|':
15746             case '+':
15747             case '-':
15748             case '^':
15749
15750                 /* These binary operators should have a left operand already
15751                  * parsed */
15752                 if (   top_index - fence < 0
15753                     || top_index - fence == 1
15754                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
15755                     || ! IS_OPERAND(*top_ptr))
15756                 {
15757                     goto unexpected_binary;
15758                 }
15759
15760                 /* If only the one operand is on the part of the stack visible
15761                  * to us, we just place this operator in the proper position */
15762                 if (top_index - fence < 2) {
15763
15764                     /* Place the operator before the operand */
15765
15766                     SV* lhs = av_pop(stack);
15767                     av_push(stack, newSVuv(curchar));
15768                     av_push(stack, lhs);
15769                     break;
15770                 }
15771
15772                 /* But if there is something else on the stack, we need to
15773                  * process it before this new operator if and only if the
15774                  * stacked operation has equal or higher precedence than the
15775                  * new one */
15776
15777              join_operators:
15778
15779                 /* The operator on the stack is supposed to be below both its
15780                  * operands */
15781                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
15782                     || IS_OPERAND(*stacked_ptr))
15783                 {
15784                     /* But if not, it's legal and indicates we are completely
15785                      * done if and only if we're currently processing a ']',
15786                      * which should be the final thing in the expression */
15787                     if (curchar == ']') {
15788                         goto done;
15789                     }
15790
15791                   unexpected_binary:
15792                     RExC_parse++;
15793                     vFAIL2("Unexpected binary operator '%c' with no "
15794                            "preceding operand", curchar);
15795                 }
15796                 stacked_operator = (char) SvUV(*stacked_ptr);
15797
15798                 if (regex_set_precedence(curchar)
15799                     > regex_set_precedence(stacked_operator))
15800                 {
15801                     /* Here, the new operator has higher precedence than the
15802                      * stacked one.  This means we need to add the new one to
15803                      * the stack to await its rhs operand (and maybe more
15804                      * stuff).  We put it before the lhs operand, leaving
15805                      * untouched the stacked operator and everything below it
15806                      * */
15807                     lhs = av_pop(stack);
15808                     assert(IS_OPERAND(lhs));
15809
15810                     av_push(stack, newSVuv(curchar));
15811                     av_push(stack, lhs);
15812                     break;
15813                 }
15814
15815                 /* Here, the new operator has equal or lower precedence than
15816                  * what's already there.  This means the operation already
15817                  * there should be performed now, before the new one. */
15818
15819                 rhs = av_pop(stack);
15820                 if (! IS_OPERAND(rhs)) {
15821
15822                     /* This can happen when a ! is not followed by an operand,
15823                      * like in /(?[\t &!])/ */
15824                     goto bad_syntax;
15825                 }
15826
15827                 lhs = av_pop(stack);
15828
15829                 if (! IS_OPERAND(lhs)) {
15830
15831                     /* This can happen when there is an empty (), like in
15832                      * /(?[[0]+()+])/ */
15833                     goto bad_syntax;
15834                 }
15835
15836                 switch (stacked_operator) {
15837                     case '&':
15838                         _invlist_intersection(lhs, rhs, &rhs);
15839                         break;
15840
15841                     case '|':
15842                     case '+':
15843                         _invlist_union(lhs, rhs, &rhs);
15844                         break;
15845
15846                     case '-':
15847                         _invlist_subtract(lhs, rhs, &rhs);
15848                         break;
15849
15850                     case '^':   /* The union minus the intersection */
15851                     {
15852                         SV* i = NULL;
15853                         SV* u = NULL;
15854
15855                         _invlist_union(lhs, rhs, &u);
15856                         _invlist_intersection(lhs, rhs, &i);
15857                         _invlist_subtract(u, i, &rhs);
15858                         SvREFCNT_dec_NN(i);
15859                         SvREFCNT_dec_NN(u);
15860                         break;
15861                     }
15862                 }
15863                 SvREFCNT_dec(lhs);
15864
15865                 /* Here, the higher precedence operation has been done, and the
15866                  * result is in 'rhs'.  We overwrite the stacked operator with
15867                  * the result.  Then we redo this code to either push the new
15868                  * operator onto the stack or perform any higher precedence
15869                  * stacked operation */
15870                 only_to_avoid_leaks = av_pop(stack);
15871                 SvREFCNT_dec(only_to_avoid_leaks);
15872                 av_push(stack, rhs);
15873                 goto redo_curchar;
15874
15875             case '!':   /* Highest priority, right associative */
15876
15877                 /* If what's already at the top of the stack is another '!",
15878                  * they just cancel each other out */
15879                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
15880                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
15881                 {
15882                     only_to_avoid_leaks = av_pop(stack);
15883                     SvREFCNT_dec(only_to_avoid_leaks);
15884                 }
15885                 else { /* Otherwise, since it's right associative, just push
15886                           onto the stack */
15887                     av_push(stack, newSVuv(curchar));
15888                 }
15889                 break;
15890
15891             default:
15892                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15893                 vFAIL("Unexpected character");
15894
15895           handle_operand:
15896
15897             /* Here 'current' is the operand.  If something is already on the
15898              * stack, we have to check if it is a !.  But first, the code above
15899              * may have altered the stack in the time since we earlier set
15900              * 'top_index'.  */
15901
15902             top_index = av_tindex_skip_len_mg(stack);
15903             if (top_index - fence >= 0) {
15904                 /* If the top entry on the stack is an operator, it had better
15905                  * be a '!', otherwise the entry below the top operand should
15906                  * be an operator */
15907                 top_ptr = av_fetch(stack, top_index, FALSE);
15908                 assert(top_ptr);
15909                 if (IS_OPERATOR(*top_ptr)) {
15910
15911                     /* The only permissible operator at the top of the stack is
15912                      * '!', which is applied immediately to this operand. */
15913                     curchar = (char) SvUV(*top_ptr);
15914                     if (curchar != '!') {
15915                         SvREFCNT_dec(current);
15916                         vFAIL2("Unexpected binary operator '%c' with no "
15917                                 "preceding operand", curchar);
15918                     }
15919
15920                     _invlist_invert(current);
15921
15922                     only_to_avoid_leaks = av_pop(stack);
15923                     SvREFCNT_dec(only_to_avoid_leaks);
15924
15925                     /* And we redo with the inverted operand.  This allows
15926                      * handling multiple ! in a row */
15927                     goto handle_operand;
15928                 }
15929                           /* Single operand is ok only for the non-binary ')'
15930                            * operator */
15931                 else if ((top_index - fence == 0 && curchar != ')')
15932                          || (top_index - fence > 0
15933                              && (! (stacked_ptr = av_fetch(stack,
15934                                                            top_index - 1,
15935                                                            FALSE))
15936                                  || IS_OPERAND(*stacked_ptr))))
15937                 {
15938                     SvREFCNT_dec(current);
15939                     vFAIL("Operand with no preceding operator");
15940                 }
15941             }
15942
15943             /* Here there was nothing on the stack or the top element was
15944              * another operand.  Just add this new one */
15945             av_push(stack, current);
15946
15947         } /* End of switch on next parse token */
15948
15949         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15950     } /* End of loop parsing through the construct */
15951
15952   done:
15953     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
15954         vFAIL("Unmatched (");
15955     }
15956
15957     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
15958         || ((final = av_pop(stack)) == NULL)
15959         || ! IS_OPERAND(final)
15960         || SvTYPE(final) != SVt_INVLIST
15961         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
15962     {
15963       bad_syntax:
15964         SvREFCNT_dec(final);
15965         vFAIL("Incomplete expression within '(?[ ])'");
15966     }
15967
15968     /* Here, 'final' is the resultant inversion list from evaluating the
15969      * expression.  Return it if so requested */
15970     if (return_invlist) {
15971         *return_invlist = final;
15972         return END;
15973     }
15974
15975     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
15976      * expecting a string of ranges and individual code points */
15977     invlist_iterinit(final);
15978     result_string = newSVpvs("");
15979     while (invlist_iternext(final, &start, &end)) {
15980         if (start == end) {
15981             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
15982         }
15983         else {
15984             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
15985                                                      start,          end);
15986         }
15987     }
15988
15989     /* About to generate an ANYOF (or similar) node from the inversion list we
15990      * have calculated */
15991     save_parse = RExC_parse;
15992     RExC_parse = SvPV(result_string, len);
15993     save_end = RExC_end;
15994     RExC_end = RExC_parse + len;
15995
15996     /* We turn off folding around the call, as the class we have constructed
15997      * already has all folding taken into consideration, and we don't want
15998      * regclass() to add to that */
15999     RExC_flags &= ~RXf_PMf_FOLD;
16000     /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if multi-char
16001      * folds are allowed.  */
16002     node = regclass(pRExC_state, flagp,depth+1,
16003                     FALSE, /* means parse the whole char class */
16004                     FALSE, /* don't allow multi-char folds */
16005                     TRUE, /* silence non-portable warnings.  The above may very
16006                              well have generated non-portable code points, but
16007                              they're valid on this machine */
16008                     FALSE, /* similarly, no need for strict */
16009                     FALSE, /* Require return to be an ANYOF */
16010                     NULL,
16011                     NULL
16012                 );
16013     if (!node)
16014         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#" UVxf,
16015                     PTR2UV(flagp));
16016
16017     /* Fix up the node type if we are in locale.  (We have pretended we are
16018      * under /u for the purposes of regclass(), as this construct will only
16019      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
16020      * as to cause any warnings about bad locales to be output in regexec.c),
16021      * and add the flag that indicates to check if not in a UTF-8 locale.  The
16022      * reason we above forbid optimization into something other than an ANYOF
16023      * node is simply to minimize the number of code changes in regexec.c.
16024      * Otherwise we would have to create new EXACTish node types and deal with
16025      * them.  This decision could be revisited should this construct become
16026      * popular.
16027      *
16028      * (One might think we could look at the resulting ANYOF node and suppress
16029      * the flag if everything is above 255, as those would be UTF-8 only,
16030      * but this isn't true, as the components that led to that result could
16031      * have been locale-affected, and just happen to cancel each other out
16032      * under UTF-8 locales.) */
16033     if (in_locale) {
16034         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
16035
16036         assert(OP(node) == ANYOF);
16037
16038         OP(node) = ANYOFL;
16039         ANYOF_FLAGS(node)
16040                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
16041     }
16042
16043     if (save_fold) {
16044         RExC_flags |= RXf_PMf_FOLD;
16045     }
16046
16047     RExC_parse = save_parse + 1;
16048     RExC_end = save_end;
16049     SvREFCNT_dec_NN(final);
16050     SvREFCNT_dec_NN(result_string);
16051
16052     nextchar(pRExC_state);
16053     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
16054     return node;
16055 }
16056
16057 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16058
16059 STATIC void
16060 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
16061                              AV * stack, const IV fence, AV * fence_stack)
16062 {   /* Dumps the stacks in handle_regex_sets() */
16063
16064     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
16065     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
16066     SSize_t i;
16067
16068     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
16069
16070     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
16071
16072     if (stack_top < 0) {
16073         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
16074     }
16075     else {
16076         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
16077         for (i = stack_top; i >= 0; i--) {
16078             SV ** element_ptr = av_fetch(stack, i, FALSE);
16079             if (! element_ptr) {
16080             }
16081
16082             if (IS_OPERATOR(*element_ptr)) {
16083                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
16084                                             (int) i, (int) SvIV(*element_ptr));
16085             }
16086             else {
16087                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
16088                 sv_dump(*element_ptr);
16089             }
16090         }
16091     }
16092
16093     if (fence_stack_top < 0) {
16094         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
16095     }
16096     else {
16097         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
16098         for (i = fence_stack_top; i >= 0; i--) {
16099             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
16100             if (! element_ptr) {
16101             }
16102
16103             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
16104                                             (int) i, (int) SvIV(*element_ptr));
16105         }
16106     }
16107 }
16108
16109 #endif
16110
16111 #undef IS_OPERATOR
16112 #undef IS_OPERAND
16113
16114 STATIC void
16115 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
16116 {
16117     /* This adds the Latin1/above-Latin1 folding rules.
16118      *
16119      * This should be called only for a Latin1-range code points, cp, which is
16120      * known to be involved in a simple fold with other code points above
16121      * Latin1.  It would give false results if /aa has been specified.
16122      * Multi-char folds are outside the scope of this, and must be handled
16123      * specially. */
16124
16125     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
16126
16127     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
16128
16129     /* The rules that are valid for all Unicode versions are hard-coded in */
16130     switch (cp) {
16131         case 'k':
16132         case 'K':
16133           *invlist =
16134              add_cp_to_invlist(*invlist, KELVIN_SIGN);
16135             break;
16136         case 's':
16137         case 'S':
16138           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
16139             break;
16140         case MICRO_SIGN:
16141           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
16142           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
16143             break;
16144         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
16145         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
16146           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
16147             break;
16148         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
16149           *invlist = add_cp_to_invlist(*invlist,
16150                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
16151             break;
16152
16153         default:    /* Other code points are checked against the data for the
16154                        current Unicode version */
16155           {
16156             Size_t folds_to_count;
16157             unsigned int first_folds_to;
16158             const unsigned int * remaining_folds_to_list;
16159             UV folded_cp;
16160
16161             if (isASCII(cp)) {
16162                 folded_cp = toFOLD(cp);
16163             }
16164             else {
16165                 U8 dummy_fold[UTF8_MAXBYTES_CASE+1];
16166                 Size_t dummy_len;
16167                 folded_cp = _to_fold_latin1(cp, dummy_fold, &dummy_len, 0);
16168             }
16169
16170             if (folded_cp > 255) {
16171                 *invlist = add_cp_to_invlist(*invlist, folded_cp);
16172             }
16173
16174             folds_to_count = _inverse_folds(folded_cp, &first_folds_to,
16175                                                     &remaining_folds_to_list);
16176             if (folds_to_count == 0) {
16177
16178                 /* Use deprecated warning to increase the chances of this being
16179                  * output */
16180                 if (PASS2) {
16181                     ckWARN2reg_d(RExC_parse,
16182                         "Perl folding rules are not up-to-date for 0x%02X;"
16183                         " please use the perlbug utility to report;", cp);
16184                 }
16185             }
16186             else {
16187                 unsigned int i;
16188
16189                 if (first_folds_to > 255) {
16190                     *invlist = add_cp_to_invlist(*invlist, first_folds_to);
16191                 }
16192                 for (i = 0; i < folds_to_count - 1; i++) {
16193                     if (remaining_folds_to_list[i] > 255) {
16194                         *invlist = add_cp_to_invlist(*invlist,
16195                                                     remaining_folds_to_list[i]);
16196                     }
16197                 }
16198             }
16199             break;
16200          }
16201     }
16202 }
16203
16204 STATIC void
16205 S_output_or_return_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings, AV** return_posix_warnings)
16206 {
16207     /* If the final parameter is NULL, output the elements of the array given
16208      * by '*posix_warnings' as REGEXP warnings.  Otherwise, the elements are
16209      * pushed onto it, (creating if necessary) */
16210
16211     SV * msg;
16212     const bool first_is_fatal =  ! return_posix_warnings
16213                                 && ckDEAD(packWARN(WARN_REGEXP));
16214
16215     PERL_ARGS_ASSERT_OUTPUT_OR_RETURN_POSIX_WARNINGS;
16216
16217     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
16218         if (return_posix_warnings) {
16219             if (! *return_posix_warnings) { /* mortalize to not leak if
16220                                                warnings are fatal */
16221                 *return_posix_warnings = (AV *) sv_2mortal((SV *) newAV());
16222             }
16223             av_push(*return_posix_warnings, msg);
16224         }
16225         else {
16226             if (first_is_fatal) {           /* Avoid leaking this */
16227                 av_undef(posix_warnings);   /* This isn't necessary if the
16228                                                array is mortal, but is a
16229                                                fail-safe */
16230                 (void) sv_2mortal(msg);
16231                 if (PASS2) {
16232                     SAVEFREESV(RExC_rx_sv);
16233                 }
16234             }
16235             Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
16236             SvREFCNT_dec_NN(msg);
16237         }
16238     }
16239 }
16240
16241 STATIC AV *
16242 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
16243 {
16244     /* This adds the string scalar <multi_string> to the array
16245      * <multi_char_matches>.  <multi_string> is known to have exactly
16246      * <cp_count> code points in it.  This is used when constructing a
16247      * bracketed character class and we find something that needs to match more
16248      * than a single character.
16249      *
16250      * <multi_char_matches> is actually an array of arrays.  Each top-level
16251      * element is an array that contains all the strings known so far that are
16252      * the same length.  And that length (in number of code points) is the same
16253      * as the index of the top-level array.  Hence, the [2] element is an
16254      * array, each element thereof is a string containing TWO code points;
16255      * while element [3] is for strings of THREE characters, and so on.  Since
16256      * this is for multi-char strings there can never be a [0] nor [1] element.
16257      *
16258      * When we rewrite the character class below, we will do so such that the
16259      * longest strings are written first, so that it prefers the longest
16260      * matching strings first.  This is done even if it turns out that any
16261      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
16262      * Christiansen has agreed that this is ok.  This makes the test for the
16263      * ligature 'ffi' come before the test for 'ff', for example */
16264
16265     AV* this_array;
16266     AV** this_array_ptr;
16267
16268     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
16269
16270     if (! multi_char_matches) {
16271         multi_char_matches = newAV();
16272     }
16273
16274     if (av_exists(multi_char_matches, cp_count)) {
16275         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
16276         this_array = *this_array_ptr;
16277     }
16278     else {
16279         this_array = newAV();
16280         av_store(multi_char_matches, cp_count,
16281                  (SV*) this_array);
16282     }
16283     av_push(this_array, multi_string);
16284
16285     return multi_char_matches;
16286 }
16287
16288 /* The names of properties whose definitions are not known at compile time are
16289  * stored in this SV, after a constant heading.  So if the length has been
16290  * changed since initialization, then there is a run-time definition. */
16291 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
16292                                         (SvCUR(listsv) != initial_listsv_len)
16293
16294 /* There is a restricted set of white space characters that are legal when
16295  * ignoring white space in a bracketed character class.  This generates the
16296  * code to skip them.
16297  *
16298  * There is a line below that uses the same white space criteria but is outside
16299  * this macro.  Both here and there must use the same definition */
16300 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
16301     STMT_START {                                                        \
16302         if (do_skip) {                                                  \
16303             while (isBLANK_A(UCHARAT(p)))                               \
16304             {                                                           \
16305                 p++;                                                    \
16306             }                                                           \
16307         }                                                               \
16308     } STMT_END
16309
16310 STATIC regnode *
16311 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
16312                  const bool stop_at_1,  /* Just parse the next thing, don't
16313                                            look for a full character class */
16314                  bool allow_multi_folds,
16315                  const bool silence_non_portable,   /* Don't output warnings
16316                                                        about too large
16317                                                        characters */
16318                  const bool strict,
16319                  bool optimizable,                  /* ? Allow a non-ANYOF return
16320                                                        node */
16321                  SV** ret_invlist, /* Return an inversion list, not a node */
16322                  AV** return_posix_warnings
16323           )
16324 {
16325     /* parse a bracketed class specification.  Most of these will produce an
16326      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
16327      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
16328      * under /i with multi-character folds: it will be rewritten following the
16329      * paradigm of this example, where the <multi-fold>s are characters which
16330      * fold to multiple character sequences:
16331      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
16332      * gets effectively rewritten as:
16333      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
16334      * reg() gets called (recursively) on the rewritten version, and this
16335      * function will return what it constructs.  (Actually the <multi-fold>s
16336      * aren't physically removed from the [abcdefghi], it's just that they are
16337      * ignored in the recursion by means of a flag:
16338      * <RExC_in_multi_char_class>.)
16339      *
16340      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
16341      * characters, with the corresponding bit set if that character is in the
16342      * list.  For characters above this, a range list or swash is used.  There
16343      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
16344      * determinable at compile time
16345      *
16346      * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs
16347      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded
16348      * to UTF-8.  This can only happen if ret_invlist is non-NULL.
16349      */
16350
16351     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
16352     IV range = 0;
16353     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
16354     regnode *ret;
16355     STRLEN numlen;
16356     int namedclass = OOB_NAMEDCLASS;
16357     char *rangebegin = NULL;
16358     bool need_class = 0;
16359     SV *listsv = NULL;
16360     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
16361                                       than just initialized.  */
16362     SV* properties = NULL;    /* Code points that match \p{} \P{} */
16363     SV* posixes = NULL;     /* Code points that match classes like [:word:],
16364                                extended beyond the Latin1 range.  These have to
16365                                be kept separate from other code points for much
16366                                of this function because their handling  is
16367                                different under /i, and for most classes under
16368                                /d as well */
16369     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
16370                                separate for a while from the non-complemented
16371                                versions because of complications with /d
16372                                matching */
16373     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
16374                                   treated more simply than the general case,
16375                                   leading to less compilation and execution
16376                                   work */
16377     UV element_count = 0;   /* Number of distinct elements in the class.
16378                                Optimizations may be possible if this is tiny */
16379     AV * multi_char_matches = NULL; /* Code points that fold to more than one
16380                                        character; used under /i */
16381     UV n;
16382     char * stop_ptr = RExC_end;    /* where to stop parsing */
16383
16384     /* ignore unescaped whitespace? */
16385     const bool skip_white = cBOOL(   ret_invlist
16386                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
16387
16388     /* Unicode properties are stored in a swash; this holds the current one
16389      * being parsed.  If this swash is the only above-latin1 component of the
16390      * character class, an optimization is to pass it directly on to the
16391      * execution engine.  Otherwise, it is set to NULL to indicate that there
16392      * are other things in the class that have to be dealt with at execution
16393      * time */
16394     SV* swash = NULL;           /* Code points that match \p{} \P{} */
16395
16396     /* Set if a component of this character class is user-defined; just passed
16397      * on to the engine */
16398     bool has_user_defined_property = FALSE;
16399
16400     /* inversion list of code points this node matches only when the target
16401      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
16402      * /d) */
16403     SV* has_upper_latin1_only_utf8_matches = NULL;
16404
16405     /* Inversion list of code points this node matches regardless of things
16406      * like locale, folding, utf8ness of the target string */
16407     SV* cp_list = NULL;
16408
16409     /* Like cp_list, but code points on this list need to be checked for things
16410      * that fold to/from them under /i */
16411     SV* cp_foldable_list = NULL;
16412
16413     /* Like cp_list, but code points on this list are valid only when the
16414      * runtime locale is UTF-8 */
16415     SV* only_utf8_locale_list = NULL;
16416
16417     /* In a range, if one of the endpoints is non-character-set portable,
16418      * meaning that it hard-codes a code point that may mean a different
16419      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16420      * mnemonic '\t' which each mean the same character no matter which
16421      * character set the platform is on. */
16422     unsigned int non_portable_endpoint = 0;
16423
16424     /* Is the range unicode? which means on a platform that isn't 1-1 native
16425      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16426      * to be a Unicode value.  */
16427     bool unicode_range = FALSE;
16428     bool invert = FALSE;    /* Is this class to be complemented */
16429
16430     bool warn_super = ALWAYS_WARN_SUPER;
16431
16432     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
16433         case we need to change the emitted regop to an EXACT. */
16434     const char * orig_parse = RExC_parse;
16435     const SSize_t orig_size = RExC_size;
16436     bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
16437
16438     /* This variable is used to mark where the end in the input is of something
16439      * that looks like a POSIX construct but isn't.  During the parse, when
16440      * something looks like it could be such a construct is encountered, it is
16441      * checked for being one, but not if we've already checked this area of the
16442      * input.  Only after this position is reached do we check again */
16443     char *not_posix_region_end = RExC_parse - 1;
16444
16445     AV* posix_warnings = NULL;
16446     const bool do_posix_warnings =     return_posix_warnings
16447                                    || (PASS2 && ckWARN(WARN_REGEXP));
16448
16449     GET_RE_DEBUG_FLAGS_DECL;
16450
16451     PERL_ARGS_ASSERT_REGCLASS;
16452 #ifndef DEBUGGING
16453     PERL_UNUSED_ARG(depth);
16454 #endif
16455
16456     DEBUG_PARSE("clas");
16457
16458 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
16459     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
16460                                    && UNICODE_DOT_DOT_VERSION == 0)
16461     allow_multi_folds = FALSE;
16462 #endif
16463
16464     /* Assume we are going to generate an ANYOF node. */
16465     ret = reganode(pRExC_state,
16466                    (LOC)
16467                     ? ANYOFL
16468                     : ANYOF,
16469                    0);
16470
16471     if (SIZE_ONLY) {
16472         RExC_size += ANYOF_SKIP;
16473         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
16474     }
16475     else {
16476         ANYOF_FLAGS(ret) = 0;
16477
16478         RExC_emit += ANYOF_SKIP;
16479         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
16480         initial_listsv_len = SvCUR(listsv);
16481         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
16482     }
16483
16484     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16485
16486     assert(RExC_parse <= RExC_end);
16487
16488     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
16489         RExC_parse++;
16490         invert = TRUE;
16491         allow_multi_folds = FALSE;
16492         MARK_NAUGHTY(1);
16493         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16494     }
16495
16496     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
16497     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
16498         int maybe_class = handle_possible_posix(pRExC_state,
16499                                                 RExC_parse,
16500                                                 &not_posix_region_end,
16501                                                 NULL,
16502                                                 TRUE /* checking only */);
16503         if (PASS2 && maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
16504             SAVEFREESV(RExC_rx_sv);
16505             ckWARN4reg(not_posix_region_end,
16506                     "POSIX syntax [%c %c] belongs inside character classes%s",
16507                     *RExC_parse, *RExC_parse,
16508                     (maybe_class == OOB_NAMEDCLASS)
16509                     ? ((POSIXCC_NOTYET(*RExC_parse))
16510                         ? " (but this one isn't implemented)"
16511                         : " (but this one isn't fully valid)")
16512                     : ""
16513                     );
16514             (void)ReREFCNT_inc(RExC_rx_sv);
16515         }
16516     }
16517
16518     /* If the caller wants us to just parse a single element, accomplish this
16519      * by faking the loop ending condition */
16520     if (stop_at_1 && RExC_end > RExC_parse) {
16521         stop_ptr = RExC_parse + 1;
16522     }
16523
16524     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
16525     if (UCHARAT(RExC_parse) == ']')
16526         goto charclassloop;
16527
16528     while (1) {
16529
16530         if (   posix_warnings
16531             && av_tindex_skip_len_mg(posix_warnings) >= 0
16532             && RExC_parse > not_posix_region_end)
16533         {
16534             /* Warnings about posix class issues are considered tentative until
16535              * we are far enough along in the parse that we can no longer
16536              * change our mind, at which point we either output them or add
16537              * them, if it has so specified, to what gets returned to the
16538              * caller.  This is done each time through the loop so that a later
16539              * class won't zap them before they have been dealt with. */
16540             output_or_return_posix_warnings(pRExC_state, posix_warnings,
16541                                             return_posix_warnings);
16542         }
16543
16544         if  (RExC_parse >= stop_ptr) {
16545             break;
16546         }
16547
16548         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16549
16550         if  (UCHARAT(RExC_parse) == ']') {
16551             break;
16552         }
16553
16554       charclassloop:
16555
16556         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
16557         save_value = value;
16558         save_prevvalue = prevvalue;
16559
16560         if (!range) {
16561             rangebegin = RExC_parse;
16562             element_count++;
16563             non_portable_endpoint = 0;
16564         }
16565         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
16566             value = utf8n_to_uvchr((U8*)RExC_parse,
16567                                    RExC_end - RExC_parse,
16568                                    &numlen, UTF8_ALLOW_DEFAULT);
16569             RExC_parse += numlen;
16570         }
16571         else
16572             value = UCHARAT(RExC_parse++);
16573
16574         if (value == '[') {
16575             char * posix_class_end;
16576             namedclass = handle_possible_posix(pRExC_state,
16577                                                RExC_parse,
16578                                                &posix_class_end,
16579                                                do_posix_warnings ? &posix_warnings : NULL,
16580                                                FALSE    /* die if error */);
16581             if (namedclass > OOB_NAMEDCLASS) {
16582
16583                 /* If there was an earlier attempt to parse this particular
16584                  * posix class, and it failed, it was a false alarm, as this
16585                  * successful one proves */
16586                 if (   posix_warnings
16587                     && av_tindex_skip_len_mg(posix_warnings) >= 0
16588                     && not_posix_region_end >= RExC_parse
16589                     && not_posix_region_end <= posix_class_end)
16590                 {
16591                     av_undef(posix_warnings);
16592                 }
16593
16594                 RExC_parse = posix_class_end;
16595             }
16596             else if (namedclass == OOB_NAMEDCLASS) {
16597                 not_posix_region_end = posix_class_end;
16598             }
16599             else {
16600                 namedclass = OOB_NAMEDCLASS;
16601             }
16602         }
16603         else if (   RExC_parse - 1 > not_posix_region_end
16604                  && MAYBE_POSIXCC(value))
16605         {
16606             (void) handle_possible_posix(
16607                         pRExC_state,
16608                         RExC_parse - 1,  /* -1 because parse has already been
16609                                             advanced */
16610                         &not_posix_region_end,
16611                         do_posix_warnings ? &posix_warnings : NULL,
16612                         TRUE /* checking only */);
16613         }
16614         else if (  strict && ! skip_white
16615                  && (   _generic_isCC(value, _CC_VERTSPACE)
16616                      || is_VERTWS_cp_high(value)))
16617         {
16618             vFAIL("Literal vertical space in [] is illegal except under /x");
16619         }
16620         else if (value == '\\') {
16621             /* Is a backslash; get the code point of the char after it */
16622
16623             if (RExC_parse >= RExC_end) {
16624                 vFAIL("Unmatched [");
16625             }
16626
16627             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
16628                 value = utf8n_to_uvchr((U8*)RExC_parse,
16629                                    RExC_end - RExC_parse,
16630                                    &numlen, UTF8_ALLOW_DEFAULT);
16631                 RExC_parse += numlen;
16632             }
16633             else
16634                 value = UCHARAT(RExC_parse++);
16635
16636             /* Some compilers cannot handle switching on 64-bit integer
16637              * values, therefore value cannot be an UV.  Yes, this will
16638              * be a problem later if we want switch on Unicode.
16639              * A similar issue a little bit later when switching on
16640              * namedclass. --jhi */
16641
16642             /* If the \ is escaping white space when white space is being
16643              * skipped, it means that that white space is wanted literally, and
16644              * is already in 'value'.  Otherwise, need to translate the escape
16645              * into what it signifies. */
16646             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
16647
16648             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
16649             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
16650             case 's':   namedclass = ANYOF_SPACE;       break;
16651             case 'S':   namedclass = ANYOF_NSPACE;      break;
16652             case 'd':   namedclass = ANYOF_DIGIT;       break;
16653             case 'D':   namedclass = ANYOF_NDIGIT;      break;
16654             case 'v':   namedclass = ANYOF_VERTWS;      break;
16655             case 'V':   namedclass = ANYOF_NVERTWS;     break;
16656             case 'h':   namedclass = ANYOF_HORIZWS;     break;
16657             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
16658             case 'N':  /* Handle \N{NAME} in class */
16659                 {
16660                     const char * const backslash_N_beg = RExC_parse - 2;
16661                     int cp_count;
16662
16663                     if (! grok_bslash_N(pRExC_state,
16664                                         NULL,      /* No regnode */
16665                                         &value,    /* Yes single value */
16666                                         &cp_count, /* Multiple code pt count */
16667                                         flagp,
16668                                         strict,
16669                                         depth)
16670                     ) {
16671
16672                         if (*flagp & NEED_UTF8)
16673                             FAIL("panic: grok_bslash_N set NEED_UTF8");
16674
16675                         RETURN_NULL_ON_RESTART_FLAGP(flagp);
16676
16677                         if (cp_count < 0) {
16678                             vFAIL("\\N in a character class must be a named character: \\N{...}");
16679                         }
16680                         else if (cp_count == 0) {
16681                             if (PASS2) {
16682                                 ckWARNreg(RExC_parse,
16683                                         "Ignoring zero length \\N{} in character class");
16684                             }
16685                         }
16686                         else { /* cp_count > 1 */
16687                             if (! RExC_in_multi_char_class) {
16688                                 if (invert || range || *RExC_parse == '-') {
16689                                     if (strict) {
16690                                         RExC_parse--;
16691                                         vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
16692                                     }
16693                                     else if (PASS2) {
16694                                         ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
16695                                     }
16696                                     break; /* <value> contains the first code
16697                                               point. Drop out of the switch to
16698                                               process it */
16699                                 }
16700                                 else {
16701                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
16702                                                  RExC_parse - backslash_N_beg);
16703                                     multi_char_matches
16704                                         = add_multi_match(multi_char_matches,
16705                                                           multi_char_N,
16706                                                           cp_count);
16707                                 }
16708                             }
16709                         } /* End of cp_count != 1 */
16710
16711                         /* This element should not be processed further in this
16712                          * class */
16713                         element_count--;
16714                         value = save_value;
16715                         prevvalue = save_prevvalue;
16716                         continue;   /* Back to top of loop to get next char */
16717                     }
16718
16719                     /* Here, is a single code point, and <value> contains it */
16720                     unicode_range = TRUE;   /* \N{} are Unicode */
16721                 }
16722                 break;
16723             case 'p':
16724             case 'P':
16725                 {
16726                 char *e;
16727                 char *i;
16728
16729
16730                 /* We will handle any undefined properties ourselves */
16731                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
16732                                        /* And we actually would prefer to get
16733                                         * the straight inversion list of the
16734                                         * swash, since we will be accessing it
16735                                         * anyway, to save a little time */
16736                                       |_CORE_SWASH_INIT_ACCEPT_INVLIST;
16737
16738                 SvREFCNT_dec(swash); /* Free any left-overs */
16739                 if (RExC_parse >= RExC_end)
16740                     vFAIL2("Empty \\%c", (U8)value);
16741                 if (*RExC_parse == '{') {
16742                     const U8 c = (U8)value;
16743                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
16744                     if (!e) {
16745                         RExC_parse++;
16746                         vFAIL2("Missing right brace on \\%c{}", c);
16747                     }
16748
16749                     RExC_parse++;
16750                     while (isSPACE(*RExC_parse)) {
16751                          RExC_parse++;
16752                     }
16753
16754                     if (UCHARAT(RExC_parse) == '^') {
16755
16756                         /* toggle.  (The rhs xor gets the single bit that
16757                          * differs between P and p; the other xor inverts just
16758                          * that bit) */
16759                         value ^= 'P' ^ 'p';
16760
16761                         RExC_parse++;
16762                         while (isSPACE(*RExC_parse)) {
16763                             RExC_parse++;
16764                         }
16765                     }
16766
16767                     if (e == RExC_parse)
16768                         vFAIL2("Empty \\%c{}", c);
16769
16770                     n = e - RExC_parse;
16771                     while (isSPACE(*(RExC_parse + n - 1)))
16772                         n--;
16773
16774                 }   /* The \p isn't immediately followed by a '{' */
16775                 else if (! isALPHA(*RExC_parse)) {
16776                     RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16777                     vFAIL2("Character following \\%c must be '{' or a "
16778                            "single-character Unicode property name",
16779                            (U8) value);
16780                 }
16781                 else {
16782                     e = RExC_parse;
16783                     n = 1;
16784                 }
16785                 if (!SIZE_ONLY) {
16786                     char* name = RExC_parse;
16787                     char* base_name;    /* name after any packages are stripped */
16788                     char* lookup_name = NULL;
16789                     const char * const colon_colon = "::";
16790                     bool invert;
16791
16792                     SV* invlist;
16793
16794                     /* Temporary workaround for [perl #133136].  For this
16795                      * precise input that is in the .t that is failing, use the
16796                      * old method so that that .t passes */
16797                     if (memEQs(RExC_start, e + 1 - RExC_start, "foo\\p{Alnum}"))
16798                     {
16799                         invlist = NULL;
16800                     }
16801                     else {
16802                         invlist = parse_uniprop_string(name, n, FOLD, &invert);
16803                     }
16804                     if (invlist) {
16805                         if (invert) {
16806                             value ^= 'P' ^ 'p';
16807                         }
16808                     }
16809                     else {
16810
16811                     /* Try to get the definition of the property into
16812                      * <invlist>.  If /i is in effect, the effective property
16813                      * will have its name be <__NAME_i>.  The design is
16814                      * discussed in commit
16815                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
16816                     name = savepv(Perl_form(aTHX_ "%.*s", (int)n, RExC_parse));
16817                     SAVEFREEPV(name);
16818
16819                     for (i = RExC_parse; i < RExC_parse + n; i++) {
16820                         if (isCNTRL(*i) && *i != '\t') {
16821                             RExC_parse = e + 1;
16822                             vFAIL2("Can't find Unicode property definition \"%s\"", name);
16823                         }
16824                     }
16825
16826                     if (FOLD) {
16827                         lookup_name = savepv(Perl_form(aTHX_ "__%s_i", name));
16828
16829                         /* The function call just below that uses this can fail
16830                          * to return, leaking memory if we don't do this */
16831                         SAVEFREEPV(lookup_name);
16832                     }
16833
16834                     /* Look up the property name, and get its swash and
16835                      * inversion list, if the property is found  */
16836                     swash = _core_swash_init("utf8",
16837                                              (lookup_name)
16838                                               ? lookup_name
16839                                               : name,
16840                                              &PL_sv_undef,
16841                                              1, /* binary */
16842                                              0, /* not tr/// */
16843                                              NULL, /* No inversion list */
16844                                              &swash_init_flags
16845                                             );
16846                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
16847                         HV* curpkg = (IN_PERL_COMPILETIME)
16848                                       ? PL_curstash
16849                                       : CopSTASH(PL_curcop);
16850                         UV final_n = n;
16851                         bool has_pkg;
16852
16853                         if (swash) {    /* Got a swash but no inversion list.
16854                                            Something is likely wrong that will
16855                                            be sorted-out later */
16856                             SvREFCNT_dec_NN(swash);
16857                             swash = NULL;
16858                         }
16859
16860                         /* Here didn't find it.  It could be a an error (like a
16861                          * typo) in specifying a Unicode property, or it could
16862                          * be a user-defined property that will be available at
16863                          * run-time.  The names of these must begin with 'In'
16864                          * or 'Is' (after any packages are stripped off).  So
16865                          * if not one of those, or if we accept only
16866                          * compile-time properties, is an error; otherwise add
16867                          * it to the list for run-time look up. */
16868                         if ((base_name = rninstr(name, name + n,
16869                                                  colon_colon, colon_colon + 2)))
16870                         { /* Has ::.  We know this must be a user-defined
16871                              property */
16872                             base_name += 2;
16873                             final_n -= base_name - name;
16874                             has_pkg = TRUE;
16875                         }
16876                         else {
16877                             base_name = name;
16878                             has_pkg = FALSE;
16879                         }
16880
16881                         if (   final_n < 3
16882                             || base_name[0] != 'I'
16883                             || (base_name[1] != 's' && base_name[1] != 'n')
16884                             || ret_invlist)
16885                         {
16886                             const char * const msg
16887                                 = (has_pkg)
16888                                   ? "Illegal user-defined property name"
16889                                   : "Can't find Unicode property definition";
16890                             RExC_parse = e + 1;
16891
16892                             /* diag_listed_as: Can't find Unicode property definition "%s" */
16893                             vFAIL3utf8f("%s \"%" UTF8f "\"",
16894                                 msg, UTF8fARG(UTF, n, name));
16895                         }
16896
16897                         /* If the property name doesn't already have a package
16898                          * name, add the current one to it so that it can be
16899                          * referred to outside it. [perl #121777] */
16900                         if (! has_pkg && curpkg) {
16901                             char* pkgname = HvNAME(curpkg);
16902                             if (memNEs(pkgname, HvNAMELEN(curpkg), "main")) {
16903                                 char* full_name = Perl_form(aTHX_
16904                                                             "%s::%s",
16905                                                             pkgname,
16906                                                             name);
16907                                 n = strlen(full_name);
16908                                 name = savepvn(full_name, n);
16909                                 SAVEFREEPV(name);
16910                             }
16911                         }
16912                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s%" UTF8f "%s\n",
16913                                         (value == 'p' ? '+' : '!'),
16914                                         (FOLD) ? "__" : "",
16915                                         UTF8fARG(UTF, n, name),
16916                                         (FOLD) ? "_i" : "");
16917                         has_user_defined_property = TRUE;
16918                         optimizable = FALSE;    /* Will have to leave this an
16919                                                    ANYOF node */
16920
16921                         /* We don't know yet what this matches, so have to flag
16922                          * it */
16923                         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
16924                     }
16925                     else {
16926
16927                         /* Here, did get the swash and its inversion list.  If
16928                          * the swash is from a user-defined property, then this
16929                          * whole character class should be regarded as such */
16930                         if (swash_init_flags
16931                             & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
16932                         {
16933                             has_user_defined_property = TRUE;
16934                         }
16935                     }
16936                     }
16937                     if (invlist) {
16938                         if (! has_user_defined_property &&
16939                             /* We warn on matching an above-Unicode code point
16940                              * if the match would return true, except don't
16941                              * warn for \p{All}, which has exactly one element
16942                              * = 0 */
16943                             (_invlist_contains_cp(invlist, 0x110000)
16944                                 && (! (_invlist_len(invlist) == 1
16945                                        && *invlist_array(invlist) == 0))))
16946                         {
16947                             warn_super = TRUE;
16948                         }
16949
16950                         /* Invert if asking for the complement */
16951                         if (value == 'P') {
16952                             _invlist_union_complement_2nd(properties,
16953                                                           invlist,
16954                                                           &properties);
16955
16956                             /* The swash can't be used as-is, because we've
16957                              * inverted things; delay removing it to here after
16958                              * have copied its invlist above */
16959                             if (! swash) {
16960                                 SvREFCNT_dec_NN(invlist);
16961                             }
16962                             SvREFCNT_dec(swash);
16963                             swash = NULL;
16964                         }
16965                         else {
16966                             _invlist_union(properties, invlist, &properties);
16967                             if (! swash) {
16968                                 SvREFCNT_dec_NN(invlist);
16969                             }
16970                         }
16971                     }
16972                 }
16973                 RExC_parse = e + 1;
16974                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
16975                                                 named */
16976
16977                 /* \p means they want Unicode semantics */
16978                 REQUIRE_UNI_RULES(flagp, NULL);
16979                 }
16980                 break;
16981             case 'n':   value = '\n';                   break;
16982             case 'r':   value = '\r';                   break;
16983             case 't':   value = '\t';                   break;
16984             case 'f':   value = '\f';                   break;
16985             case 'b':   value = '\b';                   break;
16986             case 'e':   value = ESC_NATIVE;             break;
16987             case 'a':   value = '\a';                   break;
16988             case 'o':
16989                 RExC_parse--;   /* function expects to be pointed at the 'o' */
16990                 {
16991                     const char* error_msg;
16992                     bool valid = grok_bslash_o(&RExC_parse,
16993                                                RExC_end,
16994                                                &value,
16995                                                &error_msg,
16996                                                PASS2,   /* warnings only in
16997                                                            pass 2 */
16998                                                strict,
16999                                                silence_non_portable,
17000                                                UTF);
17001                     if (! valid) {
17002                         vFAIL(error_msg);
17003                     }
17004                 }
17005                 non_portable_endpoint++;
17006                 break;
17007             case 'x':
17008                 RExC_parse--;   /* function expects to be pointed at the 'x' */
17009                 {
17010                     const char* error_msg;
17011                     bool valid = grok_bslash_x(&RExC_parse,
17012                                                RExC_end,
17013                                                &value,
17014                                                &error_msg,
17015                                                PASS2, /* Output warnings */
17016                                                strict,
17017                                                silence_non_portable,
17018                                                UTF);
17019                     if (! valid) {
17020                         vFAIL(error_msg);
17021                     }
17022                 }
17023                 non_portable_endpoint++;
17024                 break;
17025             case 'c':
17026                 value = grok_bslash_c(*RExC_parse++, PASS2);
17027                 non_portable_endpoint++;
17028                 break;
17029             case '0': case '1': case '2': case '3': case '4':
17030             case '5': case '6': case '7':
17031                 {
17032                     /* Take 1-3 octal digits */
17033                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
17034                     numlen = (strict) ? 4 : 3;
17035                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
17036                     RExC_parse += numlen;
17037                     if (numlen != 3) {
17038                         if (strict) {
17039                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
17040                             vFAIL("Need exactly 3 octal digits");
17041                         }
17042                         else if (! SIZE_ONLY /* like \08, \178 */
17043                                  && numlen < 3
17044                                  && RExC_parse < RExC_end
17045                                  && isDIGIT(*RExC_parse)
17046                                  && ckWARN(WARN_REGEXP))
17047                         {
17048                             SAVEFREESV(RExC_rx_sv);
17049                             reg_warn_non_literal_string(
17050                                  RExC_parse + 1,
17051                                  form_short_octal_warning(RExC_parse, numlen));
17052                             (void)ReREFCNT_inc(RExC_rx_sv);
17053                         }
17054                     }
17055                     non_portable_endpoint++;
17056                     break;
17057                 }
17058             default:
17059                 /* Allow \_ to not give an error */
17060                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
17061                     if (strict) {
17062                         vFAIL2("Unrecognized escape \\%c in character class",
17063                                (int)value);
17064                     }
17065                     else {
17066                         SAVEFREESV(RExC_rx_sv);
17067                         ckWARN2reg(RExC_parse,
17068                             "Unrecognized escape \\%c in character class passed through",
17069                             (int)value);
17070                         (void)ReREFCNT_inc(RExC_rx_sv);
17071                     }
17072                 }
17073                 break;
17074             }   /* End of switch on char following backslash */
17075         } /* end of handling backslash escape sequences */
17076
17077         /* Here, we have the current token in 'value' */
17078
17079         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
17080             U8 classnum;
17081
17082             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
17083              * literal, as is the character that began the false range, i.e.
17084              * the 'a' in the examples */
17085             if (range) {
17086                 if (!SIZE_ONLY) {
17087                     const int w = (RExC_parse >= rangebegin)
17088                                   ? RExC_parse - rangebegin
17089                                   : 0;
17090                     if (strict) {
17091                         vFAIL2utf8f(
17092                             "False [] range \"%" UTF8f "\"",
17093                             UTF8fARG(UTF, w, rangebegin));
17094                     }
17095                     else {
17096                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
17097                         ckWARN2reg(RExC_parse,
17098                             "False [] range \"%" UTF8f "\"",
17099                             UTF8fARG(UTF, w, rangebegin));
17100                         (void)ReREFCNT_inc(RExC_rx_sv);
17101                         cp_list = add_cp_to_invlist(cp_list, '-');
17102                         cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
17103                                                              prevvalue);
17104                     }
17105                 }
17106
17107                 range = 0; /* this was not a true range */
17108                 element_count += 2; /* So counts for three values */
17109             }
17110
17111             classnum = namedclass_to_classnum(namedclass);
17112
17113             if (LOC && namedclass < ANYOF_POSIXL_MAX
17114 #ifndef HAS_ISASCII
17115                 && classnum != _CC_ASCII
17116 #endif
17117             ) {
17118                 /* What the Posix classes (like \w, [:space:]) match in locale
17119                  * isn't knowable under locale until actual match time.  Room
17120                  * must be reserved (one time per outer bracketed class) to
17121                  * store such classes.  The space will contain a bit for each
17122                  * named class that is to be matched against.  This isn't
17123                  * needed for \p{} and pseudo-classes, as they are not affected
17124                  * by locale, and hence are dealt with separately */
17125                 if (! need_class) {
17126                     need_class = 1;
17127                     if (SIZE_ONLY) {
17128                         RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
17129                     }
17130                     else {
17131                         RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
17132                     }
17133                     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
17134                     ANYOF_POSIXL_ZERO(ret);
17135
17136                     /* We can't change this into some other type of node
17137                      * (unless this is the only element, in which case there
17138                      * are nodes that mean exactly this) as has runtime
17139                      * dependencies */
17140                     optimizable = FALSE;
17141                 }
17142
17143                 /* Coverity thinks it is possible for this to be negative; both
17144                  * jhi and khw think it's not, but be safer */
17145                 assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
17146                        || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
17147
17148                 /* See if it already matches the complement of this POSIX
17149                  * class */
17150                 if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
17151                     && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
17152                                                             ? -1
17153                                                             : 1)))
17154                 {
17155                     posixl_matches_all = TRUE;
17156                     break;  /* No need to continue.  Since it matches both
17157                                e.g., \w and \W, it matches everything, and the
17158                                bracketed class can be optimized into qr/./s */
17159                 }
17160
17161                 /* Add this class to those that should be checked at runtime */
17162                 ANYOF_POSIXL_SET(ret, namedclass);
17163
17164                 /* The above-Latin1 characters are not subject to locale rules.
17165                  * Just add them, in the second pass, to the
17166                  * unconditionally-matched list */
17167                 if (! SIZE_ONLY) {
17168                     SV* scratch_list = NULL;
17169
17170                     /* Get the list of the above-Latin1 code points this
17171                      * matches */
17172                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
17173                                           PL_XPosix_ptrs[classnum],
17174
17175                                           /* Odd numbers are complements, like
17176                                            * NDIGIT, NASCII, ... */
17177                                           namedclass % 2 != 0,
17178                                           &scratch_list);
17179                     /* Checking if 'cp_list' is NULL first saves an extra
17180                      * clone.  Its reference count will be decremented at the
17181                      * next union, etc, or if this is the only instance, at the
17182                      * end of the routine */
17183                     if (! cp_list) {
17184                         cp_list = scratch_list;
17185                     }
17186                     else {
17187                         _invlist_union(cp_list, scratch_list, &cp_list);
17188                         SvREFCNT_dec_NN(scratch_list);
17189                     }
17190                     continue;   /* Go get next character */
17191                 }
17192             }
17193             else if (! SIZE_ONLY) {
17194
17195                 /* Here, not in pass1 (in that pass we skip calculating the
17196                  * contents of this class), and is not /l, or is a POSIX class
17197                  * for which /l doesn't matter (or is a Unicode property, which
17198                  * is skipped here). */
17199                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
17200                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
17201
17202                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
17203                          * nor /l make a difference in what these match,
17204                          * therefore we just add what they match to cp_list. */
17205                         if (classnum != _CC_VERTSPACE) {
17206                             assert(   namedclass == ANYOF_HORIZWS
17207                                    || namedclass == ANYOF_NHORIZWS);
17208
17209                             /* It turns out that \h is just a synonym for
17210                              * XPosixBlank */
17211                             classnum = _CC_BLANK;
17212                         }
17213
17214                         _invlist_union_maybe_complement_2nd(
17215                                 cp_list,
17216                                 PL_XPosix_ptrs[classnum],
17217                                 namedclass % 2 != 0,    /* Complement if odd
17218                                                           (NHORIZWS, NVERTWS)
17219                                                         */
17220                                 &cp_list);
17221                     }
17222                 }
17223                 else if (  UNI_SEMANTICS
17224                         || AT_LEAST_ASCII_RESTRICTED
17225                         || classnum == _CC_ASCII
17226                         || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
17227                                                   || classnum == _CC_XDIGIT)))
17228                 {
17229                     /* We usually have to worry about /d a affecting what POSIX
17230                      * classes match, with special code needed because we won't
17231                      * know until runtime what all matches.  But there is no
17232                      * extra work needed under /u and /a; and [:ascii:] is
17233                      * unaffected by /d; and :digit: and :xdigit: don't have
17234                      * runtime differences under /d.  So we can special case
17235                      * these, and avoid some extra work below, and at runtime.
17236                      * */
17237                     _invlist_union_maybe_complement_2nd(
17238                                                      simple_posixes,
17239                                                       ((AT_LEAST_ASCII_RESTRICTED)
17240                                                        ? PL_Posix_ptrs[classnum]
17241                                                        : PL_XPosix_ptrs[classnum]),
17242                                                      namedclass % 2 != 0,
17243                                                      &simple_posixes);
17244                 }
17245                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
17246                            complement and use nposixes */
17247                     SV** posixes_ptr = namedclass % 2 == 0
17248                                        ? &posixes
17249                                        : &nposixes;
17250                     _invlist_union_maybe_complement_2nd(
17251                                                      *posixes_ptr,
17252                                                      PL_XPosix_ptrs[classnum],
17253                                                      namedclass % 2 != 0,
17254                                                      posixes_ptr);
17255                 }
17256             }
17257         } /* end of namedclass \blah */
17258
17259         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17260
17261         /* If 'range' is set, 'value' is the ending of a range--check its
17262          * validity.  (If value isn't a single code point in the case of a
17263          * range, we should have figured that out above in the code that
17264          * catches false ranges).  Later, we will handle each individual code
17265          * point in the range.  If 'range' isn't set, this could be the
17266          * beginning of a range, so check for that by looking ahead to see if
17267          * the next real character to be processed is the range indicator--the
17268          * minus sign */
17269
17270         if (range) {
17271 #ifdef EBCDIC
17272             /* For unicode ranges, we have to test that the Unicode as opposed
17273              * to the native values are not decreasing.  (Above 255, there is
17274              * no difference between native and Unicode) */
17275             if (unicode_range && prevvalue < 255 && value < 255) {
17276                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
17277                     goto backwards_range;
17278                 }
17279             }
17280             else
17281 #endif
17282             if (prevvalue > value) /* b-a */ {
17283                 int w;
17284 #ifdef EBCDIC
17285               backwards_range:
17286 #endif
17287                 w = RExC_parse - rangebegin;
17288                 vFAIL2utf8f(
17289                     "Invalid [] range \"%" UTF8f "\"",
17290                     UTF8fARG(UTF, w, rangebegin));
17291                 NOT_REACHED; /* NOTREACHED */
17292             }
17293         }
17294         else {
17295             prevvalue = value; /* save the beginning of the potential range */
17296             if (! stop_at_1     /* Can't be a range if parsing just one thing */
17297                 && *RExC_parse == '-')
17298             {
17299                 char* next_char_ptr = RExC_parse + 1;
17300
17301                 /* Get the next real char after the '-' */
17302                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
17303
17304                 /* If the '-' is at the end of the class (just before the ']',
17305                  * it is a literal minus; otherwise it is a range */
17306                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
17307                     RExC_parse = next_char_ptr;
17308
17309                     /* a bad range like \w-, [:word:]- ? */
17310                     if (namedclass > OOB_NAMEDCLASS) {
17311                         if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
17312                             const int w = RExC_parse >= rangebegin
17313                                           ?  RExC_parse - rangebegin
17314                                           : 0;
17315                             if (strict) {
17316                                 vFAIL4("False [] range \"%*.*s\"",
17317                                     w, w, rangebegin);
17318                             }
17319                             else if (PASS2) {
17320                                 vWARN4(RExC_parse,
17321                                     "False [] range \"%*.*s\"",
17322                                     w, w, rangebegin);
17323                             }
17324                         }
17325                         if (!SIZE_ONLY) {
17326                             cp_list = add_cp_to_invlist(cp_list, '-');
17327                         }
17328                         element_count++;
17329                     } else
17330                         range = 1;      /* yeah, it's a range! */
17331                     continue;   /* but do it the next time */
17332                 }
17333             }
17334         }
17335
17336         if (namedclass > OOB_NAMEDCLASS) {
17337             continue;
17338         }
17339
17340         /* Here, we have a single value this time through the loop, and
17341          * <prevvalue> is the beginning of the range, if any; or <value> if
17342          * not. */
17343
17344         /* non-Latin1 code point implies unicode semantics.  Must be set in
17345          * pass1 so is there for the whole of pass 2 */
17346         if (value > 255) {
17347             REQUIRE_UNI_RULES(flagp, NULL);
17348         }
17349
17350         /* Ready to process either the single value, or the completed range.
17351          * For single-valued non-inverted ranges, we consider the possibility
17352          * of multi-char folds.  (We made a conscious decision to not do this
17353          * for the other cases because it can often lead to non-intuitive
17354          * results.  For example, you have the peculiar case that:
17355          *  "s s" =~ /^[^\xDF]+$/i => Y
17356          *  "ss"  =~ /^[^\xDF]+$/i => N
17357          *
17358          * See [perl #89750] */
17359         if (FOLD && allow_multi_folds && value == prevvalue) {
17360             if (value == LATIN_SMALL_LETTER_SHARP_S
17361                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
17362                                                         value)))
17363             {
17364                 /* Here <value> is indeed a multi-char fold.  Get what it is */
17365
17366                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17367                 STRLEN foldlen;
17368
17369                 UV folded = _to_uni_fold_flags(
17370                                 value,
17371                                 foldbuf,
17372                                 &foldlen,
17373                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
17374                                                    ? FOLD_FLAGS_NOMIX_ASCII
17375                                                    : 0)
17376                                 );
17377
17378                 /* Here, <folded> should be the first character of the
17379                  * multi-char fold of <value>, with <foldbuf> containing the
17380                  * whole thing.  But, if this fold is not allowed (because of
17381                  * the flags), <fold> will be the same as <value>, and should
17382                  * be processed like any other character, so skip the special
17383                  * handling */
17384                 if (folded != value) {
17385
17386                     /* Skip if we are recursed, currently parsing the class
17387                      * again.  Otherwise add this character to the list of
17388                      * multi-char folds. */
17389                     if (! RExC_in_multi_char_class) {
17390                         STRLEN cp_count = utf8_length(foldbuf,
17391                                                       foldbuf + foldlen);
17392                         SV* multi_fold = sv_2mortal(newSVpvs(""));
17393
17394                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
17395
17396                         multi_char_matches
17397                                         = add_multi_match(multi_char_matches,
17398                                                           multi_fold,
17399                                                           cp_count);
17400
17401                     }
17402
17403                     /* This element should not be processed further in this
17404                      * class */
17405                     element_count--;
17406                     value = save_value;
17407                     prevvalue = save_prevvalue;
17408                     continue;
17409                 }
17410             }
17411         }
17412
17413         if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
17414             if (range) {
17415
17416                 /* If the range starts above 255, everything is portable and
17417                  * likely to be so for any forseeable character set, so don't
17418                  * warn. */
17419                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
17420                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
17421                 }
17422                 else if (prevvalue != value) {
17423
17424                     /* Under strict, ranges that stop and/or end in an ASCII
17425                      * printable should have each end point be a portable value
17426                      * for it (preferably like 'A', but we don't warn if it is
17427                      * a (portable) Unicode name or code point), and the range
17428                      * must be be all digits or all letters of the same case.
17429                      * Otherwise, the range is non-portable and unclear as to
17430                      * what it contains */
17431                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
17432                         && (          non_portable_endpoint
17433                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
17434                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
17435                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
17436                     ))) {
17437                         vWARN(RExC_parse, "Ranges of ASCII printables should"
17438                                           " be some subset of \"0-9\","
17439                                           " \"A-Z\", or \"a-z\"");
17440                     }
17441                     else if (prevvalue >= FIRST_NON_ASCII_DECIMAL_DIGIT) {
17442                         SSize_t index_start;
17443                         SSize_t index_final;
17444
17445                         /* But the nature of Unicode and languages mean we
17446                          * can't do the same checks for above-ASCII ranges,
17447                          * except in the case of digit ones.  These should
17448                          * contain only digits from the same group of 10.  The
17449                          * ASCII case is handled just above.  Hence here, the
17450                          * range could be a range of digits.  First some
17451                          * unlikely special cases.  Grandfather in that a range
17452                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
17453                          * if its starting value is one of the 10 digits prior
17454                          * to it.  This is because it is an alternate way of
17455                          * writing 19D1, and some people may expect it to be in
17456                          * that group.  But it is bad, because it won't give
17457                          * the expected results.  In Unicode 5.2 it was
17458                          * considered to be in that group (of 11, hence), but
17459                          * this was fixed in the next version */
17460
17461                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
17462                             goto warn_bad_digit_range;
17463                         }
17464                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17465                                           &&     value <= 0x1D7FF))
17466                         {
17467                             /* This is the only other case currently in Unicode
17468                              * where the algorithm below fails.  The code
17469                              * points just above are the end points of a single
17470                              * range containing only decimal digits.  It is 5
17471                              * different series of 0-9.  All other ranges of
17472                              * digits currently in Unicode are just a single
17473                              * series.  (And mktables will notify us if a later
17474                              * Unicode version breaks this.)
17475                              *
17476                              * If the range being checked is at most 9 long,
17477                              * and the digit values represented are in
17478                              * numerical order, they are from the same series.
17479                              * */
17480                             if (         value - prevvalue > 9
17481                                 ||    (((    value - 0x1D7CE) % 10)
17482                                      <= (prevvalue - 0x1D7CE) % 10))
17483                             {
17484                                 goto warn_bad_digit_range;
17485                             }
17486                         }
17487                         else {
17488
17489                             /* For all other ranges of digits in Unicode, the
17490                              * algorithm is just to check if both end points
17491                              * are in the same series, which is the same range.
17492                              * */
17493                             index_start = _invlist_search(
17494                                                     PL_XPosix_ptrs[_CC_DIGIT],
17495                                                     prevvalue);
17496
17497                             /* Warn if the range starts and ends with a digit,
17498                              * and they are not in the same group of 10. */
17499                             if (   index_start >= 0
17500                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17501                                 && (index_final =
17502                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17503                                                     value)) != index_start
17504                                 && index_final >= 0
17505                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17506                             {
17507                               warn_bad_digit_range:
17508                                 vWARN(RExC_parse, "Ranges of digits should be"
17509                                                   " from the same group of"
17510                                                   " 10");
17511                             }
17512                         }
17513                     }
17514                 }
17515             }
17516             if ((! range || prevvalue == value) && non_portable_endpoint) {
17517                 if (isPRINT_A(value)) {
17518                     char literal[3];
17519                     unsigned d = 0;
17520                     if (isBACKSLASHED_PUNCT(value)) {
17521                         literal[d++] = '\\';
17522                     }
17523                     literal[d++] = (char) value;
17524                     literal[d++] = '\0';
17525
17526                     vWARN4(RExC_parse,
17527                            "\"%.*s\" is more clearly written simply as \"%s\"",
17528                            (int) (RExC_parse - rangebegin),
17529                            rangebegin,
17530                            literal
17531                         );
17532                 }
17533                 else if isMNEMONIC_CNTRL(value) {
17534                     vWARN4(RExC_parse,
17535                            "\"%.*s\" is more clearly written simply as \"%s\"",
17536                            (int) (RExC_parse - rangebegin),
17537                            rangebegin,
17538                            cntrl_to_mnemonic((U8) value)
17539                         );
17540                 }
17541             }
17542         }
17543
17544         /* Deal with this element of the class */
17545         if (! SIZE_ONLY) {
17546
17547 #ifndef EBCDIC
17548             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17549                                                      prevvalue, value);
17550 #else
17551             /* On non-ASCII platforms, for ranges that span all of 0..255, and
17552              * ones that don't require special handling, we can just add the
17553              * range like we do for ASCII platforms */
17554             if ((UNLIKELY(prevvalue == 0) && value >= 255)
17555                 || ! (prevvalue < 256
17556                       && (unicode_range
17557                           || (! non_portable_endpoint
17558                               && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17559                                   || (isUPPER_A(prevvalue)
17560                                       && isUPPER_A(value)))))))
17561             {
17562                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17563                                                          prevvalue, value);
17564             }
17565             else {
17566                 /* Here, requires special handling.  This can be because it is
17567                  * a range whose code points are considered to be Unicode, and
17568                  * so must be individually translated into native, or because
17569                  * its a subrange of 'A-Z' or 'a-z' which each aren't
17570                  * contiguous in EBCDIC, but we have defined them to include
17571                  * only the "expected" upper or lower case ASCII alphabetics.
17572                  * Subranges above 255 are the same in native and Unicode, so
17573                  * can be added as a range */
17574                 U8 start = NATIVE_TO_LATIN1(prevvalue);
17575                 unsigned j;
17576                 U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17577                 for (j = start; j <= end; j++) {
17578                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17579                 }
17580                 if (value > 255) {
17581                     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17582                                                              256, value);
17583                 }
17584             }
17585 #endif
17586         }
17587
17588         range = 0; /* this range (if it was one) is done now */
17589     } /* End of loop through all the text within the brackets */
17590
17591
17592     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17593         output_or_return_posix_warnings(pRExC_state, posix_warnings,
17594                                         return_posix_warnings);
17595     }
17596
17597     /* If anything in the class expands to more than one character, we have to
17598      * deal with them by building up a substitute parse string, and recursively
17599      * calling reg() on it, instead of proceeding */
17600     if (multi_char_matches) {
17601         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
17602         I32 cp_count;
17603         STRLEN len;
17604         char *save_end = RExC_end;
17605         char *save_parse = RExC_parse;
17606         char *save_start = RExC_start;
17607         STRLEN prefix_end = 0;      /* We copy the character class after a
17608                                        prefix supplied here.  This is the size
17609                                        + 1 of that prefix */
17610         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
17611                                        a "|" */
17612         I32 reg_flags;
17613
17614         assert(! invert);
17615         assert(RExC_precomp_adj == 0); /* Only one level of recursion allowed */
17616
17617 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
17618            because too confusing */
17619         if (invert) {
17620             sv_catpv(substitute_parse, "(?:");
17621         }
17622 #endif
17623
17624         /* Look at the longest folds first */
17625         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
17626                         cp_count > 0;
17627                         cp_count--)
17628         {
17629
17630             if (av_exists(multi_char_matches, cp_count)) {
17631                 AV** this_array_ptr;
17632                 SV* this_sequence;
17633
17634                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
17635                                                  cp_count, FALSE);
17636                 while ((this_sequence = av_pop(*this_array_ptr)) !=
17637                                                                 &PL_sv_undef)
17638                 {
17639                     if (! first_time) {
17640                         sv_catpv(substitute_parse, "|");
17641                     }
17642                     first_time = FALSE;
17643
17644                     sv_catpv(substitute_parse, SvPVX(this_sequence));
17645                 }
17646             }
17647         }
17648
17649         /* If the character class contains anything else besides these
17650          * multi-character folds, have to include it in recursive parsing */
17651         if (element_count) {
17652             sv_catpv(substitute_parse, "|[");
17653             prefix_end = SvCUR(substitute_parse);
17654             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
17655
17656             /* Put in a closing ']' only if not going off the end, as otherwise
17657              * we are adding something that really isn't there */
17658             if (RExC_parse < RExC_end) {
17659                 sv_catpv(substitute_parse, "]");
17660             }
17661         }
17662
17663         sv_catpv(substitute_parse, ")");
17664 #if 0
17665         if (invert) {
17666             /* This is a way to get the parse to skip forward a whole named
17667              * sequence instead of matching the 2nd character when it fails the
17668              * first */
17669             sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
17670         }
17671 #endif
17672
17673         /* Set up the data structure so that any errors will be properly
17674          * reported.  See the comments at the definition of
17675          * REPORT_LOCATION_ARGS for details */
17676         RExC_precomp_adj = orig_parse - RExC_precomp;
17677         RExC_start =  RExC_parse = SvPV(substitute_parse, len);
17678         RExC_adjusted_start = RExC_start + prefix_end;
17679         RExC_end = RExC_parse + len;
17680         RExC_in_multi_char_class = 1;
17681         RExC_emit = (regnode *)orig_emit;
17682
17683         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
17684
17685         *flagp |= reg_flags & (HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PASS1|NEED_UTF8);
17686
17687         /* And restore so can parse the rest of the pattern */
17688         RExC_parse = save_parse;
17689         RExC_start = RExC_adjusted_start = save_start;
17690         RExC_precomp_adj = 0;
17691         RExC_end = save_end;
17692         RExC_in_multi_char_class = 0;
17693         SvREFCNT_dec_NN(multi_char_matches);
17694         return ret;
17695     }
17696
17697     /* Here, we've gone through the entire class and dealt with multi-char
17698      * folds.  We are now in a position that we can do some checks to see if we
17699      * can optimize this ANYOF node into a simpler one, even in Pass 1.
17700      * Currently we only do two checks:
17701      * 1) is in the unlikely event that the user has specified both, eg. \w and
17702      *    \W under /l, then the class matches everything.  (This optimization
17703      *    is done only to make the optimizer code run later work.)
17704      * 2) if the character class contains only a single element (including a
17705      *    single range), we see if there is an equivalent node for it.
17706      * Other checks are possible */
17707     if (   optimizable
17708         && ! ret_invlist   /* Can't optimize if returning the constructed
17709                               inversion list */
17710         && (UNLIKELY(posixl_matches_all) || element_count == 1))
17711     {
17712         U8 op = END;
17713         U8 arg = 0;
17714
17715         if (UNLIKELY(posixl_matches_all)) {
17716             op = SANY;
17717         }
17718         else if (namedclass > OOB_NAMEDCLASS) { /* this is a single named
17719                                                    class, like \w or [:digit:]
17720                                                    or \p{foo} */
17721
17722             /* All named classes are mapped into POSIXish nodes, with its FLAG
17723              * argument giving which class it is */
17724             switch ((I32)namedclass) {
17725                 case ANYOF_UNIPROP:
17726                     break;
17727
17728                 /* These don't depend on the charset modifiers.  They always
17729                  * match under /u rules */
17730                 case ANYOF_NHORIZWS:
17731                 case ANYOF_HORIZWS:
17732                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
17733                     /* FALLTHROUGH */
17734
17735                 case ANYOF_NVERTWS:
17736                 case ANYOF_VERTWS:
17737                     op = POSIXU;
17738                     goto join_posix;
17739
17740                 /* The actual POSIXish node for all the rest depends on the
17741                  * charset modifier.  The ones in the first set depend only on
17742                  * ASCII or, if available on this platform, also locale */
17743
17744                 case ANYOF_ASCII:
17745                 case ANYOF_NASCII:
17746
17747 #ifdef HAS_ISASCII
17748                     if (LOC) {
17749                         op = POSIXL;
17750                         goto join_posix;
17751                     }
17752 #endif
17753                     /* (named_class - ANYOF_ASCII) is 0 or 1. xor'ing with
17754                      * invert converts that to 1 or 0 */
17755                     op = ASCII + ((namedclass - ANYOF_ASCII) ^ invert);
17756                     break;
17757
17758                 /* The following don't have any matches in the upper Latin1
17759                  * range, hence /d is equivalent to /u for them.  Making it /u
17760                  * saves some branches at runtime */
17761                 case ANYOF_DIGIT:
17762                 case ANYOF_NDIGIT:
17763                 case ANYOF_XDIGIT:
17764                 case ANYOF_NXDIGIT:
17765                     if (! DEPENDS_SEMANTICS) {
17766                         goto treat_as_default;
17767                     }
17768
17769                     op = POSIXU;
17770                     goto join_posix;
17771
17772                 /* The following change to CASED under /i */
17773                 case ANYOF_LOWER:
17774                 case ANYOF_NLOWER:
17775                 case ANYOF_UPPER:
17776                 case ANYOF_NUPPER:
17777                     if (FOLD) {
17778                         namedclass = ANYOF_CASED + (namedclass % 2);
17779                     }
17780                     /* FALLTHROUGH */
17781
17782                 /* The rest have more possibilities depending on the charset.
17783                  * We take advantage of the enum ordering of the charset
17784                  * modifiers to get the exact node type, */
17785                 default:
17786                   treat_as_default:
17787                     op = POSIXD + get_regex_charset(RExC_flags);
17788                     if (op > POSIXA) { /* /aa is same as /a */
17789                         op = POSIXA;
17790                     }
17791
17792                   join_posix:
17793                     /* The odd numbered ones are the complements of the
17794                      * next-lower even number one */
17795                     if (namedclass % 2 == 1) {
17796                         invert = ! invert;
17797                         namedclass--;
17798                     }
17799                     arg = namedclass_to_classnum(namedclass);
17800                     break;
17801             }
17802         }
17803         else if (value == prevvalue) {
17804
17805             /* Here, the class consists of just a single code point */
17806
17807             if (invert) {
17808                 if (! LOC && value == '\n') {
17809                     op = REG_ANY; /* Optimize [^\n] */
17810                     *flagp |= HASWIDTH|SIMPLE;
17811                     MARK_NAUGHTY(1);
17812                 }
17813             }
17814             else if (value < 256 || UTF) {
17815
17816                 /* Optimize a single value into an EXACTish node, but not if it
17817                  * would require converting the pattern to UTF-8. */
17818                 op = compute_EXACTish(pRExC_state);
17819             }
17820         } /* Otherwise is a range */
17821         else if (! LOC) {   /* locale could vary these */
17822             if (prevvalue == '0') {
17823                 if (value == '9') {
17824                     arg = _CC_DIGIT;
17825                     op = POSIXA;
17826                 }
17827             }
17828             else if (! FOLD || ASCII_FOLD_RESTRICTED) {
17829                 /* We can optimize A-Z or a-z, but not if they could match
17830                  * something like the KELVIN SIGN under /i. */
17831                 if (prevvalue == 'A') {
17832                     if (value == 'Z'
17833 #ifdef EBCDIC
17834                         && ! non_portable_endpoint
17835 #endif
17836                     ) {
17837                         arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
17838                         op = POSIXA;
17839                     }
17840                 }
17841                 else if (prevvalue == 'a') {
17842                     if (value == 'z'
17843 #ifdef EBCDIC
17844                         && ! non_portable_endpoint
17845 #endif
17846                     ) {
17847                         arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
17848                         op = POSIXA;
17849                     }
17850                 }
17851             }
17852         }
17853
17854         /* Here, we have changed <op> away from its initial value iff we found
17855          * an optimization */
17856         if (op != END) {
17857
17858             /* Throw away this ANYOF regnode, and emit the calculated one,
17859              * which should correspond to the beginning, not current, state of
17860              * the parse */
17861             const char * cur_parse = RExC_parse;
17862             RExC_parse = (char *)orig_parse;
17863             if ( SIZE_ONLY) {
17864                 if (! LOC) {
17865
17866                     /* To get locale nodes to not use the full ANYOF size would
17867                      * require moving the code above that writes the portions
17868                      * of it that aren't in other nodes to after this point.
17869                      * e.g.  ANYOF_POSIXL_SET */
17870                     RExC_size = orig_size;
17871                 }
17872             }
17873             else {
17874                 RExC_emit = (regnode *)orig_emit;
17875                 if (PL_regkind[op] == POSIXD) {
17876                     if (op == POSIXL) {
17877                         RExC_contains_locale = 1;
17878                     }
17879                     if (invert) {
17880                         op += NPOSIXD - POSIXD;
17881                     }
17882                 }
17883             }
17884
17885             ret = reg_node(pRExC_state, op);
17886
17887             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
17888                 if (! SIZE_ONLY) {
17889                     FLAGS(ret) = arg;
17890                 }
17891                 *flagp |= HASWIDTH|SIMPLE;
17892             }
17893             else if (PL_regkind[op] == EXACT) {
17894                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
17895                                            TRUE /* downgradable to EXACT */
17896                                            );
17897             }
17898             else {
17899                 *flagp |= HASWIDTH|SIMPLE;
17900             }
17901
17902             RExC_parse = (char *) cur_parse;
17903
17904             SvREFCNT_dec(posixes);
17905             SvREFCNT_dec(nposixes);
17906             SvREFCNT_dec(simple_posixes);
17907             SvREFCNT_dec(cp_list);
17908             SvREFCNT_dec(cp_foldable_list);
17909             return ret;
17910         }
17911     }
17912
17913     if (SIZE_ONLY)
17914         return ret;
17915     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
17916
17917     /* If folding, we calculate all characters that could fold to or from the
17918      * ones already on the list */
17919     if (cp_foldable_list) {
17920         if (FOLD) {
17921             UV start, end;      /* End points of code point ranges */
17922
17923             SV* fold_intersection = NULL;
17924             SV** use_list;
17925
17926             /* Our calculated list will be for Unicode rules.  For locale
17927              * matching, we have to keep a separate list that is consulted at
17928              * runtime only when the locale indicates Unicode rules.  For
17929              * non-locale, we just use the general list */
17930             if (LOC) {
17931                 use_list = &only_utf8_locale_list;
17932             }
17933             else {
17934                 use_list = &cp_list;
17935             }
17936
17937             /* Only the characters in this class that participate in folds need
17938              * be checked.  Get the intersection of this class and all the
17939              * possible characters that are foldable.  This can quickly narrow
17940              * down a large class */
17941             _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
17942                                   &fold_intersection);
17943
17944             /* Now look at the foldable characters in this class individually */
17945             invlist_iterinit(fold_intersection);
17946             while (invlist_iternext(fold_intersection, &start, &end)) {
17947                 UV j;
17948                 UV folded;
17949
17950                 /* Look at every character in the range */
17951                 for (j = start; j <= end; j++) {
17952                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17953                     STRLEN foldlen;
17954                     unsigned int k;
17955                     Size_t folds_to_count;
17956                     unsigned int first_folds_to;
17957                     const unsigned int * remaining_folds_to_list;
17958
17959                     if (j < 256) {
17960
17961                         if (IS_IN_SOME_FOLD_L1(j)) {
17962
17963                             /* ASCII is always matched; non-ASCII is matched
17964                              * only under Unicode rules (which could happen
17965                              * under /l if the locale is a UTF-8 one */
17966                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
17967                                 *use_list = add_cp_to_invlist(*use_list,
17968                                                             PL_fold_latin1[j]);
17969                             }
17970                             else {
17971                                 has_upper_latin1_only_utf8_matches
17972                                     = add_cp_to_invlist(
17973                                             has_upper_latin1_only_utf8_matches,
17974                                             PL_fold_latin1[j]);
17975                             }
17976                         }
17977
17978                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
17979                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
17980                         {
17981                             add_above_Latin1_folds(pRExC_state,
17982                                                    (U8) j,
17983                                                    use_list);
17984                         }
17985                         continue;
17986                     }
17987
17988                     /* Here is an above Latin1 character.  We don't have the
17989                      * rules hard-coded for it.  First, get its fold.  This is
17990                      * the simple fold, as the multi-character folds have been
17991                      * handled earlier and separated out */
17992                     folded = _to_uni_fold_flags(j, foldbuf, &foldlen,
17993                                                         (ASCII_FOLD_RESTRICTED)
17994                                                         ? FOLD_FLAGS_NOMIX_ASCII
17995                                                         : 0);
17996
17997                     /* Single character fold of above Latin1.  Add everything
17998                      * in its fold closure to the list that this node should
17999                      * match. */
18000                     folds_to_count = _inverse_folds(folded, &first_folds_to,
18001                                                     &remaining_folds_to_list);
18002                     for (k = 0; k <= folds_to_count; k++) {
18003                         UV c = (k == 0)     /* First time through use itself */
18004                                 ? folded
18005                                 : (k == 1)  /* 2nd time use, the first fold */
18006                                    ? first_folds_to
18007
18008                                      /* Then the remaining ones */
18009                                    : remaining_folds_to_list[k-2];
18010
18011                         /* /aa doesn't allow folds between ASCII and non- */
18012                         if ((   ASCII_FOLD_RESTRICTED
18013                             && (isASCII(c) != isASCII(j))))
18014                         {
18015                             continue;
18016                         }
18017
18018                         /* Folds under /l which cross the 255/256 boundary are
18019                          * added to a separate list.  (These are valid only
18020                          * when the locale is UTF-8.) */
18021                         if (c < 256 && LOC) {
18022                             *use_list = add_cp_to_invlist(*use_list, c);
18023                             continue;
18024                         }
18025
18026                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
18027                         {
18028                             cp_list = add_cp_to_invlist(cp_list, c);
18029                         }
18030                         else {
18031                             /* Similarly folds involving non-ascii Latin1
18032                              * characters under /d are added to their list */
18033                             has_upper_latin1_only_utf8_matches
18034                                 = add_cp_to_invlist(
18035                                             has_upper_latin1_only_utf8_matches,
18036                                             c);
18037                         }
18038                     }
18039                 }
18040             }
18041             SvREFCNT_dec_NN(fold_intersection);
18042         }
18043
18044         /* Now that we have finished adding all the folds, there is no reason
18045          * to keep the foldable list separate */
18046         _invlist_union(cp_list, cp_foldable_list, &cp_list);
18047         SvREFCNT_dec_NN(cp_foldable_list);
18048     }
18049
18050     /* And combine the result (if any) with any inversion lists from posix
18051      * classes.  The lists are kept separate up to now because we don't want to
18052      * fold the classes (folding of those is automatically handled by the swash
18053      * fetching code) */
18054     if (simple_posixes) {   /* These are the classes known to be unaffected by
18055                                /a, /aa, and /d */
18056         if (cp_list) {
18057             _invlist_union(cp_list, simple_posixes, &cp_list);
18058             SvREFCNT_dec_NN(simple_posixes);
18059         }
18060         else {
18061             cp_list = simple_posixes;
18062         }
18063     }
18064     if (posixes || nposixes) {
18065         if (! DEPENDS_SEMANTICS) {
18066
18067             /* For everything but /d, we can just add the current 'posixes' and
18068              * 'nposixes' to the main list */
18069             if (posixes) {
18070                 if (cp_list) {
18071                     _invlist_union(cp_list, posixes, &cp_list);
18072                     SvREFCNT_dec_NN(posixes);
18073                 }
18074                 else {
18075                     cp_list = posixes;
18076                 }
18077             }
18078             if (nposixes) {
18079                 if (cp_list) {
18080                     _invlist_union(cp_list, nposixes, &cp_list);
18081                     SvREFCNT_dec_NN(nposixes);
18082                 }
18083                 else {
18084                     cp_list = nposixes;
18085                 }
18086             }
18087         }
18088         else {
18089             /* Under /d, things like \w match upper Latin1 characters only if
18090              * the target string is in UTF-8.  But things like \W match all the
18091              * upper Latin1 characters if the target string is not in UTF-8.
18092              *
18093              * Handle the case where there something like \W separately */
18094             if (nposixes) {
18095                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1);
18096
18097                 /* A complemented posix class matches all upper Latin1
18098                  * characters if not in UTF-8.  And it matches just certain
18099                  * ones when in UTF-8.  That means those certain ones are
18100                  * matched regardless, so can just be added to the
18101                  * unconditional list */
18102                 if (cp_list) {
18103                     _invlist_union(cp_list, nposixes, &cp_list);
18104                     SvREFCNT_dec_NN(nposixes);
18105                     nposixes = NULL;
18106                 }
18107                 else {
18108                     cp_list = nposixes;
18109                 }
18110
18111                 /* Likewise for 'posixes' */
18112                 _invlist_union(posixes, cp_list, &cp_list);
18113
18114                 /* Likewise for anything else in the range that matched only
18115                  * under UTF-8 */
18116                 if (has_upper_latin1_only_utf8_matches) {
18117                     _invlist_union(cp_list,
18118                                    has_upper_latin1_only_utf8_matches,
18119                                    &cp_list);
18120                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18121                     has_upper_latin1_only_utf8_matches = NULL;
18122                 }
18123
18124                 /* If we don't match all the upper Latin1 characters regardless
18125                  * of UTF-8ness, we have to set a flag to match the rest when
18126                  * not in UTF-8 */
18127                 _invlist_subtract(only_non_utf8_list, cp_list,
18128                                   &only_non_utf8_list);
18129                 if (_invlist_len(only_non_utf8_list) != 0) {
18130                     ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18131                 }
18132                 SvREFCNT_dec_NN(only_non_utf8_list);
18133             }
18134             else {
18135                 /* Here there were no complemented posix classes.  That means
18136                  * the upper Latin1 characters in 'posixes' match only when the
18137                  * target string is in UTF-8.  So we have to add them to the
18138                  * list of those types of code points, while adding the
18139                  * remainder to the unconditional list.
18140                  *
18141                  * First calculate what they are */
18142                 SV* nonascii_but_latin1_properties = NULL;
18143                 _invlist_intersection(posixes, PL_UpperLatin1,
18144                                       &nonascii_but_latin1_properties);
18145
18146                 /* And add them to the final list of such characters. */
18147                 _invlist_union(has_upper_latin1_only_utf8_matches,
18148                                nonascii_but_latin1_properties,
18149                                &has_upper_latin1_only_utf8_matches);
18150
18151                 /* Remove them from what now becomes the unconditional list */
18152                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
18153                                   &posixes);
18154
18155                 /* And add those unconditional ones to the final list */
18156                 if (cp_list) {
18157                     _invlist_union(cp_list, posixes, &cp_list);
18158                     SvREFCNT_dec_NN(posixes);
18159                     posixes = NULL;
18160                 }
18161                 else {
18162                     cp_list = posixes;
18163                 }
18164
18165                 SvREFCNT_dec(nonascii_but_latin1_properties);
18166
18167                 /* Get rid of any characters that we now know are matched
18168                  * unconditionally from the conditional list, which may make
18169                  * that list empty */
18170                 _invlist_subtract(has_upper_latin1_only_utf8_matches,
18171                                   cp_list,
18172                                   &has_upper_latin1_only_utf8_matches);
18173                 if (_invlist_len(has_upper_latin1_only_utf8_matches) == 0) {
18174                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18175                     has_upper_latin1_only_utf8_matches = NULL;
18176                 }
18177             }
18178         }
18179     }
18180
18181     /* And combine the result (if any) with any inversion list from properties.
18182      * The lists are kept separate up to now so that we can distinguish the two
18183      * in regards to matching above-Unicode.  A run-time warning is generated
18184      * if a Unicode property is matched against a non-Unicode code point. But,
18185      * we allow user-defined properties to match anything, without any warning,
18186      * and we also suppress the warning if there is a portion of the character
18187      * class that isn't a Unicode property, and which matches above Unicode, \W
18188      * or [\x{110000}] for example.
18189      * (Note that in this case, unlike the Posix one above, there is no
18190      * <has_upper_latin1_only_utf8_matches>, because having a Unicode property
18191      * forces Unicode semantics */
18192     if (properties) {
18193         if (cp_list) {
18194
18195             /* If it matters to the final outcome, see if a non-property
18196              * component of the class matches above Unicode.  If so, the
18197              * warning gets suppressed.  This is true even if just a single
18198              * such code point is specified, as, though not strictly correct if
18199              * another such code point is matched against, the fact that they
18200              * are using above-Unicode code points indicates they should know
18201              * the issues involved */
18202             if (warn_super) {
18203                 warn_super = ! (invert
18204                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
18205             }
18206
18207             _invlist_union(properties, cp_list, &cp_list);
18208             SvREFCNT_dec_NN(properties);
18209         }
18210         else {
18211             cp_list = properties;
18212         }
18213
18214         if (warn_super) {
18215             ANYOF_FLAGS(ret)
18216              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18217
18218             /* Because an ANYOF node is the only one that warns, this node
18219              * can't be optimized into something else */
18220             optimizable = FALSE;
18221         }
18222     }
18223
18224     /* Here, we have calculated what code points should be in the character
18225      * class.
18226      *
18227      * Now we can see about various optimizations.  Fold calculation (which we
18228      * did above) needs to take place before inversion.  Otherwise /[^k]/i
18229      * would invert to include K, which under /i would match k, which it
18230      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
18231      * folded until runtime */
18232
18233     /* If we didn't do folding, it's because some information isn't available
18234      * until runtime; set the run-time fold flag for these.  (We don't have to
18235      * worry about properties folding, as that is taken care of by the swash
18236      * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
18237      * locales, or the class matches at least one 0-255 range code point */
18238     if (LOC && FOLD) {
18239
18240         /* Some things on the list might be unconditionally included because of
18241          * other components.  Remove them, and clean up the list if it goes to
18242          * 0 elements */
18243         if (only_utf8_locale_list && cp_list) {
18244             _invlist_subtract(only_utf8_locale_list, cp_list,
18245                               &only_utf8_locale_list);
18246
18247             if (_invlist_len(only_utf8_locale_list) == 0) {
18248                 SvREFCNT_dec_NN(only_utf8_locale_list);
18249                 only_utf8_locale_list = NULL;
18250             }
18251         }
18252         if (only_utf8_locale_list) {
18253             ANYOF_FLAGS(ret)
18254                  |=  ANYOFL_FOLD
18255                     |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
18256         }
18257         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
18258             UV start, end;
18259             invlist_iterinit(cp_list);
18260             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
18261                 ANYOF_FLAGS(ret) |= ANYOFL_FOLD;
18262             }
18263             invlist_iterfinish(cp_list);
18264         }
18265     }
18266     else if (   DEPENDS_SEMANTICS
18267              && (    has_upper_latin1_only_utf8_matches
18268                  || (ANYOF_FLAGS(ret) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
18269     {
18270         OP(ret) = ANYOFD;
18271         optimizable = FALSE;
18272     }
18273
18274
18275     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
18276      * at compile time.  Besides not inverting folded locale now, we can't
18277      * invert if there are things such as \w, which aren't known until runtime
18278      * */
18279     if (cp_list
18280         && invert
18281         && OP(ret) != ANYOFD
18282         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
18283         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18284     {
18285         _invlist_invert(cp_list);
18286
18287         /* Any swash can't be used as-is, because we've inverted things */
18288         if (swash) {
18289             SvREFCNT_dec_NN(swash);
18290             swash = NULL;
18291         }
18292
18293         /* Clear the invert flag since have just done it here */
18294         invert = FALSE;
18295     }
18296
18297     if (ret_invlist) {
18298         assert(cp_list);
18299
18300         *ret_invlist = cp_list;
18301         SvREFCNT_dec(swash);
18302
18303         /* Discard the generated node */
18304         if (SIZE_ONLY) {
18305             RExC_size = orig_size;
18306         }
18307         else {
18308             RExC_emit = orig_emit;
18309         }
18310         return orig_emit;
18311     }
18312
18313     /* Some character classes are equivalent to other nodes.  Such nodes take
18314      * up less room and generally fewer operations to execute than ANYOF nodes.
18315      * Above, we checked for and optimized into some such equivalents for
18316      * certain common classes that are easy to test.  Getting to this point in
18317      * the code means that the class didn't get optimized there.  Since this
18318      * code is only executed in Pass 2, it is too late to save space--it has
18319      * been allocated in Pass 1, and currently isn't given back.  XXX Why not?
18320      * But turning things into an EXACTish node can allow the optimizer to join
18321      * it to any adjacent such nodes.  And if the class is equivalent to things
18322      * like /./, expensive run-time swashes can be avoided.  Now that we have
18323      * more complete information, we can find things necessarily missed by the
18324      * earlier code. */
18325
18326     if (optimizable && cp_list && ! invert) {
18327         UV start, end;
18328         U8 op = END;  /* The optimzation node-type */
18329         int posix_class = -1;   /* Illegal value */
18330         const char * cur_parse= RExC_parse;
18331         U8 ANYOFM_mask = 0xFF;
18332         U32 anode_arg = 0;
18333
18334         invlist_iterinit(cp_list);
18335         if (! invlist_iternext(cp_list, &start, &end)) {
18336
18337             /* Here, the list is empty.  This happens, for example, when a
18338              * Unicode property that doesn't match anything is the only element
18339              * in the character class (perluniprops.pod notes such properties).
18340              * */
18341             op = OPFAIL;
18342             *flagp |= HASWIDTH|SIMPLE;
18343         }
18344         else if (start == end) {    /* The range is a single code point */
18345             if (! invlist_iternext(cp_list, &start, &end)
18346
18347                     /* Don't do this optimization if it would require changing
18348                      * the pattern to UTF-8 */
18349                 && (start < 256 || UTF))
18350             {
18351                 /* Here, the list contains a single code point.  Can optimize
18352                  * into an EXACTish node */
18353
18354                 value = start;
18355
18356                 if (! FOLD) {
18357                     op = (LOC)
18358                          ? EXACTL
18359                          : EXACT;
18360                 }
18361                 else if (LOC) {
18362
18363                     /* A locale node under folding with one code point can be
18364                      * an EXACTFL, as its fold won't be calculated until
18365                      * runtime */
18366                     op = EXACTFL;
18367                 }
18368                 else {
18369
18370                     /* Here, we are generally folding, but there is only one
18371                      * code point to match.  If we have to, we use an EXACT
18372                      * node, but it would be better for joining with adjacent
18373                      * nodes in the optimization pass if we used the same
18374                      * EXACTFish node that any such are likely to be.  We can
18375                      * do this iff the code point doesn't participate in any
18376                      * folds.  For example, an EXACTF of a colon is the same as
18377                      * an EXACT one, since nothing folds to or from a colon. */
18378                     if (value < 256) {
18379                         if (IS_IN_SOME_FOLD_L1(value)) {
18380                             op = EXACT;
18381                         }
18382                     }
18383                     else {
18384                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
18385                             op = EXACT;
18386                         }
18387                     }
18388
18389                     /* If we haven't found the node type, above, it means we
18390                      * can use the prevailing one */
18391                     if (op == END) {
18392                         op = compute_EXACTish(pRExC_state);
18393                     }
18394                 }
18395             }
18396         }   /* End of first range contains just a single code point */
18397         else if (start == 0) {
18398             if (end == UV_MAX) {
18399                 op = SANY;
18400                 *flagp |= HASWIDTH|SIMPLE;
18401                 MARK_NAUGHTY(1);
18402             }
18403             else if (end == '\n' - 1
18404                     && invlist_iternext(cp_list, &start, &end)
18405                     && start == '\n' + 1 && end == UV_MAX)
18406             {
18407                 op = REG_ANY;
18408                 *flagp |= HASWIDTH|SIMPLE;
18409                 MARK_NAUGHTY(1);
18410             }
18411         }
18412         invlist_iterfinish(cp_list);
18413
18414         if (op == END) {
18415
18416             /* Here, didn't find an optimization.  See if this matches any of
18417              * the POSIX classes.  First try ASCII */
18418
18419             if (_invlistEQ(cp_list, PL_XPosix_ptrs[_CC_ASCII], 0)) {
18420                 op = ASCII;
18421                 *flagp |= HASWIDTH|SIMPLE;
18422             }
18423             else if (_invlistEQ(cp_list, PL_XPosix_ptrs[_CC_ASCII], 1)) {
18424                 op = NASCII;
18425                 *flagp |= HASWIDTH|SIMPLE;
18426             }
18427             else if (invlist_highest(cp_list) >= 0x2029) {
18428
18429                 /* Then try the other POSIX classes.  The POSIXA ones are about
18430                  * the same speed as ANYOF ops, but the ones that have
18431                  * above-Latin1 code point matches are somewhat faster than
18432                  * ANYOF.  So optimize those, but don't bother with the POSIXA
18433                  * ones nor [:cntrl:] which has no above-Latin1 matches.  If
18434                  * this ANYOF node has a lower highest possible matching code
18435                  * point than any of the XPosix ones, we know that it can't
18436                  * possibly be the same as any of them, so we can avoid
18437                  * executing this code.  The 0x2029 above for the lowest max
18438                  * was determined by manual inspection of the classes, and
18439                  * comes from \v.  Suppose Unicode in a later version adds a
18440                  * higher code point to \v.  All that means is that this code
18441                  * can be executed unnecessarily.  It will still give the
18442                  * correct answer. */
18443
18444                 for (posix_class = 0;
18445                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
18446                      posix_class++)
18447                 {
18448                     int try_inverted;
18449
18450                     if (posix_class == _CC_CNTRL) {
18451                         continue;
18452                     }
18453
18454                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
18455
18456                         /* Check if matches normal or inverted */
18457                         if (_invlistEQ(cp_list,
18458                                        PL_XPosix_ptrs[posix_class],
18459                                        try_inverted))
18460                         {
18461                             op = (try_inverted)
18462                                  ? NPOSIXU
18463                                  : POSIXU;
18464                             *flagp |= HASWIDTH|SIMPLE;
18465                             goto found_posix;
18466                         }
18467                     }
18468                 }
18469               found_posix: ;
18470             }
18471
18472             /* If it didn't match a POSIX class, it might be able to be turned
18473              * into an ANYOFM node.  Compare two different bytes, bit-by-bit.
18474              * In some positions, the bits in each will be 1; and in other
18475              * positions both will be 0; and in some positions the bit will be
18476              * 1 in one byte, and 0 in the other.  Let 'n' be the number of
18477              * positions where the bits differ.  We create a mask which has
18478              * exactly 'n' 0 bits, each in a position where the two bytes
18479              * differ.  Now take the set of all bytes that when ANDed with the
18480              * mask yield the same result.  That set has 2**n elements, and is
18481              * representable by just two 8 bit numbers: the result and the
18482              * mask.  Importantly, matching the set can be vectorized by
18483              * creating a word full of the result bytes, and a word full of the
18484              * mask bytes, yielding a significant speed up.  Here, see if this
18485              * node matches such a set.  As a concrete example consider [01],
18486              * and the byte representing '0' which is 0x30 on ASCII machines.
18487              * It has the bits 0011 0000.  Take the mask 1111 1110.  If we AND
18488              * 0x31 and 0x30 with that mask we get 0x30.  Any other bytes ANDed
18489              * yield something else.  So [01], which is a common usage, is
18490              * optimizable into ANYOFM, and can benefit from the speed up.  We
18491              * can only do this on UTF-8 invariant bytes, because the variance
18492              * would throw this off.  */
18493             if (   op == END
18494                 && invlist_highest(cp_list) <=
18495 #ifdef EBCDIC
18496                                                0xFF
18497 #else
18498                                                0x7F
18499 #endif
18500             ) {
18501                 Size_t cp_count = 0;
18502                 bool first_time = TRUE;
18503                 unsigned int lowest_cp = 0xFF;
18504                 U8 bits_differing = 0;
18505
18506                 /* Only needed on EBCDIC, as there, variants and non- are mixed
18507                  * together.  Could #ifdef it out on ASCII, but probably the
18508                  * compiler will optimize it out */
18509                 bool has_variant = FALSE;
18510
18511                 /* Go through the bytes and find the bit positions that differ */
18512                 invlist_iterinit(cp_list);
18513                 while (invlist_iternext(cp_list, &start, &end)) {
18514                     unsigned int i = start;
18515
18516                     cp_count += end - start + 1;
18517
18518                     if (first_time) {
18519                         if (! UVCHR_IS_INVARIANT(i)) {
18520                             has_variant = TRUE;
18521                             continue;
18522                         }
18523
18524                         first_time = FALSE;
18525                         lowest_cp = start;
18526
18527                         i++;
18528                     }
18529
18530                     /* Find the bit positions that differ from the lowest code
18531                      * point in the node.  Keep track of all such positions by
18532                      * OR'ing */
18533                     for (; i <= end; i++) {
18534                         if (! UVCHR_IS_INVARIANT(i)) {
18535                             has_variant = TRUE;
18536                             continue;
18537                         }
18538
18539                         bits_differing  |= i ^ lowest_cp;
18540                     }
18541                 }
18542                 invlist_iterfinish(cp_list);
18543
18544                 /* At the end of the loop, we count how many bits differ from
18545                  * the bits in lowest code point, call the count 'd'.  If the
18546                  * set we found contains 2**d elements, it is the closure of
18547                  * all code points that differ only in those bit positions.  To
18548                  * convince yourself of that, first note that the number in the
18549                  * closure must be a power of 2, which we test for.  The only
18550                  * way we could have that count and it be some differing set,
18551                  * is if we got some code points that don't differ from the
18552                  * lowest code point in any position, but do differ from each
18553                  * other in some other position.  That means one code point has
18554                  * a 1 in that position, and another has a 0.  But that would
18555                  * mean that one of them differs from the lowest code point in
18556                  * that position, which possibility we've already excluded. */
18557                 if ( ! has_variant
18558                     && cp_count == 1U << PL_bitcount[bits_differing])
18559                 {
18560                     assert(cp_count > 1);
18561                     op = ANYOFM;
18562
18563                     /* We need to make the bits that differ be 0's */
18564                     ANYOFM_mask = ~ bits_differing; /* This goes into FLAGS */
18565
18566                     /* The argument is the lowest code point */
18567                     anode_arg = lowest_cp;
18568                     *flagp |= HASWIDTH|SIMPLE;
18569                 }
18570             }
18571         }
18572
18573         if (op != END) {
18574             RExC_parse = (char *)orig_parse;
18575             RExC_emit = (regnode *)orig_emit;
18576
18577             if (regarglen[op]) {
18578                 ret = reganode(pRExC_state, op, anode_arg);
18579             } else {
18580                 ret = reg_node(pRExC_state, op);
18581             }
18582
18583             RExC_parse = (char *)cur_parse;
18584
18585             if (PL_regkind[op] == EXACT) {
18586                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
18587                                            TRUE /* downgradable to EXACT */
18588                                           );
18589             }
18590             else if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
18591                 FLAGS(ret) = posix_class;
18592             }
18593             else if (PL_regkind[op] == ANYOFM) {
18594                 FLAGS(ret) = ANYOFM_mask;
18595             }
18596
18597             SvREFCNT_dec_NN(cp_list);
18598             return ret;
18599         }
18600     }
18601
18602     /* Here, <cp_list> contains all the code points we can determine at
18603      * compile time that match under all conditions.  Go through it, and
18604      * for things that belong in the bitmap, put them there, and delete from
18605      * <cp_list>.  While we are at it, see if everything above 255 is in the
18606      * list, and if so, set a flag to speed up execution */
18607
18608     populate_ANYOF_from_invlist(ret, &cp_list);
18609
18610     if (invert) {
18611         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
18612     }
18613
18614     /* Here, the bitmap has been populated with all the Latin1 code points that
18615      * always match.  Can now add to the overall list those that match only
18616      * when the target string is UTF-8 (<has_upper_latin1_only_utf8_matches>).
18617      * */
18618     if (has_upper_latin1_only_utf8_matches) {
18619         if (cp_list) {
18620             _invlist_union(cp_list,
18621                            has_upper_latin1_only_utf8_matches,
18622                            &cp_list);
18623             SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18624         }
18625         else {
18626             cp_list = has_upper_latin1_only_utf8_matches;
18627         }
18628         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
18629     }
18630
18631     /* If there is a swash and more than one element, we can't use the swash in
18632      * the optimization below. */
18633     if (swash && element_count > 1) {
18634         SvREFCNT_dec_NN(swash);
18635         swash = NULL;
18636     }
18637
18638     /* Note that the optimization of using 'swash' if it is the only thing in
18639      * the class doesn't have us change swash at all, so it can include things
18640      * that are also in the bitmap; otherwise we have purposely deleted that
18641      * duplicate information */
18642     set_ANYOF_arg(pRExC_state, ret, cp_list,
18643                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18644                    ? listsv : NULL,
18645                   only_utf8_locale_list,
18646                   swash, has_user_defined_property);
18647
18648     *flagp |= HASWIDTH|SIMPLE;
18649
18650     if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
18651         RExC_contains_locale = 1;
18652     }
18653
18654     return ret;
18655 }
18656
18657 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
18658
18659 STATIC void
18660 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
18661                 regnode* const node,
18662                 SV* const cp_list,
18663                 SV* const runtime_defns,
18664                 SV* const only_utf8_locale_list,
18665                 SV* const swash,
18666                 const bool has_user_defined_property)
18667 {
18668     /* Sets the arg field of an ANYOF-type node 'node', using information about
18669      * the node passed-in.  If there is nothing outside the node's bitmap, the
18670      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
18671      * the count returned by add_data(), having allocated and stored an array,
18672      * av, that that count references, as follows:
18673      *  av[0] stores the character class description in its textual form.
18674      *        This is used later (regexec.c:Perl_regclass_swash()) to
18675      *        initialize the appropriate swash, and is also useful for dumping
18676      *        the regnode.  This is set to &PL_sv_undef if the textual
18677      *        description is not needed at run-time (as happens if the other
18678      *        elements completely define the class)
18679      *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
18680      *        computed from av[0].  But if no further computation need be done,
18681      *        the swash is stored here now (and av[0] is &PL_sv_undef).
18682      *  av[2] stores the inversion list of code points that match only if the
18683      *        current locale is UTF-8
18684      *  av[3] stores the cp_list inversion list for use in addition or instead
18685      *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
18686      *        (Otherwise everything needed is already in av[0] and av[1])
18687      *  av[4] is set if any component of the class is from a user-defined
18688      *        property; used only if av[3] exists */
18689
18690     UV n;
18691
18692     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
18693
18694     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
18695         assert(! (ANYOF_FLAGS(node)
18696                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
18697         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
18698     }
18699     else {
18700         AV * const av = newAV();
18701         SV *rv;
18702
18703         av_store(av, 0, (runtime_defns)
18704                         ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
18705         if (swash) {
18706             assert(cp_list);
18707             av_store(av, 1, swash);
18708             SvREFCNT_dec_NN(cp_list);
18709         }
18710         else {
18711             av_store(av, 1, &PL_sv_undef);
18712             if (cp_list) {
18713                 av_store(av, 3, cp_list);
18714                 av_store(av, 4, newSVuv(has_user_defined_property));
18715             }
18716         }
18717
18718         if (only_utf8_locale_list) {
18719             av_store(av, 2, only_utf8_locale_list);
18720         }
18721         else {
18722             av_store(av, 2, &PL_sv_undef);
18723         }
18724
18725         rv = newRV_noinc(MUTABLE_SV(av));
18726         n = add_data(pRExC_state, STR_WITH_LEN("s"));
18727         RExC_rxi->data->data[n] = (void*)rv;
18728         ARG_SET(node, n);
18729     }
18730 }
18731
18732 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
18733 SV *
18734 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
18735                                         const regnode* node,
18736                                         bool doinit,
18737                                         SV** listsvp,
18738                                         SV** only_utf8_locale_ptr,
18739                                         SV** output_invlist)
18740
18741 {
18742     /* For internal core use only.
18743      * Returns the swash for the input 'node' in the regex 'prog'.
18744      * If <doinit> is 'true', will attempt to create the swash if not already
18745      *    done.
18746      * If <listsvp> is non-null, will return the printable contents of the
18747      *    swash.  This can be used to get debugging information even before the
18748      *    swash exists, by calling this function with 'doinit' set to false, in
18749      *    which case the components that will be used to eventually create the
18750      *    swash are returned  (in a printable form).
18751      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
18752      *    store an inversion list of code points that should match only if the
18753      *    execution-time locale is a UTF-8 one.
18754      * If <output_invlist> is not NULL, it is where this routine is to store an
18755      *    inversion list of the code points that would be instead returned in
18756      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
18757      *    when this parameter is used, is just the non-code point data that
18758      *    will go into creating the swash.  This currently should be just
18759      *    user-defined properties whose definitions were not known at compile
18760      *    time.  Using this parameter allows for easier manipulation of the
18761      *    swash's data by the caller.  It is illegal to call this function with
18762      *    this parameter set, but not <listsvp>
18763      *
18764      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
18765      * that, in spite of this function's name, the swash it returns may include
18766      * the bitmap data as well */
18767
18768     SV *sw  = NULL;
18769     SV *si  = NULL;         /* Input swash initialization string */
18770     SV* invlist = NULL;
18771
18772     RXi_GET_DECL(prog,progi);
18773     const struct reg_data * const data = prog ? progi->data : NULL;
18774
18775     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
18776     assert(! output_invlist || listsvp);
18777
18778     if (data && data->count) {
18779         const U32 n = ARG(node);
18780
18781         if (data->what[n] == 's') {
18782             SV * const rv = MUTABLE_SV(data->data[n]);
18783             AV * const av = MUTABLE_AV(SvRV(rv));
18784             SV **const ary = AvARRAY(av);
18785             U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
18786
18787             si = *ary;  /* ary[0] = the string to initialize the swash with */
18788
18789             if (av_tindex_skip_len_mg(av) >= 2) {
18790                 if (only_utf8_locale_ptr
18791                     && ary[2]
18792                     && ary[2] != &PL_sv_undef)
18793                 {
18794                     *only_utf8_locale_ptr = ary[2];
18795                 }
18796                 else {
18797                     assert(only_utf8_locale_ptr);
18798                     *only_utf8_locale_ptr = NULL;
18799                 }
18800
18801                 /* Elements 3 and 4 are either both present or both absent. [3]
18802                  * is any inversion list generated at compile time; [4]
18803                  * indicates if that inversion list has any user-defined
18804                  * properties in it. */
18805                 if (av_tindex_skip_len_mg(av) >= 3) {
18806                     invlist = ary[3];
18807                     if (SvUV(ary[4])) {
18808                         swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
18809                     }
18810                 }
18811                 else {
18812                     invlist = NULL;
18813                 }
18814             }
18815
18816             /* Element [1] is reserved for the set-up swash.  If already there,
18817              * return it; if not, create it and store it there */
18818             if (ary[1] && SvROK(ary[1])) {
18819                 sw = ary[1];
18820             }
18821             else if (doinit && ((si && si != &PL_sv_undef)
18822                                  || (invlist && invlist != &PL_sv_undef))) {
18823                 assert(si);
18824                 sw = _core_swash_init("utf8", /* the utf8 package */
18825                                       "", /* nameless */
18826                                       si,
18827                                       1, /* binary */
18828                                       0, /* not from tr/// */
18829                                       invlist,
18830                                       &swash_init_flags);
18831                 (void)av_store(av, 1, sw);
18832             }
18833         }
18834     }
18835
18836     /* If requested, return a printable version of what this swash matches */
18837     if (listsvp) {
18838         SV* matches_string = NULL;
18839
18840         /* The swash should be used, if possible, to get the data, as it
18841          * contains the resolved data.  But this function can be called at
18842          * compile-time, before everything gets resolved, in which case we
18843          * return the currently best available information, which is the string
18844          * that will eventually be used to do that resolving, 'si' */
18845         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
18846             && (si && si != &PL_sv_undef))
18847         {
18848             /* Here, we only have 'si' (and possibly some passed-in data in
18849              * 'invlist', which is handled below)  If the caller only wants
18850              * 'si', use that.  */
18851             if (! output_invlist) {
18852                 matches_string = newSVsv(si);
18853             }
18854             else {
18855                 /* But if the caller wants an inversion list of the node, we
18856                  * need to parse 'si' and place as much as possible in the
18857                  * desired output inversion list, making 'matches_string' only
18858                  * contain the currently unresolvable things */
18859                 const char *si_string = SvPVX(si);
18860                 STRLEN remaining = SvCUR(si);
18861                 UV prev_cp = 0;
18862                 U8 count = 0;
18863
18864                 /* Ignore everything before the first new-line */
18865                 while (*si_string != '\n' && remaining > 0) {
18866                     si_string++;
18867                     remaining--;
18868                 }
18869                 assert(remaining > 0);
18870
18871                 si_string++;
18872                 remaining--;
18873
18874                 while (remaining > 0) {
18875
18876                     /* The data consists of just strings defining user-defined
18877                      * property names, but in prior incarnations, and perhaps
18878                      * somehow from pluggable regex engines, it could still
18879                      * hold hex code point definitions.  Each component of a
18880                      * range would be separated by a tab, and each range by a
18881                      * new-line.  If these are found, instead add them to the
18882                      * inversion list */
18883                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
18884                                      |PERL_SCAN_SILENT_NON_PORTABLE;
18885                     STRLEN len = remaining;
18886                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
18887
18888                     /* If the hex decode routine found something, it should go
18889                      * up to the next \n */
18890                     if (   *(si_string + len) == '\n') {
18891                         if (count) {    /* 2nd code point on line */
18892                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
18893                         }
18894                         else {
18895                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
18896                         }
18897                         count = 0;
18898                         goto prepare_for_next_iteration;
18899                     }
18900
18901                     /* If the hex decode was instead for the lower range limit,
18902                      * save it, and go parse the upper range limit */
18903                     if (*(si_string + len) == '\t') {
18904                         assert(count == 0);
18905
18906                         prev_cp = cp;
18907                         count = 1;
18908                       prepare_for_next_iteration:
18909                         si_string += len + 1;
18910                         remaining -= len + 1;
18911                         continue;
18912                     }
18913
18914                     /* Here, didn't find a legal hex number.  Just add it from
18915                      * here to the next \n */
18916
18917                     remaining -= len;
18918                     while (*(si_string + len) != '\n' && remaining > 0) {
18919                         remaining--;
18920                         len++;
18921                     }
18922                     if (*(si_string + len) == '\n') {
18923                         len++;
18924                         remaining--;
18925                     }
18926                     if (matches_string) {
18927                         sv_catpvn(matches_string, si_string, len - 1);
18928                     }
18929                     else {
18930                         matches_string = newSVpvn(si_string, len - 1);
18931                     }
18932                     si_string += len;
18933                     sv_catpvs(matches_string, " ");
18934                 } /* end of loop through the text */
18935
18936                 assert(matches_string);
18937                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
18938                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
18939                 }
18940             } /* end of has an 'si' but no swash */
18941         }
18942
18943         /* If we have a swash in place, its equivalent inversion list was above
18944          * placed into 'invlist'.  If not, this variable may contain a stored
18945          * inversion list which is information beyond what is in 'si' */
18946         if (invlist) {
18947
18948             /* Again, if the caller doesn't want the output inversion list, put
18949              * everything in 'matches-string' */
18950             if (! output_invlist) {
18951                 if ( ! matches_string) {
18952                     matches_string = newSVpvs("\n");
18953                 }
18954                 sv_catsv(matches_string, invlist_contents(invlist,
18955                                                   TRUE /* traditional style */
18956                                                   ));
18957             }
18958             else if (! *output_invlist) {
18959                 *output_invlist = invlist_clone(invlist);
18960             }
18961             else {
18962                 _invlist_union(*output_invlist, invlist, output_invlist);
18963             }
18964         }
18965
18966         *listsvp = matches_string;
18967     }
18968
18969     return sw;
18970 }
18971 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
18972
18973 /* reg_skipcomment()
18974
18975    Absorbs an /x style # comment from the input stream,
18976    returning a pointer to the first character beyond the comment, or if the
18977    comment terminates the pattern without anything following it, this returns
18978    one past the final character of the pattern (in other words, RExC_end) and
18979    sets the REG_RUN_ON_COMMENT_SEEN flag.
18980
18981    Note it's the callers responsibility to ensure that we are
18982    actually in /x mode
18983
18984 */
18985
18986 PERL_STATIC_INLINE char*
18987 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
18988 {
18989     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
18990
18991     assert(*p == '#');
18992
18993     while (p < RExC_end) {
18994         if (*(++p) == '\n') {
18995             return p+1;
18996         }
18997     }
18998
18999     /* we ran off the end of the pattern without ending the comment, so we have
19000      * to add an \n when wrapping */
19001     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
19002     return p;
19003 }
19004
19005 STATIC void
19006 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
19007                                 char ** p,
19008                                 const bool force_to_xmod
19009                          )
19010 {
19011     /* If the text at the current parse position '*p' is a '(?#...)' comment,
19012      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
19013      * is /x whitespace, advance '*p' so that on exit it points to the first
19014      * byte past all such white space and comments */
19015
19016     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
19017
19018     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
19019
19020     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
19021
19022     for (;;) {
19023         if (RExC_end - (*p) >= 3
19024             && *(*p)     == '('
19025             && *(*p + 1) == '?'
19026             && *(*p + 2) == '#')
19027         {
19028             while (*(*p) != ')') {
19029                 if ((*p) == RExC_end)
19030                     FAIL("Sequence (?#... not terminated");
19031                 (*p)++;
19032             }
19033             (*p)++;
19034             continue;
19035         }
19036
19037         if (use_xmod) {
19038             const char * save_p = *p;
19039             while ((*p) < RExC_end) {
19040                 STRLEN len;
19041                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
19042                     (*p) += len;
19043                 }
19044                 else if (*(*p) == '#') {
19045                     (*p) = reg_skipcomment(pRExC_state, (*p));
19046                 }
19047                 else {
19048                     break;
19049                 }
19050             }
19051             if (*p != save_p) {
19052                 continue;
19053             }
19054         }
19055
19056         break;
19057     }
19058
19059     return;
19060 }
19061
19062 /* nextchar()
19063
19064    Advances the parse position by one byte, unless that byte is the beginning
19065    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
19066    those two cases, the parse position is advanced beyond all such comments and
19067    white space.
19068
19069    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
19070 */
19071
19072 STATIC void
19073 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
19074 {
19075     PERL_ARGS_ASSERT_NEXTCHAR;
19076
19077     if (RExC_parse < RExC_end) {
19078         assert(   ! UTF
19079                || UTF8_IS_INVARIANT(*RExC_parse)
19080                || UTF8_IS_START(*RExC_parse));
19081
19082         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
19083
19084         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
19085                                 FALSE /* Don't force /x */ );
19086     }
19087 }
19088
19089 STATIC regnode *
19090 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
19091 {
19092     /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
19093      * space.  In pass1, it aligns and increments RExC_size; in pass2,
19094      * RExC_emit */
19095
19096     regnode * const ret = RExC_emit;
19097     GET_RE_DEBUG_FLAGS_DECL;
19098
19099     PERL_ARGS_ASSERT_REGNODE_GUTS;
19100
19101     assert(extra_size >= regarglen[op]);
19102
19103     if (SIZE_ONLY) {
19104         SIZE_ALIGN(RExC_size);
19105         RExC_size += 1 + extra_size;
19106         return(ret);
19107     }
19108     if (RExC_emit >= RExC_emit_bound)
19109         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
19110                    op, (void*)RExC_emit, (void*)RExC_emit_bound);
19111
19112     NODE_ALIGN_FILL(ret);
19113 #ifndef RE_TRACK_PATTERN_OFFSETS
19114     PERL_UNUSED_ARG(name);
19115 #else
19116     if (RExC_offsets) {         /* MJD */
19117         MJD_OFFSET_DEBUG(
19118               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
19119               name, __LINE__,
19120               PL_reg_name[op],
19121               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
19122                 ? "Overwriting end of array!\n" : "OK",
19123               (UV)(RExC_emit - RExC_emit_start),
19124               (UV)(RExC_parse - RExC_start),
19125               (UV)RExC_offsets[0]));
19126         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
19127     }
19128 #endif
19129     return(ret);
19130 }
19131
19132 /*
19133 - reg_node - emit a node
19134 */
19135 STATIC regnode *                        /* Location. */
19136 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
19137 {
19138     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
19139
19140     PERL_ARGS_ASSERT_REG_NODE;
19141
19142     assert(regarglen[op] == 0);
19143
19144     if (PASS2) {
19145         regnode *ptr = ret;
19146         FILL_ADVANCE_NODE(ptr, op);
19147         RExC_emit = ptr;
19148     }
19149     return(ret);
19150 }
19151
19152 /*
19153 - reganode - emit a node with an argument
19154 */
19155 STATIC regnode *                        /* Location. */
19156 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
19157 {
19158     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
19159
19160     PERL_ARGS_ASSERT_REGANODE;
19161
19162     assert(regarglen[op] == 1);
19163
19164     if (PASS2) {
19165         regnode *ptr = ret;
19166         FILL_ADVANCE_NODE_ARG(ptr, op, arg);
19167         RExC_emit = ptr;
19168     }
19169     return(ret);
19170 }
19171
19172 STATIC regnode *
19173 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
19174 {
19175     /* emit a node with U32 and I32 arguments */
19176
19177     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
19178
19179     PERL_ARGS_ASSERT_REG2LANODE;
19180
19181     assert(regarglen[op] == 2);
19182
19183     if (PASS2) {
19184         regnode *ptr = ret;
19185         FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
19186         RExC_emit = ptr;
19187     }
19188     return(ret);
19189 }
19190
19191 /*
19192 - reginsert - insert an operator in front of already-emitted operand
19193 *
19194 * Means relocating the operand.
19195 *
19196 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
19197 * set up NEXT_OFF() of the inserted node if needed. Something like this:
19198 *
19199 * reginsert(pRExC, OPFAIL, orig_emit, depth+1);
19200 * if (PASS2)
19201 *     NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
19202 *
19203 * ALSO NOTE - operand->flags will be set to 0 as well.
19204 */
19205 STATIC void
19206 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *operand, U32 depth)
19207 {
19208     regnode *src;
19209     regnode *dst;
19210     regnode *place;
19211     const int offset = regarglen[(U8)op];
19212     const int size = NODE_STEP_REGNODE + offset;
19213     GET_RE_DEBUG_FLAGS_DECL;
19214
19215     PERL_ARGS_ASSERT_REGINSERT;
19216     PERL_UNUSED_CONTEXT;
19217     PERL_UNUSED_ARG(depth);
19218 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
19219     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
19220     if (SIZE_ONLY) {
19221         RExC_size += size;
19222         return;
19223     }
19224     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
19225                                     studying. If this is wrong then we need to adjust RExC_recurse
19226                                     below like we do with RExC_open_parens/RExC_close_parens. */
19227     src = RExC_emit;
19228     RExC_emit += size;
19229     dst = RExC_emit;
19230     if (RExC_open_parens) {
19231         int paren;
19232         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
19233         /* remember that RExC_npar is rex->nparens + 1,
19234          * iow it is 1 more than the number of parens seen in
19235          * the pattern so far. */
19236         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
19237             /* note, RExC_open_parens[0] is the start of the
19238              * regex, it can't move. RExC_close_parens[0] is the end
19239              * of the regex, it *can* move. */
19240             if ( paren && RExC_open_parens[paren] >= operand ) {
19241                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
19242                 RExC_open_parens[paren] += size;
19243             } else {
19244                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
19245             }
19246             if ( RExC_close_parens[paren] >= operand ) {
19247                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
19248                 RExC_close_parens[paren] += size;
19249             } else {
19250                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
19251             }
19252         }
19253     }
19254     if (RExC_end_op)
19255         RExC_end_op += size;
19256
19257     while (src > operand) {
19258         StructCopy(--src, --dst, regnode);
19259 #ifdef RE_TRACK_PATTERN_OFFSETS
19260         if (RExC_offsets) {     /* MJD 20010112 */
19261             MJD_OFFSET_DEBUG(
19262                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
19263                   "reg_insert",
19264                   __LINE__,
19265                   PL_reg_name[op],
19266                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
19267                     ? "Overwriting end of array!\n" : "OK",
19268                   (UV)(src - RExC_emit_start),
19269                   (UV)(dst - RExC_emit_start),
19270                   (UV)RExC_offsets[0]));
19271             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
19272             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
19273         }
19274 #endif
19275     }
19276
19277     place = operand;            /* Op node, where operand used to be. */
19278 #ifdef RE_TRACK_PATTERN_OFFSETS
19279     if (RExC_offsets) {         /* MJD */
19280         MJD_OFFSET_DEBUG(
19281               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
19282               "reginsert",
19283               __LINE__,
19284               PL_reg_name[op],
19285               (UV)(place - RExC_emit_start) > RExC_offsets[0]
19286               ? "Overwriting end of array!\n" : "OK",
19287               (UV)(place - RExC_emit_start),
19288               (UV)(RExC_parse - RExC_start),
19289               (UV)RExC_offsets[0]));
19290         Set_Node_Offset(place, RExC_parse);
19291         Set_Node_Length(place, 1);
19292     }
19293 #endif
19294     src = NEXTOPER(place);
19295     place->flags = 0;
19296     FILL_ADVANCE_NODE(place, op);
19297     Zero(src, offset, regnode);
19298 }
19299
19300 /*
19301 - regtail - set the next-pointer at the end of a node chain of p to val.
19302 - SEE ALSO: regtail_study
19303 */
19304 STATIC void
19305 S_regtail(pTHX_ RExC_state_t * pRExC_state,
19306                 const regnode * const p,
19307                 const regnode * const val,
19308                 const U32 depth)
19309 {
19310     regnode *scan;
19311     GET_RE_DEBUG_FLAGS_DECL;
19312
19313     PERL_ARGS_ASSERT_REGTAIL;
19314 #ifndef DEBUGGING
19315     PERL_UNUSED_ARG(depth);
19316 #endif
19317
19318     if (SIZE_ONLY)
19319         return;
19320
19321     /* Find last node. */
19322     scan = (regnode *) p;
19323     for (;;) {
19324         regnode * const temp = regnext(scan);
19325         DEBUG_PARSE_r({
19326             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
19327             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
19328             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
19329                 SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
19330                     (temp == NULL ? "->" : ""),
19331                     (temp == NULL ? PL_reg_name[OP(val)] : "")
19332             );
19333         });
19334         if (temp == NULL)
19335             break;
19336         scan = temp;
19337     }
19338
19339     if (reg_off_by_arg[OP(scan)]) {
19340         ARG_SET(scan, val - scan);
19341     }
19342     else {
19343         NEXT_OFF(scan) = val - scan;
19344     }
19345 }
19346
19347 #ifdef DEBUGGING
19348 /*
19349 - regtail_study - set the next-pointer at the end of a node chain of p to val.
19350 - Look for optimizable sequences at the same time.
19351 - currently only looks for EXACT chains.
19352
19353 This is experimental code. The idea is to use this routine to perform
19354 in place optimizations on branches and groups as they are constructed,
19355 with the long term intention of removing optimization from study_chunk so
19356 that it is purely analytical.
19357
19358 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
19359 to control which is which.
19360
19361 */
19362 /* TODO: All four parms should be const */
19363
19364 STATIC U8
19365 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
19366                       const regnode *val,U32 depth)
19367 {
19368     regnode *scan;
19369     U8 exact = PSEUDO;
19370 #ifdef EXPERIMENTAL_INPLACESCAN
19371     I32 min = 0;
19372 #endif
19373     GET_RE_DEBUG_FLAGS_DECL;
19374
19375     PERL_ARGS_ASSERT_REGTAIL_STUDY;
19376
19377
19378     if (SIZE_ONLY)
19379         return exact;
19380
19381     /* Find last node. */
19382
19383     scan = p;
19384     for (;;) {
19385         regnode * const temp = regnext(scan);
19386 #ifdef EXPERIMENTAL_INPLACESCAN
19387         if (PL_regkind[OP(scan)] == EXACT) {
19388             bool unfolded_multi_char;   /* Unexamined in this routine */
19389             if (join_exact(pRExC_state, scan, &min,
19390                            &unfolded_multi_char, 1, val, depth+1))
19391                 return EXACT;
19392         }
19393 #endif
19394         if ( exact ) {
19395             switch (OP(scan)) {
19396                 case EXACT:
19397                 case EXACTL:
19398                 case EXACTF:
19399                 case EXACTFAA_NO_TRIE:
19400                 case EXACTFAA:
19401                 case EXACTFU:
19402                 case EXACTFLU8:
19403                 case EXACTFU_SS:
19404                 case EXACTFL:
19405                         if( exact == PSEUDO )
19406                             exact= OP(scan);
19407                         else if ( exact != OP(scan) )
19408                             exact= 0;
19409                 case NOTHING:
19410                     break;
19411                 default:
19412                     exact= 0;
19413             }
19414         }
19415         DEBUG_PARSE_r({
19416             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
19417             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
19418             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
19419                 SvPV_nolen_const(RExC_mysv),
19420                 REG_NODE_NUM(scan),
19421                 PL_reg_name[exact]);
19422         });
19423         if (temp == NULL)
19424             break;
19425         scan = temp;
19426     }
19427     DEBUG_PARSE_r({
19428         DEBUG_PARSE_MSG("");
19429         regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
19430         Perl_re_printf( aTHX_
19431                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
19432                       SvPV_nolen_const(RExC_mysv),
19433                       (IV)REG_NODE_NUM(val),
19434                       (IV)(val - scan)
19435         );
19436     });
19437     if (reg_off_by_arg[OP(scan)]) {
19438         ARG_SET(scan, val - scan);
19439     }
19440     else {
19441         NEXT_OFF(scan) = val - scan;
19442     }
19443
19444     return exact;
19445 }
19446 #endif
19447
19448 STATIC SV*
19449 S_get_ANYOFM_contents(pTHX_ const regnode * n) {
19450
19451     /* Returns an inversion list of all the code points matched by the ANYOFM
19452      * node 'n' */
19453
19454     SV * cp_list = _new_invlist(-1);
19455     const U8 lowest = (U8) ARG(n);
19456     unsigned int i;
19457     U8 count = 0;
19458     U8 needed = 1U << PL_bitcount[ (U8) ~ FLAGS(n)];
19459
19460     PERL_ARGS_ASSERT_GET_ANYOFM_CONTENTS;
19461
19462     /* Starting with the lowest code point, any code point that ANDed with the
19463      * mask yields the lowest code point is in the set */
19464     for (i = lowest; i <= 0xFF; i++) {
19465         if ((i & FLAGS(n)) == ARG(n)) {
19466             cp_list = add_cp_to_invlist(cp_list, i);
19467             count++;
19468
19469             /* We know how many code points (a power of two) that are in the
19470              * set.  No use looking once we've got that number */
19471             if (count >= needed) break;
19472         }
19473     }
19474
19475     return cp_list;
19476 }
19477
19478 /*
19479  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
19480  */
19481 #ifdef DEBUGGING
19482
19483 static void
19484 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
19485 {
19486     int bit;
19487     int set=0;
19488
19489     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
19490
19491     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
19492         if (flags & (1<<bit)) {
19493             if (!set++ && lead)
19494                 Perl_re_printf( aTHX_  "%s",lead);
19495             Perl_re_printf( aTHX_  "%s ",PL_reg_intflags_name[bit]);
19496         }
19497     }
19498     if (lead)  {
19499         if (set)
19500             Perl_re_printf( aTHX_  "\n");
19501         else
19502             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
19503     }
19504 }
19505
19506 static void
19507 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
19508 {
19509     int bit;
19510     int set=0;
19511     regex_charset cs;
19512
19513     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
19514
19515     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
19516         if (flags & (1<<bit)) {
19517             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
19518                 continue;
19519             }
19520             if (!set++ && lead)
19521                 Perl_re_printf( aTHX_  "%s",lead);
19522             Perl_re_printf( aTHX_  "%s ",PL_reg_extflags_name[bit]);
19523         }
19524     }
19525     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
19526             if (!set++ && lead) {
19527                 Perl_re_printf( aTHX_  "%s",lead);
19528             }
19529             switch (cs) {
19530                 case REGEX_UNICODE_CHARSET:
19531                     Perl_re_printf( aTHX_  "UNICODE");
19532                     break;
19533                 case REGEX_LOCALE_CHARSET:
19534                     Perl_re_printf( aTHX_  "LOCALE");
19535                     break;
19536                 case REGEX_ASCII_RESTRICTED_CHARSET:
19537                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
19538                     break;
19539                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
19540                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
19541                     break;
19542                 default:
19543                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
19544                     break;
19545             }
19546     }
19547     if (lead)  {
19548         if (set)
19549             Perl_re_printf( aTHX_  "\n");
19550         else
19551             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
19552     }
19553 }
19554 #endif
19555
19556 void
19557 Perl_regdump(pTHX_ const regexp *r)
19558 {
19559 #ifdef DEBUGGING
19560     int i;
19561     SV * const sv = sv_newmortal();
19562     SV *dsv= sv_newmortal();
19563     RXi_GET_DECL(r,ri);
19564     GET_RE_DEBUG_FLAGS_DECL;
19565
19566     PERL_ARGS_ASSERT_REGDUMP;
19567
19568     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
19569
19570     /* Header fields of interest. */
19571     for (i = 0; i < 2; i++) {
19572         if (r->substrs->data[i].substr) {
19573             RE_PV_QUOTED_DECL(s, 0, dsv,
19574                             SvPVX_const(r->substrs->data[i].substr),
19575                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
19576                             PL_dump_re_max_len);
19577             Perl_re_printf( aTHX_
19578                           "%s %s%s at %" IVdf "..%" UVuf " ",
19579                           i ? "floating" : "anchored",
19580                           s,
19581                           RE_SV_TAIL(r->substrs->data[i].substr),
19582                           (IV)r->substrs->data[i].min_offset,
19583                           (UV)r->substrs->data[i].max_offset);
19584         }
19585         else if (r->substrs->data[i].utf8_substr) {
19586             RE_PV_QUOTED_DECL(s, 1, dsv,
19587                             SvPVX_const(r->substrs->data[i].utf8_substr),
19588                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
19589                             30);
19590             Perl_re_printf( aTHX_
19591                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
19592                           i ? "floating" : "anchored",
19593                           s,
19594                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
19595                           (IV)r->substrs->data[i].min_offset,
19596                           (UV)r->substrs->data[i].max_offset);
19597         }
19598     }
19599
19600     if (r->check_substr || r->check_utf8)
19601         Perl_re_printf( aTHX_
19602                       (const char *)
19603                       (   r->check_substr == r->substrs->data[1].substr
19604                        && r->check_utf8   == r->substrs->data[1].utf8_substr
19605                        ? "(checking floating" : "(checking anchored"));
19606     if (r->intflags & PREGf_NOSCAN)
19607         Perl_re_printf( aTHX_  " noscan");
19608     if (r->extflags & RXf_CHECK_ALL)
19609         Perl_re_printf( aTHX_  " isall");
19610     if (r->check_substr || r->check_utf8)
19611         Perl_re_printf( aTHX_  ") ");
19612
19613     if (ri->regstclass) {
19614         regprop(r, sv, ri->regstclass, NULL, NULL);
19615         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
19616     }
19617     if (r->intflags & PREGf_ANCH) {
19618         Perl_re_printf( aTHX_  "anchored");
19619         if (r->intflags & PREGf_ANCH_MBOL)
19620             Perl_re_printf( aTHX_  "(MBOL)");
19621         if (r->intflags & PREGf_ANCH_SBOL)
19622             Perl_re_printf( aTHX_  "(SBOL)");
19623         if (r->intflags & PREGf_ANCH_GPOS)
19624             Perl_re_printf( aTHX_  "(GPOS)");
19625         Perl_re_printf( aTHX_ " ");
19626     }
19627     if (r->intflags & PREGf_GPOS_SEEN)
19628         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
19629     if (r->intflags & PREGf_SKIP)
19630         Perl_re_printf( aTHX_  "plus ");
19631     if (r->intflags & PREGf_IMPLICIT)
19632         Perl_re_printf( aTHX_  "implicit ");
19633     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
19634     if (r->extflags & RXf_EVAL_SEEN)
19635         Perl_re_printf( aTHX_  "with eval ");
19636     Perl_re_printf( aTHX_  "\n");
19637     DEBUG_FLAGS_r({
19638         regdump_extflags("r->extflags: ",r->extflags);
19639         regdump_intflags("r->intflags: ",r->intflags);
19640     });
19641 #else
19642     PERL_ARGS_ASSERT_REGDUMP;
19643     PERL_UNUSED_CONTEXT;
19644     PERL_UNUSED_ARG(r);
19645 #endif  /* DEBUGGING */
19646 }
19647
19648 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
19649 #ifdef DEBUGGING
19650
19651 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
19652      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
19653      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
19654      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
19655      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
19656      || _CC_VERTSPACE != 15
19657 #   error Need to adjust order of anyofs[]
19658 #  endif
19659 static const char * const anyofs[] = {
19660     "\\w",
19661     "\\W",
19662     "\\d",
19663     "\\D",
19664     "[:alpha:]",
19665     "[:^alpha:]",
19666     "[:lower:]",
19667     "[:^lower:]",
19668     "[:upper:]",
19669     "[:^upper:]",
19670     "[:punct:]",
19671     "[:^punct:]",
19672     "[:print:]",
19673     "[:^print:]",
19674     "[:alnum:]",
19675     "[:^alnum:]",
19676     "[:graph:]",
19677     "[:^graph:]",
19678     "[:cased:]",
19679     "[:^cased:]",
19680     "\\s",
19681     "\\S",
19682     "[:blank:]",
19683     "[:^blank:]",
19684     "[:xdigit:]",
19685     "[:^xdigit:]",
19686     "[:cntrl:]",
19687     "[:^cntrl:]",
19688     "[:ascii:]",
19689     "[:^ascii:]",
19690     "\\v",
19691     "\\V"
19692 };
19693 #endif
19694
19695 /*
19696 - regprop - printable representation of opcode, with run time support
19697 */
19698
19699 void
19700 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
19701 {
19702 #ifdef DEBUGGING
19703     int k;
19704     RXi_GET_DECL(prog,progi);
19705     GET_RE_DEBUG_FLAGS_DECL;
19706
19707     PERL_ARGS_ASSERT_REGPROP;
19708
19709     SvPVCLEAR(sv);
19710
19711     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
19712         /* It would be nice to FAIL() here, but this may be called from
19713            regexec.c, and it would be hard to supply pRExC_state. */
19714         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
19715                                               (int)OP(o), (int)REGNODE_MAX);
19716     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
19717
19718     k = PL_regkind[OP(o)];
19719
19720     if (k == EXACT) {
19721         sv_catpvs(sv, " ");
19722         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
19723          * is a crude hack but it may be the best for now since
19724          * we have no flag "this EXACTish node was UTF-8"
19725          * --jhi */
19726         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
19727                   PL_colors[0], PL_colors[1],
19728                   PERL_PV_ESCAPE_UNI_DETECT |
19729                   PERL_PV_ESCAPE_NONASCII   |
19730                   PERL_PV_PRETTY_ELLIPSES   |
19731                   PERL_PV_PRETTY_LTGT       |
19732                   PERL_PV_PRETTY_NOCLEAR
19733                   );
19734     } else if (k == TRIE) {
19735         /* print the details of the trie in dumpuntil instead, as
19736          * progi->data isn't available here */
19737         const char op = OP(o);
19738         const U32 n = ARG(o);
19739         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
19740                (reg_ac_data *)progi->data->data[n] :
19741                NULL;
19742         const reg_trie_data * const trie
19743             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
19744
19745         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
19746         DEBUG_TRIE_COMPILE_r({
19747           if (trie->jump)
19748             sv_catpvs(sv, "(JUMP)");
19749           Perl_sv_catpvf(aTHX_ sv,
19750             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
19751             (UV)trie->startstate,
19752             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
19753             (UV)trie->wordcount,
19754             (UV)trie->minlen,
19755             (UV)trie->maxlen,
19756             (UV)TRIE_CHARCOUNT(trie),
19757             (UV)trie->uniquecharcount
19758           );
19759         });
19760         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
19761             sv_catpvs(sv, "[");
19762             (void) put_charclass_bitmap_innards(sv,
19763                                                 ((IS_ANYOF_TRIE(op))
19764                                                  ? ANYOF_BITMAP(o)
19765                                                  : TRIE_BITMAP(trie)),
19766                                                 NULL,
19767                                                 NULL,
19768                                                 NULL,
19769                                                 FALSE
19770                                                );
19771             sv_catpvs(sv, "]");
19772         }
19773     } else if (k == CURLY) {
19774         U32 lo = ARG1(o), hi = ARG2(o);
19775         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
19776             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
19777         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
19778         if (hi == REG_INFTY)
19779             sv_catpvs(sv, "INFTY");
19780         else
19781             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
19782         sv_catpvs(sv, "}");
19783     }
19784     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
19785         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
19786     else if (k == REF || k == OPEN || k == CLOSE
19787              || k == GROUPP || OP(o)==ACCEPT)
19788     {
19789         AV *name_list= NULL;
19790         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
19791         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
19792         if ( RXp_PAREN_NAMES(prog) ) {
19793             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19794         } else if ( pRExC_state ) {
19795             name_list= RExC_paren_name_list;
19796         }
19797         if (name_list) {
19798             if ( k != REF || (OP(o) < NREF)) {
19799                 SV **name= av_fetch(name_list, parno, 0 );
19800                 if (name)
19801                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19802             }
19803             else {
19804                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
19805                 I32 *nums=(I32*)SvPVX(sv_dat);
19806                 SV **name= av_fetch(name_list, nums[0], 0 );
19807                 I32 n;
19808                 if (name) {
19809                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
19810                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
19811                                     (n ? "," : ""), (IV)nums[n]);
19812                     }
19813                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19814                 }
19815             }
19816         }
19817         if ( k == REF && reginfo) {
19818             U32 n = ARG(o);  /* which paren pair */
19819             I32 ln = prog->offs[n].start;
19820             if (prog->lastparen < n || ln == -1 || prog->offs[n].end == -1)
19821                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
19822             else if (ln == prog->offs[n].end)
19823                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
19824             else {
19825                 const char *s = reginfo->strbeg + ln;
19826                 Perl_sv_catpvf(aTHX_ sv, ": ");
19827                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
19828                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
19829             }
19830         }
19831     } else if (k == GOSUB) {
19832         AV *name_list= NULL;
19833         if ( RXp_PAREN_NAMES(prog) ) {
19834             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19835         } else if ( pRExC_state ) {
19836             name_list= RExC_paren_name_list;
19837         }
19838
19839         /* Paren and offset */
19840         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
19841                 (int)((o + (int)ARG2L(o)) - progi->program) );
19842         if (name_list) {
19843             SV **name= av_fetch(name_list, ARG(o), 0 );
19844             if (name)
19845                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19846         }
19847     }
19848     else if (k == LOGICAL)
19849         /* 2: embedded, otherwise 1 */
19850         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
19851     else if (k == ANYOF) {
19852         const U8 flags = ANYOF_FLAGS(o);
19853         bool do_sep = FALSE;    /* Do we need to separate various components of
19854                                    the output? */
19855         /* Set if there is still an unresolved user-defined property */
19856         SV *unresolved                = NULL;
19857
19858         /* Things that are ignored except when the runtime locale is UTF-8 */
19859         SV *only_utf8_locale_invlist = NULL;
19860
19861         /* Code points that don't fit in the bitmap */
19862         SV *nonbitmap_invlist = NULL;
19863
19864         /* And things that aren't in the bitmap, but are small enough to be */
19865         SV* bitmap_range_not_in_bitmap = NULL;
19866
19867         const bool inverted = flags & ANYOF_INVERT;
19868
19869         if (OP(o) == ANYOFL) {
19870             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
19871                 sv_catpvs(sv, "{utf8-locale-reqd}");
19872             }
19873             if (flags & ANYOFL_FOLD) {
19874                 sv_catpvs(sv, "{i}");
19875             }
19876         }
19877
19878         /* If there is stuff outside the bitmap, get it */
19879         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
19880             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
19881                                                 &unresolved,
19882                                                 &only_utf8_locale_invlist,
19883                                                 &nonbitmap_invlist);
19884             /* The non-bitmap data may contain stuff that could fit in the
19885              * bitmap.  This could come from a user-defined property being
19886              * finally resolved when this call was done; or much more likely
19887              * because there are matches that require UTF-8 to be valid, and so
19888              * aren't in the bitmap.  This is teased apart later */
19889             _invlist_intersection(nonbitmap_invlist,
19890                                   PL_InBitmap,
19891                                   &bitmap_range_not_in_bitmap);
19892             /* Leave just the things that don't fit into the bitmap */
19893             _invlist_subtract(nonbitmap_invlist,
19894                               PL_InBitmap,
19895                               &nonbitmap_invlist);
19896         }
19897
19898         /* Obey this flag to add all above-the-bitmap code points */
19899         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
19900             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
19901                                                       NUM_ANYOF_CODE_POINTS,
19902                                                       UV_MAX);
19903         }
19904
19905         /* Ready to start outputting.  First, the initial left bracket */
19906         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
19907
19908         /* Then all the things that could fit in the bitmap */
19909         do_sep = put_charclass_bitmap_innards(sv,
19910                                               ANYOF_BITMAP(o),
19911                                               bitmap_range_not_in_bitmap,
19912                                               only_utf8_locale_invlist,
19913                                               o,
19914
19915                                               /* Can't try inverting for a
19916                                                * better display if there are
19917                                                * things that haven't been
19918                                                * resolved */
19919                                               unresolved != NULL);
19920         SvREFCNT_dec(bitmap_range_not_in_bitmap);
19921
19922         /* If there are user-defined properties which haven't been defined yet,
19923          * output them.  If the result is not to be inverted, it is clearest to
19924          * output them in a separate [] from the bitmap range stuff.  If the
19925          * result is to be complemented, we have to show everything in one [],
19926          * as the inversion applies to the whole thing.  Use {braces} to
19927          * separate them from anything in the bitmap and anything above the
19928          * bitmap. */
19929         if (unresolved) {
19930             if (inverted) {
19931                 if (! do_sep) { /* If didn't output anything in the bitmap */
19932                     sv_catpvs(sv, "^");
19933                 }
19934                 sv_catpvs(sv, "{");
19935             }
19936             else if (do_sep) {
19937                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19938             }
19939             sv_catsv(sv, unresolved);
19940             if (inverted) {
19941                 sv_catpvs(sv, "}");
19942             }
19943             do_sep = ! inverted;
19944         }
19945
19946         /* And, finally, add the above-the-bitmap stuff */
19947         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
19948             SV* contents;
19949
19950             /* See if truncation size is overridden */
19951             const STRLEN dump_len = (PL_dump_re_max_len > 256)
19952                                     ? PL_dump_re_max_len
19953                                     : 256;
19954
19955             /* This is output in a separate [] */
19956             if (do_sep) {
19957                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19958             }
19959
19960             /* And, for easy of understanding, it is shown in the
19961              * uncomplemented form if possible.  The one exception being if
19962              * there are unresolved items, where the inversion has to be
19963              * delayed until runtime */
19964             if (inverted && ! unresolved) {
19965                 _invlist_invert(nonbitmap_invlist);
19966                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
19967             }
19968
19969             contents = invlist_contents(nonbitmap_invlist,
19970                                         FALSE /* output suitable for catsv */
19971                                        );
19972
19973             /* If the output is shorter than the permissible maximum, just do it. */
19974             if (SvCUR(contents) <= dump_len) {
19975                 sv_catsv(sv, contents);
19976             }
19977             else {
19978                 const char * contents_string = SvPVX(contents);
19979                 STRLEN i = dump_len;
19980
19981                 /* Otherwise, start at the permissible max and work back to the
19982                  * first break possibility */
19983                 while (i > 0 && contents_string[i] != ' ') {
19984                     i--;
19985                 }
19986                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
19987                                        find a legal break */
19988                     i = dump_len;
19989                 }
19990
19991                 sv_catpvn(sv, contents_string, i);
19992                 sv_catpvs(sv, "...");
19993             }
19994
19995             SvREFCNT_dec_NN(contents);
19996             SvREFCNT_dec_NN(nonbitmap_invlist);
19997         }
19998
19999         /* And finally the matching, closing ']' */
20000         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20001
20002         SvREFCNT_dec(unresolved);
20003     }
20004     else if (k == ANYOFM) {
20005         SV * cp_list = get_ANYOFM_contents(o);
20006
20007         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20008         put_charclass_bitmap_innards(sv, NULL, cp_list, NULL, NULL, TRUE);
20009         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20010
20011         SvREFCNT_dec(cp_list);
20012     }
20013     else if (k == POSIXD || k == NPOSIXD) {
20014         U8 index = FLAGS(o) * 2;
20015         if (index < C_ARRAY_LENGTH(anyofs)) {
20016             if (*anyofs[index] != '[')  {
20017                 sv_catpv(sv, "[");
20018             }
20019             sv_catpv(sv, anyofs[index]);
20020             if (*anyofs[index] != '[')  {
20021                 sv_catpv(sv, "]");
20022             }
20023         }
20024         else {
20025             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
20026         }
20027     }
20028     else if (k == BOUND || k == NBOUND) {
20029         /* Must be synced with order of 'bound_type' in regcomp.h */
20030         const char * const bounds[] = {
20031             "",      /* Traditional */
20032             "{gcb}",
20033             "{lb}",
20034             "{sb}",
20035             "{wb}"
20036         };
20037         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
20038         sv_catpv(sv, bounds[FLAGS(o)]);
20039     }
20040     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
20041         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
20042     else if (OP(o) == SBOL)
20043         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
20044
20045     /* add on the verb argument if there is one */
20046     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
20047         if ( ARG(o) )
20048             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
20049                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
20050         else
20051             sv_catpvs(sv, ":NULL");
20052     }
20053 #else
20054     PERL_UNUSED_CONTEXT;
20055     PERL_UNUSED_ARG(sv);
20056     PERL_UNUSED_ARG(o);
20057     PERL_UNUSED_ARG(prog);
20058     PERL_UNUSED_ARG(reginfo);
20059     PERL_UNUSED_ARG(pRExC_state);
20060 #endif  /* DEBUGGING */
20061 }
20062
20063
20064
20065 SV *
20066 Perl_re_intuit_string(pTHX_ REGEXP * const r)
20067 {                               /* Assume that RE_INTUIT is set */
20068     struct regexp *const prog = ReANY(r);
20069     GET_RE_DEBUG_FLAGS_DECL;
20070
20071     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
20072     PERL_UNUSED_CONTEXT;
20073
20074     DEBUG_COMPILE_r(
20075         {
20076             const char * const s = SvPV_nolen_const(RX_UTF8(r)
20077                       ? prog->check_utf8 : prog->check_substr);
20078
20079             if (!PL_colorset) reginitcolors();
20080             Perl_re_printf( aTHX_
20081                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
20082                       PL_colors[4],
20083                       RX_UTF8(r) ? "utf8 " : "",
20084                       PL_colors[5],PL_colors[0],
20085                       s,
20086                       PL_colors[1],
20087                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
20088         } );
20089
20090     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
20091     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
20092 }
20093
20094 /*
20095    pregfree()
20096
20097    handles refcounting and freeing the perl core regexp structure. When
20098    it is necessary to actually free the structure the first thing it
20099    does is call the 'free' method of the regexp_engine associated to
20100    the regexp, allowing the handling of the void *pprivate; member
20101    first. (This routine is not overridable by extensions, which is why
20102    the extensions free is called first.)
20103
20104    See regdupe and regdupe_internal if you change anything here.
20105 */
20106 #ifndef PERL_IN_XSUB_RE
20107 void
20108 Perl_pregfree(pTHX_ REGEXP *r)
20109 {
20110     SvREFCNT_dec(r);
20111 }
20112
20113 void
20114 Perl_pregfree2(pTHX_ REGEXP *rx)
20115 {
20116     struct regexp *const r = ReANY(rx);
20117     GET_RE_DEBUG_FLAGS_DECL;
20118
20119     PERL_ARGS_ASSERT_PREGFREE2;
20120
20121     if (r->mother_re) {
20122         ReREFCNT_dec(r->mother_re);
20123     } else {
20124         CALLREGFREE_PVT(rx); /* free the private data */
20125         SvREFCNT_dec(RXp_PAREN_NAMES(r));
20126     }
20127     if (r->substrs) {
20128         int i;
20129         for (i = 0; i < 2; i++) {
20130             SvREFCNT_dec(r->substrs->data[i].substr);
20131             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
20132         }
20133         Safefree(r->substrs);
20134     }
20135     RX_MATCH_COPY_FREE(rx);
20136 #ifdef PERL_ANY_COW
20137     SvREFCNT_dec(r->saved_copy);
20138 #endif
20139     Safefree(r->offs);
20140     SvREFCNT_dec(r->qr_anoncv);
20141     if (r->recurse_locinput)
20142         Safefree(r->recurse_locinput);
20143 }
20144
20145
20146 /*  reg_temp_copy()
20147
20148     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
20149     except that dsv will be created if NULL.
20150
20151     This function is used in two main ways. First to implement
20152         $r = qr/....; $s = $$r;
20153
20154     Secondly, it is used as a hacky workaround to the structural issue of
20155     match results
20156     being stored in the regexp structure which is in turn stored in
20157     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
20158     could be PL_curpm in multiple contexts, and could require multiple
20159     result sets being associated with the pattern simultaneously, such
20160     as when doing a recursive match with (??{$qr})
20161
20162     The solution is to make a lightweight copy of the regexp structure
20163     when a qr// is returned from the code executed by (??{$qr}) this
20164     lightweight copy doesn't actually own any of its data except for
20165     the starp/end and the actual regexp structure itself.
20166
20167 */
20168
20169
20170 REGEXP *
20171 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
20172 {
20173     struct regexp *drx;
20174     struct regexp *const srx = ReANY(ssv);
20175     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
20176
20177     PERL_ARGS_ASSERT_REG_TEMP_COPY;
20178
20179     if (!dsv)
20180         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
20181     else {
20182         SvOK_off((SV *)dsv);
20183         if (islv) {
20184             /* For PVLVs, the head (sv_any) points to an XPVLV, while
20185              * the LV's xpvlenu_rx will point to a regexp body, which
20186              * we allocate here */
20187             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
20188             assert(!SvPVX(dsv));
20189             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
20190             temp->sv_any = NULL;
20191             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
20192             SvREFCNT_dec_NN(temp);
20193             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
20194                ing below will not set it. */
20195             SvCUR_set(dsv, SvCUR(ssv));
20196         }
20197     }
20198     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
20199        sv_force_normal(sv) is called.  */
20200     SvFAKE_on(dsv);
20201     drx = ReANY(dsv);
20202
20203     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
20204     SvPV_set(dsv, RX_WRAPPED(ssv));
20205     /* We share the same string buffer as the original regexp, on which we
20206        hold a reference count, incremented when mother_re is set below.
20207        The string pointer is copied here, being part of the regexp struct.
20208      */
20209     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
20210            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
20211     if (!islv)
20212         SvLEN_set(dsv, 0);
20213     if (srx->offs) {
20214         const I32 npar = srx->nparens+1;
20215         Newx(drx->offs, npar, regexp_paren_pair);
20216         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
20217     }
20218     if (srx->substrs) {
20219         int i;
20220         Newx(drx->substrs, 1, struct reg_substr_data);
20221         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
20222
20223         for (i = 0; i < 2; i++) {
20224             SvREFCNT_inc_void(drx->substrs->data[i].substr);
20225             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
20226         }
20227
20228         /* check_substr and check_utf8, if non-NULL, point to either their
20229            anchored or float namesakes, and don't hold a second reference.  */
20230     }
20231     RX_MATCH_COPIED_off(dsv);
20232 #ifdef PERL_ANY_COW
20233     drx->saved_copy = NULL;
20234 #endif
20235     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
20236     SvREFCNT_inc_void(drx->qr_anoncv);
20237     if (srx->recurse_locinput)
20238         Newx(drx->recurse_locinput,srx->nparens + 1,char *);
20239
20240     return dsv;
20241 }
20242 #endif
20243
20244
20245 /* regfree_internal()
20246
20247    Free the private data in a regexp. This is overloadable by
20248    extensions. Perl takes care of the regexp structure in pregfree(),
20249    this covers the *pprivate pointer which technically perl doesn't
20250    know about, however of course we have to handle the
20251    regexp_internal structure when no extension is in use.
20252
20253    Note this is called before freeing anything in the regexp
20254    structure.
20255  */
20256
20257 void
20258 Perl_regfree_internal(pTHX_ REGEXP * const rx)
20259 {
20260     struct regexp *const r = ReANY(rx);
20261     RXi_GET_DECL(r,ri);
20262     GET_RE_DEBUG_FLAGS_DECL;
20263
20264     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
20265
20266     DEBUG_COMPILE_r({
20267         if (!PL_colorset)
20268             reginitcolors();
20269         {
20270             SV *dsv= sv_newmortal();
20271             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
20272                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
20273             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
20274                 PL_colors[4],PL_colors[5],s);
20275         }
20276     });
20277 #ifdef RE_TRACK_PATTERN_OFFSETS
20278     if (ri->u.offsets)
20279         Safefree(ri->u.offsets);             /* 20010421 MJD */
20280 #endif
20281     if (ri->code_blocks)
20282         S_free_codeblocks(aTHX_ ri->code_blocks);
20283
20284     if (ri->data) {
20285         int n = ri->data->count;
20286
20287         while (--n >= 0) {
20288           /* If you add a ->what type here, update the comment in regcomp.h */
20289             switch (ri->data->what[n]) {
20290             case 'a':
20291             case 'r':
20292             case 's':
20293             case 'S':
20294             case 'u':
20295                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
20296                 break;
20297             case 'f':
20298                 Safefree(ri->data->data[n]);
20299                 break;
20300             case 'l':
20301             case 'L':
20302                 break;
20303             case 'T':
20304                 { /* Aho Corasick add-on structure for a trie node.
20305                      Used in stclass optimization only */
20306                     U32 refcount;
20307                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
20308 #ifdef USE_ITHREADS
20309                     dVAR;
20310 #endif
20311                     OP_REFCNT_LOCK;
20312                     refcount = --aho->refcount;
20313                     OP_REFCNT_UNLOCK;
20314                     if ( !refcount ) {
20315                         PerlMemShared_free(aho->states);
20316                         PerlMemShared_free(aho->fail);
20317                          /* do this last!!!! */
20318                         PerlMemShared_free(ri->data->data[n]);
20319                         /* we should only ever get called once, so
20320                          * assert as much, and also guard the free
20321                          * which /might/ happen twice. At the least
20322                          * it will make code anlyzers happy and it
20323                          * doesn't cost much. - Yves */
20324                         assert(ri->regstclass);
20325                         if (ri->regstclass) {
20326                             PerlMemShared_free(ri->regstclass);
20327                             ri->regstclass = 0;
20328                         }
20329                     }
20330                 }
20331                 break;
20332             case 't':
20333                 {
20334                     /* trie structure. */
20335                     U32 refcount;
20336                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
20337 #ifdef USE_ITHREADS
20338                     dVAR;
20339 #endif
20340                     OP_REFCNT_LOCK;
20341                     refcount = --trie->refcount;
20342                     OP_REFCNT_UNLOCK;
20343                     if ( !refcount ) {
20344                         PerlMemShared_free(trie->charmap);
20345                         PerlMemShared_free(trie->states);
20346                         PerlMemShared_free(trie->trans);
20347                         if (trie->bitmap)
20348                             PerlMemShared_free(trie->bitmap);
20349                         if (trie->jump)
20350                             PerlMemShared_free(trie->jump);
20351                         PerlMemShared_free(trie->wordinfo);
20352                         /* do this last!!!! */
20353                         PerlMemShared_free(ri->data->data[n]);
20354                     }
20355                 }
20356                 break;
20357             default:
20358                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
20359                                                     ri->data->what[n]);
20360             }
20361         }
20362         Safefree(ri->data->what);
20363         Safefree(ri->data);
20364     }
20365
20366     Safefree(ri);
20367 }
20368
20369 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
20370 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
20371 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
20372
20373 /*
20374    re_dup_guts - duplicate a regexp.
20375
20376    This routine is expected to clone a given regexp structure. It is only
20377    compiled under USE_ITHREADS.
20378
20379    After all of the core data stored in struct regexp is duplicated
20380    the regexp_engine.dupe method is used to copy any private data
20381    stored in the *pprivate pointer. This allows extensions to handle
20382    any duplication it needs to do.
20383
20384    See pregfree() and regfree_internal() if you change anything here.
20385 */
20386 #if defined(USE_ITHREADS)
20387 #ifndef PERL_IN_XSUB_RE
20388 void
20389 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
20390 {
20391     dVAR;
20392     I32 npar;
20393     const struct regexp *r = ReANY(sstr);
20394     struct regexp *ret = ReANY(dstr);
20395
20396     PERL_ARGS_ASSERT_RE_DUP_GUTS;
20397
20398     npar = r->nparens+1;
20399     Newx(ret->offs, npar, regexp_paren_pair);
20400     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
20401
20402     if (ret->substrs) {
20403         /* Do it this way to avoid reading from *r after the StructCopy().
20404            That way, if any of the sv_dup_inc()s dislodge *r from the L1
20405            cache, it doesn't matter.  */
20406         int i;
20407         const bool anchored = r->check_substr
20408             ? r->check_substr == r->substrs->data[0].substr
20409             : r->check_utf8   == r->substrs->data[0].utf8_substr;
20410         Newx(ret->substrs, 1, struct reg_substr_data);
20411         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
20412
20413         for (i = 0; i < 2; i++) {
20414             ret->substrs->data[i].substr =
20415                         sv_dup_inc(ret->substrs->data[i].substr, param);
20416             ret->substrs->data[i].utf8_substr =
20417                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
20418         }
20419
20420         /* check_substr and check_utf8, if non-NULL, point to either their
20421            anchored or float namesakes, and don't hold a second reference.  */
20422
20423         if (ret->check_substr) {
20424             if (anchored) {
20425                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
20426
20427                 ret->check_substr = ret->substrs->data[0].substr;
20428                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
20429             } else {
20430                 assert(r->check_substr == r->substrs->data[1].substr);
20431                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
20432
20433                 ret->check_substr = ret->substrs->data[1].substr;
20434                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
20435             }
20436         } else if (ret->check_utf8) {
20437             if (anchored) {
20438                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
20439             } else {
20440                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
20441             }
20442         }
20443     }
20444
20445     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
20446     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
20447     if (r->recurse_locinput)
20448         Newx(ret->recurse_locinput,r->nparens + 1,char *);
20449
20450     if (ret->pprivate)
20451         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
20452
20453     if (RX_MATCH_COPIED(dstr))
20454         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
20455     else
20456         ret->subbeg = NULL;
20457 #ifdef PERL_ANY_COW
20458     ret->saved_copy = NULL;
20459 #endif
20460
20461     /* Whether mother_re be set or no, we need to copy the string.  We
20462        cannot refrain from copying it when the storage points directly to
20463        our mother regexp, because that's
20464                1: a buffer in a different thread
20465                2: something we no longer hold a reference on
20466                so we need to copy it locally.  */
20467     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
20468     ret->mother_re   = NULL;
20469 }
20470 #endif /* PERL_IN_XSUB_RE */
20471
20472 /*
20473    regdupe_internal()
20474
20475    This is the internal complement to regdupe() which is used to copy
20476    the structure pointed to by the *pprivate pointer in the regexp.
20477    This is the core version of the extension overridable cloning hook.
20478    The regexp structure being duplicated will be copied by perl prior
20479    to this and will be provided as the regexp *r argument, however
20480    with the /old/ structures pprivate pointer value. Thus this routine
20481    may override any copying normally done by perl.
20482
20483    It returns a pointer to the new regexp_internal structure.
20484 */
20485
20486 void *
20487 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
20488 {
20489     dVAR;
20490     struct regexp *const r = ReANY(rx);
20491     regexp_internal *reti;
20492     int len;
20493     RXi_GET_DECL(r,ri);
20494
20495     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
20496
20497     len = ProgLen(ri);
20498
20499     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
20500           char, regexp_internal);
20501     Copy(ri->program, reti->program, len+1, regnode);
20502
20503
20504     if (ri->code_blocks) {
20505         int n;
20506         Newx(reti->code_blocks, 1, struct reg_code_blocks);
20507         Newx(reti->code_blocks->cb, ri->code_blocks->count,
20508                     struct reg_code_block);
20509         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
20510              ri->code_blocks->count, struct reg_code_block);
20511         for (n = 0; n < ri->code_blocks->count; n++)
20512              reti->code_blocks->cb[n].src_regex = (REGEXP*)
20513                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
20514         reti->code_blocks->count = ri->code_blocks->count;
20515         reti->code_blocks->refcnt = 1;
20516     }
20517     else
20518         reti->code_blocks = NULL;
20519
20520     reti->regstclass = NULL;
20521
20522     if (ri->data) {
20523         struct reg_data *d;
20524         const int count = ri->data->count;
20525         int i;
20526
20527         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
20528                 char, struct reg_data);
20529         Newx(d->what, count, U8);
20530
20531         d->count = count;
20532         for (i = 0; i < count; i++) {
20533             d->what[i] = ri->data->what[i];
20534             switch (d->what[i]) {
20535                 /* see also regcomp.h and regfree_internal() */
20536             case 'a': /* actually an AV, but the dup function is identical.
20537                          values seem to be "plain sv's" generally. */
20538             case 'r': /* a compiled regex (but still just another SV) */
20539             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
20540                          this use case should go away, the code could have used
20541                          'a' instead - see S_set_ANYOF_arg() for array contents. */
20542             case 'S': /* actually an SV, but the dup function is identical.  */
20543             case 'u': /* actually an HV, but the dup function is identical.
20544                          values are "plain sv's" */
20545                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
20546                 break;
20547             case 'f':
20548                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
20549                  * patterns which could start with several different things. Pre-TRIE
20550                  * this was more important than it is now, however this still helps
20551                  * in some places, for instance /x?a+/ might produce a SSC equivalent
20552                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
20553                  * in regexec.c
20554                  */
20555                 /* This is cheating. */
20556                 Newx(d->data[i], 1, regnode_ssc);
20557                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
20558                 reti->regstclass = (regnode*)d->data[i];
20559                 break;
20560             case 'T':
20561                 /* AHO-CORASICK fail table */
20562                 /* Trie stclasses are readonly and can thus be shared
20563                  * without duplication. We free the stclass in pregfree
20564                  * when the corresponding reg_ac_data struct is freed.
20565                  */
20566                 reti->regstclass= ri->regstclass;
20567                 /* FALLTHROUGH */
20568             case 't':
20569                 /* TRIE transition table */
20570                 OP_REFCNT_LOCK;
20571                 ((reg_trie_data*)ri->data->data[i])->refcount++;
20572                 OP_REFCNT_UNLOCK;
20573                 /* FALLTHROUGH */
20574             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
20575             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
20576                          is not from another regexp */
20577                 d->data[i] = ri->data->data[i];
20578                 break;
20579             default:
20580                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
20581                                                            ri->data->what[i]);
20582             }
20583         }
20584
20585         reti->data = d;
20586     }
20587     else
20588         reti->data = NULL;
20589
20590     reti->name_list_idx = ri->name_list_idx;
20591
20592 #ifdef RE_TRACK_PATTERN_OFFSETS
20593     if (ri->u.offsets) {
20594         Newx(reti->u.offsets, 2*len+1, U32);
20595         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
20596     }
20597 #else
20598     SetProgLen(reti,len);
20599 #endif
20600
20601     return (void*)reti;
20602 }
20603
20604 #endif    /* USE_ITHREADS */
20605
20606 #ifndef PERL_IN_XSUB_RE
20607
20608 /*
20609  - regnext - dig the "next" pointer out of a node
20610  */
20611 regnode *
20612 Perl_regnext(pTHX_ regnode *p)
20613 {
20614     I32 offset;
20615
20616     if (!p)
20617         return(NULL);
20618
20619     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
20620         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
20621                                                 (int)OP(p), (int)REGNODE_MAX);
20622     }
20623
20624     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
20625     if (offset == 0)
20626         return(NULL);
20627
20628     return(p+offset);
20629 }
20630 #endif
20631
20632 STATIC void
20633 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
20634 {
20635     va_list args;
20636     STRLEN l1 = strlen(pat1);
20637     STRLEN l2 = strlen(pat2);
20638     char buf[512];
20639     SV *msv;
20640     const char *message;
20641
20642     PERL_ARGS_ASSERT_RE_CROAK2;
20643
20644     if (l1 > 510)
20645         l1 = 510;
20646     if (l1 + l2 > 510)
20647         l2 = 510 - l1;
20648     Copy(pat1, buf, l1 , char);
20649     Copy(pat2, buf + l1, l2 , char);
20650     buf[l1 + l2] = '\n';
20651     buf[l1 + l2 + 1] = '\0';
20652     va_start(args, pat2);
20653     msv = vmess(buf, &args);
20654     va_end(args);
20655     message = SvPV_const(msv,l1);
20656     if (l1 > 512)
20657         l1 = 512;
20658     Copy(message, buf, l1 , char);
20659     /* l1-1 to avoid \n */
20660     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
20661 }
20662
20663 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
20664
20665 #ifndef PERL_IN_XSUB_RE
20666 void
20667 Perl_save_re_context(pTHX)
20668 {
20669     I32 nparens = -1;
20670     I32 i;
20671
20672     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
20673
20674     if (PL_curpm) {
20675         const REGEXP * const rx = PM_GETRE(PL_curpm);
20676         if (rx)
20677             nparens = RX_NPARENS(rx);
20678     }
20679
20680     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
20681      * that PL_curpm will be null, but that utf8.pm and the modules it
20682      * loads will only use $1..$3.
20683      * The t/porting/re_context.t test file checks this assumption.
20684      */
20685     if (nparens == -1)
20686         nparens = 3;
20687
20688     for (i = 1; i <= nparens; i++) {
20689         char digits[TYPE_CHARS(long)];
20690         const STRLEN len = my_snprintf(digits, sizeof(digits),
20691                                        "%lu", (long)i);
20692         GV *const *const gvp
20693             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
20694
20695         if (gvp) {
20696             GV * const gv = *gvp;
20697             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
20698                 save_scalar(gv);
20699         }
20700     }
20701 }
20702 #endif
20703
20704 #ifdef DEBUGGING
20705
20706 STATIC void
20707 S_put_code_point(pTHX_ SV *sv, UV c)
20708 {
20709     PERL_ARGS_ASSERT_PUT_CODE_POINT;
20710
20711     if (c > 255) {
20712         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
20713     }
20714     else if (isPRINT(c)) {
20715         const char string = (char) c;
20716
20717         /* We use {phrase} as metanotation in the class, so also escape literal
20718          * braces */
20719         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
20720             sv_catpvs(sv, "\\");
20721         sv_catpvn(sv, &string, 1);
20722     }
20723     else if (isMNEMONIC_CNTRL(c)) {
20724         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
20725     }
20726     else {
20727         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
20728     }
20729 }
20730
20731 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
20732
20733 STATIC void
20734 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
20735 {
20736     /* Appends to 'sv' a displayable version of the range of code points from
20737      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
20738      * that have them, when they occur at the beginning or end of the range.
20739      * It uses hex to output the remaining code points, unless 'allow_literals'
20740      * is true, in which case the printable ASCII ones are output as-is (though
20741      * some of these will be escaped by put_code_point()).
20742      *
20743      * NOTE:  This is designed only for printing ranges of code points that fit
20744      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
20745      */
20746
20747     const unsigned int min_range_count = 3;
20748
20749     assert(start <= end);
20750
20751     PERL_ARGS_ASSERT_PUT_RANGE;
20752
20753     while (start <= end) {
20754         UV this_end;
20755         const char * format;
20756
20757         if (end - start < min_range_count) {
20758
20759             /* Output chars individually when they occur in short ranges */
20760             for (; start <= end; start++) {
20761                 put_code_point(sv, start);
20762             }
20763             break;
20764         }
20765
20766         /* If permitted by the input options, and there is a possibility that
20767          * this range contains a printable literal, look to see if there is
20768          * one. */
20769         if (allow_literals && start <= MAX_PRINT_A) {
20770
20771             /* If the character at the beginning of the range isn't an ASCII
20772              * printable, effectively split the range into two parts:
20773              *  1) the portion before the first such printable,
20774              *  2) the rest
20775              * and output them separately. */
20776             if (! isPRINT_A(start)) {
20777                 UV temp_end = start + 1;
20778
20779                 /* There is no point looking beyond the final possible
20780                  * printable, in MAX_PRINT_A */
20781                 UV max = MIN(end, MAX_PRINT_A);
20782
20783                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
20784                     temp_end++;
20785                 }
20786
20787                 /* Here, temp_end points to one beyond the first printable if
20788                  * found, or to one beyond 'max' if not.  If none found, make
20789                  * sure that we use the entire range */
20790                 if (temp_end > MAX_PRINT_A) {
20791                     temp_end = end + 1;
20792                 }
20793
20794                 /* Output the first part of the split range: the part that
20795                  * doesn't have printables, with the parameter set to not look
20796                  * for literals (otherwise we would infinitely recurse) */
20797                 put_range(sv, start, temp_end - 1, FALSE);
20798
20799                 /* The 2nd part of the range (if any) starts here. */
20800                 start = temp_end;
20801
20802                 /* We do a continue, instead of dropping down, because even if
20803                  * the 2nd part is non-empty, it could be so short that we want
20804                  * to output it as individual characters, as tested for at the
20805                  * top of this loop.  */
20806                 continue;
20807             }
20808
20809             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
20810              * output a sub-range of just the digits or letters, then process
20811              * the remaining portion as usual. */
20812             if (isALPHANUMERIC_A(start)) {
20813                 UV mask = (isDIGIT_A(start))
20814                            ? _CC_DIGIT
20815                              : isUPPER_A(start)
20816                                ? _CC_UPPER
20817                                : _CC_LOWER;
20818                 UV temp_end = start + 1;
20819
20820                 /* Find the end of the sub-range that includes just the
20821                  * characters in the same class as the first character in it */
20822                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
20823                     temp_end++;
20824                 }
20825                 temp_end--;
20826
20827                 /* For short ranges, don't duplicate the code above to output
20828                  * them; just call recursively */
20829                 if (temp_end - start < min_range_count) {
20830                     put_range(sv, start, temp_end, FALSE);
20831                 }
20832                 else {  /* Output as a range */
20833                     put_code_point(sv, start);
20834                     sv_catpvs(sv, "-");
20835                     put_code_point(sv, temp_end);
20836                 }
20837                 start = temp_end + 1;
20838                 continue;
20839             }
20840
20841             /* We output any other printables as individual characters */
20842             if (isPUNCT_A(start) || isSPACE_A(start)) {
20843                 while (start <= end && (isPUNCT_A(start)
20844                                         || isSPACE_A(start)))
20845                 {
20846                     put_code_point(sv, start);
20847                     start++;
20848                 }
20849                 continue;
20850             }
20851         } /* End of looking for literals */
20852
20853         /* Here is not to output as a literal.  Some control characters have
20854          * mnemonic names.  Split off any of those at the beginning and end of
20855          * the range to print mnemonically.  It isn't possible for many of
20856          * these to be in a row, so this won't overwhelm with output */
20857         if (   start <= end
20858             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
20859         {
20860             while (isMNEMONIC_CNTRL(start) && start <= end) {
20861                 put_code_point(sv, start);
20862                 start++;
20863             }
20864
20865             /* If this didn't take care of the whole range ... */
20866             if (start <= end) {
20867
20868                 /* Look backwards from the end to find the final non-mnemonic
20869                  * */
20870                 UV temp_end = end;
20871                 while (isMNEMONIC_CNTRL(temp_end)) {
20872                     temp_end--;
20873                 }
20874
20875                 /* And separately output the interior range that doesn't start
20876                  * or end with mnemonics */
20877                 put_range(sv, start, temp_end, FALSE);
20878
20879                 /* Then output the mnemonic trailing controls */
20880                 start = temp_end + 1;
20881                 while (start <= end) {
20882                     put_code_point(sv, start);
20883                     start++;
20884                 }
20885                 break;
20886             }
20887         }
20888
20889         /* As a final resort, output the range or subrange as hex. */
20890
20891         this_end = (end < NUM_ANYOF_CODE_POINTS)
20892                     ? end
20893                     : NUM_ANYOF_CODE_POINTS - 1;
20894 #if NUM_ANYOF_CODE_POINTS > 256
20895         format = (this_end < 256)
20896                  ? "\\x%02" UVXf "-\\x%02" UVXf
20897                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
20898 #else
20899         format = "\\x%02" UVXf "-\\x%02" UVXf;
20900 #endif
20901         GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral);
20902         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
20903         GCC_DIAG_RESTORE_STMT;
20904         break;
20905     }
20906 }
20907
20908 STATIC void
20909 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
20910 {
20911     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
20912      * 'invlist' */
20913
20914     UV start, end;
20915     bool allow_literals = TRUE;
20916
20917     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
20918
20919     /* Generally, it is more readable if printable characters are output as
20920      * literals, but if a range (nearly) spans all of them, it's best to output
20921      * it as a single range.  This code will use a single range if all but 2
20922      * ASCII printables are in it */
20923     invlist_iterinit(invlist);
20924     while (invlist_iternext(invlist, &start, &end)) {
20925
20926         /* If the range starts beyond the final printable, it doesn't have any
20927          * in it */
20928         if (start > MAX_PRINT_A) {
20929             break;
20930         }
20931
20932         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
20933          * all but two, the range must start and end no later than 2 from
20934          * either end */
20935         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
20936             if (end > MAX_PRINT_A) {
20937                 end = MAX_PRINT_A;
20938             }
20939             if (start < ' ') {
20940                 start = ' ';
20941             }
20942             if (end - start >= MAX_PRINT_A - ' ' - 2) {
20943                 allow_literals = FALSE;
20944             }
20945             break;
20946         }
20947     }
20948     invlist_iterfinish(invlist);
20949
20950     /* Here we have figured things out.  Output each range */
20951     invlist_iterinit(invlist);
20952     while (invlist_iternext(invlist, &start, &end)) {
20953         if (start >= NUM_ANYOF_CODE_POINTS) {
20954             break;
20955         }
20956         put_range(sv, start, end, allow_literals);
20957     }
20958     invlist_iterfinish(invlist);
20959
20960     return;
20961 }
20962
20963 STATIC SV*
20964 S_put_charclass_bitmap_innards_common(pTHX_
20965         SV* invlist,            /* The bitmap */
20966         SV* posixes,            /* Under /l, things like [:word:], \S */
20967         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
20968         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
20969         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
20970         const bool invert       /* Is the result to be inverted? */
20971 )
20972 {
20973     /* Create and return an SV containing a displayable version of the bitmap
20974      * and associated information determined by the input parameters.  If the
20975      * output would have been only the inversion indicator '^', NULL is instead
20976      * returned. */
20977
20978     SV * output;
20979
20980     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
20981
20982     if (invert) {
20983         output = newSVpvs("^");
20984     }
20985     else {
20986         output = newSVpvs("");
20987     }
20988
20989     /* First, the code points in the bitmap that are unconditionally there */
20990     put_charclass_bitmap_innards_invlist(output, invlist);
20991
20992     /* Traditionally, these have been placed after the main code points */
20993     if (posixes) {
20994         sv_catsv(output, posixes);
20995     }
20996
20997     if (only_utf8 && _invlist_len(only_utf8)) {
20998         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
20999         put_charclass_bitmap_innards_invlist(output, only_utf8);
21000     }
21001
21002     if (not_utf8 && _invlist_len(not_utf8)) {
21003         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
21004         put_charclass_bitmap_innards_invlist(output, not_utf8);
21005     }
21006
21007     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
21008         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
21009         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
21010
21011         /* This is the only list in this routine that can legally contain code
21012          * points outside the bitmap range.  The call just above to
21013          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
21014          * output them here.  There's about a half-dozen possible, and none in
21015          * contiguous ranges longer than 2 */
21016         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21017             UV start, end;
21018             SV* above_bitmap = NULL;
21019
21020             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
21021
21022             invlist_iterinit(above_bitmap);
21023             while (invlist_iternext(above_bitmap, &start, &end)) {
21024                 UV i;
21025
21026                 for (i = start; i <= end; i++) {
21027                     put_code_point(output, i);
21028                 }
21029             }
21030             invlist_iterfinish(above_bitmap);
21031             SvREFCNT_dec_NN(above_bitmap);
21032         }
21033     }
21034
21035     if (invert && SvCUR(output) == 1) {
21036         return NULL;
21037     }
21038
21039     return output;
21040 }
21041
21042 STATIC bool
21043 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
21044                                      char *bitmap,
21045                                      SV *nonbitmap_invlist,
21046                                      SV *only_utf8_locale_invlist,
21047                                      const regnode * const node,
21048                                      const bool force_as_is_display)
21049 {
21050     /* Appends to 'sv' a displayable version of the innards of the bracketed
21051      * character class defined by the other arguments:
21052      *  'bitmap' points to the bitmap, or NULL if to ignore that.
21053      *  'nonbitmap_invlist' is an inversion list of the code points that are in
21054      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
21055      *      none.  The reasons for this could be that they require some
21056      *      condition such as the target string being or not being in UTF-8
21057      *      (under /d), or because they came from a user-defined property that
21058      *      was not resolved at the time of the regex compilation (under /u)
21059      *  'only_utf8_locale_invlist' is an inversion list of the code points that
21060      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
21061      *  'node' is the regex pattern ANYOF node.  It is needed only when the
21062      *      above two parameters are not null, and is passed so that this
21063      *      routine can tease apart the various reasons for them.
21064      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
21065      *      to invert things to see if that leads to a cleaner display.  If
21066      *      FALSE, this routine is free to use its judgment about doing this.
21067      *
21068      * It returns TRUE if there was actually something output.  (It may be that
21069      * the bitmap, etc is empty.)
21070      *
21071      * When called for outputting the bitmap of a non-ANYOF node, just pass the
21072      * bitmap, with the succeeding parameters set to NULL, and the final one to
21073      * FALSE.
21074      */
21075
21076     /* In general, it tries to display the 'cleanest' representation of the
21077      * innards, choosing whether to display them inverted or not, regardless of
21078      * whether the class itself is to be inverted.  However,  there are some
21079      * cases where it can't try inverting, as what actually matches isn't known
21080      * until runtime, and hence the inversion isn't either. */
21081     bool inverting_allowed = ! force_as_is_display;
21082
21083     int i;
21084     STRLEN orig_sv_cur = SvCUR(sv);
21085
21086     SV* invlist;            /* Inversion list we accumulate of code points that
21087                                are unconditionally matched */
21088     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
21089                                UTF-8 */
21090     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
21091                              */
21092     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
21093     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
21094                                        is UTF-8 */
21095
21096     SV* as_is_display;      /* The output string when we take the inputs
21097                                literally */
21098     SV* inverted_display;   /* The output string when we invert the inputs */
21099
21100     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
21101
21102     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
21103                                                    to match? */
21104     /* We are biased in favor of displaying things without them being inverted,
21105      * as that is generally easier to understand */
21106     const int bias = 5;
21107
21108     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
21109
21110     /* Start off with whatever code points are passed in.  (We clone, so we
21111      * don't change the caller's list) */
21112     if (nonbitmap_invlist) {
21113         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
21114         invlist = invlist_clone(nonbitmap_invlist);
21115     }
21116     else {  /* Worst case size is every other code point is matched */
21117         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
21118     }
21119
21120     if (flags) {
21121         if (OP(node) == ANYOFD) {
21122
21123             /* This flag indicates that the code points below 0x100 in the
21124              * nonbitmap list are precisely the ones that match only when the
21125              * target is UTF-8 (they should all be non-ASCII). */
21126             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
21127             {
21128                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
21129                 _invlist_subtract(invlist, only_utf8, &invlist);
21130             }
21131
21132             /* And this flag for matching all non-ASCII 0xFF and below */
21133             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
21134             {
21135                 not_utf8 = invlist_clone(PL_UpperLatin1);
21136             }
21137         }
21138         else if (OP(node) == ANYOFL) {
21139
21140             /* If either of these flags are set, what matches isn't
21141              * determinable except during execution, so don't know enough here
21142              * to invert */
21143             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
21144                 inverting_allowed = FALSE;
21145             }
21146
21147             /* What the posix classes match also varies at runtime, so these
21148              * will be output symbolically. */
21149             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
21150                 int i;
21151
21152                 posixes = newSVpvs("");
21153                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
21154                     if (ANYOF_POSIXL_TEST(node,i)) {
21155                         sv_catpv(posixes, anyofs[i]);
21156                     }
21157                 }
21158             }
21159         }
21160     }
21161
21162     /* Accumulate the bit map into the unconditional match list */
21163     if (bitmap) {
21164         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
21165             if (BITMAP_TEST(bitmap, i)) {
21166                 int start = i++;
21167                 for (;
21168                      i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i);
21169                      i++)
21170                 { /* empty */ }
21171                 invlist = _add_range_to_invlist(invlist, start, i-1);
21172             }
21173         }
21174     }
21175
21176     /* Make sure that the conditional match lists don't have anything in them
21177      * that match unconditionally; otherwise the output is quite confusing.
21178      * This could happen if the code that populates these misses some
21179      * duplication. */
21180     if (only_utf8) {
21181         _invlist_subtract(only_utf8, invlist, &only_utf8);
21182     }
21183     if (not_utf8) {
21184         _invlist_subtract(not_utf8, invlist, &not_utf8);
21185     }
21186
21187     if (only_utf8_locale_invlist) {
21188
21189         /* Since this list is passed in, we have to make a copy before
21190          * modifying it */
21191         only_utf8_locale = invlist_clone(only_utf8_locale_invlist);
21192
21193         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
21194
21195         /* And, it can get really weird for us to try outputting an inverted
21196          * form of this list when it has things above the bitmap, so don't even
21197          * try */
21198         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21199             inverting_allowed = FALSE;
21200         }
21201     }
21202
21203     /* Calculate what the output would be if we take the input as-is */
21204     as_is_display = put_charclass_bitmap_innards_common(invlist,
21205                                                     posixes,
21206                                                     only_utf8,
21207                                                     not_utf8,
21208                                                     only_utf8_locale,
21209                                                     invert);
21210
21211     /* If have to take the output as-is, just do that */
21212     if (! inverting_allowed) {
21213         if (as_is_display) {
21214             sv_catsv(sv, as_is_display);
21215             SvREFCNT_dec_NN(as_is_display);
21216         }
21217     }
21218     else { /* But otherwise, create the output again on the inverted input, and
21219               use whichever version is shorter */
21220
21221         int inverted_bias, as_is_bias;
21222
21223         /* We will apply our bias to whichever of the the results doesn't have
21224          * the '^' */
21225         if (invert) {
21226             invert = FALSE;
21227             as_is_bias = bias;
21228             inverted_bias = 0;
21229         }
21230         else {
21231             invert = TRUE;
21232             as_is_bias = 0;
21233             inverted_bias = bias;
21234         }
21235
21236         /* Now invert each of the lists that contribute to the output,
21237          * excluding from the result things outside the possible range */
21238
21239         /* For the unconditional inversion list, we have to add in all the
21240          * conditional code points, so that when inverted, they will be gone
21241          * from it */
21242         _invlist_union(only_utf8, invlist, &invlist);
21243         _invlist_union(not_utf8, invlist, &invlist);
21244         _invlist_union(only_utf8_locale, invlist, &invlist);
21245         _invlist_invert(invlist);
21246         _invlist_intersection(invlist, PL_InBitmap, &invlist);
21247
21248         if (only_utf8) {
21249             _invlist_invert(only_utf8);
21250             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
21251         }
21252         else if (not_utf8) {
21253
21254             /* If a code point matches iff the target string is not in UTF-8,
21255              * then complementing the result has it not match iff not in UTF-8,
21256              * which is the same thing as matching iff it is UTF-8. */
21257             only_utf8 = not_utf8;
21258             not_utf8 = NULL;
21259         }
21260
21261         if (only_utf8_locale) {
21262             _invlist_invert(only_utf8_locale);
21263             _invlist_intersection(only_utf8_locale,
21264                                   PL_InBitmap,
21265                                   &only_utf8_locale);
21266         }
21267
21268         inverted_display = put_charclass_bitmap_innards_common(
21269                                             invlist,
21270                                             posixes,
21271                                             only_utf8,
21272                                             not_utf8,
21273                                             only_utf8_locale, invert);
21274
21275         /* Use the shortest representation, taking into account our bias
21276          * against showing it inverted */
21277         if (   inverted_display
21278             && (   ! as_is_display
21279                 || (  SvCUR(inverted_display) + inverted_bias
21280                     < SvCUR(as_is_display)    + as_is_bias)))
21281         {
21282             sv_catsv(sv, inverted_display);
21283         }
21284         else if (as_is_display) {
21285             sv_catsv(sv, as_is_display);
21286         }
21287
21288         SvREFCNT_dec(as_is_display);
21289         SvREFCNT_dec(inverted_display);
21290     }
21291
21292     SvREFCNT_dec_NN(invlist);
21293     SvREFCNT_dec(only_utf8);
21294     SvREFCNT_dec(not_utf8);
21295     SvREFCNT_dec(posixes);
21296     SvREFCNT_dec(only_utf8_locale);
21297
21298     return SvCUR(sv) > orig_sv_cur;
21299 }
21300
21301 #define CLEAR_OPTSTART                                                       \
21302     if (optstart) STMT_START {                                               \
21303         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
21304                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
21305         optstart=NULL;                                                       \
21306     } STMT_END
21307
21308 #define DUMPUNTIL(b,e)                                                       \
21309                     CLEAR_OPTSTART;                                          \
21310                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
21311
21312 STATIC const regnode *
21313 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
21314             const regnode *last, const regnode *plast,
21315             SV* sv, I32 indent, U32 depth)
21316 {
21317     U8 op = PSEUDO;     /* Arbitrary non-END op. */
21318     const regnode *next;
21319     const regnode *optstart= NULL;
21320
21321     RXi_GET_DECL(r,ri);
21322     GET_RE_DEBUG_FLAGS_DECL;
21323
21324     PERL_ARGS_ASSERT_DUMPUNTIL;
21325
21326 #ifdef DEBUG_DUMPUNTIL
21327     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n",indent,node-start,
21328         last ? last-start : 0,plast ? plast-start : 0);
21329 #endif
21330
21331     if (plast && plast < last)
21332         last= plast;
21333
21334     while (PL_regkind[op] != END && (!last || node < last)) {
21335         assert(node);
21336         /* While that wasn't END last time... */
21337         NODE_ALIGN(node);
21338         op = OP(node);
21339         if (op == CLOSE || op == SRCLOSE || op == WHILEM)
21340             indent--;
21341         next = regnext((regnode *)node);
21342
21343         /* Where, what. */
21344         if (OP(node) == OPTIMIZED) {
21345             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
21346                 optstart = node;
21347             else
21348                 goto after_print;
21349         } else
21350             CLEAR_OPTSTART;
21351
21352         regprop(r, sv, node, NULL, NULL);
21353         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
21354                       (int)(2*indent + 1), "", SvPVX_const(sv));
21355
21356         if (OP(node) != OPTIMIZED) {
21357             if (next == NULL)           /* Next ptr. */
21358                 Perl_re_printf( aTHX_  " (0)");
21359             else if (PL_regkind[(U8)op] == BRANCH
21360                      && PL_regkind[OP(next)] != BRANCH )
21361                 Perl_re_printf( aTHX_  " (FAIL)");
21362             else
21363                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
21364             Perl_re_printf( aTHX_ "\n");
21365         }
21366
21367       after_print:
21368         if (PL_regkind[(U8)op] == BRANCHJ) {
21369             assert(next);
21370             {
21371                 const regnode *nnode = (OP(next) == LONGJMP
21372                                        ? regnext((regnode *)next)
21373                                        : next);
21374                 if (last && nnode > last)
21375                     nnode = last;
21376                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
21377             }
21378         }
21379         else if (PL_regkind[(U8)op] == BRANCH) {
21380             assert(next);
21381             DUMPUNTIL(NEXTOPER(node), next);
21382         }
21383         else if ( PL_regkind[(U8)op]  == TRIE ) {
21384             const regnode *this_trie = node;
21385             const char op = OP(node);
21386             const U32 n = ARG(node);
21387             const reg_ac_data * const ac = op>=AHOCORASICK ?
21388                (reg_ac_data *)ri->data->data[n] :
21389                NULL;
21390             const reg_trie_data * const trie =
21391                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
21392 #ifdef DEBUGGING
21393             AV *const trie_words
21394                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
21395 #endif
21396             const regnode *nextbranch= NULL;
21397             I32 word_idx;
21398             SvPVCLEAR(sv);
21399             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
21400                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
21401
21402                 Perl_re_indentf( aTHX_  "%s ",
21403                     indent+3,
21404                     elem_ptr
21405                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
21406                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
21407                                 PL_colors[0], PL_colors[1],
21408                                 (SvUTF8(*elem_ptr)
21409                                  ? PERL_PV_ESCAPE_UNI
21410                                  : 0)
21411                                 | PERL_PV_PRETTY_ELLIPSES
21412                                 | PERL_PV_PRETTY_LTGT
21413                             )
21414                     : "???"
21415                 );
21416                 if (trie->jump) {
21417                     U16 dist= trie->jump[word_idx+1];
21418                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
21419                                (UV)((dist ? this_trie + dist : next) - start));
21420                     if (dist) {
21421                         if (!nextbranch)
21422                             nextbranch= this_trie + trie->jump[0];
21423                         DUMPUNTIL(this_trie + dist, nextbranch);
21424                     }
21425                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
21426                         nextbranch= regnext((regnode *)nextbranch);
21427                 } else {
21428                     Perl_re_printf( aTHX_  "\n");
21429                 }
21430             }
21431             if (last && next > last)
21432                 node= last;
21433             else
21434                 node= next;
21435         }
21436         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
21437             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
21438                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
21439         }
21440         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
21441             assert(next);
21442             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
21443         }
21444         else if ( op == PLUS || op == STAR) {
21445             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
21446         }
21447         else if (PL_regkind[(U8)op] == ANYOF) {
21448             /* arglen 1 + class block */
21449             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
21450                           ? ANYOF_POSIXL_SKIP
21451                           : ANYOF_SKIP);
21452             node = NEXTOPER(node);
21453         }
21454         else if (PL_regkind[(U8)op] == EXACT) {
21455             /* Literal string, where present. */
21456             node += NODE_SZ_STR(node) - 1;
21457             node = NEXTOPER(node);
21458         }
21459         else {
21460             node = NEXTOPER(node);
21461             node += regarglen[(U8)op];
21462         }
21463         if (op == CURLYX || op == OPEN || op == SROPEN)
21464             indent++;
21465     }
21466     CLEAR_OPTSTART;
21467 #ifdef DEBUG_DUMPUNTIL
21468     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
21469 #endif
21470     return node;
21471 }
21472
21473 #endif  /* DEBUGGING */
21474
21475 /*
21476  * ex: set ts=8 sts=4 sw=4 et:
21477  */