This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Fix preprocessor directive indentation
[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]), NULL));
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], NULL));
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, NULL);
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], NULL);
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)], NULL);
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)], NULL);
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 PERL_STATIC_INLINE void
8595 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8596 {
8597     /* Sets the current number of elements stored in the inversion list.
8598      * Updates SvCUR correspondingly */
8599     PERL_UNUSED_CONTEXT;
8600     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8601
8602     assert(is_invlist(invlist));
8603
8604     SvCUR_set(invlist,
8605               (len == 0)
8606                ? 0
8607                : TO_INTERNAL_SIZE(len + offset));
8608     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8609 }
8610
8611 STATIC void
8612 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
8613 {
8614     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
8615      * steals the list from 'src', so 'src' is made to have a NULL list.  This
8616      * is similar to what SvSetMagicSV() would do, if it were implemented on
8617      * inversion lists, though this routine avoids a copy */
8618
8619     const UV src_len          = _invlist_len(src);
8620     const bool src_offset     = *get_invlist_offset_addr(src);
8621     const STRLEN src_byte_len = SvLEN(src);
8622     char * array              = SvPVX(src);
8623
8624     const int oldtainted = TAINT_get;
8625
8626     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
8627
8628     assert(is_invlist(src));
8629     assert(is_invlist(dest));
8630     assert(! invlist_is_iterating(src));
8631     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
8632
8633     /* Make sure it ends in the right place with a NUL, as our inversion list
8634      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
8635      * asserts it */
8636     array[src_byte_len - 1] = '\0';
8637
8638     TAINT_NOT;      /* Otherwise it breaks */
8639     sv_usepvn_flags(dest,
8640                     (char *) array,
8641                     src_byte_len - 1,
8642
8643                     /* This flag is documented to cause a copy to be avoided */
8644                     SV_HAS_TRAILING_NUL);
8645     TAINT_set(oldtainted);
8646     SvPV_set(src, 0);
8647     SvLEN_set(src, 0);
8648     SvCUR_set(src, 0);
8649
8650     /* Finish up copying over the other fields in an inversion list */
8651     *get_invlist_offset_addr(dest) = src_offset;
8652     invlist_set_len(dest, src_len, src_offset);
8653     *get_invlist_previous_index_addr(dest) = 0;
8654     invlist_iterfinish(dest);
8655 }
8656
8657 PERL_STATIC_INLINE IV*
8658 S_get_invlist_previous_index_addr(SV* invlist)
8659 {
8660     /* Return the address of the IV that is reserved to hold the cached index
8661      * */
8662     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8663
8664     assert(is_invlist(invlist));
8665
8666     return &(((XINVLIST*) SvANY(invlist))->prev_index);
8667 }
8668
8669 PERL_STATIC_INLINE IV
8670 S_invlist_previous_index(SV* const invlist)
8671 {
8672     /* Returns cached index of previous search */
8673
8674     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8675
8676     return *get_invlist_previous_index_addr(invlist);
8677 }
8678
8679 PERL_STATIC_INLINE void
8680 S_invlist_set_previous_index(SV* const invlist, const IV index)
8681 {
8682     /* Caches <index> for later retrieval */
8683
8684     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8685
8686     assert(index == 0 || index < (int) _invlist_len(invlist));
8687
8688     *get_invlist_previous_index_addr(invlist) = index;
8689 }
8690
8691 PERL_STATIC_INLINE void
8692 S_invlist_trim(SV* invlist)
8693 {
8694     /* Free the not currently-being-used space in an inversion list */
8695
8696     /* But don't free up the space needed for the 0 UV that is always at the
8697      * beginning of the list, nor the trailing NUL */
8698     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
8699
8700     PERL_ARGS_ASSERT_INVLIST_TRIM;
8701
8702     assert(is_invlist(invlist));
8703
8704     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
8705 }
8706
8707 PERL_STATIC_INLINE void
8708 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
8709 {
8710     PERL_ARGS_ASSERT_INVLIST_CLEAR;
8711
8712     assert(is_invlist(invlist));
8713
8714     invlist_set_len(invlist, 0, 0);
8715     invlist_trim(invlist);
8716 }
8717
8718 #endif /* ifndef PERL_IN_XSUB_RE */
8719
8720 PERL_STATIC_INLINE bool
8721 S_invlist_is_iterating(SV* const invlist)
8722 {
8723     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8724
8725     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8726 }
8727
8728 #ifndef PERL_IN_XSUB_RE
8729
8730 PERL_STATIC_INLINE UV
8731 S_invlist_max(SV* const invlist)
8732 {
8733     /* Returns the maximum number of elements storable in the inversion list's
8734      * array, without having to realloc() */
8735
8736     PERL_ARGS_ASSERT_INVLIST_MAX;
8737
8738     assert(is_invlist(invlist));
8739
8740     /* Assumes worst case, in which the 0 element is not counted in the
8741      * inversion list, so subtracts 1 for that */
8742     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8743            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8744            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8745 }
8746
8747 STATIC void
8748 S_initialize_invlist_guts(pTHX_ SV* invlist, const Size_t initial_size)
8749 {
8750     PERL_ARGS_ASSERT_INITIALIZE_INVLIST_GUTS;
8751
8752     /* First 1 is in case the zero element isn't in the list; second 1 is for
8753      * trailing NUL */
8754     SvGROW(invlist, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8755     invlist_set_len(invlist, 0, 0);
8756
8757     /* Force iterinit() to be used to get iteration to work */
8758     invlist_iterfinish(invlist);
8759
8760     *get_invlist_previous_index_addr(invlist) = 0;
8761 }
8762
8763 SV*
8764 Perl__new_invlist(pTHX_ IV initial_size)
8765 {
8766
8767     /* Return a pointer to a newly constructed inversion list, with enough
8768      * space to store 'initial_size' elements.  If that number is negative, a
8769      * system default is used instead */
8770
8771     SV* new_list;
8772
8773     if (initial_size < 0) {
8774         initial_size = 10;
8775     }
8776
8777     /* Allocate the initial space */
8778     new_list = newSV_type(SVt_INVLIST);
8779
8780     initialize_invlist_guts(new_list, initial_size);
8781
8782     return new_list;
8783 }
8784
8785 SV*
8786 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8787 {
8788     /* Return a pointer to a newly constructed inversion list, initialized to
8789      * point to <list>, which has to be in the exact correct inversion list
8790      * form, including internal fields.  Thus this is a dangerous routine that
8791      * should not be used in the wrong hands.  The passed in 'list' contains
8792      * several header fields at the beginning that are not part of the
8793      * inversion list body proper */
8794
8795     const STRLEN length = (STRLEN) list[0];
8796     const UV version_id =          list[1];
8797     const bool offset   =    cBOOL(list[2]);
8798 #define HEADER_LENGTH 3
8799     /* If any of the above changes in any way, you must change HEADER_LENGTH
8800      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8801      *      perl -E 'say int(rand 2**31-1)'
8802      */
8803 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8804                                         data structure type, so that one being
8805                                         passed in can be validated to be an
8806                                         inversion list of the correct vintage.
8807                                        */
8808
8809     SV* invlist = newSV_type(SVt_INVLIST);
8810
8811     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8812
8813     if (version_id != INVLIST_VERSION_ID) {
8814         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8815     }
8816
8817     /* The generated array passed in includes header elements that aren't part
8818      * of the list proper, so start it just after them */
8819     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8820
8821     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8822                                shouldn't touch it */
8823
8824     *(get_invlist_offset_addr(invlist)) = offset;
8825
8826     /* The 'length' passed to us is the physical number of elements in the
8827      * inversion list.  But if there is an offset the logical number is one
8828      * less than that */
8829     invlist_set_len(invlist, length  - offset, offset);
8830
8831     invlist_set_previous_index(invlist, 0);
8832
8833     /* Initialize the iteration pointer. */
8834     invlist_iterfinish(invlist);
8835
8836     SvREADONLY_on(invlist);
8837
8838     return invlist;
8839 }
8840
8841 STATIC void
8842 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8843 {
8844     /* Grow the maximum size of an inversion list */
8845
8846     PERL_ARGS_ASSERT_INVLIST_EXTEND;
8847
8848     assert(is_invlist(invlist));
8849
8850     /* Add one to account for the zero element at the beginning which may not
8851      * be counted by the calling parameters */
8852     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8853 }
8854
8855 STATIC void
8856 S__append_range_to_invlist(pTHX_ SV* const invlist,
8857                                  const UV start, const UV end)
8858 {
8859    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8860     * the end of the inversion list.  The range must be above any existing
8861     * ones. */
8862
8863     UV* array;
8864     UV max = invlist_max(invlist);
8865     UV len = _invlist_len(invlist);
8866     bool offset;
8867
8868     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8869
8870     if (len == 0) { /* Empty lists must be initialized */
8871         offset = start != 0;
8872         array = _invlist_array_init(invlist, ! offset);
8873     }
8874     else {
8875         /* Here, the existing list is non-empty. The current max entry in the
8876          * list is generally the first value not in the set, except when the
8877          * set extends to the end of permissible values, in which case it is
8878          * the first entry in that final set, and so this call is an attempt to
8879          * append out-of-order */
8880
8881         UV final_element = len - 1;
8882         array = invlist_array(invlist);
8883         if (   array[final_element] > start
8884             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8885         {
8886             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",
8887                      array[final_element], start,
8888                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8889         }
8890
8891         /* Here, it is a legal append.  If the new range begins 1 above the end
8892          * of the range below it, it is extending the range below it, so the
8893          * new first value not in the set is one greater than the newly
8894          * extended range.  */
8895         offset = *get_invlist_offset_addr(invlist);
8896         if (array[final_element] == start) {
8897             if (end != UV_MAX) {
8898                 array[final_element] = end + 1;
8899             }
8900             else {
8901                 /* But if the end is the maximum representable on the machine,
8902                  * assume that infinity was actually what was meant.  Just let
8903                  * the range that this would extend to have no end */
8904                 invlist_set_len(invlist, len - 1, offset);
8905             }
8906             return;
8907         }
8908     }
8909
8910     /* Here the new range doesn't extend any existing set.  Add it */
8911
8912     len += 2;   /* Includes an element each for the start and end of range */
8913
8914     /* If wll overflow the existing space, extend, which may cause the array to
8915      * be moved */
8916     if (max < len) {
8917         invlist_extend(invlist, len);
8918
8919         /* Have to set len here to avoid assert failure in invlist_array() */
8920         invlist_set_len(invlist, len, offset);
8921
8922         array = invlist_array(invlist);
8923     }
8924     else {
8925         invlist_set_len(invlist, len, offset);
8926     }
8927
8928     /* The next item on the list starts the range, the one after that is
8929      * one past the new range.  */
8930     array[len - 2] = start;
8931     if (end != UV_MAX) {
8932         array[len - 1] = end + 1;
8933     }
8934     else {
8935         /* But if the end is the maximum representable on the machine, just let
8936          * the range have no end */
8937         invlist_set_len(invlist, len - 1, offset);
8938     }
8939 }
8940
8941 SSize_t
8942 Perl__invlist_search(SV* const invlist, const UV cp)
8943 {
8944     /* Searches the inversion list for the entry that contains the input code
8945      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8946      * return value is the index into the list's array of the range that
8947      * contains <cp>, that is, 'i' such that
8948      *  array[i] <= cp < array[i+1]
8949      */
8950
8951     IV low = 0;
8952     IV mid;
8953     IV high = _invlist_len(invlist);
8954     const IV highest_element = high - 1;
8955     const UV* array;
8956
8957     PERL_ARGS_ASSERT__INVLIST_SEARCH;
8958
8959     /* If list is empty, return failure. */
8960     if (high == 0) {
8961         return -1;
8962     }
8963
8964     /* (We can't get the array unless we know the list is non-empty) */
8965     array = invlist_array(invlist);
8966
8967     mid = invlist_previous_index(invlist);
8968     assert(mid >=0);
8969     if (mid > highest_element) {
8970         mid = highest_element;
8971     }
8972
8973     /* <mid> contains the cache of the result of the previous call to this
8974      * function (0 the first time).  See if this call is for the same result,
8975      * or if it is for mid-1.  This is under the theory that calls to this
8976      * function will often be for related code points that are near each other.
8977      * And benchmarks show that caching gives better results.  We also test
8978      * here if the code point is within the bounds of the list.  These tests
8979      * replace others that would have had to be made anyway to make sure that
8980      * the array bounds were not exceeded, and these give us extra information
8981      * at the same time */
8982     if (cp >= array[mid]) {
8983         if (cp >= array[highest_element]) {
8984             return highest_element;
8985         }
8986
8987         /* Here, array[mid] <= cp < array[highest_element].  This means that
8988          * the final element is not the answer, so can exclude it; it also
8989          * means that <mid> is not the final element, so can refer to 'mid + 1'
8990          * safely */
8991         if (cp < array[mid + 1]) {
8992             return mid;
8993         }
8994         high--;
8995         low = mid + 1;
8996     }
8997     else { /* cp < aray[mid] */
8998         if (cp < array[0]) { /* Fail if outside the array */
8999             return -1;
9000         }
9001         high = mid;
9002         if (cp >= array[mid - 1]) {
9003             goto found_entry;
9004         }
9005     }
9006
9007     /* Binary search.  What we are looking for is <i> such that
9008      *  array[i] <= cp < array[i+1]
9009      * The loop below converges on the i+1.  Note that there may not be an
9010      * (i+1)th element in the array, and things work nonetheless */
9011     while (low < high) {
9012         mid = (low + high) / 2;
9013         assert(mid <= highest_element);
9014         if (array[mid] <= cp) { /* cp >= array[mid] */
9015             low = mid + 1;
9016
9017             /* We could do this extra test to exit the loop early.
9018             if (cp < array[low]) {
9019                 return mid;
9020             }
9021             */
9022         }
9023         else { /* cp < array[mid] */
9024             high = mid;
9025         }
9026     }
9027
9028   found_entry:
9029     high--;
9030     invlist_set_previous_index(invlist, high);
9031     return high;
9032 }
9033
9034 void
9035 Perl__invlist_populate_swatch(SV* const invlist,
9036                               const UV start, const UV end, U8* swatch)
9037 {
9038     /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
9039      * but is used when the swash has an inversion list.  This makes this much
9040      * faster, as it uses a binary search instead of a linear one.  This is
9041      * intimately tied to that function, and perhaps should be in utf8.c,
9042      * except it is intimately tied to inversion lists as well.  It assumes
9043      * that <swatch> is all 0's on input */
9044
9045     UV current = start;
9046     const IV len = _invlist_len(invlist);
9047     IV i;
9048     const UV * array;
9049
9050     PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
9051
9052     if (len == 0) { /* Empty inversion list */
9053         return;
9054     }
9055
9056     array = invlist_array(invlist);
9057
9058     /* Find which element it is */
9059     i = _invlist_search(invlist, start);
9060
9061     /* We populate from <start> to <end> */
9062     while (current < end) {
9063         UV upper;
9064
9065         /* The inversion list gives the results for every possible code point
9066          * after the first one in the list.  Only those ranges whose index is
9067          * even are ones that the inversion list matches.  For the odd ones,
9068          * and if the initial code point is not in the list, we have to skip
9069          * forward to the next element */
9070         if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
9071             i++;
9072             if (i >= len) { /* Finished if beyond the end of the array */
9073                 return;
9074             }
9075             current = array[i];
9076             if (current >= end) {   /* Finished if beyond the end of what we
9077                                        are populating */
9078                 if (LIKELY(end < UV_MAX)) {
9079                     return;
9080                 }
9081
9082                 /* We get here when the upper bound is the maximum
9083                  * representable on the machine, and we are looking for just
9084                  * that code point.  Have to special case it */
9085                 i = len;
9086                 goto join_end_of_list;
9087             }
9088         }
9089         assert(current >= start);
9090
9091         /* The current range ends one below the next one, except don't go past
9092          * <end> */
9093         i++;
9094         upper = (i < len && array[i] < end) ? array[i] : end;
9095
9096         /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
9097          * for each code point in it */
9098         for (; current < upper; current++) {
9099             const STRLEN offset = (STRLEN)(current - start);
9100             swatch[offset >> 3] |= 1 << (offset & 7);
9101         }
9102
9103       join_end_of_list:
9104
9105         /* Quit if at the end of the list */
9106         if (i >= len) {
9107
9108             /* But first, have to deal with the highest possible code point on
9109              * the platform.  The previous code assumes that <end> is one
9110              * beyond where we want to populate, but that is impossible at the
9111              * platform's infinity, so have to handle it specially */
9112             if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
9113             {
9114                 const STRLEN offset = (STRLEN)(end - start);
9115                 swatch[offset >> 3] |= 1 << (offset & 7);
9116             }
9117             return;
9118         }
9119
9120         /* Advance to the next range, which will be for code points not in the
9121          * inversion list */
9122         current = array[i];
9123     }
9124
9125     return;
9126 }
9127
9128 void
9129 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9130                                          const bool complement_b, SV** output)
9131 {
9132     /* Take the union of two inversion lists and point '*output' to it.  On
9133      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9134      * even 'a' or 'b').  If to an inversion list, the contents of the original
9135      * list will be replaced by the union.  The first list, 'a', may be
9136      * NULL, in which case a copy of the second list is placed in '*output'.
9137      * If 'complement_b' is TRUE, the union is taken of the complement
9138      * (inversion) of 'b' instead of b itself.
9139      *
9140      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9141      * Richard Gillam, published by Addison-Wesley, and explained at some
9142      * length there.  The preface says to incorporate its examples into your
9143      * code at your own risk.
9144      *
9145      * The algorithm is like a merge sort. */
9146
9147     const UV* array_a;    /* a's array */
9148     const UV* array_b;
9149     UV len_a;       /* length of a's array */
9150     UV len_b;
9151
9152     SV* u;                      /* the resulting union */
9153     UV* array_u;
9154     UV len_u = 0;
9155
9156     UV i_a = 0;             /* current index into a's array */
9157     UV i_b = 0;
9158     UV i_u = 0;
9159
9160     /* running count, as explained in the algorithm source book; items are
9161      * stopped accumulating and are output when the count changes to/from 0.
9162      * The count is incremented when we start a range that's in an input's set,
9163      * and decremented when we start a range that's not in a set.  So this
9164      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9165      * and hence nothing goes into the union; 1, just one of the inputs is in
9166      * its set (and its current range gets added to the union); and 2 when both
9167      * inputs are in their sets.  */
9168     UV count = 0;
9169
9170     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9171     assert(a != b);
9172     assert(*output == NULL || is_invlist(*output));
9173
9174     len_b = _invlist_len(b);
9175     if (len_b == 0) {
9176
9177         /* Here, 'b' is empty, hence it's complement is all possible code
9178          * points.  So if the union includes the complement of 'b', it includes
9179          * everything, and we need not even look at 'a'.  It's easiest to
9180          * create a new inversion list that matches everything.  */
9181         if (complement_b) {
9182             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9183
9184             if (*output == NULL) { /* If the output didn't exist, just point it
9185                                       at the new list */
9186                 *output = everything;
9187             }
9188             else { /* Otherwise, replace its contents with the new list */
9189                 invlist_replace_list_destroys_src(*output, everything);
9190                 SvREFCNT_dec_NN(everything);
9191             }
9192
9193             return;
9194         }
9195
9196         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9197          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9198          * output will be empty */
9199
9200         if (a == NULL || _invlist_len(a) == 0) {
9201             if (*output == NULL) {
9202                 *output = _new_invlist(0);
9203             }
9204             else {
9205                 invlist_clear(*output);
9206             }
9207             return;
9208         }
9209
9210         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9211          * union.  We can just return a copy of 'a' if '*output' doesn't point
9212          * to an existing list */
9213         if (*output == NULL) {
9214             *output = invlist_clone(a, NULL);
9215             return;
9216         }
9217
9218         /* If the output is to overwrite 'a', we have a no-op, as it's
9219          * already in 'a' */
9220         if (*output == a) {
9221             return;
9222         }
9223
9224         /* Here, '*output' is to be overwritten by 'a' */
9225         u = invlist_clone(a, NULL);
9226         invlist_replace_list_destroys_src(*output, u);
9227         SvREFCNT_dec_NN(u);
9228
9229         return;
9230     }
9231
9232     /* Here 'b' is not empty.  See about 'a' */
9233
9234     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9235
9236         /* Here, 'a' is empty (and b is not).  That means the union will come
9237          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9238          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9239          * the clone */
9240
9241         SV ** dest = (*output == NULL) ? output : &u;
9242         *dest = invlist_clone(b, NULL);
9243         if (complement_b) {
9244             _invlist_invert(*dest);
9245         }
9246
9247         if (dest == &u) {
9248             invlist_replace_list_destroys_src(*output, u);
9249             SvREFCNT_dec_NN(u);
9250         }
9251
9252         return;
9253     }
9254
9255     /* Here both lists exist and are non-empty */
9256     array_a = invlist_array(a);
9257     array_b = invlist_array(b);
9258
9259     /* If are to take the union of 'a' with the complement of b, set it
9260      * up so are looking at b's complement. */
9261     if (complement_b) {
9262
9263         /* To complement, we invert: if the first element is 0, remove it.  To
9264          * do this, we just pretend the array starts one later */
9265         if (array_b[0] == 0) {
9266             array_b++;
9267             len_b--;
9268         }
9269         else {
9270
9271             /* But if the first element is not zero, we pretend the list starts
9272              * at the 0 that is always stored immediately before the array. */
9273             array_b--;
9274             len_b++;
9275         }
9276     }
9277
9278     /* Size the union for the worst case: that the sets are completely
9279      * disjoint */
9280     u = _new_invlist(len_a + len_b);
9281
9282     /* Will contain U+0000 if either component does */
9283     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9284                                       || (len_b > 0 && array_b[0] == 0));
9285
9286     /* Go through each input list item by item, stopping when have exhausted
9287      * one of them */
9288     while (i_a < len_a && i_b < len_b) {
9289         UV cp;      /* The element to potentially add to the union's array */
9290         bool cp_in_set;   /* is it in the the input list's set or not */
9291
9292         /* We need to take one or the other of the two inputs for the union.
9293          * Since we are merging two sorted lists, we take the smaller of the
9294          * next items.  In case of a tie, we take first the one that is in its
9295          * set.  If we first took the one not in its set, it would decrement
9296          * the count, possibly to 0 which would cause it to be output as ending
9297          * the range, and the next time through we would take the same number,
9298          * and output it again as beginning the next range.  By doing it the
9299          * opposite way, there is no possibility that the count will be
9300          * momentarily decremented to 0, and thus the two adjoining ranges will
9301          * be seamlessly merged.  (In a tie and both are in the set or both not
9302          * in the set, it doesn't matter which we take first.) */
9303         if (       array_a[i_a] < array_b[i_b]
9304             || (   array_a[i_a] == array_b[i_b]
9305                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9306         {
9307             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9308             cp = array_a[i_a++];
9309         }
9310         else {
9311             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9312             cp = array_b[i_b++];
9313         }
9314
9315         /* Here, have chosen which of the two inputs to look at.  Only output
9316          * if the running count changes to/from 0, which marks the
9317          * beginning/end of a range that's in the set */
9318         if (cp_in_set) {
9319             if (count == 0) {
9320                 array_u[i_u++] = cp;
9321             }
9322             count++;
9323         }
9324         else {
9325             count--;
9326             if (count == 0) {
9327                 array_u[i_u++] = cp;
9328             }
9329         }
9330     }
9331
9332
9333     /* The loop above increments the index into exactly one of the input lists
9334      * each iteration, and ends when either index gets to its list end.  That
9335      * means the other index is lower than its end, and so something is
9336      * remaining in that one.  We decrement 'count', as explained below, if
9337      * that list is in its set.  (i_a and i_b each currently index the element
9338      * beyond the one we care about.) */
9339     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9340         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9341     {
9342         count--;
9343     }
9344
9345     /* Above we decremented 'count' if the list that had unexamined elements in
9346      * it was in its set.  This has made it so that 'count' being non-zero
9347      * means there isn't anything left to output; and 'count' equal to 0 means
9348      * that what is left to output is precisely that which is left in the
9349      * non-exhausted input list.
9350      *
9351      * To see why, note first that the exhausted input obviously has nothing
9352      * left to add to the union.  If it was in its set at its end, that means
9353      * the set extends from here to the platform's infinity, and hence so does
9354      * the union and the non-exhausted set is irrelevant.  The exhausted set
9355      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9356      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9357      * 'count' remains at 1.  This is consistent with the decremented 'count'
9358      * != 0 meaning there's nothing left to add to the union.
9359      *
9360      * But if the exhausted input wasn't in its set, it contributed 0 to
9361      * 'count', and the rest of the union will be whatever the other input is.
9362      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9363      * otherwise it gets decremented to 0.  This is consistent with 'count'
9364      * == 0 meaning the remainder of the union is whatever is left in the
9365      * non-exhausted list. */
9366     if (count != 0) {
9367         len_u = i_u;
9368     }
9369     else {
9370         IV copy_count = len_a - i_a;
9371         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9372             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9373         }
9374         else { /* The non-exhausted input is b */
9375             copy_count = len_b - i_b;
9376             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9377         }
9378         len_u = i_u + copy_count;
9379     }
9380
9381     /* Set the result to the final length, which can change the pointer to
9382      * array_u, so re-find it.  (Note that it is unlikely that this will
9383      * change, as we are shrinking the space, not enlarging it) */
9384     if (len_u != _invlist_len(u)) {
9385         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9386         invlist_trim(u);
9387         array_u = invlist_array(u);
9388     }
9389
9390     if (*output == NULL) {  /* Simply return the new inversion list */
9391         *output = u;
9392     }
9393     else {
9394         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9395          * could instead free '*output', and then set it to 'u', but experience
9396          * has shown [perl #127392] that if the input is a mortal, we can get a
9397          * huge build-up of these during regex compilation before they get
9398          * freed. */
9399         invlist_replace_list_destroys_src(*output, u);
9400         SvREFCNT_dec_NN(u);
9401     }
9402
9403     return;
9404 }
9405
9406 void
9407 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9408                                                const bool complement_b, SV** i)
9409 {
9410     /* Take the intersection of two inversion lists and point '*i' to it.  On
9411      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9412      * even 'a' or 'b').  If to an inversion list, the contents of the original
9413      * list will be replaced by the intersection.  The first list, 'a', may be
9414      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9415      * TRUE, the result will be the intersection of 'a' and the complement (or
9416      * inversion) of 'b' instead of 'b' directly.
9417      *
9418      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9419      * Richard Gillam, published by Addison-Wesley, and explained at some
9420      * length there.  The preface says to incorporate its examples into your
9421      * code at your own risk.  In fact, it had bugs
9422      *
9423      * The algorithm is like a merge sort, and is essentially the same as the
9424      * union above
9425      */
9426
9427     const UV* array_a;          /* a's array */
9428     const UV* array_b;
9429     UV len_a;   /* length of a's array */
9430     UV len_b;
9431
9432     SV* r;                   /* the resulting intersection */
9433     UV* array_r;
9434     UV len_r = 0;
9435
9436     UV i_a = 0;             /* current index into a's array */
9437     UV i_b = 0;
9438     UV i_r = 0;
9439
9440     /* running count of how many of the two inputs are postitioned at ranges
9441      * that are in their sets.  As explained in the algorithm source book,
9442      * items are stopped accumulating and are output when the count changes
9443      * to/from 2.  The count is incremented when we start a range that's in an
9444      * input's set, and decremented when we start a range that's not in a set.
9445      * Only when it is 2 are we in the intersection. */
9446     UV count = 0;
9447
9448     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9449     assert(a != b);
9450     assert(*i == NULL || is_invlist(*i));
9451
9452     /* Special case if either one is empty */
9453     len_a = (a == NULL) ? 0 : _invlist_len(a);
9454     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9455         if (len_a != 0 && complement_b) {
9456
9457             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9458              * must be empty.  Here, also we are using 'b's complement, which
9459              * hence must be every possible code point.  Thus the intersection
9460              * is simply 'a'. */
9461
9462             if (*i == a) {  /* No-op */
9463                 return;
9464             }
9465
9466             if (*i == NULL) {
9467                 *i = invlist_clone(a, NULL);
9468                 return;
9469             }
9470
9471             r = invlist_clone(a, NULL);
9472             invlist_replace_list_destroys_src(*i, r);
9473             SvREFCNT_dec_NN(r);
9474             return;
9475         }
9476
9477         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9478          * intersection must be empty */
9479         if (*i == NULL) {
9480             *i = _new_invlist(0);
9481             return;
9482         }
9483
9484         invlist_clear(*i);
9485         return;
9486     }
9487
9488     /* Here both lists exist and are non-empty */
9489     array_a = invlist_array(a);
9490     array_b = invlist_array(b);
9491
9492     /* If are to take the intersection of 'a' with the complement of b, set it
9493      * up so are looking at b's complement. */
9494     if (complement_b) {
9495
9496         /* To complement, we invert: if the first element is 0, remove it.  To
9497          * do this, we just pretend the array starts one later */
9498         if (array_b[0] == 0) {
9499             array_b++;
9500             len_b--;
9501         }
9502         else {
9503
9504             /* But if the first element is not zero, we pretend the list starts
9505              * at the 0 that is always stored immediately before the array. */
9506             array_b--;
9507             len_b++;
9508         }
9509     }
9510
9511     /* Size the intersection for the worst case: that the intersection ends up
9512      * fragmenting everything to be completely disjoint */
9513     r= _new_invlist(len_a + len_b);
9514
9515     /* Will contain U+0000 iff both components do */
9516     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9517                                      && len_b > 0 && array_b[0] == 0);
9518
9519     /* Go through each list item by item, stopping when have exhausted one of
9520      * them */
9521     while (i_a < len_a && i_b < len_b) {
9522         UV cp;      /* The element to potentially add to the intersection's
9523                        array */
9524         bool cp_in_set; /* Is it in the input list's set or not */
9525
9526         /* We need to take one or the other of the two inputs for the
9527          * intersection.  Since we are merging two sorted lists, we take the
9528          * smaller of the next items.  In case of a tie, we take first the one
9529          * that is not in its set (a difference from the union algorithm).  If
9530          * we first took the one in its set, it would increment the count,
9531          * possibly to 2 which would cause it to be output as starting a range
9532          * in the intersection, and the next time through we would take that
9533          * same number, and output it again as ending the set.  By doing the
9534          * opposite of this, there is no possibility that the count will be
9535          * momentarily incremented to 2.  (In a tie and both are in the set or
9536          * both not in the set, it doesn't matter which we take first.) */
9537         if (       array_a[i_a] < array_b[i_b]
9538             || (   array_a[i_a] == array_b[i_b]
9539                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9540         {
9541             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9542             cp = array_a[i_a++];
9543         }
9544         else {
9545             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9546             cp= array_b[i_b++];
9547         }
9548
9549         /* Here, have chosen which of the two inputs to look at.  Only output
9550          * if the running count changes to/from 2, which marks the
9551          * beginning/end of a range that's in the intersection */
9552         if (cp_in_set) {
9553             count++;
9554             if (count == 2) {
9555                 array_r[i_r++] = cp;
9556             }
9557         }
9558         else {
9559             if (count == 2) {
9560                 array_r[i_r++] = cp;
9561             }
9562             count--;
9563         }
9564
9565     }
9566
9567     /* The loop above increments the index into exactly one of the input lists
9568      * each iteration, and ends when either index gets to its list end.  That
9569      * means the other index is lower than its end, and so something is
9570      * remaining in that one.  We increment 'count', as explained below, if the
9571      * exhausted list was in its set.  (i_a and i_b each currently index the
9572      * element beyond the one we care about.) */
9573     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9574         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9575     {
9576         count++;
9577     }
9578
9579     /* Above we incremented 'count' if the exhausted list was in its set.  This
9580      * has made it so that 'count' being below 2 means there is nothing left to
9581      * output; otheriwse what's left to add to the intersection is precisely
9582      * that which is left in the non-exhausted input list.
9583      *
9584      * To see why, note first that the exhausted input obviously has nothing
9585      * left to affect the intersection.  If it was in its set at its end, that
9586      * means the set extends from here to the platform's infinity, and hence
9587      * anything in the non-exhausted's list will be in the intersection, and
9588      * anything not in it won't be.  Hence, the rest of the intersection is
9589      * precisely what's in the non-exhausted list  The exhausted set also
9590      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9591      * it means 'count' is now at least 2.  This is consistent with the
9592      * incremented 'count' being >= 2 means to add the non-exhausted list to
9593      * the intersection.
9594      *
9595      * But if the exhausted input wasn't in its set, it contributed 0 to
9596      * 'count', and the intersection can't include anything further; the
9597      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9598      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9599      * further to add to the intersection. */
9600     if (count < 2) { /* Nothing left to put in the intersection. */
9601         len_r = i_r;
9602     }
9603     else { /* copy the non-exhausted list, unchanged. */
9604         IV copy_count = len_a - i_a;
9605         if (copy_count > 0) {   /* a is the one with stuff left */
9606             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9607         }
9608         else {  /* b is the one with stuff left */
9609             copy_count = len_b - i_b;
9610             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9611         }
9612         len_r = i_r + copy_count;
9613     }
9614
9615     /* Set the result to the final length, which can change the pointer to
9616      * array_r, so re-find it.  (Note that it is unlikely that this will
9617      * change, as we are shrinking the space, not enlarging it) */
9618     if (len_r != _invlist_len(r)) {
9619         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9620         invlist_trim(r);
9621         array_r = invlist_array(r);
9622     }
9623
9624     if (*i == NULL) { /* Simply return the calculated intersection */
9625         *i = r;
9626     }
9627     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9628               instead free '*i', and then set it to 'r', but experience has
9629               shown [perl #127392] that if the input is a mortal, we can get a
9630               huge build-up of these during regex compilation before they get
9631               freed. */
9632         if (len_r) {
9633             invlist_replace_list_destroys_src(*i, r);
9634         }
9635         else {
9636             invlist_clear(*i);
9637         }
9638         SvREFCNT_dec_NN(r);
9639     }
9640
9641     return;
9642 }
9643
9644 SV*
9645 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9646 {
9647     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9648      * set.  A pointer to the inversion list is returned.  This may actually be
9649      * a new list, in which case the passed in one has been destroyed.  The
9650      * passed-in inversion list can be NULL, in which case a new one is created
9651      * with just the one range in it.  The new list is not necessarily
9652      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9653      * result of this function.  The gain would not be large, and in many
9654      * cases, this is called multiple times on a single inversion list, so
9655      * anything freed may almost immediately be needed again.
9656      *
9657      * This used to mostly call the 'union' routine, but that is much more
9658      * heavyweight than really needed for a single range addition */
9659
9660     UV* array;              /* The array implementing the inversion list */
9661     UV len;                 /* How many elements in 'array' */
9662     SSize_t i_s;            /* index into the invlist array where 'start'
9663                                should go */
9664     SSize_t i_e = 0;        /* And the index where 'end' should go */
9665     UV cur_highest;         /* The highest code point in the inversion list
9666                                upon entry to this function */
9667
9668     /* This range becomes the whole inversion list if none already existed */
9669     if (invlist == NULL) {
9670         invlist = _new_invlist(2);
9671         _append_range_to_invlist(invlist, start, end);
9672         return invlist;
9673     }
9674
9675     /* Likewise, if the inversion list is currently empty */
9676     len = _invlist_len(invlist);
9677     if (len == 0) {
9678         _append_range_to_invlist(invlist, start, end);
9679         return invlist;
9680     }
9681
9682     /* Starting here, we have to know the internals of the list */
9683     array = invlist_array(invlist);
9684
9685     /* If the new range ends higher than the current highest ... */
9686     cur_highest = invlist_highest(invlist);
9687     if (end > cur_highest) {
9688
9689         /* If the whole range is higher, we can just append it */
9690         if (start > cur_highest) {
9691             _append_range_to_invlist(invlist, start, end);
9692             return invlist;
9693         }
9694
9695         /* Otherwise, add the portion that is higher ... */
9696         _append_range_to_invlist(invlist, cur_highest + 1, end);
9697
9698         /* ... and continue on below to handle the rest.  As a result of the
9699          * above append, we know that the index of the end of the range is the
9700          * final even numbered one of the array.  Recall that the final element
9701          * always starts a range that extends to infinity.  If that range is in
9702          * the set (meaning the set goes from here to infinity), it will be an
9703          * even index, but if it isn't in the set, it's odd, and the final
9704          * range in the set is one less, which is even. */
9705         if (end == UV_MAX) {
9706             i_e = len;
9707         }
9708         else {
9709             i_e = len - 2;
9710         }
9711     }
9712
9713     /* We have dealt with appending, now see about prepending.  If the new
9714      * range starts lower than the current lowest ... */
9715     if (start < array[0]) {
9716
9717         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
9718          * Let the union code handle it, rather than having to know the
9719          * trickiness in two code places.  */
9720         if (UNLIKELY(start == 0)) {
9721             SV* range_invlist;
9722
9723             range_invlist = _new_invlist(2);
9724             _append_range_to_invlist(range_invlist, start, end);
9725
9726             _invlist_union(invlist, range_invlist, &invlist);
9727
9728             SvREFCNT_dec_NN(range_invlist);
9729
9730             return invlist;
9731         }
9732
9733         /* If the whole new range comes before the first entry, and doesn't
9734          * extend it, we have to insert it as an additional range */
9735         if (end < array[0] - 1) {
9736             i_s = i_e = -1;
9737             goto splice_in_new_range;
9738         }
9739
9740         /* Here the new range adjoins the existing first range, extending it
9741          * downwards. */
9742         array[0] = start;
9743
9744         /* And continue on below to handle the rest.  We know that the index of
9745          * the beginning of the range is the first one of the array */
9746         i_s = 0;
9747     }
9748     else { /* Not prepending any part of the new range to the existing list.
9749             * Find where in the list it should go.  This finds i_s, such that:
9750             *     invlist[i_s] <= start < array[i_s+1]
9751             */
9752         i_s = _invlist_search(invlist, start);
9753     }
9754
9755     /* At this point, any extending before the beginning of the inversion list
9756      * and/or after the end has been done.  This has made it so that, in the
9757      * code below, each endpoint of the new range is either in a range that is
9758      * in the set, or is in a gap between two ranges that are.  This means we
9759      * don't have to worry about exceeding the array bounds.
9760      *
9761      * Find where in the list the new range ends (but we can skip this if we
9762      * have already determined what it is, or if it will be the same as i_s,
9763      * which we already have computed) */
9764     if (i_e == 0) {
9765         i_e = (start == end)
9766               ? i_s
9767               : _invlist_search(invlist, end);
9768     }
9769
9770     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
9771      * is a range that goes to infinity there is no element at invlist[i_e+1],
9772      * so only the first relation holds. */
9773
9774     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9775
9776         /* Here, the ranges on either side of the beginning of the new range
9777          * are in the set, and this range starts in the gap between them.
9778          *
9779          * The new range extends the range above it downwards if the new range
9780          * ends at or above that range's start */
9781         const bool extends_the_range_above = (   end == UV_MAX
9782                                               || end + 1 >= array[i_s+1]);
9783
9784         /* The new range extends the range below it upwards if it begins just
9785          * after where that range ends */
9786         if (start == array[i_s]) {
9787
9788             /* If the new range fills the entire gap between the other ranges,
9789              * they will get merged together.  Other ranges may also get
9790              * merged, depending on how many of them the new range spans.  In
9791              * the general case, we do the merge later, just once, after we
9792              * figure out how many to merge.  But in the case where the new
9793              * range exactly spans just this one gap (possibly extending into
9794              * the one above), we do the merge here, and an early exit.  This
9795              * is done here to avoid having to special case later. */
9796             if (i_e - i_s <= 1) {
9797
9798                 /* If i_e - i_s == 1, it means that the new range terminates
9799                  * within the range above, and hence 'extends_the_range_above'
9800                  * must be true.  (If the range above it extends to infinity,
9801                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
9802                  * will be 0, so no harm done.) */
9803                 if (extends_the_range_above) {
9804                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
9805                     invlist_set_len(invlist,
9806                                     len - 2,
9807                                     *(get_invlist_offset_addr(invlist)));
9808                     return invlist;
9809                 }
9810
9811                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
9812                  * to the same range, and below we are about to decrement i_s
9813                  * */
9814                 i_e--;
9815             }
9816
9817             /* Here, the new range is adjacent to the one below.  (It may also
9818              * span beyond the range above, but that will get resolved later.)
9819              * Extend the range below to include this one. */
9820             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
9821             i_s--;
9822             start = array[i_s];
9823         }
9824         else if (extends_the_range_above) {
9825
9826             /* Here the new range only extends the range above it, but not the
9827              * one below.  It merges with the one above.  Again, we keep i_e
9828              * and i_s in sync if they point to the same range */
9829             if (i_e == i_s) {
9830                 i_e++;
9831             }
9832             i_s++;
9833             array[i_s] = start;
9834         }
9835     }
9836
9837     /* Here, we've dealt with the new range start extending any adjoining
9838      * existing ranges.
9839      *
9840      * If the new range extends to infinity, it is now the final one,
9841      * regardless of what was there before */
9842     if (UNLIKELY(end == UV_MAX)) {
9843         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
9844         return invlist;
9845     }
9846
9847     /* If i_e started as == i_s, it has also been dealt with,
9848      * and been updated to the new i_s, which will fail the following if */
9849     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
9850
9851         /* Here, the ranges on either side of the end of the new range are in
9852          * the set, and this range ends in the gap between them.
9853          *
9854          * If this range is adjacent to (hence extends) the range above it, it
9855          * becomes part of that range; likewise if it extends the range below,
9856          * it becomes part of that range */
9857         if (end + 1 == array[i_e+1]) {
9858             i_e++;
9859             array[i_e] = start;
9860         }
9861         else if (start <= array[i_e]) {
9862             array[i_e] = end + 1;
9863             i_e--;
9864         }
9865     }
9866
9867     if (i_s == i_e) {
9868
9869         /* If the range fits entirely in an existing range (as possibly already
9870          * extended above), it doesn't add anything new */
9871         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
9872             return invlist;
9873         }
9874
9875         /* Here, no part of the range is in the list.  Must add it.  It will
9876          * occupy 2 more slots */
9877       splice_in_new_range:
9878
9879         invlist_extend(invlist, len + 2);
9880         array = invlist_array(invlist);
9881         /* Move the rest of the array down two slots. Don't include any
9882          * trailing NUL */
9883         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
9884
9885         /* Do the actual splice */
9886         array[i_e+1] = start;
9887         array[i_e+2] = end + 1;
9888         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
9889         return invlist;
9890     }
9891
9892     /* Here the new range crossed the boundaries of a pre-existing range.  The
9893      * code above has adjusted things so that both ends are in ranges that are
9894      * in the set.  This means everything in between must also be in the set.
9895      * Just squash things together */
9896     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
9897     invlist_set_len(invlist,
9898                     len - i_e + i_s,
9899                     *(get_invlist_offset_addr(invlist)));
9900
9901     return invlist;
9902 }
9903
9904 SV*
9905 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9906                                  UV** other_elements_ptr)
9907 {
9908     /* Create and return an inversion list whose contents are to be populated
9909      * by the caller.  The caller gives the number of elements (in 'size') and
9910      * the very first element ('element0').  This function will set
9911      * '*other_elements_ptr' to an array of UVs, where the remaining elements
9912      * are to be placed.
9913      *
9914      * Obviously there is some trust involved that the caller will properly
9915      * fill in the other elements of the array.
9916      *
9917      * (The first element needs to be passed in, as the underlying code does
9918      * things differently depending on whether it is zero or non-zero) */
9919
9920     SV* invlist = _new_invlist(size);
9921     bool offset;
9922
9923     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9924
9925     invlist = add_cp_to_invlist(invlist, element0);
9926     offset = *get_invlist_offset_addr(invlist);
9927
9928     invlist_set_len(invlist, size, offset);
9929     *other_elements_ptr = invlist_array(invlist) + 1;
9930     return invlist;
9931 }
9932
9933 #endif
9934
9935 PERL_STATIC_INLINE SV*
9936 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9937     return _add_range_to_invlist(invlist, cp, cp);
9938 }
9939
9940 #ifndef PERL_IN_XSUB_RE
9941 void
9942 Perl__invlist_invert(pTHX_ SV* const invlist)
9943 {
9944     /* Complement the input inversion list.  This adds a 0 if the list didn't
9945      * have a zero; removes it otherwise.  As described above, the data
9946      * structure is set up so that this is very efficient */
9947
9948     PERL_ARGS_ASSERT__INVLIST_INVERT;
9949
9950     assert(! invlist_is_iterating(invlist));
9951
9952     /* The inverse of matching nothing is matching everything */
9953     if (_invlist_len(invlist) == 0) {
9954         _append_range_to_invlist(invlist, 0, UV_MAX);
9955         return;
9956     }
9957
9958     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9959 }
9960
9961 SV*
9962 Perl_invlist_clone(pTHX_ SV* const invlist, SV* new_invlist)
9963 {
9964
9965     /* Return a new inversion list that is a copy of the input one, which is
9966      * unchanged.  The new list will not be mortal even if the old one was. */
9967
9968     const STRLEN nominal_length = _invlist_len(invlist);    /* Why not +1 XXX */
9969     const STRLEN physical_length = SvCUR(invlist);
9970     const bool offset = *(get_invlist_offset_addr(invlist));
9971
9972     PERL_ARGS_ASSERT_INVLIST_CLONE;
9973
9974     /* Need to allocate extra space to accommodate Perl's addition of a
9975      * trailing NUL to SvPV's, since it thinks they are always strings */
9976     if (new_invlist == NULL) {
9977         new_invlist = _new_invlist(nominal_length);
9978     }
9979     else {
9980         sv_upgrade(new_invlist, SVt_INVLIST);
9981         initialize_invlist_guts(new_invlist, nominal_length);
9982     }
9983
9984     *(get_invlist_offset_addr(new_invlist)) = offset;
9985     invlist_set_len(new_invlist, nominal_length, offset);
9986     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9987
9988     return new_invlist;
9989 }
9990
9991 #endif
9992
9993 PERL_STATIC_INLINE STRLEN*
9994 S_get_invlist_iter_addr(SV* invlist)
9995 {
9996     /* Return the address of the UV that contains the current iteration
9997      * position */
9998
9999     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
10000
10001     assert(is_invlist(invlist));
10002
10003     return &(((XINVLIST*) SvANY(invlist))->iterator);
10004 }
10005
10006 PERL_STATIC_INLINE void
10007 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
10008 {
10009     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
10010
10011     *get_invlist_iter_addr(invlist) = 0;
10012 }
10013
10014 PERL_STATIC_INLINE void
10015 S_invlist_iterfinish(SV* invlist)
10016 {
10017     /* Terminate iterator for invlist.  This is to catch development errors.
10018      * Any iteration that is interrupted before completed should call this
10019      * function.  Functions that add code points anywhere else but to the end
10020      * of an inversion list assert that they are not in the middle of an
10021      * iteration.  If they were, the addition would make the iteration
10022      * problematical: if the iteration hadn't reached the place where things
10023      * were being added, it would be ok */
10024
10025     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
10026
10027     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
10028 }
10029
10030 STATIC bool
10031 S_invlist_iternext(SV* invlist, UV* start, UV* end)
10032 {
10033     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
10034      * This call sets in <*start> and <*end>, the next range in <invlist>.
10035      * Returns <TRUE> if successful and the next call will return the next
10036      * range; <FALSE> if was already at the end of the list.  If the latter,
10037      * <*start> and <*end> are unchanged, and the next call to this function
10038      * will start over at the beginning of the list */
10039
10040     STRLEN* pos = get_invlist_iter_addr(invlist);
10041     UV len = _invlist_len(invlist);
10042     UV *array;
10043
10044     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
10045
10046     if (*pos >= len) {
10047         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
10048         return FALSE;
10049     }
10050
10051     array = invlist_array(invlist);
10052
10053     *start = array[(*pos)++];
10054
10055     if (*pos >= len) {
10056         *end = UV_MAX;
10057     }
10058     else {
10059         *end = array[(*pos)++] - 1;
10060     }
10061
10062     return TRUE;
10063 }
10064
10065 PERL_STATIC_INLINE UV
10066 S_invlist_highest(SV* const invlist)
10067 {
10068     /* Returns the highest code point that matches an inversion list.  This API
10069      * has an ambiguity, as it returns 0 under either the highest is actually
10070      * 0, or if the list is empty.  If this distinction matters to you, check
10071      * for emptiness before calling this function */
10072
10073     UV len = _invlist_len(invlist);
10074     UV *array;
10075
10076     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
10077
10078     if (len == 0) {
10079         return 0;
10080     }
10081
10082     array = invlist_array(invlist);
10083
10084     /* The last element in the array in the inversion list always starts a
10085      * range that goes to infinity.  That range may be for code points that are
10086      * matched in the inversion list, or it may be for ones that aren't
10087      * matched.  In the latter case, the highest code point in the set is one
10088      * less than the beginning of this range; otherwise it is the final element
10089      * of this range: infinity */
10090     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10091            ? UV_MAX
10092            : array[len - 1] - 1;
10093 }
10094
10095 STATIC SV *
10096 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10097 {
10098     /* Get the contents of an inversion list into a string SV so that they can
10099      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10100      * traditionally done for debug tracing; otherwise it uses a format
10101      * suitable for just copying to the output, with blanks between ranges and
10102      * a dash between range components */
10103
10104     UV start, end;
10105     SV* output;
10106     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10107     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10108
10109     if (traditional_style) {
10110         output = newSVpvs("\n");
10111     }
10112     else {
10113         output = newSVpvs("");
10114     }
10115
10116     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10117
10118     assert(! invlist_is_iterating(invlist));
10119
10120     invlist_iterinit(invlist);
10121     while (invlist_iternext(invlist, &start, &end)) {
10122         if (end == UV_MAX) {
10123             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFINITY%c",
10124                                           start, intra_range_delimiter,
10125                                                  inter_range_delimiter);
10126         }
10127         else if (end != start) {
10128             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10129                                           start,
10130                                                    intra_range_delimiter,
10131                                                   end, inter_range_delimiter);
10132         }
10133         else {
10134             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10135                                           start, inter_range_delimiter);
10136         }
10137     }
10138
10139     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10140         SvCUR_set(output, SvCUR(output) - 1);
10141     }
10142
10143     return output;
10144 }
10145
10146 #ifndef PERL_IN_XSUB_RE
10147 void
10148 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10149                          const char * const indent, SV* const invlist)
10150 {
10151     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10152      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10153      * the string 'indent'.  The output looks like this:
10154          [0] 0x000A .. 0x000D
10155          [2] 0x0085
10156          [4] 0x2028 .. 0x2029
10157          [6] 0x3104 .. INFINITY
10158      * This means that the first range of code points matched by the list are
10159      * 0xA through 0xD; the second range contains only the single code point
10160      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10161      * are used to define each range (except if the final range extends to
10162      * infinity, only a single element is needed).  The array index of the
10163      * first element for the corresponding range is given in brackets. */
10164
10165     UV start, end;
10166     STRLEN count = 0;
10167
10168     PERL_ARGS_ASSERT__INVLIST_DUMP;
10169
10170     if (invlist_is_iterating(invlist)) {
10171         Perl_dump_indent(aTHX_ level, file,
10172              "%sCan't dump inversion list because is in middle of iterating\n",
10173              indent);
10174         return;
10175     }
10176
10177     invlist_iterinit(invlist);
10178     while (invlist_iternext(invlist, &start, &end)) {
10179         if (end == UV_MAX) {
10180             Perl_dump_indent(aTHX_ level, file,
10181                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFINITY\n",
10182                                    indent, (UV)count, start);
10183         }
10184         else if (end != start) {
10185             Perl_dump_indent(aTHX_ level, file,
10186                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10187                                 indent, (UV)count, start,         end);
10188         }
10189         else {
10190             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10191                                             indent, (UV)count, start);
10192         }
10193         count += 2;
10194     }
10195 }
10196
10197 #endif
10198
10199 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10200 bool
10201 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10202 {
10203     /* Return a boolean as to if the two passed in inversion lists are
10204      * identical.  The final argument, if TRUE, says to take the complement of
10205      * the second inversion list before doing the comparison */
10206
10207     const UV* array_a = invlist_array(a);
10208     const UV* array_b = invlist_array(b);
10209     UV len_a = _invlist_len(a);
10210     UV len_b = _invlist_len(b);
10211
10212     PERL_ARGS_ASSERT__INVLISTEQ;
10213
10214     /* If are to compare 'a' with the complement of b, set it
10215      * up so are looking at b's complement. */
10216     if (complement_b) {
10217
10218         /* The complement of nothing is everything, so <a> would have to have
10219          * just one element, starting at zero (ending at infinity) */
10220         if (len_b == 0) {
10221             return (len_a == 1 && array_a[0] == 0);
10222         }
10223         else if (array_b[0] == 0) {
10224
10225             /* Otherwise, to complement, we invert.  Here, the first element is
10226              * 0, just remove it.  To do this, we just pretend the array starts
10227              * one later */
10228
10229             array_b++;
10230             len_b--;
10231         }
10232         else {
10233
10234             /* But if the first element is not zero, we pretend the list starts
10235              * at the 0 that is always stored immediately before the array. */
10236             array_b--;
10237             len_b++;
10238         }
10239     }
10240
10241     return    len_a == len_b
10242            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10243
10244 }
10245 #endif
10246
10247 /*
10248  * As best we can, determine the characters that can match the start of
10249  * the given EXACTF-ish node.
10250  *
10251  * Returns the invlist as a new SV*; it is the caller's responsibility to
10252  * call SvREFCNT_dec() when done with it.
10253  */
10254 STATIC SV*
10255 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10256 {
10257     const U8 * s = (U8*)STRING(node);
10258     SSize_t bytelen = STR_LEN(node);
10259     UV uc;
10260     /* Start out big enough for 2 separate code points */
10261     SV* invlist = _new_invlist(4);
10262
10263     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10264
10265     if (! UTF) {
10266         uc = *s;
10267
10268         /* We punt and assume can match anything if the node begins
10269          * with a multi-character fold.  Things are complicated.  For
10270          * example, /ffi/i could match any of:
10271          *  "\N{LATIN SMALL LIGATURE FFI}"
10272          *  "\N{LATIN SMALL LIGATURE FF}I"
10273          *  "F\N{LATIN SMALL LIGATURE FI}"
10274          *  plus several other things; and making sure we have all the
10275          *  possibilities is hard. */
10276         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10277             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10278         }
10279         else {
10280             /* Any Latin1 range character can potentially match any
10281              * other depending on the locale */
10282             if (OP(node) == EXACTFL) {
10283                 _invlist_union(invlist, PL_Latin1, &invlist);
10284             }
10285             else {
10286                 /* But otherwise, it matches at least itself.  We can
10287                  * quickly tell if it has a distinct fold, and if so,
10288                  * it matches that as well */
10289                 invlist = add_cp_to_invlist(invlist, uc);
10290                 if (IS_IN_SOME_FOLD_L1(uc))
10291                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10292             }
10293
10294             /* Some characters match above-Latin1 ones under /i.  This
10295              * is true of EXACTFL ones when the locale is UTF-8 */
10296             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10297                 && (! isASCII(uc) || (OP(node) != EXACTFAA
10298                                     && OP(node) != EXACTFAA_NO_TRIE)))
10299             {
10300                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10301             }
10302         }
10303     }
10304     else {  /* Pattern is UTF-8 */
10305         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10306         const U8* e = s + bytelen;
10307         IV fc;
10308
10309         fc = uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10310
10311         /* The only code points that aren't folded in a UTF EXACTFish
10312          * node are are the problematic ones in EXACTFL nodes */
10313         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10314             /* We need to check for the possibility that this EXACTFL
10315              * node begins with a multi-char fold.  Therefore we fold
10316              * the first few characters of it so that we can make that
10317              * check */
10318             U8 *d = folded;
10319             int i;
10320
10321             fc = -1;
10322             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10323                 if (isASCII(*s)) {
10324                     *(d++) = (U8) toFOLD(*s);
10325                     if (fc < 0) {       /* Save the first fold */
10326                         fc = *(d-1);
10327                     }
10328                     s++;
10329                 }
10330                 else {
10331                     STRLEN len;
10332                     UV fold = toFOLD_utf8_safe(s, e, d, &len);
10333                     if (fc < 0) {       /* Save the first fold */
10334                         fc = fold;
10335                     }
10336                     d += len;
10337                     s += UTF8SKIP(s);
10338                 }
10339             }
10340
10341             /* And set up so the code below that looks in this folded
10342              * buffer instead of the node's string */
10343             e = d;
10344             s = folded;
10345         }
10346
10347         /* When we reach here 's' points to the fold of the first
10348          * character(s) of the node; and 'e' points to far enough along
10349          * the folded string to be just past any possible multi-char
10350          * fold.
10351          *
10352          * Unlike the non-UTF-8 case, the macro for determining if a
10353          * string is a multi-char fold requires all the characters to
10354          * already be folded.  This is because of all the complications
10355          * if not.  Note that they are folded anyway, except in EXACTFL
10356          * nodes.  Like the non-UTF case above, we punt if the node
10357          * begins with a multi-char fold  */
10358
10359         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10360             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10361         }
10362         else {  /* Single char fold */
10363             unsigned int k;
10364             unsigned int first_folds_to;
10365             const unsigned int * remaining_folds_to_list;
10366             Size_t folds_to_count;
10367
10368             /* It matches itself */
10369             invlist = add_cp_to_invlist(invlist, fc);
10370
10371             /* ... plus all the things that fold to it, which are found in
10372              * PL_utf8_foldclosures */
10373             folds_to_count = _inverse_folds(fc, &first_folds_to,
10374                                                 &remaining_folds_to_list);
10375             for (k = 0; k < folds_to_count; k++) {
10376                 UV c = (k == 0) ? first_folds_to : remaining_folds_to_list[k-1];
10377
10378                 /* /aa doesn't allow folds between ASCII and non- */
10379                 if (   (OP(node) == EXACTFAA || OP(node) == EXACTFAA_NO_TRIE)
10380                     && isASCII(c) != isASCII(fc))
10381                 {
10382                     continue;
10383                 }
10384
10385                 invlist = add_cp_to_invlist(invlist, c);
10386             }
10387         }
10388     }
10389
10390     return invlist;
10391 }
10392
10393 #undef HEADER_LENGTH
10394 #undef TO_INTERNAL_SIZE
10395 #undef FROM_INTERNAL_SIZE
10396 #undef INVLIST_VERSION_ID
10397
10398 /* End of inversion list object */
10399
10400 STATIC void
10401 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10402 {
10403     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10404      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10405      * should point to the first flag; it is updated on output to point to the
10406      * final ')' or ':'.  There needs to be at least one flag, or this will
10407      * abort */
10408
10409     /* for (?g), (?gc), and (?o) warnings; warning
10410        about (?c) will warn about (?g) -- japhy    */
10411
10412 #define WASTED_O  0x01
10413 #define WASTED_G  0x02
10414 #define WASTED_C  0x04
10415 #define WASTED_GC (WASTED_G|WASTED_C)
10416     I32 wastedflags = 0x00;
10417     U32 posflags = 0, negflags = 0;
10418     U32 *flagsp = &posflags;
10419     char has_charset_modifier = '\0';
10420     regex_charset cs;
10421     bool has_use_defaults = FALSE;
10422     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10423     int x_mod_count = 0;
10424
10425     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10426
10427     /* '^' as an initial flag sets certain defaults */
10428     if (UCHARAT(RExC_parse) == '^') {
10429         RExC_parse++;
10430         has_use_defaults = TRUE;
10431         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10432         set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
10433                                         ? REGEX_UNICODE_CHARSET
10434                                         : REGEX_DEPENDS_CHARSET);
10435     }
10436
10437     cs = get_regex_charset(RExC_flags);
10438     if (cs == REGEX_DEPENDS_CHARSET
10439         && (RExC_utf8 || RExC_uni_semantics))
10440     {
10441         cs = REGEX_UNICODE_CHARSET;
10442     }
10443
10444     while (RExC_parse < RExC_end) {
10445         /* && strchr("iogcmsx", *RExC_parse) */
10446         /* (?g), (?gc) and (?o) are useless here
10447            and must be globally applied -- japhy */
10448         switch (*RExC_parse) {
10449
10450             /* Code for the imsxn flags */
10451             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10452
10453             case LOCALE_PAT_MOD:
10454                 if (has_charset_modifier) {
10455                     goto excess_modifier;
10456                 }
10457                 else if (flagsp == &negflags) {
10458                     goto neg_modifier;
10459                 }
10460                 cs = REGEX_LOCALE_CHARSET;
10461                 has_charset_modifier = LOCALE_PAT_MOD;
10462                 break;
10463             case UNICODE_PAT_MOD:
10464                 if (has_charset_modifier) {
10465                     goto excess_modifier;
10466                 }
10467                 else if (flagsp == &negflags) {
10468                     goto neg_modifier;
10469                 }
10470                 cs = REGEX_UNICODE_CHARSET;
10471                 has_charset_modifier = UNICODE_PAT_MOD;
10472                 break;
10473             case ASCII_RESTRICT_PAT_MOD:
10474                 if (flagsp == &negflags) {
10475                     goto neg_modifier;
10476                 }
10477                 if (has_charset_modifier) {
10478                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10479                         goto excess_modifier;
10480                     }
10481                     /* Doubled modifier implies more restricted */
10482                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10483                 }
10484                 else {
10485                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10486                 }
10487                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10488                 break;
10489             case DEPENDS_PAT_MOD:
10490                 if (has_use_defaults) {
10491                     goto fail_modifiers;
10492                 }
10493                 else if (flagsp == &negflags) {
10494                     goto neg_modifier;
10495                 }
10496                 else if (has_charset_modifier) {
10497                     goto excess_modifier;
10498                 }
10499
10500                 /* The dual charset means unicode semantics if the
10501                  * pattern (or target, not known until runtime) are
10502                  * utf8, or something in the pattern indicates unicode
10503                  * semantics */
10504                 cs = (RExC_utf8 || RExC_uni_semantics)
10505                      ? REGEX_UNICODE_CHARSET
10506                      : REGEX_DEPENDS_CHARSET;
10507                 has_charset_modifier = DEPENDS_PAT_MOD;
10508                 break;
10509               excess_modifier:
10510                 RExC_parse++;
10511                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10512                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10513                 }
10514                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10515                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10516                                         *(RExC_parse - 1));
10517                 }
10518                 else {
10519                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10520                 }
10521                 NOT_REACHED; /*NOTREACHED*/
10522               neg_modifier:
10523                 RExC_parse++;
10524                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10525                                     *(RExC_parse - 1));
10526                 NOT_REACHED; /*NOTREACHED*/
10527             case ONCE_PAT_MOD: /* 'o' */
10528             case GLOBAL_PAT_MOD: /* 'g' */
10529                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10530                     const I32 wflagbit = *RExC_parse == 'o'
10531                                          ? WASTED_O
10532                                          : WASTED_G;
10533                     if (! (wastedflags & wflagbit) ) {
10534                         wastedflags |= wflagbit;
10535                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10536                         vWARN5(
10537                             RExC_parse + 1,
10538                             "Useless (%s%c) - %suse /%c modifier",
10539                             flagsp == &negflags ? "?-" : "?",
10540                             *RExC_parse,
10541                             flagsp == &negflags ? "don't " : "",
10542                             *RExC_parse
10543                         );
10544                     }
10545                 }
10546                 break;
10547
10548             case CONTINUE_PAT_MOD: /* 'c' */
10549                 if (PASS2 && ckWARN(WARN_REGEXP)) {
10550                     if (! (wastedflags & WASTED_C) ) {
10551                         wastedflags |= WASTED_GC;
10552                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10553                         vWARN3(
10554                             RExC_parse + 1,
10555                             "Useless (%sc) - %suse /gc modifier",
10556                             flagsp == &negflags ? "?-" : "?",
10557                             flagsp == &negflags ? "don't " : ""
10558                         );
10559                     }
10560                 }
10561                 break;
10562             case KEEPCOPY_PAT_MOD: /* 'p' */
10563                 if (flagsp == &negflags) {
10564                     if (PASS2)
10565                         ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10566                 } else {
10567                     *flagsp |= RXf_PMf_KEEPCOPY;
10568                 }
10569                 break;
10570             case '-':
10571                 /* A flag is a default iff it is following a minus, so
10572                  * if there is a minus, it means will be trying to
10573                  * re-specify a default which is an error */
10574                 if (has_use_defaults || flagsp == &negflags) {
10575                     goto fail_modifiers;
10576                 }
10577                 flagsp = &negflags;
10578                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10579                 x_mod_count = 0;
10580                 break;
10581             case ':':
10582             case ')':
10583
10584                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10585                     negflags |= RXf_PMf_EXTENDED_MORE;
10586                 }
10587                 RExC_flags |= posflags;
10588
10589                 if (negflags & RXf_PMf_EXTENDED) {
10590                     negflags |= RXf_PMf_EXTENDED_MORE;
10591                 }
10592                 RExC_flags &= ~negflags;
10593                 set_regex_charset(&RExC_flags, cs);
10594
10595                 return;
10596             default:
10597               fail_modifiers:
10598                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
10599                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10600                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10601                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10602                 NOT_REACHED; /*NOTREACHED*/
10603         }
10604
10605         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10606     }
10607
10608     vFAIL("Sequence (?... not terminated");
10609 }
10610
10611 /*
10612  - reg - regular expression, i.e. main body or parenthesized thing
10613  *
10614  * Caller must absorb opening parenthesis.
10615  *
10616  * Combining parenthesis handling with the base level of regular expression
10617  * is a trifle forced, but the need to tie the tails of the branches to what
10618  * follows makes it hard to avoid.
10619  */
10620 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
10621 #ifdef DEBUGGING
10622 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
10623 #else
10624 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
10625 #endif
10626
10627 PERL_STATIC_INLINE regnode *
10628 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
10629                              I32 *flagp,
10630                              char * parse_start,
10631                              char ch
10632                       )
10633 {
10634     regnode *ret;
10635     char* name_start = RExC_parse;
10636     U32 num = 0;
10637     SV *sv_dat = reg_scan_name(pRExC_state, SIZE_ONLY
10638                                             ? REG_RSN_RETURN_NULL
10639                                             : REG_RSN_RETURN_DATA);
10640     GET_RE_DEBUG_FLAGS_DECL;
10641
10642     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
10643
10644     if (RExC_parse == name_start || *RExC_parse != ch) {
10645         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
10646         vFAIL2("Sequence %.3s... not terminated",parse_start);
10647     }
10648
10649     if (!SIZE_ONLY) {
10650         num = add_data( pRExC_state, STR_WITH_LEN("S"));
10651         RExC_rxi->data->data[num]=(void*)sv_dat;
10652         SvREFCNT_inc_simple_void(sv_dat);
10653     }
10654     RExC_sawback = 1;
10655     ret = reganode(pRExC_state,
10656                    ((! FOLD)
10657                      ? NREF
10658                      : (ASCII_FOLD_RESTRICTED)
10659                        ? NREFFA
10660                        : (AT_LEAST_UNI_SEMANTICS)
10661                          ? NREFFU
10662                          : (LOC)
10663                            ? NREFFL
10664                            : NREFF),
10665                     num);
10666     *flagp |= HASWIDTH;
10667
10668     Set_Node_Offset(ret, parse_start+1);
10669     Set_Node_Cur_Length(ret, parse_start);
10670
10671     nextchar(pRExC_state);
10672     return ret;
10673 }
10674
10675 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
10676    flags. Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan
10677    needs to be restarted, or'd with NEED_UTF8 if the pattern needs to be
10678    upgraded to UTF-8.  Otherwise would only return NULL if regbranch() returns
10679    NULL, which cannot happen.  */
10680 STATIC regnode *
10681 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
10682     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
10683      * 2 is like 1, but indicates that nextchar() has been called to advance
10684      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
10685      * this flag alerts us to the need to check for that */
10686 {
10687     regnode *ret = NULL;    /* Will be the head of the group. */
10688     regnode *br;
10689     regnode *lastbr;
10690     regnode *ender = NULL;
10691     I32 parno = 0;
10692     I32 flags;
10693     U32 oregflags = RExC_flags;
10694     bool have_branch = 0;
10695     bool is_open = 0;
10696     I32 freeze_paren = 0;
10697     I32 after_freeze = 0;
10698     I32 num; /* numeric backreferences */
10699
10700     char * parse_start = RExC_parse; /* MJD */
10701     char * const oregcomp_parse = RExC_parse;
10702
10703     GET_RE_DEBUG_FLAGS_DECL;
10704
10705     PERL_ARGS_ASSERT_REG;
10706     DEBUG_PARSE("reg ");
10707
10708     *flagp = 0;                         /* Tentatively. */
10709
10710     /* Having this true makes it feasible to have a lot fewer tests for the
10711      * parse pointer being in scope.  For example, we can write
10712      *      while(isFOO(*RExC_parse)) RExC_parse++;
10713      * instead of
10714      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
10715      */
10716     assert(*RExC_end == '\0');
10717
10718     /* Make an OPEN node, if parenthesized. */
10719     if (paren) {
10720
10721         /* Under /x, space and comments can be gobbled up between the '(' and
10722          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
10723          * intervening space, as the sequence is a token, and a token should be
10724          * indivisible */
10725         bool has_intervening_patws = (paren == 2)
10726                                   && *(RExC_parse - 1) != '(';
10727
10728         if (RExC_parse >= RExC_end) {
10729             vFAIL("Unmatched (");
10730         }
10731
10732         if (paren == 'r') {     /* Atomic script run */
10733             paren = '>';
10734             goto parse_rest;
10735         }
10736         else if ( *RExC_parse == '*') { /* (*VERB:ARG), (*construct:...) */
10737             char *start_verb = RExC_parse + 1;
10738             STRLEN verb_len;
10739             char *start_arg = NULL;
10740             unsigned char op = 0;
10741             int arg_required = 0;
10742             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
10743             bool has_upper = FALSE;
10744
10745             if (has_intervening_patws) {
10746                 RExC_parse++;   /* past the '*' */
10747
10748                 /* For strict backwards compatibility, don't change the message
10749                  * now that we also have lowercase operands */
10750                 if (isUPPER(*RExC_parse)) {
10751                     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
10752                 }
10753                 else {
10754                     vFAIL("In '(*...)', the '(' and '*' must be adjacent");
10755                 }
10756             }
10757             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
10758                 if ( *RExC_parse == ':' ) {
10759                     start_arg = RExC_parse + 1;
10760                     break;
10761                 }
10762                 else if (! UTF) {
10763                     if (isUPPER(*RExC_parse)) {
10764                         has_upper = TRUE;
10765                     }
10766                     RExC_parse++;
10767                 }
10768                 else {
10769                     RExC_parse += UTF8SKIP(RExC_parse);
10770                 }
10771             }
10772             verb_len = RExC_parse - start_verb;
10773             if ( start_arg ) {
10774                 if (RExC_parse >= RExC_end) {
10775                     goto unterminated_verb_pattern;
10776                 }
10777
10778                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10779                 while ( RExC_parse < RExC_end && *RExC_parse != ')' ) {
10780                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10781                 }
10782                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
10783                   unterminated_verb_pattern:
10784                     if (has_upper) {
10785                         vFAIL("Unterminated verb pattern argument");
10786                     }
10787                     else {
10788                         vFAIL("Unterminated '(*...' argument");
10789                     }
10790                 }
10791             } else {
10792                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
10793                     if (has_upper) {
10794                         vFAIL("Unterminated verb pattern");
10795                     }
10796                     else {
10797                         vFAIL("Unterminated '(*...' construct");
10798                     }
10799                 }
10800             }
10801
10802             /* Here, we know that RExC_parse < RExC_end */
10803
10804             switch ( *start_verb ) {
10805             case 'A':  /* (*ACCEPT) */
10806                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
10807                     op = ACCEPT;
10808                     internal_argval = RExC_nestroot;
10809                 }
10810                 break;
10811             case 'C':  /* (*COMMIT) */
10812                 if ( memEQs(start_verb,verb_len,"COMMIT") )
10813                     op = COMMIT;
10814                 break;
10815             case 'F':  /* (*FAIL) */
10816                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
10817                     op = OPFAIL;
10818                 }
10819                 break;
10820             case ':':  /* (*:NAME) */
10821             case 'M':  /* (*MARK:NAME) */
10822                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
10823                     op = MARKPOINT;
10824                     arg_required = 1;
10825                 }
10826                 break;
10827             case 'P':  /* (*PRUNE) */
10828                 if ( memEQs(start_verb,verb_len,"PRUNE") )
10829                     op = PRUNE;
10830                 break;
10831             case 'S':   /* (*SKIP) */
10832                 if ( memEQs(start_verb,verb_len,"SKIP") )
10833                     op = SKIP;
10834                 break;
10835             case 'T':  /* (*THEN) */
10836                 /* [19:06] <TimToady> :: is then */
10837                 if ( memEQs(start_verb,verb_len,"THEN") ) {
10838                     op = CUTGROUP;
10839                     RExC_seen |= REG_CUTGROUP_SEEN;
10840                 }
10841                 break;
10842             case 'a':
10843                 if (   memEQs(start_verb, verb_len, "asr")
10844                     || memEQs(start_verb, verb_len, "atomic_script_run"))
10845                 {
10846                     paren = 'r';        /* Mnemonic: recursed run */
10847                     goto script_run;
10848                 }
10849                 else if (memEQs(start_verb, verb_len, "atomic")) {
10850                     paren = 't';    /* AtOMIC */
10851                     goto alpha_assertions;
10852                 }
10853                 break;
10854             case 'p':
10855                 if (   memEQs(start_verb, verb_len, "plb")
10856                     || memEQs(start_verb, verb_len, "positive_lookbehind"))
10857                 {
10858                     paren = 'b';
10859                     goto lookbehind_alpha_assertions;
10860                 }
10861                 else if (   memEQs(start_verb, verb_len, "pla")
10862                          || memEQs(start_verb, verb_len, "positive_lookahead"))
10863                 {
10864                     paren = 'a';
10865                     goto alpha_assertions;
10866                 }
10867                 break;
10868             case 'n':
10869                 if (   memEQs(start_verb, verb_len, "nlb")
10870                     || memEQs(start_verb, verb_len, "negative_lookbehind"))
10871                 {
10872                     paren = 'B';
10873                     goto lookbehind_alpha_assertions;
10874                 }
10875                 else if (   memEQs(start_verb, verb_len, "nla")
10876                          || memEQs(start_verb, verb_len, "negative_lookahead"))
10877                 {
10878                     paren = 'A';
10879                     goto alpha_assertions;
10880                 }
10881                 break;
10882             case 's':
10883                 if (   memEQs(start_verb, verb_len, "sr")
10884                     || memEQs(start_verb, verb_len, "script_run"))
10885                 {
10886                     regnode * atomic;
10887
10888                     paren = 's';
10889
10890                    script_run:
10891
10892                     /* This indicates Unicode rules. */
10893                     REQUIRE_UNI_RULES(flagp, NULL);
10894
10895                     if (! start_arg) {
10896                         goto no_colon;
10897                     }
10898
10899                     RExC_parse = start_arg;
10900
10901                     if (RExC_in_script_run) {
10902
10903                         /*  Nested script runs are treated as no-ops, because
10904                          *  if the nested one fails, the outer one must as
10905                          *  well.  It could fail sooner, and avoid (??{} with
10906                          *  side effects, but that is explicitly documented as
10907                          *  undefined behavior. */
10908
10909                         ret = NULL;
10910
10911                         if (paren == 's') {
10912                             paren = ':';
10913                             goto parse_rest;
10914                         }
10915
10916                         /* But, the atomic part of a nested atomic script run
10917                          * isn't a no-op, but can be treated just like a '(?>'
10918                          * */
10919                         paren = '>';
10920                         goto parse_rest;
10921                     }
10922
10923                     /* By doing this here, we avoid extra warnings for nested
10924                      * script runs */
10925                     if (PASS2) {
10926                         Perl_ck_warner_d(aTHX_
10927                             packWARN(WARN_EXPERIMENTAL__SCRIPT_RUN),
10928                             "The script_run feature is experimental"
10929                             REPORT_LOCATION, REPORT_LOCATION_ARGS(RExC_parse));
10930
10931                     }
10932
10933                     if (paren == 's') {
10934                         /* Here, we're starting a new regular script run */
10935                         ret = reg_node(pRExC_state, SROPEN);
10936                         RExC_in_script_run = 1;
10937                         is_open = 1;
10938                         goto parse_rest;
10939                     }
10940
10941                     /* Here, we are starting an atomic script run.  This is
10942                      * handled by recursing to deal with the atomic portion
10943                      * separately, enclosed in SROPEN ... SRCLOSE nodes */
10944
10945                     ret = reg_node(pRExC_state, SROPEN);
10946
10947                     RExC_in_script_run = 1;
10948
10949                     atomic = reg(pRExC_state, 'r', &flags, depth);
10950                     if (flags & (RESTART_PASS1|NEED_UTF8)) {
10951                         *flagp = flags & (RESTART_PASS1|NEED_UTF8);
10952                         return NULL;
10953                     }
10954
10955                     REGTAIL(pRExC_state, ret, atomic);
10956
10957                     REGTAIL(pRExC_state, atomic,
10958                            reg_node(pRExC_state, SRCLOSE));
10959
10960                     RExC_in_script_run = 0;
10961                     return ret;
10962                 }
10963
10964                 break;
10965
10966             lookbehind_alpha_assertions:
10967                 RExC_seen |= REG_LOOKBEHIND_SEEN;
10968                 RExC_in_lookbehind++;
10969                 /*FALLTHROUGH*/
10970
10971             alpha_assertions:
10972
10973                 if (PASS2) {
10974                     Perl_ck_warner_d(aTHX_
10975                         packWARN(WARN_EXPERIMENTAL__ALPHA_ASSERTIONS),
10976                         "The alpha_assertions feature is experimental"
10977                         REPORT_LOCATION, REPORT_LOCATION_ARGS(RExC_parse));
10978                 }
10979
10980                 RExC_seen_zerolen++;
10981
10982                 if (! start_arg) {
10983                     goto no_colon;
10984                 }
10985
10986                 /* An empty negative lookahead assertion simply is failure */
10987                 if (paren == 'A' && RExC_parse == start_arg) {
10988                     ret=reganode(pRExC_state, OPFAIL, 0);
10989                     nextchar(pRExC_state);
10990                     return ret;
10991                 }
10992
10993                 RExC_parse = start_arg;
10994                 goto parse_rest;
10995
10996               no_colon:
10997                 vFAIL2utf8f(
10998                 "'(*%" UTF8f "' requires a terminating ':'",
10999                 UTF8fARG(UTF, verb_len, start_verb));
11000                 NOT_REACHED; /*NOTREACHED*/
11001
11002             } /* End of switch */
11003             if ( ! op ) {
11004                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11005                 if (has_upper || verb_len == 0) {
11006                     vFAIL2utf8f(
11007                     "Unknown verb pattern '%" UTF8f "'",
11008                     UTF8fARG(UTF, verb_len, start_verb));
11009                 }
11010                 else {
11011                     vFAIL2utf8f(
11012                     "Unknown '(*...)' construct '%" UTF8f "'",
11013                     UTF8fARG(UTF, verb_len, start_verb));
11014                 }
11015             }
11016             if ( RExC_parse == start_arg ) {
11017                 start_arg = NULL;
11018             }
11019             if ( arg_required && !start_arg ) {
11020                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
11021                     verb_len, start_verb);
11022             }
11023             if (internal_argval == -1) {
11024                 ret = reganode(pRExC_state, op, 0);
11025             } else {
11026                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
11027             }
11028             RExC_seen |= REG_VERBARG_SEEN;
11029             if ( ! SIZE_ONLY ) {
11030                 if (start_arg) {
11031                     SV *sv = newSVpvn( start_arg,
11032                                        RExC_parse - start_arg);
11033                     ARG(ret) = add_data( pRExC_state,
11034                                          STR_WITH_LEN("S"));
11035                     RExC_rxi->data->data[ARG(ret)]=(void*)sv;
11036                     ret->flags = 1;
11037                 } else {
11038                     ret->flags = 0;
11039                 }
11040                 if ( internal_argval != -1 )
11041                     ARG2L_SET(ret, internal_argval);
11042             }
11043             nextchar(pRExC_state);
11044             return ret;
11045         }
11046         else if (*RExC_parse == '?') { /* (?...) */
11047             bool is_logical = 0;
11048             const char * const seqstart = RExC_parse;
11049             const char * endptr;
11050             if (has_intervening_patws) {
11051                 RExC_parse++;
11052                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
11053             }
11054
11055             RExC_parse++;           /* past the '?' */
11056             paren = *RExC_parse;    /* might be a trailing NUL, if not
11057                                        well-formed */
11058             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11059             if (RExC_parse > RExC_end) {
11060                 paren = '\0';
11061             }
11062             ret = NULL;                 /* For look-ahead/behind. */
11063             switch (paren) {
11064
11065             case 'P':   /* (?P...) variants for those used to PCRE/Python */
11066                 paren = *RExC_parse;
11067                 if ( paren == '<') {    /* (?P<...>) named capture */
11068                     RExC_parse++;
11069                     if (RExC_parse >= RExC_end) {
11070                         vFAIL("Sequence (?P<... not terminated");
11071                     }
11072                     goto named_capture;
11073                 }
11074                 else if (paren == '>') {   /* (?P>name) named recursion */
11075                     RExC_parse++;
11076                     if (RExC_parse >= RExC_end) {
11077                         vFAIL("Sequence (?P>... not terminated");
11078                     }
11079                     goto named_recursion;
11080                 }
11081                 else if (paren == '=') {   /* (?P=...)  named backref */
11082                     RExC_parse++;
11083                     return handle_named_backref(pRExC_state, flagp,
11084                                                 parse_start, ')');
11085                 }
11086                 RExC_parse += SKIP_IF_CHAR(RExC_parse);
11087                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11088                 vFAIL3("Sequence (%.*s...) not recognized",
11089                                 RExC_parse-seqstart, seqstart);
11090                 NOT_REACHED; /*NOTREACHED*/
11091             case '<':           /* (?<...) */
11092                 if (*RExC_parse == '!')
11093                     paren = ',';
11094                 else if (*RExC_parse != '=')
11095               named_capture:
11096                 {               /* (?<...>) */
11097                     char *name_start;
11098                     SV *svname;
11099                     paren= '>';
11100                 /* FALLTHROUGH */
11101             case '\'':          /* (?'...') */
11102                     name_start = RExC_parse;
11103                     svname = reg_scan_name(pRExC_state,
11104                         SIZE_ONLY    /* reverse test from the others */
11105                         ? REG_RSN_RETURN_NAME
11106                         : REG_RSN_RETURN_NULL);
11107                     if (   RExC_parse == name_start
11108                         || RExC_parse >= RExC_end
11109                         || *RExC_parse != paren)
11110                     {
11111                         vFAIL2("Sequence (?%c... not terminated",
11112                             paren=='>' ? '<' : paren);
11113                     }
11114                     if (SIZE_ONLY) {
11115                         HE *he_str;
11116                         SV *sv_dat = NULL;
11117                         if (!svname) /* shouldn't happen */
11118                             Perl_croak(aTHX_
11119                                 "panic: reg_scan_name returned NULL");
11120                         if (!RExC_paren_names) {
11121                             RExC_paren_names= newHV();
11122                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
11123 #ifdef DEBUGGING
11124                             RExC_paren_name_list= newAV();
11125                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
11126 #endif
11127                         }
11128                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
11129                         if ( he_str )
11130                             sv_dat = HeVAL(he_str);
11131                         if ( ! sv_dat ) {
11132                             /* croak baby croak */
11133                             Perl_croak(aTHX_
11134                                 "panic: paren_name hash element allocation failed");
11135                         } else if ( SvPOK(sv_dat) ) {
11136                             /* (?|...) can mean we have dupes so scan to check
11137                                its already been stored. Maybe a flag indicating
11138                                we are inside such a construct would be useful,
11139                                but the arrays are likely to be quite small, so
11140                                for now we punt -- dmq */
11141                             IV count = SvIV(sv_dat);
11142                             I32 *pv = (I32*)SvPVX(sv_dat);
11143                             IV i;
11144                             for ( i = 0 ; i < count ; i++ ) {
11145                                 if ( pv[i] == RExC_npar ) {
11146                                     count = 0;
11147                                     break;
11148                                 }
11149                             }
11150                             if ( count ) {
11151                                 pv = (I32*)SvGROW(sv_dat,
11152                                                 SvCUR(sv_dat) + sizeof(I32)+1);
11153                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
11154                                 pv[count] = RExC_npar;
11155                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
11156                             }
11157                         } else {
11158                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
11159                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
11160                                                                 sizeof(I32));
11161                             SvIOK_on(sv_dat);
11162                             SvIV_set(sv_dat, 1);
11163                         }
11164 #ifdef DEBUGGING
11165                         /* Yes this does cause a memory leak in debugging Perls
11166                          * */
11167                         if (!av_store(RExC_paren_name_list,
11168                                       RExC_npar, SvREFCNT_inc(svname)))
11169                             SvREFCNT_dec_NN(svname);
11170 #endif
11171
11172                         /*sv_dump(sv_dat);*/
11173                     }
11174                     nextchar(pRExC_state);
11175                     paren = 1;
11176                     goto capturing_parens;
11177                 }
11178
11179                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11180                 RExC_in_lookbehind++;
11181                 RExC_parse++;
11182                 if (RExC_parse >= RExC_end) {
11183                     vFAIL("Sequence (?... not terminated");
11184                 }
11185
11186                 /* FALLTHROUGH */
11187             case '=':           /* (?=...) */
11188                 RExC_seen_zerolen++;
11189                 break;
11190             case '!':           /* (?!...) */
11191                 RExC_seen_zerolen++;
11192                 /* check if we're really just a "FAIL" assertion */
11193                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11194                                         FALSE /* Don't force to /x */ );
11195                 if (*RExC_parse == ')') {
11196                     ret=reganode(pRExC_state, OPFAIL, 0);
11197                     nextchar(pRExC_state);
11198                     return ret;
11199                 }
11200                 break;
11201             case '|':           /* (?|...) */
11202                 /* branch reset, behave like a (?:...) except that
11203                    buffers in alternations share the same numbers */
11204                 paren = ':';
11205                 after_freeze = freeze_paren = RExC_npar;
11206                 break;
11207             case ':':           /* (?:...) */
11208             case '>':           /* (?>...) */
11209                 break;
11210             case '$':           /* (?$...) */
11211             case '@':           /* (?@...) */
11212                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
11213                 break;
11214             case '0' :           /* (?0) */
11215             case 'R' :           /* (?R) */
11216                 if (RExC_parse == RExC_end || *RExC_parse != ')')
11217                     FAIL("Sequence (?R) not terminated");
11218                 num = 0;
11219                 RExC_seen |= REG_RECURSE_SEEN;
11220                 *flagp |= POSTPONED;
11221                 goto gen_recurse_regop;
11222                 /*notreached*/
11223             /* named and numeric backreferences */
11224             case '&':            /* (?&NAME) */
11225                 parse_start = RExC_parse - 1;
11226               named_recursion:
11227                 {
11228                     SV *sv_dat = reg_scan_name(pRExC_state,
11229                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11230                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
11231                 }
11232                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
11233                     vFAIL("Sequence (?&... not terminated");
11234                 goto gen_recurse_regop;
11235                 /* NOTREACHED */
11236             case '+':
11237                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
11238                     RExC_parse++;
11239                     vFAIL("Illegal pattern");
11240                 }
11241                 goto parse_recursion;
11242                 /* NOTREACHED*/
11243             case '-': /* (?-1) */
11244                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
11245                     RExC_parse--; /* rewind to let it be handled later */
11246                     goto parse_flags;
11247                 }
11248                 /* FALLTHROUGH */
11249             case '1': case '2': case '3': case '4': /* (?1) */
11250             case '5': case '6': case '7': case '8': case '9':
11251                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
11252               parse_recursion:
11253                 {
11254                     bool is_neg = FALSE;
11255                     UV unum;
11256                     parse_start = RExC_parse - 1; /* MJD */
11257                     if (*RExC_parse == '-') {
11258                         RExC_parse++;
11259                         is_neg = TRUE;
11260                     }
11261                     endptr = RExC_end;
11262                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11263                         && unum <= I32_MAX
11264                     ) {
11265                         num = (I32)unum;
11266                         RExC_parse = (char*)endptr;
11267                     } else
11268                         num = I32_MAX;
11269                     if (is_neg) {
11270                         /* Some limit for num? */
11271                         num = -num;
11272                     }
11273                 }
11274                 if (*RExC_parse!=')')
11275                     vFAIL("Expecting close bracket");
11276
11277               gen_recurse_regop:
11278                 if ( paren == '-' ) {
11279                     /*
11280                     Diagram of capture buffer numbering.
11281                     Top line is the normal capture buffer numbers
11282                     Bottom line is the negative indexing as from
11283                     the X (the (?-2))
11284
11285                     +   1 2    3 4 5 X          6 7
11286                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11287                     -   5 4    3 2 1 X          x x
11288
11289                     */
11290                     num = RExC_npar + num;
11291                     if (num < 1)  {
11292                         RExC_parse++;
11293                         vFAIL("Reference to nonexistent group");
11294                     }
11295                 } else if ( paren == '+' ) {
11296                     num = RExC_npar + num - 1;
11297                 }
11298                 /* We keep track how many GOSUB items we have produced.
11299                    To start off the ARG2L() of the GOSUB holds its "id",
11300                    which is used later in conjunction with RExC_recurse
11301                    to calculate the offset we need to jump for the GOSUB,
11302                    which it will store in the final representation.
11303                    We have to defer the actual calculation until much later
11304                    as the regop may move.
11305                  */
11306
11307                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11308                 if (!SIZE_ONLY) {
11309                     if (num > (I32)RExC_rx->nparens) {
11310                         RExC_parse++;
11311                         vFAIL("Reference to nonexistent group");
11312                     }
11313                     RExC_recurse_count++;
11314                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11315                         "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11316                               22, "|    |", (int)(depth * 2 + 1), "",
11317                               (UV)ARG(ret), (IV)ARG2L(ret)));
11318                 }
11319                 RExC_seen |= REG_RECURSE_SEEN;
11320
11321                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
11322                 Set_Node_Offset(ret, parse_start); /* MJD */
11323
11324                 *flagp |= POSTPONED;
11325                 assert(*RExC_parse == ')');
11326                 nextchar(pRExC_state);
11327                 return ret;
11328
11329             /* NOTREACHED */
11330
11331             case '?':           /* (??...) */
11332                 is_logical = 1;
11333                 if (*RExC_parse != '{') {
11334                     RExC_parse += SKIP_IF_CHAR(RExC_parse);
11335                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11336                     vFAIL2utf8f(
11337                         "Sequence (%" UTF8f "...) not recognized",
11338                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11339                     NOT_REACHED; /*NOTREACHED*/
11340                 }
11341                 *flagp |= POSTPONED;
11342                 paren = '{';
11343                 RExC_parse++;
11344                 /* FALLTHROUGH */
11345             case '{':           /* (?{...}) */
11346             {
11347                 U32 n = 0;
11348                 struct reg_code_block *cb;
11349
11350                 RExC_seen_zerolen++;
11351
11352                 if (   !pRExC_state->code_blocks
11353                     || pRExC_state->code_index
11354                                         >= pRExC_state->code_blocks->count
11355                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11356                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11357                             - RExC_start)
11358                 ) {
11359                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11360                         FAIL("panic: Sequence (?{...}): no code block found\n");
11361                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11362                 }
11363                 /* this is a pre-compiled code block (?{...}) */
11364                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11365                 RExC_parse = RExC_start + cb->end;
11366                 if (!SIZE_ONLY) {
11367                     OP *o = cb->block;
11368                     if (cb->src_regex) {
11369                         n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11370                         RExC_rxi->data->data[n] =
11371                             (void*)SvREFCNT_inc((SV*)cb->src_regex);
11372                         RExC_rxi->data->data[n+1] = (void*)o;
11373                     }
11374                     else {
11375                         n = add_data(pRExC_state,
11376                                (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11377                         RExC_rxi->data->data[n] = (void*)o;
11378                     }
11379                 }
11380                 pRExC_state->code_index++;
11381                 nextchar(pRExC_state);
11382
11383                 if (is_logical) {
11384                     regnode *eval;
11385                     ret = reg_node(pRExC_state, LOGICAL);
11386
11387                     eval = reg2Lanode(pRExC_state, EVAL,
11388                                        n,
11389
11390                                        /* for later propagation into (??{})
11391                                         * return value */
11392                                        RExC_flags & RXf_PMf_COMPILETIME
11393                                       );
11394                     if (!SIZE_ONLY) {
11395                         ret->flags = 2;
11396                     }
11397                     REGTAIL(pRExC_state, ret, eval);
11398                     /* deal with the length of this later - MJD */
11399                     return ret;
11400                 }
11401                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11402                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
11403                 Set_Node_Offset(ret, parse_start);
11404                 return ret;
11405             }
11406             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11407             {
11408                 int is_define= 0;
11409                 const int DEFINE_len = sizeof("DEFINE") - 1;
11410                 if (    RExC_parse < RExC_end - 1
11411                     && (   (       RExC_parse[0] == '?'        /* (?(?...)) */
11412                             && (   RExC_parse[1] == '='
11413                                 || RExC_parse[1] == '!'
11414                                 || RExC_parse[1] == '<'
11415                                 || RExC_parse[1] == '{'))
11416                         || (       RExC_parse[0] == '*'        /* (?(*...)) */
11417                             && (   memBEGINs(RExC_parse + 1,
11418                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11419                                          "pla:")
11420                                 || memBEGINs(RExC_parse + 1,
11421                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11422                                          "plb:")
11423                                 || memBEGINs(RExC_parse + 1,
11424                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11425                                          "nla:")
11426                                 || memBEGINs(RExC_parse + 1,
11427                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11428                                          "nlb:")
11429                                 || memBEGINs(RExC_parse + 1,
11430                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11431                                          "positive_lookahead:")
11432                                 || memBEGINs(RExC_parse + 1,
11433                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11434                                          "positive_lookbehind:")
11435                                 || memBEGINs(RExC_parse + 1,
11436                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11437                                          "negative_lookahead:")
11438                                 || memBEGINs(RExC_parse + 1,
11439                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11440                                          "negative_lookbehind:"))))
11441                 ) { /* Lookahead or eval. */
11442                     I32 flag;
11443                     regnode *tail;
11444
11445                     ret = reg_node(pRExC_state, LOGICAL);
11446                     if (!SIZE_ONLY)
11447                         ret->flags = 1;
11448
11449                     tail = reg(pRExC_state, 1, &flag, depth+1);
11450                     RETURN_NULL_ON_RESTART(flag,flagp);
11451                     REGTAIL(pRExC_state, ret, tail);
11452                     goto insert_if;
11453                 }
11454                 else if (   RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11455                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11456                 {
11457                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11458                     char *name_start= RExC_parse++;
11459                     U32 num = 0;
11460                     SV *sv_dat=reg_scan_name(pRExC_state,
11461                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
11462                     if (   RExC_parse == name_start
11463                         || RExC_parse >= RExC_end
11464                         || *RExC_parse != ch)
11465                     {
11466                         vFAIL2("Sequence (?(%c... not terminated",
11467                             (ch == '>' ? '<' : ch));
11468                     }
11469                     RExC_parse++;
11470                     if (!SIZE_ONLY) {
11471                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11472                         RExC_rxi->data->data[num]=(void*)sv_dat;
11473                         SvREFCNT_inc_simple_void(sv_dat);
11474                     }
11475                     ret = reganode(pRExC_state,NGROUPP,num);
11476                     goto insert_if_check_paren;
11477                 }
11478                 else if (memBEGINs(RExC_parse,
11479                                    (STRLEN) (RExC_end - RExC_parse),
11480                                    "DEFINE"))
11481                 {
11482                     ret = reganode(pRExC_state,DEFINEP,0);
11483                     RExC_parse += DEFINE_len;
11484                     is_define = 1;
11485                     goto insert_if_check_paren;
11486                 }
11487                 else if (RExC_parse[0] == 'R') {
11488                     RExC_parse++;
11489                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11490                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11491                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11492                      */
11493                     parno = 0;
11494                     if (RExC_parse[0] == '0') {
11495                         parno = 1;
11496                         RExC_parse++;
11497                     }
11498                     else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11499                         UV uv;
11500                         endptr = RExC_end;
11501                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11502                             && uv <= I32_MAX
11503                         ) {
11504                             parno = (I32)uv + 1;
11505                             RExC_parse = (char*)endptr;
11506                         }
11507                         /* else "Switch condition not recognized" below */
11508                     } else if (RExC_parse[0] == '&') {
11509                         SV *sv_dat;
11510                         RExC_parse++;
11511                         sv_dat = reg_scan_name(pRExC_state,
11512                             SIZE_ONLY
11513                             ? REG_RSN_RETURN_NULL
11514                             : REG_RSN_RETURN_DATA);
11515
11516                         /* we should only have a false sv_dat when
11517                          * SIZE_ONLY is true, and we always have false
11518                          * sv_dat when SIZE_ONLY is true.
11519                          * reg_scan_name() will VFAIL() if the name is
11520                          * unknown when SIZE_ONLY is false, and otherwise
11521                          * will return something, and when SIZE_ONLY is
11522                          * true, reg_scan_name() just parses the string,
11523                          * and doesnt return anything. (in theory) */
11524                         assert(SIZE_ONLY ? !sv_dat : !!sv_dat);
11525
11526                         if (sv_dat)
11527                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11528                     }
11529                     ret = reganode(pRExC_state,INSUBP,parno);
11530                     goto insert_if_check_paren;
11531                 }
11532                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
11533                     /* (?(1)...) */
11534                     char c;
11535                     UV uv;
11536                     endptr = RExC_end;
11537                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11538                         && uv <= I32_MAX
11539                     ) {
11540                         parno = (I32)uv;
11541                         RExC_parse = (char*)endptr;
11542                     }
11543                     else {
11544                         vFAIL("panic: grok_atoUV returned FALSE");
11545                     }
11546                     ret = reganode(pRExC_state, GROUPP, parno);
11547
11548                  insert_if_check_paren:
11549                     if (UCHARAT(RExC_parse) != ')') {
11550                         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11551                         vFAIL("Switch condition not recognized");
11552                     }
11553                     nextchar(pRExC_state);
11554                   insert_if:
11555                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
11556                     br = regbranch(pRExC_state, &flags, 1,depth+1);
11557                     if (br == NULL) {
11558                         RETURN_NULL_ON_RESTART(flags,flagp);
11559                         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11560                               (UV) flags);
11561                     } else
11562                         REGTAIL(pRExC_state, br, reganode(pRExC_state,
11563                                                           LONGJMP, 0));
11564                     c = UCHARAT(RExC_parse);
11565                     nextchar(pRExC_state);
11566                     if (flags&HASWIDTH)
11567                         *flagp |= HASWIDTH;
11568                     if (c == '|') {
11569                         if (is_define)
11570                             vFAIL("(?(DEFINE)....) does not allow branches");
11571
11572                         /* Fake one for optimizer.  */
11573                         lastbr = reganode(pRExC_state, IFTHEN, 0);
11574
11575                         if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
11576                             RETURN_NULL_ON_RESTART(flags,flagp);
11577                             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf,
11578                                   (UV) flags);
11579                         }
11580                         REGTAIL(pRExC_state, ret, lastbr);
11581                         if (flags&HASWIDTH)
11582                             *flagp |= HASWIDTH;
11583                         c = UCHARAT(RExC_parse);
11584                         nextchar(pRExC_state);
11585                     }
11586                     else
11587                         lastbr = NULL;
11588                     if (c != ')') {
11589                         if (RExC_parse >= RExC_end)
11590                             vFAIL("Switch (?(condition)... not terminated");
11591                         else
11592                             vFAIL("Switch (?(condition)... contains too many branches");
11593                     }
11594                     ender = reg_node(pRExC_state, TAIL);
11595                     REGTAIL(pRExC_state, br, ender);
11596                     if (lastbr) {
11597                         REGTAIL(pRExC_state, lastbr, ender);
11598                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11599                     }
11600                     else
11601                         REGTAIL(pRExC_state, ret, ender);
11602                     RExC_size++; /* XXX WHY do we need this?!!
11603                                     For large programs it seems to be required
11604                                     but I can't figure out why. -- dmq*/
11605                     return ret;
11606                 }
11607                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11608                 vFAIL("Unknown switch condition (?(...))");
11609             }
11610             case '[':           /* (?[ ... ]) */
11611                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
11612                                          oregcomp_parse);
11613             case 0: /* A NUL */
11614                 RExC_parse--; /* for vFAIL to print correctly */
11615                 vFAIL("Sequence (? incomplete");
11616                 break;
11617             default: /* e.g., (?i) */
11618                 RExC_parse = (char *) seqstart + 1;
11619               parse_flags:
11620                 parse_lparen_question_flags(pRExC_state);
11621                 if (UCHARAT(RExC_parse) != ':') {
11622                     if (RExC_parse < RExC_end)
11623                         nextchar(pRExC_state);
11624                     *flagp = TRYAGAIN;
11625                     return NULL;
11626                 }
11627                 paren = ':';
11628                 nextchar(pRExC_state);
11629                 ret = NULL;
11630                 goto parse_rest;
11631             } /* end switch */
11632         }
11633         else {
11634             if (*RExC_parse == '{' && PASS2) {
11635                 ckWARNregdep(RExC_parse + 1,
11636                             "Unescaped left brace in regex is "
11637                             "deprecated here (and will be fatal "
11638                             "in Perl 5.32), passed through");
11639             }
11640             /* Not bothering to indent here, as the above 'else' is temporary
11641              * */
11642         if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
11643           capturing_parens:
11644             parno = RExC_npar;
11645             RExC_npar++;
11646
11647             ret = reganode(pRExC_state, OPEN, parno);
11648             if (!SIZE_ONLY ){
11649                 if (!RExC_nestroot)
11650                     RExC_nestroot = parno;
11651                 if (RExC_open_parens && !RExC_open_parens[parno])
11652                 {
11653                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11654                         "%*s%*s Setting open paren #%" IVdf " to %d\n",
11655                         22, "|    |", (int)(depth * 2 + 1), "",
11656                         (IV)parno, REG_NODE_NUM(ret)));
11657                     RExC_open_parens[parno]= ret;
11658                 }
11659             }
11660             Set_Node_Length(ret, 1); /* MJD */
11661             Set_Node_Offset(ret, RExC_parse); /* MJD */
11662             is_open = 1;
11663         } else {
11664             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
11665             paren = ':';
11666             ret = NULL;
11667         }
11668         }
11669     }
11670     else                        /* ! paren */
11671         ret = NULL;
11672
11673    parse_rest:
11674     /* Pick up the branches, linking them together. */
11675     parse_start = RExC_parse;   /* MJD */
11676     br = regbranch(pRExC_state, &flags, 1,depth+1);
11677
11678     /*     branch_len = (paren != 0); */
11679
11680     if (br == NULL) {
11681         RETURN_NULL_ON_RESTART(flags,flagp);
11682         FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11683     }
11684     if (*RExC_parse == '|') {
11685         if (!SIZE_ONLY && RExC_extralen) {
11686             reginsert(pRExC_state, BRANCHJ, br, depth+1);
11687         }
11688         else {                  /* MJD */
11689             reginsert(pRExC_state, BRANCH, br, depth+1);
11690             Set_Node_Length(br, paren != 0);
11691             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
11692         }
11693         have_branch = 1;
11694         if (SIZE_ONLY)
11695             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
11696     }
11697     else if (paren == ':') {
11698         *flagp |= flags&SIMPLE;
11699     }
11700     if (is_open) {                              /* Starts with OPEN. */
11701         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
11702     }
11703     else if (paren != '?')              /* Not Conditional */
11704         ret = br;
11705     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11706     lastbr = br;
11707     while (*RExC_parse == '|') {
11708         if (!SIZE_ONLY && RExC_extralen) {
11709             ender = reganode(pRExC_state, LONGJMP,0);
11710
11711             /* Append to the previous. */
11712             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
11713         }
11714         if (SIZE_ONLY)
11715             RExC_extralen += 2;         /* Account for LONGJMP. */
11716         nextchar(pRExC_state);
11717         if (freeze_paren) {
11718             if (RExC_npar > after_freeze)
11719                 after_freeze = RExC_npar;
11720             RExC_npar = freeze_paren;
11721         }
11722         br = regbranch(pRExC_state, &flags, 0, depth+1);
11723
11724         if (br == NULL) {
11725             RETURN_NULL_ON_RESTART(flags,flagp);
11726             FAIL2("panic: regbranch returned NULL, flags=%#" UVxf, (UV) flags);
11727         }
11728         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
11729         lastbr = br;
11730         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
11731     }
11732
11733     if (have_branch || paren != ':') {
11734         /* Make a closing node, and hook it on the end. */
11735         switch (paren) {
11736         case ':':
11737             ender = reg_node(pRExC_state, TAIL);
11738             break;
11739         case 1: case 2:
11740             ender = reganode(pRExC_state, CLOSE, parno);
11741             if ( RExC_close_parens ) {
11742                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11743                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
11744                         22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
11745                 RExC_close_parens[parno]= ender;
11746                 if (RExC_nestroot == parno)
11747                     RExC_nestroot = 0;
11748             }
11749             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
11750             Set_Node_Length(ender,1); /* MJD */
11751             break;
11752         case 's':
11753             ender = reg_node(pRExC_state, SRCLOSE);
11754             RExC_in_script_run = 0;
11755             break;
11756         case '<':
11757         case 'a':
11758         case 'A':
11759         case 'b':
11760         case 'B':
11761         case ',':
11762         case '=':
11763         case '!':
11764             *flagp &= ~HASWIDTH;
11765             /* FALLTHROUGH */
11766         case 't':   /* aTomic */
11767         case '>':
11768             ender = reg_node(pRExC_state, SUCCEED);
11769             break;
11770         case 0:
11771             ender = reg_node(pRExC_state, END);
11772             if (!SIZE_ONLY) {
11773                 assert(!RExC_end_op); /* there can only be one! */
11774                 RExC_end_op = ender;
11775                 if (RExC_close_parens) {
11776                     DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11777                         "%*s%*s Setting close paren #0 (END) to %d\n",
11778                         22, "|    |", (int)(depth * 2 + 1), "", REG_NODE_NUM(ender)));
11779
11780                     RExC_close_parens[0]= ender;
11781                 }
11782             }
11783             break;
11784         }
11785         DEBUG_PARSE_r(if (!SIZE_ONLY) {
11786             DEBUG_PARSE_MSG("lsbr");
11787             regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
11788             regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11789             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11790                           SvPV_nolen_const(RExC_mysv1),
11791                           (IV)REG_NODE_NUM(lastbr),
11792                           SvPV_nolen_const(RExC_mysv2),
11793                           (IV)REG_NODE_NUM(ender),
11794                           (IV)(ender - lastbr)
11795             );
11796         });
11797         REGTAIL(pRExC_state, lastbr, ender);
11798
11799         if (have_branch && !SIZE_ONLY) {
11800             char is_nothing= 1;
11801             if (depth==1)
11802                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
11803
11804             /* Hook the tails of the branches to the closing node. */
11805             for (br = ret; br; br = regnext(br)) {
11806                 const U8 op = PL_regkind[OP(br)];
11807                 if (op == BRANCH) {
11808                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
11809                     if ( OP(NEXTOPER(br)) != NOTHING
11810                          || regnext(NEXTOPER(br)) != ender)
11811                         is_nothing= 0;
11812                 }
11813                 else if (op == BRANCHJ) {
11814                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
11815                     /* for now we always disable this optimisation * /
11816                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
11817                          || regnext(NEXTOPER(NEXTOPER(br))) != ender)
11818                     */
11819                         is_nothing= 0;
11820                 }
11821             }
11822             if (is_nothing) {
11823                 br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
11824                 DEBUG_PARSE_r(if (!SIZE_ONLY) {
11825                     DEBUG_PARSE_MSG("NADA");
11826                     regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
11827                     regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
11828                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
11829                                   SvPV_nolen_const(RExC_mysv1),
11830                                   (IV)REG_NODE_NUM(ret),
11831                                   SvPV_nolen_const(RExC_mysv2),
11832                                   (IV)REG_NODE_NUM(ender),
11833                                   (IV)(ender - ret)
11834                     );
11835                 });
11836                 OP(br)= NOTHING;
11837                 if (OP(ender) == TAIL) {
11838                     NEXT_OFF(br)= 0;
11839                     RExC_emit= br + 1;
11840                 } else {
11841                     regnode *opt;
11842                     for ( opt= br + 1; opt < ender ; opt++ )
11843                         OP(opt)= OPTIMIZED;
11844                     NEXT_OFF(br)= ender - br;
11845                 }
11846             }
11847         }
11848     }
11849
11850     {
11851         const char *p;
11852          /* Even/odd or x=don't care: 010101x10x */
11853         static const char parens[] = "=!aA<,>Bbt";
11854          /* flag below is set to 0 up through 'A'; 1 for larger */
11855
11856         if (paren && (p = strchr(parens, paren))) {
11857             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
11858             int flag = (p - parens) > 3;
11859
11860             if (paren == '>' || paren == 't') {
11861                 node = SUSPEND, flag = 0;
11862             }
11863
11864             reginsert(pRExC_state, node,ret, depth+1);
11865             Set_Node_Cur_Length(ret, parse_start);
11866             Set_Node_Offset(ret, parse_start + 1);
11867             ret->flags = flag;
11868             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
11869         }
11870     }
11871
11872     /* Check for proper termination. */
11873     if (paren) {
11874         /* restore original flags, but keep (?p) and, if we've changed from /d
11875          * rules to /u, keep the /u */
11876         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
11877         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
11878             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
11879         }
11880         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
11881             RExC_parse = oregcomp_parse;
11882             vFAIL("Unmatched (");
11883         }
11884         nextchar(pRExC_state);
11885     }
11886     else if (!paren && RExC_parse < RExC_end) {
11887         if (*RExC_parse == ')') {
11888             RExC_parse++;
11889             vFAIL("Unmatched )");
11890         }
11891         else
11892             FAIL("Junk on end of regexp");      /* "Can't happen". */
11893         NOT_REACHED; /* NOTREACHED */
11894     }
11895
11896     if (RExC_in_lookbehind) {
11897         RExC_in_lookbehind--;
11898     }
11899     if (after_freeze > RExC_npar)
11900         RExC_npar = after_freeze;
11901     return(ret);
11902 }
11903
11904 /*
11905  - regbranch - one alternative of an | operator
11906  *
11907  * Implements the concatenation operator.
11908  *
11909  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11910  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11911  */
11912 STATIC regnode *
11913 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
11914 {
11915     regnode *ret;
11916     regnode *chain = NULL;
11917     regnode *latest;
11918     I32 flags = 0, c = 0;
11919     GET_RE_DEBUG_FLAGS_DECL;
11920
11921     PERL_ARGS_ASSERT_REGBRANCH;
11922
11923     DEBUG_PARSE("brnc");
11924
11925     if (first)
11926         ret = NULL;
11927     else {
11928         if (!SIZE_ONLY && RExC_extralen)
11929             ret = reganode(pRExC_state, BRANCHJ,0);
11930         else {
11931             ret = reg_node(pRExC_state, BRANCH);
11932             Set_Node_Length(ret, 1);
11933         }
11934     }
11935
11936     if (!first && SIZE_ONLY)
11937         RExC_extralen += 1;                     /* BRANCHJ */
11938
11939     *flagp = WORST;                     /* Tentatively. */
11940
11941     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11942                             FALSE /* Don't force to /x */ );
11943     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
11944         flags &= ~TRYAGAIN;
11945         latest = regpiece(pRExC_state, &flags,depth+1);
11946         if (latest == NULL) {
11947             if (flags & TRYAGAIN)
11948                 continue;
11949             RETURN_NULL_ON_RESTART(flags,flagp);
11950             FAIL2("panic: regpiece returned NULL, flags=%#" UVxf, (UV) flags);
11951         }
11952         else if (ret == NULL)
11953             ret = latest;
11954         *flagp |= flags&(HASWIDTH|POSTPONED);
11955         if (chain == NULL)      /* First piece. */
11956             *flagp |= flags&SPSTART;
11957         else {
11958             /* FIXME adding one for every branch after the first is probably
11959              * excessive now we have TRIE support. (hv) */
11960             MARK_NAUGHTY(1);
11961             REGTAIL(pRExC_state, chain, latest);
11962         }
11963         chain = latest;
11964         c++;
11965     }
11966     if (chain == NULL) {        /* Loop ran zero times. */
11967         chain = reg_node(pRExC_state, NOTHING);
11968         if (ret == NULL)
11969             ret = chain;
11970     }
11971     if (c == 1) {
11972         *flagp |= flags&SIMPLE;
11973     }
11974
11975     return ret;
11976 }
11977
11978 /*
11979  - regpiece - something followed by possible quantifier * + ? {n,m}
11980  *
11981  * Note that the branching code sequences used for ? and the general cases
11982  * of * and + are somewhat optimized:  they use the same NOTHING node as
11983  * both the endmarker for their branch list and the body of the last branch.
11984  * It might seem that this node could be dispensed with entirely, but the
11985  * endmarker role is not redundant.
11986  *
11987  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
11988  * TRYAGAIN.
11989  * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
11990  * restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
11991  */
11992 STATIC regnode *
11993 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11994 {
11995     regnode *ret;
11996     char op;
11997     char *next;
11998     I32 flags;
11999     const char * const origparse = RExC_parse;
12000     I32 min;
12001     I32 max = REG_INFTY;
12002 #ifdef RE_TRACK_PATTERN_OFFSETS
12003     char *parse_start;
12004 #endif
12005     const char *maxpos = NULL;
12006     UV uv;
12007
12008     /* Save the original in case we change the emitted regop to a FAIL. */
12009     regnode * const orig_emit = RExC_emit;
12010
12011     GET_RE_DEBUG_FLAGS_DECL;
12012
12013     PERL_ARGS_ASSERT_REGPIECE;
12014
12015     DEBUG_PARSE("piec");
12016
12017     ret = regatom(pRExC_state, &flags,depth+1);
12018     if (ret == NULL) {
12019         RETURN_NULL_ON_RESTART_OR_FLAGS(flags,flagp,TRYAGAIN);
12020         FAIL2("panic: regatom returned NULL, flags=%#" UVxf, (UV) flags);
12021     }
12022
12023     op = *RExC_parse;
12024
12025     if (op == '{' && regcurly(RExC_parse)) {
12026         maxpos = NULL;
12027 #ifdef RE_TRACK_PATTERN_OFFSETS
12028         parse_start = RExC_parse; /* MJD */
12029 #endif
12030         next = RExC_parse + 1;
12031         while (isDIGIT(*next) || *next == ',') {
12032             if (*next == ',') {
12033                 if (maxpos)
12034                     break;
12035                 else
12036                     maxpos = next;
12037             }
12038             next++;
12039         }
12040         if (*next == '}') {             /* got one */
12041             const char* endptr;
12042             if (!maxpos)
12043                 maxpos = next;
12044             RExC_parse++;
12045             if (isDIGIT(*RExC_parse)) {
12046                 endptr = RExC_end;
12047                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
12048                     vFAIL("Invalid quantifier in {,}");
12049                 if (uv >= REG_INFTY)
12050                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12051                 min = (I32)uv;
12052             } else {
12053                 min = 0;
12054             }
12055             if (*maxpos == ',')
12056                 maxpos++;
12057             else
12058                 maxpos = RExC_parse;
12059             if (isDIGIT(*maxpos)) {
12060                 endptr = RExC_end;
12061                 if (!grok_atoUV(maxpos, &uv, &endptr))
12062                     vFAIL("Invalid quantifier in {,}");
12063                 if (uv >= REG_INFTY)
12064                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12065                 max = (I32)uv;
12066             } else {
12067                 max = REG_INFTY;                /* meaning "infinity" */
12068             }
12069             RExC_parse = next;
12070             nextchar(pRExC_state);
12071             if (max < min) {    /* If can't match, warn and optimize to fail
12072                                    unconditionally */
12073                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
12074                 if (PASS2) {
12075                     ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
12076                     NEXT_OFF(orig_emit)= regarglen[OPFAIL] + NODE_STEP_REGNODE;
12077                 }
12078                 return ret;
12079             }
12080             else if (min == max && *RExC_parse == '?')
12081             {
12082                 if (PASS2) {
12083                     ckWARN2reg(RExC_parse + 1,
12084                                "Useless use of greediness modifier '%c'",
12085                                *RExC_parse);
12086                 }
12087             }
12088
12089           do_curly:
12090             if ((flags&SIMPLE)) {
12091                 if (min == 0 && max == REG_INFTY) {
12092                     reginsert(pRExC_state, STAR, ret, depth+1);
12093                     MARK_NAUGHTY(4);
12094                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12095                     goto nest_check;
12096                 }
12097                 if (min == 1 && max == REG_INFTY) {
12098                     reginsert(pRExC_state, PLUS, ret, depth+1);
12099                     MARK_NAUGHTY(3);
12100                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12101                     goto nest_check;
12102                 }
12103                 MARK_NAUGHTY_EXP(2, 2);
12104                 reginsert(pRExC_state, CURLY, ret, depth+1);
12105                 Set_Node_Offset(ret, parse_start+1); /* MJD */
12106                 Set_Node_Cur_Length(ret, parse_start);
12107             }
12108             else {
12109                 regnode * const w = reg_node(pRExC_state, WHILEM);
12110
12111                 w->flags = 0;
12112                 REGTAIL(pRExC_state, ret, w);
12113                 if (!SIZE_ONLY && RExC_extralen) {
12114                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
12115                     reginsert(pRExC_state, NOTHING,ret, depth+1);
12116                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
12117                 }
12118                 reginsert(pRExC_state, CURLYX,ret, depth+1);
12119                                 /* MJD hk */
12120                 Set_Node_Offset(ret, parse_start+1);
12121                 Set_Node_Length(ret,
12122                                 op == '{' ? (RExC_parse - parse_start) : 1);
12123
12124                 if (!SIZE_ONLY && RExC_extralen)
12125                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
12126                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
12127                 if (SIZE_ONLY)
12128                     RExC_whilem_seen++, RExC_extralen += 3;
12129                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
12130             }
12131             ret->flags = 0;
12132
12133             if (min > 0)
12134                 *flagp = WORST;
12135             if (max > 0)
12136                 *flagp |= HASWIDTH;
12137             if (!SIZE_ONLY) {
12138                 ARG1_SET(ret, (U16)min);
12139                 ARG2_SET(ret, (U16)max);
12140             }
12141             if (max == REG_INFTY)
12142                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12143
12144             goto nest_check;
12145         }
12146     }
12147
12148     if (!ISMULT1(op)) {
12149         *flagp = flags;
12150         return(ret);
12151     }
12152
12153 #if 0                           /* Now runtime fix should be reliable. */
12154
12155     /* if this is reinstated, don't forget to put this back into perldiag:
12156
12157             =item Regexp *+ operand could be empty at {#} in regex m/%s/
12158
12159            (F) The part of the regexp subject to either the * or + quantifier
12160            could match an empty string. The {#} shows in the regular
12161            expression about where the problem was discovered.
12162
12163     */
12164
12165     if (!(flags&HASWIDTH) && op != '?')
12166       vFAIL("Regexp *+ operand could be empty");
12167 #endif
12168
12169 #ifdef RE_TRACK_PATTERN_OFFSETS
12170     parse_start = RExC_parse;
12171 #endif
12172     nextchar(pRExC_state);
12173
12174     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
12175
12176     if (op == '*') {
12177         min = 0;
12178         goto do_curly;
12179     }
12180     else if (op == '+') {
12181         min = 1;
12182         goto do_curly;
12183     }
12184     else if (op == '?') {
12185         min = 0; max = 1;
12186         goto do_curly;
12187     }
12188   nest_check:
12189     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
12190         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
12191         ckWARN2reg(RExC_parse,
12192                    "%" UTF8f " matches null string many times",
12193                    UTF8fARG(UTF, (RExC_parse >= origparse
12194                                  ? RExC_parse - origparse
12195                                  : 0),
12196                    origparse));
12197         (void)ReREFCNT_inc(RExC_rx_sv);
12198     }
12199
12200     if (*RExC_parse == '?') {
12201         nextchar(pRExC_state);
12202         reginsert(pRExC_state, MINMOD, ret, depth+1);
12203         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
12204     }
12205     else if (*RExC_parse == '+') {
12206         regnode *ender;
12207         nextchar(pRExC_state);
12208         ender = reg_node(pRExC_state, SUCCEED);
12209         REGTAIL(pRExC_state, ret, ender);
12210         reginsert(pRExC_state, SUSPEND, ret, depth+1);
12211         ender = reg_node(pRExC_state, TAIL);
12212         REGTAIL(pRExC_state, ret, ender);
12213     }
12214
12215     if (ISMULT2(RExC_parse)) {
12216         RExC_parse++;
12217         vFAIL("Nested quantifiers");
12218     }
12219
12220     return(ret);
12221 }
12222
12223 STATIC bool
12224 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
12225                 regnode ** node_p,
12226                 UV * code_point_p,
12227                 int * cp_count,
12228                 I32 * flagp,
12229                 const bool strict,
12230                 const U32 depth
12231     )
12232 {
12233  /* This routine teases apart the various meanings of \N and returns
12234   * accordingly.  The input parameters constrain which meaning(s) is/are valid
12235   * in the current context.
12236   *
12237   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
12238   *
12239   * If <code_point_p> is not NULL, the context is expecting the result to be a
12240   * single code point.  If this \N instance turns out to a single code point,
12241   * the function returns TRUE and sets *code_point_p to that code point.
12242   *
12243   * If <node_p> is not NULL, the context is expecting the result to be one of
12244   * the things representable by a regnode.  If this \N instance turns out to be
12245   * one such, the function generates the regnode, returns TRUE and sets *node_p
12246   * to point to that regnode.
12247   *
12248   * If this instance of \N isn't legal in any context, this function will
12249   * generate a fatal error and not return.
12250   *
12251   * On input, RExC_parse should point to the first char following the \N at the
12252   * time of the call.  On successful return, RExC_parse will have been updated
12253   * to point to just after the sequence identified by this routine.  Also
12254   * *flagp has been updated as needed.
12255   *
12256   * When there is some problem with the current context and this \N instance,
12257   * the function returns FALSE, without advancing RExC_parse, nor setting
12258   * *node_p, nor *code_point_p, nor *flagp.
12259   *
12260   * If <cp_count> is not NULL, the caller wants to know the length (in code
12261   * points) that this \N sequence matches.  This is set, and the input is
12262   * parsed for errors, even if the function returns FALSE, as detailed below.
12263   *
12264   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
12265   *
12266   * Probably the most common case is for the \N to specify a single code point.
12267   * *cp_count will be set to 1, and *code_point_p will be set to that code
12268   * point.
12269   *
12270   * Another possibility is for the input to be an empty \N{}, which for
12271   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
12272   * will be set to a generated NOTHING node.
12273   *
12274   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
12275   * set to 0. *node_p will be set to a generated REG_ANY node.
12276   *
12277   * The fourth possibility is that \N resolves to a sequence of more than one
12278   * code points.  *cp_count will be set to the number of code points in the
12279   * sequence. *node_p * will be set to a generated node returned by this
12280   * function calling S_reg().
12281   *
12282   * The final possibility is that it is premature to be calling this function;
12283   * that pass1 needs to be restarted.  This can happen when this changes from
12284   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
12285   * latter occurs only when the fourth possibility would otherwise be in
12286   * effect, and is because one of those code points requires the pattern to be
12287   * recompiled as UTF-8.  The function returns FALSE, and sets the
12288   * RESTART_PASS1 and NEED_UTF8 flags in *flagp, as appropriate.  When this
12289   * happens, the caller needs to desist from continuing parsing, and return
12290   * this information to its caller.  This is not set for when there is only one
12291   * code point, as this can be called as part of an ANYOF node, and they can
12292   * store above-Latin1 code points without the pattern having to be in UTF-8.
12293   *
12294   * For non-single-quoted regexes, the tokenizer has resolved character and
12295   * sequence names inside \N{...} into their Unicode values, normalizing the
12296   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
12297   * hex-represented code points in the sequence.  This is done there because
12298   * the names can vary based on what charnames pragma is in scope at the time,
12299   * so we need a way to take a snapshot of what they resolve to at the time of
12300   * the original parse. [perl #56444].
12301   *
12302   * That parsing is skipped for single-quoted regexes, so we may here get
12303   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
12304   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
12305   * is legal and handled here.  The code point is Unicode, and has to be
12306   * translated into the native character set for non-ASCII platforms.
12307   */
12308
12309     char * endbrace;    /* points to '}' following the name */
12310     char* p = RExC_parse; /* Temporary */
12311
12312     SV * substitute_parse = NULL;
12313     char *orig_end;
12314     char *save_start;
12315     I32 flags;
12316     Size_t count = 0;   /* code point count kept internally by this function */
12317
12318     GET_RE_DEBUG_FLAGS_DECL;
12319
12320     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12321
12322     GET_RE_DEBUG_FLAGS;
12323
12324     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12325     assert(! (node_p && cp_count));               /* At most 1 should be set */
12326
12327     if (cp_count) {     /* Initialize return for the most common case */
12328         *cp_count = 1;
12329     }
12330
12331     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12332      * modifier.  The other meanings do not, so use a temporary until we find
12333      * out which we are being called with */
12334     skip_to_be_ignored_text(pRExC_state, &p,
12335                             FALSE /* Don't force to /x */ );
12336
12337     /* Disambiguate between \N meaning a named character versus \N meaning
12338      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12339      * quantifier, or there is no '{' at all */
12340     if (*p != '{' || regcurly(p)) {
12341         RExC_parse = p;
12342         if (cp_count) {
12343             *cp_count = -1;
12344         }
12345
12346         if (! node_p) {
12347             return FALSE;
12348         }
12349
12350         *node_p = reg_node(pRExC_state, REG_ANY);
12351         *flagp |= HASWIDTH|SIMPLE;
12352         MARK_NAUGHTY(1);
12353         Set_Node_Length(*node_p, 1); /* MJD */
12354         return TRUE;
12355     }
12356
12357     /* The test above made sure that the next real character is a '{', but
12358      * under the /x modifier, it could be separated by space (or a comment and
12359      * \n) and this is not allowed (for consistency with \x{...} and the
12360      * tokenizer handling of \N{NAME}). */
12361     if (*RExC_parse != '{') {
12362         vFAIL("Missing braces on \\N{}");
12363     }
12364
12365     RExC_parse++;       /* Skip past the '{' */
12366
12367     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12368     if (! endbrace) { /* no trailing brace */
12369         vFAIL2("Missing right brace on \\%c{}", 'N');
12370     }
12371
12372     /* Here, we have decided it should be a named character or sequence */
12373     REQUIRE_UNI_RULES(flagp, FALSE); /* Unicode named chars imply Unicode
12374                                         semantics */
12375
12376     if (endbrace == RExC_parse) {   /* empty: \N{} */
12377         if (strict) {
12378             RExC_parse++;   /* Position after the "}" */
12379             vFAIL("Zero length \\N{}");
12380         }
12381         if (cp_count) {
12382             *cp_count = 0;
12383         }
12384         nextchar(pRExC_state);
12385         if (! node_p) {
12386             return FALSE;
12387         }
12388
12389         *node_p = reg_node(pRExC_state,NOTHING);
12390         return TRUE;
12391     }
12392
12393     /* If we haven't got something that begins with 'U+', then it didn't get lexed. */
12394     if (   endbrace - RExC_parse < 2
12395         || strnNE(RExC_parse, "U+", 2))
12396     {
12397         RExC_parse = endbrace;  /* position msg's '<--HERE' */
12398         vFAIL("\\N{NAME} must be resolved by the lexer");
12399     }
12400
12401         /* This code purposely indented below because of future changes coming */
12402
12403         /* We can get to here when the input is \N{U+...} or when toke.c has
12404          * converted a name to the \N{U+...} form.  This include changing a
12405          * name that evaluates to multiple code points to \N{U+c1.c2.c3 ...} */
12406
12407         RExC_parse += 2;    /* Skip past the 'U+' */
12408
12409         /* Code points are separated by dots.  The '}' terminates the whole
12410          * thing. */
12411
12412         do {    /* Loop until the ending brace */
12413             UV cp = 0;
12414             char * start_digit;     /* The first of the current code point */
12415             if (! isXDIGIT(*RExC_parse)) {
12416                 RExC_parse++;
12417                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
12418             }
12419
12420             start_digit = RExC_parse;
12421             count++;
12422
12423             /* Loop through the hex digits of the current code point */
12424             do {
12425                 /* Adding this digit will shift the result 4 bits.  If that
12426                  * result would be above the legal max, it's overflow */
12427                 if (cp > MAX_LEGAL_CP >> 4) {
12428
12429                     /* Find the end of the code point */
12430                     do {
12431                         RExC_parse ++;
12432                     } while (isXDIGIT(*RExC_parse) || *RExC_parse == '_');
12433
12434                     /* Be sure to synchronize this message with the similar one
12435                      * in utf8.c */
12436                     vFAIL4("Use of code point 0x%.*s is not allowed; the"
12437                         " permissible max is 0x%" UVxf,
12438                         (int) (RExC_parse - start_digit), start_digit,
12439                         MAX_LEGAL_CP);
12440                 }
12441
12442                 /* Accumulate this (valid) digit into the running total */
12443                 cp  = (cp << 4) + READ_XDIGIT(RExC_parse);
12444
12445                 /* READ_XDIGIT advanced the input pointer.  Ignore a single
12446                  * underscore separator */
12447                 if (*RExC_parse == '_' && isXDIGIT(RExC_parse[1])) {
12448                     RExC_parse++;
12449                 }
12450             } while (isXDIGIT(*RExC_parse));
12451
12452             /* Here, have accumulated the next code point */
12453             if (RExC_parse >= endbrace) {   /* If done ... */
12454                 if (count != 1) {
12455                     goto do_concat;
12456                 }
12457
12458                 /* Here, is a single code point; fail if doesn't want that */
12459                 if (! code_point_p) {
12460                     RExC_parse = p;
12461                     return FALSE;
12462                 }
12463
12464                 /* A single code point is easy to handle; just return it */
12465                 *code_point_p = UNI_TO_NATIVE(cp);
12466                 RExC_parse = endbrace;
12467                 nextchar(pRExC_state);
12468                 return TRUE;
12469             }
12470
12471             /* Here, the only legal thing would be a multiple character
12472              * sequence (of the form "\N{U+c1.c2. ... }".   So the next
12473              * character must be a dot (and the one after that can't be the
12474              * endbrace, or we'd have something like \N{U+100.} ) */
12475             if (*RExC_parse != '.' || RExC_parse + 1 >= endbrace) {
12476                 RExC_parse += (RExC_orig_utf8)  /* point to after 1st invalid */
12477                                 ? UTF8SKIP(RExC_parse)
12478                                 : 1;
12479                 if (RExC_parse >= endbrace) { /* Guard against malformed utf8 */
12480                     RExC_parse = endbrace;
12481                 }
12482                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
12483             }
12484
12485             /* Here, looks like its really a multiple character sequence.  Fail
12486              * if that's not what the caller wants.  But continue with counting
12487              * and error checking if they still want a count */
12488             if (! node_p && ! cp_count) {
12489                 return FALSE;
12490             }
12491
12492             /* What is done here is to convert this to a sub-pattern of the
12493              * form \x{char1}\x{char2}...  and then call reg recursively to
12494              * parse it (enclosing in "(?: ... )" ).  That way, it retains its
12495              * atomicness, while not having to worry about special handling
12496              * that some code points may have.  We don't create a subpattern,
12497              * but go through the motions of code point counting and error
12498              * checking, if the caller doesn't want a node returned. */
12499
12500             if (node_p && count == 1) {
12501                 substitute_parse = newSVpvs("?:");
12502             }
12503
12504           do_concat:
12505
12506             if (node_p) {
12507                 /* Convert to notation the rest of the code understands */
12508                 sv_catpvs(substitute_parse, "\\x{");
12509                 sv_catpvn(substitute_parse, start_digit,
12510                                             RExC_parse - start_digit);
12511                 sv_catpvs(substitute_parse, "}");
12512             }
12513
12514             /* Move to after the dot (or ending brace the final time through.)
12515              * */
12516             RExC_parse++;
12517             count++;
12518
12519         } while (RExC_parse < endbrace);
12520
12521         if (! node_p) { /* Doesn't want the node */
12522             assert (cp_count);
12523
12524             *cp_count = count;
12525             return FALSE;
12526         }
12527
12528         sv_catpvs(substitute_parse, ")");
12529
12530 #ifdef EBCDIC
12531         /* The values are Unicode, and therefore have to be converted to native
12532          * on a non-Unicode (meaning non-ASCII) platform. */
12533         RExC_recode_x_to_native = 1;
12534 #endif
12535
12536     /* Here, we have the string the name evaluates to, ready to be parsed,
12537      * stored in 'substitute_parse' as a series of valid "\x{...}\x{...}"
12538      * constructs.  This can be called from within a substitute parse already.
12539      * The error reporting mechanism doesn't work for 2 levels of this, but the
12540      * code above has validated this new construct, so there should be no
12541      * errors generated by the below.*/
12542     save_start = RExC_start;
12543     orig_end = RExC_end;
12544
12545     RExC_parse = RExC_start = SvPVX(substitute_parse);
12546     RExC_end = RExC_parse + SvCUR(substitute_parse);
12547
12548     *node_p = reg(pRExC_state, 1, &flags, depth+1);
12549
12550     /* Restore the saved values */
12551     RExC_start = save_start;
12552     RExC_parse = endbrace;
12553     RExC_end = orig_end;
12554 #ifdef EBCDIC
12555     RExC_recode_x_to_native = 0;
12556 #endif
12557
12558     SvREFCNT_dec_NN(substitute_parse);
12559
12560     if (! *node_p) {
12561         RETURN_X_ON_RESTART(FALSE, flags,flagp);
12562         FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#" UVxf,
12563             (UV) flags);
12564     }
12565     *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12566
12567     nextchar(pRExC_state);
12568
12569     return TRUE;
12570 }
12571
12572
12573 PERL_STATIC_INLINE U8
12574 S_compute_EXACTish(RExC_state_t *pRExC_state)
12575 {
12576     U8 op;
12577
12578     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
12579
12580     if (! FOLD) {
12581         return (LOC)
12582                 ? EXACTL
12583                 : EXACT;
12584     }
12585
12586     op = get_regex_charset(RExC_flags);
12587     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
12588         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
12589                  been, so there is no hole */
12590     }
12591
12592     return op + EXACTF;
12593 }
12594
12595 PERL_STATIC_INLINE void
12596 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
12597                          regnode *node, I32* flagp, STRLEN len, UV code_point,
12598                          bool downgradable)
12599 {
12600     /* This knows the details about sizing an EXACTish node, setting flags for
12601      * it (by setting <*flagp>, and potentially populating it with a single
12602      * character.
12603      *
12604      * If <len> (the length in bytes) is non-zero, this function assumes that
12605      * the node has already been populated, and just does the sizing.  In this
12606      * case <code_point> should be the final code point that has already been
12607      * placed into the node.  This value will be ignored except that under some
12608      * circumstances <*flagp> is set based on it.
12609      *
12610      * If <len> is zero, the function assumes that the node is to contain only
12611      * the single character given by <code_point> and calculates what <len>
12612      * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
12613      * additionally will populate the node's STRING with <code_point> or its
12614      * fold if folding.
12615      *
12616      * In both cases <*flagp> is appropriately set
12617      *
12618      * It knows that under FOLD, the Latin Sharp S and UTF characters above
12619      * 255, must be folded (the former only when the rules indicate it can
12620      * match 'ss')
12621      *
12622      * When it does the populating, it looks at the flag 'downgradable'.  If
12623      * true with a node that folds, it checks if the single code point
12624      * participates in a fold, and if not downgrades the node to an EXACT.
12625      * This helps the optimizer */
12626
12627     bool len_passed_in = cBOOL(len != 0);
12628     U8 character[UTF8_MAXBYTES_CASE+1];
12629
12630     PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
12631
12632     /* Don't bother to check for downgrading in PASS1, as it doesn't make any
12633      * sizing difference, and is extra work that is thrown away */
12634     if (downgradable && ! PASS2) {
12635         downgradable = FALSE;
12636     }
12637
12638     if (! len_passed_in) {
12639         if (UTF) {
12640             if (UVCHR_IS_INVARIANT(code_point)) {
12641                 if (LOC || ! FOLD) {    /* /l defers folding until runtime */
12642                     *character = (U8) code_point;
12643                 }
12644                 else { /* Here is /i and not /l. (toFOLD() is defined on just
12645                           ASCII, which isn't the same thing as INVARIANT on
12646                           EBCDIC, but it works there, as the extra invariants
12647                           fold to themselves) */
12648                     *character = toFOLD((U8) code_point);
12649
12650                     /* We can downgrade to an EXACT node if this character
12651                      * isn't a folding one.  Note that this assumes that
12652                      * nothing above Latin1 folds to some other invariant than
12653                      * one of these alphabetics; otherwise we would also have
12654                      * to check:
12655                      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12656                      *      || ASCII_FOLD_RESTRICTED))
12657                      */
12658                     if (downgradable && PL_fold[code_point] == code_point) {
12659                         OP(node) = EXACT;
12660                     }
12661                 }
12662                 len = 1;
12663             }
12664             else if (FOLD && (! LOC
12665                               || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
12666             {   /* Folding, and ok to do so now */
12667                 UV folded = _to_uni_fold_flags(
12668                                    code_point,
12669                                    character,
12670                                    &len,
12671                                    FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12672                                                       ? FOLD_FLAGS_NOMIX_ASCII
12673                                                       : 0));
12674                 if (downgradable
12675                     && folded == code_point /* This quickly rules out many
12676                                                cases, avoiding the
12677                                                _invlist_contains_cp() overhead
12678                                                for those.  */
12679                     && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
12680                 {
12681                     OP(node) = (LOC)
12682                                ? EXACTL
12683                                : EXACT;
12684                 }
12685             }
12686             else if (code_point <= MAX_UTF8_TWO_BYTE) {
12687
12688                 /* Not folding this cp, and can output it directly */
12689                 *character = UTF8_TWO_BYTE_HI(code_point);
12690                 *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
12691                 len = 2;
12692             }
12693             else {
12694                 uvchr_to_utf8( character, code_point);
12695                 len = UTF8SKIP(character);
12696             }
12697         } /* Else pattern isn't UTF8.  */
12698         else if (! FOLD) {
12699             *character = (U8) code_point;
12700             len = 1;
12701         } /* Else is folded non-UTF8 */
12702 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12703    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12704                                       || UNICODE_DOT_DOT_VERSION > 0)
12705         else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
12706 #else
12707         else if (1) {
12708 #endif
12709             /* We don't fold any non-UTF8 except possibly the Sharp s  (see
12710              * comments at join_exact()); */
12711             *character = (U8) code_point;
12712             len = 1;
12713
12714             /* Can turn into an EXACT node if we know the fold at compile time,
12715              * and it folds to itself and doesn't particpate in other folds */
12716             if (downgradable
12717                 && ! LOC
12718                 && PL_fold_latin1[code_point] == code_point
12719                 && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
12720                     || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
12721             {
12722                 OP(node) = EXACT;
12723             }
12724         } /* else is Sharp s.  May need to fold it */
12725         else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
12726             *character = 's';
12727             *(character + 1) = 's';
12728             len = 2;
12729         }
12730         else {
12731             *character = LATIN_SMALL_LETTER_SHARP_S;
12732             len = 1;
12733         }
12734     }
12735
12736     if (SIZE_ONLY) {
12737         RExC_size += STR_SZ(len);
12738     }
12739     else {
12740         RExC_emit += STR_SZ(len);
12741         STR_LEN(node) = len;
12742         if (! len_passed_in) {
12743             Copy((char *) character, STRING(node), len, char);
12744         }
12745     }
12746
12747     *flagp |= HASWIDTH;
12748
12749     /* A single character node is SIMPLE, except for the special-cased SHARP S
12750      * under /di. */
12751     if ((len == 1 || (UTF && len == UVCHR_SKIP(code_point)))
12752 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
12753    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
12754                                       || UNICODE_DOT_DOT_VERSION > 0)
12755         && ( code_point != LATIN_SMALL_LETTER_SHARP_S
12756             || ! FOLD || ! DEPENDS_SEMANTICS)
12757 #endif
12758     ) {
12759         *flagp |= SIMPLE;
12760     }
12761
12762     /* The OP may not be well defined in PASS1 */
12763     if (PASS2 && OP(node) == EXACTFL) {
12764         RExC_contains_locale = 1;
12765     }
12766 }
12767
12768 STATIC bool
12769 S_new_regcurly(const char *s, const char *e)
12770 {
12771     /* This is a temporary function designed to match the most lenient form of
12772      * a {m,n} quantifier we ever envision, with either number omitted, and
12773      * spaces anywhere between/before/after them.
12774      *
12775      * If this function fails, then the string it matches is very unlikely to
12776      * ever be considered a valid quantifier, so we can allow the '{' that
12777      * begins it to be considered as a literal */
12778
12779     bool has_min = FALSE;
12780     bool has_max = FALSE;
12781
12782     PERL_ARGS_ASSERT_NEW_REGCURLY;
12783
12784     if (s >= e || *s++ != '{')
12785         return FALSE;
12786
12787     while (s < e && isSPACE(*s)) {
12788         s++;
12789     }
12790     while (s < e && isDIGIT(*s)) {
12791         has_min = TRUE;
12792         s++;
12793     }
12794     while (s < e && isSPACE(*s)) {
12795         s++;
12796     }
12797
12798     if (*s == ',') {
12799         s++;
12800         while (s < e && isSPACE(*s)) {
12801             s++;
12802         }
12803         while (s < e && isDIGIT(*s)) {
12804             has_max = TRUE;
12805             s++;
12806         }
12807         while (s < e && isSPACE(*s)) {
12808             s++;
12809         }
12810     }
12811
12812     return s < e && *s == '}' && (has_min || has_max);
12813 }
12814
12815 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
12816  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
12817
12818 static I32
12819 S_backref_value(char *p, char *e)
12820 {
12821     const char* endptr = e;
12822     UV val;
12823     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
12824         return (I32)val;
12825     return I32_MAX;
12826 }
12827
12828
12829 /*
12830  - regatom - the lowest level
12831
12832    Try to identify anything special at the start of the current parse position.
12833    If there is, then handle it as required. This may involve generating a
12834    single regop, such as for an assertion; or it may involve recursing, such as
12835    to handle a () structure.
12836
12837    If the string doesn't start with something special then we gobble up
12838    as much literal text as we can.  If we encounter a quantifier, we have to
12839    back off the final literal character, as that quantifier applies to just it
12840    and not to the whole string of literals.
12841
12842    Once we have been able to handle whatever type of thing started the
12843    sequence, we return.
12844
12845    Note: we have to be careful with escapes, as they can be both literal
12846    and special, and in the case of \10 and friends, context determines which.
12847
12848    A summary of the code structure is:
12849
12850    switch (first_byte) {
12851         cases for each special:
12852             handle this special;
12853             break;
12854         case '\\':
12855             switch (2nd byte) {
12856                 cases for each unambiguous special:
12857                     handle this special;
12858                     break;
12859                 cases for each ambigous special/literal:
12860                     disambiguate;
12861                     if (special)  handle here
12862                     else goto defchar;
12863                 default: // unambiguously literal:
12864                     goto defchar;
12865             }
12866         default:  // is a literal char
12867             // FALL THROUGH
12868         defchar:
12869             create EXACTish node for literal;
12870             while (more input and node isn't full) {
12871                 switch (input_byte) {
12872                    cases for each special;
12873                        make sure parse pointer is set so that the next call to
12874                            regatom will see this special first
12875                        goto loopdone; // EXACTish node terminated by prev. char
12876                    default:
12877                        append char to EXACTISH node;
12878                 }
12879                 get next input byte;
12880             }
12881         loopdone:
12882    }
12883    return the generated node;
12884
12885    Specifically there are two separate switches for handling
12886    escape sequences, with the one for handling literal escapes requiring
12887    a dummy entry for all of the special escapes that are actually handled
12888    by the other.
12889
12890    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
12891    TRYAGAIN.
12892    Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs to be
12893    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
12894    Otherwise does not return NULL.
12895 */
12896
12897 STATIC regnode *
12898 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12899 {
12900     regnode *ret = NULL;
12901     I32 flags = 0;
12902     char *parse_start;
12903     U8 op;
12904     int invert = 0;
12905     U8 arg;
12906
12907     GET_RE_DEBUG_FLAGS_DECL;
12908
12909     *flagp = WORST;             /* Tentatively. */
12910
12911     DEBUG_PARSE("atom");
12912
12913     PERL_ARGS_ASSERT_REGATOM;
12914
12915   tryagain:
12916     parse_start = RExC_parse;
12917     assert(RExC_parse < RExC_end);
12918     switch ((U8)*RExC_parse) {
12919     case '^':
12920         RExC_seen_zerolen++;
12921         nextchar(pRExC_state);
12922         if (RExC_flags & RXf_PMf_MULTILINE)
12923             ret = reg_node(pRExC_state, MBOL);
12924         else
12925             ret = reg_node(pRExC_state, SBOL);
12926         Set_Node_Length(ret, 1); /* MJD */
12927         break;
12928     case '$':
12929         nextchar(pRExC_state);
12930         if (*RExC_parse)
12931             RExC_seen_zerolen++;
12932         if (RExC_flags & RXf_PMf_MULTILINE)
12933             ret = reg_node(pRExC_state, MEOL);
12934         else
12935             ret = reg_node(pRExC_state, SEOL);
12936         Set_Node_Length(ret, 1); /* MJD */
12937         break;
12938     case '.':
12939         nextchar(pRExC_state);
12940         if (RExC_flags & RXf_PMf_SINGLELINE)
12941             ret = reg_node(pRExC_state, SANY);
12942         else
12943             ret = reg_node(pRExC_state, REG_ANY);
12944         *flagp |= HASWIDTH|SIMPLE;
12945         MARK_NAUGHTY(1);
12946         Set_Node_Length(ret, 1); /* MJD */
12947         break;
12948     case '[':
12949     {
12950         char * const oregcomp_parse = ++RExC_parse;
12951         ret = regclass(pRExC_state, flagp,depth+1,
12952                        FALSE, /* means parse the whole char class */
12953                        TRUE, /* allow multi-char folds */
12954                        FALSE, /* don't silence non-portable warnings. */
12955                        (bool) RExC_strict,
12956                        TRUE, /* Allow an optimized regnode result */
12957                        NULL,
12958                        NULL);
12959         if (ret == NULL) {
12960             RETURN_NULL_ON_RESTART_FLAGP_OR_FLAGS(flagp,NEED_UTF8);
12961             FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
12962                   (UV) *flagp);
12963         }
12964         if (*RExC_parse != ']') {
12965             RExC_parse = oregcomp_parse;
12966             vFAIL("Unmatched [");
12967         }
12968         nextchar(pRExC_state);
12969         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
12970         break;
12971     }
12972     case '(':
12973         nextchar(pRExC_state);
12974         ret = reg(pRExC_state, 2, &flags,depth+1);
12975         if (ret == NULL) {
12976                 if (flags & TRYAGAIN) {
12977                     if (RExC_parse >= RExC_end) {
12978                          /* Make parent create an empty node if needed. */
12979                         *flagp |= TRYAGAIN;
12980                         return(NULL);
12981                     }
12982                     goto tryagain;
12983                 }
12984                 RETURN_NULL_ON_RESTART(flags,flagp);
12985                 FAIL2("panic: reg returned NULL to regatom, flags=%#" UVxf,
12986                                                                  (UV) flags);
12987         }
12988         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
12989         break;
12990     case '|':
12991     case ')':
12992         if (flags & TRYAGAIN) {
12993             *flagp |= TRYAGAIN;
12994             return NULL;
12995         }
12996         vFAIL("Internal urp");
12997                                 /* Supposed to be caught earlier. */
12998         break;
12999     case '?':
13000     case '+':
13001     case '*':
13002         RExC_parse++;
13003         vFAIL("Quantifier follows nothing");
13004         break;
13005     case '\\':
13006         /* Special Escapes
13007
13008            This switch handles escape sequences that resolve to some kind
13009            of special regop and not to literal text. Escape sequnces that
13010            resolve to literal text are handled below in the switch marked
13011            "Literal Escapes".
13012
13013            Every entry in this switch *must* have a corresponding entry
13014            in the literal escape switch. However, the opposite is not
13015            required, as the default for this switch is to jump to the
13016            literal text handling code.
13017         */
13018         RExC_parse++;
13019         switch ((U8)*RExC_parse) {
13020         /* Special Escapes */
13021         case 'A':
13022             RExC_seen_zerolen++;
13023             ret = reg_node(pRExC_state, SBOL);
13024             /* SBOL is shared with /^/ so we set the flags so we can tell
13025              * /\A/ from /^/ in split. We check ret because first pass we
13026              * have no regop struct to set the flags on. */
13027             if (PASS2)
13028                 ret->flags = 1;
13029             *flagp |= SIMPLE;
13030             goto finish_meta_pat;
13031         case 'G':
13032             ret = reg_node(pRExC_state, GPOS);
13033             RExC_seen |= REG_GPOS_SEEN;
13034             *flagp |= SIMPLE;
13035             goto finish_meta_pat;
13036         case 'K':
13037             RExC_seen_zerolen++;
13038             ret = reg_node(pRExC_state, KEEPS);
13039             *flagp |= SIMPLE;
13040             /* XXX:dmq : disabling in-place substitution seems to
13041              * be necessary here to avoid cases of memory corruption, as
13042              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
13043              */
13044             RExC_seen |= REG_LOOKBEHIND_SEEN;
13045             goto finish_meta_pat;
13046         case 'Z':
13047             ret = reg_node(pRExC_state, SEOL);
13048             *flagp |= SIMPLE;
13049             RExC_seen_zerolen++;                /* Do not optimize RE away */
13050             goto finish_meta_pat;
13051         case 'z':
13052             ret = reg_node(pRExC_state, EOS);
13053             *flagp |= SIMPLE;
13054             RExC_seen_zerolen++;                /* Do not optimize RE away */
13055             goto finish_meta_pat;
13056         case 'C':
13057             vFAIL("\\C no longer supported");
13058         case 'X':
13059             ret = reg_node(pRExC_state, CLUMP);
13060             *flagp |= HASWIDTH;
13061             goto finish_meta_pat;
13062
13063         case 'W':
13064             invert = 1;
13065             /* FALLTHROUGH */
13066         case 'w':
13067             arg = ANYOF_WORDCHAR;
13068             goto join_posix;
13069
13070         case 'B':
13071             invert = 1;
13072             /* FALLTHROUGH */
13073         case 'b':
13074           {
13075             regex_charset charset = get_regex_charset(RExC_flags);
13076
13077             RExC_seen_zerolen++;
13078             RExC_seen |= REG_LOOKBEHIND_SEEN;
13079             op = BOUND + charset;
13080
13081             if (op == BOUNDL) {
13082                 RExC_contains_locale = 1;
13083             }
13084
13085             ret = reg_node(pRExC_state, op);
13086             *flagp |= SIMPLE;
13087             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
13088                 FLAGS(ret) = TRADITIONAL_BOUND;
13089                 if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
13090                     OP(ret) = BOUNDA;
13091                 }
13092             }
13093             else {
13094                 STRLEN length;
13095                 char name = *RExC_parse;
13096                 char * endbrace = NULL;
13097                 RExC_parse += 2;
13098                 if (RExC_parse < RExC_end) {
13099                     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
13100                 }
13101
13102                 if (! endbrace) {
13103                     vFAIL2("Missing right brace on \\%c{}", name);
13104                 }
13105                 /* XXX Need to decide whether to take spaces or not.  Should be
13106                  * consistent with \p{}, but that currently is SPACE, which
13107                  * means vertical too, which seems wrong
13108                  * while (isBLANK(*RExC_parse)) {
13109                     RExC_parse++;
13110                 }*/
13111                 if (endbrace == RExC_parse) {
13112                     RExC_parse++;  /* After the '}' */
13113                     vFAIL2("Empty \\%c{}", name);
13114                 }
13115                 length = endbrace - RExC_parse;
13116                 /*while (isBLANK(*(RExC_parse + length - 1))) {
13117                     length--;
13118                 }*/
13119                 switch (*RExC_parse) {
13120                     case 'g':
13121                         if (    length != 1
13122                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
13123                         {
13124                             goto bad_bound_type;
13125                         }
13126                         FLAGS(ret) = GCB_BOUND;
13127                         break;
13128                     case 'l':
13129                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13130                             goto bad_bound_type;
13131                         }
13132                         FLAGS(ret) = LB_BOUND;
13133                         break;
13134                     case 's':
13135                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13136                             goto bad_bound_type;
13137                         }
13138                         FLAGS(ret) = SB_BOUND;
13139                         break;
13140                     case 'w':
13141                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13142                             goto bad_bound_type;
13143                         }
13144                         FLAGS(ret) = WB_BOUND;
13145                         break;
13146                     default:
13147                       bad_bound_type:
13148                         RExC_parse = endbrace;
13149                         vFAIL2utf8f(
13150                             "'%" UTF8f "' is an unknown bound type",
13151                             UTF8fARG(UTF, length, endbrace - length));
13152                         NOT_REACHED; /*NOTREACHED*/
13153                 }
13154                 RExC_parse = endbrace;
13155                 REQUIRE_UNI_RULES(flagp, NULL);
13156
13157                 if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
13158                     OP(ret) = BOUNDU;
13159                     length += 4;
13160
13161                     /* Don't have to worry about UTF-8, in this message because
13162                      * to get here the contents of the \b must be ASCII */
13163                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
13164                               "Using /u for '%.*s' instead of /%s",
13165                               (unsigned) length,
13166                               endbrace - length + 1,
13167                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
13168                               ? ASCII_RESTRICT_PAT_MODS
13169                               : ASCII_MORE_RESTRICT_PAT_MODS);
13170                 }
13171             }
13172
13173             if (PASS2 && invert) {
13174                 OP(ret) += NBOUND - BOUND;
13175             }
13176             goto finish_meta_pat;
13177           }
13178
13179         case 'D':
13180             invert = 1;
13181             /* FALLTHROUGH */
13182         case 'd':
13183             arg = ANYOF_DIGIT;
13184             if (! DEPENDS_SEMANTICS) {
13185                 goto join_posix;
13186             }
13187
13188             /* \d doesn't have any matches in the upper Latin1 range, hence /d
13189              * is equivalent to /u.  Changing to /u saves some branches at
13190              * runtime */
13191             op = POSIXU;
13192             goto join_posix_op_known;
13193
13194         case 'R':
13195             ret = reg_node(pRExC_state, LNBREAK);
13196             *flagp |= HASWIDTH|SIMPLE;
13197             goto finish_meta_pat;
13198
13199         case 'H':
13200             invert = 1;
13201             /* FALLTHROUGH */
13202         case 'h':
13203             arg = ANYOF_BLANK;
13204             op = POSIXU;
13205             goto join_posix_op_known;
13206
13207         case 'V':
13208             invert = 1;
13209             /* FALLTHROUGH */
13210         case 'v':
13211             arg = ANYOF_VERTWS;
13212             op = POSIXU;
13213             goto join_posix_op_known;
13214
13215         case 'S':
13216             invert = 1;
13217             /* FALLTHROUGH */
13218         case 's':
13219             arg = ANYOF_SPACE;
13220
13221           join_posix:
13222
13223             op = POSIXD + get_regex_charset(RExC_flags);
13224             if (op > POSIXA) {  /* /aa is same as /a */
13225                 op = POSIXA;
13226             }
13227             else if (op == POSIXL) {
13228                 RExC_contains_locale = 1;
13229             }
13230
13231           join_posix_op_known:
13232
13233             if (invert) {
13234                 op += NPOSIXD - POSIXD;
13235             }
13236
13237             ret = reg_node(pRExC_state, op);
13238             if (! SIZE_ONLY) {
13239                 FLAGS(ret) = namedclass_to_classnum(arg);
13240             }
13241
13242             *flagp |= HASWIDTH|SIMPLE;
13243             /* FALLTHROUGH */
13244
13245           finish_meta_pat:
13246             if (   UCHARAT(RExC_parse + 1) == '{'
13247                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
13248             {
13249                 RExC_parse += 2;
13250                 vFAIL("Unescaped left brace in regex is illegal here");
13251             }
13252             nextchar(pRExC_state);
13253             Set_Node_Length(ret, 2); /* MJD */
13254             break;
13255         case 'p':
13256         case 'P':
13257             RExC_parse--;
13258
13259             ret = regclass(pRExC_state, flagp,depth+1,
13260                            TRUE, /* means just parse this element */
13261                            FALSE, /* don't allow multi-char folds */
13262                            FALSE, /* don't silence non-portable warnings.  It
13263                                      would be a bug if these returned
13264                                      non-portables */
13265                            (bool) RExC_strict,
13266                            TRUE, /* Allow an optimized regnode result */
13267                            NULL,
13268                            NULL);
13269             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13270             /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
13271              * multi-char folds are allowed.  */
13272             if (!ret)
13273                 FAIL2("panic: regclass returned NULL to regatom, flags=%#" UVxf,
13274                       (UV) *flagp);
13275
13276             RExC_parse--;
13277
13278             Set_Node_Offset(ret, parse_start);
13279             Set_Node_Cur_Length(ret, parse_start - 2);
13280             nextchar(pRExC_state);
13281             break;
13282         case 'N':
13283             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
13284              * \N{...} evaluates to a sequence of more than one code points).
13285              * The function call below returns a regnode, which is our result.
13286              * The parameters cause it to fail if the \N{} evaluates to a
13287              * single code point; we handle those like any other literal.  The
13288              * reason that the multicharacter case is handled here and not as
13289              * part of the EXACtish code is because of quantifiers.  In
13290              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
13291              * this way makes that Just Happen. dmq.
13292              * join_exact() will join this up with adjacent EXACTish nodes
13293              * later on, if appropriate. */
13294             ++RExC_parse;
13295             if (grok_bslash_N(pRExC_state,
13296                               &ret,     /* Want a regnode returned */
13297                               NULL,     /* Fail if evaluates to a single code
13298                                            point */
13299                               NULL,     /* Don't need a count of how many code
13300                                            points */
13301                               flagp,
13302                               RExC_strict,
13303                               depth)
13304             ) {
13305                 break;
13306             }
13307
13308             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13309
13310             /* Here, evaluates to a single code point.  Go get that */
13311             RExC_parse = parse_start;
13312             goto defchar;
13313
13314         case 'k':    /* Handle \k<NAME> and \k'NAME' */
13315       parse_named_seq:
13316         {
13317             char ch;
13318             if (   RExC_parse >= RExC_end - 1
13319                 || ((   ch = RExC_parse[1]) != '<'
13320                                       && ch != '\''
13321                                       && ch != '{'))
13322             {
13323                 RExC_parse++;
13324                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13325                 vFAIL2("Sequence %.2s... not terminated",parse_start);
13326             } else {
13327                 RExC_parse += 2;
13328                 ret = handle_named_backref(pRExC_state,
13329                                            flagp,
13330                                            parse_start,
13331                                            (ch == '<')
13332                                            ? '>'
13333                                            : (ch == '{')
13334                                              ? '}'
13335                                              : '\'');
13336             }
13337             break;
13338         }
13339         case 'g':
13340         case '1': case '2': case '3': case '4':
13341         case '5': case '6': case '7': case '8': case '9':
13342             {
13343                 I32 num;
13344                 bool hasbrace = 0;
13345
13346                 if (*RExC_parse == 'g') {
13347                     bool isrel = 0;
13348
13349                     RExC_parse++;
13350                     if (*RExC_parse == '{') {
13351                         RExC_parse++;
13352                         hasbrace = 1;
13353                     }
13354                     if (*RExC_parse == '-') {
13355                         RExC_parse++;
13356                         isrel = 1;
13357                     }
13358                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13359                         if (isrel) RExC_parse--;
13360                         RExC_parse -= 2;
13361                         goto parse_named_seq;
13362                     }
13363
13364                     if (RExC_parse >= RExC_end) {
13365                         goto unterminated_g;
13366                     }
13367                     num = S_backref_value(RExC_parse, RExC_end);
13368                     if (num == 0)
13369                         vFAIL("Reference to invalid group 0");
13370                     else if (num == I32_MAX) {
13371                          if (isDIGIT(*RExC_parse))
13372                             vFAIL("Reference to nonexistent group");
13373                         else
13374                           unterminated_g:
13375                             vFAIL("Unterminated \\g... pattern");
13376                     }
13377
13378                     if (isrel) {
13379                         num = RExC_npar - num;
13380                         if (num < 1)
13381                             vFAIL("Reference to nonexistent or unclosed group");
13382                     }
13383                 }
13384                 else {
13385                     num = S_backref_value(RExC_parse, RExC_end);
13386                     /* bare \NNN might be backref or octal - if it is larger
13387                      * than or equal RExC_npar then it is assumed to be an
13388                      * octal escape. Note RExC_npar is +1 from the actual
13389                      * number of parens. */
13390                     /* Note we do NOT check if num == I32_MAX here, as that is
13391                      * handled by the RExC_npar check */
13392
13393                     if (
13394                         /* any numeric escape < 10 is always a backref */
13395                         num > 9
13396                         /* any numeric escape < RExC_npar is a backref */
13397                         && num >= RExC_npar
13398                         /* cannot be an octal escape if it starts with 8 */
13399                         && *RExC_parse != '8'
13400                         /* cannot be an octal escape it it starts with 9 */
13401                         && *RExC_parse != '9'
13402                     )
13403                     {
13404                         /* Probably not a backref, instead likely to be an
13405                          * octal character escape, e.g. \35 or \777.
13406                          * The above logic should make it obvious why using
13407                          * octal escapes in patterns is problematic. - Yves */
13408                         RExC_parse = parse_start;
13409                         goto defchar;
13410                     }
13411                 }
13412
13413                 /* At this point RExC_parse points at a numeric escape like
13414                  * \12 or \88 or something similar, which we should NOT treat
13415                  * as an octal escape. It may or may not be a valid backref
13416                  * escape. For instance \88888888 is unlikely to be a valid
13417                  * backref. */
13418                 while (isDIGIT(*RExC_parse))
13419                     RExC_parse++;
13420                 if (hasbrace) {
13421                     if (*RExC_parse != '}')
13422                         vFAIL("Unterminated \\g{...} pattern");
13423                     RExC_parse++;
13424                 }
13425                 if (!SIZE_ONLY) {
13426                     if (num > (I32)RExC_rx->nparens)
13427                         vFAIL("Reference to nonexistent group");
13428                 }
13429                 RExC_sawback = 1;
13430                 ret = reganode(pRExC_state,
13431                                ((! FOLD)
13432                                  ? REF
13433                                  : (ASCII_FOLD_RESTRICTED)
13434                                    ? REFFA
13435                                    : (AT_LEAST_UNI_SEMANTICS)
13436                                      ? REFFU
13437                                      : (LOC)
13438                                        ? REFFL
13439                                        : REFF),
13440                                 num);
13441                 *flagp |= HASWIDTH;
13442
13443                 /* override incorrect value set in reganode MJD */
13444                 Set_Node_Offset(ret, parse_start);
13445                 Set_Node_Cur_Length(ret, parse_start-1);
13446                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13447                                         FALSE /* Don't force to /x */ );
13448             }
13449             break;
13450         case '\0':
13451             if (RExC_parse >= RExC_end)
13452                 FAIL("Trailing \\");
13453             /* FALLTHROUGH */
13454         default:
13455             /* Do not generate "unrecognized" warnings here, we fall
13456                back into the quick-grab loop below */
13457             RExC_parse = parse_start;
13458             goto defchar;
13459         } /* end of switch on a \foo sequence */
13460         break;
13461
13462     case '#':
13463
13464         /* '#' comments should have been spaced over before this function was
13465          * called */
13466         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13467         /*
13468         if (RExC_flags & RXf_PMf_EXTENDED) {
13469             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13470             if (RExC_parse < RExC_end)
13471                 goto tryagain;
13472         }
13473         */
13474
13475         /* FALLTHROUGH */
13476
13477     default:
13478           defchar: {
13479
13480             /* Here, we have determined that the next thing is probably a
13481              * literal character.  RExC_parse points to the first byte of its
13482              * definition.  (It still may be an escape sequence that evaluates
13483              * to a single character) */
13484
13485             STRLEN len = 0;
13486             UV ender = 0;
13487             char *p;
13488             char *s;
13489
13490 /* This allows us to fill a node with just enough spare so that if the final
13491  * character folds, its expansion is guaranteed to fit */
13492 #define MAX_NODE_STRING_SIZE (255-UTF8_MAXBYTES_CASE)
13493             char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE+1];
13494
13495             char *s0;
13496             U8 upper_parse = MAX_NODE_STRING_SIZE;
13497
13498             /* We start out as an EXACT node, even if under /i, until we find a
13499              * character which is in a fold.  The algorithm now segregates into
13500              * separate nodes, characters that fold from those that don't under
13501              * /i.  (This hopefull will create nodes that are fixed strings
13502              * even under /i, giving the optimizer something to grab onto to.)
13503              * So, if a node has something in it and the next character is in
13504              * the opposite category, that node is closed up, and the function
13505              * returns.  Then regatom is called again, and a new node is
13506              * created for the new category. */
13507             U8 node_type = EXACT;
13508
13509             bool next_is_quantifier;
13510             char * oldp = NULL;
13511
13512             /* We can convert EXACTF nodes to EXACTFU if they contain only
13513              * characters that match identically regardless of the target
13514              * string's UTF8ness.  The reason to do this is that EXACTF is not
13515              * trie-able, EXACTFU is.
13516              *
13517              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13518              * contain only above-Latin1 characters (hence must be in UTF8),
13519              * which don't participate in folds with Latin1-range characters,
13520              * as the latter's folds aren't known until runtime.  (We don't
13521              * need to figure this out until pass 2) */
13522             bool maybe_exactfu = PASS2;
13523
13524             /* To see if RExC_uni_semantics changes during parsing of the node.
13525              * */
13526             bool uni_semantics_at_node_start;
13527
13528             /* The node_type may change below, but since the size of the node
13529              * doesn't change, it works */
13530             ret = reg_node(pRExC_state, node_type);
13531
13532             /* In pass1, folded, we use a temporary buffer instead of the
13533              * actual node, as the node doesn't exist yet */
13534             s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
13535
13536             s0 = s;
13537
13538           reparse:
13539
13540             /* This breaks under rare circumstances.  If folding, we do not
13541              * want to split a node at a character that is a non-final in a
13542              * multi-char fold, as an input string could just happen to want to
13543              * match across the node boundary.  The code at the end of the loop
13544              * looks for this, and backs off until it finds not such a
13545              * character, but it is possible (though extremely, extremely
13546              * unlikely) for all characters in the node to be non-final fold
13547              * ones, in which case we just leave the node fully filled, and
13548              * hope that it doesn't match the string in just the wrong place */
13549
13550             assert( ! UTF     /* Is at the beginning of a character */
13551                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
13552                    || UTF8_IS_START(UCHARAT(RExC_parse)));
13553
13554             uni_semantics_at_node_start = cBOOL(RExC_uni_semantics);
13555
13556             /* Here, we have a literal character.  Find the maximal string of
13557              * them in the input that we can fit into a single EXACTish node.
13558              * We quit at the first non-literal or when the node gets full, or
13559              * under /i the categorization of folding/non-folding character
13560              * changes */
13561             for (p = RExC_parse; len < upper_parse && p < RExC_end; ) {
13562
13563                 /* In most cases each iteration adds one byte to the output.
13564                  * The exceptions override this */
13565                 Size_t added_len = 1;
13566
13567                 oldp = p;
13568
13569                 /* White space has already been ignored */
13570                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
13571                        || ! is_PATWS_safe((p), RExC_end, UTF));
13572
13573                 switch ((U8)*p) {
13574                 case '^':
13575                 case '$':
13576                 case '.':
13577                 case '[':
13578                 case '(':
13579                 case ')':
13580                 case '|':
13581                     goto loopdone;
13582                 case '\\':
13583                     /* Literal Escapes Switch
13584
13585                        This switch is meant to handle escape sequences that
13586                        resolve to a literal character.
13587
13588                        Every escape sequence that represents something
13589                        else, like an assertion or a char class, is handled
13590                        in the switch marked 'Special Escapes' above in this
13591                        routine, but also has an entry here as anything that
13592                        isn't explicitly mentioned here will be treated as
13593                        an unescaped equivalent literal.
13594                     */
13595
13596                     switch ((U8)*++p) {
13597                     /* These are all the special escapes. */
13598                     case 'A':             /* Start assertion */
13599                     case 'b': case 'B':   /* Word-boundary assertion*/
13600                     case 'C':             /* Single char !DANGEROUS! */
13601                     case 'd': case 'D':   /* digit class */
13602                     case 'g': case 'G':   /* generic-backref, pos assertion */
13603                     case 'h': case 'H':   /* HORIZWS */
13604                     case 'k': case 'K':   /* named backref, keep marker */
13605                     case 'p': case 'P':   /* Unicode property */
13606                               case 'R':   /* LNBREAK */
13607                     case 's': case 'S':   /* space class */
13608                     case 'v': case 'V':   /* VERTWS */
13609                     case 'w': case 'W':   /* word class */
13610                     case 'X':             /* eXtended Unicode "combining
13611                                              character sequence" */
13612                     case 'z': case 'Z':   /* End of line/string assertion */
13613                         --p;
13614                         goto loopdone;
13615
13616                     /* Anything after here is an escape that resolves to a
13617                        literal. (Except digits, which may or may not)
13618                      */
13619                     case 'n':
13620                         ender = '\n';
13621                         p++;
13622                         break;
13623                     case 'N': /* Handle a single-code point named character. */
13624                         RExC_parse = p + 1;
13625                         if (! grok_bslash_N(pRExC_state,
13626                                             NULL,   /* Fail if evaluates to
13627                                                        anything other than a
13628                                                        single code point */
13629                                             &ender, /* The returned single code
13630                                                        point */
13631                                             NULL,   /* Don't need a count of
13632                                                        how many code points */
13633                                             flagp,
13634                                             RExC_strict,
13635                                             depth)
13636                         ) {
13637                             if (*flagp & NEED_UTF8)
13638                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
13639                             RETURN_NULL_ON_RESTART_FLAGP(flagp);
13640
13641                             /* Here, it wasn't a single code point.  Go close
13642                              * up this EXACTish node.  The switch() prior to
13643                              * this switch handles the other cases */
13644                             RExC_parse = p = oldp;
13645                             goto loopdone;
13646                         }
13647                         p = RExC_parse;
13648                         RExC_parse = parse_start;
13649                         if (ender > 0xff) {
13650                             REQUIRE_UTF8(flagp);
13651                         }
13652                         break;
13653                     case 'r':
13654                         ender = '\r';
13655                         p++;
13656                         break;
13657                     case 't':
13658                         ender = '\t';
13659                         p++;
13660                         break;
13661                     case 'f':
13662                         ender = '\f';
13663                         p++;
13664                         break;
13665                     case 'e':
13666                         ender = ESC_NATIVE;
13667                         p++;
13668                         break;
13669                     case 'a':
13670                         ender = '\a';
13671                         p++;
13672                         break;
13673                     case 'o':
13674                         {
13675                             UV result;
13676                             const char* error_msg;
13677
13678                             bool valid = grok_bslash_o(&p,
13679                                                        RExC_end,
13680                                                        &result,
13681                                                        &error_msg,
13682                                                        PASS2, /* out warnings */
13683                                                        (bool) RExC_strict,
13684                                                        TRUE, /* Output warnings
13685                                                                 for non-
13686                                                                 portables */
13687                                                        UTF);
13688                             if (! valid) {
13689                                 RExC_parse = p; /* going to die anyway; point
13690                                                    to exact spot of failure */
13691                                 vFAIL(error_msg);
13692                             }
13693                             ender = result;
13694                             if (ender > 0xff) {
13695                                 REQUIRE_UTF8(flagp);
13696                             }
13697                             break;
13698                         }
13699                     case 'x':
13700                         {
13701                             UV result = UV_MAX; /* initialize to erroneous
13702                                                    value */
13703                             const char* error_msg;
13704
13705                             bool valid = grok_bslash_x(&p,
13706                                                        RExC_end,
13707                                                        &result,
13708                                                        &error_msg,
13709                                                        PASS2, /* out warnings */
13710                                                        (bool) RExC_strict,
13711                                                        TRUE, /* Silence warnings
13712                                                                 for non-
13713                                                                 portables */
13714                                                        UTF);
13715                             if (! valid) {
13716                                 RExC_parse = p; /* going to die anyway; point
13717                                                    to exact spot of failure */
13718                                 vFAIL(error_msg);
13719                             }
13720                             ender = result;
13721
13722                             if (ender < 0x100) {
13723 #ifdef EBCDIC
13724                                 if (RExC_recode_x_to_native) {
13725                                     ender = LATIN1_TO_NATIVE(ender);
13726                                 }
13727 #endif
13728                             }
13729                             else {
13730                                 REQUIRE_UTF8(flagp);
13731                             }
13732                             break;
13733                         }
13734                     case 'c':
13735                         p++;
13736                         ender = grok_bslash_c(*p++, PASS2);
13737                         break;
13738                     case '8': case '9': /* must be a backreference */
13739                         --p;
13740                         /* we have an escape like \8 which cannot be an octal escape
13741                          * so we exit the loop, and let the outer loop handle this
13742                          * escape which may or may not be a legitimate backref. */
13743                         goto loopdone;
13744                     case '1': case '2': case '3':case '4':
13745                     case '5': case '6': case '7':
13746                         /* When we parse backslash escapes there is ambiguity
13747                          * between backreferences and octal escapes. Any escape
13748                          * from \1 - \9 is a backreference, any multi-digit
13749                          * escape which does not start with 0 and which when
13750                          * evaluated as decimal could refer to an already
13751                          * parsed capture buffer is a back reference. Anything
13752                          * else is octal.
13753                          *
13754                          * Note this implies that \118 could be interpreted as
13755                          * 118 OR as "\11" . "8" depending on whether there
13756                          * were 118 capture buffers defined already in the
13757                          * pattern.  */
13758
13759                         /* NOTE, RExC_npar is 1 more than the actual number of
13760                          * parens we have seen so far, hence the < RExC_npar below. */
13761
13762                         if ( !isDIGIT(p[1]) || S_backref_value(p, RExC_end) < RExC_npar)
13763                         {  /* Not to be treated as an octal constant, go
13764                                    find backref */
13765                             --p;
13766                             goto loopdone;
13767                         }
13768                         /* FALLTHROUGH */
13769                     case '0':
13770                         {
13771                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
13772                             STRLEN numlen = 3;
13773                             ender = grok_oct(p, &numlen, &flags, NULL);
13774                             if (ender > 0xff) {
13775                                 REQUIRE_UTF8(flagp);
13776                             }
13777                             p += numlen;
13778                             if (PASS2   /* like \08, \178 */
13779                                 && numlen < 3
13780                                 && isDIGIT(*p) && ckWARN(WARN_REGEXP))
13781                             {
13782                                 reg_warn_non_literal_string(
13783                                          p + 1,
13784                                          form_short_octal_warning(p, numlen));
13785                             }
13786                         }
13787                         break;
13788                     case '\0':
13789                         if (p >= RExC_end)
13790                             FAIL("Trailing \\");
13791                         /* FALLTHROUGH */
13792                     default:
13793                         if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
13794                             /* Include any left brace following the alpha to emphasize
13795                              * that it could be part of an escape at some point
13796                              * in the future */
13797                             int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
13798                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
13799                         }
13800                         goto normal_default;
13801                     } /* End of switch on '\' */
13802                     break;
13803                 case '{':
13804                     /* Trying to gain new uses for '{' without breaking too
13805                      * much existing code is hard.  The solution currently
13806                      * adopted is:
13807                      *  1)  If there is no ambiguity that a '{' should always
13808                      *      be taken literally, at the start of a construct, we
13809                      *      just do so.
13810                      *  2)  If the literal '{' conflicts with our desired use
13811                      *      of it as a metacharacter, we die.  The deprecation
13812                      *      cycles for this have come and gone.
13813                      *  3)  If there is ambiguity, we raise a simple warning.
13814                      *      This could happen, for example, if the user
13815                      *      intended it to introduce a quantifier, but slightly
13816                      *      misspelled the quantifier.  Without this warning,
13817                      *      the quantifier would silently be taken as a literal
13818                      *      string of characters instead of a meta construct */
13819                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
13820                         if (      RExC_strict
13821                             || (  p > parse_start + 1
13822                                 && isALPHA_A(*(p - 1))
13823                                 && *(p - 2) == '\\')
13824                             || new_regcurly(p, RExC_end))
13825                         {
13826                             RExC_parse = p + 1;
13827                             vFAIL("Unescaped left brace in regex is "
13828                                   "illegal here");
13829                         }
13830                         if (PASS2) {
13831                             ckWARNreg(p + 1, "Unescaped left brace in regex is"
13832                                              " passed through");
13833                         }
13834                     }
13835                     goto normal_default;
13836                 case '}':
13837                 case ']':
13838                     if (PASS2 && p > RExC_parse && RExC_strict) {
13839                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
13840                     }
13841                     /*FALLTHROUGH*/
13842                 default:    /* A literal character */
13843                   normal_default:
13844                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
13845                         STRLEN numlen;
13846                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
13847                                                &numlen, UTF8_ALLOW_DEFAULT);
13848                         p += numlen;
13849                     }
13850                     else
13851                         ender = (U8) *p++;
13852                     break;
13853                 } /* End of switch on the literal */
13854
13855                 /* Here, have looked at the literal character, and <ender>
13856                  * contains its ordinal; <p> points to the character after it.
13857                  * We need to check if the next non-ignored thing is a
13858                  * quantifier.  Move <p> to after anything that should be
13859                  * ignored, which, as a side effect, positions <p> for the next
13860                  * loop iteration */
13861                 skip_to_be_ignored_text(pRExC_state, &p,
13862                                         FALSE /* Don't force to /x */ );
13863
13864                 /* If the next thing is a quantifier, it applies to this
13865                  * character only, which means that this character has to be in
13866                  * its own node and can't just be appended to the string in an
13867                  * existing node, so if there are already other characters in
13868                  * the node, close the node with just them, and set up to do
13869                  * this character again next time through, when it will be the
13870                  * only thing in its new node */
13871
13872                 next_is_quantifier =    LIKELY(p < RExC_end)
13873                                      && UNLIKELY(ISMULT2(p));
13874
13875                 if (next_is_quantifier && LIKELY(len)) {
13876                     p = oldp;
13877                     goto loopdone;
13878                 }
13879
13880                 /* Ready to add 'ender' to the node */
13881
13882                 if (! FOLD) {  /* The simple case, just append the literal */
13883
13884                     /* In the sizing pass, we need only the size of the
13885                      * character we are appending, hence we can delay getting
13886                      * its representation until PASS2. */
13887                     if (SIZE_ONLY) {
13888                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13889                             const STRLEN unilen = UVCHR_SKIP(ender);
13890                             s += unilen;
13891                             added_len = unilen;
13892                         }
13893                         else {
13894                             s++;
13895                         }
13896                     } else { /* PASS2 */
13897                       not_fold_common:
13898                         if (UTF && ! UVCHR_IS_INVARIANT(ender)) {
13899                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
13900                             added_len = (char *) new_s - s;
13901                             s = (char *) new_s;
13902                         }
13903                         else {
13904                             *(s++) = (char) ender;
13905                         }
13906                     }
13907                 }
13908                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
13909
13910                     /* Here are folding under /l, and the code point is
13911                      * problematic.  If this is the first character in the
13912                      * node, change the node type to folding.   Otherwise, if
13913                      * this is the first problematic character, close up the
13914                      * existing node, so can start a new node with this one */
13915                     if (! len) {
13916                         node_type = EXACTFL;
13917                     }
13918                     else if (node_type == EXACT) {
13919                         p = oldp;
13920                         goto loopdone;
13921                     }
13922
13923                     /* This code point means we can't simplify things */
13924                     maybe_exactfu = FALSE;
13925
13926                     /* A problematic code point in this context means that its
13927                      * fold isn't known until runtime, so we can't fold it now.
13928                      * (The non-problematic code points are the above-Latin1
13929                      * ones that fold to also all above-Latin1.  Their folds
13930                      * don't vary no matter what the locale is.) But here we
13931                      * have characters whose fold depends on the locale.
13932                      * Unlike the non-folding case above, we have to keep track
13933                      * of these in the sizing pass, so that we can make sure we
13934                      * don't split too-long nodes in the middle of a potential
13935                      * multi-char fold.  And unlike the regular fold case
13936                      * handled in the else clauses below, we don't actually
13937                      * fold and don't have special cases to consider.  What we
13938                      * do for both passes is the PASS2 code for non-folding */
13939                     goto not_fold_common;
13940                 }
13941                 else                /* A regular FOLD code point */
13942                      if (! UTF)
13943                 {
13944                     /* Here, are folding and are not UTF-8 encoded; therefore
13945                      * the character must be in the range 0-255, and is not /l.
13946                      * (Not /l because we already handled these under /l in
13947                      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
13948                     if (! IS_IN_SOME_FOLD_L1(ender)) {
13949
13950                         /* Start a new node for this non-folding character if
13951                          * previous ones in the node were folded */
13952                         if (len && node_type != EXACT) {
13953                             p = oldp;
13954                             goto loopdone;
13955                         }
13956
13957                         *(s++) = (char) ender;
13958                     }
13959                     else {  /* Here, does participate in some fold */
13960
13961                         /* if this is the first character in the node, change
13962                          * its type to folding.  Otherwise, if this is the
13963                          * first folding character in the node, close up the
13964                          * existing node, so can start a new node with this
13965                          * one.  */
13966                         if (! len) {
13967                             node_type = compute_EXACTish(pRExC_state);
13968                         }
13969                         else if (node_type == EXACT) {
13970                             p = oldp;
13971                             goto loopdone;
13972                         }
13973
13974                         /* See if the character's fold differs between /d and
13975                          * /u.  On non-ancient Unicode versions, this includes
13976                          * the multi-char fold SHARP S to 'ss' */
13977
13978 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
13979    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
13980                                       || UNICODE_DOT_DOT_VERSION > 0)
13981
13982                         if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
13983
13984                             /* See comments for join_exact() as to why we fold
13985                              * this non-UTF at compile time */
13986                             if (node_type == EXACTFU) {
13987                                 *(s++) = 's';
13988
13989                                 /* Let the code below add in the extra 's' */
13990                                 ender = 's';
13991                                 added_len = 2;
13992                             }
13993                             else if (   uni_semantics_at_node_start
13994                                      != RExC_uni_semantics)
13995                             {
13996                                 /* Here, we are supossed to be using Unicode
13997                                  * rules, but this folding node is not.  This
13998                                  * happens during pass 1 when the node started
13999                                  * out not under Unicode rules, but a \N{} was
14000                                  * encountered during the processing of it,
14001                                  * causing Unicode rules to be switched into.
14002                                  * Pass 1 continues uninterrupted, as by the
14003                                  * time we get to pass 2, we will know enough
14004                                  * to generate the correct folds.  Except in
14005                                  * this one case, we need to restart the node,
14006                                  * because the fold of the sharp s requires 2
14007                                  * characters, and the sizing needs to account
14008                                  * for that. */
14009                                 p = oldp;
14010                                 goto loopdone;
14011                             }
14012                             else {
14013                                 RExC_seen_unfolded_sharp_s = 1;
14014                                 maybe_exactfu = FALSE;
14015                             }
14016                         }
14017                         else if (   len
14018                                  && isALPHA_FOLD_EQ(ender, 's')
14019                                  && isALPHA_FOLD_EQ(*(s-1), 's'))
14020                         {
14021                             maybe_exactfu = FALSE;
14022                         }
14023                         else
14024 #endif
14025
14026                         if (PL_fold[ender] != PL_fold_latin1[ender]) {
14027                             maybe_exactfu = FALSE;
14028                         }
14029
14030                         /* Even when folding, we store just the input
14031                          * character, as we have an array that finds its fold
14032                          * quickly */
14033                         *(s++) = (char) ender;
14034                     }
14035                 }
14036                 else {  /* FOLD, and UTF */
14037                     /* Unlike the non-fold case, we do actually have to
14038                      * calculate the fold in pass 1.  This is for two reasons,
14039                      * the folded length may be longer than the unfolded, and
14040                      * we have to calculate how many EXACTish nodes it will
14041                      * take; and we may run out of room in a node in the middle
14042                      * of a potential multi-char fold, and have to back off
14043                      * accordingly.  */
14044
14045                     if (isASCII_uni(ender)) {
14046
14047                         /* As above, we close up and start a new node if the
14048                          * previous characters don't match the fold/non-fold
14049                          * state of this one.  And if this is the first
14050                          * character in the node, and it folds, we change the
14051                          * node away from being EXACT */
14052                         if (! IS_IN_SOME_FOLD_L1(ender)) {
14053                             if (len && node_type != EXACT) {
14054                                 p = oldp;
14055                                 goto loopdone;
14056                             }
14057
14058                             *(s)++ = (U8) ender;
14059                         }
14060                         else {  /* Is in a fold */
14061
14062                             if (! len) {
14063                                 node_type = compute_EXACTish(pRExC_state);
14064                             }
14065                             else if (node_type == EXACT) {
14066                                 p = oldp;
14067                                 goto loopdone;
14068                             }
14069
14070                             *(s)++ = (U8) toFOLD(ender);
14071                         }
14072                     }
14073                     else {  /* Not ASCII */
14074                         STRLEN foldlen;
14075
14076                         /* As above, we close up and start a new node if the
14077                          * previous characters don't match the fold/non-fold
14078                          * state of this one.  And if this is the first
14079                          * character in the node, and it folds, we change the
14080                          * node away from being EXACT */
14081                         if (! _invlist_contains_cp(PL_utf8_foldable, ender)) {
14082                             if (len && node_type != EXACT) {
14083                                 p = oldp;
14084                                 goto loopdone;
14085                             }
14086
14087                             s = (char *) uvchr_to_utf8((U8 *) s, ender);
14088                             added_len = UVCHR_SKIP(ender);
14089                         }
14090                         else {
14091
14092                             if (! len) {
14093                                 node_type = compute_EXACTish(pRExC_state);
14094                             }
14095                             else if (node_type == EXACT) {
14096                                 p = oldp;
14097                                 goto loopdone;
14098                             }
14099
14100                             ender = _to_uni_fold_flags(
14101                                      ender,
14102                                      (U8 *) s,
14103                                      &foldlen,
14104                                      FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
14105                                                         ? FOLD_FLAGS_NOMIX_ASCII
14106                                                         : 0));
14107                             s += foldlen;
14108                             added_len = foldlen;
14109                         }
14110                     }
14111                 }
14112
14113                 len += added_len;
14114
14115                 if (next_is_quantifier) {
14116
14117                     /* Here, the next input is a quantifier, and to get here,
14118                      * the current character is the only one in the node. */
14119                     goto loopdone;
14120                 }
14121
14122             } /* End of loop through literal characters */
14123
14124             /* Here we have either exhausted the input or ran out of room in
14125              * the node.  (If we encountered a character that can't be in the
14126              * node, transfer is made directly to <loopdone>, and so we
14127              * wouldn't have fallen off the end of the loop.)  In the latter
14128              * case, we artificially have to split the node into two, because
14129              * we just don't have enough space to hold everything.  This
14130              * creates a problem if the final character participates in a
14131              * multi-character fold in the non-final position, as a match that
14132              * should have occurred won't, due to the way nodes are matched,
14133              * and our artificial boundary.  So back off until we find a non-
14134              * problematic character -- one that isn't at the beginning or
14135              * middle of such a fold.  (Either it doesn't participate in any
14136              * folds, or appears only in the final position of all the folds it
14137              * does participate in.)  A better solution with far fewer false
14138              * positives, and that would fill the nodes more completely, would
14139              * be to actually have available all the multi-character folds to
14140              * test against, and to back-off only far enough to be sure that
14141              * this node isn't ending with a partial one.  <upper_parse> is set
14142              * further below (if we need to reparse the node) to include just
14143              * up through that final non-problematic character that this code
14144              * identifies, so when it is set to less than the full node, we can
14145              * skip the rest of this */
14146             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
14147
14148                 const STRLEN full_len = len;
14149
14150                 assert(len >= MAX_NODE_STRING_SIZE);
14151
14152                 /* Here, <s> points to the final byte of the final character.
14153                  * Look backwards through the string until find a non-
14154                  * problematic character */
14155
14156                 if (! UTF) {
14157
14158                     /* This has no multi-char folds to non-UTF characters */
14159                     if (ASCII_FOLD_RESTRICTED) {
14160                         goto loopdone;
14161                     }
14162
14163                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
14164                     len = s - s0 + 1;
14165                 }
14166                 else {
14167
14168                     /* Point to the first byte of the final character */
14169                     s = (char *) utf8_hop((U8 *) s, -1);
14170
14171                     while (s >= s0) {   /* Search backwards until find
14172                                            a non-problematic char */
14173                         if (UTF8_IS_INVARIANT(*s)) {
14174
14175                             /* There are no ascii characters that participate
14176                              * in multi-char folds under /aa.  In EBCDIC, the
14177                              * non-ascii invariants are all control characters,
14178                              * so don't ever participate in any folds. */
14179                             if (ASCII_FOLD_RESTRICTED
14180                                 || ! IS_NON_FINAL_FOLD(*s))
14181                             {
14182                                 break;
14183                             }
14184                         }
14185                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
14186                             if (! IS_NON_FINAL_FOLD(EIGHT_BIT_UTF8_TO_NATIVE(
14187                                                                   *s, *(s+1))))
14188                             {
14189                                 break;
14190                             }
14191                         }
14192                         else if (! _invlist_contains_cp(
14193                                         PL_NonL1NonFinalFold,
14194                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
14195                         {
14196                             break;
14197                         }
14198
14199                         /* Here, the current character is problematic in that
14200                          * it does occur in the non-final position of some
14201                          * fold, so try the character before it, but have to
14202                          * special case the very first byte in the string, so
14203                          * we don't read outside the string */
14204                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
14205                     } /* End of loop backwards through the string */
14206
14207                     /* If there were only problematic characters in the string,
14208                      * <s> will point to before s0, in which case the length
14209                      * should be 0, otherwise include the length of the
14210                      * non-problematic character just found */
14211                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
14212                 }
14213
14214                 /* Here, have found the final character, if any, that is
14215                  * non-problematic as far as ending the node without splitting
14216                  * it across a potential multi-char fold.  <len> contains the
14217                  * number of bytes in the node up-to and including that
14218                  * character, or is 0 if there is no such character, meaning
14219                  * the whole node contains only problematic characters.  In
14220                  * this case, give up and just take the node as-is.  We can't
14221                  * do any better */
14222                 if (len == 0) {
14223                     len = full_len;
14224
14225                     /* If the node ends in an 's' we make sure it stays EXACTF,
14226                      * as if it turns into an EXACTFU, it could later get
14227                      * joined with another 's' that would then wrongly match
14228                      * the sharp s */
14229                     if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
14230                     {
14231                         maybe_exactfu = FALSE;
14232                     }
14233                 } else {
14234
14235                     /* Here, the node does contain some characters that aren't
14236                      * problematic.  If one such is the final character in the
14237                      * node, we are done */
14238                     if (len == full_len) {
14239                         goto loopdone;
14240                     }
14241                     else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
14242
14243                         /* If the final character is problematic, but the
14244                          * penultimate is not, back-off that last character to
14245                          * later start a new node with it */
14246                         p = oldp;
14247                         goto loopdone;
14248                     }
14249
14250                     /* Here, the final non-problematic character is earlier
14251                      * in the input than the penultimate character.  What we do
14252                      * is reparse from the beginning, going up only as far as
14253                      * this final ok one, thus guaranteeing that the node ends
14254                      * in an acceptable character.  The reason we reparse is
14255                      * that we know how far in the character is, but we don't
14256                      * know how to correlate its position with the input parse.
14257                      * An alternate implementation would be to build that
14258                      * correlation as we go along during the original parse,
14259                      * but that would entail extra work for every node, whereas
14260                      * this code gets executed only when the string is too
14261                      * large for the node, and the final two characters are
14262                      * problematic, an infrequent occurrence.  Yet another
14263                      * possible strategy would be to save the tail of the
14264                      * string, and the next time regatom is called, initialize
14265                      * with that.  The problem with this is that unless you
14266                      * back off one more character, you won't be guaranteed
14267                      * regatom will get called again, unless regbranch,
14268                      * regpiece ... are also changed.  If you do back off that
14269                      * extra character, so that there is input guaranteed to
14270                      * force calling regatom, you can't handle the case where
14271                      * just the first character in the node is acceptable.  I
14272                      * (khw) decided to try this method which doesn't have that
14273                      * pitfall; if performance issues are found, we can do a
14274                      * combination of the current approach plus that one */
14275                     upper_parse = len;
14276                     len = 0;
14277                     s = s0;
14278                     goto reparse;
14279                 }
14280             }   /* End of verifying node ends with an appropriate char */
14281
14282           loopdone:   /* Jumped to when encounters something that shouldn't be
14283                          in the node */
14284
14285             /* I (khw) don't know if you can get here with zero length, but the
14286              * old code handled this situation by creating a zero-length EXACT
14287              * node.  Might as well be NOTHING instead */
14288             if (len == 0) {
14289                 OP(ret) = NOTHING;
14290             }
14291             else {
14292                 OP(ret) = node_type;
14293
14294                 /* If the node type is EXACT here, check to see if it
14295                  * should be EXACTL. */
14296                 if (node_type == EXACT) {
14297                     if (LOC) {
14298                         OP(ret) = EXACTL;
14299                     }
14300                 }
14301
14302                 if (FOLD) {
14303                     /* If 'maybe_exactfu' is set, then there are no code points
14304                      * that match differently depending on UTF8ness of the
14305                      * target string (for /u), or depending on locale for /l */
14306                     if (maybe_exactfu) {
14307                         if (node_type == EXACTF) {
14308                             OP(ret) = EXACTFU;
14309                         }
14310                         else if (node_type == EXACTFL) {
14311                             OP(ret) = EXACTFLU8;
14312                         }
14313                     }
14314                 }
14315
14316                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
14317                                            FALSE /* Don't look to see if could
14318                                                     be turned into an EXACT
14319                                                     node, as we have already
14320                                                     computed that */
14321                                           );
14322             }
14323
14324             RExC_parse = p - 1;
14325             Set_Node_Cur_Length(ret, parse_start);
14326             RExC_parse = p;
14327             {
14328                 /* len is STRLEN which is unsigned, need to copy to signed */
14329                 IV iv = len;
14330                 if (iv < 0)
14331                     vFAIL("Internal disaster");
14332             }
14333
14334         } /* End of label 'defchar:' */
14335         break;
14336     } /* End of giant switch on input character */
14337
14338     /* Position parse to next real character */
14339     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14340                                             FALSE /* Don't force to /x */ );
14341     if (   PASS2 && *RExC_parse == '{'
14342         && OP(ret) != SBOL && ! regcurly(RExC_parse))
14343     {
14344         if (RExC_strict || new_regcurly(RExC_parse, RExC_end)) {
14345             RExC_parse++;
14346             vFAIL("Unescaped left brace in regex is illegal here");
14347         }
14348         ckWARNreg(RExC_parse + 1, "Unescaped left brace in regex is"
14349                                   " passed through");
14350     }
14351
14352     return(ret);
14353 }
14354
14355
14356 STATIC void
14357 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
14358 {
14359     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
14360      * sets up the bitmap and any flags, removing those code points from the
14361      * inversion list, setting it to NULL should it become completely empty */
14362
14363     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
14364     assert(PL_regkind[OP(node)] == ANYOF);
14365
14366     ANYOF_BITMAP_ZERO(node);
14367     if (*invlist_ptr) {
14368
14369         /* This gets set if we actually need to modify things */
14370         bool change_invlist = FALSE;
14371
14372         UV start, end;
14373
14374         /* Start looking through *invlist_ptr */
14375         invlist_iterinit(*invlist_ptr);
14376         while (invlist_iternext(*invlist_ptr, &start, &end)) {
14377             UV high;
14378             int i;
14379
14380             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
14381                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
14382             }
14383
14384             /* Quit if are above what we should change */
14385             if (start >= NUM_ANYOF_CODE_POINTS) {
14386                 break;
14387             }
14388
14389             change_invlist = TRUE;
14390
14391             /* Set all the bits in the range, up to the max that we are doing */
14392             high = (end < NUM_ANYOF_CODE_POINTS - 1)
14393                    ? end
14394                    : NUM_ANYOF_CODE_POINTS - 1;
14395             for (i = start; i <= (int) high; i++) {
14396                 if (! ANYOF_BITMAP_TEST(node, i)) {
14397                     ANYOF_BITMAP_SET(node, i);
14398                 }
14399             }
14400         }
14401         invlist_iterfinish(*invlist_ptr);
14402
14403         /* Done with loop; remove any code points that are in the bitmap from
14404          * *invlist_ptr; similarly for code points above the bitmap if we have
14405          * a flag to match all of them anyways */
14406         if (change_invlist) {
14407             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
14408         }
14409         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
14410             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
14411         }
14412
14413         /* If have completely emptied it, remove it completely */
14414         if (_invlist_len(*invlist_ptr) == 0) {
14415             SvREFCNT_dec_NN(*invlist_ptr);
14416             *invlist_ptr = NULL;
14417         }
14418     }
14419 }
14420
14421 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
14422    Character classes ([:foo:]) can also be negated ([:^foo:]).
14423    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
14424    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
14425    but trigger failures because they are currently unimplemented. */
14426
14427 #define POSIXCC_DONE(c)   ((c) == ':')
14428 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
14429 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
14430 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
14431
14432 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
14433 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
14434 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
14435
14436 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
14437
14438 /* 'posix_warnings' and 'warn_text' are names of variables in the following
14439  * routine. q.v. */
14440 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
14441         if (posix_warnings) {                                               \
14442             if (! RExC_warn_text ) RExC_warn_text = (AV *) sv_2mortal((SV *) newAV()); \
14443             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                          \
14444                                              WARNING_PREFIX                 \
14445                                              text                           \
14446                                              REPORT_LOCATION,               \
14447                                              REPORT_LOCATION_ARGS(p)));     \
14448         }                                                                   \
14449     } STMT_END
14450 #define CLEAR_POSIX_WARNINGS()                                              \
14451     STMT_START {                                                            \
14452         if (posix_warnings && RExC_warn_text)                               \
14453             av_clear(RExC_warn_text);                                       \
14454     } STMT_END
14455
14456 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
14457     STMT_START {                                                            \
14458         CLEAR_POSIX_WARNINGS();                                             \
14459         return ret;                                                         \
14460     } STMT_END
14461
14462 STATIC int
14463 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
14464
14465     const char * const s,      /* Where the putative posix class begins.
14466                                   Normally, this is one past the '['.  This
14467                                   parameter exists so it can be somewhere
14468                                   besides RExC_parse. */
14469     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
14470                                   NULL */
14471     AV ** posix_warnings,      /* Where to place any generated warnings, or
14472                                   NULL */
14473     const bool check_only      /* Don't die if error */
14474 )
14475 {
14476     /* This parses what the caller thinks may be one of the three POSIX
14477      * constructs:
14478      *  1) a character class, like [:blank:]
14479      *  2) a collating symbol, like [. .]
14480      *  3) an equivalence class, like [= =]
14481      * In the latter two cases, it croaks if it finds a syntactically legal
14482      * one, as these are not handled by Perl.
14483      *
14484      * The main purpose is to look for a POSIX character class.  It returns:
14485      *  a) the class number
14486      *      if it is a completely syntactically and semantically legal class.
14487      *      'updated_parse_ptr', if not NULL, is set to point to just after the
14488      *      closing ']' of the class
14489      *  b) OOB_NAMEDCLASS
14490      *      if it appears that one of the three POSIX constructs was meant, but
14491      *      its specification was somehow defective.  'updated_parse_ptr', if
14492      *      not NULL, is set to point to the character just after the end
14493      *      character of the class.  See below for handling of warnings.
14494      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
14495      *      if it  doesn't appear that a POSIX construct was intended.
14496      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
14497      *      raised.
14498      *
14499      * In b) there may be errors or warnings generated.  If 'check_only' is
14500      * TRUE, then any errors are discarded.  Warnings are returned to the
14501      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
14502      * instead it is NULL, warnings are suppressed.  This is done in all
14503      * passes.  The reason for this is that the rest of the parsing is heavily
14504      * dependent on whether this routine found a valid posix class or not.  If
14505      * it did, the closing ']' is absorbed as part of the class.  If no class,
14506      * or an invalid one is found, any ']' will be considered the terminator of
14507      * the outer bracketed character class, leading to very different results.
14508      * In particular, a '(?[ ])' construct will likely have a syntax error if
14509      * the class is parsed other than intended, and this will happen in pass1,
14510      * before the warnings would normally be output.  This mechanism allows the
14511      * caller to output those warnings in pass1 just before dieing, giving a
14512      * much better clue as to what is wrong.
14513      *
14514      * The reason for this function, and its complexity is that a bracketed
14515      * character class can contain just about anything.  But it's easy to
14516      * mistype the very specific posix class syntax but yielding a valid
14517      * regular bracketed class, so it silently gets compiled into something
14518      * quite unintended.
14519      *
14520      * The solution adopted here maintains backward compatibility except that
14521      * it adds a warning if it looks like a posix class was intended but
14522      * improperly specified.  The warning is not raised unless what is input
14523      * very closely resembles one of the 14 legal posix classes.  To do this,
14524      * it uses fuzzy parsing.  It calculates how many single-character edits it
14525      * would take to transform what was input into a legal posix class.  Only
14526      * if that number is quite small does it think that the intention was a
14527      * posix class.  Obviously these are heuristics, and there will be cases
14528      * where it errs on one side or another, and they can be tweaked as
14529      * experience informs.
14530      *
14531      * The syntax for a legal posix class is:
14532      *
14533      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
14534      *
14535      * What this routine considers syntactically to be an intended posix class
14536      * is this (the comments indicate some restrictions that the pattern
14537      * doesn't show):
14538      *
14539      *  qr/(?x: \[?                         # The left bracket, possibly
14540      *                                      # omitted
14541      *          \h*                         # possibly followed by blanks
14542      *          (?: \^ \h* )?               # possibly a misplaced caret
14543      *          [:;]?                       # The opening class character,
14544      *                                      # possibly omitted.  A typo
14545      *                                      # semi-colon can also be used.
14546      *          \h*
14547      *          \^?                         # possibly a correctly placed
14548      *                                      # caret, but not if there was also
14549      *                                      # a misplaced one
14550      *          \h*
14551      *          .{3,15}                     # The class name.  If there are
14552      *                                      # deviations from the legal syntax,
14553      *                                      # its edit distance must be close
14554      *                                      # to a real class name in order
14555      *                                      # for it to be considered to be
14556      *                                      # an intended posix class.
14557      *          \h*
14558      *          [[:punct:]]?                # The closing class character,
14559      *                                      # possibly omitted.  If not a colon
14560      *                                      # nor semi colon, the class name
14561      *                                      # must be even closer to a valid
14562      *                                      # one
14563      *          \h*
14564      *          \]?                         # The right bracket, possibly
14565      *                                      # omitted.
14566      *     )/
14567      *
14568      * In the above, \h must be ASCII-only.
14569      *
14570      * These are heuristics, and can be tweaked as field experience dictates.
14571      * There will be cases when someone didn't intend to specify a posix class
14572      * that this warns as being so.  The goal is to minimize these, while
14573      * maximizing the catching of things intended to be a posix class that
14574      * aren't parsed as such.
14575      */
14576
14577     const char* p             = s;
14578     const char * const e      = RExC_end;
14579     unsigned complement       = 0;      /* If to complement the class */
14580     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
14581     bool has_opening_bracket  = FALSE;
14582     bool has_opening_colon    = FALSE;
14583     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
14584                                                    valid class */
14585     const char * possible_end = NULL;   /* used for a 2nd parse pass */
14586     const char* name_start;             /* ptr to class name first char */
14587
14588     /* If the number of single-character typos the input name is away from a
14589      * legal name is no more than this number, it is considered to have meant
14590      * the legal name */
14591     int max_distance          = 2;
14592
14593     /* to store the name.  The size determines the maximum length before we
14594      * decide that no posix class was intended.  Should be at least
14595      * sizeof("alphanumeric") */
14596     UV input_text[15];
14597     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
14598
14599     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
14600
14601     CLEAR_POSIX_WARNINGS();
14602
14603     if (p >= e) {
14604         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
14605     }
14606
14607     if (*(p - 1) != '[') {
14608         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
14609         found_problem = TRUE;
14610     }
14611     else {
14612         has_opening_bracket = TRUE;
14613     }
14614
14615     /* They could be confused and think you can put spaces between the
14616      * components */
14617     if (isBLANK(*p)) {
14618         found_problem = TRUE;
14619
14620         do {
14621             p++;
14622         } while (p < e && isBLANK(*p));
14623
14624         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14625     }
14626
14627     /* For [. .] and [= =].  These are quite different internally from [: :],
14628      * so they are handled separately.  */
14629     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
14630                                             and 1 for at least one char in it
14631                                           */
14632     {
14633         const char open_char  = *p;
14634         const char * temp_ptr = p + 1;
14635
14636         /* These two constructs are not handled by perl, and if we find a
14637          * syntactically valid one, we croak.  khw, who wrote this code, finds
14638          * this explanation of them very unclear:
14639          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
14640          * And searching the rest of the internet wasn't very helpful either.
14641          * It looks like just about any byte can be in these constructs,
14642          * depending on the locale.  But unless the pattern is being compiled
14643          * under /l, which is very rare, Perl runs under the C or POSIX locale.
14644          * In that case, it looks like [= =] isn't allowed at all, and that
14645          * [. .] could be any single code point, but for longer strings the
14646          * constituent characters would have to be the ASCII alphabetics plus
14647          * the minus-hyphen.  Any sensible locale definition would limit itself
14648          * to these.  And any portable one definitely should.  Trying to parse
14649          * the general case is a nightmare (see [perl #127604]).  So, this code
14650          * looks only for interiors of these constructs that match:
14651          *      qr/.|[-\w]{2,}/
14652          * Using \w relaxes the apparent rules a little, without adding much
14653          * danger of mistaking something else for one of these constructs.
14654          *
14655          * [. .] in some implementations described on the internet is usable to
14656          * escape a character that otherwise is special in bracketed character
14657          * classes.  For example [.].] means a literal right bracket instead of
14658          * the ending of the class
14659          *
14660          * [= =] can legitimately contain a [. .] construct, but we don't
14661          * handle this case, as that [. .] construct will later get parsed
14662          * itself and croak then.  And [= =] is checked for even when not under
14663          * /l, as Perl has long done so.
14664          *
14665          * The code below relies on there being a trailing NUL, so it doesn't
14666          * have to keep checking if the parse ptr < e.
14667          */
14668         if (temp_ptr[1] == open_char) {
14669             temp_ptr++;
14670         }
14671         else while (    temp_ptr < e
14672                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
14673         {
14674             temp_ptr++;
14675         }
14676
14677         if (*temp_ptr == open_char) {
14678             temp_ptr++;
14679             if (*temp_ptr == ']') {
14680                 temp_ptr++;
14681                 if (! found_problem && ! check_only) {
14682                     RExC_parse = (char *) temp_ptr;
14683                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
14684                             "extensions", open_char, open_char);
14685                 }
14686
14687                 /* Here, the syntax wasn't completely valid, or else the call
14688                  * is to check-only */
14689                 if (updated_parse_ptr) {
14690                     *updated_parse_ptr = (char *) temp_ptr;
14691                 }
14692
14693                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
14694             }
14695         }
14696
14697         /* If we find something that started out to look like one of these
14698          * constructs, but isn't, we continue below so that it can be checked
14699          * for being a class name with a typo of '.' or '=' instead of a colon.
14700          * */
14701     }
14702
14703     /* Here, we think there is a possibility that a [: :] class was meant, and
14704      * we have the first real character.  It could be they think the '^' comes
14705      * first */
14706     if (*p == '^') {
14707         found_problem = TRUE;
14708         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
14709         complement = 1;
14710         p++;
14711
14712         if (isBLANK(*p)) {
14713             found_problem = TRUE;
14714
14715             do {
14716                 p++;
14717             } while (p < e && isBLANK(*p));
14718
14719             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14720         }
14721     }
14722
14723     /* But the first character should be a colon, which they could have easily
14724      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
14725      * distinguish from a colon, so treat that as a colon).  */
14726     if (*p == ':') {
14727         p++;
14728         has_opening_colon = TRUE;
14729     }
14730     else if (*p == ';') {
14731         found_problem = TRUE;
14732         p++;
14733         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14734         has_opening_colon = TRUE;
14735     }
14736     else {
14737         found_problem = TRUE;
14738         ADD_POSIX_WARNING(p, "there must be a starting ':'");
14739
14740         /* Consider an initial punctuation (not one of the recognized ones) to
14741          * be a left terminator */
14742         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
14743             p++;
14744         }
14745     }
14746
14747     /* They may think that you can put spaces between the components */
14748     if (isBLANK(*p)) {
14749         found_problem = TRUE;
14750
14751         do {
14752             p++;
14753         } while (p < e && isBLANK(*p));
14754
14755         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14756     }
14757
14758     if (*p == '^') {
14759
14760         /* We consider something like [^:^alnum:]] to not have been intended to
14761          * be a posix class, but XXX maybe we should */
14762         if (complement) {
14763             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14764         }
14765
14766         complement = 1;
14767         p++;
14768     }
14769
14770     /* Again, they may think that you can put spaces between the components */
14771     if (isBLANK(*p)) {
14772         found_problem = TRUE;
14773
14774         do {
14775             p++;
14776         } while (p < e && isBLANK(*p));
14777
14778         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
14779     }
14780
14781     if (*p == ']') {
14782
14783         /* XXX This ']' may be a typo, and something else was meant.  But
14784          * treating it as such creates enough complications, that that
14785          * possibility isn't currently considered here.  So we assume that the
14786          * ']' is what is intended, and if we've already found an initial '[',
14787          * this leaves this construct looking like [:] or [:^], which almost
14788          * certainly weren't intended to be posix classes */
14789         if (has_opening_bracket) {
14790             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14791         }
14792
14793         /* But this function can be called when we parse the colon for
14794          * something like qr/[alpha:]]/, so we back up to look for the
14795          * beginning */
14796         p--;
14797
14798         if (*p == ';') {
14799             found_problem = TRUE;
14800             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
14801         }
14802         else if (*p != ':') {
14803
14804             /* XXX We are currently very restrictive here, so this code doesn't
14805              * consider the possibility that, say, /[alpha.]]/ was intended to
14806              * be a posix class. */
14807             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14808         }
14809
14810         /* Here we have something like 'foo:]'.  There was no initial colon,
14811          * and we back up over 'foo.  XXX Unlike the going forward case, we
14812          * don't handle typos of non-word chars in the middle */
14813         has_opening_colon = FALSE;
14814         p--;
14815
14816         while (p > RExC_start && isWORDCHAR(*p)) {
14817             p--;
14818         }
14819         p++;
14820
14821         /* Here, we have positioned ourselves to where we think the first
14822          * character in the potential class is */
14823     }
14824
14825     /* Now the interior really starts.  There are certain key characters that
14826      * can end the interior, or these could just be typos.  To catch both
14827      * cases, we may have to do two passes.  In the first pass, we keep on
14828      * going unless we come to a sequence that matches
14829      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
14830      * This means it takes a sequence to end the pass, so two typos in a row if
14831      * that wasn't what was intended.  If the class is perfectly formed, just
14832      * this one pass is needed.  We also stop if there are too many characters
14833      * being accumulated, but this number is deliberately set higher than any
14834      * real class.  It is set high enough so that someone who thinks that
14835      * 'alphanumeric' is a correct name would get warned that it wasn't.
14836      * While doing the pass, we keep track of where the key characters were in
14837      * it.  If we don't find an end to the class, and one of the key characters
14838      * was found, we redo the pass, but stop when we get to that character.
14839      * Thus the key character was considered a typo in the first pass, but a
14840      * terminator in the second.  If two key characters are found, we stop at
14841      * the second one in the first pass.  Again this can miss two typos, but
14842      * catches a single one
14843      *
14844      * In the first pass, 'possible_end' starts as NULL, and then gets set to
14845      * point to the first key character.  For the second pass, it starts as -1.
14846      * */
14847
14848     name_start = p;
14849   parse_name:
14850     {
14851         bool has_blank               = FALSE;
14852         bool has_upper               = FALSE;
14853         bool has_terminating_colon   = FALSE;
14854         bool has_terminating_bracket = FALSE;
14855         bool has_semi_colon          = FALSE;
14856         unsigned int name_len        = 0;
14857         int punct_count              = 0;
14858
14859         while (p < e) {
14860
14861             /* Squeeze out blanks when looking up the class name below */
14862             if (isBLANK(*p) ) {
14863                 has_blank = TRUE;
14864                 found_problem = TRUE;
14865                 p++;
14866                 continue;
14867             }
14868
14869             /* The name will end with a punctuation */
14870             if (isPUNCT(*p)) {
14871                 const char * peek = p + 1;
14872
14873                 /* Treat any non-']' punctuation followed by a ']' (possibly
14874                  * with intervening blanks) as trying to terminate the class.
14875                  * ']]' is very likely to mean a class was intended (but
14876                  * missing the colon), but the warning message that gets
14877                  * generated shows the error position better if we exit the
14878                  * loop at the bottom (eventually), so skip it here. */
14879                 if (*p != ']') {
14880                     if (peek < e && isBLANK(*peek)) {
14881                         has_blank = TRUE;
14882                         found_problem = TRUE;
14883                         do {
14884                             peek++;
14885                         } while (peek < e && isBLANK(*peek));
14886                     }
14887
14888                     if (peek < e && *peek == ']') {
14889                         has_terminating_bracket = TRUE;
14890                         if (*p == ':') {
14891                             has_terminating_colon = TRUE;
14892                         }
14893                         else if (*p == ';') {
14894                             has_semi_colon = TRUE;
14895                             has_terminating_colon = TRUE;
14896                         }
14897                         else {
14898                             found_problem = TRUE;
14899                         }
14900                         p = peek + 1;
14901                         goto try_posix;
14902                     }
14903                 }
14904
14905                 /* Here we have punctuation we thought didn't end the class.
14906                  * Keep track of the position of the key characters that are
14907                  * more likely to have been class-enders */
14908                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
14909
14910                     /* Allow just one such possible class-ender not actually
14911                      * ending the class. */
14912                     if (possible_end) {
14913                         break;
14914                     }
14915                     possible_end = p;
14916                 }
14917
14918                 /* If we have too many punctuation characters, no use in
14919                  * keeping going */
14920                 if (++punct_count > max_distance) {
14921                     break;
14922                 }
14923
14924                 /* Treat the punctuation as a typo. */
14925                 input_text[name_len++] = *p;
14926                 p++;
14927             }
14928             else if (isUPPER(*p)) { /* Use lowercase for lookup */
14929                 input_text[name_len++] = toLOWER(*p);
14930                 has_upper = TRUE;
14931                 found_problem = TRUE;
14932                 p++;
14933             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
14934                 input_text[name_len++] = *p;
14935                 p++;
14936             }
14937             else {
14938                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
14939                 p+= UTF8SKIP(p);
14940             }
14941
14942             /* The declaration of 'input_text' is how long we allow a potential
14943              * class name to be, before saying they didn't mean a class name at
14944              * all */
14945             if (name_len >= C_ARRAY_LENGTH(input_text)) {
14946                 break;
14947             }
14948         }
14949
14950         /* We get to here when the possible class name hasn't been properly
14951          * terminated before:
14952          *   1) we ran off the end of the pattern; or
14953          *   2) found two characters, each of which might have been intended to
14954          *      be the name's terminator
14955          *   3) found so many punctuation characters in the purported name,
14956          *      that the edit distance to a valid one is exceeded
14957          *   4) we decided it was more characters than anyone could have
14958          *      intended to be one. */
14959
14960         found_problem = TRUE;
14961
14962         /* In the final two cases, we know that looking up what we've
14963          * accumulated won't lead to a match, even a fuzzy one. */
14964         if (   name_len >= C_ARRAY_LENGTH(input_text)
14965             || punct_count > max_distance)
14966         {
14967             /* If there was an intermediate key character that could have been
14968              * an intended end, redo the parse, but stop there */
14969             if (possible_end && possible_end != (char *) -1) {
14970                 possible_end = (char *) -1; /* Special signal value to say
14971                                                we've done a first pass */
14972                 p = name_start;
14973                 goto parse_name;
14974             }
14975
14976             /* Otherwise, it can't have meant to have been a class */
14977             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
14978         }
14979
14980         /* If we ran off the end, and the final character was a punctuation
14981          * one, back up one, to look at that final one just below.  Later, we
14982          * will restore the parse pointer if appropriate */
14983         if (name_len && p == e && isPUNCT(*(p-1))) {
14984             p--;
14985             name_len--;
14986         }
14987
14988         if (p < e && isPUNCT(*p)) {
14989             if (*p == ']') {
14990                 has_terminating_bracket = TRUE;
14991
14992                 /* If this is a 2nd ']', and the first one is just below this
14993                  * one, consider that to be the real terminator.  This gives a
14994                  * uniform and better positioning for the warning message  */
14995                 if (   possible_end
14996                     && possible_end != (char *) -1
14997                     && *possible_end == ']'
14998                     && name_len && input_text[name_len - 1] == ']')
14999                 {
15000                     name_len--;
15001                     p = possible_end;
15002
15003                     /* And this is actually equivalent to having done the 2nd
15004                      * pass now, so set it to not try again */
15005                     possible_end = (char *) -1;
15006                 }
15007             }
15008             else {
15009                 if (*p == ':') {
15010                     has_terminating_colon = TRUE;
15011                 }
15012                 else if (*p == ';') {
15013                     has_semi_colon = TRUE;
15014                     has_terminating_colon = TRUE;
15015                 }
15016                 p++;
15017             }
15018         }
15019
15020     try_posix:
15021
15022         /* Here, we have a class name to look up.  We can short circuit the
15023          * stuff below for short names that can't possibly be meant to be a
15024          * class name.  (We can do this on the first pass, as any second pass
15025          * will yield an even shorter name) */
15026         if (name_len < 3) {
15027             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15028         }
15029
15030         /* Find which class it is.  Initially switch on the length of the name.
15031          * */
15032         switch (name_len) {
15033             case 4:
15034                 if (memEQs(name_start, 4, "word")) {
15035                     /* this is not POSIX, this is the Perl \w */
15036                     class_number = ANYOF_WORDCHAR;
15037                 }
15038                 break;
15039             case 5:
15040                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
15041                  *                        graph lower print punct space upper
15042                  * Offset 4 gives the best switch position.  */
15043                 switch (name_start[4]) {
15044                     case 'a':
15045                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
15046                             class_number = ANYOF_ALPHA;
15047                         break;
15048                     case 'e':
15049                         if (memBEGINs(name_start, 5, "spac")) /* space */
15050                             class_number = ANYOF_SPACE;
15051                         break;
15052                     case 'h':
15053                         if (memBEGINs(name_start, 5, "grap")) /* graph */
15054                             class_number = ANYOF_GRAPH;
15055                         break;
15056                     case 'i':
15057                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
15058                             class_number = ANYOF_ASCII;
15059                         break;
15060                     case 'k':
15061                         if (memBEGINs(name_start, 5, "blan")) /* blank */
15062                             class_number = ANYOF_BLANK;
15063                         break;
15064                     case 'l':
15065                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
15066                             class_number = ANYOF_CNTRL;
15067                         break;
15068                     case 'm':
15069                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
15070                             class_number = ANYOF_ALPHANUMERIC;
15071                         break;
15072                     case 'r':
15073                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
15074                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
15075                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
15076                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
15077                         break;
15078                     case 't':
15079                         if (memBEGINs(name_start, 5, "digi")) /* digit */
15080                             class_number = ANYOF_DIGIT;
15081                         else if (memBEGINs(name_start, 5, "prin")) /* print */
15082                             class_number = ANYOF_PRINT;
15083                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
15084                             class_number = ANYOF_PUNCT;
15085                         break;
15086                 }
15087                 break;
15088             case 6:
15089                 if (memEQs(name_start, 6, "xdigit"))
15090                     class_number = ANYOF_XDIGIT;
15091                 break;
15092         }
15093
15094         /* If the name exactly matches a posix class name the class number will
15095          * here be set to it, and the input almost certainly was meant to be a
15096          * posix class, so we can skip further checking.  If instead the syntax
15097          * is exactly correct, but the name isn't one of the legal ones, we
15098          * will return that as an error below.  But if neither of these apply,
15099          * it could be that no posix class was intended at all, or that one
15100          * was, but there was a typo.  We tease these apart by doing fuzzy
15101          * matching on the name */
15102         if (class_number == OOB_NAMEDCLASS && found_problem) {
15103             const UV posix_names[][6] = {
15104                                                 { 'a', 'l', 'n', 'u', 'm' },
15105                                                 { 'a', 'l', 'p', 'h', 'a' },
15106                                                 { 'a', 's', 'c', 'i', 'i' },
15107                                                 { 'b', 'l', 'a', 'n', 'k' },
15108                                                 { 'c', 'n', 't', 'r', 'l' },
15109                                                 { 'd', 'i', 'g', 'i', 't' },
15110                                                 { 'g', 'r', 'a', 'p', 'h' },
15111                                                 { 'l', 'o', 'w', 'e', 'r' },
15112                                                 { 'p', 'r', 'i', 'n', 't' },
15113                                                 { 'p', 'u', 'n', 'c', 't' },
15114                                                 { 's', 'p', 'a', 'c', 'e' },
15115                                                 { 'u', 'p', 'p', 'e', 'r' },
15116                                                 { 'w', 'o', 'r', 'd' },
15117                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
15118                                             };
15119             /* The names of the above all have added NULs to make them the same
15120              * size, so we need to also have the real lengths */
15121             const UV posix_name_lengths[] = {
15122                                                 sizeof("alnum") - 1,
15123                                                 sizeof("alpha") - 1,
15124                                                 sizeof("ascii") - 1,
15125                                                 sizeof("blank") - 1,
15126                                                 sizeof("cntrl") - 1,
15127                                                 sizeof("digit") - 1,
15128                                                 sizeof("graph") - 1,
15129                                                 sizeof("lower") - 1,
15130                                                 sizeof("print") - 1,
15131                                                 sizeof("punct") - 1,
15132                                                 sizeof("space") - 1,
15133                                                 sizeof("upper") - 1,
15134                                                 sizeof("word")  - 1,
15135                                                 sizeof("xdigit")- 1
15136                                             };
15137             unsigned int i;
15138             int temp_max = max_distance;    /* Use a temporary, so if we
15139                                                reparse, we haven't changed the
15140                                                outer one */
15141
15142             /* Use a smaller max edit distance if we are missing one of the
15143              * delimiters */
15144             if (   has_opening_bracket + has_opening_colon < 2
15145                 || has_terminating_bracket + has_terminating_colon < 2)
15146             {
15147                 temp_max--;
15148             }
15149
15150             /* See if the input name is close to a legal one */
15151             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
15152
15153                 /* Short circuit call if the lengths are too far apart to be
15154                  * able to match */
15155                 if (abs( (int) (name_len - posix_name_lengths[i]))
15156                     > temp_max)
15157                 {
15158                     continue;
15159                 }
15160
15161                 if (edit_distance(input_text,
15162                                   posix_names[i],
15163                                   name_len,
15164                                   posix_name_lengths[i],
15165                                   temp_max
15166                                  )
15167                     > -1)
15168                 { /* If it is close, it probably was intended to be a class */
15169                     goto probably_meant_to_be;
15170                 }
15171             }
15172
15173             /* Here the input name is not close enough to a valid class name
15174              * for us to consider it to be intended to be a posix class.  If
15175              * we haven't already done so, and the parse found a character that
15176              * could have been terminators for the name, but which we absorbed
15177              * as typos during the first pass, repeat the parse, signalling it
15178              * to stop at that character */
15179             if (possible_end && possible_end != (char *) -1) {
15180                 possible_end = (char *) -1;
15181                 p = name_start;
15182                 goto parse_name;
15183             }
15184
15185             /* Here neither pass found a close-enough class name */
15186             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15187         }
15188
15189     probably_meant_to_be:
15190
15191         /* Here we think that a posix specification was intended.  Update any
15192          * parse pointer */
15193         if (updated_parse_ptr) {
15194             *updated_parse_ptr = (char *) p;
15195         }
15196
15197         /* If a posix class name was intended but incorrectly specified, we
15198          * output or return the warnings */
15199         if (found_problem) {
15200
15201             /* We set flags for these issues in the parse loop above instead of
15202              * adding them to the list of warnings, because we can parse it
15203              * twice, and we only want one warning instance */
15204             if (has_upper) {
15205                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
15206             }
15207             if (has_blank) {
15208                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15209             }
15210             if (has_semi_colon) {
15211                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15212             }
15213             else if (! has_terminating_colon) {
15214                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
15215             }
15216             if (! has_terminating_bracket) {
15217                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
15218             }
15219
15220             if (posix_warnings && RExC_warn_text && av_top_index(RExC_warn_text) > -1) {
15221                 *posix_warnings = RExC_warn_text;
15222             }
15223         }
15224         else if (class_number != OOB_NAMEDCLASS) {
15225             /* If it is a known class, return the class.  The class number
15226              * #defines are structured so each complement is +1 to the normal
15227              * one */
15228             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
15229         }
15230         else if (! check_only) {
15231
15232             /* Here, it is an unrecognized class.  This is an error (unless the
15233             * call is to check only, which we've already handled above) */
15234             const char * const complement_string = (complement)
15235                                                    ? "^"
15236                                                    : "";
15237             RExC_parse = (char *) p;
15238             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
15239                         complement_string,
15240                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
15241         }
15242     }
15243
15244     return OOB_NAMEDCLASS;
15245 }
15246 #undef ADD_POSIX_WARNING
15247
15248 STATIC unsigned  int
15249 S_regex_set_precedence(const U8 my_operator) {
15250
15251     /* Returns the precedence in the (?[...]) construct of the input operator,
15252      * specified by its character representation.  The precedence follows
15253      * general Perl rules, but it extends this so that ')' and ']' have (low)
15254      * precedence even though they aren't really operators */
15255
15256     switch (my_operator) {
15257         case '!':
15258             return 5;
15259         case '&':
15260             return 4;
15261         case '^':
15262         case '|':
15263         case '+':
15264         case '-':
15265             return 3;
15266         case ')':
15267             return 2;
15268         case ']':
15269             return 1;
15270     }
15271
15272     NOT_REACHED; /* NOTREACHED */
15273     return 0;   /* Silence compiler warning */
15274 }
15275
15276 STATIC regnode *
15277 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
15278                     I32 *flagp, U32 depth,
15279                     char * const oregcomp_parse)
15280 {
15281     /* Handle the (?[...]) construct to do set operations */
15282
15283     U8 curchar;                     /* Current character being parsed */
15284     UV start, end;                  /* End points of code point ranges */
15285     SV* final = NULL;               /* The end result inversion list */
15286     SV* result_string;              /* 'final' stringified */
15287     AV* stack;                      /* stack of operators and operands not yet
15288                                        resolved */
15289     AV* fence_stack = NULL;         /* A stack containing the positions in
15290                                        'stack' of where the undealt-with left
15291                                        parens would be if they were actually
15292                                        put there */
15293     /* The 'volatile' is a workaround for an optimiser bug
15294      * in Solaris Studio 12.3. See RT #127455 */
15295     volatile IV fence = 0;          /* Position of where most recent undealt-
15296                                        with left paren in stack is; -1 if none.
15297                                      */
15298     STRLEN len;                     /* Temporary */
15299     regnode* node;                  /* Temporary, and final regnode returned by
15300                                        this function */
15301     const bool save_fold = FOLD;    /* Temporary */
15302     char *save_end, *save_parse;    /* Temporaries */
15303     const bool in_locale = LOC;     /* we turn off /l during processing */
15304     AV* posix_warnings = NULL;
15305
15306     GET_RE_DEBUG_FLAGS_DECL;
15307
15308     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
15309
15310     DEBUG_PARSE("xcls");
15311
15312     if (in_locale) {
15313         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
15314     }
15315
15316     REQUIRE_UNI_RULES(flagp, NULL);   /* The use of this operator implies /u.
15317                                          This is required so that the compile
15318                                          time values are valid in all runtime
15319                                          cases */
15320
15321     /* This will return only an ANYOF regnode, or (unlikely) something smaller
15322      * (such as EXACT).  Thus we can skip most everything if just sizing.  We
15323      * call regclass to handle '[]' so as to not have to reinvent its parsing
15324      * rules here (throwing away the size it computes each time).  And, we exit
15325      * upon an unescaped ']' that isn't one ending a regclass.  To do both
15326      * these things, we need to realize that something preceded by a backslash
15327      * is escaped, so we have to keep track of backslashes */
15328     if (SIZE_ONLY) {
15329         UV nest_depth = 0; /* how many nested (?[...]) constructs */
15330
15331         while (RExC_parse < RExC_end) {
15332             SV* current = NULL;
15333
15334             skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15335                                     TRUE /* Force /x */ );
15336
15337             switch (*RExC_parse) {
15338                 case '(':
15339                     if (RExC_parse[1] == '?' && RExC_parse[2] == '[')
15340                         nest_depth++, RExC_parse+=2;
15341                     /* FALLTHROUGH */
15342                 default:
15343                     break;
15344                 case '\\':
15345                     /* Skip past this, so the next character gets skipped, after
15346                      * the switch */
15347                     RExC_parse++;
15348                     if (*RExC_parse == 'c') {
15349                             /* Skip the \cX notation for control characters */
15350                             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15351                     }
15352                     break;
15353
15354                 case '[':
15355                 {
15356                     /* See if this is a [:posix:] class. */
15357                     bool is_posix_class = (OOB_NAMEDCLASS
15358                             < handle_possible_posix(pRExC_state,
15359                                                 RExC_parse + 1,
15360                                                 NULL,
15361                                                 NULL,
15362                                                 TRUE /* checking only */));
15363                     /* If it is a posix class, leave the parse pointer at the
15364                      * '[' to fool regclass() into thinking it is part of a
15365                      * '[[:posix:]]'. */
15366                     if (! is_posix_class) {
15367                         RExC_parse++;
15368                     }
15369
15370                     /* regclass() can only return RESTART_PASS1 and NEED_UTF8
15371                      * if multi-char folds are allowed.  */
15372                     if (!regclass(pRExC_state, flagp,depth+1,
15373                                   is_posix_class, /* parse the whole char
15374                                                      class only if not a
15375                                                      posix class */
15376                                   FALSE, /* don't allow multi-char folds */
15377                                   TRUE, /* silence non-portable warnings. */
15378                                   TRUE, /* strict */
15379                                   FALSE, /* Require return to be an ANYOF */
15380                                   &current,
15381                                   &posix_warnings
15382                                  ))
15383                         FAIL2("panic: regclass returned NULL to handle_sets, "
15384                               "flags=%#" UVxf, (UV) *flagp);
15385
15386                     /* function call leaves parse pointing to the ']', except
15387                      * if we faked it */
15388                     if (is_posix_class) {
15389                         RExC_parse--;
15390                     }
15391
15392                     SvREFCNT_dec(current);   /* In case it returned something */
15393                     break;
15394                 }
15395
15396                 case ']':
15397                     if (RExC_parse[1] == ')') {
15398                         RExC_parse++;
15399                         if (nest_depth--) break;
15400                         node = reganode(pRExC_state, ANYOF, 0);
15401                         RExC_size += ANYOF_SKIP;
15402                         nextchar(pRExC_state);
15403                         Set_Node_Length(node,
15404                                 RExC_parse - oregcomp_parse + 1); /* MJD */
15405                         if (in_locale) {
15406                             set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
15407                         }
15408
15409                         return node;
15410                     }
15411                     /* We output the messages even if warnings are off, because we'll fail
15412                      * the very next thing, and these give a likely diagnosis for that */
15413                     if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15414                         output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15415                     }
15416                     RExC_parse++;
15417                     vFAIL("Unexpected ']' with no following ')' in (?[...");
15418             }
15419
15420             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
15421         }
15422
15423         /* We output the messages even if warnings are off, because we'll fail
15424          * the very next thing, and these give a likely diagnosis for that */
15425         if (posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
15426             output_or_return_posix_warnings(pRExC_state, posix_warnings, NULL);
15427         }
15428
15429         vFAIL("Syntax error in (?[...])");
15430     }
15431
15432     /* Pass 2 only after this. */
15433     Perl_ck_warner_d(aTHX_
15434         packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
15435         "The regex_sets feature is experimental" REPORT_LOCATION,
15436         REPORT_LOCATION_ARGS(RExC_parse));
15437
15438     /* Everything in this construct is a metacharacter.  Operands begin with
15439      * either a '\' (for an escape sequence), or a '[' for a bracketed
15440      * character class.  Any other character should be an operator, or
15441      * parenthesis for grouping.  Both types of operands are handled by calling
15442      * regclass() to parse them.  It is called with a parameter to indicate to
15443      * return the computed inversion list.  The parsing here is implemented via
15444      * a stack.  Each entry on the stack is a single character representing one
15445      * of the operators; or else a pointer to an operand inversion list. */
15446
15447 #define IS_OPERATOR(a) SvIOK(a)
15448 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15449
15450     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15451      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15452      * with pronouncing it called it Reverse Polish instead, but now that YOU
15453      * know how to pronounce it you can use the correct term, thus giving due
15454      * credit to the person who invented it, and impressing your geek friends.
15455      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15456      * it is now more like an English initial W (as in wonk) than an L.)
15457      *
15458      * This means that, for example, 'a | b & c' is stored on the stack as
15459      *
15460      * c  [4]
15461      * b  [3]
15462      * &  [2]
15463      * a  [1]
15464      * |  [0]
15465      *
15466      * where the numbers in brackets give the stack [array] element number.
15467      * In this implementation, parentheses are not stored on the stack.
15468      * Instead a '(' creates a "fence" so that the part of the stack below the
15469      * fence is invisible except to the corresponding ')' (this allows us to
15470      * replace testing for parens, by using instead subtraction of the fence
15471      * position).  As new operands are processed they are pushed onto the stack
15472      * (except as noted in the next paragraph).  New operators of higher
15473      * precedence than the current final one are inserted on the stack before
15474      * the lhs operand (so that when the rhs is pushed next, everything will be
15475      * in the correct positions shown above.  When an operator of equal or
15476      * lower precedence is encountered in parsing, all the stacked operations
15477      * of equal or higher precedence are evaluated, leaving the result as the
15478      * top entry on the stack.  This makes higher precedence operations
15479      * evaluate before lower precedence ones, and causes operations of equal
15480      * precedence to left associate.
15481      *
15482      * The only unary operator '!' is immediately pushed onto the stack when
15483      * encountered.  When an operand is encountered, if the top of the stack is
15484      * a '!", the complement is immediately performed, and the '!' popped.  The
15485      * resulting value is treated as a new operand, and the logic in the
15486      * previous paragraph is executed.  Thus in the expression
15487      *      [a] + ! [b]
15488      * the stack looks like
15489      *
15490      * !
15491      * a
15492      * +
15493      *
15494      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
15495      * becomes
15496      *
15497      * !b
15498      * a
15499      * +
15500      *
15501      * A ')' is treated as an operator with lower precedence than all the
15502      * aforementioned ones, which causes all operations on the stack above the
15503      * corresponding '(' to be evaluated down to a single resultant operand.
15504      * Then the fence for the '(' is removed, and the operand goes through the
15505      * algorithm above, without the fence.
15506      *
15507      * A separate stack is kept of the fence positions, so that the position of
15508      * the latest so-far unbalanced '(' is at the top of it.
15509      *
15510      * The ']' ending the construct is treated as the lowest operator of all,
15511      * so that everything gets evaluated down to a single operand, which is the
15512      * result */
15513
15514     sv_2mortal((SV *)(stack = newAV()));
15515     sv_2mortal((SV *)(fence_stack = newAV()));
15516
15517     while (RExC_parse < RExC_end) {
15518         I32 top_index;              /* Index of top-most element in 'stack' */
15519         SV** top_ptr;               /* Pointer to top 'stack' element */
15520         SV* current = NULL;         /* To contain the current inversion list
15521                                        operand */
15522         SV* only_to_avoid_leaks;
15523
15524         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15525                                 TRUE /* Force /x */ );
15526         if (RExC_parse >= RExC_end) {
15527             Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
15528         }
15529
15530         curchar = UCHARAT(RExC_parse);
15531
15532 redo_curchar:
15533
15534 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15535                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
15536         DEBUG_U(dump_regex_sets_structures(pRExC_state,
15537                                            stack, fence, fence_stack));
15538 #endif
15539
15540         top_index = av_tindex_skip_len_mg(stack);
15541
15542         switch (curchar) {
15543             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
15544             char stacked_operator;  /* The topmost operator on the 'stack'. */
15545             SV* lhs;                /* Operand to the left of the operator */
15546             SV* rhs;                /* Operand to the right of the operator */
15547             SV* fence_ptr;          /* Pointer to top element of the fence
15548                                        stack */
15549
15550             case '(':
15551
15552                 if (   RExC_parse < RExC_end - 1
15553                     && (UCHARAT(RExC_parse + 1) == '?'))
15554                 {
15555                     /* If is a '(?', could be an embedded '(?flags:(?[...])'.
15556                      * This happens when we have some thing like
15557                      *
15558                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
15559                      *   ...
15560                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
15561                      *
15562                      * Here we would be handling the interpolated
15563                      * '$thai_or_lao'.  We handle this by a recursive call to
15564                      * ourselves which returns the inversion list the
15565                      * interpolated expression evaluates to.  We use the flags
15566                      * from the interpolated pattern. */
15567                     U32 save_flags = RExC_flags;
15568                     const char * save_parse;
15569
15570                     RExC_parse += 2;        /* Skip past the '(?' */
15571                     save_parse = RExC_parse;
15572
15573                     /* Parse any flags for the '(?' */
15574                     parse_lparen_question_flags(pRExC_state);
15575
15576                     if (RExC_parse == save_parse  /* Makes sure there was at
15577                                                      least one flag (or else
15578                                                      this embedding wasn't
15579                                                      compiled) */
15580                         || RExC_parse >= RExC_end - 4
15581                         || UCHARAT(RExC_parse) != ':'
15582                         || UCHARAT(++RExC_parse) != '('
15583                         || UCHARAT(++RExC_parse) != '?'
15584                         || UCHARAT(++RExC_parse) != '[')
15585                     {
15586
15587                         /* In combination with the above, this moves the
15588                          * pointer to the point just after the first erroneous
15589                          * character (or if there are no flags, to where they
15590                          * should have been) */
15591                         if (RExC_parse >= RExC_end - 4) {
15592                             RExC_parse = RExC_end;
15593                         }
15594                         else if (RExC_parse != save_parse) {
15595                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15596                         }
15597                         vFAIL("Expecting '(?flags:(?[...'");
15598                     }
15599
15600                     /* Recurse, with the meat of the embedded expression */
15601                     RExC_parse++;
15602                     (void) handle_regex_sets(pRExC_state, &current, flagp,
15603                                                     depth+1, oregcomp_parse);
15604
15605                     /* Here, 'current' contains the embedded expression's
15606                      * inversion list, and RExC_parse points to the trailing
15607                      * ']'; the next character should be the ')' */
15608                     RExC_parse++;
15609                     if (UCHARAT(RExC_parse) != ')')
15610                         vFAIL("Expecting close paren for nested extended charclass");
15611
15612                     /* Then the ')' matching the original '(' handled by this
15613                      * case: statement */
15614                     RExC_parse++;
15615                     if (UCHARAT(RExC_parse) != ')')
15616                         vFAIL("Expecting close paren for wrapper for nested extended charclass");
15617
15618                     RExC_parse++;
15619                     RExC_flags = save_flags;
15620                     goto handle_operand;
15621                 }
15622
15623                 /* A regular '('.  Look behind for illegal syntax */
15624                 if (top_index - fence >= 0) {
15625                     /* If the top entry on the stack is an operator, it had
15626                      * better be a '!', otherwise the entry below the top
15627                      * operand should be an operator */
15628                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
15629                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
15630                         || (   IS_OPERAND(*top_ptr)
15631                             && (   top_index - fence < 1
15632                                 || ! (stacked_ptr = av_fetch(stack,
15633                                                              top_index - 1,
15634                                                              FALSE))
15635                                 || ! IS_OPERATOR(*stacked_ptr))))
15636                     {
15637                         RExC_parse++;
15638                         vFAIL("Unexpected '(' with no preceding operator");
15639                     }
15640                 }
15641
15642                 /* Stack the position of this undealt-with left paren */
15643                 av_push(fence_stack, newSViv(fence));
15644                 fence = top_index + 1;
15645                 break;
15646
15647             case '\\':
15648                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15649                  * multi-char folds are allowed.  */
15650                 if (!regclass(pRExC_state, flagp,depth+1,
15651                               TRUE, /* means parse just the next thing */
15652                               FALSE, /* don't allow multi-char folds */
15653                               FALSE, /* don't silence non-portable warnings.  */
15654                               TRUE,  /* strict */
15655                               FALSE, /* Require return to be an ANYOF */
15656                               &current,
15657                               NULL))
15658                 {
15659                     FAIL2("panic: regclass returned NULL to handle_sets, "
15660                           "flags=%#" UVxf, (UV) *flagp);
15661                 }
15662
15663                 /* regclass() will return with parsing just the \ sequence,
15664                  * leaving the parse pointer at the next thing to parse */
15665                 RExC_parse--;
15666                 goto handle_operand;
15667
15668             case '[':   /* Is a bracketed character class */
15669             {
15670                 /* See if this is a [:posix:] class. */
15671                 bool is_posix_class = (OOB_NAMEDCLASS
15672                             < handle_possible_posix(pRExC_state,
15673                                                 RExC_parse + 1,
15674                                                 NULL,
15675                                                 NULL,
15676                                                 TRUE /* checking only */));
15677                 /* If it is a posix class, leave the parse pointer at the '['
15678                  * to fool regclass() into thinking it is part of a
15679                  * '[[:posix:]]'. */
15680                 if (! is_posix_class) {
15681                     RExC_parse++;
15682                 }
15683
15684                 /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if
15685                  * multi-char folds are allowed.  */
15686                 if (!regclass(pRExC_state, flagp,depth+1,
15687                                 is_posix_class, /* parse the whole char
15688                                                     class only if not a
15689                                                     posix class */
15690                                 FALSE, /* don't allow multi-char folds */
15691                                 TRUE, /* silence non-portable warnings. */
15692                                 TRUE, /* strict */
15693                                 FALSE, /* Require return to be an ANYOF */
15694                                 &current,
15695                                 NULL
15696                                 ))
15697                 {
15698                     FAIL2("panic: regclass returned NULL to handle_sets, "
15699                           "flags=%#" UVxf, (UV) *flagp);
15700                 }
15701
15702                 /* function call leaves parse pointing to the ']', except if we
15703                  * faked it */
15704                 if (is_posix_class) {
15705                     RExC_parse--;
15706                 }
15707
15708                 goto handle_operand;
15709             }
15710
15711             case ']':
15712                 if (top_index >= 1) {
15713                     goto join_operators;
15714                 }
15715
15716                 /* Only a single operand on the stack: are done */
15717                 goto done;
15718
15719             case ')':
15720                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
15721                     RExC_parse++;
15722                     vFAIL("Unexpected ')'");
15723                 }
15724
15725                 /* If nothing after the fence, is missing an operand */
15726                 if (top_index - fence < 0) {
15727                     RExC_parse++;
15728                     goto bad_syntax;
15729                 }
15730                 /* If at least two things on the stack, treat this as an
15731                   * operator */
15732                 if (top_index - fence >= 1) {
15733                     goto join_operators;
15734                 }
15735
15736                 /* Here only a single thing on the fenced stack, and there is a
15737                  * fence.  Get rid of it */
15738                 fence_ptr = av_pop(fence_stack);
15739                 assert(fence_ptr);
15740                 fence = SvIV(fence_ptr);
15741                 SvREFCNT_dec_NN(fence_ptr);
15742                 fence_ptr = NULL;
15743
15744                 if (fence < 0) {
15745                     fence = 0;
15746                 }
15747
15748                 /* Having gotten rid of the fence, we pop the operand at the
15749                  * stack top and process it as a newly encountered operand */
15750                 current = av_pop(stack);
15751                 if (IS_OPERAND(current)) {
15752                     goto handle_operand;
15753                 }
15754
15755                 RExC_parse++;
15756                 goto bad_syntax;
15757
15758             case '&':
15759             case '|':
15760             case '+':
15761             case '-':
15762             case '^':
15763
15764                 /* These binary operators should have a left operand already
15765                  * parsed */
15766                 if (   top_index - fence < 0
15767                     || top_index - fence == 1
15768                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
15769                     || ! IS_OPERAND(*top_ptr))
15770                 {
15771                     goto unexpected_binary;
15772                 }
15773
15774                 /* If only the one operand is on the part of the stack visible
15775                  * to us, we just place this operator in the proper position */
15776                 if (top_index - fence < 2) {
15777
15778                     /* Place the operator before the operand */
15779
15780                     SV* lhs = av_pop(stack);
15781                     av_push(stack, newSVuv(curchar));
15782                     av_push(stack, lhs);
15783                     break;
15784                 }
15785
15786                 /* But if there is something else on the stack, we need to
15787                  * process it before this new operator if and only if the
15788                  * stacked operation has equal or higher precedence than the
15789                  * new one */
15790
15791              join_operators:
15792
15793                 /* The operator on the stack is supposed to be below both its
15794                  * operands */
15795                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
15796                     || IS_OPERAND(*stacked_ptr))
15797                 {
15798                     /* But if not, it's legal and indicates we are completely
15799                      * done if and only if we're currently processing a ']',
15800                      * which should be the final thing in the expression */
15801                     if (curchar == ']') {
15802                         goto done;
15803                     }
15804
15805                   unexpected_binary:
15806                     RExC_parse++;
15807                     vFAIL2("Unexpected binary operator '%c' with no "
15808                            "preceding operand", curchar);
15809                 }
15810                 stacked_operator = (char) SvUV(*stacked_ptr);
15811
15812                 if (regex_set_precedence(curchar)
15813                     > regex_set_precedence(stacked_operator))
15814                 {
15815                     /* Here, the new operator has higher precedence than the
15816                      * stacked one.  This means we need to add the new one to
15817                      * the stack to await its rhs operand (and maybe more
15818                      * stuff).  We put it before the lhs operand, leaving
15819                      * untouched the stacked operator and everything below it
15820                      * */
15821                     lhs = av_pop(stack);
15822                     assert(IS_OPERAND(lhs));
15823
15824                     av_push(stack, newSVuv(curchar));
15825                     av_push(stack, lhs);
15826                     break;
15827                 }
15828
15829                 /* Here, the new operator has equal or lower precedence than
15830                  * what's already there.  This means the operation already
15831                  * there should be performed now, before the new one. */
15832
15833                 rhs = av_pop(stack);
15834                 if (! IS_OPERAND(rhs)) {
15835
15836                     /* This can happen when a ! is not followed by an operand,
15837                      * like in /(?[\t &!])/ */
15838                     goto bad_syntax;
15839                 }
15840
15841                 lhs = av_pop(stack);
15842
15843                 if (! IS_OPERAND(lhs)) {
15844
15845                     /* This can happen when there is an empty (), like in
15846                      * /(?[[0]+()+])/ */
15847                     goto bad_syntax;
15848                 }
15849
15850                 switch (stacked_operator) {
15851                     case '&':
15852                         _invlist_intersection(lhs, rhs, &rhs);
15853                         break;
15854
15855                     case '|':
15856                     case '+':
15857                         _invlist_union(lhs, rhs, &rhs);
15858                         break;
15859
15860                     case '-':
15861                         _invlist_subtract(lhs, rhs, &rhs);
15862                         break;
15863
15864                     case '^':   /* The union minus the intersection */
15865                     {
15866                         SV* i = NULL;
15867                         SV* u = NULL;
15868
15869                         _invlist_union(lhs, rhs, &u);
15870                         _invlist_intersection(lhs, rhs, &i);
15871                         _invlist_subtract(u, i, &rhs);
15872                         SvREFCNT_dec_NN(i);
15873                         SvREFCNT_dec_NN(u);
15874                         break;
15875                     }
15876                 }
15877                 SvREFCNT_dec(lhs);
15878
15879                 /* Here, the higher precedence operation has been done, and the
15880                  * result is in 'rhs'.  We overwrite the stacked operator with
15881                  * the result.  Then we redo this code to either push the new
15882                  * operator onto the stack or perform any higher precedence
15883                  * stacked operation */
15884                 only_to_avoid_leaks = av_pop(stack);
15885                 SvREFCNT_dec(only_to_avoid_leaks);
15886                 av_push(stack, rhs);
15887                 goto redo_curchar;
15888
15889             case '!':   /* Highest priority, right associative */
15890
15891                 /* If what's already at the top of the stack is another '!",
15892                  * they just cancel each other out */
15893                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
15894                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
15895                 {
15896                     only_to_avoid_leaks = av_pop(stack);
15897                     SvREFCNT_dec(only_to_avoid_leaks);
15898                 }
15899                 else { /* Otherwise, since it's right associative, just push
15900                           onto the stack */
15901                     av_push(stack, newSVuv(curchar));
15902                 }
15903                 break;
15904
15905             default:
15906                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15907                 vFAIL("Unexpected character");
15908
15909           handle_operand:
15910
15911             /* Here 'current' is the operand.  If something is already on the
15912              * stack, we have to check if it is a !.  But first, the code above
15913              * may have altered the stack in the time since we earlier set
15914              * 'top_index'.  */
15915
15916             top_index = av_tindex_skip_len_mg(stack);
15917             if (top_index - fence >= 0) {
15918                 /* If the top entry on the stack is an operator, it had better
15919                  * be a '!', otherwise the entry below the top operand should
15920                  * be an operator */
15921                 top_ptr = av_fetch(stack, top_index, FALSE);
15922                 assert(top_ptr);
15923                 if (IS_OPERATOR(*top_ptr)) {
15924
15925                     /* The only permissible operator at the top of the stack is
15926                      * '!', which is applied immediately to this operand. */
15927                     curchar = (char) SvUV(*top_ptr);
15928                     if (curchar != '!') {
15929                         SvREFCNT_dec(current);
15930                         vFAIL2("Unexpected binary operator '%c' with no "
15931                                 "preceding operand", curchar);
15932                     }
15933
15934                     _invlist_invert(current);
15935
15936                     only_to_avoid_leaks = av_pop(stack);
15937                     SvREFCNT_dec(only_to_avoid_leaks);
15938
15939                     /* And we redo with the inverted operand.  This allows
15940                      * handling multiple ! in a row */
15941                     goto handle_operand;
15942                 }
15943                           /* Single operand is ok only for the non-binary ')'
15944                            * operator */
15945                 else if ((top_index - fence == 0 && curchar != ')')
15946                          || (top_index - fence > 0
15947                              && (! (stacked_ptr = av_fetch(stack,
15948                                                            top_index - 1,
15949                                                            FALSE))
15950                                  || IS_OPERAND(*stacked_ptr))))
15951                 {
15952                     SvREFCNT_dec(current);
15953                     vFAIL("Operand with no preceding operator");
15954                 }
15955             }
15956
15957             /* Here there was nothing on the stack or the top element was
15958              * another operand.  Just add this new one */
15959             av_push(stack, current);
15960
15961         } /* End of switch on next parse token */
15962
15963         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
15964     } /* End of loop parsing through the construct */
15965
15966   done:
15967     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
15968         vFAIL("Unmatched (");
15969     }
15970
15971     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
15972         || ((final = av_pop(stack)) == NULL)
15973         || ! IS_OPERAND(final)
15974         || ! is_invlist(final)
15975         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
15976     {
15977       bad_syntax:
15978         SvREFCNT_dec(final);
15979         vFAIL("Incomplete expression within '(?[ ])'");
15980     }
15981
15982     /* Here, 'final' is the resultant inversion list from evaluating the
15983      * expression.  Return it if so requested */
15984     if (return_invlist) {
15985         *return_invlist = final;
15986         return END;
15987     }
15988
15989     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
15990      * expecting a string of ranges and individual code points */
15991     invlist_iterinit(final);
15992     result_string = newSVpvs("");
15993     while (invlist_iternext(final, &start, &end)) {
15994         if (start == end) {
15995             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
15996         }
15997         else {
15998             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
15999                                                      start,          end);
16000         }
16001     }
16002
16003     /* About to generate an ANYOF (or similar) node from the inversion list we
16004      * have calculated */
16005     save_parse = RExC_parse;
16006     RExC_parse = SvPV(result_string, len);
16007     save_end = RExC_end;
16008     RExC_end = RExC_parse + len;
16009
16010     /* We turn off folding around the call, as the class we have constructed
16011      * already has all folding taken into consideration, and we don't want
16012      * regclass() to add to that */
16013     RExC_flags &= ~RXf_PMf_FOLD;
16014     /* regclass() can only return RESTART_PASS1 and NEED_UTF8 if multi-char
16015      * folds are allowed.  */
16016     node = regclass(pRExC_state, flagp,depth+1,
16017                     FALSE, /* means parse the whole char class */
16018                     FALSE, /* don't allow multi-char folds */
16019                     TRUE, /* silence non-portable warnings.  The above may very
16020                              well have generated non-portable code points, but
16021                              they're valid on this machine */
16022                     FALSE, /* similarly, no need for strict */
16023                     FALSE, /* Require return to be an ANYOF */
16024                     NULL,
16025                     NULL
16026                 );
16027     if (!node)
16028         FAIL2("panic: regclass returned NULL to handle_sets, flags=%#" UVxf,
16029                     PTR2UV(flagp));
16030
16031     /* Fix up the node type if we are in locale.  (We have pretended we are
16032      * under /u for the purposes of regclass(), as this construct will only
16033      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
16034      * as to cause any warnings about bad locales to be output in regexec.c),
16035      * and add the flag that indicates to check if not in a UTF-8 locale.  The
16036      * reason we above forbid optimization into something other than an ANYOF
16037      * node is simply to minimize the number of code changes in regexec.c.
16038      * Otherwise we would have to create new EXACTish node types and deal with
16039      * them.  This decision could be revisited should this construct become
16040      * popular.
16041      *
16042      * (One might think we could look at the resulting ANYOF node and suppress
16043      * the flag if everything is above 255, as those would be UTF-8 only,
16044      * but this isn't true, as the components that led to that result could
16045      * have been locale-affected, and just happen to cancel each other out
16046      * under UTF-8 locales.) */
16047     if (in_locale) {
16048         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
16049
16050         assert(OP(node) == ANYOF);
16051
16052         OP(node) = ANYOFL;
16053         ANYOF_FLAGS(node)
16054                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
16055     }
16056
16057     if (save_fold) {
16058         RExC_flags |= RXf_PMf_FOLD;
16059     }
16060
16061     RExC_parse = save_parse + 1;
16062     RExC_end = save_end;
16063     SvREFCNT_dec_NN(final);
16064     SvREFCNT_dec_NN(result_string);
16065
16066     nextchar(pRExC_state);
16067     Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
16068     return node;
16069 }
16070
16071 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16072
16073 STATIC void
16074 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
16075                              AV * stack, const IV fence, AV * fence_stack)
16076 {   /* Dumps the stacks in handle_regex_sets() */
16077
16078     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
16079     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
16080     SSize_t i;
16081
16082     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
16083
16084     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
16085
16086     if (stack_top < 0) {
16087         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
16088     }
16089     else {
16090         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
16091         for (i = stack_top; i >= 0; i--) {
16092             SV ** element_ptr = av_fetch(stack, i, FALSE);
16093             if (! element_ptr) {
16094             }
16095
16096             if (IS_OPERATOR(*element_ptr)) {
16097                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
16098                                             (int) i, (int) SvIV(*element_ptr));
16099             }
16100             else {
16101                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
16102                 sv_dump(*element_ptr);
16103             }
16104         }
16105     }
16106
16107     if (fence_stack_top < 0) {
16108         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
16109     }
16110     else {
16111         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
16112         for (i = fence_stack_top; i >= 0; i--) {
16113             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
16114             if (! element_ptr) {
16115             }
16116
16117             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
16118                                             (int) i, (int) SvIV(*element_ptr));
16119         }
16120     }
16121 }
16122
16123 #endif
16124
16125 #undef IS_OPERATOR
16126 #undef IS_OPERAND
16127
16128 STATIC void
16129 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
16130 {
16131     /* This adds the Latin1/above-Latin1 folding rules.
16132      *
16133      * This should be called only for a Latin1-range code points, cp, which is
16134      * known to be involved in a simple fold with other code points above
16135      * Latin1.  It would give false results if /aa has been specified.
16136      * Multi-char folds are outside the scope of this, and must be handled
16137      * specially. */
16138
16139     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
16140
16141     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
16142
16143     /* The rules that are valid for all Unicode versions are hard-coded in */
16144     switch (cp) {
16145         case 'k':
16146         case 'K':
16147           *invlist =
16148              add_cp_to_invlist(*invlist, KELVIN_SIGN);
16149             break;
16150         case 's':
16151         case 'S':
16152           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
16153             break;
16154         case MICRO_SIGN:
16155           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
16156           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
16157             break;
16158         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
16159         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
16160           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
16161             break;
16162         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
16163           *invlist = add_cp_to_invlist(*invlist,
16164                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
16165             break;
16166
16167         default:    /* Other code points are checked against the data for the
16168                        current Unicode version */
16169           {
16170             Size_t folds_to_count;
16171             unsigned int first_folds_to;
16172             const unsigned int * remaining_folds_to_list;
16173             UV folded_cp;
16174
16175             if (isASCII(cp)) {
16176                 folded_cp = toFOLD(cp);
16177             }
16178             else {
16179                 U8 dummy_fold[UTF8_MAXBYTES_CASE+1];
16180                 Size_t dummy_len;
16181                 folded_cp = _to_fold_latin1(cp, dummy_fold, &dummy_len, 0);
16182             }
16183
16184             if (folded_cp > 255) {
16185                 *invlist = add_cp_to_invlist(*invlist, folded_cp);
16186             }
16187
16188             folds_to_count = _inverse_folds(folded_cp, &first_folds_to,
16189                                                     &remaining_folds_to_list);
16190             if (folds_to_count == 0) {
16191
16192                 /* Use deprecated warning to increase the chances of this being
16193                  * output */
16194                 if (PASS2) {
16195                     ckWARN2reg_d(RExC_parse,
16196                         "Perl folding rules are not up-to-date for 0x%02X;"
16197                         " please use the perlbug utility to report;", cp);
16198                 }
16199             }
16200             else {
16201                 unsigned int i;
16202
16203                 if (first_folds_to > 255) {
16204                     *invlist = add_cp_to_invlist(*invlist, first_folds_to);
16205                 }
16206                 for (i = 0; i < folds_to_count - 1; i++) {
16207                     if (remaining_folds_to_list[i] > 255) {
16208                         *invlist = add_cp_to_invlist(*invlist,
16209                                                     remaining_folds_to_list[i]);
16210                     }
16211                 }
16212             }
16213             break;
16214          }
16215     }
16216 }
16217
16218 STATIC void
16219 S_output_or_return_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings, AV** return_posix_warnings)
16220 {
16221     /* If the final parameter is NULL, output the elements of the array given
16222      * by '*posix_warnings' as REGEXP warnings.  Otherwise, the elements are
16223      * pushed onto it, (creating if necessary) */
16224
16225     SV * msg;
16226     const bool first_is_fatal =  ! return_posix_warnings
16227                                 && ckDEAD(packWARN(WARN_REGEXP));
16228
16229     PERL_ARGS_ASSERT_OUTPUT_OR_RETURN_POSIX_WARNINGS;
16230
16231     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
16232         if (return_posix_warnings) {
16233             if (! *return_posix_warnings) { /* mortalize to not leak if
16234                                                warnings are fatal */
16235                 *return_posix_warnings = (AV *) sv_2mortal((SV *) newAV());
16236             }
16237             av_push(*return_posix_warnings, msg);
16238         }
16239         else {
16240             if (first_is_fatal) {           /* Avoid leaking this */
16241                 av_undef(posix_warnings);   /* This isn't necessary if the
16242                                                array is mortal, but is a
16243                                                fail-safe */
16244                 (void) sv_2mortal(msg);
16245                 if (PASS2) {
16246                     SAVEFREESV(RExC_rx_sv);
16247                 }
16248             }
16249             Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
16250             SvREFCNT_dec_NN(msg);
16251         }
16252     }
16253 }
16254
16255 STATIC AV *
16256 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
16257 {
16258     /* This adds the string scalar <multi_string> to the array
16259      * <multi_char_matches>.  <multi_string> is known to have exactly
16260      * <cp_count> code points in it.  This is used when constructing a
16261      * bracketed character class and we find something that needs to match more
16262      * than a single character.
16263      *
16264      * <multi_char_matches> is actually an array of arrays.  Each top-level
16265      * element is an array that contains all the strings known so far that are
16266      * the same length.  And that length (in number of code points) is the same
16267      * as the index of the top-level array.  Hence, the [2] element is an
16268      * array, each element thereof is a string containing TWO code points;
16269      * while element [3] is for strings of THREE characters, and so on.  Since
16270      * this is for multi-char strings there can never be a [0] nor [1] element.
16271      *
16272      * When we rewrite the character class below, we will do so such that the
16273      * longest strings are written first, so that it prefers the longest
16274      * matching strings first.  This is done even if it turns out that any
16275      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
16276      * Christiansen has agreed that this is ok.  This makes the test for the
16277      * ligature 'ffi' come before the test for 'ff', for example */
16278
16279     AV* this_array;
16280     AV** this_array_ptr;
16281
16282     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
16283
16284     if (! multi_char_matches) {
16285         multi_char_matches = newAV();
16286     }
16287
16288     if (av_exists(multi_char_matches, cp_count)) {
16289         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
16290         this_array = *this_array_ptr;
16291     }
16292     else {
16293         this_array = newAV();
16294         av_store(multi_char_matches, cp_count,
16295                  (SV*) this_array);
16296     }
16297     av_push(this_array, multi_string);
16298
16299     return multi_char_matches;
16300 }
16301
16302 /* The names of properties whose definitions are not known at compile time are
16303  * stored in this SV, after a constant heading.  So if the length has been
16304  * changed since initialization, then there is a run-time definition. */
16305 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
16306                                         (SvCUR(listsv) != initial_listsv_len)
16307
16308 /* There is a restricted set of white space characters that are legal when
16309  * ignoring white space in a bracketed character class.  This generates the
16310  * code to skip them.
16311  *
16312  * There is a line below that uses the same white space criteria but is outside
16313  * this macro.  Both here and there must use the same definition */
16314 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
16315     STMT_START {                                                        \
16316         if (do_skip) {                                                  \
16317             while (isBLANK_A(UCHARAT(p)))                               \
16318             {                                                           \
16319                 p++;                                                    \
16320             }                                                           \
16321         }                                                               \
16322     } STMT_END
16323
16324 STATIC regnode *
16325 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
16326                  const bool stop_at_1,  /* Just parse the next thing, don't
16327                                            look for a full character class */
16328                  bool allow_multi_folds,
16329                  const bool silence_non_portable,   /* Don't output warnings
16330                                                        about too large
16331                                                        characters */
16332                  const bool strict,
16333                  bool optimizable,                  /* ? Allow a non-ANYOF return
16334                                                        node */
16335                  SV** ret_invlist, /* Return an inversion list, not a node */
16336                  AV** return_posix_warnings
16337           )
16338 {
16339     /* parse a bracketed class specification.  Most of these will produce an
16340      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
16341      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
16342      * under /i with multi-character folds: it will be rewritten following the
16343      * paradigm of this example, where the <multi-fold>s are characters which
16344      * fold to multiple character sequences:
16345      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
16346      * gets effectively rewritten as:
16347      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
16348      * reg() gets called (recursively) on the rewritten version, and this
16349      * function will return what it constructs.  (Actually the <multi-fold>s
16350      * aren't physically removed from the [abcdefghi], it's just that they are
16351      * ignored in the recursion by means of a flag:
16352      * <RExC_in_multi_char_class>.)
16353      *
16354      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
16355      * characters, with the corresponding bit set if that character is in the
16356      * list.  For characters above this, a range list or swash is used.  There
16357      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
16358      * determinable at compile time
16359      *
16360      * Returns NULL, setting *flagp to RESTART_PASS1 if the sizing scan needs
16361      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded
16362      * to UTF-8.  This can only happen if ret_invlist is non-NULL.
16363      */
16364
16365     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
16366     IV range = 0;
16367     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
16368     regnode *ret;
16369     STRLEN numlen;
16370     int namedclass = OOB_NAMEDCLASS;
16371     char *rangebegin = NULL;
16372     bool need_class = 0;
16373     SV *listsv = NULL;
16374     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
16375                                       than just initialized.  */
16376     SV* properties = NULL;    /* Code points that match \p{} \P{} */
16377     SV* posixes = NULL;     /* Code points that match classes like [:word:],
16378                                extended beyond the Latin1 range.  These have to
16379                                be kept separate from other code points for much
16380                                of this function because their handling  is
16381                                different under /i, and for most classes under
16382                                /d as well */
16383     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
16384                                separate for a while from the non-complemented
16385                                versions because of complications with /d
16386                                matching */
16387     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
16388                                   treated more simply than the general case,
16389                                   leading to less compilation and execution
16390                                   work */
16391     UV element_count = 0;   /* Number of distinct elements in the class.
16392                                Optimizations may be possible if this is tiny */
16393     AV * multi_char_matches = NULL; /* Code points that fold to more than one
16394                                        character; used under /i */
16395     UV n;
16396     char * stop_ptr = RExC_end;    /* where to stop parsing */
16397
16398     /* ignore unescaped whitespace? */
16399     const bool skip_white = cBOOL(   ret_invlist
16400                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
16401
16402     /* Unicode properties are stored in a swash; this holds the current one
16403      * being parsed.  If this swash is the only above-latin1 component of the
16404      * character class, an optimization is to pass it directly on to the
16405      * execution engine.  Otherwise, it is set to NULL to indicate that there
16406      * are other things in the class that have to be dealt with at execution
16407      * time */
16408     SV* swash = NULL;           /* Code points that match \p{} \P{} */
16409
16410     /* Set if a component of this character class is user-defined; just passed
16411      * on to the engine */
16412     bool has_user_defined_property = FALSE;
16413
16414     /* inversion list of code points this node matches only when the target
16415      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
16416      * /d) */
16417     SV* has_upper_latin1_only_utf8_matches = NULL;
16418
16419     /* Inversion list of code points this node matches regardless of things
16420      * like locale, folding, utf8ness of the target string */
16421     SV* cp_list = NULL;
16422
16423     /* Like cp_list, but code points on this list need to be checked for things
16424      * that fold to/from them under /i */
16425     SV* cp_foldable_list = NULL;
16426
16427     /* Like cp_list, but code points on this list are valid only when the
16428      * runtime locale is UTF-8 */
16429     SV* only_utf8_locale_list = NULL;
16430
16431     /* In a range, if one of the endpoints is non-character-set portable,
16432      * meaning that it hard-codes a code point that may mean a different
16433      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16434      * mnemonic '\t' which each mean the same character no matter which
16435      * character set the platform is on. */
16436     unsigned int non_portable_endpoint = 0;
16437
16438     /* Is the range unicode? which means on a platform that isn't 1-1 native
16439      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16440      * to be a Unicode value.  */
16441     bool unicode_range = FALSE;
16442     bool invert = FALSE;    /* Is this class to be complemented */
16443
16444     bool warn_super = ALWAYS_WARN_SUPER;
16445
16446     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
16447         case we need to change the emitted regop to an EXACT. */
16448     const char * orig_parse = RExC_parse;
16449     const SSize_t orig_size = RExC_size;
16450     bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
16451
16452     /* This variable is used to mark where the end in the input is of something
16453      * that looks like a POSIX construct but isn't.  During the parse, when
16454      * something looks like it could be such a construct is encountered, it is
16455      * checked for being one, but not if we've already checked this area of the
16456      * input.  Only after this position is reached do we check again */
16457     char *not_posix_region_end = RExC_parse - 1;
16458
16459     AV* posix_warnings = NULL;
16460     const bool do_posix_warnings =     return_posix_warnings
16461                                    || (PASS2 && ckWARN(WARN_REGEXP));
16462
16463     GET_RE_DEBUG_FLAGS_DECL;
16464
16465     PERL_ARGS_ASSERT_REGCLASS;
16466 #ifndef DEBUGGING
16467     PERL_UNUSED_ARG(depth);
16468 #endif
16469
16470     DEBUG_PARSE("clas");
16471
16472 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
16473     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
16474                                    && UNICODE_DOT_DOT_VERSION == 0)
16475     allow_multi_folds = FALSE;
16476 #endif
16477
16478     /* Assume we are going to generate an ANYOF node. */
16479     ret = reganode(pRExC_state,
16480                    (LOC)
16481                     ? ANYOFL
16482                     : ANYOF,
16483                    0);
16484
16485     if (SIZE_ONLY) {
16486         RExC_size += ANYOF_SKIP;
16487         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
16488     }
16489     else {
16490         ANYOF_FLAGS(ret) = 0;
16491
16492         RExC_emit += ANYOF_SKIP;
16493         listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
16494         initial_listsv_len = SvCUR(listsv);
16495         SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
16496     }
16497
16498     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16499
16500     assert(RExC_parse <= RExC_end);
16501
16502     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
16503         RExC_parse++;
16504         invert = TRUE;
16505         allow_multi_folds = FALSE;
16506         MARK_NAUGHTY(1);
16507         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16508     }
16509
16510     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
16511     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
16512         int maybe_class = handle_possible_posix(pRExC_state,
16513                                                 RExC_parse,
16514                                                 &not_posix_region_end,
16515                                                 NULL,
16516                                                 TRUE /* checking only */);
16517         if (PASS2 && maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
16518             SAVEFREESV(RExC_rx_sv);
16519             ckWARN4reg(not_posix_region_end,
16520                     "POSIX syntax [%c %c] belongs inside character classes%s",
16521                     *RExC_parse, *RExC_parse,
16522                     (maybe_class == OOB_NAMEDCLASS)
16523                     ? ((POSIXCC_NOTYET(*RExC_parse))
16524                         ? " (but this one isn't implemented)"
16525                         : " (but this one isn't fully valid)")
16526                     : ""
16527                     );
16528             (void)ReREFCNT_inc(RExC_rx_sv);
16529         }
16530     }
16531
16532     /* If the caller wants us to just parse a single element, accomplish this
16533      * by faking the loop ending condition */
16534     if (stop_at_1 && RExC_end > RExC_parse) {
16535         stop_ptr = RExC_parse + 1;
16536     }
16537
16538     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
16539     if (UCHARAT(RExC_parse) == ']')
16540         goto charclassloop;
16541
16542     while (1) {
16543
16544         if (   posix_warnings
16545             && av_tindex_skip_len_mg(posix_warnings) >= 0
16546             && RExC_parse > not_posix_region_end)
16547         {
16548             /* Warnings about posix class issues are considered tentative until
16549              * we are far enough along in the parse that we can no longer
16550              * change our mind, at which point we either output them or add
16551              * them, if it has so specified, to what gets returned to the
16552              * caller.  This is done each time through the loop so that a later
16553              * class won't zap them before they have been dealt with. */
16554             output_or_return_posix_warnings(pRExC_state, posix_warnings,
16555                                             return_posix_warnings);
16556         }
16557
16558         if  (RExC_parse >= stop_ptr) {
16559             break;
16560         }
16561
16562         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16563
16564         if  (UCHARAT(RExC_parse) == ']') {
16565             break;
16566         }
16567
16568       charclassloop:
16569
16570         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
16571         save_value = value;
16572         save_prevvalue = prevvalue;
16573
16574         if (!range) {
16575             rangebegin = RExC_parse;
16576             element_count++;
16577             non_portable_endpoint = 0;
16578         }
16579         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
16580             value = utf8n_to_uvchr((U8*)RExC_parse,
16581                                    RExC_end - RExC_parse,
16582                                    &numlen, UTF8_ALLOW_DEFAULT);
16583             RExC_parse += numlen;
16584         }
16585         else
16586             value = UCHARAT(RExC_parse++);
16587
16588         if (value == '[') {
16589             char * posix_class_end;
16590             namedclass = handle_possible_posix(pRExC_state,
16591                                                RExC_parse,
16592                                                &posix_class_end,
16593                                                do_posix_warnings ? &posix_warnings : NULL,
16594                                                FALSE    /* die if error */);
16595             if (namedclass > OOB_NAMEDCLASS) {
16596
16597                 /* If there was an earlier attempt to parse this particular
16598                  * posix class, and it failed, it was a false alarm, as this
16599                  * successful one proves */
16600                 if (   posix_warnings
16601                     && av_tindex_skip_len_mg(posix_warnings) >= 0
16602                     && not_posix_region_end >= RExC_parse
16603                     && not_posix_region_end <= posix_class_end)
16604                 {
16605                     av_undef(posix_warnings);
16606                 }
16607
16608                 RExC_parse = posix_class_end;
16609             }
16610             else if (namedclass == OOB_NAMEDCLASS) {
16611                 not_posix_region_end = posix_class_end;
16612             }
16613             else {
16614                 namedclass = OOB_NAMEDCLASS;
16615             }
16616         }
16617         else if (   RExC_parse - 1 > not_posix_region_end
16618                  && MAYBE_POSIXCC(value))
16619         {
16620             (void) handle_possible_posix(
16621                         pRExC_state,
16622                         RExC_parse - 1,  /* -1 because parse has already been
16623                                             advanced */
16624                         &not_posix_region_end,
16625                         do_posix_warnings ? &posix_warnings : NULL,
16626                         TRUE /* checking only */);
16627         }
16628         else if (  strict && ! skip_white
16629                  && (   _generic_isCC(value, _CC_VERTSPACE)
16630                      || is_VERTWS_cp_high(value)))
16631         {
16632             vFAIL("Literal vertical space in [] is illegal except under /x");
16633         }
16634         else if (value == '\\') {
16635             /* Is a backslash; get the code point of the char after it */
16636
16637             if (RExC_parse >= RExC_end) {
16638                 vFAIL("Unmatched [");
16639             }
16640
16641             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
16642                 value = utf8n_to_uvchr((U8*)RExC_parse,
16643                                    RExC_end - RExC_parse,
16644                                    &numlen, UTF8_ALLOW_DEFAULT);
16645                 RExC_parse += numlen;
16646             }
16647             else
16648                 value = UCHARAT(RExC_parse++);
16649
16650             /* Some compilers cannot handle switching on 64-bit integer
16651              * values, therefore value cannot be an UV.  Yes, this will
16652              * be a problem later if we want switch on Unicode.
16653              * A similar issue a little bit later when switching on
16654              * namedclass. --jhi */
16655
16656             /* If the \ is escaping white space when white space is being
16657              * skipped, it means that that white space is wanted literally, and
16658              * is already in 'value'.  Otherwise, need to translate the escape
16659              * into what it signifies. */
16660             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
16661
16662             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
16663             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
16664             case 's':   namedclass = ANYOF_SPACE;       break;
16665             case 'S':   namedclass = ANYOF_NSPACE;      break;
16666             case 'd':   namedclass = ANYOF_DIGIT;       break;
16667             case 'D':   namedclass = ANYOF_NDIGIT;      break;
16668             case 'v':   namedclass = ANYOF_VERTWS;      break;
16669             case 'V':   namedclass = ANYOF_NVERTWS;     break;
16670             case 'h':   namedclass = ANYOF_HORIZWS;     break;
16671             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
16672             case 'N':  /* Handle \N{NAME} in class */
16673                 {
16674                     const char * const backslash_N_beg = RExC_parse - 2;
16675                     int cp_count;
16676
16677                     if (! grok_bslash_N(pRExC_state,
16678                                         NULL,      /* No regnode */
16679                                         &value,    /* Yes single value */
16680                                         &cp_count, /* Multiple code pt count */
16681                                         flagp,
16682                                         strict,
16683                                         depth)
16684                     ) {
16685
16686                         if (*flagp & NEED_UTF8)
16687                             FAIL("panic: grok_bslash_N set NEED_UTF8");
16688
16689                         RETURN_NULL_ON_RESTART_FLAGP(flagp);
16690
16691                         if (cp_count < 0) {
16692                             vFAIL("\\N in a character class must be a named character: \\N{...}");
16693                         }
16694                         else if (cp_count == 0) {
16695                             if (PASS2) {
16696                                 ckWARNreg(RExC_parse,
16697                                         "Ignoring zero length \\N{} in character class");
16698                             }
16699                         }
16700                         else { /* cp_count > 1 */
16701                             if (! RExC_in_multi_char_class) {
16702                                 if (invert || range || *RExC_parse == '-') {
16703                                     if (strict) {
16704                                         RExC_parse--;
16705                                         vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
16706                                     }
16707                                     else if (PASS2) {
16708                                         ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
16709                                     }
16710                                     break; /* <value> contains the first code
16711                                               point. Drop out of the switch to
16712                                               process it */
16713                                 }
16714                                 else {
16715                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
16716                                                  RExC_parse - backslash_N_beg);
16717                                     multi_char_matches
16718                                         = add_multi_match(multi_char_matches,
16719                                                           multi_char_N,
16720                                                           cp_count);
16721                                 }
16722                             }
16723                         } /* End of cp_count != 1 */
16724
16725                         /* This element should not be processed further in this
16726                          * class */
16727                         element_count--;
16728                         value = save_value;
16729                         prevvalue = save_prevvalue;
16730                         continue;   /* Back to top of loop to get next char */
16731                     }
16732
16733                     /* Here, is a single code point, and <value> contains it */
16734                     unicode_range = TRUE;   /* \N{} are Unicode */
16735                 }
16736                 break;
16737             case 'p':
16738             case 'P':
16739                 {
16740                 char *e;
16741                 char *i;
16742
16743
16744                 /* We will handle any undefined properties ourselves */
16745                 U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
16746                                        /* And we actually would prefer to get
16747                                         * the straight inversion list of the
16748                                         * swash, since we will be accessing it
16749                                         * anyway, to save a little time */
16750                                       |_CORE_SWASH_INIT_ACCEPT_INVLIST;
16751
16752                 SvREFCNT_dec(swash); /* Free any left-overs */
16753                 if (RExC_parse >= RExC_end)
16754                     vFAIL2("Empty \\%c", (U8)value);
16755                 if (*RExC_parse == '{') {
16756                     const U8 c = (U8)value;
16757                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
16758                     if (!e) {
16759                         RExC_parse++;
16760                         vFAIL2("Missing right brace on \\%c{}", c);
16761                     }
16762
16763                     RExC_parse++;
16764
16765                     /* White space is allowed adjacent to the braces and after
16766                      * any '^', even when not under /x */
16767                     while (isSPACE(*RExC_parse)) {
16768                          RExC_parse++;
16769                     }
16770
16771                     if (UCHARAT(RExC_parse) == '^') {
16772
16773                         /* toggle.  (The rhs xor gets the single bit that
16774                          * differs between P and p; the other xor inverts just
16775                          * that bit) */
16776                         value ^= 'P' ^ 'p';
16777
16778                         RExC_parse++;
16779                         while (isSPACE(*RExC_parse)) {
16780                             RExC_parse++;
16781                         }
16782                     }
16783
16784                     if (e == RExC_parse)
16785                         vFAIL2("Empty \\%c{}", c);
16786
16787                     n = e - RExC_parse;
16788                     while (isSPACE(*(RExC_parse + n - 1)))
16789                         n--;
16790
16791                 }   /* The \p isn't immediately followed by a '{' */
16792                 else if (! isALPHA(*RExC_parse)) {
16793                     RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16794                     vFAIL2("Character following \\%c must be '{' or a "
16795                            "single-character Unicode property name",
16796                            (U8) value);
16797                 }
16798                 else {
16799                     e = RExC_parse;
16800                     n = 1;
16801                 }
16802                 if (!SIZE_ONLY) {
16803                     char* name = RExC_parse;
16804                     char* base_name;    /* name after any packages are stripped */
16805                     char* lookup_name = NULL;
16806                     const char * const colon_colon = "::";
16807                     bool invert;
16808
16809                     SV* invlist;
16810
16811                     /* Temporary workaround for [perl #133136].  For this
16812                     * precise input that is in the .t that is failing, load
16813                     * utf8.pm, which is what the test wants, so that that
16814                     * .t passes */
16815                     if (     memEQs(RExC_start, e + 1 - RExC_start,
16816                                     "foo\\p{Alnum}")
16817                         && ! hv_common(GvHVn(PL_incgv),
16818                                        NULL,
16819                                        "utf8.pm", sizeof("utf8.pm") - 1,
16820                                        0, HV_FETCH_ISEXISTS, NULL, 0))
16821                     {
16822                         require_pv("utf8.pm");
16823                     }
16824                     invlist = parse_uniprop_string(name, n, FOLD, &invert);
16825                     if (invlist) {
16826                         if (invert) {
16827                             value ^= 'P' ^ 'p';
16828                         }
16829                     }
16830                     else {
16831
16832                     /* Try to get the definition of the property into
16833                      * <invlist>.  If /i is in effect, the effective property
16834                      * will have its name be <__NAME_i>.  The design is
16835                      * discussed in commit
16836                      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
16837                     name = savepv(Perl_form(aTHX_ "%.*s", (int)n, RExC_parse));
16838                     SAVEFREEPV(name);
16839
16840                     for (i = RExC_parse; i < RExC_parse + n; i++) {
16841                         if (isCNTRL(*i) && *i != '\t') {
16842                             RExC_parse = e + 1;
16843                             vFAIL2("Can't find Unicode property definition \"%s\"", name);
16844                         }
16845                     }
16846
16847                     if (FOLD) {
16848                         lookup_name = savepv(Perl_form(aTHX_ "__%s_i", name));
16849
16850                         /* The function call just below that uses this can fail
16851                          * to return, leaking memory if we don't do this */
16852                         SAVEFREEPV(lookup_name);
16853                     }
16854
16855                     /* Look up the property name, and get its swash and
16856                      * inversion list, if the property is found  */
16857                     swash = _core_swash_init("utf8",
16858                                              (lookup_name)
16859                                               ? lookup_name
16860                                               : name,
16861                                              &PL_sv_undef,
16862                                              1, /* binary */
16863                                              0, /* not tr/// */
16864                                              NULL, /* No inversion list */
16865                                              &swash_init_flags
16866                                             );
16867                     if (! swash || ! (invlist = _get_swash_invlist(swash))) {
16868                         HV* curpkg = (IN_PERL_COMPILETIME)
16869                                       ? PL_curstash
16870                                       : CopSTASH(PL_curcop);
16871                         UV final_n = n;
16872                         bool has_pkg;
16873
16874                         if (swash) {    /* Got a swash but no inversion list.
16875                                            Something is likely wrong that will
16876                                            be sorted-out later */
16877                             SvREFCNT_dec_NN(swash);
16878                             swash = NULL;
16879                         }
16880
16881                         /* Here didn't find it.  It could be a an error (like a
16882                          * typo) in specifying a Unicode property, or it could
16883                          * be a user-defined property that will be available at
16884                          * run-time.  The names of these must begin with 'In'
16885                          * or 'Is' (after any packages are stripped off).  So
16886                          * if not one of those, or if we accept only
16887                          * compile-time properties, is an error; otherwise add
16888                          * it to the list for run-time look up. */
16889                         if ((base_name = rninstr(name, name + n,
16890                                                  colon_colon, colon_colon + 2)))
16891                         { /* Has ::.  We know this must be a user-defined
16892                              property */
16893                             base_name += 2;
16894                             final_n -= base_name - name;
16895                             has_pkg = TRUE;
16896                         }
16897                         else {
16898                             base_name = name;
16899                             has_pkg = FALSE;
16900                         }
16901
16902                         if (   final_n < 3
16903                             || base_name[0] != 'I'
16904                             || (base_name[1] != 's' && base_name[1] != 'n')
16905                             || ret_invlist)
16906                         {
16907                             const char * const msg
16908                                 = (has_pkg)
16909                                   ? "Illegal user-defined property name"
16910                                   : "Can't find Unicode property definition";
16911                             RExC_parse = e + 1;
16912
16913                             /* diag_listed_as: Can't find Unicode property definition "%s" */
16914                             vFAIL3utf8f("%s \"%" UTF8f "\"",
16915                                 msg, UTF8fARG(UTF, n, name));
16916                         }
16917
16918                         /* If the property name doesn't already have a package
16919                          * name, add the current one to it so that it can be
16920                          * referred to outside it. [perl #121777] */
16921                         if (! has_pkg && curpkg) {
16922                             char* pkgname = HvNAME(curpkg);
16923                             if (memNEs(pkgname, HvNAMELEN(curpkg), "main")) {
16924                                 char* full_name = Perl_form(aTHX_
16925                                                             "%s::%s",
16926                                                             pkgname,
16927                                                             name);
16928                                 n = strlen(full_name);
16929                                 name = savepvn(full_name, n);
16930                                 SAVEFREEPV(name);
16931                             }
16932                         }
16933                         Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s%" UTF8f "%s\n",
16934                                         (value == 'p' ? '+' : '!'),
16935                                         (FOLD) ? "__" : "",
16936                                         UTF8fARG(UTF, n, name),
16937                                         (FOLD) ? "_i" : "");
16938                         has_user_defined_property = TRUE;
16939                         optimizable = FALSE;    /* Will have to leave this an
16940                                                    ANYOF node */
16941
16942                         /* We don't know yet what this matches, so have to flag
16943                          * it */
16944                         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
16945                     }
16946                     else {
16947
16948                         /* Here, did get the swash and its inversion list.  If
16949                          * the swash is from a user-defined property, then this
16950                          * whole character class should be regarded as such */
16951                         if (swash_init_flags
16952                             & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
16953                         {
16954                             has_user_defined_property = TRUE;
16955                         }
16956                     }
16957                     }
16958                     if (invlist) {
16959                         if (! has_user_defined_property &&
16960                             /* We warn on matching an above-Unicode code point
16961                              * if the match would return true, except don't
16962                              * warn for \p{All}, which has exactly one element
16963                              * = 0 */
16964                             (_invlist_contains_cp(invlist, 0x110000)
16965                                 && (! (_invlist_len(invlist) == 1
16966                                        && *invlist_array(invlist) == 0))))
16967                         {
16968                             warn_super = TRUE;
16969                         }
16970
16971                         /* Invert if asking for the complement */
16972                         if (value == 'P') {
16973                             _invlist_union_complement_2nd(properties,
16974                                                           invlist,
16975                                                           &properties);
16976
16977                             /* The swash can't be used as-is, because we've
16978                              * inverted things; delay removing it to here after
16979                              * have copied its invlist above */
16980                             if (! swash) {
16981                                 SvREFCNT_dec_NN(invlist);
16982                             }
16983                             SvREFCNT_dec(swash);
16984                             swash = NULL;
16985                         }
16986                         else {
16987                             _invlist_union(properties, invlist, &properties);
16988                             if (! swash) {
16989                                 SvREFCNT_dec_NN(invlist);
16990                             }
16991                         }
16992                     }
16993                 } /* End of actually getting the values in pass 2 */
16994
16995                 RExC_parse = e + 1;
16996                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
16997                                                 named */
16998
16999                 /* \p means they want Unicode semantics */
17000                 REQUIRE_UNI_RULES(flagp, NULL);
17001                 }
17002                 break;
17003             case 'n':   value = '\n';                   break;
17004             case 'r':   value = '\r';                   break;
17005             case 't':   value = '\t';                   break;
17006             case 'f':   value = '\f';                   break;
17007             case 'b':   value = '\b';                   break;
17008             case 'e':   value = ESC_NATIVE;             break;
17009             case 'a':   value = '\a';                   break;
17010             case 'o':
17011                 RExC_parse--;   /* function expects to be pointed at the 'o' */
17012                 {
17013                     const char* error_msg;
17014                     bool valid = grok_bslash_o(&RExC_parse,
17015                                                RExC_end,
17016                                                &value,
17017                                                &error_msg,
17018                                                PASS2,   /* warnings only in
17019                                                            pass 2 */
17020                                                strict,
17021                                                silence_non_portable,
17022                                                UTF);
17023                     if (! valid) {
17024                         vFAIL(error_msg);
17025                     }
17026                 }
17027                 non_portable_endpoint++;
17028                 break;
17029             case 'x':
17030                 RExC_parse--;   /* function expects to be pointed at the 'x' */
17031                 {
17032                     const char* error_msg;
17033                     bool valid = grok_bslash_x(&RExC_parse,
17034                                                RExC_end,
17035                                                &value,
17036                                                &error_msg,
17037                                                PASS2, /* Output warnings */
17038                                                strict,
17039                                                silence_non_portable,
17040                                                UTF);
17041                     if (! valid) {
17042                         vFAIL(error_msg);
17043                     }
17044                 }
17045                 non_portable_endpoint++;
17046                 break;
17047             case 'c':
17048                 value = grok_bslash_c(*RExC_parse++, PASS2);
17049                 non_portable_endpoint++;
17050                 break;
17051             case '0': case '1': case '2': case '3': case '4':
17052             case '5': case '6': case '7':
17053                 {
17054                     /* Take 1-3 octal digits */
17055                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
17056                     numlen = (strict) ? 4 : 3;
17057                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
17058                     RExC_parse += numlen;
17059                     if (numlen != 3) {
17060                         if (strict) {
17061                             RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
17062                             vFAIL("Need exactly 3 octal digits");
17063                         }
17064                         else if (! SIZE_ONLY /* like \08, \178 */
17065                                  && numlen < 3
17066                                  && RExC_parse < RExC_end
17067                                  && isDIGIT(*RExC_parse)
17068                                  && ckWARN(WARN_REGEXP))
17069                         {
17070                             SAVEFREESV(RExC_rx_sv);
17071                             reg_warn_non_literal_string(
17072                                  RExC_parse + 1,
17073                                  form_short_octal_warning(RExC_parse, numlen));
17074                             (void)ReREFCNT_inc(RExC_rx_sv);
17075                         }
17076                     }
17077                     non_portable_endpoint++;
17078                     break;
17079                 }
17080             default:
17081                 /* Allow \_ to not give an error */
17082                 if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
17083                     if (strict) {
17084                         vFAIL2("Unrecognized escape \\%c in character class",
17085                                (int)value);
17086                     }
17087                     else {
17088                         SAVEFREESV(RExC_rx_sv);
17089                         ckWARN2reg(RExC_parse,
17090                             "Unrecognized escape \\%c in character class passed through",
17091                             (int)value);
17092                         (void)ReREFCNT_inc(RExC_rx_sv);
17093                     }
17094                 }
17095                 break;
17096             }   /* End of switch on char following backslash */
17097         } /* end of handling backslash escape sequences */
17098
17099         /* Here, we have the current token in 'value' */
17100
17101         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
17102             U8 classnum;
17103
17104             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
17105              * literal, as is the character that began the false range, i.e.
17106              * the 'a' in the examples */
17107             if (range) {
17108                 if (!SIZE_ONLY) {
17109                     const int w = (RExC_parse >= rangebegin)
17110                                   ? RExC_parse - rangebegin
17111                                   : 0;
17112                     if (strict) {
17113                         vFAIL2utf8f(
17114                             "False [] range \"%" UTF8f "\"",
17115                             UTF8fARG(UTF, w, rangebegin));
17116                     }
17117                     else {
17118                         SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
17119                         ckWARN2reg(RExC_parse,
17120                             "False [] range \"%" UTF8f "\"",
17121                             UTF8fARG(UTF, w, rangebegin));
17122                         (void)ReREFCNT_inc(RExC_rx_sv);
17123                         cp_list = add_cp_to_invlist(cp_list, '-');
17124                         cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
17125                                                              prevvalue);
17126                     }
17127                 }
17128
17129                 range = 0; /* this was not a true range */
17130                 element_count += 2; /* So counts for three values */
17131             }
17132
17133             classnum = namedclass_to_classnum(namedclass);
17134
17135             if (LOC && namedclass < ANYOF_POSIXL_MAX
17136 #ifndef HAS_ISASCII
17137                 && classnum != _CC_ASCII
17138 #endif
17139             ) {
17140                 /* What the Posix classes (like \w, [:space:]) match in locale
17141                  * isn't knowable under locale until actual match time.  Room
17142                  * must be reserved (one time per outer bracketed class) to
17143                  * store such classes.  The space will contain a bit for each
17144                  * named class that is to be matched against.  This isn't
17145                  * needed for \p{} and pseudo-classes, as they are not affected
17146                  * by locale, and hence are dealt with separately */
17147                 if (! need_class) {
17148                     need_class = 1;
17149                     if (SIZE_ONLY) {
17150                         RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
17151                     }
17152                     else {
17153                         RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
17154                     }
17155                     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
17156                     ANYOF_POSIXL_ZERO(ret);
17157
17158                     /* We can't change this into some other type of node
17159                      * (unless this is the only element, in which case there
17160                      * are nodes that mean exactly this) as has runtime
17161                      * dependencies */
17162                     optimizable = FALSE;
17163                 }
17164
17165                 /* Coverity thinks it is possible for this to be negative; both
17166                  * jhi and khw think it's not, but be safer */
17167                 assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
17168                        || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
17169
17170                 /* See if it already matches the complement of this POSIX
17171                  * class */
17172                 if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
17173                     && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
17174                                                             ? -1
17175                                                             : 1)))
17176                 {
17177                     posixl_matches_all = TRUE;
17178                     break;  /* No need to continue.  Since it matches both
17179                                e.g., \w and \W, it matches everything, and the
17180                                bracketed class can be optimized into qr/./s */
17181                 }
17182
17183                 /* Add this class to those that should be checked at runtime */
17184                 ANYOF_POSIXL_SET(ret, namedclass);
17185
17186                 /* The above-Latin1 characters are not subject to locale rules.
17187                  * Just add them, in the second pass, to the
17188                  * unconditionally-matched list */
17189                 if (! SIZE_ONLY) {
17190                     SV* scratch_list = NULL;
17191
17192                     /* Get the list of the above-Latin1 code points this
17193                      * matches */
17194                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
17195                                           PL_XPosix_ptrs[classnum],
17196
17197                                           /* Odd numbers are complements, like
17198                                            * NDIGIT, NASCII, ... */
17199                                           namedclass % 2 != 0,
17200                                           &scratch_list);
17201                     /* Checking if 'cp_list' is NULL first saves an extra
17202                      * clone.  Its reference count will be decremented at the
17203                      * next union, etc, or if this is the only instance, at the
17204                      * end of the routine */
17205                     if (! cp_list) {
17206                         cp_list = scratch_list;
17207                     }
17208                     else {
17209                         _invlist_union(cp_list, scratch_list, &cp_list);
17210                         SvREFCNT_dec_NN(scratch_list);
17211                     }
17212                     continue;   /* Go get next character */
17213                 }
17214             }
17215             else if (! SIZE_ONLY) {
17216
17217                 /* Here, not in pass1 (in that pass we skip calculating the
17218                  * contents of this class), and is not /l, or is a POSIX class
17219                  * for which /l doesn't matter (or is a Unicode property, which
17220                  * is skipped here). */
17221                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
17222                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
17223
17224                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
17225                          * nor /l make a difference in what these match,
17226                          * therefore we just add what they match to cp_list. */
17227                         if (classnum != _CC_VERTSPACE) {
17228                             assert(   namedclass == ANYOF_HORIZWS
17229                                    || namedclass == ANYOF_NHORIZWS);
17230
17231                             /* It turns out that \h is just a synonym for
17232                              * XPosixBlank */
17233                             classnum = _CC_BLANK;
17234                         }
17235
17236                         _invlist_union_maybe_complement_2nd(
17237                                 cp_list,
17238                                 PL_XPosix_ptrs[classnum],
17239                                 namedclass % 2 != 0,    /* Complement if odd
17240                                                           (NHORIZWS, NVERTWS)
17241                                                         */
17242                                 &cp_list);
17243                     }
17244                 }
17245                 else if (  UNI_SEMANTICS
17246                         || AT_LEAST_ASCII_RESTRICTED
17247                         || classnum == _CC_ASCII
17248                         || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
17249                                                   || classnum == _CC_XDIGIT)))
17250                 {
17251                     /* We usually have to worry about /d a affecting what POSIX
17252                      * classes match, with special code needed because we won't
17253                      * know until runtime what all matches.  But there is no
17254                      * extra work needed under /u and /a; and [:ascii:] is
17255                      * unaffected by /d; and :digit: and :xdigit: don't have
17256                      * runtime differences under /d.  So we can special case
17257                      * these, and avoid some extra work below, and at runtime.
17258                      * */
17259                     _invlist_union_maybe_complement_2nd(
17260                                                      simple_posixes,
17261                                                       ((AT_LEAST_ASCII_RESTRICTED)
17262                                                        ? PL_Posix_ptrs[classnum]
17263                                                        : PL_XPosix_ptrs[classnum]),
17264                                                      namedclass % 2 != 0,
17265                                                      &simple_posixes);
17266                 }
17267                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
17268                            complement and use nposixes */
17269                     SV** posixes_ptr = namedclass % 2 == 0
17270                                        ? &posixes
17271                                        : &nposixes;
17272                     _invlist_union_maybe_complement_2nd(
17273                                                      *posixes_ptr,
17274                                                      PL_XPosix_ptrs[classnum],
17275                                                      namedclass % 2 != 0,
17276                                                      posixes_ptr);
17277                 }
17278             }
17279         } /* end of namedclass \blah */
17280
17281         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17282
17283         /* If 'range' is set, 'value' is the ending of a range--check its
17284          * validity.  (If value isn't a single code point in the case of a
17285          * range, we should have figured that out above in the code that
17286          * catches false ranges).  Later, we will handle each individual code
17287          * point in the range.  If 'range' isn't set, this could be the
17288          * beginning of a range, so check for that by looking ahead to see if
17289          * the next real character to be processed is the range indicator--the
17290          * minus sign */
17291
17292         if (range) {
17293 #ifdef EBCDIC
17294             /* For unicode ranges, we have to test that the Unicode as opposed
17295              * to the native values are not decreasing.  (Above 255, there is
17296              * no difference between native and Unicode) */
17297             if (unicode_range && prevvalue < 255 && value < 255) {
17298                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
17299                     goto backwards_range;
17300                 }
17301             }
17302             else
17303 #endif
17304             if (prevvalue > value) /* b-a */ {
17305                 int w;
17306 #ifdef EBCDIC
17307               backwards_range:
17308 #endif
17309                 w = RExC_parse - rangebegin;
17310                 vFAIL2utf8f(
17311                     "Invalid [] range \"%" UTF8f "\"",
17312                     UTF8fARG(UTF, w, rangebegin));
17313                 NOT_REACHED; /* NOTREACHED */
17314             }
17315         }
17316         else {
17317             prevvalue = value; /* save the beginning of the potential range */
17318             if (! stop_at_1     /* Can't be a range if parsing just one thing */
17319                 && *RExC_parse == '-')
17320             {
17321                 char* next_char_ptr = RExC_parse + 1;
17322
17323                 /* Get the next real char after the '-' */
17324                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
17325
17326                 /* If the '-' is at the end of the class (just before the ']',
17327                  * it is a literal minus; otherwise it is a range */
17328                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
17329                     RExC_parse = next_char_ptr;
17330
17331                     /* a bad range like \w-, [:word:]- ? */
17332                     if (namedclass > OOB_NAMEDCLASS) {
17333                         if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
17334                             const int w = RExC_parse >= rangebegin
17335                                           ?  RExC_parse - rangebegin
17336                                           : 0;
17337                             if (strict) {
17338                                 vFAIL4("False [] range \"%*.*s\"",
17339                                     w, w, rangebegin);
17340                             }
17341                             else if (PASS2) {
17342                                 vWARN4(RExC_parse,
17343                                     "False [] range \"%*.*s\"",
17344                                     w, w, rangebegin);
17345                             }
17346                         }
17347                         if (!SIZE_ONLY) {
17348                             cp_list = add_cp_to_invlist(cp_list, '-');
17349                         }
17350                         element_count++;
17351                     } else
17352                         range = 1;      /* yeah, it's a range! */
17353                     continue;   /* but do it the next time */
17354                 }
17355             }
17356         }
17357
17358         if (namedclass > OOB_NAMEDCLASS) {
17359             continue;
17360         }
17361
17362         /* Here, we have a single value this time through the loop, and
17363          * <prevvalue> is the beginning of the range, if any; or <value> if
17364          * not. */
17365
17366         /* non-Latin1 code point implies unicode semantics.  Must be set in
17367          * pass1 so is there for the whole of pass 2 */
17368         if (value > 255) {
17369             REQUIRE_UNI_RULES(flagp, NULL);
17370         }
17371
17372         /* Ready to process either the single value, or the completed range.
17373          * For single-valued non-inverted ranges, we consider the possibility
17374          * of multi-char folds.  (We made a conscious decision to not do this
17375          * for the other cases because it can often lead to non-intuitive
17376          * results.  For example, you have the peculiar case that:
17377          *  "s s" =~ /^[^\xDF]+$/i => Y
17378          *  "ss"  =~ /^[^\xDF]+$/i => N
17379          *
17380          * See [perl #89750] */
17381         if (FOLD && allow_multi_folds && value == prevvalue) {
17382             if (value == LATIN_SMALL_LETTER_SHARP_S
17383                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
17384                                                         value)))
17385             {
17386                 /* Here <value> is indeed a multi-char fold.  Get what it is */
17387
17388                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17389                 STRLEN foldlen;
17390
17391                 UV folded = _to_uni_fold_flags(
17392                                 value,
17393                                 foldbuf,
17394                                 &foldlen,
17395                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
17396                                                    ? FOLD_FLAGS_NOMIX_ASCII
17397                                                    : 0)
17398                                 );
17399
17400                 /* Here, <folded> should be the first character of the
17401                  * multi-char fold of <value>, with <foldbuf> containing the
17402                  * whole thing.  But, if this fold is not allowed (because of
17403                  * the flags), <fold> will be the same as <value>, and should
17404                  * be processed like any other character, so skip the special
17405                  * handling */
17406                 if (folded != value) {
17407
17408                     /* Skip if we are recursed, currently parsing the class
17409                      * again.  Otherwise add this character to the list of
17410                      * multi-char folds. */
17411                     if (! RExC_in_multi_char_class) {
17412                         STRLEN cp_count = utf8_length(foldbuf,
17413                                                       foldbuf + foldlen);
17414                         SV* multi_fold = sv_2mortal(newSVpvs(""));
17415
17416                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
17417
17418                         multi_char_matches
17419                                         = add_multi_match(multi_char_matches,
17420                                                           multi_fold,
17421                                                           cp_count);
17422
17423                     }
17424
17425                     /* This element should not be processed further in this
17426                      * class */
17427                     element_count--;
17428                     value = save_value;
17429                     prevvalue = save_prevvalue;
17430                     continue;
17431                 }
17432             }
17433         }
17434
17435         if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
17436             if (range) {
17437
17438                 /* If the range starts above 255, everything is portable and
17439                  * likely to be so for any forseeable character set, so don't
17440                  * warn. */
17441                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
17442                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
17443                 }
17444                 else if (prevvalue != value) {
17445
17446                     /* Under strict, ranges that stop and/or end in an ASCII
17447                      * printable should have each end point be a portable value
17448                      * for it (preferably like 'A', but we don't warn if it is
17449                      * a (portable) Unicode name or code point), and the range
17450                      * must be be all digits or all letters of the same case.
17451                      * Otherwise, the range is non-portable and unclear as to
17452                      * what it contains */
17453                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
17454                         && (          non_portable_endpoint
17455                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
17456                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
17457                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
17458                     ))) {
17459                         vWARN(RExC_parse, "Ranges of ASCII printables should"
17460                                           " be some subset of \"0-9\","
17461                                           " \"A-Z\", or \"a-z\"");
17462                     }
17463                     else if (prevvalue >= FIRST_NON_ASCII_DECIMAL_DIGIT) {
17464                         SSize_t index_start;
17465                         SSize_t index_final;
17466
17467                         /* But the nature of Unicode and languages mean we
17468                          * can't do the same checks for above-ASCII ranges,
17469                          * except in the case of digit ones.  These should
17470                          * contain only digits from the same group of 10.  The
17471                          * ASCII case is handled just above.  Hence here, the
17472                          * range could be a range of digits.  First some
17473                          * unlikely special cases.  Grandfather in that a range
17474                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
17475                          * if its starting value is one of the 10 digits prior
17476                          * to it.  This is because it is an alternate way of
17477                          * writing 19D1, and some people may expect it to be in
17478                          * that group.  But it is bad, because it won't give
17479                          * the expected results.  In Unicode 5.2 it was
17480                          * considered to be in that group (of 11, hence), but
17481                          * this was fixed in the next version */
17482
17483                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
17484                             goto warn_bad_digit_range;
17485                         }
17486                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17487                                           &&     value <= 0x1D7FF))
17488                         {
17489                             /* This is the only other case currently in Unicode
17490                              * where the algorithm below fails.  The code
17491                              * points just above are the end points of a single
17492                              * range containing only decimal digits.  It is 5
17493                              * different series of 0-9.  All other ranges of
17494                              * digits currently in Unicode are just a single
17495                              * series.  (And mktables will notify us if a later
17496                              * Unicode version breaks this.)
17497                              *
17498                              * If the range being checked is at most 9 long,
17499                              * and the digit values represented are in
17500                              * numerical order, they are from the same series.
17501                              * */
17502                             if (         value - prevvalue > 9
17503                                 ||    (((    value - 0x1D7CE) % 10)
17504                                      <= (prevvalue - 0x1D7CE) % 10))
17505                             {
17506                                 goto warn_bad_digit_range;
17507                             }
17508                         }
17509                         else {
17510
17511                             /* For all other ranges of digits in Unicode, the
17512                              * algorithm is just to check if both end points
17513                              * are in the same series, which is the same range.
17514                              * */
17515                             index_start = _invlist_search(
17516                                                     PL_XPosix_ptrs[_CC_DIGIT],
17517                                                     prevvalue);
17518
17519                             /* Warn if the range starts and ends with a digit,
17520                              * and they are not in the same group of 10. */
17521                             if (   index_start >= 0
17522                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17523                                 && (index_final =
17524                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17525                                                     value)) != index_start
17526                                 && index_final >= 0
17527                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17528                             {
17529                               warn_bad_digit_range:
17530                                 vWARN(RExC_parse, "Ranges of digits should be"
17531                                                   " from the same group of"
17532                                                   " 10");
17533                             }
17534                         }
17535                     }
17536                 }
17537             }
17538             if ((! range || prevvalue == value) && non_portable_endpoint) {
17539                 if (isPRINT_A(value)) {
17540                     char literal[3];
17541                     unsigned d = 0;
17542                     if (isBACKSLASHED_PUNCT(value)) {
17543                         literal[d++] = '\\';
17544                     }
17545                     literal[d++] = (char) value;
17546                     literal[d++] = '\0';
17547
17548                     vWARN4(RExC_parse,
17549                            "\"%.*s\" is more clearly written simply as \"%s\"",
17550                            (int) (RExC_parse - rangebegin),
17551                            rangebegin,
17552                            literal
17553                         );
17554                 }
17555                 else if isMNEMONIC_CNTRL(value) {
17556                     vWARN4(RExC_parse,
17557                            "\"%.*s\" is more clearly written simply as \"%s\"",
17558                            (int) (RExC_parse - rangebegin),
17559                            rangebegin,
17560                            cntrl_to_mnemonic((U8) value)
17561                         );
17562                 }
17563             }
17564         }
17565
17566         /* Deal with this element of the class */
17567         if (! SIZE_ONLY) {
17568
17569 #ifndef EBCDIC
17570             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17571                                                      prevvalue, value);
17572 #else
17573             /* On non-ASCII platforms, for ranges that span all of 0..255, and
17574              * ones that don't require special handling, we can just add the
17575              * range like we do for ASCII platforms */
17576             if ((UNLIKELY(prevvalue == 0) && value >= 255)
17577                 || ! (prevvalue < 256
17578                       && (unicode_range
17579                           || (! non_portable_endpoint
17580                               && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17581                                   || (isUPPER_A(prevvalue)
17582                                       && isUPPER_A(value)))))))
17583             {
17584                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17585                                                          prevvalue, value);
17586             }
17587             else {
17588                 /* Here, requires special handling.  This can be because it is
17589                  * a range whose code points are considered to be Unicode, and
17590                  * so must be individually translated into native, or because
17591                  * its a subrange of 'A-Z' or 'a-z' which each aren't
17592                  * contiguous in EBCDIC, but we have defined them to include
17593                  * only the "expected" upper or lower case ASCII alphabetics.
17594                  * Subranges above 255 are the same in native and Unicode, so
17595                  * can be added as a range */
17596                 U8 start = NATIVE_TO_LATIN1(prevvalue);
17597                 unsigned j;
17598                 U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17599                 for (j = start; j <= end; j++) {
17600                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17601                 }
17602                 if (value > 255) {
17603                     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17604                                                              256, value);
17605                 }
17606             }
17607 #endif
17608         }
17609
17610         range = 0; /* this range (if it was one) is done now */
17611     } /* End of loop through all the text within the brackets */
17612
17613
17614     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17615         output_or_return_posix_warnings(pRExC_state, posix_warnings,
17616                                         return_posix_warnings);
17617     }
17618
17619     /* If anything in the class expands to more than one character, we have to
17620      * deal with them by building up a substitute parse string, and recursively
17621      * calling reg() on it, instead of proceeding */
17622     if (multi_char_matches) {
17623         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
17624         I32 cp_count;
17625         STRLEN len;
17626         char *save_end = RExC_end;
17627         char *save_parse = RExC_parse;
17628         char *save_start = RExC_start;
17629         STRLEN prefix_end = 0;      /* We copy the character class after a
17630                                        prefix supplied here.  This is the size
17631                                        + 1 of that prefix */
17632         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
17633                                        a "|" */
17634         I32 reg_flags;
17635
17636         assert(! invert);
17637         assert(RExC_precomp_adj == 0); /* Only one level of recursion allowed */
17638
17639 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
17640            because too confusing */
17641         if (invert) {
17642             sv_catpvs(substitute_parse, "(?:");
17643         }
17644 #endif
17645
17646         /* Look at the longest folds first */
17647         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
17648                         cp_count > 0;
17649                         cp_count--)
17650         {
17651
17652             if (av_exists(multi_char_matches, cp_count)) {
17653                 AV** this_array_ptr;
17654                 SV* this_sequence;
17655
17656                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
17657                                                  cp_count, FALSE);
17658                 while ((this_sequence = av_pop(*this_array_ptr)) !=
17659                                                                 &PL_sv_undef)
17660                 {
17661                     if (! first_time) {
17662                         sv_catpvs(substitute_parse, "|");
17663                     }
17664                     first_time = FALSE;
17665
17666                     sv_catpv(substitute_parse, SvPVX(this_sequence));
17667                 }
17668             }
17669         }
17670
17671         /* If the character class contains anything else besides these
17672          * multi-character folds, have to include it in recursive parsing */
17673         if (element_count) {
17674             sv_catpvs(substitute_parse, "|[");
17675             prefix_end = SvCUR(substitute_parse);
17676             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
17677
17678             /* Put in a closing ']' only if not going off the end, as otherwise
17679              * we are adding something that really isn't there */
17680             if (RExC_parse < RExC_end) {
17681                 sv_catpvs(substitute_parse, "]");
17682             }
17683         }
17684
17685         sv_catpvs(substitute_parse, ")");
17686 #if 0
17687         if (invert) {
17688             /* This is a way to get the parse to skip forward a whole named
17689              * sequence instead of matching the 2nd character when it fails the
17690              * first */
17691             sv_catpvs(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
17692         }
17693 #endif
17694
17695         /* Set up the data structure so that any errors will be properly
17696          * reported.  See the comments at the definition of
17697          * REPORT_LOCATION_ARGS for details */
17698         RExC_precomp_adj = orig_parse - RExC_precomp;
17699         RExC_start =  RExC_parse = SvPV(substitute_parse, len);
17700         RExC_adjusted_start = RExC_start + prefix_end;
17701         RExC_end = RExC_parse + len;
17702         RExC_in_multi_char_class = 1;
17703         RExC_emit = (regnode *)orig_emit;
17704
17705         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
17706
17707         *flagp |= reg_flags & (HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PASS1|NEED_UTF8);
17708
17709         /* And restore so can parse the rest of the pattern */
17710         RExC_parse = save_parse;
17711         RExC_start = RExC_adjusted_start = save_start;
17712         RExC_precomp_adj = 0;
17713         RExC_end = save_end;
17714         RExC_in_multi_char_class = 0;
17715         SvREFCNT_dec_NN(multi_char_matches);
17716         return ret;
17717     }
17718
17719     /* Here, we've gone through the entire class and dealt with multi-char
17720      * folds.  We are now in a position that we can do some checks to see if we
17721      * can optimize this ANYOF node into a simpler one, even in Pass 1.
17722      * Currently we only do two checks:
17723      * 1) is in the unlikely event that the user has specified both, eg. \w and
17724      *    \W under /l, then the class matches everything.  (This optimization
17725      *    is done only to make the optimizer code run later work.)
17726      * 2) if the character class contains only a single element (including a
17727      *    single range), we see if there is an equivalent node for it.
17728      * Other checks are possible */
17729     if (   optimizable
17730         && ! ret_invlist   /* Can't optimize if returning the constructed
17731                               inversion list */
17732         && (UNLIKELY(posixl_matches_all) || element_count == 1))
17733     {
17734         U8 op = END;
17735         U8 arg = 0;
17736
17737         if (UNLIKELY(posixl_matches_all)) {
17738             op = SANY;
17739         }
17740         else if (namedclass > OOB_NAMEDCLASS) { /* this is a single named
17741                                                    class, like \w or [:digit:]
17742                                                    or \p{foo} */
17743
17744             /* All named classes are mapped into POSIXish nodes, with its FLAG
17745              * argument giving which class it is */
17746             switch ((I32)namedclass) {
17747                 case ANYOF_UNIPROP:
17748                     break;
17749
17750                 /* These don't depend on the charset modifiers.  They always
17751                  * match under /u rules */
17752                 case ANYOF_NHORIZWS:
17753                 case ANYOF_HORIZWS:
17754                     namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
17755                     /* FALLTHROUGH */
17756
17757                 case ANYOF_NVERTWS:
17758                 case ANYOF_VERTWS:
17759                     op = POSIXU;
17760                     goto join_posix;
17761
17762                 /* The actual POSIXish node for all the rest depends on the
17763                  * charset modifier.  The ones in the first set depend only on
17764                  * ASCII or, if available on this platform, also locale */
17765
17766                 case ANYOF_ASCII:
17767                 case ANYOF_NASCII:
17768
17769 #ifdef HAS_ISASCII
17770                     if (LOC) {
17771                         op = POSIXL;
17772                         goto join_posix;
17773                     }
17774 #endif
17775                     /* (named_class - ANYOF_ASCII) is 0 or 1. xor'ing with
17776                      * invert converts that to 1 or 0 */
17777                     op = ASCII + ((namedclass - ANYOF_ASCII) ^ invert);
17778                     break;
17779
17780                 /* The following don't have any matches in the upper Latin1
17781                  * range, hence /d is equivalent to /u for them.  Making it /u
17782                  * saves some branches at runtime */
17783                 case ANYOF_DIGIT:
17784                 case ANYOF_NDIGIT:
17785                 case ANYOF_XDIGIT:
17786                 case ANYOF_NXDIGIT:
17787                     if (! DEPENDS_SEMANTICS) {
17788                         goto treat_as_default;
17789                     }
17790
17791                     op = POSIXU;
17792                     goto join_posix;
17793
17794                 /* The following change to CASED under /i */
17795                 case ANYOF_LOWER:
17796                 case ANYOF_NLOWER:
17797                 case ANYOF_UPPER:
17798                 case ANYOF_NUPPER:
17799                     if (FOLD) {
17800                         namedclass = ANYOF_CASED + (namedclass % 2);
17801                     }
17802                     /* FALLTHROUGH */
17803
17804                 /* The rest have more possibilities depending on the charset.
17805                  * We take advantage of the enum ordering of the charset
17806                  * modifiers to get the exact node type, */
17807                 default:
17808                   treat_as_default:
17809                     op = POSIXD + get_regex_charset(RExC_flags);
17810                     if (op > POSIXA) { /* /aa is same as /a */
17811                         op = POSIXA;
17812                     }
17813
17814                   join_posix:
17815                     /* The odd numbered ones are the complements of the
17816                      * next-lower even number one */
17817                     if (namedclass % 2 == 1) {
17818                         invert = ! invert;
17819                         namedclass--;
17820                     }
17821                     arg = namedclass_to_classnum(namedclass);
17822                     break;
17823             }
17824         }
17825         else if (value == prevvalue) {
17826
17827             /* Here, the class consists of just a single code point */
17828
17829             if (invert) {
17830                 if (! LOC && value == '\n') {
17831                     op = REG_ANY; /* Optimize [^\n] */
17832                     *flagp |= HASWIDTH|SIMPLE;
17833                     MARK_NAUGHTY(1);
17834                 }
17835             }
17836             else if (value < 256 || UTF) {
17837
17838                 /* Optimize a single value into an EXACTish node, but not if it
17839                  * would require converting the pattern to UTF-8. */
17840                 op = compute_EXACTish(pRExC_state);
17841             }
17842         } /* Otherwise is a range */
17843         else if (! LOC) {   /* locale could vary these */
17844             if (prevvalue == '0') {
17845                 if (value == '9') {
17846                     arg = _CC_DIGIT;
17847                     op = POSIXA;
17848                 }
17849             }
17850             else if (! FOLD || ASCII_FOLD_RESTRICTED) {
17851                 /* We can optimize A-Z or a-z, but not if they could match
17852                  * something like the KELVIN SIGN under /i. */
17853                 if (prevvalue == 'A') {
17854                     if (value == 'Z'
17855 #ifdef EBCDIC
17856                         && ! non_portable_endpoint
17857 #endif
17858                     ) {
17859                         arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
17860                         op = POSIXA;
17861                     }
17862                 }
17863                 else if (prevvalue == 'a') {
17864                     if (value == 'z'
17865 #ifdef EBCDIC
17866                         && ! non_portable_endpoint
17867 #endif
17868                     ) {
17869                         arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
17870                         op = POSIXA;
17871                     }
17872                 }
17873             }
17874         }
17875
17876         /* Here, we have changed <op> away from its initial value iff we found
17877          * an optimization */
17878         if (op != END) {
17879
17880             /* Throw away this ANYOF regnode, and emit the calculated one,
17881              * which should correspond to the beginning, not current, state of
17882              * the parse */
17883             const char * cur_parse = RExC_parse;
17884             RExC_parse = (char *)orig_parse;
17885             if ( SIZE_ONLY) {
17886                 if (! LOC) {
17887
17888                     /* To get locale nodes to not use the full ANYOF size would
17889                      * require moving the code above that writes the portions
17890                      * of it that aren't in other nodes to after this point.
17891                      * e.g.  ANYOF_POSIXL_SET */
17892                     RExC_size = orig_size;
17893                 }
17894             }
17895             else {
17896                 RExC_emit = (regnode *)orig_emit;
17897                 if (PL_regkind[op] == POSIXD) {
17898                     if (op == POSIXL) {
17899                         RExC_contains_locale = 1;
17900                     }
17901                     if (invert) {
17902                         op += NPOSIXD - POSIXD;
17903                     }
17904                 }
17905             }
17906
17907             ret = reg_node(pRExC_state, op);
17908
17909             if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
17910                 if (! SIZE_ONLY) {
17911                     FLAGS(ret) = arg;
17912                 }
17913                 *flagp |= HASWIDTH|SIMPLE;
17914             }
17915             else if (PL_regkind[op] == EXACT) {
17916                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
17917                                            TRUE /* downgradable to EXACT */
17918                                            );
17919             }
17920             else {
17921                 *flagp |= HASWIDTH|SIMPLE;
17922             }
17923
17924             RExC_parse = (char *) cur_parse;
17925
17926             SvREFCNT_dec(posixes);
17927             SvREFCNT_dec(nposixes);
17928             SvREFCNT_dec(simple_posixes);
17929             SvREFCNT_dec(cp_list);
17930             SvREFCNT_dec(cp_foldable_list);
17931             return ret;
17932         }
17933     }
17934
17935     if (SIZE_ONLY)
17936         return ret;
17937     /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
17938
17939     /* If folding, we calculate all characters that could fold to or from the
17940      * ones already on the list */
17941     if (cp_foldable_list) {
17942         if (FOLD) {
17943             UV start, end;      /* End points of code point ranges */
17944
17945             SV* fold_intersection = NULL;
17946             SV** use_list;
17947
17948             /* Our calculated list will be for Unicode rules.  For locale
17949              * matching, we have to keep a separate list that is consulted at
17950              * runtime only when the locale indicates Unicode rules.  For
17951              * non-locale, we just use the general list */
17952             if (LOC) {
17953                 use_list = &only_utf8_locale_list;
17954             }
17955             else {
17956                 use_list = &cp_list;
17957             }
17958
17959             /* Only the characters in this class that participate in folds need
17960              * be checked.  Get the intersection of this class and all the
17961              * possible characters that are foldable.  This can quickly narrow
17962              * down a large class */
17963             _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
17964                                   &fold_intersection);
17965
17966             /* Now look at the foldable characters in this class individually */
17967             invlist_iterinit(fold_intersection);
17968             while (invlist_iternext(fold_intersection, &start, &end)) {
17969                 UV j;
17970                 UV folded;
17971
17972                 /* Look at every character in the range */
17973                 for (j = start; j <= end; j++) {
17974                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17975                     STRLEN foldlen;
17976                     unsigned int k;
17977                     Size_t folds_to_count;
17978                     unsigned int first_folds_to;
17979                     const unsigned int * remaining_folds_to_list;
17980
17981                     if (j < 256) {
17982
17983                         if (IS_IN_SOME_FOLD_L1(j)) {
17984
17985                             /* ASCII is always matched; non-ASCII is matched
17986                              * only under Unicode rules (which could happen
17987                              * under /l if the locale is a UTF-8 one */
17988                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
17989                                 *use_list = add_cp_to_invlist(*use_list,
17990                                                             PL_fold_latin1[j]);
17991                             }
17992                             else {
17993                                 has_upper_latin1_only_utf8_matches
17994                                     = add_cp_to_invlist(
17995                                             has_upper_latin1_only_utf8_matches,
17996                                             PL_fold_latin1[j]);
17997                             }
17998                         }
17999
18000                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
18001                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
18002                         {
18003                             add_above_Latin1_folds(pRExC_state,
18004                                                    (U8) j,
18005                                                    use_list);
18006                         }
18007                         continue;
18008                     }
18009
18010                     /* Here is an above Latin1 character.  We don't have the
18011                      * rules hard-coded for it.  First, get its fold.  This is
18012                      * the simple fold, as the multi-character folds have been
18013                      * handled earlier and separated out */
18014                     folded = _to_uni_fold_flags(j, foldbuf, &foldlen,
18015                                                         (ASCII_FOLD_RESTRICTED)
18016                                                         ? FOLD_FLAGS_NOMIX_ASCII
18017                                                         : 0);
18018
18019                     /* Single character fold of above Latin1.  Add everything
18020                      * in its fold closure to the list that this node should
18021                      * match. */
18022                     folds_to_count = _inverse_folds(folded, &first_folds_to,
18023                                                     &remaining_folds_to_list);
18024                     for (k = 0; k <= folds_to_count; k++) {
18025                         UV c = (k == 0)     /* First time through use itself */
18026                                 ? folded
18027                                 : (k == 1)  /* 2nd time use, the first fold */
18028                                    ? first_folds_to
18029
18030                                      /* Then the remaining ones */
18031                                    : remaining_folds_to_list[k-2];
18032
18033                         /* /aa doesn't allow folds between ASCII and non- */
18034                         if ((   ASCII_FOLD_RESTRICTED
18035                             && (isASCII(c) != isASCII(j))))
18036                         {
18037                             continue;
18038                         }
18039
18040                         /* Folds under /l which cross the 255/256 boundary are
18041                          * added to a separate list.  (These are valid only
18042                          * when the locale is UTF-8.) */
18043                         if (c < 256 && LOC) {
18044                             *use_list = add_cp_to_invlist(*use_list, c);
18045                             continue;
18046                         }
18047
18048                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
18049                         {
18050                             cp_list = add_cp_to_invlist(cp_list, c);
18051                         }
18052                         else {
18053                             /* Similarly folds involving non-ascii Latin1
18054                              * characters under /d are added to their list */
18055                             has_upper_latin1_only_utf8_matches
18056                                 = add_cp_to_invlist(
18057                                             has_upper_latin1_only_utf8_matches,
18058                                             c);
18059                         }
18060                     }
18061                 }
18062             }
18063             SvREFCNT_dec_NN(fold_intersection);
18064         }
18065
18066         /* Now that we have finished adding all the folds, there is no reason
18067          * to keep the foldable list separate */
18068         _invlist_union(cp_list, cp_foldable_list, &cp_list);
18069         SvREFCNT_dec_NN(cp_foldable_list);
18070     }
18071
18072     /* And combine the result (if any) with any inversion lists from posix
18073      * classes.  The lists are kept separate up to now because we don't want to
18074      * fold the classes (folding of those is automatically handled by the swash
18075      * fetching code) */
18076     if (simple_posixes) {   /* These are the classes known to be unaffected by
18077                                /a, /aa, and /d */
18078         if (cp_list) {
18079             _invlist_union(cp_list, simple_posixes, &cp_list);
18080             SvREFCNT_dec_NN(simple_posixes);
18081         }
18082         else {
18083             cp_list = simple_posixes;
18084         }
18085     }
18086     if (posixes || nposixes) {
18087         if (! DEPENDS_SEMANTICS) {
18088
18089             /* For everything but /d, we can just add the current 'posixes' and
18090              * 'nposixes' to the main list */
18091             if (posixes) {
18092                 if (cp_list) {
18093                     _invlist_union(cp_list, posixes, &cp_list);
18094                     SvREFCNT_dec_NN(posixes);
18095                 }
18096                 else {
18097                     cp_list = posixes;
18098                 }
18099             }
18100             if (nposixes) {
18101                 if (cp_list) {
18102                     _invlist_union(cp_list, nposixes, &cp_list);
18103                     SvREFCNT_dec_NN(nposixes);
18104                 }
18105                 else {
18106                     cp_list = nposixes;
18107                 }
18108             }
18109         }
18110         else {
18111             /* Under /d, things like \w match upper Latin1 characters only if
18112              * the target string is in UTF-8.  But things like \W match all the
18113              * upper Latin1 characters if the target string is not in UTF-8.
18114              *
18115              * Handle the case where there something like \W separately */
18116             if (nposixes) {
18117                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1, NULL);
18118
18119                 /* A complemented posix class matches all upper Latin1
18120                  * characters if not in UTF-8.  And it matches just certain
18121                  * ones when in UTF-8.  That means those certain ones are
18122                  * matched regardless, so can just be added to the
18123                  * unconditional list */
18124                 if (cp_list) {
18125                     _invlist_union(cp_list, nposixes, &cp_list);
18126                     SvREFCNT_dec_NN(nposixes);
18127                     nposixes = NULL;
18128                 }
18129                 else {
18130                     cp_list = nposixes;
18131                 }
18132
18133                 /* Likewise for 'posixes' */
18134                 _invlist_union(posixes, cp_list, &cp_list);
18135
18136                 /* Likewise for anything else in the range that matched only
18137                  * under UTF-8 */
18138                 if (has_upper_latin1_only_utf8_matches) {
18139                     _invlist_union(cp_list,
18140                                    has_upper_latin1_only_utf8_matches,
18141                                    &cp_list);
18142                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18143                     has_upper_latin1_only_utf8_matches = NULL;
18144                 }
18145
18146                 /* If we don't match all the upper Latin1 characters regardless
18147                  * of UTF-8ness, we have to set a flag to match the rest when
18148                  * not in UTF-8 */
18149                 _invlist_subtract(only_non_utf8_list, cp_list,
18150                                   &only_non_utf8_list);
18151                 if (_invlist_len(only_non_utf8_list) != 0) {
18152                     ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18153                 }
18154                 SvREFCNT_dec_NN(only_non_utf8_list);
18155             }
18156             else {
18157                 /* Here there were no complemented posix classes.  That means
18158                  * the upper Latin1 characters in 'posixes' match only when the
18159                  * target string is in UTF-8.  So we have to add them to the
18160                  * list of those types of code points, while adding the
18161                  * remainder to the unconditional list.
18162                  *
18163                  * First calculate what they are */
18164                 SV* nonascii_but_latin1_properties = NULL;
18165                 _invlist_intersection(posixes, PL_UpperLatin1,
18166                                       &nonascii_but_latin1_properties);
18167
18168                 /* And add them to the final list of such characters. */
18169                 _invlist_union(has_upper_latin1_only_utf8_matches,
18170                                nonascii_but_latin1_properties,
18171                                &has_upper_latin1_only_utf8_matches);
18172
18173                 /* Remove them from what now becomes the unconditional list */
18174                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
18175                                   &posixes);
18176
18177                 /* And add those unconditional ones to the final list */
18178                 if (cp_list) {
18179                     _invlist_union(cp_list, posixes, &cp_list);
18180                     SvREFCNT_dec_NN(posixes);
18181                     posixes = NULL;
18182                 }
18183                 else {
18184                     cp_list = posixes;
18185                 }
18186
18187                 SvREFCNT_dec(nonascii_but_latin1_properties);
18188
18189                 /* Get rid of any characters that we now know are matched
18190                  * unconditionally from the conditional list, which may make
18191                  * that list empty */
18192                 _invlist_subtract(has_upper_latin1_only_utf8_matches,
18193                                   cp_list,
18194                                   &has_upper_latin1_only_utf8_matches);
18195                 if (_invlist_len(has_upper_latin1_only_utf8_matches) == 0) {
18196                     SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18197                     has_upper_latin1_only_utf8_matches = NULL;
18198                 }
18199             }
18200         }
18201     }
18202
18203     /* And combine the result (if any) with any inversion list from properties.
18204      * The lists are kept separate up to now so that we can distinguish the two
18205      * in regards to matching above-Unicode.  A run-time warning is generated
18206      * if a Unicode property is matched against a non-Unicode code point. But,
18207      * we allow user-defined properties to match anything, without any warning,
18208      * and we also suppress the warning if there is a portion of the character
18209      * class that isn't a Unicode property, and which matches above Unicode, \W
18210      * or [\x{110000}] for example.
18211      * (Note that in this case, unlike the Posix one above, there is no
18212      * <has_upper_latin1_only_utf8_matches>, because having a Unicode property
18213      * forces Unicode semantics */
18214     if (properties) {
18215         if (cp_list) {
18216
18217             /* If it matters to the final outcome, see if a non-property
18218              * component of the class matches above Unicode.  If so, the
18219              * warning gets suppressed.  This is true even if just a single
18220              * such code point is specified, as, though not strictly correct if
18221              * another such code point is matched against, the fact that they
18222              * are using above-Unicode code points indicates they should know
18223              * the issues involved */
18224             if (warn_super) {
18225                 warn_super = ! (invert
18226                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
18227             }
18228
18229             _invlist_union(properties, cp_list, &cp_list);
18230             SvREFCNT_dec_NN(properties);
18231         }
18232         else {
18233             cp_list = properties;
18234         }
18235
18236         if (warn_super) {
18237             ANYOF_FLAGS(ret)
18238              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18239
18240             /* Because an ANYOF node is the only one that warns, this node
18241              * can't be optimized into something else */
18242             optimizable = FALSE;
18243         }
18244     }
18245
18246     /* Here, we have calculated what code points should be in the character
18247      * class.
18248      *
18249      * Now we can see about various optimizations.  Fold calculation (which we
18250      * did above) needs to take place before inversion.  Otherwise /[^k]/i
18251      * would invert to include K, which under /i would match k, which it
18252      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
18253      * folded until runtime */
18254
18255     /* If we didn't do folding, it's because some information isn't available
18256      * until runtime; set the run-time fold flag for these.  (We don't have to
18257      * worry about properties folding, as that is taken care of by the swash
18258      * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
18259      * locales, or the class matches at least one 0-255 range code point */
18260     if (LOC && FOLD) {
18261
18262         /* Some things on the list might be unconditionally included because of
18263          * other components.  Remove them, and clean up the list if it goes to
18264          * 0 elements */
18265         if (only_utf8_locale_list && cp_list) {
18266             _invlist_subtract(only_utf8_locale_list, cp_list,
18267                               &only_utf8_locale_list);
18268
18269             if (_invlist_len(only_utf8_locale_list) == 0) {
18270                 SvREFCNT_dec_NN(only_utf8_locale_list);
18271                 only_utf8_locale_list = NULL;
18272             }
18273         }
18274         if (only_utf8_locale_list) {
18275             ANYOF_FLAGS(ret)
18276                  |=  ANYOFL_FOLD
18277                     |ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
18278         }
18279         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
18280             UV start, end;
18281             invlist_iterinit(cp_list);
18282             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
18283                 ANYOF_FLAGS(ret) |= ANYOFL_FOLD;
18284             }
18285             invlist_iterfinish(cp_list);
18286         }
18287     }
18288     else if (   DEPENDS_SEMANTICS
18289              && (    has_upper_latin1_only_utf8_matches
18290                  || (ANYOF_FLAGS(ret) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
18291     {
18292         OP(ret) = ANYOFD;
18293         optimizable = FALSE;
18294     }
18295
18296
18297     /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
18298      * at compile time.  Besides not inverting folded locale now, we can't
18299      * invert if there are things such as \w, which aren't known until runtime
18300      * */
18301     if (cp_list
18302         && invert
18303         && OP(ret) != ANYOFD
18304         && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
18305         && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18306     {
18307         _invlist_invert(cp_list);
18308
18309         /* Any swash can't be used as-is, because we've inverted things */
18310         if (swash) {
18311             SvREFCNT_dec_NN(swash);
18312             swash = NULL;
18313         }
18314
18315         /* Clear the invert flag since have just done it here */
18316         invert = FALSE;
18317     }
18318
18319     if (ret_invlist) {
18320         assert(cp_list);
18321
18322         *ret_invlist = cp_list;
18323         SvREFCNT_dec(swash);
18324
18325         /* Discard the generated node */
18326         if (SIZE_ONLY) {
18327             RExC_size = orig_size;
18328         }
18329         else {
18330             RExC_emit = orig_emit;
18331         }
18332         return orig_emit;
18333     }
18334
18335     /* Some character classes are equivalent to other nodes.  Such nodes take
18336      * up less room and generally fewer operations to execute than ANYOF nodes.
18337      * Above, we checked for and optimized into some such equivalents for
18338      * certain common classes that are easy to test.  Getting to this point in
18339      * the code means that the class didn't get optimized there.  Since this
18340      * code is only executed in Pass 2, it is too late to save space--it has
18341      * been allocated in Pass 1, and currently isn't given back.  XXX Why not?
18342      * But turning things into an EXACTish node can allow the optimizer to join
18343      * it to any adjacent such nodes.  And if the class is equivalent to things
18344      * like /./, expensive run-time swashes can be avoided.  Now that we have
18345      * more complete information, we can find things necessarily missed by the
18346      * earlier code. */
18347
18348     if (optimizable && cp_list && ! invert) {
18349         UV start, end;
18350         U8 op = END;  /* The optimzation node-type */
18351         int posix_class = -1;   /* Illegal value */
18352         const char * cur_parse= RExC_parse;
18353         U8 ANYOFM_mask = 0xFF;
18354         U32 anode_arg = 0;
18355
18356         invlist_iterinit(cp_list);
18357         if (! invlist_iternext(cp_list, &start, &end)) {
18358
18359             /* Here, the list is empty.  This happens, for example, when a
18360              * Unicode property that doesn't match anything is the only element
18361              * in the character class (perluniprops.pod notes such properties).
18362              * */
18363             op = OPFAIL;
18364             *flagp |= HASWIDTH|SIMPLE;
18365         }
18366         else if (start == end) {    /* The range is a single code point */
18367             if (! invlist_iternext(cp_list, &start, &end)
18368
18369                     /* Don't do this optimization if it would require changing
18370                      * the pattern to UTF-8 */
18371                 && (start < 256 || UTF))
18372             {
18373                 /* Here, the list contains a single code point.  Can optimize
18374                  * into an EXACTish node */
18375
18376                 value = start;
18377
18378                 if (! FOLD) {
18379                     op = (LOC)
18380                          ? EXACTL
18381                          : EXACT;
18382                 }
18383                 else if (LOC) {
18384
18385                     /* A locale node under folding with one code point can be
18386                      * an EXACTFL, as its fold won't be calculated until
18387                      * runtime */
18388                     op = EXACTFL;
18389                 }
18390                 else {
18391
18392                     /* Here, we are generally folding, but there is only one
18393                      * code point to match.  If we have to, we use an EXACT
18394                      * node, but it would be better for joining with adjacent
18395                      * nodes in the optimization pass if we used the same
18396                      * EXACTFish node that any such are likely to be.  We can
18397                      * do this iff the code point doesn't participate in any
18398                      * folds.  For example, an EXACTF of a colon is the same as
18399                      * an EXACT one, since nothing folds to or from a colon. */
18400                     if (value < 256) {
18401                         if (IS_IN_SOME_FOLD_L1(value)) {
18402                             op = EXACT;
18403                         }
18404                     }
18405                     else {
18406                         if (_invlist_contains_cp(PL_utf8_foldable, value)) {
18407                             op = EXACT;
18408                         }
18409                     }
18410
18411                     /* If we haven't found the node type, above, it means we
18412                      * can use the prevailing one */
18413                     if (op == END) {
18414                         op = compute_EXACTish(pRExC_state);
18415                     }
18416                 }
18417             }
18418         }   /* End of first range contains just a single code point */
18419         else if (start == 0) {
18420             if (end == UV_MAX) {
18421                 op = SANY;
18422                 *flagp |= HASWIDTH|SIMPLE;
18423                 MARK_NAUGHTY(1);
18424             }
18425             else if (end == '\n' - 1
18426                     && invlist_iternext(cp_list, &start, &end)
18427                     && start == '\n' + 1 && end == UV_MAX)
18428             {
18429                 op = REG_ANY;
18430                 *flagp |= HASWIDTH|SIMPLE;
18431                 MARK_NAUGHTY(1);
18432             }
18433         }
18434         invlist_iterfinish(cp_list);
18435
18436         if (op == END) {
18437
18438             /* Here, didn't find an optimization.  See if this matches any of
18439              * the POSIX classes.  First try ASCII */
18440
18441             if (_invlistEQ(cp_list, PL_XPosix_ptrs[_CC_ASCII], 0)) {
18442                 op = ASCII;
18443                 *flagp |= HASWIDTH|SIMPLE;
18444             }
18445             else if (_invlistEQ(cp_list, PL_XPosix_ptrs[_CC_ASCII], 1)) {
18446                 op = NASCII;
18447                 *flagp |= HASWIDTH|SIMPLE;
18448             }
18449             else if (invlist_highest(cp_list) >= 0x2029) {
18450
18451                 /* Then try the other POSIX classes.  The POSIXA ones are about
18452                  * the same speed as ANYOF ops, but the ones that have
18453                  * above-Latin1 code point matches are somewhat faster than
18454                  * ANYOF.  So optimize those, but don't bother with the POSIXA
18455                  * ones nor [:cntrl:] which has no above-Latin1 matches.  If
18456                  * this ANYOF node has a lower highest possible matching code
18457                  * point than any of the XPosix ones, we know that it can't
18458                  * possibly be the same as any of them, so we can avoid
18459                  * executing this code.  The 0x2029 above for the lowest max
18460                  * was determined by manual inspection of the classes, and
18461                  * comes from \v.  Suppose Unicode in a later version adds a
18462                  * higher code point to \v.  All that means is that this code
18463                  * can be executed unnecessarily.  It will still give the
18464                  * correct answer. */
18465
18466                 for (posix_class = 0;
18467                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
18468                      posix_class++)
18469                 {
18470                     int try_inverted;
18471
18472                     if (posix_class == _CC_CNTRL) {
18473                         continue;
18474                     }
18475
18476                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
18477
18478                         /* Check if matches normal or inverted */
18479                         if (_invlistEQ(cp_list,
18480                                        PL_XPosix_ptrs[posix_class],
18481                                        try_inverted))
18482                         {
18483                             op = (try_inverted)
18484                                  ? NPOSIXU
18485                                  : POSIXU;
18486                             *flagp |= HASWIDTH|SIMPLE;
18487                             goto found_posix;
18488                         }
18489                     }
18490                 }
18491               found_posix: ;
18492             }
18493
18494             /* If it didn't match a POSIX class, it might be able to be turned
18495              * into an ANYOFM node.  Compare two different bytes, bit-by-bit.
18496              * In some positions, the bits in each will be 1; and in other
18497              * positions both will be 0; and in some positions the bit will be
18498              * 1 in one byte, and 0 in the other.  Let 'n' be the number of
18499              * positions where the bits differ.  We create a mask which has
18500              * exactly 'n' 0 bits, each in a position where the two bytes
18501              * differ.  Now take the set of all bytes that when ANDed with the
18502              * mask yield the same result.  That set has 2**n elements, and is
18503              * representable by just two 8 bit numbers: the result and the
18504              * mask.  Importantly, matching the set can be vectorized by
18505              * creating a word full of the result bytes, and a word full of the
18506              * mask bytes, yielding a significant speed up.  Here, see if this
18507              * node matches such a set.  As a concrete example consider [01],
18508              * and the byte representing '0' which is 0x30 on ASCII machines.
18509              * It has the bits 0011 0000.  Take the mask 1111 1110.  If we AND
18510              * 0x31 and 0x30 with that mask we get 0x30.  Any other bytes ANDed
18511              * yield something else.  So [01], which is a common usage, is
18512              * optimizable into ANYOFM, and can benefit from the speed up.  We
18513              * can only do this on UTF-8 invariant bytes, because the variance
18514              * would throw this off.  */
18515             if (   op == END
18516                 && invlist_highest(cp_list) <=
18517 #ifdef EBCDIC
18518                                                0xFF
18519 #else
18520                                                0x7F
18521 #endif
18522             ) {
18523                 Size_t cp_count = 0;
18524                 bool first_time = TRUE;
18525                 unsigned int lowest_cp = 0xFF;
18526                 U8 bits_differing = 0;
18527
18528                 /* Only needed on EBCDIC, as there, variants and non- are mixed
18529                  * together.  Could #ifdef it out on ASCII, but probably the
18530                  * compiler will optimize it out */
18531                 bool has_variant = FALSE;
18532
18533                 /* Go through the bytes and find the bit positions that differ */
18534                 invlist_iterinit(cp_list);
18535                 while (invlist_iternext(cp_list, &start, &end)) {
18536                     unsigned int i = start;
18537
18538                     cp_count += end - start + 1;
18539
18540                     if (first_time) {
18541                         if (! UVCHR_IS_INVARIANT(i)) {
18542                             has_variant = TRUE;
18543                             continue;
18544                         }
18545
18546                         first_time = FALSE;
18547                         lowest_cp = start;
18548
18549                         i++;
18550                     }
18551
18552                     /* Find the bit positions that differ from the lowest code
18553                      * point in the node.  Keep track of all such positions by
18554                      * OR'ing */
18555                     for (; i <= end; i++) {
18556                         if (! UVCHR_IS_INVARIANT(i)) {
18557                             has_variant = TRUE;
18558                             continue;
18559                         }
18560
18561                         bits_differing  |= i ^ lowest_cp;
18562                     }
18563                 }
18564                 invlist_iterfinish(cp_list);
18565
18566                 /* At the end of the loop, we count how many bits differ from
18567                  * the bits in lowest code point, call the count 'd'.  If the
18568                  * set we found contains 2**d elements, it is the closure of
18569                  * all code points that differ only in those bit positions.  To
18570                  * convince yourself of that, first note that the number in the
18571                  * closure must be a power of 2, which we test for.  The only
18572                  * way we could have that count and it be some differing set,
18573                  * is if we got some code points that don't differ from the
18574                  * lowest code point in any position, but do differ from each
18575                  * other in some other position.  That means one code point has
18576                  * a 1 in that position, and another has a 0.  But that would
18577                  * mean that one of them differs from the lowest code point in
18578                  * that position, which possibility we've already excluded. */
18579                 if ( ! has_variant
18580                     && cp_count == 1U << PL_bitcount[bits_differing])
18581                 {
18582                     assert(cp_count > 1);
18583                     op = ANYOFM;
18584
18585                     /* We need to make the bits that differ be 0's */
18586                     ANYOFM_mask = ~ bits_differing; /* This goes into FLAGS */
18587
18588                     /* The argument is the lowest code point */
18589                     anode_arg = lowest_cp;
18590                     *flagp |= HASWIDTH|SIMPLE;
18591                 }
18592             }
18593         }
18594
18595         if (op != END) {
18596             RExC_parse = (char *)orig_parse;
18597             RExC_emit = (regnode *)orig_emit;
18598
18599             if (regarglen[op]) {
18600                 ret = reganode(pRExC_state, op, anode_arg);
18601             } else {
18602                 ret = reg_node(pRExC_state, op);
18603             }
18604
18605             RExC_parse = (char *)cur_parse;
18606
18607             if (PL_regkind[op] == EXACT) {
18608                 alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
18609                                            TRUE /* downgradable to EXACT */
18610                                           );
18611             }
18612             else if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
18613                 FLAGS(ret) = posix_class;
18614             }
18615             else if (PL_regkind[op] == ANYOFM) {
18616                 FLAGS(ret) = ANYOFM_mask;
18617             }
18618
18619             SvREFCNT_dec_NN(cp_list);
18620             return ret;
18621         }
18622     }
18623
18624     /* Here, <cp_list> contains all the code points we can determine at
18625      * compile time that match under all conditions.  Go through it, and
18626      * for things that belong in the bitmap, put them there, and delete from
18627      * <cp_list>.  While we are at it, see if everything above 255 is in the
18628      * list, and if so, set a flag to speed up execution */
18629
18630     populate_ANYOF_from_invlist(ret, &cp_list);
18631
18632     if (invert) {
18633         ANYOF_FLAGS(ret) |= ANYOF_INVERT;
18634     }
18635
18636     /* Here, the bitmap has been populated with all the Latin1 code points that
18637      * always match.  Can now add to the overall list those that match only
18638      * when the target string is UTF-8 (<has_upper_latin1_only_utf8_matches>).
18639      * */
18640     if (has_upper_latin1_only_utf8_matches) {
18641         if (cp_list) {
18642             _invlist_union(cp_list,
18643                            has_upper_latin1_only_utf8_matches,
18644                            &cp_list);
18645             SvREFCNT_dec_NN(has_upper_latin1_only_utf8_matches);
18646         }
18647         else {
18648             cp_list = has_upper_latin1_only_utf8_matches;
18649         }
18650         ANYOF_FLAGS(ret) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
18651     }
18652
18653     /* If there is a swash and more than one element, we can't use the swash in
18654      * the optimization below. */
18655     if (swash && element_count > 1) {
18656         SvREFCNT_dec_NN(swash);
18657         swash = NULL;
18658     }
18659
18660     /* Note that the optimization of using 'swash' if it is the only thing in
18661      * the class doesn't have us change swash at all, so it can include things
18662      * that are also in the bitmap; otherwise we have purposely deleted that
18663      * duplicate information */
18664     set_ANYOF_arg(pRExC_state, ret, cp_list,
18665                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
18666                    ? listsv : NULL,
18667                   only_utf8_locale_list,
18668                   swash, has_user_defined_property);
18669
18670     *flagp |= HASWIDTH|SIMPLE;
18671
18672     if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
18673         RExC_contains_locale = 1;
18674     }
18675
18676     return ret;
18677 }
18678
18679 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
18680
18681 STATIC void
18682 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
18683                 regnode* const node,
18684                 SV* const cp_list,
18685                 SV* const runtime_defns,
18686                 SV* const only_utf8_locale_list,
18687                 SV* const swash,
18688                 const bool has_user_defined_property)
18689 {
18690     /* Sets the arg field of an ANYOF-type node 'node', using information about
18691      * the node passed-in.  If there is nothing outside the node's bitmap, the
18692      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
18693      * the count returned by add_data(), having allocated and stored an array,
18694      * av, that that count references, as follows:
18695      *  av[0] stores the character class description in its textual form.
18696      *        This is used later (regexec.c:Perl_regclass_swash()) to
18697      *        initialize the appropriate swash, and is also useful for dumping
18698      *        the regnode.  This is set to &PL_sv_undef if the textual
18699      *        description is not needed at run-time (as happens if the other
18700      *        elements completely define the class)
18701      *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
18702      *        computed from av[0].  But if no further computation need be done,
18703      *        the swash is stored here now (and av[0] is &PL_sv_undef).
18704      *  av[2] stores the inversion list of code points that match only if the
18705      *        current locale is UTF-8
18706      *  av[3] stores the cp_list inversion list for use in addition or instead
18707      *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
18708      *        (Otherwise everything needed is already in av[0] and av[1])
18709      *  av[4] is set if any component of the class is from a user-defined
18710      *        property; used only if av[3] exists */
18711
18712     UV n;
18713
18714     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
18715
18716     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
18717         assert(! (ANYOF_FLAGS(node)
18718                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
18719         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
18720     }
18721     else {
18722         AV * const av = newAV();
18723         SV *rv;
18724
18725         av_store(av, 0, (runtime_defns)
18726                         ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
18727         if (swash) {
18728             assert(cp_list);
18729             av_store(av, 1, swash);
18730             SvREFCNT_dec_NN(cp_list);
18731         }
18732         else {
18733             av_store(av, 1, &PL_sv_undef);
18734             if (cp_list) {
18735                 av_store(av, 3, cp_list);
18736                 av_store(av, 4, newSVuv(has_user_defined_property));
18737             }
18738         }
18739
18740         if (only_utf8_locale_list) {
18741             av_store(av, 2, only_utf8_locale_list);
18742         }
18743         else {
18744             av_store(av, 2, &PL_sv_undef);
18745         }
18746
18747         rv = newRV_noinc(MUTABLE_SV(av));
18748         n = add_data(pRExC_state, STR_WITH_LEN("s"));
18749         RExC_rxi->data->data[n] = (void*)rv;
18750         ARG_SET(node, n);
18751     }
18752 }
18753
18754 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
18755 SV *
18756 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
18757                                         const regnode* node,
18758                                         bool doinit,
18759                                         SV** listsvp,
18760                                         SV** only_utf8_locale_ptr,
18761                                         SV** output_invlist)
18762
18763 {
18764     /* For internal core use only.
18765      * Returns the swash for the input 'node' in the regex 'prog'.
18766      * If <doinit> is 'true', will attempt to create the swash if not already
18767      *    done.
18768      * If <listsvp> is non-null, will return the printable contents of the
18769      *    swash.  This can be used to get debugging information even before the
18770      *    swash exists, by calling this function with 'doinit' set to false, in
18771      *    which case the components that will be used to eventually create the
18772      *    swash are returned  (in a printable form).
18773      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
18774      *    store an inversion list of code points that should match only if the
18775      *    execution-time locale is a UTF-8 one.
18776      * If <output_invlist> is not NULL, it is where this routine is to store an
18777      *    inversion list of the code points that would be instead returned in
18778      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
18779      *    when this parameter is used, is just the non-code point data that
18780      *    will go into creating the swash.  This currently should be just
18781      *    user-defined properties whose definitions were not known at compile
18782      *    time.  Using this parameter allows for easier manipulation of the
18783      *    swash's data by the caller.  It is illegal to call this function with
18784      *    this parameter set, but not <listsvp>
18785      *
18786      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
18787      * that, in spite of this function's name, the swash it returns may include
18788      * the bitmap data as well */
18789
18790     SV *sw  = NULL;
18791     SV *si  = NULL;         /* Input swash initialization string */
18792     SV* invlist = NULL;
18793
18794     RXi_GET_DECL(prog,progi);
18795     const struct reg_data * const data = prog ? progi->data : NULL;
18796
18797     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
18798     assert(! output_invlist || listsvp);
18799
18800     if (data && data->count) {
18801         const U32 n = ARG(node);
18802
18803         if (data->what[n] == 's') {
18804             SV * const rv = MUTABLE_SV(data->data[n]);
18805             AV * const av = MUTABLE_AV(SvRV(rv));
18806             SV **const ary = AvARRAY(av);
18807             U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
18808
18809             si = *ary;  /* ary[0] = the string to initialize the swash with */
18810
18811             if (av_tindex_skip_len_mg(av) >= 2) {
18812                 if (only_utf8_locale_ptr
18813                     && ary[2]
18814                     && ary[2] != &PL_sv_undef)
18815                 {
18816                     *only_utf8_locale_ptr = ary[2];
18817                 }
18818                 else {
18819                     assert(only_utf8_locale_ptr);
18820                     *only_utf8_locale_ptr = NULL;
18821                 }
18822
18823                 /* Elements 3 and 4 are either both present or both absent. [3]
18824                  * is any inversion list generated at compile time; [4]
18825                  * indicates if that inversion list has any user-defined
18826                  * properties in it. */
18827                 if (av_tindex_skip_len_mg(av) >= 3) {
18828                     invlist = ary[3];
18829                     if (SvUV(ary[4])) {
18830                         swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
18831                     }
18832                 }
18833                 else {
18834                     invlist = NULL;
18835                 }
18836             }
18837
18838             /* Element [1] is reserved for the set-up swash.  If already there,
18839              * return it; if not, create it and store it there */
18840             if (ary[1] && SvROK(ary[1])) {
18841                 sw = ary[1];
18842             }
18843             else if (doinit && ((si && si != &PL_sv_undef)
18844                                  || (invlist && invlist != &PL_sv_undef))) {
18845                 assert(si);
18846                 sw = _core_swash_init("utf8", /* the utf8 package */
18847                                       "", /* nameless */
18848                                       si,
18849                                       1, /* binary */
18850                                       0, /* not from tr/// */
18851                                       invlist,
18852                                       &swash_init_flags);
18853                 (void)av_store(av, 1, sw);
18854             }
18855         }
18856     }
18857
18858     /* If requested, return a printable version of what this swash matches */
18859     if (listsvp) {
18860         SV* matches_string = NULL;
18861
18862         /* The swash should be used, if possible, to get the data, as it
18863          * contains the resolved data.  But this function can be called at
18864          * compile-time, before everything gets resolved, in which case we
18865          * return the currently best available information, which is the string
18866          * that will eventually be used to do that resolving, 'si' */
18867         if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
18868             && (si && si != &PL_sv_undef))
18869         {
18870             /* Here, we only have 'si' (and possibly some passed-in data in
18871              * 'invlist', which is handled below)  If the caller only wants
18872              * 'si', use that.  */
18873             if (! output_invlist) {
18874                 matches_string = newSVsv(si);
18875             }
18876             else {
18877                 /* But if the caller wants an inversion list of the node, we
18878                  * need to parse 'si' and place as much as possible in the
18879                  * desired output inversion list, making 'matches_string' only
18880                  * contain the currently unresolvable things */
18881                 const char *si_string = SvPVX(si);
18882                 STRLEN remaining = SvCUR(si);
18883                 UV prev_cp = 0;
18884                 U8 count = 0;
18885
18886                 /* Ignore everything before the first new-line */
18887                 while (*si_string != '\n' && remaining > 0) {
18888                     si_string++;
18889                     remaining--;
18890                 }
18891                 assert(remaining > 0);
18892
18893                 si_string++;
18894                 remaining--;
18895
18896                 while (remaining > 0) {
18897
18898                     /* The data consists of just strings defining user-defined
18899                      * property names, but in prior incarnations, and perhaps
18900                      * somehow from pluggable regex engines, it could still
18901                      * hold hex code point definitions.  Each component of a
18902                      * range would be separated by a tab, and each range by a
18903                      * new-line.  If these are found, instead add them to the
18904                      * inversion list */
18905                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
18906                                      |PERL_SCAN_SILENT_NON_PORTABLE;
18907                     STRLEN len = remaining;
18908                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
18909
18910                     /* If the hex decode routine found something, it should go
18911                      * up to the next \n */
18912                     if (   *(si_string + len) == '\n') {
18913                         if (count) {    /* 2nd code point on line */
18914                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
18915                         }
18916                         else {
18917                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
18918                         }
18919                         count = 0;
18920                         goto prepare_for_next_iteration;
18921                     }
18922
18923                     /* If the hex decode was instead for the lower range limit,
18924                      * save it, and go parse the upper range limit */
18925                     if (*(si_string + len) == '\t') {
18926                         assert(count == 0);
18927
18928                         prev_cp = cp;
18929                         count = 1;
18930                       prepare_for_next_iteration:
18931                         si_string += len + 1;
18932                         remaining -= len + 1;
18933                         continue;
18934                     }
18935
18936                     /* Here, didn't find a legal hex number.  Just add it from
18937                      * here to the next \n */
18938
18939                     remaining -= len;
18940                     while (*(si_string + len) != '\n' && remaining > 0) {
18941                         remaining--;
18942                         len++;
18943                     }
18944                     if (*(si_string + len) == '\n') {
18945                         len++;
18946                         remaining--;
18947                     }
18948                     if (matches_string) {
18949                         sv_catpvn(matches_string, si_string, len - 1);
18950                     }
18951                     else {
18952                         matches_string = newSVpvn(si_string, len - 1);
18953                     }
18954                     si_string += len;
18955                     sv_catpvs(matches_string, " ");
18956                 } /* end of loop through the text */
18957
18958                 assert(matches_string);
18959                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
18960                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
18961                 }
18962             } /* end of has an 'si' but no swash */
18963         }
18964
18965         /* If we have a swash in place, its equivalent inversion list was above
18966          * placed into 'invlist'.  If not, this variable may contain a stored
18967          * inversion list which is information beyond what is in 'si' */
18968         if (invlist) {
18969
18970             /* Again, if the caller doesn't want the output inversion list, put
18971              * everything in 'matches-string' */
18972             if (! output_invlist) {
18973                 if ( ! matches_string) {
18974                     matches_string = newSVpvs("\n");
18975                 }
18976                 sv_catsv(matches_string, invlist_contents(invlist,
18977                                                   TRUE /* traditional style */
18978                                                   ));
18979             }
18980             else if (! *output_invlist) {
18981                 *output_invlist = invlist_clone(invlist, NULL);
18982             }
18983             else {
18984                 _invlist_union(*output_invlist, invlist, output_invlist);
18985             }
18986         }
18987
18988         *listsvp = matches_string;
18989     }
18990
18991     return sw;
18992 }
18993 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
18994
18995 /* reg_skipcomment()
18996
18997    Absorbs an /x style # comment from the input stream,
18998    returning a pointer to the first character beyond the comment, or if the
18999    comment terminates the pattern without anything following it, this returns
19000    one past the final character of the pattern (in other words, RExC_end) and
19001    sets the REG_RUN_ON_COMMENT_SEEN flag.
19002
19003    Note it's the callers responsibility to ensure that we are
19004    actually in /x mode
19005
19006 */
19007
19008 PERL_STATIC_INLINE char*
19009 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
19010 {
19011     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
19012
19013     assert(*p == '#');
19014
19015     while (p < RExC_end) {
19016         if (*(++p) == '\n') {
19017             return p+1;
19018         }
19019     }
19020
19021     /* we ran off the end of the pattern without ending the comment, so we have
19022      * to add an \n when wrapping */
19023     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
19024     return p;
19025 }
19026
19027 STATIC void
19028 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
19029                                 char ** p,
19030                                 const bool force_to_xmod
19031                          )
19032 {
19033     /* If the text at the current parse position '*p' is a '(?#...)' comment,
19034      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
19035      * is /x whitespace, advance '*p' so that on exit it points to the first
19036      * byte past all such white space and comments */
19037
19038     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
19039
19040     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
19041
19042     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
19043
19044     for (;;) {
19045         if (RExC_end - (*p) >= 3
19046             && *(*p)     == '('
19047             && *(*p + 1) == '?'
19048             && *(*p + 2) == '#')
19049         {
19050             while (*(*p) != ')') {
19051                 if ((*p) == RExC_end)
19052                     FAIL("Sequence (?#... not terminated");
19053                 (*p)++;
19054             }
19055             (*p)++;
19056             continue;
19057         }
19058
19059         if (use_xmod) {
19060             const char * save_p = *p;
19061             while ((*p) < RExC_end) {
19062                 STRLEN len;
19063                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
19064                     (*p) += len;
19065                 }
19066                 else if (*(*p) == '#') {
19067                     (*p) = reg_skipcomment(pRExC_state, (*p));
19068                 }
19069                 else {
19070                     break;
19071                 }
19072             }
19073             if (*p != save_p) {
19074                 continue;
19075             }
19076         }
19077
19078         break;
19079     }
19080
19081     return;
19082 }
19083
19084 /* nextchar()
19085
19086    Advances the parse position by one byte, unless that byte is the beginning
19087    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
19088    those two cases, the parse position is advanced beyond all such comments and
19089    white space.
19090
19091    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
19092 */
19093
19094 STATIC void
19095 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
19096 {
19097     PERL_ARGS_ASSERT_NEXTCHAR;
19098
19099     if (RExC_parse < RExC_end) {
19100         assert(   ! UTF
19101                || UTF8_IS_INVARIANT(*RExC_parse)
19102                || UTF8_IS_START(*RExC_parse));
19103
19104         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
19105
19106         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
19107                                 FALSE /* Don't force /x */ );
19108     }
19109 }
19110
19111 STATIC regnode *
19112 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
19113 {
19114     /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
19115      * space.  In pass1, it aligns and increments RExC_size; in pass2,
19116      * RExC_emit */
19117
19118     regnode * const ret = RExC_emit;
19119     GET_RE_DEBUG_FLAGS_DECL;
19120
19121     PERL_ARGS_ASSERT_REGNODE_GUTS;
19122
19123     assert(extra_size >= regarglen[op]);
19124
19125     if (SIZE_ONLY) {
19126         SIZE_ALIGN(RExC_size);
19127         RExC_size += 1 + extra_size;
19128         return(ret);
19129     }
19130     if (RExC_emit >= RExC_emit_bound)
19131         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
19132                    op, (void*)RExC_emit, (void*)RExC_emit_bound);
19133
19134     NODE_ALIGN_FILL(ret);
19135 #ifndef RE_TRACK_PATTERN_OFFSETS
19136     PERL_UNUSED_ARG(name);
19137 #else
19138     if (RExC_offsets) {         /* MJD */
19139         MJD_OFFSET_DEBUG(
19140               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
19141               name, __LINE__,
19142               PL_reg_name[op],
19143               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
19144                 ? "Overwriting end of array!\n" : "OK",
19145               (UV)(RExC_emit - RExC_emit_start),
19146               (UV)(RExC_parse - RExC_start),
19147               (UV)RExC_offsets[0]));
19148         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
19149     }
19150 #endif
19151     return(ret);
19152 }
19153
19154 /*
19155 - reg_node - emit a node
19156 */
19157 STATIC regnode *                        /* Location. */
19158 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
19159 {
19160     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
19161
19162     PERL_ARGS_ASSERT_REG_NODE;
19163
19164     assert(regarglen[op] == 0);
19165
19166     if (PASS2) {
19167         regnode *ptr = ret;
19168         FILL_ADVANCE_NODE(ptr, op);
19169         RExC_emit = ptr;
19170     }
19171     return(ret);
19172 }
19173
19174 /*
19175 - reganode - emit a node with an argument
19176 */
19177 STATIC regnode *                        /* Location. */
19178 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
19179 {
19180     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
19181
19182     PERL_ARGS_ASSERT_REGANODE;
19183
19184     assert(regarglen[op] == 1);
19185
19186     if (PASS2) {
19187         regnode *ptr = ret;
19188         FILL_ADVANCE_NODE_ARG(ptr, op, arg);
19189         RExC_emit = ptr;
19190     }
19191     return(ret);
19192 }
19193
19194 STATIC regnode *
19195 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
19196 {
19197     /* emit a node with U32 and I32 arguments */
19198
19199     regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
19200
19201     PERL_ARGS_ASSERT_REG2LANODE;
19202
19203     assert(regarglen[op] == 2);
19204
19205     if (PASS2) {
19206         regnode *ptr = ret;
19207         FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
19208         RExC_emit = ptr;
19209     }
19210     return(ret);
19211 }
19212
19213 /*
19214 - reginsert - insert an operator in front of already-emitted operand
19215 *
19216 * Means relocating the operand.
19217 *
19218 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
19219 * set up NEXT_OFF() of the inserted node if needed. Something like this:
19220 *
19221 * reginsert(pRExC, OPFAIL, orig_emit, depth+1);
19222 * if (PASS2)
19223 *     NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
19224 *
19225 * ALSO NOTE - operand->flags will be set to 0 as well.
19226 */
19227 STATIC void
19228 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *operand, U32 depth)
19229 {
19230     regnode *src;
19231     regnode *dst;
19232     regnode *place;
19233     const int offset = regarglen[(U8)op];
19234     const int size = NODE_STEP_REGNODE + offset;
19235     GET_RE_DEBUG_FLAGS_DECL;
19236
19237     PERL_ARGS_ASSERT_REGINSERT;
19238     PERL_UNUSED_CONTEXT;
19239     PERL_UNUSED_ARG(depth);
19240 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
19241     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
19242     if (SIZE_ONLY) {
19243         RExC_size += size;
19244         return;
19245     }
19246     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
19247                                     studying. If this is wrong then we need to adjust RExC_recurse
19248                                     below like we do with RExC_open_parens/RExC_close_parens. */
19249     src = RExC_emit;
19250     RExC_emit += size;
19251     dst = RExC_emit;
19252     if (RExC_open_parens) {
19253         int paren;
19254         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
19255         /* remember that RExC_npar is rex->nparens + 1,
19256          * iow it is 1 more than the number of parens seen in
19257          * the pattern so far. */
19258         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
19259             /* note, RExC_open_parens[0] is the start of the
19260              * regex, it can't move. RExC_close_parens[0] is the end
19261              * of the regex, it *can* move. */
19262             if ( paren && RExC_open_parens[paren] >= operand ) {
19263                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
19264                 RExC_open_parens[paren] += size;
19265             } else {
19266                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
19267             }
19268             if ( RExC_close_parens[paren] >= operand ) {
19269                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
19270                 RExC_close_parens[paren] += size;
19271             } else {
19272                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
19273             }
19274         }
19275     }
19276     if (RExC_end_op)
19277         RExC_end_op += size;
19278
19279     while (src > operand) {
19280         StructCopy(--src, --dst, regnode);
19281 #ifdef RE_TRACK_PATTERN_OFFSETS
19282         if (RExC_offsets) {     /* MJD 20010112 */
19283             MJD_OFFSET_DEBUG(
19284                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
19285                   "reg_insert",
19286                   __LINE__,
19287                   PL_reg_name[op],
19288                   (UV)(dst - RExC_emit_start) > RExC_offsets[0]
19289                     ? "Overwriting end of array!\n" : "OK",
19290                   (UV)(src - RExC_emit_start),
19291                   (UV)(dst - RExC_emit_start),
19292                   (UV)RExC_offsets[0]));
19293             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
19294             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
19295         }
19296 #endif
19297     }
19298
19299     place = operand;            /* Op node, where operand used to be. */
19300 #ifdef RE_TRACK_PATTERN_OFFSETS
19301     if (RExC_offsets) {         /* MJD */
19302         MJD_OFFSET_DEBUG(
19303               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
19304               "reginsert",
19305               __LINE__,
19306               PL_reg_name[op],
19307               (UV)(place - RExC_emit_start) > RExC_offsets[0]
19308               ? "Overwriting end of array!\n" : "OK",
19309               (UV)(place - RExC_emit_start),
19310               (UV)(RExC_parse - RExC_start),
19311               (UV)RExC_offsets[0]));
19312         Set_Node_Offset(place, RExC_parse);
19313         Set_Node_Length(place, 1);
19314     }
19315 #endif
19316     src = NEXTOPER(place);
19317     place->flags = 0;
19318     FILL_ADVANCE_NODE(place, op);
19319     Zero(src, offset, regnode);
19320 }
19321
19322 /*
19323 - regtail - set the next-pointer at the end of a node chain of p to val.
19324 - SEE ALSO: regtail_study
19325 */
19326 STATIC void
19327 S_regtail(pTHX_ RExC_state_t * pRExC_state,
19328                 const regnode * const p,
19329                 const regnode * const val,
19330                 const U32 depth)
19331 {
19332     regnode *scan;
19333     GET_RE_DEBUG_FLAGS_DECL;
19334
19335     PERL_ARGS_ASSERT_REGTAIL;
19336 #ifndef DEBUGGING
19337     PERL_UNUSED_ARG(depth);
19338 #endif
19339
19340     if (SIZE_ONLY)
19341         return;
19342
19343     /* Find last node. */
19344     scan = (regnode *) p;
19345     for (;;) {
19346         regnode * const temp = regnext(scan);
19347         DEBUG_PARSE_r({
19348             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
19349             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
19350             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
19351                 SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
19352                     (temp == NULL ? "->" : ""),
19353                     (temp == NULL ? PL_reg_name[OP(val)] : "")
19354             );
19355         });
19356         if (temp == NULL)
19357             break;
19358         scan = temp;
19359     }
19360
19361     if (reg_off_by_arg[OP(scan)]) {
19362         ARG_SET(scan, val - scan);
19363     }
19364     else {
19365         NEXT_OFF(scan) = val - scan;
19366     }
19367 }
19368
19369 #ifdef DEBUGGING
19370 /*
19371 - regtail_study - set the next-pointer at the end of a node chain of p to val.
19372 - Look for optimizable sequences at the same time.
19373 - currently only looks for EXACT chains.
19374
19375 This is experimental code. The idea is to use this routine to perform
19376 in place optimizations on branches and groups as they are constructed,
19377 with the long term intention of removing optimization from study_chunk so
19378 that it is purely analytical.
19379
19380 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
19381 to control which is which.
19382
19383 */
19384 /* TODO: All four parms should be const */
19385
19386 STATIC U8
19387 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
19388                       const regnode *val,U32 depth)
19389 {
19390     regnode *scan;
19391     U8 exact = PSEUDO;
19392 #ifdef EXPERIMENTAL_INPLACESCAN
19393     I32 min = 0;
19394 #endif
19395     GET_RE_DEBUG_FLAGS_DECL;
19396
19397     PERL_ARGS_ASSERT_REGTAIL_STUDY;
19398
19399
19400     if (SIZE_ONLY)
19401         return exact;
19402
19403     /* Find last node. */
19404
19405     scan = p;
19406     for (;;) {
19407         regnode * const temp = regnext(scan);
19408 #ifdef EXPERIMENTAL_INPLACESCAN
19409         if (PL_regkind[OP(scan)] == EXACT) {
19410             bool unfolded_multi_char;   /* Unexamined in this routine */
19411             if (join_exact(pRExC_state, scan, &min,
19412                            &unfolded_multi_char, 1, val, depth+1))
19413                 return EXACT;
19414         }
19415 #endif
19416         if ( exact ) {
19417             switch (OP(scan)) {
19418                 case EXACT:
19419                 case EXACTL:
19420                 case EXACTF:
19421                 case EXACTFAA_NO_TRIE:
19422                 case EXACTFAA:
19423                 case EXACTFU:
19424                 case EXACTFLU8:
19425                 case EXACTFU_SS:
19426                 case EXACTFL:
19427                         if( exact == PSEUDO )
19428                             exact= OP(scan);
19429                         else if ( exact != OP(scan) )
19430                             exact= 0;
19431                 case NOTHING:
19432                     break;
19433                 default:
19434                     exact= 0;
19435             }
19436         }
19437         DEBUG_PARSE_r({
19438             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
19439             regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
19440             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
19441                 SvPV_nolen_const(RExC_mysv),
19442                 REG_NODE_NUM(scan),
19443                 PL_reg_name[exact]);
19444         });
19445         if (temp == NULL)
19446             break;
19447         scan = temp;
19448     }
19449     DEBUG_PARSE_r({
19450         DEBUG_PARSE_MSG("");
19451         regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
19452         Perl_re_printf( aTHX_
19453                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
19454                       SvPV_nolen_const(RExC_mysv),
19455                       (IV)REG_NODE_NUM(val),
19456                       (IV)(val - scan)
19457         );
19458     });
19459     if (reg_off_by_arg[OP(scan)]) {
19460         ARG_SET(scan, val - scan);
19461     }
19462     else {
19463         NEXT_OFF(scan) = val - scan;
19464     }
19465
19466     return exact;
19467 }
19468 #endif
19469
19470 STATIC SV*
19471 S_get_ANYOFM_contents(pTHX_ const regnode * n) {
19472
19473     /* Returns an inversion list of all the code points matched by the ANYOFM
19474      * node 'n' */
19475
19476     SV * cp_list = _new_invlist(-1);
19477     const U8 lowest = (U8) ARG(n);
19478     unsigned int i;
19479     U8 count = 0;
19480     U8 needed = 1U << PL_bitcount[ (U8) ~ FLAGS(n)];
19481
19482     PERL_ARGS_ASSERT_GET_ANYOFM_CONTENTS;
19483
19484     /* Starting with the lowest code point, any code point that ANDed with the
19485      * mask yields the lowest code point is in the set */
19486     for (i = lowest; i <= 0xFF; i++) {
19487         if ((i & FLAGS(n)) == ARG(n)) {
19488             cp_list = add_cp_to_invlist(cp_list, i);
19489             count++;
19490
19491             /* We know how many code points (a power of two) that are in the
19492              * set.  No use looking once we've got that number */
19493             if (count >= needed) break;
19494         }
19495     }
19496
19497     return cp_list;
19498 }
19499
19500 /*
19501  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
19502  */
19503 #ifdef DEBUGGING
19504
19505 static void
19506 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
19507 {
19508     int bit;
19509     int set=0;
19510
19511     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
19512
19513     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
19514         if (flags & (1<<bit)) {
19515             if (!set++ && lead)
19516                 Perl_re_printf( aTHX_  "%s",lead);
19517             Perl_re_printf( aTHX_  "%s ",PL_reg_intflags_name[bit]);
19518         }
19519     }
19520     if (lead)  {
19521         if (set)
19522             Perl_re_printf( aTHX_  "\n");
19523         else
19524             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
19525     }
19526 }
19527
19528 static void
19529 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
19530 {
19531     int bit;
19532     int set=0;
19533     regex_charset cs;
19534
19535     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
19536
19537     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
19538         if (flags & (1<<bit)) {
19539             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
19540                 continue;
19541             }
19542             if (!set++ && lead)
19543                 Perl_re_printf( aTHX_  "%s",lead);
19544             Perl_re_printf( aTHX_  "%s ",PL_reg_extflags_name[bit]);
19545         }
19546     }
19547     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
19548             if (!set++ && lead) {
19549                 Perl_re_printf( aTHX_  "%s",lead);
19550             }
19551             switch (cs) {
19552                 case REGEX_UNICODE_CHARSET:
19553                     Perl_re_printf( aTHX_  "UNICODE");
19554                     break;
19555                 case REGEX_LOCALE_CHARSET:
19556                     Perl_re_printf( aTHX_  "LOCALE");
19557                     break;
19558                 case REGEX_ASCII_RESTRICTED_CHARSET:
19559                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
19560                     break;
19561                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
19562                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
19563                     break;
19564                 default:
19565                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
19566                     break;
19567             }
19568     }
19569     if (lead)  {
19570         if (set)
19571             Perl_re_printf( aTHX_  "\n");
19572         else
19573             Perl_re_printf( aTHX_  "%s[none-set]\n",lead);
19574     }
19575 }
19576 #endif
19577
19578 void
19579 Perl_regdump(pTHX_ const regexp *r)
19580 {
19581 #ifdef DEBUGGING
19582     int i;
19583     SV * const sv = sv_newmortal();
19584     SV *dsv= sv_newmortal();
19585     RXi_GET_DECL(r,ri);
19586     GET_RE_DEBUG_FLAGS_DECL;
19587
19588     PERL_ARGS_ASSERT_REGDUMP;
19589
19590     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
19591
19592     /* Header fields of interest. */
19593     for (i = 0; i < 2; i++) {
19594         if (r->substrs->data[i].substr) {
19595             RE_PV_QUOTED_DECL(s, 0, dsv,
19596                             SvPVX_const(r->substrs->data[i].substr),
19597                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
19598                             PL_dump_re_max_len);
19599             Perl_re_printf( aTHX_
19600                           "%s %s%s at %" IVdf "..%" UVuf " ",
19601                           i ? "floating" : "anchored",
19602                           s,
19603                           RE_SV_TAIL(r->substrs->data[i].substr),
19604                           (IV)r->substrs->data[i].min_offset,
19605                           (UV)r->substrs->data[i].max_offset);
19606         }
19607         else if (r->substrs->data[i].utf8_substr) {
19608             RE_PV_QUOTED_DECL(s, 1, dsv,
19609                             SvPVX_const(r->substrs->data[i].utf8_substr),
19610                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
19611                             30);
19612             Perl_re_printf( aTHX_
19613                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
19614                           i ? "floating" : "anchored",
19615                           s,
19616                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
19617                           (IV)r->substrs->data[i].min_offset,
19618                           (UV)r->substrs->data[i].max_offset);
19619         }
19620     }
19621
19622     if (r->check_substr || r->check_utf8)
19623         Perl_re_printf( aTHX_
19624                       (const char *)
19625                       (   r->check_substr == r->substrs->data[1].substr
19626                        && r->check_utf8   == r->substrs->data[1].utf8_substr
19627                        ? "(checking floating" : "(checking anchored"));
19628     if (r->intflags & PREGf_NOSCAN)
19629         Perl_re_printf( aTHX_  " noscan");
19630     if (r->extflags & RXf_CHECK_ALL)
19631         Perl_re_printf( aTHX_  " isall");
19632     if (r->check_substr || r->check_utf8)
19633         Perl_re_printf( aTHX_  ") ");
19634
19635     if (ri->regstclass) {
19636         regprop(r, sv, ri->regstclass, NULL, NULL);
19637         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
19638     }
19639     if (r->intflags & PREGf_ANCH) {
19640         Perl_re_printf( aTHX_  "anchored");
19641         if (r->intflags & PREGf_ANCH_MBOL)
19642             Perl_re_printf( aTHX_  "(MBOL)");
19643         if (r->intflags & PREGf_ANCH_SBOL)
19644             Perl_re_printf( aTHX_  "(SBOL)");
19645         if (r->intflags & PREGf_ANCH_GPOS)
19646             Perl_re_printf( aTHX_  "(GPOS)");
19647         Perl_re_printf( aTHX_ " ");
19648     }
19649     if (r->intflags & PREGf_GPOS_SEEN)
19650         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
19651     if (r->intflags & PREGf_SKIP)
19652         Perl_re_printf( aTHX_  "plus ");
19653     if (r->intflags & PREGf_IMPLICIT)
19654         Perl_re_printf( aTHX_  "implicit ");
19655     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
19656     if (r->extflags & RXf_EVAL_SEEN)
19657         Perl_re_printf( aTHX_  "with eval ");
19658     Perl_re_printf( aTHX_  "\n");
19659     DEBUG_FLAGS_r({
19660         regdump_extflags("r->extflags: ",r->extflags);
19661         regdump_intflags("r->intflags: ",r->intflags);
19662     });
19663 #else
19664     PERL_ARGS_ASSERT_REGDUMP;
19665     PERL_UNUSED_CONTEXT;
19666     PERL_UNUSED_ARG(r);
19667 #endif  /* DEBUGGING */
19668 }
19669
19670 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
19671 #ifdef DEBUGGING
19672
19673 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
19674      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
19675      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
19676      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
19677      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
19678      || _CC_VERTSPACE != 15
19679 #   error Need to adjust order of anyofs[]
19680 #  endif
19681 static const char * const anyofs[] = {
19682     "\\w",
19683     "\\W",
19684     "\\d",
19685     "\\D",
19686     "[:alpha:]",
19687     "[:^alpha:]",
19688     "[:lower:]",
19689     "[:^lower:]",
19690     "[:upper:]",
19691     "[:^upper:]",
19692     "[:punct:]",
19693     "[:^punct:]",
19694     "[:print:]",
19695     "[:^print:]",
19696     "[:alnum:]",
19697     "[:^alnum:]",
19698     "[:graph:]",
19699     "[:^graph:]",
19700     "[:cased:]",
19701     "[:^cased:]",
19702     "\\s",
19703     "\\S",
19704     "[:blank:]",
19705     "[:^blank:]",
19706     "[:xdigit:]",
19707     "[:^xdigit:]",
19708     "[:cntrl:]",
19709     "[:^cntrl:]",
19710     "[:ascii:]",
19711     "[:^ascii:]",
19712     "\\v",
19713     "\\V"
19714 };
19715 #endif
19716
19717 /*
19718 - regprop - printable representation of opcode, with run time support
19719 */
19720
19721 void
19722 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
19723 {
19724 #ifdef DEBUGGING
19725     int k;
19726     RXi_GET_DECL(prog,progi);
19727     GET_RE_DEBUG_FLAGS_DECL;
19728
19729     PERL_ARGS_ASSERT_REGPROP;
19730
19731     SvPVCLEAR(sv);
19732
19733     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
19734         /* It would be nice to FAIL() here, but this may be called from
19735            regexec.c, and it would be hard to supply pRExC_state. */
19736         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
19737                                               (int)OP(o), (int)REGNODE_MAX);
19738     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
19739
19740     k = PL_regkind[OP(o)];
19741
19742     if (k == EXACT) {
19743         sv_catpvs(sv, " ");
19744         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
19745          * is a crude hack but it may be the best for now since
19746          * we have no flag "this EXACTish node was UTF-8"
19747          * --jhi */
19748         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
19749                   PL_colors[0], PL_colors[1],
19750                   PERL_PV_ESCAPE_UNI_DETECT |
19751                   PERL_PV_ESCAPE_NONASCII   |
19752                   PERL_PV_PRETTY_ELLIPSES   |
19753                   PERL_PV_PRETTY_LTGT       |
19754                   PERL_PV_PRETTY_NOCLEAR
19755                   );
19756     } else if (k == TRIE) {
19757         /* print the details of the trie in dumpuntil instead, as
19758          * progi->data isn't available here */
19759         const char op = OP(o);
19760         const U32 n = ARG(o);
19761         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
19762                (reg_ac_data *)progi->data->data[n] :
19763                NULL;
19764         const reg_trie_data * const trie
19765             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
19766
19767         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
19768         DEBUG_TRIE_COMPILE_r({
19769           if (trie->jump)
19770             sv_catpvs(sv, "(JUMP)");
19771           Perl_sv_catpvf(aTHX_ sv,
19772             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
19773             (UV)trie->startstate,
19774             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
19775             (UV)trie->wordcount,
19776             (UV)trie->minlen,
19777             (UV)trie->maxlen,
19778             (UV)TRIE_CHARCOUNT(trie),
19779             (UV)trie->uniquecharcount
19780           );
19781         });
19782         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
19783             sv_catpvs(sv, "[");
19784             (void) put_charclass_bitmap_innards(sv,
19785                                                 ((IS_ANYOF_TRIE(op))
19786                                                  ? ANYOF_BITMAP(o)
19787                                                  : TRIE_BITMAP(trie)),
19788                                                 NULL,
19789                                                 NULL,
19790                                                 NULL,
19791                                                 FALSE
19792                                                );
19793             sv_catpvs(sv, "]");
19794         }
19795     } else if (k == CURLY) {
19796         U32 lo = ARG1(o), hi = ARG2(o);
19797         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
19798             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
19799         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
19800         if (hi == REG_INFTY)
19801             sv_catpvs(sv, "INFTY");
19802         else
19803             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
19804         sv_catpvs(sv, "}");
19805     }
19806     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
19807         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
19808     else if (k == REF || k == OPEN || k == CLOSE
19809              || k == GROUPP || OP(o)==ACCEPT)
19810     {
19811         AV *name_list= NULL;
19812         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
19813         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
19814         if ( RXp_PAREN_NAMES(prog) ) {
19815             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19816         } else if ( pRExC_state ) {
19817             name_list= RExC_paren_name_list;
19818         }
19819         if (name_list) {
19820             if ( k != REF || (OP(o) < NREF)) {
19821                 SV **name= av_fetch(name_list, parno, 0 );
19822                 if (name)
19823                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19824             }
19825             else {
19826                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
19827                 I32 *nums=(I32*)SvPVX(sv_dat);
19828                 SV **name= av_fetch(name_list, nums[0], 0 );
19829                 I32 n;
19830                 if (name) {
19831                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
19832                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
19833                                     (n ? "," : ""), (IV)nums[n]);
19834                     }
19835                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19836                 }
19837             }
19838         }
19839         if ( k == REF && reginfo) {
19840             U32 n = ARG(o);  /* which paren pair */
19841             I32 ln = prog->offs[n].start;
19842             if (prog->lastparen < n || ln == -1 || prog->offs[n].end == -1)
19843                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
19844             else if (ln == prog->offs[n].end)
19845                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
19846             else {
19847                 const char *s = reginfo->strbeg + ln;
19848                 Perl_sv_catpvf(aTHX_ sv, ": ");
19849                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
19850                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
19851             }
19852         }
19853     } else if (k == GOSUB) {
19854         AV *name_list= NULL;
19855         if ( RXp_PAREN_NAMES(prog) ) {
19856             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
19857         } else if ( pRExC_state ) {
19858             name_list= RExC_paren_name_list;
19859         }
19860
19861         /* Paren and offset */
19862         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
19863                 (int)((o + (int)ARG2L(o)) - progi->program) );
19864         if (name_list) {
19865             SV **name= av_fetch(name_list, ARG(o), 0 );
19866             if (name)
19867                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
19868         }
19869     }
19870     else if (k == LOGICAL)
19871         /* 2: embedded, otherwise 1 */
19872         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
19873     else if (k == ANYOF) {
19874         const U8 flags = ANYOF_FLAGS(o);
19875         bool do_sep = FALSE;    /* Do we need to separate various components of
19876                                    the output? */
19877         /* Set if there is still an unresolved user-defined property */
19878         SV *unresolved                = NULL;
19879
19880         /* Things that are ignored except when the runtime locale is UTF-8 */
19881         SV *only_utf8_locale_invlist = NULL;
19882
19883         /* Code points that don't fit in the bitmap */
19884         SV *nonbitmap_invlist = NULL;
19885
19886         /* And things that aren't in the bitmap, but are small enough to be */
19887         SV* bitmap_range_not_in_bitmap = NULL;
19888
19889         const bool inverted = flags & ANYOF_INVERT;
19890
19891         if (OP(o) == ANYOFL) {
19892             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
19893                 sv_catpvs(sv, "{utf8-locale-reqd}");
19894             }
19895             if (flags & ANYOFL_FOLD) {
19896                 sv_catpvs(sv, "{i}");
19897             }
19898         }
19899
19900         /* If there is stuff outside the bitmap, get it */
19901         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
19902             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
19903                                                 &unresolved,
19904                                                 &only_utf8_locale_invlist,
19905                                                 &nonbitmap_invlist);
19906             /* The non-bitmap data may contain stuff that could fit in the
19907              * bitmap.  This could come from a user-defined property being
19908              * finally resolved when this call was done; or much more likely
19909              * because there are matches that require UTF-8 to be valid, and so
19910              * aren't in the bitmap.  This is teased apart later */
19911             _invlist_intersection(nonbitmap_invlist,
19912                                   PL_InBitmap,
19913                                   &bitmap_range_not_in_bitmap);
19914             /* Leave just the things that don't fit into the bitmap */
19915             _invlist_subtract(nonbitmap_invlist,
19916                               PL_InBitmap,
19917                               &nonbitmap_invlist);
19918         }
19919
19920         /* Obey this flag to add all above-the-bitmap code points */
19921         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
19922             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
19923                                                       NUM_ANYOF_CODE_POINTS,
19924                                                       UV_MAX);
19925         }
19926
19927         /* Ready to start outputting.  First, the initial left bracket */
19928         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
19929
19930         /* Then all the things that could fit in the bitmap */
19931         do_sep = put_charclass_bitmap_innards(sv,
19932                                               ANYOF_BITMAP(o),
19933                                               bitmap_range_not_in_bitmap,
19934                                               only_utf8_locale_invlist,
19935                                               o,
19936
19937                                               /* Can't try inverting for a
19938                                                * better display if there are
19939                                                * things that haven't been
19940                                                * resolved */
19941                                               unresolved != NULL);
19942         SvREFCNT_dec(bitmap_range_not_in_bitmap);
19943
19944         /* If there are user-defined properties which haven't been defined yet,
19945          * output them.  If the result is not to be inverted, it is clearest to
19946          * output them in a separate [] from the bitmap range stuff.  If the
19947          * result is to be complemented, we have to show everything in one [],
19948          * as the inversion applies to the whole thing.  Use {braces} to
19949          * separate them from anything in the bitmap and anything above the
19950          * bitmap. */
19951         if (unresolved) {
19952             if (inverted) {
19953                 if (! do_sep) { /* If didn't output anything in the bitmap */
19954                     sv_catpvs(sv, "^");
19955                 }
19956                 sv_catpvs(sv, "{");
19957             }
19958             else if (do_sep) {
19959                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19960             }
19961             sv_catsv(sv, unresolved);
19962             if (inverted) {
19963                 sv_catpvs(sv, "}");
19964             }
19965             do_sep = ! inverted;
19966         }
19967
19968         /* And, finally, add the above-the-bitmap stuff */
19969         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
19970             SV* contents;
19971
19972             /* See if truncation size is overridden */
19973             const STRLEN dump_len = (PL_dump_re_max_len > 256)
19974                                     ? PL_dump_re_max_len
19975                                     : 256;
19976
19977             /* This is output in a separate [] */
19978             if (do_sep) {
19979                 Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
19980             }
19981
19982             /* And, for easy of understanding, it is shown in the
19983              * uncomplemented form if possible.  The one exception being if
19984              * there are unresolved items, where the inversion has to be
19985              * delayed until runtime */
19986             if (inverted && ! unresolved) {
19987                 _invlist_invert(nonbitmap_invlist);
19988                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
19989             }
19990
19991             contents = invlist_contents(nonbitmap_invlist,
19992                                         FALSE /* output suitable for catsv */
19993                                        );
19994
19995             /* If the output is shorter than the permissible maximum, just do it. */
19996             if (SvCUR(contents) <= dump_len) {
19997                 sv_catsv(sv, contents);
19998             }
19999             else {
20000                 const char * contents_string = SvPVX(contents);
20001                 STRLEN i = dump_len;
20002
20003                 /* Otherwise, start at the permissible max and work back to the
20004                  * first break possibility */
20005                 while (i > 0 && contents_string[i] != ' ') {
20006                     i--;
20007                 }
20008                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
20009                                        find a legal break */
20010                     i = dump_len;
20011                 }
20012
20013                 sv_catpvn(sv, contents_string, i);
20014                 sv_catpvs(sv, "...");
20015             }
20016
20017             SvREFCNT_dec_NN(contents);
20018             SvREFCNT_dec_NN(nonbitmap_invlist);
20019         }
20020
20021         /* And finally the matching, closing ']' */
20022         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20023
20024         SvREFCNT_dec(unresolved);
20025     }
20026     else if (k == ANYOFM) {
20027         SV * cp_list = get_ANYOFM_contents(o);
20028
20029         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20030         put_charclass_bitmap_innards(sv, NULL, cp_list, NULL, NULL, TRUE);
20031         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20032
20033         SvREFCNT_dec(cp_list);
20034     }
20035     else if (k == POSIXD || k == NPOSIXD) {
20036         U8 index = FLAGS(o) * 2;
20037         if (index < C_ARRAY_LENGTH(anyofs)) {
20038             if (*anyofs[index] != '[')  {
20039                 sv_catpvs(sv, "[");
20040             }
20041             sv_catpv(sv, anyofs[index]);
20042             if (*anyofs[index] != '[')  {
20043                 sv_catpvs(sv, "]");
20044             }
20045         }
20046         else {
20047             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
20048         }
20049     }
20050     else if (k == BOUND || k == NBOUND) {
20051         /* Must be synced with order of 'bound_type' in regcomp.h */
20052         const char * const bounds[] = {
20053             "",      /* Traditional */
20054             "{gcb}",
20055             "{lb}",
20056             "{sb}",
20057             "{wb}"
20058         };
20059         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
20060         sv_catpv(sv, bounds[FLAGS(o)]);
20061     }
20062     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
20063         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
20064     else if (OP(o) == SBOL)
20065         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
20066
20067     /* add on the verb argument if there is one */
20068     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
20069         if ( ARG(o) )
20070             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
20071                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
20072         else
20073             sv_catpvs(sv, ":NULL");
20074     }
20075 #else
20076     PERL_UNUSED_CONTEXT;
20077     PERL_UNUSED_ARG(sv);
20078     PERL_UNUSED_ARG(o);
20079     PERL_UNUSED_ARG(prog);
20080     PERL_UNUSED_ARG(reginfo);
20081     PERL_UNUSED_ARG(pRExC_state);
20082 #endif  /* DEBUGGING */
20083 }
20084
20085
20086
20087 SV *
20088 Perl_re_intuit_string(pTHX_ REGEXP * const r)
20089 {                               /* Assume that RE_INTUIT is set */
20090     struct regexp *const prog = ReANY(r);
20091     GET_RE_DEBUG_FLAGS_DECL;
20092
20093     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
20094     PERL_UNUSED_CONTEXT;
20095
20096     DEBUG_COMPILE_r(
20097         {
20098             const char * const s = SvPV_nolen_const(RX_UTF8(r)
20099                       ? prog->check_utf8 : prog->check_substr);
20100
20101             if (!PL_colorset) reginitcolors();
20102             Perl_re_printf( aTHX_
20103                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
20104                       PL_colors[4],
20105                       RX_UTF8(r) ? "utf8 " : "",
20106                       PL_colors[5],PL_colors[0],
20107                       s,
20108                       PL_colors[1],
20109                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
20110         } );
20111
20112     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
20113     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
20114 }
20115
20116 /*
20117    pregfree()
20118
20119    handles refcounting and freeing the perl core regexp structure. When
20120    it is necessary to actually free the structure the first thing it
20121    does is call the 'free' method of the regexp_engine associated to
20122    the regexp, allowing the handling of the void *pprivate; member
20123    first. (This routine is not overridable by extensions, which is why
20124    the extensions free is called first.)
20125
20126    See regdupe and regdupe_internal if you change anything here.
20127 */
20128 #ifndef PERL_IN_XSUB_RE
20129 void
20130 Perl_pregfree(pTHX_ REGEXP *r)
20131 {
20132     SvREFCNT_dec(r);
20133 }
20134
20135 void
20136 Perl_pregfree2(pTHX_ REGEXP *rx)
20137 {
20138     struct regexp *const r = ReANY(rx);
20139     GET_RE_DEBUG_FLAGS_DECL;
20140
20141     PERL_ARGS_ASSERT_PREGFREE2;
20142
20143     if (r->mother_re) {
20144         ReREFCNT_dec(r->mother_re);
20145     } else {
20146         CALLREGFREE_PVT(rx); /* free the private data */
20147         SvREFCNT_dec(RXp_PAREN_NAMES(r));
20148     }
20149     if (r->substrs) {
20150         int i;
20151         for (i = 0; i < 2; i++) {
20152             SvREFCNT_dec(r->substrs->data[i].substr);
20153             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
20154         }
20155         Safefree(r->substrs);
20156     }
20157     RX_MATCH_COPY_FREE(rx);
20158 #ifdef PERL_ANY_COW
20159     SvREFCNT_dec(r->saved_copy);
20160 #endif
20161     Safefree(r->offs);
20162     SvREFCNT_dec(r->qr_anoncv);
20163     if (r->recurse_locinput)
20164         Safefree(r->recurse_locinput);
20165 }
20166
20167
20168 /*  reg_temp_copy()
20169
20170     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
20171     except that dsv will be created if NULL.
20172
20173     This function is used in two main ways. First to implement
20174         $r = qr/....; $s = $$r;
20175
20176     Secondly, it is used as a hacky workaround to the structural issue of
20177     match results
20178     being stored in the regexp structure which is in turn stored in
20179     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
20180     could be PL_curpm in multiple contexts, and could require multiple
20181     result sets being associated with the pattern simultaneously, such
20182     as when doing a recursive match with (??{$qr})
20183
20184     The solution is to make a lightweight copy of the regexp structure
20185     when a qr// is returned from the code executed by (??{$qr}) this
20186     lightweight copy doesn't actually own any of its data except for
20187     the starp/end and the actual regexp structure itself.
20188
20189 */
20190
20191
20192 REGEXP *
20193 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
20194 {
20195     struct regexp *drx;
20196     struct regexp *const srx = ReANY(ssv);
20197     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
20198
20199     PERL_ARGS_ASSERT_REG_TEMP_COPY;
20200
20201     if (!dsv)
20202         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
20203     else {
20204         SvOK_off((SV *)dsv);
20205         if (islv) {
20206             /* For PVLVs, the head (sv_any) points to an XPVLV, while
20207              * the LV's xpvlenu_rx will point to a regexp body, which
20208              * we allocate here */
20209             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
20210             assert(!SvPVX(dsv));
20211             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
20212             temp->sv_any = NULL;
20213             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
20214             SvREFCNT_dec_NN(temp);
20215             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
20216                ing below will not set it. */
20217             SvCUR_set(dsv, SvCUR(ssv));
20218         }
20219     }
20220     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
20221        sv_force_normal(sv) is called.  */
20222     SvFAKE_on(dsv);
20223     drx = ReANY(dsv);
20224
20225     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
20226     SvPV_set(dsv, RX_WRAPPED(ssv));
20227     /* We share the same string buffer as the original regexp, on which we
20228        hold a reference count, incremented when mother_re is set below.
20229        The string pointer is copied here, being part of the regexp struct.
20230      */
20231     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
20232            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
20233     if (!islv)
20234         SvLEN_set(dsv, 0);
20235     if (srx->offs) {
20236         const I32 npar = srx->nparens+1;
20237         Newx(drx->offs, npar, regexp_paren_pair);
20238         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
20239     }
20240     if (srx->substrs) {
20241         int i;
20242         Newx(drx->substrs, 1, struct reg_substr_data);
20243         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
20244
20245         for (i = 0; i < 2; i++) {
20246             SvREFCNT_inc_void(drx->substrs->data[i].substr);
20247             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
20248         }
20249
20250         /* check_substr and check_utf8, if non-NULL, point to either their
20251            anchored or float namesakes, and don't hold a second reference.  */
20252     }
20253     RX_MATCH_COPIED_off(dsv);
20254 #ifdef PERL_ANY_COW
20255     drx->saved_copy = NULL;
20256 #endif
20257     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
20258     SvREFCNT_inc_void(drx->qr_anoncv);
20259     if (srx->recurse_locinput)
20260         Newx(drx->recurse_locinput,srx->nparens + 1,char *);
20261
20262     return dsv;
20263 }
20264 #endif
20265
20266
20267 /* regfree_internal()
20268
20269    Free the private data in a regexp. This is overloadable by
20270    extensions. Perl takes care of the regexp structure in pregfree(),
20271    this covers the *pprivate pointer which technically perl doesn't
20272    know about, however of course we have to handle the
20273    regexp_internal structure when no extension is in use.
20274
20275    Note this is called before freeing anything in the regexp
20276    structure.
20277  */
20278
20279 void
20280 Perl_regfree_internal(pTHX_ REGEXP * const rx)
20281 {
20282     struct regexp *const r = ReANY(rx);
20283     RXi_GET_DECL(r,ri);
20284     GET_RE_DEBUG_FLAGS_DECL;
20285
20286     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
20287
20288     DEBUG_COMPILE_r({
20289         if (!PL_colorset)
20290             reginitcolors();
20291         {
20292             SV *dsv= sv_newmortal();
20293             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
20294                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
20295             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
20296                 PL_colors[4],PL_colors[5],s);
20297         }
20298     });
20299 #ifdef RE_TRACK_PATTERN_OFFSETS
20300     if (ri->u.offsets)
20301         Safefree(ri->u.offsets);             /* 20010421 MJD */
20302 #endif
20303     if (ri->code_blocks)
20304         S_free_codeblocks(aTHX_ ri->code_blocks);
20305
20306     if (ri->data) {
20307         int n = ri->data->count;
20308
20309         while (--n >= 0) {
20310           /* If you add a ->what type here, update the comment in regcomp.h */
20311             switch (ri->data->what[n]) {
20312             case 'a':
20313             case 'r':
20314             case 's':
20315             case 'S':
20316             case 'u':
20317                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
20318                 break;
20319             case 'f':
20320                 Safefree(ri->data->data[n]);
20321                 break;
20322             case 'l':
20323             case 'L':
20324                 break;
20325             case 'T':
20326                 { /* Aho Corasick add-on structure for a trie node.
20327                      Used in stclass optimization only */
20328                     U32 refcount;
20329                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
20330 #ifdef USE_ITHREADS
20331                     dVAR;
20332 #endif
20333                     OP_REFCNT_LOCK;
20334                     refcount = --aho->refcount;
20335                     OP_REFCNT_UNLOCK;
20336                     if ( !refcount ) {
20337                         PerlMemShared_free(aho->states);
20338                         PerlMemShared_free(aho->fail);
20339                          /* do this last!!!! */
20340                         PerlMemShared_free(ri->data->data[n]);
20341                         /* we should only ever get called once, so
20342                          * assert as much, and also guard the free
20343                          * which /might/ happen twice. At the least
20344                          * it will make code anlyzers happy and it
20345                          * doesn't cost much. - Yves */
20346                         assert(ri->regstclass);
20347                         if (ri->regstclass) {
20348                             PerlMemShared_free(ri->regstclass);
20349                             ri->regstclass = 0;
20350                         }
20351                     }
20352                 }
20353                 break;
20354             case 't':
20355                 {
20356                     /* trie structure. */
20357                     U32 refcount;
20358                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
20359 #ifdef USE_ITHREADS
20360                     dVAR;
20361 #endif
20362                     OP_REFCNT_LOCK;
20363                     refcount = --trie->refcount;
20364                     OP_REFCNT_UNLOCK;
20365                     if ( !refcount ) {
20366                         PerlMemShared_free(trie->charmap);
20367                         PerlMemShared_free(trie->states);
20368                         PerlMemShared_free(trie->trans);
20369                         if (trie->bitmap)
20370                             PerlMemShared_free(trie->bitmap);
20371                         if (trie->jump)
20372                             PerlMemShared_free(trie->jump);
20373                         PerlMemShared_free(trie->wordinfo);
20374                         /* do this last!!!! */
20375                         PerlMemShared_free(ri->data->data[n]);
20376                     }
20377                 }
20378                 break;
20379             default:
20380                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
20381                                                     ri->data->what[n]);
20382             }
20383         }
20384         Safefree(ri->data->what);
20385         Safefree(ri->data);
20386     }
20387
20388     Safefree(ri);
20389 }
20390
20391 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
20392 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
20393 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
20394
20395 /*
20396    re_dup_guts - duplicate a regexp.
20397
20398    This routine is expected to clone a given regexp structure. It is only
20399    compiled under USE_ITHREADS.
20400
20401    After all of the core data stored in struct regexp is duplicated
20402    the regexp_engine.dupe method is used to copy any private data
20403    stored in the *pprivate pointer. This allows extensions to handle
20404    any duplication it needs to do.
20405
20406    See pregfree() and regfree_internal() if you change anything here.
20407 */
20408 #if defined(USE_ITHREADS)
20409 #ifndef PERL_IN_XSUB_RE
20410 void
20411 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
20412 {
20413     dVAR;
20414     I32 npar;
20415     const struct regexp *r = ReANY(sstr);
20416     struct regexp *ret = ReANY(dstr);
20417
20418     PERL_ARGS_ASSERT_RE_DUP_GUTS;
20419
20420     npar = r->nparens+1;
20421     Newx(ret->offs, npar, regexp_paren_pair);
20422     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
20423
20424     if (ret->substrs) {
20425         /* Do it this way to avoid reading from *r after the StructCopy().
20426            That way, if any of the sv_dup_inc()s dislodge *r from the L1
20427            cache, it doesn't matter.  */
20428         int i;
20429         const bool anchored = r->check_substr
20430             ? r->check_substr == r->substrs->data[0].substr
20431             : r->check_utf8   == r->substrs->data[0].utf8_substr;
20432         Newx(ret->substrs, 1, struct reg_substr_data);
20433         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
20434
20435         for (i = 0; i < 2; i++) {
20436             ret->substrs->data[i].substr =
20437                         sv_dup_inc(ret->substrs->data[i].substr, param);
20438             ret->substrs->data[i].utf8_substr =
20439                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
20440         }
20441
20442         /* check_substr and check_utf8, if non-NULL, point to either their
20443            anchored or float namesakes, and don't hold a second reference.  */
20444
20445         if (ret->check_substr) {
20446             if (anchored) {
20447                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
20448
20449                 ret->check_substr = ret->substrs->data[0].substr;
20450                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
20451             } else {
20452                 assert(r->check_substr == r->substrs->data[1].substr);
20453                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
20454
20455                 ret->check_substr = ret->substrs->data[1].substr;
20456                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
20457             }
20458         } else if (ret->check_utf8) {
20459             if (anchored) {
20460                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
20461             } else {
20462                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
20463             }
20464         }
20465     }
20466
20467     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
20468     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
20469     if (r->recurse_locinput)
20470         Newx(ret->recurse_locinput,r->nparens + 1,char *);
20471
20472     if (ret->pprivate)
20473         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
20474
20475     if (RX_MATCH_COPIED(dstr))
20476         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
20477     else
20478         ret->subbeg = NULL;
20479 #ifdef PERL_ANY_COW
20480     ret->saved_copy = NULL;
20481 #endif
20482
20483     /* Whether mother_re be set or no, we need to copy the string.  We
20484        cannot refrain from copying it when the storage points directly to
20485        our mother regexp, because that's
20486                1: a buffer in a different thread
20487                2: something we no longer hold a reference on
20488                so we need to copy it locally.  */
20489     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
20490     ret->mother_re   = NULL;
20491 }
20492 #endif /* PERL_IN_XSUB_RE */
20493
20494 /*
20495    regdupe_internal()
20496
20497    This is the internal complement to regdupe() which is used to copy
20498    the structure pointed to by the *pprivate pointer in the regexp.
20499    This is the core version of the extension overridable cloning hook.
20500    The regexp structure being duplicated will be copied by perl prior
20501    to this and will be provided as the regexp *r argument, however
20502    with the /old/ structures pprivate pointer value. Thus this routine
20503    may override any copying normally done by perl.
20504
20505    It returns a pointer to the new regexp_internal structure.
20506 */
20507
20508 void *
20509 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
20510 {
20511     dVAR;
20512     struct regexp *const r = ReANY(rx);
20513     regexp_internal *reti;
20514     int len;
20515     RXi_GET_DECL(r,ri);
20516
20517     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
20518
20519     len = ProgLen(ri);
20520
20521     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
20522           char, regexp_internal);
20523     Copy(ri->program, reti->program, len+1, regnode);
20524
20525
20526     if (ri->code_blocks) {
20527         int n;
20528         Newx(reti->code_blocks, 1, struct reg_code_blocks);
20529         Newx(reti->code_blocks->cb, ri->code_blocks->count,
20530                     struct reg_code_block);
20531         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
20532              ri->code_blocks->count, struct reg_code_block);
20533         for (n = 0; n < ri->code_blocks->count; n++)
20534              reti->code_blocks->cb[n].src_regex = (REGEXP*)
20535                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
20536         reti->code_blocks->count = ri->code_blocks->count;
20537         reti->code_blocks->refcnt = 1;
20538     }
20539     else
20540         reti->code_blocks = NULL;
20541
20542     reti->regstclass = NULL;
20543
20544     if (ri->data) {
20545         struct reg_data *d;
20546         const int count = ri->data->count;
20547         int i;
20548
20549         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
20550                 char, struct reg_data);
20551         Newx(d->what, count, U8);
20552
20553         d->count = count;
20554         for (i = 0; i < count; i++) {
20555             d->what[i] = ri->data->what[i];
20556             switch (d->what[i]) {
20557                 /* see also regcomp.h and regfree_internal() */
20558             case 'a': /* actually an AV, but the dup function is identical.
20559                          values seem to be "plain sv's" generally. */
20560             case 'r': /* a compiled regex (but still just another SV) */
20561             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
20562                          this use case should go away, the code could have used
20563                          'a' instead - see S_set_ANYOF_arg() for array contents. */
20564             case 'S': /* actually an SV, but the dup function is identical.  */
20565             case 'u': /* actually an HV, but the dup function is identical.
20566                          values are "plain sv's" */
20567                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
20568                 break;
20569             case 'f':
20570                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
20571                  * patterns which could start with several different things. Pre-TRIE
20572                  * this was more important than it is now, however this still helps
20573                  * in some places, for instance /x?a+/ might produce a SSC equivalent
20574                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
20575                  * in regexec.c
20576                  */
20577                 /* This is cheating. */
20578                 Newx(d->data[i], 1, regnode_ssc);
20579                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
20580                 reti->regstclass = (regnode*)d->data[i];
20581                 break;
20582             case 'T':
20583                 /* AHO-CORASICK fail table */
20584                 /* Trie stclasses are readonly and can thus be shared
20585                  * without duplication. We free the stclass in pregfree
20586                  * when the corresponding reg_ac_data struct is freed.
20587                  */
20588                 reti->regstclass= ri->regstclass;
20589                 /* FALLTHROUGH */
20590             case 't':
20591                 /* TRIE transition table */
20592                 OP_REFCNT_LOCK;
20593                 ((reg_trie_data*)ri->data->data[i])->refcount++;
20594                 OP_REFCNT_UNLOCK;
20595                 /* FALLTHROUGH */
20596             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
20597             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
20598                          is not from another regexp */
20599                 d->data[i] = ri->data->data[i];
20600                 break;
20601             default:
20602                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
20603                                                            ri->data->what[i]);
20604             }
20605         }
20606
20607         reti->data = d;
20608     }
20609     else
20610         reti->data = NULL;
20611
20612     reti->name_list_idx = ri->name_list_idx;
20613
20614 #ifdef RE_TRACK_PATTERN_OFFSETS
20615     if (ri->u.offsets) {
20616         Newx(reti->u.offsets, 2*len+1, U32);
20617         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
20618     }
20619 #else
20620     SetProgLen(reti,len);
20621 #endif
20622
20623     return (void*)reti;
20624 }
20625
20626 #endif    /* USE_ITHREADS */
20627
20628 #ifndef PERL_IN_XSUB_RE
20629
20630 /*
20631  - regnext - dig the "next" pointer out of a node
20632  */
20633 regnode *
20634 Perl_regnext(pTHX_ regnode *p)
20635 {
20636     I32 offset;
20637
20638     if (!p)
20639         return(NULL);
20640
20641     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
20642         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
20643                                                 (int)OP(p), (int)REGNODE_MAX);
20644     }
20645
20646     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
20647     if (offset == 0)
20648         return(NULL);
20649
20650     return(p+offset);
20651 }
20652 #endif
20653
20654 STATIC void
20655 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
20656 {
20657     va_list args;
20658     STRLEN l1 = strlen(pat1);
20659     STRLEN l2 = strlen(pat2);
20660     char buf[512];
20661     SV *msv;
20662     const char *message;
20663
20664     PERL_ARGS_ASSERT_RE_CROAK2;
20665
20666     if (l1 > 510)
20667         l1 = 510;
20668     if (l1 + l2 > 510)
20669         l2 = 510 - l1;
20670     Copy(pat1, buf, l1 , char);
20671     Copy(pat2, buf + l1, l2 , char);
20672     buf[l1 + l2] = '\n';
20673     buf[l1 + l2 + 1] = '\0';
20674     va_start(args, pat2);
20675     msv = vmess(buf, &args);
20676     va_end(args);
20677     message = SvPV_const(msv,l1);
20678     if (l1 > 512)
20679         l1 = 512;
20680     Copy(message, buf, l1 , char);
20681     /* l1-1 to avoid \n */
20682     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
20683 }
20684
20685 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
20686
20687 #ifndef PERL_IN_XSUB_RE
20688 void
20689 Perl_save_re_context(pTHX)
20690 {
20691     I32 nparens = -1;
20692     I32 i;
20693
20694     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
20695
20696     if (PL_curpm) {
20697         const REGEXP * const rx = PM_GETRE(PL_curpm);
20698         if (rx)
20699             nparens = RX_NPARENS(rx);
20700     }
20701
20702     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
20703      * that PL_curpm will be null, but that utf8.pm and the modules it
20704      * loads will only use $1..$3.
20705      * The t/porting/re_context.t test file checks this assumption.
20706      */
20707     if (nparens == -1)
20708         nparens = 3;
20709
20710     for (i = 1; i <= nparens; i++) {
20711         char digits[TYPE_CHARS(long)];
20712         const STRLEN len = my_snprintf(digits, sizeof(digits),
20713                                        "%lu", (long)i);
20714         GV *const *const gvp
20715             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
20716
20717         if (gvp) {
20718             GV * const gv = *gvp;
20719             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
20720                 save_scalar(gv);
20721         }
20722     }
20723 }
20724 #endif
20725
20726 #ifdef DEBUGGING
20727
20728 STATIC void
20729 S_put_code_point(pTHX_ SV *sv, UV c)
20730 {
20731     PERL_ARGS_ASSERT_PUT_CODE_POINT;
20732
20733     if (c > 255) {
20734         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
20735     }
20736     else if (isPRINT(c)) {
20737         const char string = (char) c;
20738
20739         /* We use {phrase} as metanotation in the class, so also escape literal
20740          * braces */
20741         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
20742             sv_catpvs(sv, "\\");
20743         sv_catpvn(sv, &string, 1);
20744     }
20745     else if (isMNEMONIC_CNTRL(c)) {
20746         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
20747     }
20748     else {
20749         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
20750     }
20751 }
20752
20753 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
20754
20755 STATIC void
20756 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
20757 {
20758     /* Appends to 'sv' a displayable version of the range of code points from
20759      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
20760      * that have them, when they occur at the beginning or end of the range.
20761      * It uses hex to output the remaining code points, unless 'allow_literals'
20762      * is true, in which case the printable ASCII ones are output as-is (though
20763      * some of these will be escaped by put_code_point()).
20764      *
20765      * NOTE:  This is designed only for printing ranges of code points that fit
20766      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
20767      */
20768
20769     const unsigned int min_range_count = 3;
20770
20771     assert(start <= end);
20772
20773     PERL_ARGS_ASSERT_PUT_RANGE;
20774
20775     while (start <= end) {
20776         UV this_end;
20777         const char * format;
20778
20779         if (end - start < min_range_count) {
20780
20781             /* Output chars individually when they occur in short ranges */
20782             for (; start <= end; start++) {
20783                 put_code_point(sv, start);
20784             }
20785             break;
20786         }
20787
20788         /* If permitted by the input options, and there is a possibility that
20789          * this range contains a printable literal, look to see if there is
20790          * one. */
20791         if (allow_literals && start <= MAX_PRINT_A) {
20792
20793             /* If the character at the beginning of the range isn't an ASCII
20794              * printable, effectively split the range into two parts:
20795              *  1) the portion before the first such printable,
20796              *  2) the rest
20797              * and output them separately. */
20798             if (! isPRINT_A(start)) {
20799                 UV temp_end = start + 1;
20800
20801                 /* There is no point looking beyond the final possible
20802                  * printable, in MAX_PRINT_A */
20803                 UV max = MIN(end, MAX_PRINT_A);
20804
20805                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
20806                     temp_end++;
20807                 }
20808
20809                 /* Here, temp_end points to one beyond the first printable if
20810                  * found, or to one beyond 'max' if not.  If none found, make
20811                  * sure that we use the entire range */
20812                 if (temp_end > MAX_PRINT_A) {
20813                     temp_end = end + 1;
20814                 }
20815
20816                 /* Output the first part of the split range: the part that
20817                  * doesn't have printables, with the parameter set to not look
20818                  * for literals (otherwise we would infinitely recurse) */
20819                 put_range(sv, start, temp_end - 1, FALSE);
20820
20821                 /* The 2nd part of the range (if any) starts here. */
20822                 start = temp_end;
20823
20824                 /* We do a continue, instead of dropping down, because even if
20825                  * the 2nd part is non-empty, it could be so short that we want
20826                  * to output it as individual characters, as tested for at the
20827                  * top of this loop.  */
20828                 continue;
20829             }
20830
20831             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
20832              * output a sub-range of just the digits or letters, then process
20833              * the remaining portion as usual. */
20834             if (isALPHANUMERIC_A(start)) {
20835                 UV mask = (isDIGIT_A(start))
20836                            ? _CC_DIGIT
20837                              : isUPPER_A(start)
20838                                ? _CC_UPPER
20839                                : _CC_LOWER;
20840                 UV temp_end = start + 1;
20841
20842                 /* Find the end of the sub-range that includes just the
20843                  * characters in the same class as the first character in it */
20844                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
20845                     temp_end++;
20846                 }
20847                 temp_end--;
20848
20849                 /* For short ranges, don't duplicate the code above to output
20850                  * them; just call recursively */
20851                 if (temp_end - start < min_range_count) {
20852                     put_range(sv, start, temp_end, FALSE);
20853                 }
20854                 else {  /* Output as a range */
20855                     put_code_point(sv, start);
20856                     sv_catpvs(sv, "-");
20857                     put_code_point(sv, temp_end);
20858                 }
20859                 start = temp_end + 1;
20860                 continue;
20861             }
20862
20863             /* We output any other printables as individual characters */
20864             if (isPUNCT_A(start) || isSPACE_A(start)) {
20865                 while (start <= end && (isPUNCT_A(start)
20866                                         || isSPACE_A(start)))
20867                 {
20868                     put_code_point(sv, start);
20869                     start++;
20870                 }
20871                 continue;
20872             }
20873         } /* End of looking for literals */
20874
20875         /* Here is not to output as a literal.  Some control characters have
20876          * mnemonic names.  Split off any of those at the beginning and end of
20877          * the range to print mnemonically.  It isn't possible for many of
20878          * these to be in a row, so this won't overwhelm with output */
20879         if (   start <= end
20880             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
20881         {
20882             while (isMNEMONIC_CNTRL(start) && start <= end) {
20883                 put_code_point(sv, start);
20884                 start++;
20885             }
20886
20887             /* If this didn't take care of the whole range ... */
20888             if (start <= end) {
20889
20890                 /* Look backwards from the end to find the final non-mnemonic
20891                  * */
20892                 UV temp_end = end;
20893                 while (isMNEMONIC_CNTRL(temp_end)) {
20894                     temp_end--;
20895                 }
20896
20897                 /* And separately output the interior range that doesn't start
20898                  * or end with mnemonics */
20899                 put_range(sv, start, temp_end, FALSE);
20900
20901                 /* Then output the mnemonic trailing controls */
20902                 start = temp_end + 1;
20903                 while (start <= end) {
20904                     put_code_point(sv, start);
20905                     start++;
20906                 }
20907                 break;
20908             }
20909         }
20910
20911         /* As a final resort, output the range or subrange as hex. */
20912
20913         this_end = (end < NUM_ANYOF_CODE_POINTS)
20914                     ? end
20915                     : NUM_ANYOF_CODE_POINTS - 1;
20916 #if NUM_ANYOF_CODE_POINTS > 256
20917         format = (this_end < 256)
20918                  ? "\\x%02" UVXf "-\\x%02" UVXf
20919                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
20920 #else
20921         format = "\\x%02" UVXf "-\\x%02" UVXf;
20922 #endif
20923         GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral);
20924         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
20925         GCC_DIAG_RESTORE_STMT;
20926         break;
20927     }
20928 }
20929
20930 STATIC void
20931 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
20932 {
20933     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
20934      * 'invlist' */
20935
20936     UV start, end;
20937     bool allow_literals = TRUE;
20938
20939     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
20940
20941     /* Generally, it is more readable if printable characters are output as
20942      * literals, but if a range (nearly) spans all of them, it's best to output
20943      * it as a single range.  This code will use a single range if all but 2
20944      * ASCII printables are in it */
20945     invlist_iterinit(invlist);
20946     while (invlist_iternext(invlist, &start, &end)) {
20947
20948         /* If the range starts beyond the final printable, it doesn't have any
20949          * in it */
20950         if (start > MAX_PRINT_A) {
20951             break;
20952         }
20953
20954         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
20955          * all but two, the range must start and end no later than 2 from
20956          * either end */
20957         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
20958             if (end > MAX_PRINT_A) {
20959                 end = MAX_PRINT_A;
20960             }
20961             if (start < ' ') {
20962                 start = ' ';
20963             }
20964             if (end - start >= MAX_PRINT_A - ' ' - 2) {
20965                 allow_literals = FALSE;
20966             }
20967             break;
20968         }
20969     }
20970     invlist_iterfinish(invlist);
20971
20972     /* Here we have figured things out.  Output each range */
20973     invlist_iterinit(invlist);
20974     while (invlist_iternext(invlist, &start, &end)) {
20975         if (start >= NUM_ANYOF_CODE_POINTS) {
20976             break;
20977         }
20978         put_range(sv, start, end, allow_literals);
20979     }
20980     invlist_iterfinish(invlist);
20981
20982     return;
20983 }
20984
20985 STATIC SV*
20986 S_put_charclass_bitmap_innards_common(pTHX_
20987         SV* invlist,            /* The bitmap */
20988         SV* posixes,            /* Under /l, things like [:word:], \S */
20989         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
20990         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
20991         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
20992         const bool invert       /* Is the result to be inverted? */
20993 )
20994 {
20995     /* Create and return an SV containing a displayable version of the bitmap
20996      * and associated information determined by the input parameters.  If the
20997      * output would have been only the inversion indicator '^', NULL is instead
20998      * returned. */
20999
21000     SV * output;
21001
21002     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
21003
21004     if (invert) {
21005         output = newSVpvs("^");
21006     }
21007     else {
21008         output = newSVpvs("");
21009     }
21010
21011     /* First, the code points in the bitmap that are unconditionally there */
21012     put_charclass_bitmap_innards_invlist(output, invlist);
21013
21014     /* Traditionally, these have been placed after the main code points */
21015     if (posixes) {
21016         sv_catsv(output, posixes);
21017     }
21018
21019     if (only_utf8 && _invlist_len(only_utf8)) {
21020         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
21021         put_charclass_bitmap_innards_invlist(output, only_utf8);
21022     }
21023
21024     if (not_utf8 && _invlist_len(not_utf8)) {
21025         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
21026         put_charclass_bitmap_innards_invlist(output, not_utf8);
21027     }
21028
21029     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
21030         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
21031         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
21032
21033         /* This is the only list in this routine that can legally contain code
21034          * points outside the bitmap range.  The call just above to
21035          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
21036          * output them here.  There's about a half-dozen possible, and none in
21037          * contiguous ranges longer than 2 */
21038         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21039             UV start, end;
21040             SV* above_bitmap = NULL;
21041
21042             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
21043
21044             invlist_iterinit(above_bitmap);
21045             while (invlist_iternext(above_bitmap, &start, &end)) {
21046                 UV i;
21047
21048                 for (i = start; i <= end; i++) {
21049                     put_code_point(output, i);
21050                 }
21051             }
21052             invlist_iterfinish(above_bitmap);
21053             SvREFCNT_dec_NN(above_bitmap);
21054         }
21055     }
21056
21057     if (invert && SvCUR(output) == 1) {
21058         return NULL;
21059     }
21060
21061     return output;
21062 }
21063
21064 STATIC bool
21065 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
21066                                      char *bitmap,
21067                                      SV *nonbitmap_invlist,
21068                                      SV *only_utf8_locale_invlist,
21069                                      const regnode * const node,
21070                                      const bool force_as_is_display)
21071 {
21072     /* Appends to 'sv' a displayable version of the innards of the bracketed
21073      * character class defined by the other arguments:
21074      *  'bitmap' points to the bitmap, or NULL if to ignore that.
21075      *  'nonbitmap_invlist' is an inversion list of the code points that are in
21076      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
21077      *      none.  The reasons for this could be that they require some
21078      *      condition such as the target string being or not being in UTF-8
21079      *      (under /d), or because they came from a user-defined property that
21080      *      was not resolved at the time of the regex compilation (under /u)
21081      *  'only_utf8_locale_invlist' is an inversion list of the code points that
21082      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
21083      *  'node' is the regex pattern ANYOF node.  It is needed only when the
21084      *      above two parameters are not null, and is passed so that this
21085      *      routine can tease apart the various reasons for them.
21086      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
21087      *      to invert things to see if that leads to a cleaner display.  If
21088      *      FALSE, this routine is free to use its judgment about doing this.
21089      *
21090      * It returns TRUE if there was actually something output.  (It may be that
21091      * the bitmap, etc is empty.)
21092      *
21093      * When called for outputting the bitmap of a non-ANYOF node, just pass the
21094      * bitmap, with the succeeding parameters set to NULL, and the final one to
21095      * FALSE.
21096      */
21097
21098     /* In general, it tries to display the 'cleanest' representation of the
21099      * innards, choosing whether to display them inverted or not, regardless of
21100      * whether the class itself is to be inverted.  However,  there are some
21101      * cases where it can't try inverting, as what actually matches isn't known
21102      * until runtime, and hence the inversion isn't either. */
21103     bool inverting_allowed = ! force_as_is_display;
21104
21105     int i;
21106     STRLEN orig_sv_cur = SvCUR(sv);
21107
21108     SV* invlist;            /* Inversion list we accumulate of code points that
21109                                are unconditionally matched */
21110     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
21111                                UTF-8 */
21112     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
21113                              */
21114     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
21115     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
21116                                        is UTF-8 */
21117
21118     SV* as_is_display;      /* The output string when we take the inputs
21119                                literally */
21120     SV* inverted_display;   /* The output string when we invert the inputs */
21121
21122     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
21123
21124     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
21125                                                    to match? */
21126     /* We are biased in favor of displaying things without them being inverted,
21127      * as that is generally easier to understand */
21128     const int bias = 5;
21129
21130     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
21131
21132     /* Start off with whatever code points are passed in.  (We clone, so we
21133      * don't change the caller's list) */
21134     if (nonbitmap_invlist) {
21135         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
21136         invlist = invlist_clone(nonbitmap_invlist, NULL);
21137     }
21138     else {  /* Worst case size is every other code point is matched */
21139         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
21140     }
21141
21142     if (flags) {
21143         if (OP(node) == ANYOFD) {
21144
21145             /* This flag indicates that the code points below 0x100 in the
21146              * nonbitmap list are precisely the ones that match only when the
21147              * target is UTF-8 (they should all be non-ASCII). */
21148             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
21149             {
21150                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
21151                 _invlist_subtract(invlist, only_utf8, &invlist);
21152             }
21153
21154             /* And this flag for matching all non-ASCII 0xFF and below */
21155             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
21156             {
21157                 not_utf8 = invlist_clone(PL_UpperLatin1, NULL);
21158             }
21159         }
21160         else if (OP(node) == ANYOFL) {
21161
21162             /* If either of these flags are set, what matches isn't
21163              * determinable except during execution, so don't know enough here
21164              * to invert */
21165             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
21166                 inverting_allowed = FALSE;
21167             }
21168
21169             /* What the posix classes match also varies at runtime, so these
21170              * will be output symbolically. */
21171             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
21172                 int i;
21173
21174                 posixes = newSVpvs("");
21175                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
21176                     if (ANYOF_POSIXL_TEST(node,i)) {
21177                         sv_catpv(posixes, anyofs[i]);
21178                     }
21179                 }
21180             }
21181         }
21182     }
21183
21184     /* Accumulate the bit map into the unconditional match list */
21185     if (bitmap) {
21186         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
21187             if (BITMAP_TEST(bitmap, i)) {
21188                 int start = i++;
21189                 for (;
21190                      i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i);
21191                      i++)
21192                 { /* empty */ }
21193                 invlist = _add_range_to_invlist(invlist, start, i-1);
21194             }
21195         }
21196     }
21197
21198     /* Make sure that the conditional match lists don't have anything in them
21199      * that match unconditionally; otherwise the output is quite confusing.
21200      * This could happen if the code that populates these misses some
21201      * duplication. */
21202     if (only_utf8) {
21203         _invlist_subtract(only_utf8, invlist, &only_utf8);
21204     }
21205     if (not_utf8) {
21206         _invlist_subtract(not_utf8, invlist, &not_utf8);
21207     }
21208
21209     if (only_utf8_locale_invlist) {
21210
21211         /* Since this list is passed in, we have to make a copy before
21212          * modifying it */
21213         only_utf8_locale = invlist_clone(only_utf8_locale_invlist, NULL);
21214
21215         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
21216
21217         /* And, it can get really weird for us to try outputting an inverted
21218          * form of this list when it has things above the bitmap, so don't even
21219          * try */
21220         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21221             inverting_allowed = FALSE;
21222         }
21223     }
21224
21225     /* Calculate what the output would be if we take the input as-is */
21226     as_is_display = put_charclass_bitmap_innards_common(invlist,
21227                                                     posixes,
21228                                                     only_utf8,
21229                                                     not_utf8,
21230                                                     only_utf8_locale,
21231                                                     invert);
21232
21233     /* If have to take the output as-is, just do that */
21234     if (! inverting_allowed) {
21235         if (as_is_display) {
21236             sv_catsv(sv, as_is_display);
21237             SvREFCNT_dec_NN(as_is_display);
21238         }
21239     }
21240     else { /* But otherwise, create the output again on the inverted input, and
21241               use whichever version is shorter */
21242
21243         int inverted_bias, as_is_bias;
21244
21245         /* We will apply our bias to whichever of the the results doesn't have
21246          * the '^' */
21247         if (invert) {
21248             invert = FALSE;
21249             as_is_bias = bias;
21250             inverted_bias = 0;
21251         }
21252         else {
21253             invert = TRUE;
21254             as_is_bias = 0;
21255             inverted_bias = bias;
21256         }
21257
21258         /* Now invert each of the lists that contribute to the output,
21259          * excluding from the result things outside the possible range */
21260
21261         /* For the unconditional inversion list, we have to add in all the
21262          * conditional code points, so that when inverted, they will be gone
21263          * from it */
21264         _invlist_union(only_utf8, invlist, &invlist);
21265         _invlist_union(not_utf8, invlist, &invlist);
21266         _invlist_union(only_utf8_locale, invlist, &invlist);
21267         _invlist_invert(invlist);
21268         _invlist_intersection(invlist, PL_InBitmap, &invlist);
21269
21270         if (only_utf8) {
21271             _invlist_invert(only_utf8);
21272             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
21273         }
21274         else if (not_utf8) {
21275
21276             /* If a code point matches iff the target string is not in UTF-8,
21277              * then complementing the result has it not match iff not in UTF-8,
21278              * which is the same thing as matching iff it is UTF-8. */
21279             only_utf8 = not_utf8;
21280             not_utf8 = NULL;
21281         }
21282
21283         if (only_utf8_locale) {
21284             _invlist_invert(only_utf8_locale);
21285             _invlist_intersection(only_utf8_locale,
21286                                   PL_InBitmap,
21287                                   &only_utf8_locale);
21288         }
21289
21290         inverted_display = put_charclass_bitmap_innards_common(
21291                                             invlist,
21292                                             posixes,
21293                                             only_utf8,
21294                                             not_utf8,
21295                                             only_utf8_locale, invert);
21296
21297         /* Use the shortest representation, taking into account our bias
21298          * against showing it inverted */
21299         if (   inverted_display
21300             && (   ! as_is_display
21301                 || (  SvCUR(inverted_display) + inverted_bias
21302                     < SvCUR(as_is_display)    + as_is_bias)))
21303         {
21304             sv_catsv(sv, inverted_display);
21305         }
21306         else if (as_is_display) {
21307             sv_catsv(sv, as_is_display);
21308         }
21309
21310         SvREFCNT_dec(as_is_display);
21311         SvREFCNT_dec(inverted_display);
21312     }
21313
21314     SvREFCNT_dec_NN(invlist);
21315     SvREFCNT_dec(only_utf8);
21316     SvREFCNT_dec(not_utf8);
21317     SvREFCNT_dec(posixes);
21318     SvREFCNT_dec(only_utf8_locale);
21319
21320     return SvCUR(sv) > orig_sv_cur;
21321 }
21322
21323 #define CLEAR_OPTSTART                                                       \
21324     if (optstart) STMT_START {                                               \
21325         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
21326                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
21327         optstart=NULL;                                                       \
21328     } STMT_END
21329
21330 #define DUMPUNTIL(b,e)                                                       \
21331                     CLEAR_OPTSTART;                                          \
21332                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
21333
21334 STATIC const regnode *
21335 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
21336             const regnode *last, const regnode *plast,
21337             SV* sv, I32 indent, U32 depth)
21338 {
21339     U8 op = PSEUDO;     /* Arbitrary non-END op. */
21340     const regnode *next;
21341     const regnode *optstart= NULL;
21342
21343     RXi_GET_DECL(r,ri);
21344     GET_RE_DEBUG_FLAGS_DECL;
21345
21346     PERL_ARGS_ASSERT_DUMPUNTIL;
21347
21348 #ifdef DEBUG_DUMPUNTIL
21349     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n",indent,node-start,
21350         last ? last-start : 0,plast ? plast-start : 0);
21351 #endif
21352
21353     if (plast && plast < last)
21354         last= plast;
21355
21356     while (PL_regkind[op] != END && (!last || node < last)) {
21357         assert(node);
21358         /* While that wasn't END last time... */
21359         NODE_ALIGN(node);
21360         op = OP(node);
21361         if (op == CLOSE || op == SRCLOSE || op == WHILEM)
21362             indent--;
21363         next = regnext((regnode *)node);
21364
21365         /* Where, what. */
21366         if (OP(node) == OPTIMIZED) {
21367             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
21368                 optstart = node;
21369             else
21370                 goto after_print;
21371         } else
21372             CLEAR_OPTSTART;
21373
21374         regprop(r, sv, node, NULL, NULL);
21375         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
21376                       (int)(2*indent + 1), "", SvPVX_const(sv));
21377
21378         if (OP(node) != OPTIMIZED) {
21379             if (next == NULL)           /* Next ptr. */
21380                 Perl_re_printf( aTHX_  " (0)");
21381             else if (PL_regkind[(U8)op] == BRANCH
21382                      && PL_regkind[OP(next)] != BRANCH )
21383                 Perl_re_printf( aTHX_  " (FAIL)");
21384             else
21385                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
21386             Perl_re_printf( aTHX_ "\n");
21387         }
21388
21389       after_print:
21390         if (PL_regkind[(U8)op] == BRANCHJ) {
21391             assert(next);
21392             {
21393                 const regnode *nnode = (OP(next) == LONGJMP
21394                                        ? regnext((regnode *)next)
21395                                        : next);
21396                 if (last && nnode > last)
21397                     nnode = last;
21398                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
21399             }
21400         }
21401         else if (PL_regkind[(U8)op] == BRANCH) {
21402             assert(next);
21403             DUMPUNTIL(NEXTOPER(node), next);
21404         }
21405         else if ( PL_regkind[(U8)op]  == TRIE ) {
21406             const regnode *this_trie = node;
21407             const char op = OP(node);
21408             const U32 n = ARG(node);
21409             const reg_ac_data * const ac = op>=AHOCORASICK ?
21410                (reg_ac_data *)ri->data->data[n] :
21411                NULL;
21412             const reg_trie_data * const trie =
21413                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
21414 #ifdef DEBUGGING
21415             AV *const trie_words
21416                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
21417 #endif
21418             const regnode *nextbranch= NULL;
21419             I32 word_idx;
21420             SvPVCLEAR(sv);
21421             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
21422                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
21423
21424                 Perl_re_indentf( aTHX_  "%s ",
21425                     indent+3,
21426                     elem_ptr
21427                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
21428                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
21429                                 PL_colors[0], PL_colors[1],
21430                                 (SvUTF8(*elem_ptr)
21431                                  ? PERL_PV_ESCAPE_UNI
21432                                  : 0)
21433                                 | PERL_PV_PRETTY_ELLIPSES
21434                                 | PERL_PV_PRETTY_LTGT
21435                             )
21436                     : "???"
21437                 );
21438                 if (trie->jump) {
21439                     U16 dist= trie->jump[word_idx+1];
21440                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
21441                                (UV)((dist ? this_trie + dist : next) - start));
21442                     if (dist) {
21443                         if (!nextbranch)
21444                             nextbranch= this_trie + trie->jump[0];
21445                         DUMPUNTIL(this_trie + dist, nextbranch);
21446                     }
21447                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
21448                         nextbranch= regnext((regnode *)nextbranch);
21449                 } else {
21450                     Perl_re_printf( aTHX_  "\n");
21451                 }
21452             }
21453             if (last && next > last)
21454                 node= last;
21455             else
21456                 node= next;
21457         }
21458         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
21459             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
21460                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
21461         }
21462         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
21463             assert(next);
21464             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
21465         }
21466         else if ( op == PLUS || op == STAR) {
21467             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
21468         }
21469         else if (PL_regkind[(U8)op] == ANYOF) {
21470             /* arglen 1 + class block */
21471             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
21472                           ? ANYOF_POSIXL_SKIP
21473                           : ANYOF_SKIP);
21474             node = NEXTOPER(node);
21475         }
21476         else if (PL_regkind[(U8)op] == EXACT) {
21477             /* Literal string, where present. */
21478             node += NODE_SZ_STR(node) - 1;
21479             node = NEXTOPER(node);
21480         }
21481         else {
21482             node = NEXTOPER(node);
21483             node += regarglen[(U8)op];
21484         }
21485         if (op == CURLYX || op == OPEN || op == SROPEN)
21486             indent++;
21487     }
21488     CLEAR_OPTSTART;
21489 #ifdef DEBUG_DUMPUNTIL
21490     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
21491 #endif
21492     return node;
21493 }
21494
21495 #endif  /* DEBUGGING */
21496
21497 #ifndef PERL_IN_XSUB_RE
21498
21499 #include "uni_keywords.h"
21500
21501 void
21502 Perl_init_uniprops(pTHX)
21503 {
21504     /* Set up the inversion list global variables */
21505
21506     PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
21507     PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALNUM]);
21508     PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALPHA]);
21509     PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXBLANK]);
21510     PL_XPosix_ptrs[_CC_CASED] =  _new_invlist_C_array(uni_prop_ptrs[UNI_CASED]);
21511     PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXCNTRL]);
21512     PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXDIGIT]);
21513     PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXGRAPH]);
21514     PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXLOWER]);
21515     PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPRINT]);
21516     PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPUNCT]);
21517     PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXSPACE]);
21518     PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXUPPER]);
21519     PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_VERTSPACE]);
21520     PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXWORD]);
21521     PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXXDIGIT]);
21522
21523     PL_Posix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
21524     PL_Posix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALNUM]);
21525     PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALPHA]);
21526     PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXBLANK]);
21527     PL_Posix_ptrs[_CC_CASED] =  _new_invlist_C_array(uni_prop_ptrs[UNI_CASED]);
21528     PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXCNTRL]);
21529     PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXDIGIT]);
21530     PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXGRAPH]);
21531     PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXLOWER]);
21532     PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPRINT]);
21533     PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPUNCT]);
21534     PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXSPACE]);
21535     PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXUPPER]);
21536     PL_Posix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_VERTSPACE]);
21537     PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXWORD]);
21538     PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXXDIGIT]);
21539
21540     PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
21541     PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
21542     PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
21543     PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
21544     PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
21545
21546     PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
21547     PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
21548     PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
21549
21550     PL_Assigned_invlist = _new_invlist_C_array(uni_prop_ptrs[UNI_ASSIGNED]);
21551
21552     PL_utf8_perl_idstart = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDSTART]);
21553     PL_utf8_perl_idcont = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDCONT]);
21554
21555     PL_utf8_charname_begin = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_BEGIN]);
21556     PL_utf8_charname_continue = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_CONTINUE]);
21557
21558     PL_utf8_foldable = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_ANY_FOLDS]);
21559     PL_HasMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
21560                                             UNI__PERL_FOLDS_TO_MULTI_CHAR]);
21561     PL_NonL1NonFinalFold = _new_invlist_C_array(
21562                                             NonL1_Perl_Non_Final_Folds_invlist);
21563
21564     PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
21565     PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
21566     PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
21567     PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
21568     PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
21569     PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
21570     PL_utf8_mark = _new_invlist_C_array(uni_prop_ptrs[UNI_M]);
21571
21572     /* The below are used only by deprecated functions.  They could be removed */
21573     PL_utf8_xidcont  = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDC]);
21574     PL_utf8_idcont   = _new_invlist_C_array(uni_prop_ptrs[UNI_IDC]);
21575     PL_utf8_xidstart = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDS]);
21576 }
21577
21578 SV *
21579 Perl_parse_uniprop_string(pTHX_ const char * const name, const Size_t name_len,
21580                                 const bool to_fold, bool * invert)
21581 {
21582     /* Parse the interior meat of \p{} passed to this in 'name' with length
21583      * 'name_len', and return an inversion list if a property with 'name' is
21584      * found, or NULL if not.  'name' point to the input with leading and
21585      * trailing space trimmed.  'to_fold' indicates if /i is in effect.
21586      *
21587      * When the return is an inversion list, '*invert' will be set to a boolean
21588      * indicating if it should be inverted or not
21589      *
21590      * This currently doesn't handle all cases.  A NULL return indicates the
21591      * caller should try a different approach
21592      */
21593
21594     char* lookup_name;
21595     bool stricter = FALSE;
21596     bool is_nv_type = FALSE;         /* nv= or numeric_value=, or possibly one
21597                                         of the cjk numeric properties (though
21598                                         it requires extra effort to compile
21599                                         them) */
21600     unsigned int i;
21601     unsigned int j = 0, lookup_len;
21602     int equals_pos = -1;        /* Where the '=' is found, or negative if none */
21603     int slash_pos = -1;        /* Where the '/' is found, or negative if none */
21604     int table_index = 0;
21605     bool starts_with_In_or_Is = FALSE;
21606     Size_t lookup_offset = 0;
21607
21608     PERL_ARGS_ASSERT_PARSE_UNIPROP_STRING;
21609
21610     /* The input will be modified into 'lookup_name' */
21611     Newx(lookup_name, name_len, char);
21612     SAVEFREEPV(lookup_name);
21613
21614     /* Parse the input. */
21615     for (i = 0; i < name_len; i++) {
21616         char cur = name[i];
21617
21618         /* These characters can be freely ignored in most situations.  Later it
21619          * may turn out we shouldn't have ignored them, and we have to reparse,
21620          * but we don't have enough information yet to make that decision */
21621         if (cur == '-' || cur == '_' || isSPACE_A(cur)) {
21622             continue;
21623         }
21624
21625         /* Case differences are also ignored.  Our lookup routine assumes
21626          * everything is lowercase */
21627         if (isUPPER_A(cur)) {
21628             lookup_name[j++] = toLOWER(cur);
21629             continue;
21630         }
21631
21632         /* A double colon is either an error, or a package qualifier to a
21633          * subroutine user-defined property; neither of which do we currently
21634          * handle
21635          *
21636          * But a single colon is a synonym for '=' */
21637         if (cur == ':') {
21638             if (i < name_len - 1 && name[i+1] == ':') {
21639                 return NULL;
21640             }
21641             cur = '=';
21642         }
21643
21644         /* Otherwise, this character is part of the name. */
21645         lookup_name[j++] = cur;
21646
21647         /* Only the equals sign needs further processing */
21648         if (cur == '=') {
21649             equals_pos = j; /* Note where it occurred in the input */
21650             break;
21651         }
21652     }
21653
21654     /* Here, we are either done with the whole property name, if it was simple;
21655      * or are positioned just after the '=' if it is compound. */
21656
21657     if (equals_pos >= 0) {
21658         assert(! stricter); /* We shouldn't have set this yet */
21659
21660         /* Space immediately after the '=' is ignored */
21661         i++;
21662         for (; i < name_len; i++) {
21663             if (! isSPACE_A(name[i])) {
21664                 break;
21665             }
21666         }
21667
21668         /* Certain properties need special handling.  They may optionally be
21669          * prefixed by 'is'.  Ignore that prefix for the purposes of checking
21670          * if this is one of those properties */
21671         if (memBEGINPs(lookup_name, name_len, "is")) {
21672             lookup_offset = 2;
21673         }
21674
21675         /* Then check if it is one of these properties.  This is hard-coded
21676          * because easier this way, and the list is unlikely to change.  There
21677          * are several properties like this in the Unihan DB, which is unlikely
21678          * to be compiled, and they all end with 'numeric'.  The interiors
21679          * aren't checked for the precise property.  This would stop working if
21680          * a cjk property were to be created that ended with 'numeric' and
21681          * wasn't a numeric type */
21682         is_nv_type = memEQs(lookup_name + lookup_offset,
21683                        j - 1 - lookup_offset, "numericvalue")
21684                   || memEQs(lookup_name + lookup_offset,
21685                       j - 1 - lookup_offset, "nv")
21686                   || (   memENDPs(lookup_name + lookup_offset,
21687                             j - 1 - lookup_offset, "numeric")
21688                       && (   memBEGINPs(lookup_name + lookup_offset,
21689                                       j - 1 - lookup_offset, "cjk")
21690                           || memBEGINPs(lookup_name + lookup_offset,
21691                                       j - 1 - lookup_offset, "k")));
21692         if (   is_nv_type
21693             || memEQs(lookup_name + lookup_offset,
21694                       j - 1 - lookup_offset, "canonicalcombiningclass")
21695             || memEQs(lookup_name + lookup_offset,
21696                       j - 1 - lookup_offset, "ccc")
21697             || memEQs(lookup_name + lookup_offset,
21698                       j - 1 - lookup_offset, "age")
21699             || memEQs(lookup_name + lookup_offset,
21700                       j - 1 - lookup_offset, "in")
21701             || memEQs(lookup_name + lookup_offset,
21702                       j - 1 - lookup_offset, "presentin"))
21703         {
21704             unsigned int k;
21705
21706             /* What makes these properties special is that the stuff after the
21707              * '=' is a number.  Therefore, we can't throw away '-'
21708              * willy-nilly, as those could be a minus sign.  Other stricter
21709              * rules also apply.  However, these properties all can have the
21710              * rhs not be a number, in which case they contain at least one
21711              * alphabetic.  In those cases, the stricter rules don't apply.
21712              * But the numeric type properties can have the alphas [Ee] to
21713              * signify an exponent, and it is still a number with stricter
21714              * rules.  So look for an alpha that signifys not-strict */
21715             stricter = TRUE;
21716             for (k = i; k < name_len; k++) {
21717                 if (   isALPHA_A(name[k])
21718                     && (! is_nv_type || ! isALPHA_FOLD_EQ(name[k], 'E')))
21719                 {
21720                     stricter = FALSE;
21721                     break;
21722                 }
21723             }
21724         }
21725
21726         if (stricter) {
21727
21728             /* A number may have a leading '+' or '-'.  The latter is retained
21729              * */
21730             if (name[i] == '+') {
21731                 i++;
21732             }
21733             else if (name[i] == '-') {
21734                 lookup_name[j++] = '-';
21735                 i++;
21736             }
21737
21738             /* Skip leading zeros including single underscores separating the
21739              * zeros, or between the final leading zero and the first other
21740              * digit */
21741             for (; i < name_len - 1; i++) {
21742                 if (   name[i] != '0'
21743                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
21744                 {
21745                     break;
21746                 }
21747             }
21748         }
21749     }
21750     else {  /* No '=' */
21751
21752        /* We are now in a position to determine if this property should have
21753         * been parsed using stricter rules.  Only a few are like that, and
21754         * unlikely to change. */
21755         if (   memBEGINPs(lookup_name, j, "perl")
21756             && memNEs(lookup_name + 4, j - 4, "space")
21757             && memNEs(lookup_name + 4, j - 4, "word"))
21758         {
21759             stricter = TRUE;
21760
21761             /* We set the inputs back to 0 and the code below will reparse,
21762              * using strict */
21763             i = j = 0;
21764         }
21765     }
21766
21767     /* Here, we have either finished the property, or are positioned to parse
21768      * the remainder, and we know if stricter rules apply.  Finish out, if not
21769      * already done */
21770     for (; i < name_len; i++) {
21771         char cur = name[i];
21772
21773         /* In all instances, case differences are ignored, and we normalize to
21774          * lowercase */
21775         if (isUPPER_A(cur)) {
21776             lookup_name[j++] = toLOWER(cur);
21777             continue;
21778         }
21779
21780         /* An underscore is skipped, but not under strict rules unless it
21781          * separates two digits */
21782         if (cur == '_') {
21783             if (    stricter
21784                 && (     i == 0 || (int) i == equals_pos || i == name_len- 1
21785                     || ! isDIGIT_A(name[i-1]) || ! isDIGIT_A(name[i+1])))
21786             {
21787                 lookup_name[j++] = '_';
21788             }
21789             continue;
21790         }
21791
21792         /* Hyphens are skipped except under strict */
21793         if (cur == '-' && ! stricter) {
21794             continue;
21795         }
21796
21797         /* XXX Bug in documentation.  It says white space skipped adjacent to
21798          * non-word char.  Maybe we should, but shouldn't skip it next to a dot
21799          * in a number */
21800         if (isSPACE_A(cur) && ! stricter) {
21801             continue;
21802         }
21803
21804         lookup_name[j++] = cur;
21805
21806         /* Unless this is a non-trailing slash, we are done with it */
21807         if (i >= name_len - 1 || cur != '/') {
21808             continue;
21809         }
21810
21811         slash_pos = j;
21812
21813         /* A slash in the 'numeric value' property indicates that what follows
21814          * is a denominator.  It can have a leading '+' and '0's that should be
21815          * skipped.  But we have never allowed a negative denominator, so treat
21816          * a minus like every other character.  (No need to rule out a second
21817          * '/', as that won't match anything anyway */
21818         if (is_nv_type) {
21819             i++;
21820             if (i < name_len && name[i] == '+') {
21821                 i++;
21822             }
21823
21824             /* Skip leading zeros including underscores separating digits */
21825             for (; i < name_len - 1; i++) {
21826                 if (   name[i] != '0'
21827                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
21828                 {
21829                     break;
21830                 }
21831             }
21832
21833             /* Store the first real character in the denominator */
21834             lookup_name[j++] = name[i];
21835         }
21836     }
21837
21838     /* Here are completely done parsing the input 'name', and 'lookup_name'
21839      * contains a copy, normalized.
21840      *
21841      * This special case is grandfathered in: 'L_' and 'GC=L_' are accepted and
21842      * different from without the underscores.  */
21843     if (  (   UNLIKELY(memEQs(lookup_name, j, "l"))
21844            || UNLIKELY(memEQs(lookup_name, j, "gc=l")))
21845         && UNLIKELY(name[name_len-1] == '_'))
21846     {
21847         lookup_name[j++] = '&';
21848     }
21849     else if (name_len > 2 && name[0] == 'I' && (   name[1] == 'n'
21850                                                 || name[1] == 's'))
21851     {
21852
21853         /* Also, if the original input began with 'In' or 'Is', it could be a
21854          * subroutine call instead of a property names, which currently isn't
21855          * handled by this function.  Subroutine calls can't happen if there is
21856          * an '=' in the name */
21857         if (equals_pos < 0 && get_cvn_flags(name, name_len, GV_NOTQUAL) != NULL)
21858         {
21859             return NULL;
21860         }
21861
21862         starts_with_In_or_Is = TRUE;
21863     }
21864
21865     lookup_len = j;     /* Use a more mnemonic name starting here */
21866
21867     /* Get the index into our pointer table of the inversion list corresponding
21868      * to the property */
21869     table_index = match_uniprop((U8 *) lookup_name, lookup_len);
21870
21871     /* If it didn't find the property */
21872     if (table_index == 0) {
21873
21874         /* If didn't find the property, we try again stripping off any initial
21875          * 'In' or 'Is' */
21876         if (starts_with_In_or_Is) {
21877             lookup_name += 2;
21878             lookup_len -= 2;
21879             equals_pos -= 2;
21880             slash_pos -= 2;
21881
21882             table_index = match_uniprop((U8 *) lookup_name, lookup_len);
21883         }
21884
21885         if (table_index == 0) {
21886             char * canonical;
21887
21888             /* If not found, and not a numeric type property, isn't a legal
21889              * property */
21890             if (! is_nv_type) {
21891                 return NULL;
21892             }
21893
21894             /* But the numeric type properties need more work to decide.  What
21895              * we do is make sure we have the number in canonical form and look
21896              * that up. */
21897
21898             if (slash_pos < 0) {    /* No slash */
21899
21900                 /* When it isn't a rational, take the input, convert it to a
21901                  * NV, then create a canonical string representation of that
21902                  * NV. */
21903
21904                 NV value;
21905
21906                 /* Get the value */
21907                 if (my_atof3(lookup_name + equals_pos, &value,
21908                              lookup_len - equals_pos)
21909                           != lookup_name + lookup_len)
21910                 {
21911                     return NULL;
21912                 }
21913
21914                 /* If the value is an integer, the canonical value is integral */
21915                 if (Perl_ceil(value) == value) {
21916                     canonical = Perl_form(aTHX_ "%.*s%.0" NVff,
21917                                                 equals_pos, lookup_name, value);
21918                 }
21919                 else {  /* Otherwise, it is %e with a known precision */
21920                     char * exp_ptr;
21921
21922                     canonical = Perl_form(aTHX_ "%.*s%.*" NVef,
21923                                                 equals_pos, lookup_name,
21924                                                 PL_E_FORMAT_PRECISION, value);
21925
21926                     /* The exponent generated is expecting two digits, whereas
21927                      * %e on some systems will generate three.  Remove leading
21928                      * zeros in excess of 2 from the exponent.  We start
21929                      * looking for them after the '=' */
21930                     exp_ptr = strchr(canonical + equals_pos, 'e');
21931                     if (exp_ptr) {
21932                         char * cur_ptr = exp_ptr + 2; /* past the 'e[+-]' */
21933                         SSize_t excess_exponent_len = strlen(cur_ptr) - 2;
21934
21935                         assert(*(cur_ptr - 1) == '-' || *(cur_ptr - 1) == '+');
21936
21937                         if (excess_exponent_len > 0) {
21938                             SSize_t leading_zeros = strspn(cur_ptr, "0");
21939                             SSize_t excess_leading_zeros
21940                                     = MIN(leading_zeros, excess_exponent_len);
21941                             if (excess_leading_zeros > 0) {
21942                                 Move(cur_ptr + excess_leading_zeros,
21943                                      cur_ptr,
21944                                      strlen(cur_ptr) - excess_leading_zeros
21945                                        + 1,  /* Copy the NUL as well */
21946                                      char);
21947                             }
21948                         }
21949                     }
21950                 }
21951             }
21952             else {  /* Has a slash.  Create a rational in canonical form  */
21953                 UV numerator, denominator, gcd, trial;
21954                 const char * end_ptr;
21955                 const char * sign = "";
21956
21957                 /* We can't just find the numerator, denominator, and do the
21958                  * division, then use the method above, because that is
21959                  * inexact.  And the input could be a rational that is within
21960                  * epsilon (given our precision) of a valid rational, and would
21961                  * then incorrectly compare valid.
21962                  *
21963                  * We're only interested in the part after the '=' */
21964                 const char * this_lookup_name = lookup_name + equals_pos;
21965                 lookup_len -= equals_pos;
21966                 slash_pos -= equals_pos;
21967
21968                 /* Handle any leading minus */
21969                 if (this_lookup_name[0] == '-') {
21970                     sign = "-";
21971                     this_lookup_name++;
21972                     lookup_len--;
21973                     slash_pos--;
21974                 }
21975
21976                 /* Convert the numerator to numeric */
21977                 end_ptr = this_lookup_name + slash_pos;
21978                 if (! grok_atoUV(this_lookup_name, &numerator, &end_ptr)) {
21979                     return NULL;
21980                 }
21981
21982                 /* It better have included all characters before the slash */
21983                 if (*end_ptr != '/') {
21984                     return NULL;
21985                 }
21986
21987                 /* Set to look at just the denominator */
21988                 this_lookup_name += slash_pos;
21989                 lookup_len -= slash_pos;
21990                 end_ptr = this_lookup_name + lookup_len;
21991
21992                 /* Convert the denominator to numeric */
21993                 if (! grok_atoUV(this_lookup_name, &denominator, &end_ptr)) {
21994                     return NULL;
21995                 }
21996
21997                 /* It better be the rest of the characters, and don't divide by
21998                  * 0 */
21999                 if (   end_ptr != this_lookup_name + lookup_len
22000                     || denominator == 0)
22001                 {
22002                     return NULL;
22003                 }
22004
22005                 /* Get the greatest common denominator using
22006                    http://en.wikipedia.org/wiki/Euclidean_algorithm */
22007                 gcd = numerator;
22008                 trial = denominator;
22009                 while (trial != 0) {
22010                     UV temp = trial;
22011                     trial = gcd % trial;
22012                     gcd = temp;
22013                 }
22014
22015                 /* If already in lowest possible terms, we have already tried
22016                  * looking this up */
22017                 if (gcd == 1) {
22018                     return NULL;
22019                 }
22020
22021                 /* Reduce the rational, which should put it in canonical form.
22022                  * Then look it up */
22023                 numerator /= gcd;
22024                 denominator /= gcd;
22025
22026                 canonical = Perl_form(aTHX_ "%.*s%s%" UVuf "/%" UVuf,
22027                         equals_pos, lookup_name, sign, numerator, denominator);
22028             }
22029
22030             /* Here, we have the number in canonical form.  Try that */
22031             table_index = match_uniprop((U8 *) canonical, strlen(canonical));
22032             if (table_index == 0) {
22033                 return NULL;
22034             }
22035         }
22036     }
22037
22038     /* The return is an index into a table of ptrs.  A negative return
22039      * signifies that the real index is the absolute value, but the result
22040      * needs to be inverted */
22041     if (table_index < 0) {
22042         *invert = TRUE;
22043         table_index = -table_index;
22044     }
22045     else {
22046         *invert = FALSE;
22047     }
22048
22049     /* Out-of band indices indicate a deprecated property.  The proper index is
22050      * modulo it with the table size.  And dividing by the table size yields
22051      * an offset into a table constructed to contain the corresponding warning
22052      * message */
22053     if (table_index > MAX_UNI_KEYWORD_INDEX) {
22054         Size_t warning_offset = table_index / MAX_UNI_KEYWORD_INDEX;
22055         table_index %= MAX_UNI_KEYWORD_INDEX;
22056         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
22057                 "Use of '%.*s' in \\p{} or \\P{} is deprecated because: %s",
22058                 (int) name_len, name, deprecated_property_msgs[warning_offset]);
22059     }
22060
22061     /* In a few properties, a different property is used under /i.  These are
22062      * unlikely to change, so are hard-coded here. */
22063     if (to_fold) {
22064         if (   table_index == UNI_XPOSIXUPPER
22065             || table_index == UNI_XPOSIXLOWER
22066             || table_index == UNI_TITLE)
22067         {
22068             table_index = UNI_CASED;
22069         }
22070         else if (   table_index == UNI_UPPERCASELETTER
22071                  || table_index == UNI_LOWERCASELETTER
22072 #  ifdef UNI_TITLECASELETTER   /* Missing from early Unicodes */
22073                  || table_index == UNI_TITLECASELETTER
22074 #  endif
22075         ) {
22076             table_index = UNI_CASEDLETTER;
22077         }
22078         else if (  table_index == UNI_POSIXUPPER
22079                 || table_index == UNI_POSIXLOWER)
22080         {
22081             table_index = UNI_POSIXALPHA;
22082         }
22083     }
22084
22085     /* Create and return the inversion list */
22086     return _new_invlist_C_array(uni_prop_ptrs[table_index]);
22087 }
22088
22089 #endif
22090
22091 /*
22092  * ex: set ts=8 sts=4 sw=4 et:
22093  */