This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mailling list archaeology, restoring old content
[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 #define REG_COMP_C
78 #ifdef PERL_IN_XSUB_RE
79 #  include "re_comp.h"
80 EXTERN_C const struct regexp_engine my_reg_engine;
81 #else
82 #  include "regcomp.h"
83 #endif
84
85 #include "dquote_inline.h"
86 #include "invlist_inline.h"
87 #include "unicode_constants.h"
88
89 #define HAS_NONLATIN1_FOLD_CLOSURE(i) \
90  _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
91 #define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
92  _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
93 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
94 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
95
96 #ifndef STATIC
97 #define STATIC  static
98 #endif
99
100 /* this is a chain of data about sub patterns we are processing that
101    need to be handled separately/specially in study_chunk. Its so
102    we can simulate recursion without losing state.  */
103 struct scan_frame;
104 typedef struct scan_frame {
105     regnode *last_regnode;      /* last node to process in this frame */
106     regnode *next_regnode;      /* next node to process when last is reached */
107     U32 prev_recursed_depth;
108     I32 stopparen;              /* what stopparen do we use */
109
110     struct scan_frame *this_prev_frame; /* this previous frame */
111     struct scan_frame *prev_frame;      /* previous frame */
112     struct scan_frame *next_frame;      /* next frame */
113 } scan_frame;
114
115 /* Certain characters are output as a sequence with the first being a
116  * backslash. */
117 #define isBACKSLASHED_PUNCT(c)  strchr("-[]\\^", c)
118
119
120 struct RExC_state_t {
121     U32         flags;                  /* RXf_* are we folding, multilining? */
122     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
123     char        *precomp;               /* uncompiled string. */
124     char        *precomp_end;           /* pointer to end of uncompiled string. */
125     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
126     regexp      *rx;                    /* perl core regexp structure */
127     regexp_internal     *rxi;           /* internal data for regexp object
128                                            pprivate field */
129     char        *start;                 /* Start of input for compile */
130     char        *end;                   /* End of input for compile */
131     char        *parse;                 /* Input-scan pointer. */
132     char        *copy_start;            /* start of copy of input within
133                                            constructed parse string */
134     char        *save_copy_start;       /* Provides one level of saving
135                                            and restoring 'copy_start' */
136     char        *copy_start_in_input;   /* Position in input string
137                                            corresponding to copy_start */
138     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
139     regnode     *emit_start;            /* Start of emitted-code area */
140     regnode_offset emit;                /* Code-emit pointer */
141     I32         naughty;                /* How bad is this pattern? */
142     I32         sawback;                /* Did we see \1, ...? */
143     U32         seen;
144     SSize_t     size;                   /* Number of regnode equivalents in
145                                            pattern */
146
147     /* position beyond 'precomp' of the warning message furthest away from
148      * 'precomp'.  During the parse, no warnings are raised for any problems
149      * earlier in the parse than this position.  This works if warnings are
150      * raised the first time a given spot is parsed, and if only one
151      * independent warning is raised for any given spot */
152     Size_t      latest_warn_offset;
153
154     I32         npar;                   /* Capture buffer count so far in the
155                                            parse, (OPEN) plus one. ("par" 0 is
156                                            the whole pattern)*/
157     I32         total_par;              /* During initial parse, is either 0,
158                                            or -1; the latter indicating a
159                                            reparse is needed.  After that pass,
160                                            it is what 'npar' became after the
161                                            pass.  Hence, it being > 0 indicates
162                                            we are in a reparse situation */
163     I32         nestroot;               /* root parens we are in - used by
164                                            accept */
165     I32         seen_zerolen;
166     regnode_offset *open_parens;        /* offsets to open parens */
167     regnode_offset *close_parens;       /* offsets to close parens */
168     I32      parens_buf_size;           /* #slots malloced open/close_parens */
169     regnode     *end_op;                /* END node in program */
170     I32         utf8;           /* whether the pattern is utf8 or not */
171     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
172                                 /* XXX use this for future optimisation of case
173                                  * where pattern must be upgraded to utf8. */
174     I32         uni_semantics;  /* If a d charset modifier should use unicode
175                                    rules, even if the pattern is not in
176                                    utf8 */
177     HV          *paren_names;           /* Paren names */
178
179     regnode     **recurse;              /* Recurse regops */
180     I32         recurse_count;          /* Number of recurse regops we have generated */
181     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
182                                            through */
183     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
184     I32         in_lookbehind;
185     I32         in_lookahead;
186     I32         contains_locale;
187     I32         override_recoding;
188     I32         recode_x_to_native;
189     I32         in_multi_char_class;
190     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
191                                             within pattern */
192     int         code_index;             /* next code_blocks[] slot */
193     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
194     scan_frame *frame_head;
195     scan_frame *frame_last;
196     U32         frame_count;
197     AV         *warn_text;
198     HV         *unlexed_names;
199 #ifdef ADD_TO_REGEXEC
200     char        *starttry;              /* -Dr: where regtry was called. */
201 #define RExC_starttry   (pRExC_state->starttry)
202 #endif
203     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
204 #ifdef DEBUGGING
205     const char  *lastparse;
206     I32         lastnum;
207     AV          *paren_name_list;       /* idx -> name */
208     U32         study_chunk_recursed_count;
209     SV          *mysv1;
210     SV          *mysv2;
211
212 #define RExC_lastparse  (pRExC_state->lastparse)
213 #define RExC_lastnum    (pRExC_state->lastnum)
214 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
215 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
216 #define RExC_mysv       (pRExC_state->mysv1)
217 #define RExC_mysv1      (pRExC_state->mysv1)
218 #define RExC_mysv2      (pRExC_state->mysv2)
219
220 #endif
221     bool        seen_d_op;
222     bool        strict;
223     bool        study_started;
224     bool        in_script_run;
225     bool        use_BRANCHJ;
226 };
227
228 #define RExC_flags      (pRExC_state->flags)
229 #define RExC_pm_flags   (pRExC_state->pm_flags)
230 #define RExC_precomp    (pRExC_state->precomp)
231 #define RExC_copy_start_in_input (pRExC_state->copy_start_in_input)
232 #define RExC_copy_start_in_constructed  (pRExC_state->copy_start)
233 #define RExC_save_copy_start_in_constructed  (pRExC_state->save_copy_start)
234 #define RExC_precomp_end (pRExC_state->precomp_end)
235 #define RExC_rx_sv      (pRExC_state->rx_sv)
236 #define RExC_rx         (pRExC_state->rx)
237 #define RExC_rxi        (pRExC_state->rxi)
238 #define RExC_start      (pRExC_state->start)
239 #define RExC_end        (pRExC_state->end)
240 #define RExC_parse      (pRExC_state->parse)
241 #define RExC_latest_warn_offset (pRExC_state->latest_warn_offset )
242 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
243 #define RExC_seen_d_op (pRExC_state->seen_d_op) /* Seen something that differs
244                                                    under /d from /u ? */
245
246 #ifdef RE_TRACK_PATTERN_OFFSETS
247 #  define RExC_offsets  (RExC_rxi->u.offsets) /* I am not like the
248                                                          others */
249 #endif
250 #define RExC_emit       (pRExC_state->emit)
251 #define RExC_emit_start (pRExC_state->emit_start)
252 #define RExC_sawback    (pRExC_state->sawback)
253 #define RExC_seen       (pRExC_state->seen)
254 #define RExC_size       (pRExC_state->size)
255 #define RExC_maxlen        (pRExC_state->maxlen)
256 #define RExC_npar       (pRExC_state->npar)
257 #define RExC_total_parens       (pRExC_state->total_par)
258 #define RExC_parens_buf_size    (pRExC_state->parens_buf_size)
259 #define RExC_nestroot   (pRExC_state->nestroot)
260 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
261 #define RExC_utf8       (pRExC_state->utf8)
262 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
263 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
264 #define RExC_open_parens        (pRExC_state->open_parens)
265 #define RExC_close_parens       (pRExC_state->close_parens)
266 #define RExC_end_op     (pRExC_state->end_op)
267 #define RExC_paren_names        (pRExC_state->paren_names)
268 #define RExC_recurse    (pRExC_state->recurse)
269 #define RExC_recurse_count      (pRExC_state->recurse_count)
270 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
271 #define RExC_study_chunk_recursed_bytes  \
272                                    (pRExC_state->study_chunk_recursed_bytes)
273 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
274 #define RExC_in_lookahead       (pRExC_state->in_lookahead)
275 #define RExC_contains_locale    (pRExC_state->contains_locale)
276 #define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
277
278 #ifdef EBCDIC
279 #  define SET_recode_x_to_native(x)                                         \
280                     STMT_START { RExC_recode_x_to_native = (x); } STMT_END
281 #else
282 #  define SET_recode_x_to_native(x) NOOP
283 #endif
284
285 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
286 #define RExC_frame_head (pRExC_state->frame_head)
287 #define RExC_frame_last (pRExC_state->frame_last)
288 #define RExC_frame_count (pRExC_state->frame_count)
289 #define RExC_strict (pRExC_state->strict)
290 #define RExC_study_started      (pRExC_state->study_started)
291 #define RExC_warn_text (pRExC_state->warn_text)
292 #define RExC_in_script_run      (pRExC_state->in_script_run)
293 #define RExC_use_BRANCHJ        (pRExC_state->use_BRANCHJ)
294 #define RExC_unlexed_names (pRExC_state->unlexed_names)
295
296 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
297  * a flag to disable back-off on the fixed/floating substrings - if it's
298  * a high complexity pattern we assume the benefit of avoiding a full match
299  * is worth the cost of checking for the substrings even if they rarely help.
300  */
301 #define RExC_naughty    (pRExC_state->naughty)
302 #define TOO_NAUGHTY (10)
303 #define MARK_NAUGHTY(add) \
304     if (RExC_naughty < TOO_NAUGHTY) \
305         RExC_naughty += (add)
306 #define MARK_NAUGHTY_EXP(exp, add) \
307     if (RExC_naughty < TOO_NAUGHTY) \
308         RExC_naughty += RExC_naughty / (exp) + (add)
309
310 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
311 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
312         ((*s) == '{' && regcurly(s)))
313
314 /*
315  * Flags to be passed up and down.
316  */
317 #define WORST           0       /* Worst case. */
318 #define HASWIDTH        0x01    /* Known to not match null strings, could match
319                                    non-null ones. */
320
321 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
322  * character.  (There needs to be a case: in the switch statement in regexec.c
323  * for any node marked SIMPLE.)  Note that this is not the same thing as
324  * REGNODE_SIMPLE */
325 #define SIMPLE          0x02
326 #define SPSTART         0x04    /* Starts with * or + */
327 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
328 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
329 #define RESTART_PARSE   0x20    /* Need to redo the parse */
330 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PARSE, need to
331                                    calcuate sizes as UTF-8 */
332
333 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
334
335 /* whether trie related optimizations are enabled */
336 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
337 #define TRIE_STUDY_OPT
338 #define FULL_TRIE_STUDY
339 #define TRIE_STCLASS
340 #endif
341
342
343
344 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
345 #define PBITVAL(paren) (1 << ((paren) & 7))
346 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
347 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
348 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
349
350 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
351                                      if (!UTF) {                           \
352                                          *flagp = RESTART_PARSE|NEED_UTF8; \
353                                          return 0;                         \
354                                      }                                     \
355                              } STMT_END
356
357 /* Change from /d into /u rules, and restart the parse.  RExC_uni_semantics is
358  * a flag that indicates we need to override /d with /u as a result of
359  * something in the pattern.  It should only be used in regards to calling
360  * set_regex_charset() or get_regex_charse() */
361 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
362     STMT_START {                                                            \
363             if (DEPENDS_SEMANTICS) {                                        \
364                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
365                 RExC_uni_semantics = 1;                                     \
366                 if (RExC_seen_d_op && LIKELY(! IN_PARENS_PASS)) {           \
367                     /* No need to restart the parse if we haven't seen      \
368                      * anything that differs between /u and /d, and no need \
369                      * to restart immediately if we're going to reparse     \
370                      * anyway to count parens */                            \
371                     *flagp |= RESTART_PARSE;                                \
372                     return restart_retval;                                  \
373                 }                                                           \
374             }                                                               \
375     } STMT_END
376
377 #define REQUIRE_BRANCHJ(flagp, restart_retval)                              \
378     STMT_START {                                                            \
379                 RExC_use_BRANCHJ = 1;                                       \
380                 *flagp |= RESTART_PARSE;                                    \
381                 return restart_retval;                                      \
382     } STMT_END
383
384 /* Until we have completed the parse, we leave RExC_total_parens at 0 or
385  * less.  After that, it must always be positive, because the whole re is
386  * considered to be surrounded by virtual parens.  Setting it to negative
387  * indicates there is some construct that needs to know the actual number of
388  * parens to be properly handled.  And that means an extra pass will be
389  * required after we've counted them all */
390 #define ALL_PARENS_COUNTED (RExC_total_parens > 0)
391 #define REQUIRE_PARENS_PASS                                                 \
392     STMT_START {  /* No-op if have completed a pass */                      \
393                     if (! ALL_PARENS_COUNTED) RExC_total_parens = -1;       \
394     } STMT_END
395 #define IN_PARENS_PASS (RExC_total_parens < 0)
396
397
398 /* This is used to return failure (zero) early from the calling function if
399  * various flags in 'flags' are set.  Two flags always cause a return:
400  * 'RESTART_PARSE' and 'NEED_UTF8'.   'extra' can be used to specify any
401  * additional flags that should cause a return; 0 if none.  If the return will
402  * be done, '*flagp' is first set to be all of the flags that caused the
403  * return. */
404 #define RETURN_FAIL_ON_RESTART_OR_FLAGS(flags,flagp,extra)                  \
405     STMT_START {                                                            \
406             if ((flags) & (RESTART_PARSE|NEED_UTF8|(extra))) {              \
407                 *(flagp) = (flags) & (RESTART_PARSE|NEED_UTF8|(extra));     \
408                 return 0;                                                   \
409             }                                                               \
410     } STMT_END
411
412 #define MUST_RESTART(flags) ((flags) & (RESTART_PARSE))
413
414 #define RETURN_FAIL_ON_RESTART(flags,flagp)                                 \
415                         RETURN_FAIL_ON_RESTART_OR_FLAGS( flags, flagp, 0)
416 #define RETURN_FAIL_ON_RESTART_FLAGP(flagp)                                 \
417                                     if (MUST_RESTART(*(flagp))) return 0
418
419 /* This converts the named class defined in regcomp.h to its equivalent class
420  * number defined in handy.h. */
421 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
422 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
423
424 #define _invlist_union_complement_2nd(a, b, output) \
425                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
426 #define _invlist_intersection_complement_2nd(a, b, output) \
427                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
428
429 /* About scan_data_t.
430
431   During optimisation we recurse through the regexp program performing
432   various inplace (keyhole style) optimisations. In addition study_chunk
433   and scan_commit populate this data structure with information about
434   what strings MUST appear in the pattern. We look for the longest
435   string that must appear at a fixed location, and we look for the
436   longest string that may appear at a floating location. So for instance
437   in the pattern:
438
439     /FOO[xX]A.*B[xX]BAR/
440
441   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
442   strings (because they follow a .* construct). study_chunk will identify
443   both FOO and BAR as being the longest fixed and floating strings respectively.
444
445   The strings can be composites, for instance
446
447      /(f)(o)(o)/
448
449   will result in a composite fixed substring 'foo'.
450
451   For each string some basic information is maintained:
452
453   - min_offset
454     This is the position the string must appear at, or not before.
455     It also implicitly (when combined with minlenp) tells us how many
456     characters must match before the string we are searching for.
457     Likewise when combined with minlenp and the length of the string it
458     tells us how many characters must appear after the string we have
459     found.
460
461   - max_offset
462     Only used for floating strings. This is the rightmost point that
463     the string can appear at. If set to SSize_t_MAX it indicates that the
464     string can occur infinitely far to the right.
465     For fixed strings, it is equal to min_offset.
466
467   - minlenp
468     A pointer to the minimum number of characters of the pattern that the
469     string was found inside. This is important as in the case of positive
470     lookahead or positive lookbehind we can have multiple patterns
471     involved. Consider
472
473     /(?=FOO).*F/
474
475     The minimum length of the pattern overall is 3, the minimum length
476     of the lookahead part is 3, but the minimum length of the part that
477     will actually match is 1. So 'FOO's minimum length is 3, but the
478     minimum length for the F is 1. This is important as the minimum length
479     is used to determine offsets in front of and behind the string being
480     looked for.  Since strings can be composites this is the length of the
481     pattern at the time it was committed with a scan_commit. Note that
482     the length is calculated by study_chunk, so that the minimum lengths
483     are not known until the full pattern has been compiled, thus the
484     pointer to the value.
485
486   - lookbehind
487
488     In the case of lookbehind the string being searched for can be
489     offset past the start point of the final matching string.
490     If this value was just blithely removed from the min_offset it would
491     invalidate some of the calculations for how many chars must match
492     before or after (as they are derived from min_offset and minlen and
493     the length of the string being searched for).
494     When the final pattern is compiled and the data is moved from the
495     scan_data_t structure into the regexp structure the information
496     about lookbehind is factored in, with the information that would
497     have been lost precalculated in the end_shift field for the
498     associated string.
499
500   The fields pos_min and pos_delta are used to store the minimum offset
501   and the delta to the maximum offset at the current point in the pattern.
502
503 */
504
505 struct scan_data_substrs {
506     SV      *str;       /* longest substring found in pattern */
507     SSize_t min_offset; /* earliest point in string it can appear */
508     SSize_t max_offset; /* latest point in string it can appear */
509     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
510     SSize_t lookbehind; /* is the pos of the string modified by LB */
511     I32 flags;          /* per substring SF_* and SCF_* flags */
512 };
513
514 typedef struct scan_data_t {
515     /*I32 len_min;      unused */
516     /*I32 len_delta;    unused */
517     SSize_t pos_min;
518     SSize_t pos_delta;
519     SV *last_found;
520     SSize_t last_end;       /* min value, <0 unless valid. */
521     SSize_t last_start_min;
522     SSize_t last_start_max;
523     U8      cur_is_floating; /* whether the last_* values should be set as
524                               * the next fixed (0) or floating (1)
525                               * substring */
526
527     /* [0] is longest fixed substring so far, [1] is longest float so far */
528     struct scan_data_substrs  substrs[2];
529
530     I32 flags;             /* common SF_* and SCF_* flags */
531     I32 whilem_c;
532     SSize_t *last_closep;
533     regnode_ssc *start_class;
534 } scan_data_t;
535
536 /*
537  * Forward declarations for pregcomp()'s friends.
538  */
539
540 static const scan_data_t zero_scan_data = {
541     0, 0, NULL, 0, 0, 0, 0,
542     {
543         { NULL, 0, 0, 0, 0, 0 },
544         { NULL, 0, 0, 0, 0, 0 },
545     },
546     0, 0, NULL, NULL
547 };
548
549 /* study flags */
550
551 #define SF_BEFORE_SEOL          0x0001
552 #define SF_BEFORE_MEOL          0x0002
553 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
554
555 #define SF_IS_INF               0x0040
556 #define SF_HAS_PAR              0x0080
557 #define SF_IN_PAR               0x0100
558 #define SF_HAS_EVAL             0x0200
559
560
561 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
562  * longest substring in the pattern. When it is not set the optimiser keeps
563  * track of position, but does not keep track of the actual strings seen,
564  *
565  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
566  * /foo/i will not.
567  *
568  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
569  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
570  * turned off because of the alternation (BRANCH). */
571 #define SCF_DO_SUBSTR           0x0400
572
573 #define SCF_DO_STCLASS_AND      0x0800
574 #define SCF_DO_STCLASS_OR       0x1000
575 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
576 #define SCF_WHILEM_VISITED_POS  0x2000
577
578 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
579 #define SCF_SEEN_ACCEPT         0x8000
580 #define SCF_TRIE_DOING_RESTUDY 0x10000
581 #define SCF_IN_DEFINE          0x20000
582
583
584
585
586 #define UTF cBOOL(RExC_utf8)
587
588 /* The enums for all these are ordered so things work out correctly */
589 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
590 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
591                                                      == REGEX_DEPENDS_CHARSET)
592 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
593 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
594                                                      >= REGEX_UNICODE_CHARSET)
595 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
596                                             == REGEX_ASCII_RESTRICTED_CHARSET)
597 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
598                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
599 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
600                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
601
602 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
603
604 /* For programs that want to be strictly Unicode compatible by dying if any
605  * attempt is made to match a non-Unicode code point against a Unicode
606  * property.  */
607 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
608
609 #define OOB_NAMEDCLASS          -1
610
611 /* There is no code point that is out-of-bounds, so this is problematic.  But
612  * its only current use is to initialize a variable that is always set before
613  * looked at. */
614 #define OOB_UNICODE             0xDEADBEEF
615
616 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
617
618
619 /* length of regex to show in messages that don't mark a position within */
620 #define RegexLengthToShowInErrorMessages 127
621
622 /*
623  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
624  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
625  * op/pragma/warn/regcomp.
626  */
627 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
628 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
629
630 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
631                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
632
633 /* The code in this file in places uses one level of recursion with parsing
634  * rebased to an alternate string constructed by us in memory.  This can take
635  * the form of something that is completely different from the input, or
636  * something that uses the input as part of the alternate.  In the first case,
637  * there should be no possibility of an error, as we are in complete control of
638  * the alternate string.  But in the second case we don't completely control
639  * the input portion, so there may be errors in that.  Here's an example:
640  *      /[abc\x{DF}def]/ui
641  * is handled specially because \x{df} folds to a sequence of more than one
642  * character: 'ss'.  What is done is to create and parse an alternate string,
643  * which looks like this:
644  *      /(?:\x{DF}|[abc\x{DF}def])/ui
645  * where it uses the input unchanged in the middle of something it constructs,
646  * which is a branch for the DF outside the character class, and clustering
647  * parens around the whole thing. (It knows enough to skip the DF inside the
648  * class while in this substitute parse.) 'abc' and 'def' may have errors that
649  * need to be reported.  The general situation looks like this:
650  *
651  *                                       |<------- identical ------>|
652  *              sI                       tI               xI       eI
653  * Input:       ---------------------------------------------------------------
654  * Constructed:         ---------------------------------------------------
655  *                      sC               tC               xC       eC     EC
656  *                                       |<------- identical ------>|
657  *
658  * sI..eI   is the portion of the input pattern we are concerned with here.
659  * sC..EC   is the constructed substitute parse string.
660  *  sC..tC  is constructed by us
661  *  tC..eC  is an exact duplicate of the portion of the input pattern tI..eI.
662  *          In the diagram, these are vertically aligned.
663  *  eC..EC  is also constructed by us.
664  * xC       is the position in the substitute parse string where we found a
665  *          problem.
666  * xI       is the position in the original pattern corresponding to xC.
667  *
668  * We want to display a message showing the real input string.  Thus we need to
669  * translate from xC to xI.  We know that xC >= tC, since the portion of the
670  * string sC..tC has been constructed by us, and so shouldn't have errors.  We
671  * get:
672  *      xI = tI + (xC - tC)
673  *
674  * When the substitute parse is constructed, the code needs to set:
675  *      RExC_start (sC)
676  *      RExC_end (eC)
677  *      RExC_copy_start_in_input  (tI)
678  *      RExC_copy_start_in_constructed (tC)
679  * and restore them when done.
680  *
681  * During normal processing of the input pattern, both
682  * 'RExC_copy_start_in_input' and 'RExC_copy_start_in_constructed' are set to
683  * sI, so that xC equals xI.
684  */
685
686 #define sI              RExC_precomp
687 #define eI              RExC_precomp_end
688 #define sC              RExC_start
689 #define eC              RExC_end
690 #define tI              RExC_copy_start_in_input
691 #define tC              RExC_copy_start_in_constructed
692 #define xI(xC)          (tI + (xC - tC))
693 #define xI_offset(xC)   (xI(xC) - sI)
694
695 #define REPORT_LOCATION_ARGS(xC)                                            \
696     UTF8fARG(UTF,                                                           \
697              (xI(xC) > eI) /* Don't run off end */                          \
698               ? eI - sI   /* Length before the <--HERE */                   \
699               : ((xI_offset(xC) >= 0)                                       \
700                  ? xI_offset(xC)                                            \
701                  : (Perl_croak(aTHX_ "panic: %s: %d: negative offset: %"    \
702                                     IVdf " trying to output message for "   \
703                                     " pattern %.*s",                        \
704                                     __FILE__, __LINE__, (IV) xI_offset(xC), \
705                                     ((int) (eC - sC)), sC), 0)),            \
706              sI),         /* The input pattern printed up to the <--HERE */ \
707     UTF8fARG(UTF,                                                           \
708              (xI(xC) > eI) ? 0 : eI - xI(xC), /* Length after <--HERE */    \
709              (xI(xC) > eI) ? eI : xI(xC))     /* pattern after <--HERE */
710
711 /* Used to point after bad bytes for an error message, but avoid skipping
712  * past a nul byte. */
713 #define SKIP_IF_CHAR(s, e) (!*(s) ? 0 : UTF ? UTF8_SAFE_SKIP(s, e) : 1)
714
715 /* Set up to clean up after our imminent demise */
716 #define PREPARE_TO_DIE                                                      \
717     STMT_START {                                                            \
718         if (RExC_rx_sv)                                                     \
719             SAVEFREESV(RExC_rx_sv);                                         \
720         if (RExC_open_parens)                                               \
721             SAVEFREEPV(RExC_open_parens);                                   \
722         if (RExC_close_parens)                                              \
723             SAVEFREEPV(RExC_close_parens);                                  \
724     } STMT_END
725
726 /*
727  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
728  * arg. Show regex, up to a maximum length. If it's too long, chop and add
729  * "...".
730  */
731 #define _FAIL(code) STMT_START {                                        \
732     const char *ellipses = "";                                          \
733     IV len = RExC_precomp_end - RExC_precomp;                           \
734                                                                         \
735     PREPARE_TO_DIE;                                                     \
736     if (len > RegexLengthToShowInErrorMessages) {                       \
737         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
738         len = RegexLengthToShowInErrorMessages - 10;                    \
739         ellipses = "...";                                               \
740     }                                                                   \
741     code;                                                               \
742 } STMT_END
743
744 #define FAIL(msg) _FAIL(                            \
745     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
746             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
747
748 #define FAIL2(msg,arg) _FAIL(                       \
749     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
750             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
751
752 #define FAIL3(msg,arg1,arg2) _FAIL(                         \
753     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
754      arg1, arg2, UTF8fARG(UTF, len, RExC_precomp), ellipses))
755
756 /*
757  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
758  */
759 #define Simple_vFAIL(m) STMT_START {                                    \
760     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
761             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
762 } STMT_END
763
764 /*
765  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
766  */
767 #define vFAIL(m) STMT_START {                           \
768     PREPARE_TO_DIE;                                     \
769     Simple_vFAIL(m);                                    \
770 } STMT_END
771
772 /*
773  * Like Simple_vFAIL(), but accepts two arguments.
774  */
775 #define Simple_vFAIL2(m,a1) STMT_START {                        \
776     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,              \
777                       REPORT_LOCATION_ARGS(RExC_parse));        \
778 } STMT_END
779
780 /*
781  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
782  */
783 #define vFAIL2(m,a1) STMT_START {                       \
784     PREPARE_TO_DIE;                                     \
785     Simple_vFAIL2(m, a1);                               \
786 } STMT_END
787
788
789 /*
790  * Like Simple_vFAIL(), but accepts three arguments.
791  */
792 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
793     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
794             REPORT_LOCATION_ARGS(RExC_parse));                  \
795 } STMT_END
796
797 /*
798  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
799  */
800 #define vFAIL3(m,a1,a2) STMT_START {                    \
801     PREPARE_TO_DIE;                                     \
802     Simple_vFAIL3(m, a1, a2);                           \
803 } STMT_END
804
805 /*
806  * Like Simple_vFAIL(), but accepts four arguments.
807  */
808 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
809     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,      \
810             REPORT_LOCATION_ARGS(RExC_parse));                  \
811 } STMT_END
812
813 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
814     PREPARE_TO_DIE;                                     \
815     Simple_vFAIL4(m, a1, a2, a3);                       \
816 } STMT_END
817
818 /* A specialized version of vFAIL2 that works with UTF8f */
819 #define vFAIL2utf8f(m, a1) STMT_START {             \
820     PREPARE_TO_DIE;                                 \
821     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,  \
822             REPORT_LOCATION_ARGS(RExC_parse));      \
823 } STMT_END
824
825 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
826     PREPARE_TO_DIE;                                     \
827     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
828             REPORT_LOCATION_ARGS(RExC_parse));          \
829 } STMT_END
830
831 /* Setting this to NULL is a signal to not output warnings */
832 #define TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE                               \
833     STMT_START {                                                            \
834       RExC_save_copy_start_in_constructed  = RExC_copy_start_in_constructed;\
835       RExC_copy_start_in_constructed = NULL;                                \
836     } STMT_END
837 #define RESTORE_WARNINGS                                                    \
838     RExC_copy_start_in_constructed = RExC_save_copy_start_in_constructed
839
840 /* Since a warning can be generated multiple times as the input is reparsed, we
841  * output it the first time we come to that point in the parse, but suppress it
842  * otherwise.  'RExC_copy_start_in_constructed' being NULL is a flag to not
843  * generate any warnings */
844 #define TO_OUTPUT_WARNINGS(loc)                                         \
845   (   RExC_copy_start_in_constructed                                    \
846    && ((xI(loc)) - RExC_precomp) > (Ptrdiff_t) RExC_latest_warn_offset)
847
848 /* After we've emitted a warning, we save the position in the input so we don't
849  * output it again */
850 #define UPDATE_WARNINGS_LOC(loc)                                        \
851     STMT_START {                                                        \
852         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
853             RExC_latest_warn_offset = (xI(loc)) - RExC_precomp;         \
854         }                                                               \
855     } STMT_END
856
857 /* 'warns' is the output of the packWARNx macro used in 'code' */
858 #define _WARN_HELPER(loc, warns, code)                                  \
859     STMT_START {                                                        \
860         if (! RExC_copy_start_in_constructed) {                         \
861             Perl_croak( aTHX_ "panic! %s: %d: Tried to warn when none"  \
862                               " expected at '%s'",                      \
863                               __FILE__, __LINE__, loc);                 \
864         }                                                               \
865         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
866             if (ckDEAD(warns))                                          \
867                 PREPARE_TO_DIE;                                         \
868             code;                                                       \
869             UPDATE_WARNINGS_LOC(loc);                                   \
870         }                                                               \
871     } STMT_END
872
873 /* m is not necessarily a "literal string", in this macro */
874 #define reg_warn_non_literal_string(loc, m)                             \
875     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
876                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
877                                        "%s" REPORT_LOCATION,            \
878                                   m, REPORT_LOCATION_ARGS(loc)))
879
880 #define ckWARNreg(loc,m)                                                \
881     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
882                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
883                                           m REPORT_LOCATION,            \
884                                           REPORT_LOCATION_ARGS(loc)))
885
886 #define vWARN(loc, m)                                                   \
887     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
888                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
889                                        m REPORT_LOCATION,               \
890                                        REPORT_LOCATION_ARGS(loc)))      \
891
892 #define vWARN_dep(loc, m)                                               \
893     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
894                       Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),      \
895                                        m REPORT_LOCATION,               \
896                                        REPORT_LOCATION_ARGS(loc)))
897
898 #define ckWARNdep(loc,m)                                                \
899     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
900                       Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
901                                             m REPORT_LOCATION,          \
902                                             REPORT_LOCATION_ARGS(loc)))
903
904 #define ckWARNregdep(loc,m)                                                 \
905     _WARN_HELPER(loc, packWARN2(WARN_DEPRECATED, WARN_REGEXP),              \
906                       Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,     \
907                                                       WARN_REGEXP),         \
908                                              m REPORT_LOCATION,             \
909                                              REPORT_LOCATION_ARGS(loc)))
910
911 #define ckWARN2reg_d(loc,m, a1)                                             \
912     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
913                       Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),         \
914                                             m REPORT_LOCATION,              \
915                                             a1, REPORT_LOCATION_ARGS(loc)))
916
917 #define ckWARN2reg(loc, m, a1)                                              \
918     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
919                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
920                                           m REPORT_LOCATION,                \
921                                           a1, REPORT_LOCATION_ARGS(loc)))
922
923 #define vWARN3(loc, m, a1, a2)                                              \
924     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
925                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),              \
926                                        m REPORT_LOCATION,                   \
927                                        a1, a2, REPORT_LOCATION_ARGS(loc)))
928
929 #define ckWARN3reg(loc, m, a1, a2)                                          \
930     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
931                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
932                                           m REPORT_LOCATION,                \
933                                           a1, a2,                           \
934                                           REPORT_LOCATION_ARGS(loc)))
935
936 #define vWARN4(loc, m, a1, a2, a3)                                      \
937     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
938                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
939                                        m REPORT_LOCATION,               \
940                                        a1, a2, a3,                      \
941                                        REPORT_LOCATION_ARGS(loc)))
942
943 #define ckWARN4reg(loc, m, a1, a2, a3)                                  \
944     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
945                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
946                                           m REPORT_LOCATION,            \
947                                           a1, a2, a3,                   \
948                                           REPORT_LOCATION_ARGS(loc)))
949
950 #define vWARN5(loc, m, a1, a2, a3, a4)                                  \
951     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
952                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
953                                        m REPORT_LOCATION,               \
954                                        a1, a2, a3, a4,                  \
955                                        REPORT_LOCATION_ARGS(loc)))
956
957 #define ckWARNexperimental(loc, class, m)                               \
958     _WARN_HELPER(loc, packWARN(class),                                  \
959                       Perl_ck_warner_d(aTHX_ packWARN(class),           \
960                                             m REPORT_LOCATION,          \
961                                             REPORT_LOCATION_ARGS(loc)))
962
963 /* Convert between a pointer to a node and its offset from the beginning of the
964  * program */
965 #define REGNODE_p(offset)    (RExC_emit_start + (offset))
966 #define REGNODE_OFFSET(node) ((node) - RExC_emit_start)
967
968 /* Macros for recording node offsets.   20001227 mjd@plover.com
969  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
970  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
971  * Element 0 holds the number n.
972  * Position is 1 indexed.
973  */
974 #ifndef RE_TRACK_PATTERN_OFFSETS
975 #define Set_Node_Offset_To_R(offset,byte)
976 #define Set_Node_Offset(node,byte)
977 #define Set_Cur_Node_Offset
978 #define Set_Node_Length_To_R(node,len)
979 #define Set_Node_Length(node,len)
980 #define Set_Node_Cur_Length(node,start)
981 #define Node_Offset(n)
982 #define Node_Length(n)
983 #define Set_Node_Offset_Length(node,offset,len)
984 #define ProgLen(ri) ri->u.proglen
985 #define SetProgLen(ri,x) ri->u.proglen = x
986 #define Track_Code(code)
987 #else
988 #define ProgLen(ri) ri->u.offsets[0]
989 #define SetProgLen(ri,x) ri->u.offsets[0] = x
990 #define Set_Node_Offset_To_R(offset,byte) STMT_START {                  \
991         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
992                     __LINE__, (int)(offset), (int)(byte)));             \
993         if((offset) < 0) {                                              \
994             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
995                                          (int)(offset));                \
996         } else {                                                        \
997             RExC_offsets[2*(offset)-1] = (byte);                        \
998         }                                                               \
999 } STMT_END
1000
1001 #define Set_Node_Offset(node,byte)                                      \
1002     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (byte)-RExC_start)
1003 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
1004
1005 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
1006         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
1007                 __LINE__, (int)(node), (int)(len)));                    \
1008         if((node) < 0) {                                                \
1009             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
1010                                          (int)(node));                  \
1011         } else {                                                        \
1012             RExC_offsets[2*(node)] = (len);                             \
1013         }                                                               \
1014 } STMT_END
1015
1016 #define Set_Node_Length(node,len) \
1017     Set_Node_Length_To_R(REGNODE_OFFSET(node), len)
1018 #define Set_Node_Cur_Length(node, start)                \
1019     Set_Node_Length(node, RExC_parse - start)
1020
1021 /* Get offsets and lengths */
1022 #define Node_Offset(n) (RExC_offsets[2*(REGNODE_OFFSET(n))-1])
1023 #define Node_Length(n) (RExC_offsets[2*(REGNODE_OFFSET(n))])
1024
1025 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
1026     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (offset));       \
1027     Set_Node_Length_To_R(REGNODE_OFFSET(node), (len));  \
1028 } STMT_END
1029
1030 #define Track_Code(code) STMT_START { code } STMT_END
1031 #endif
1032
1033 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
1034 #define EXPERIMENTAL_INPLACESCAN
1035 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
1036
1037 #ifdef DEBUGGING
1038 int
1039 Perl_re_printf(pTHX_ const char *fmt, ...)
1040 {
1041     va_list ap;
1042     int result;
1043     PerlIO *f= Perl_debug_log;
1044     PERL_ARGS_ASSERT_RE_PRINTF;
1045     va_start(ap, fmt);
1046     result = PerlIO_vprintf(f, fmt, ap);
1047     va_end(ap);
1048     return result;
1049 }
1050
1051 int
1052 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
1053 {
1054     va_list ap;
1055     int result;
1056     PerlIO *f= Perl_debug_log;
1057     PERL_ARGS_ASSERT_RE_INDENTF;
1058     va_start(ap, depth);
1059     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
1060     result = PerlIO_vprintf(f, fmt, ap);
1061     va_end(ap);
1062     return result;
1063 }
1064 #endif /* DEBUGGING */
1065
1066 #define DEBUG_RExC_seen()                                                   \
1067         DEBUG_OPTIMISE_MORE_r({                                             \
1068             Perl_re_printf( aTHX_ "RExC_seen: ");                           \
1069                                                                             \
1070             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
1071                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                \
1072                                                                             \
1073             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
1074                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");              \
1075                                                                             \
1076             if (RExC_seen & REG_GPOS_SEEN)                                  \
1077                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                    \
1078                                                                             \
1079             if (RExC_seen & REG_RECURSE_SEEN)                               \
1080                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                 \
1081                                                                             \
1082             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
1083                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");      \
1084                                                                             \
1085             if (RExC_seen & REG_VERBARG_SEEN)                               \
1086                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                 \
1087                                                                             \
1088             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
1089                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                \
1090                                                                             \
1091             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
1092                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");          \
1093                                                                             \
1094             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
1095                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");          \
1096                                                                             \
1097             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
1098                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");    \
1099                                                                             \
1100             Perl_re_printf( aTHX_ "\n");                                    \
1101         });
1102
1103 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
1104   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
1105
1106
1107 #ifdef DEBUGGING
1108 static void
1109 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
1110                                     const char *close_str)
1111 {
1112     if (!flags)
1113         return;
1114
1115     Perl_re_printf( aTHX_  "%s", open_str);
1116     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
1117     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
1118     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
1119     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
1120     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
1121     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
1122     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
1123     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
1124     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
1125     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
1126     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
1127     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
1128     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1129     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1130     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1131     Perl_re_printf( aTHX_  "%s", close_str);
1132 }
1133
1134
1135 static void
1136 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1137                     U32 depth, int is_inf)
1138 {
1139     GET_RE_DEBUG_FLAGS_DECL;
1140
1141     DEBUG_OPTIMISE_MORE_r({
1142         if (!data)
1143             return;
1144         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1145             depth,
1146             where,
1147             (IV)data->pos_min,
1148             (IV)data->pos_delta,
1149             (UV)data->flags
1150         );
1151
1152         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1153
1154         Perl_re_printf( aTHX_
1155             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1156             (IV)data->whilem_c,
1157             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1158             is_inf ? "INF " : ""
1159         );
1160
1161         if (data->last_found) {
1162             int i;
1163             Perl_re_printf(aTHX_
1164                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1165                     SvPVX_const(data->last_found),
1166                     (IV)data->last_end,
1167                     (IV)data->last_start_min,
1168                     (IV)data->last_start_max
1169             );
1170
1171             for (i = 0; i < 2; i++) {
1172                 Perl_re_printf(aTHX_
1173                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1174                     data->cur_is_floating == i ? "*" : "",
1175                     i ? "Float" : "Fixed",
1176                     SvPVX_const(data->substrs[i].str),
1177                     (IV)data->substrs[i].min_offset,
1178                     (IV)data->substrs[i].max_offset
1179                 );
1180                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1181             }
1182         }
1183
1184         Perl_re_printf( aTHX_ "\n");
1185     });
1186 }
1187
1188
1189 static void
1190 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1191                 regnode *scan, U32 depth, U32 flags)
1192 {
1193     GET_RE_DEBUG_FLAGS_DECL;
1194
1195     DEBUG_OPTIMISE_r({
1196         regnode *Next;
1197
1198         if (!scan)
1199             return;
1200         Next = regnext(scan);
1201         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1202         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1203             depth,
1204             str,
1205             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1206             Next ? (REG_NODE_NUM(Next)) : 0 );
1207         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1208         Perl_re_printf( aTHX_  "\n");
1209    });
1210 }
1211
1212
1213 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1214                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1215
1216 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1217                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1218
1219 #else
1220 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1221 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1222 #endif
1223
1224
1225 /* =========================================================
1226  * BEGIN edit_distance stuff.
1227  *
1228  * This calculates how many single character changes of any type are needed to
1229  * transform a string into another one.  It is taken from version 3.1 of
1230  *
1231  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1232  */
1233
1234 /* Our unsorted dictionary linked list.   */
1235 /* Note we use UVs, not chars. */
1236
1237 struct dictionary{
1238   UV key;
1239   UV value;
1240   struct dictionary* next;
1241 };
1242 typedef struct dictionary item;
1243
1244
1245 PERL_STATIC_INLINE item*
1246 push(UV key, item* curr)
1247 {
1248     item* head;
1249     Newx(head, 1, item);
1250     head->key = key;
1251     head->value = 0;
1252     head->next = curr;
1253     return head;
1254 }
1255
1256
1257 PERL_STATIC_INLINE item*
1258 find(item* head, UV key)
1259 {
1260     item* iterator = head;
1261     while (iterator){
1262         if (iterator->key == key){
1263             return iterator;
1264         }
1265         iterator = iterator->next;
1266     }
1267
1268     return NULL;
1269 }
1270
1271 PERL_STATIC_INLINE item*
1272 uniquePush(item* head, UV key)
1273 {
1274     item* iterator = head;
1275
1276     while (iterator){
1277         if (iterator->key == key) {
1278             return head;
1279         }
1280         iterator = iterator->next;
1281     }
1282
1283     return push(key, head);
1284 }
1285
1286 PERL_STATIC_INLINE void
1287 dict_free(item* head)
1288 {
1289     item* iterator = head;
1290
1291     while (iterator) {
1292         item* temp = iterator;
1293         iterator = iterator->next;
1294         Safefree(temp);
1295     }
1296
1297     head = NULL;
1298 }
1299
1300 /* End of Dictionary Stuff */
1301
1302 /* All calculations/work are done here */
1303 STATIC int
1304 S_edit_distance(const UV* src,
1305                 const UV* tgt,
1306                 const STRLEN x,             /* length of src[] */
1307                 const STRLEN y,             /* length of tgt[] */
1308                 const SSize_t maxDistance
1309 )
1310 {
1311     item *head = NULL;
1312     UV swapCount, swapScore, targetCharCount, i, j;
1313     UV *scores;
1314     UV score_ceil = x + y;
1315
1316     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1317
1318     /* intialize matrix start values */
1319     Newx(scores, ( (x + 2) * (y + 2)), UV);
1320     scores[0] = score_ceil;
1321     scores[1 * (y + 2) + 0] = score_ceil;
1322     scores[0 * (y + 2) + 1] = score_ceil;
1323     scores[1 * (y + 2) + 1] = 0;
1324     head = uniquePush(uniquePush(head, src[0]), tgt[0]);
1325
1326     /* work loops    */
1327     /* i = src index */
1328     /* j = tgt index */
1329     for (i=1;i<=x;i++) {
1330         if (i < x)
1331             head = uniquePush(head, src[i]);
1332         scores[(i+1) * (y + 2) + 1] = i;
1333         scores[(i+1) * (y + 2) + 0] = score_ceil;
1334         swapCount = 0;
1335
1336         for (j=1;j<=y;j++) {
1337             if (i == 1) {
1338                 if(j < y)
1339                 head = uniquePush(head, tgt[j]);
1340                 scores[1 * (y + 2) + (j + 1)] = j;
1341                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1342             }
1343
1344             targetCharCount = find(head, tgt[j-1])->value;
1345             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1346
1347             if (src[i-1] != tgt[j-1]){
1348                 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));
1349             }
1350             else {
1351                 swapCount = j;
1352                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1353             }
1354         }
1355
1356         find(head, src[i-1])->value = i;
1357     }
1358
1359     {
1360         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1361         dict_free(head);
1362         Safefree(scores);
1363         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1364     }
1365 }
1366
1367 /* END of edit_distance() stuff
1368  * ========================================================= */
1369
1370 /* is c a control character for which we have a mnemonic? */
1371 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1372
1373 STATIC const char *
1374 S_cntrl_to_mnemonic(const U8 c)
1375 {
1376     /* Returns the mnemonic string that represents character 'c', if one
1377      * exists; NULL otherwise.  The only ones that exist for the purposes of
1378      * this routine are a few control characters */
1379
1380     switch (c) {
1381         case '\a':       return "\\a";
1382         case '\b':       return "\\b";
1383         case ESC_NATIVE: return "\\e";
1384         case '\f':       return "\\f";
1385         case '\n':       return "\\n";
1386         case '\r':       return "\\r";
1387         case '\t':       return "\\t";
1388     }
1389
1390     return NULL;
1391 }
1392
1393 /* Mark that we cannot extend a found fixed substring at this point.
1394    Update the longest found anchored substring or the longest found
1395    floating substrings if needed. */
1396
1397 STATIC void
1398 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1399                     SSize_t *minlenp, int is_inf)
1400 {
1401     const STRLEN l = CHR_SVLEN(data->last_found);
1402     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1403     const STRLEN old_l = CHR_SVLEN(longest_sv);
1404     GET_RE_DEBUG_FLAGS_DECL;
1405
1406     PERL_ARGS_ASSERT_SCAN_COMMIT;
1407
1408     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1409         const U8 i = data->cur_is_floating;
1410         SvSetMagicSV(longest_sv, data->last_found);
1411         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1412
1413         if (!i) /* fixed */
1414             data->substrs[0].max_offset = data->substrs[0].min_offset;
1415         else { /* float */
1416             data->substrs[1].max_offset = (l
1417                           ? data->last_start_max
1418                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1419                                          ? SSize_t_MAX
1420                                          : data->pos_min + data->pos_delta));
1421             if (is_inf
1422                  || (STRLEN)data->substrs[1].max_offset > (STRLEN)SSize_t_MAX)
1423                 data->substrs[1].max_offset = SSize_t_MAX;
1424         }
1425
1426         if (data->flags & SF_BEFORE_EOL)
1427             data->substrs[i].flags |= (data->flags & SF_BEFORE_EOL);
1428         else
1429             data->substrs[i].flags &= ~SF_BEFORE_EOL;
1430         data->substrs[i].minlenp = minlenp;
1431         data->substrs[i].lookbehind = 0;
1432     }
1433
1434     SvCUR_set(data->last_found, 0);
1435     {
1436         SV * const sv = data->last_found;
1437         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1438             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1439             if (mg)
1440                 mg->mg_len = 0;
1441         }
1442     }
1443     data->last_end = -1;
1444     data->flags &= ~SF_BEFORE_EOL;
1445     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1446 }
1447
1448 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1449  * list that describes which code points it matches */
1450
1451 STATIC void
1452 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1453 {
1454     /* Set the SSC 'ssc' to match an empty string or any code point */
1455
1456     PERL_ARGS_ASSERT_SSC_ANYTHING;
1457
1458     assert(is_ANYOF_SYNTHETIC(ssc));
1459
1460     /* mortalize so won't leak */
1461     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1462     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1463 }
1464
1465 STATIC int
1466 S_ssc_is_anything(const regnode_ssc *ssc)
1467 {
1468     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1469      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1470      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1471      * in any way, so there's no point in using it */
1472
1473     UV start, end;
1474     bool ret;
1475
1476     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1477
1478     assert(is_ANYOF_SYNTHETIC(ssc));
1479
1480     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1481         return FALSE;
1482     }
1483
1484     /* See if the list consists solely of the range 0 - Infinity */
1485     invlist_iterinit(ssc->invlist);
1486     ret = invlist_iternext(ssc->invlist, &start, &end)
1487           && start == 0
1488           && end == UV_MAX;
1489
1490     invlist_iterfinish(ssc->invlist);
1491
1492     if (ret) {
1493         return TRUE;
1494     }
1495
1496     /* If e.g., both \w and \W are set, matches everything */
1497     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1498         int i;
1499         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1500             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1501                 return TRUE;
1502             }
1503         }
1504     }
1505
1506     return FALSE;
1507 }
1508
1509 STATIC void
1510 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1511 {
1512     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1513      * string, any code point, or any posix class under locale */
1514
1515     PERL_ARGS_ASSERT_SSC_INIT;
1516
1517     Zero(ssc, 1, regnode_ssc);
1518     set_ANYOF_SYNTHETIC(ssc);
1519     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1520     ssc_anything(ssc);
1521
1522     /* If any portion of the regex is to operate under locale rules that aren't
1523      * fully known at compile time, initialization includes it.  The reason
1524      * this isn't done for all regexes is that the optimizer was written under
1525      * the assumption that locale was all-or-nothing.  Given the complexity and
1526      * lack of documentation in the optimizer, and that there are inadequate
1527      * test cases for locale, many parts of it may not work properly, it is
1528      * safest to avoid locale unless necessary. */
1529     if (RExC_contains_locale) {
1530         ANYOF_POSIXL_SETALL(ssc);
1531     }
1532     else {
1533         ANYOF_POSIXL_ZERO(ssc);
1534     }
1535 }
1536
1537 STATIC int
1538 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1539                         const regnode_ssc *ssc)
1540 {
1541     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1542      * to the list of code points matched, and locale posix classes; hence does
1543      * not check its flags) */
1544
1545     UV start, end;
1546     bool ret;
1547
1548     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1549
1550     assert(is_ANYOF_SYNTHETIC(ssc));
1551
1552     invlist_iterinit(ssc->invlist);
1553     ret = invlist_iternext(ssc->invlist, &start, &end)
1554           && start == 0
1555           && end == UV_MAX;
1556
1557     invlist_iterfinish(ssc->invlist);
1558
1559     if (! ret) {
1560         return FALSE;
1561     }
1562
1563     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1564         return FALSE;
1565     }
1566
1567     return TRUE;
1568 }
1569
1570 #define INVLIST_INDEX 0
1571 #define ONLY_LOCALE_MATCHES_INDEX 1
1572 #define DEFERRED_USER_DEFINED_INDEX 2
1573
1574 STATIC SV*
1575 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1576                                const regnode_charclass* const node)
1577 {
1578     /* Returns a mortal inversion list defining which code points are matched
1579      * by 'node', which is of type ANYOF.  Handles complementing the result if
1580      * appropriate.  If some code points aren't knowable at this time, the
1581      * returned list must, and will, contain every code point that is a
1582      * possibility. */
1583
1584     dVAR;
1585     SV* invlist = NULL;
1586     SV* only_utf8_locale_invlist = NULL;
1587     unsigned int i;
1588     const U32 n = ARG(node);
1589     bool new_node_has_latin1 = FALSE;
1590     const U8 flags = (inRANGE(OP(node), ANYOFH, ANYOFHr))
1591                       ? 0
1592                       : ANYOF_FLAGS(node);
1593
1594     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1595
1596     /* Look at the data structure created by S_set_ANYOF_arg() */
1597     if (n != ANYOF_ONLY_HAS_BITMAP) {
1598         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1599         AV * const av = MUTABLE_AV(SvRV(rv));
1600         SV **const ary = AvARRAY(av);
1601         assert(RExC_rxi->data->what[n] == 's');
1602
1603         if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
1604
1605             /* Here there are things that won't be known until runtime -- we
1606              * have to assume it could be anything */
1607             invlist = sv_2mortal(_new_invlist(1));
1608             return _add_range_to_invlist(invlist, 0, UV_MAX);
1609         }
1610         else if (ary[INVLIST_INDEX]) {
1611
1612             /* Use the node's inversion list */
1613             invlist = sv_2mortal(invlist_clone(ary[INVLIST_INDEX], NULL));
1614         }
1615
1616         /* Get the code points valid only under UTF-8 locales */
1617         if (   (flags & ANYOFL_FOLD)
1618             &&  av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX)
1619         {
1620             only_utf8_locale_invlist = ary[ONLY_LOCALE_MATCHES_INDEX];
1621         }
1622     }
1623
1624     if (! invlist) {
1625         invlist = sv_2mortal(_new_invlist(0));
1626     }
1627
1628     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1629      * code points, and an inversion list for the others, but if there are code
1630      * points that should match only conditionally on the target string being
1631      * UTF-8, those are placed in the inversion list, and not the bitmap.
1632      * Since there are circumstances under which they could match, they are
1633      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1634      * to exclude them here, so that when we invert below, the end result
1635      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1636      * have to do this here before we add the unconditionally matched code
1637      * points */
1638     if (flags & ANYOF_INVERT) {
1639         _invlist_intersection_complement_2nd(invlist,
1640                                              PL_UpperLatin1,
1641                                              &invlist);
1642     }
1643
1644     /* Add in the points from the bit map */
1645     if (! inRANGE(OP(node), ANYOFH, ANYOFHr)) {
1646         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1647             if (ANYOF_BITMAP_TEST(node, i)) {
1648                 unsigned int start = i++;
1649
1650                 for (;    i < NUM_ANYOF_CODE_POINTS
1651                        && ANYOF_BITMAP_TEST(node, i); ++i)
1652                 {
1653                     /* empty */
1654                 }
1655                 invlist = _add_range_to_invlist(invlist, start, i-1);
1656                 new_node_has_latin1 = TRUE;
1657             }
1658         }
1659     }
1660
1661     /* If this can match all upper Latin1 code points, have to add them
1662      * as well.  But don't add them if inverting, as when that gets done below,
1663      * it would exclude all these characters, including the ones it shouldn't
1664      * that were added just above */
1665     if (! (flags & ANYOF_INVERT) && OP(node) == ANYOFD
1666         && (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1667     {
1668         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1669     }
1670
1671     /* Similarly for these */
1672     if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1673         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1674     }
1675
1676     if (flags & ANYOF_INVERT) {
1677         _invlist_invert(invlist);
1678     }
1679     else if (flags & ANYOFL_FOLD) {
1680         if (new_node_has_latin1) {
1681
1682             /* Under /li, any 0-255 could fold to any other 0-255, depending on
1683              * the locale.  We can skip this if there are no 0-255 at all. */
1684             _invlist_union(invlist, PL_Latin1, &invlist);
1685
1686             invlist = add_cp_to_invlist(invlist, LATIN_SMALL_LETTER_DOTLESS_I);
1687             invlist = add_cp_to_invlist(invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
1688         }
1689         else {
1690             if (_invlist_contains_cp(invlist, LATIN_SMALL_LETTER_DOTLESS_I)) {
1691                 invlist = add_cp_to_invlist(invlist, 'I');
1692             }
1693             if (_invlist_contains_cp(invlist,
1694                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE))
1695             {
1696                 invlist = add_cp_to_invlist(invlist, 'i');
1697             }
1698         }
1699     }
1700
1701     /* Similarly add the UTF-8 locale possible matches.  These have to be
1702      * deferred until after the non-UTF-8 locale ones are taken care of just
1703      * above, or it leads to wrong results under ANYOF_INVERT */
1704     if (only_utf8_locale_invlist) {
1705         _invlist_union_maybe_complement_2nd(invlist,
1706                                             only_utf8_locale_invlist,
1707                                             flags & ANYOF_INVERT,
1708                                             &invlist);
1709     }
1710
1711     return invlist;
1712 }
1713
1714 /* These two functions currently do the exact same thing */
1715 #define ssc_init_zero           ssc_init
1716
1717 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1718 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1719
1720 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1721  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1722  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1723
1724 STATIC void
1725 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1726                 const regnode_charclass *and_with)
1727 {
1728     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1729      * another SSC or a regular ANYOF class.  Can create false positives. */
1730
1731     SV* anded_cp_list;
1732     U8  and_with_flags = inRANGE(OP(and_with), ANYOFH, ANYOFHr)
1733                           ? 0
1734                           : ANYOF_FLAGS(and_with);
1735     U8  anded_flags;
1736
1737     PERL_ARGS_ASSERT_SSC_AND;
1738
1739     assert(is_ANYOF_SYNTHETIC(ssc));
1740
1741     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1742      * the code point inversion list and just the relevant flags */
1743     if (is_ANYOF_SYNTHETIC(and_with)) {
1744         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1745         anded_flags = and_with_flags;
1746
1747         /* XXX This is a kludge around what appears to be deficiencies in the
1748          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1749          * there are paths through the optimizer where it doesn't get weeded
1750          * out when it should.  And if we don't make some extra provision for
1751          * it like the code just below, it doesn't get added when it should.
1752          * This solution is to add it only when AND'ing, which is here, and
1753          * only when what is being AND'ed is the pristine, original node
1754          * matching anything.  Thus it is like adding it to ssc_anything() but
1755          * only when the result is to be AND'ed.  Probably the same solution
1756          * could be adopted for the same problem we have with /l matching,
1757          * which is solved differently in S_ssc_init(), and that would lead to
1758          * fewer false positives than that solution has.  But if this solution
1759          * creates bugs, the consequences are only that a warning isn't raised
1760          * that should be; while the consequences for having /l bugs is
1761          * incorrect matches */
1762         if (ssc_is_anything((regnode_ssc *)and_with)) {
1763             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1764         }
1765     }
1766     else {
1767         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1768         if (OP(and_with) == ANYOFD) {
1769             anded_flags = and_with_flags & ANYOF_COMMON_FLAGS;
1770         }
1771         else {
1772             anded_flags = and_with_flags
1773             &( ANYOF_COMMON_FLAGS
1774               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1775               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1776             if (ANYOFL_UTF8_LOCALE_REQD(and_with_flags)) {
1777                 anded_flags &=
1778                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1779             }
1780         }
1781     }
1782
1783     ANYOF_FLAGS(ssc) &= anded_flags;
1784
1785     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1786      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1787      * 'and_with' may be inverted.  When not inverted, we have the situation of
1788      * computing:
1789      *  (C1 | P1) & (C2 | P2)
1790      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1791      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1792      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1793      *                    <=  ((C1 & C2) | P1 | P2)
1794      * Alternatively, the last few steps could be:
1795      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1796      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1797      *                    <=  (C1 | C2 | (P1 & P2))
1798      * We favor the second approach if either P1 or P2 is non-empty.  This is
1799      * because these components are a barrier to doing optimizations, as what
1800      * they match cannot be known until the moment of matching as they are
1801      * dependent on the current locale, 'AND"ing them likely will reduce or
1802      * eliminate them.
1803      * But we can do better if we know that C1,P1 are in their initial state (a
1804      * frequent occurrence), each matching everything:
1805      *  (<everything>) & (C2 | P2) =  C2 | P2
1806      * Similarly, if C2,P2 are in their initial state (again a frequent
1807      * occurrence), the result is a no-op
1808      *  (C1 | P1) & (<everything>) =  C1 | P1
1809      *
1810      * Inverted, we have
1811      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1812      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1813      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1814      * */
1815
1816     if ((and_with_flags & ANYOF_INVERT)
1817         && ! is_ANYOF_SYNTHETIC(and_with))
1818     {
1819         unsigned int i;
1820
1821         ssc_intersection(ssc,
1822                          anded_cp_list,
1823                          FALSE /* Has already been inverted */
1824                          );
1825
1826         /* If either P1 or P2 is empty, the intersection will be also; can skip
1827          * the loop */
1828         if (! (and_with_flags & ANYOF_MATCHES_POSIXL)) {
1829             ANYOF_POSIXL_ZERO(ssc);
1830         }
1831         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1832
1833             /* Note that the Posix class component P from 'and_with' actually
1834              * looks like:
1835              *      P = Pa | Pb | ... | Pn
1836              * where each component is one posix class, such as in [\w\s].
1837              * Thus
1838              *      ~P = ~(Pa | Pb | ... | Pn)
1839              *         = ~Pa & ~Pb & ... & ~Pn
1840              *        <= ~Pa | ~Pb | ... | ~Pn
1841              * The last is something we can easily calculate, but unfortunately
1842              * is likely to have many false positives.  We could do better
1843              * in some (but certainly not all) instances if two classes in
1844              * P have known relationships.  For example
1845              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1846              * So
1847              *      :lower: & :print: = :lower:
1848              * And similarly for classes that must be disjoint.  For example,
1849              * since \s and \w can have no elements in common based on rules in
1850              * the POSIX standard,
1851              *      \w & ^\S = nothing
1852              * Unfortunately, some vendor locales do not meet the Posix
1853              * standard, in particular almost everything by Microsoft.
1854              * The loop below just changes e.g., \w into \W and vice versa */
1855
1856             regnode_charclass_posixl temp;
1857             int add = 1;    /* To calculate the index of the complement */
1858
1859             Zero(&temp, 1, regnode_charclass_posixl);
1860             ANYOF_POSIXL_ZERO(&temp);
1861             for (i = 0; i < ANYOF_MAX; i++) {
1862                 assert(i % 2 != 0
1863                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1864                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1865
1866                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1867                     ANYOF_POSIXL_SET(&temp, i + add);
1868                 }
1869                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1870             }
1871             ANYOF_POSIXL_AND(&temp, ssc);
1872
1873         } /* else ssc already has no posixes */
1874     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1875          in its initial state */
1876     else if (! is_ANYOF_SYNTHETIC(and_with)
1877              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1878     {
1879         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1880          * copy it over 'ssc' */
1881         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1882             if (is_ANYOF_SYNTHETIC(and_with)) {
1883                 StructCopy(and_with, ssc, regnode_ssc);
1884             }
1885             else {
1886                 ssc->invlist = anded_cp_list;
1887                 ANYOF_POSIXL_ZERO(ssc);
1888                 if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1889                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1890                 }
1891             }
1892         }
1893         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1894                  || (and_with_flags & ANYOF_MATCHES_POSIXL))
1895         {
1896             /* One or the other of P1, P2 is non-empty. */
1897             if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1898                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1899             }
1900             ssc_union(ssc, anded_cp_list, FALSE);
1901         }
1902         else { /* P1 = P2 = empty */
1903             ssc_intersection(ssc, anded_cp_list, FALSE);
1904         }
1905     }
1906 }
1907
1908 STATIC void
1909 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1910                const regnode_charclass *or_with)
1911 {
1912     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1913      * another SSC or a regular ANYOF class.  Can create false positives if
1914      * 'or_with' is to be inverted. */
1915
1916     SV* ored_cp_list;
1917     U8 ored_flags;
1918     U8  or_with_flags = inRANGE(OP(or_with), ANYOFH, ANYOFHr)
1919                          ? 0
1920                          : ANYOF_FLAGS(or_with);
1921
1922     PERL_ARGS_ASSERT_SSC_OR;
1923
1924     assert(is_ANYOF_SYNTHETIC(ssc));
1925
1926     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1927      * the code point inversion list and just the relevant flags */
1928     if (is_ANYOF_SYNTHETIC(or_with)) {
1929         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1930         ored_flags = or_with_flags;
1931     }
1932     else {
1933         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1934         ored_flags = or_with_flags & ANYOF_COMMON_FLAGS;
1935         if (OP(or_with) != ANYOFD) {
1936             ored_flags
1937             |= or_with_flags
1938              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1939                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1940             if (ANYOFL_UTF8_LOCALE_REQD(or_with_flags)) {
1941                 ored_flags |=
1942                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1943             }
1944         }
1945     }
1946
1947     ANYOF_FLAGS(ssc) |= ored_flags;
1948
1949     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1950      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1951      * 'or_with' may be inverted.  When not inverted, we have the simple
1952      * situation of computing:
1953      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1954      * If P1|P2 yields a situation with both a class and its complement are
1955      * set, like having both \w and \W, this matches all code points, and we
1956      * can delete these from the P component of the ssc going forward.  XXX We
1957      * might be able to delete all the P components, but I (khw) am not certain
1958      * about this, and it is better to be safe.
1959      *
1960      * Inverted, we have
1961      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1962      *                         <=  (C1 | P1) | ~C2
1963      *                         <=  (C1 | ~C2) | P1
1964      * (which results in actually simpler code than the non-inverted case)
1965      * */
1966
1967     if ((or_with_flags & ANYOF_INVERT)
1968         && ! is_ANYOF_SYNTHETIC(or_with))
1969     {
1970         /* We ignore P2, leaving P1 going forward */
1971     }   /* else  Not inverted */
1972     else if (or_with_flags & ANYOF_MATCHES_POSIXL) {
1973         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1974         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1975             unsigned int i;
1976             for (i = 0; i < ANYOF_MAX; i += 2) {
1977                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1978                 {
1979                     ssc_match_all_cp(ssc);
1980                     ANYOF_POSIXL_CLEAR(ssc, i);
1981                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1982                 }
1983             }
1984         }
1985     }
1986
1987     ssc_union(ssc,
1988               ored_cp_list,
1989               FALSE /* Already has been inverted */
1990               );
1991 }
1992
1993 PERL_STATIC_INLINE void
1994 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1995 {
1996     PERL_ARGS_ASSERT_SSC_UNION;
1997
1998     assert(is_ANYOF_SYNTHETIC(ssc));
1999
2000     _invlist_union_maybe_complement_2nd(ssc->invlist,
2001                                         invlist,
2002                                         invert2nd,
2003                                         &ssc->invlist);
2004 }
2005
2006 PERL_STATIC_INLINE void
2007 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
2008                          SV* const invlist,
2009                          const bool invert2nd)
2010 {
2011     PERL_ARGS_ASSERT_SSC_INTERSECTION;
2012
2013     assert(is_ANYOF_SYNTHETIC(ssc));
2014
2015     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
2016                                                invlist,
2017                                                invert2nd,
2018                                                &ssc->invlist);
2019 }
2020
2021 PERL_STATIC_INLINE void
2022 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
2023 {
2024     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
2025
2026     assert(is_ANYOF_SYNTHETIC(ssc));
2027
2028     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
2029 }
2030
2031 PERL_STATIC_INLINE void
2032 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
2033 {
2034     /* AND just the single code point 'cp' into the SSC 'ssc' */
2035
2036     SV* cp_list = _new_invlist(2);
2037
2038     PERL_ARGS_ASSERT_SSC_CP_AND;
2039
2040     assert(is_ANYOF_SYNTHETIC(ssc));
2041
2042     cp_list = add_cp_to_invlist(cp_list, cp);
2043     ssc_intersection(ssc, cp_list,
2044                      FALSE /* Not inverted */
2045                      );
2046     SvREFCNT_dec_NN(cp_list);
2047 }
2048
2049 PERL_STATIC_INLINE void
2050 S_ssc_clear_locale(regnode_ssc *ssc)
2051 {
2052     /* Set the SSC 'ssc' to not match any locale things */
2053     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
2054
2055     assert(is_ANYOF_SYNTHETIC(ssc));
2056
2057     ANYOF_POSIXL_ZERO(ssc);
2058     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
2059 }
2060
2061 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
2062
2063 STATIC bool
2064 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
2065 {
2066     /* The synthetic start class is used to hopefully quickly winnow down
2067      * places where a pattern could start a match in the target string.  If it
2068      * doesn't really narrow things down that much, there isn't much point to
2069      * having the overhead of using it.  This function uses some very crude
2070      * heuristics to decide if to use the ssc or not.
2071      *
2072      * It returns TRUE if 'ssc' rules out more than half what it considers to
2073      * be the "likely" possible matches, but of course it doesn't know what the
2074      * actual things being matched are going to be; these are only guesses
2075      *
2076      * For /l matches, it assumes that the only likely matches are going to be
2077      *      in the 0-255 range, uniformly distributed, so half of that is 127
2078      * For /a and /d matches, it assumes that the likely matches will be just
2079      *      the ASCII range, so half of that is 63
2080      * For /u and there isn't anything matching above the Latin1 range, it
2081      *      assumes that that is the only range likely to be matched, and uses
2082      *      half that as the cut-off: 127.  If anything matches above Latin1,
2083      *      it assumes that all of Unicode could match (uniformly), except for
2084      *      non-Unicode code points and things in the General Category "Other"
2085      *      (unassigned, private use, surrogates, controls and formats).  This
2086      *      is a much large number. */
2087
2088     U32 count = 0;      /* Running total of number of code points matched by
2089                            'ssc' */
2090     UV start, end;      /* Start and end points of current range in inversion
2091                            XXX outdated.  UTF-8 locales are common, what about invert? list */
2092     const U32 max_code_points = (LOC)
2093                                 ?  256
2094                                 : ((  ! UNI_SEMANTICS
2095                                     ||  invlist_highest(ssc->invlist) < 256)
2096                                   ? 128
2097                                   : NON_OTHER_COUNT);
2098     const U32 max_match = max_code_points / 2;
2099
2100     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
2101
2102     invlist_iterinit(ssc->invlist);
2103     while (invlist_iternext(ssc->invlist, &start, &end)) {
2104         if (start >= max_code_points) {
2105             break;
2106         }
2107         end = MIN(end, max_code_points - 1);
2108         count += end - start + 1;
2109         if (count >= max_match) {
2110             invlist_iterfinish(ssc->invlist);
2111             return FALSE;
2112         }
2113     }
2114
2115     return TRUE;
2116 }
2117
2118
2119 STATIC void
2120 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
2121 {
2122     /* The inversion list in the SSC is marked mortal; now we need a more
2123      * permanent copy, which is stored the same way that is done in a regular
2124      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
2125      * map */
2126
2127     SV* invlist = invlist_clone(ssc->invlist, NULL);
2128
2129     PERL_ARGS_ASSERT_SSC_FINALIZE;
2130
2131     assert(is_ANYOF_SYNTHETIC(ssc));
2132
2133     /* The code in this file assumes that all but these flags aren't relevant
2134      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
2135      * by the time we reach here */
2136     assert(! (ANYOF_FLAGS(ssc)
2137         & ~( ANYOF_COMMON_FLAGS
2138             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
2139             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
2140
2141     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
2142
2143     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist, NULL, NULL);
2144
2145     /* Make sure is clone-safe */
2146     ssc->invlist = NULL;
2147
2148     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
2149         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
2150         OP(ssc) = ANYOFPOSIXL;
2151     }
2152     else if (RExC_contains_locale) {
2153         OP(ssc) = ANYOFL;
2154     }
2155
2156     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
2157 }
2158
2159 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
2160 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
2161 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
2162 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
2163                                ? (TRIE_LIST_CUR( idx ) - 1)           \
2164                                : 0 )
2165
2166
2167 #ifdef DEBUGGING
2168 /*
2169    dump_trie(trie,widecharmap,revcharmap)
2170    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
2171    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
2172
2173    These routines dump out a trie in a somewhat readable format.
2174    The _interim_ variants are used for debugging the interim
2175    tables that are used to generate the final compressed
2176    representation which is what dump_trie expects.
2177
2178    Part of the reason for their existence is to provide a form
2179    of documentation as to how the different representations function.
2180
2181 */
2182
2183 /*
2184   Dumps the final compressed table form of the trie to Perl_debug_log.
2185   Used for debugging make_trie().
2186 */
2187
2188 STATIC void
2189 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
2190             AV *revcharmap, U32 depth)
2191 {
2192     U32 state;
2193     SV *sv=sv_newmortal();
2194     int colwidth= widecharmap ? 6 : 4;
2195     U16 word;
2196     GET_RE_DEBUG_FLAGS_DECL;
2197
2198     PERL_ARGS_ASSERT_DUMP_TRIE;
2199
2200     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
2201         depth+1, "Match","Base","Ofs" );
2202
2203     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2204         SV ** const tmp = av_fetch( revcharmap, state, 0);
2205         if ( tmp ) {
2206             Perl_re_printf( aTHX_  "%*s",
2207                 colwidth,
2208                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2209                             PL_colors[0], PL_colors[1],
2210                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2211                             PERL_PV_ESCAPE_FIRSTCHAR
2212                 )
2213             );
2214         }
2215     }
2216     Perl_re_printf( aTHX_  "\n");
2217     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2218
2219     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2220         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2221     Perl_re_printf( aTHX_  "\n");
2222
2223     for( state = 1 ; state < trie->statecount ; state++ ) {
2224         const U32 base = trie->states[ state ].trans.base;
2225
2226         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2227
2228         if ( trie->states[ state ].wordnum ) {
2229             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2230         } else {
2231             Perl_re_printf( aTHX_  "%6s", "" );
2232         }
2233
2234         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2235
2236         if ( base ) {
2237             U32 ofs = 0;
2238
2239             while( ( base + ofs  < trie->uniquecharcount ) ||
2240                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2241                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2242                                                                     != state))
2243                     ofs++;
2244
2245             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2246
2247             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2248                 if ( ( base + ofs >= trie->uniquecharcount )
2249                         && ( base + ofs - trie->uniquecharcount
2250                                                         < trie->lasttrans )
2251                         && trie->trans[ base + ofs
2252                                     - trie->uniquecharcount ].check == state )
2253                 {
2254                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2255                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2256                    );
2257                 } else {
2258                     Perl_re_printf( aTHX_  "%*s", colwidth,"   ." );
2259                 }
2260             }
2261
2262             Perl_re_printf( aTHX_  "]");
2263
2264         }
2265         Perl_re_printf( aTHX_  "\n" );
2266     }
2267     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2268                                 depth);
2269     for (word=1; word <= trie->wordcount; word++) {
2270         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2271             (int)word, (int)(trie->wordinfo[word].prev),
2272             (int)(trie->wordinfo[word].len));
2273     }
2274     Perl_re_printf( aTHX_  "\n" );
2275 }
2276 /*
2277   Dumps a fully constructed but uncompressed trie in list form.
2278   List tries normally only are used for construction when the number of
2279   possible chars (trie->uniquecharcount) is very high.
2280   Used for debugging make_trie().
2281 */
2282 STATIC void
2283 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2284                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2285                          U32 depth)
2286 {
2287     U32 state;
2288     SV *sv=sv_newmortal();
2289     int colwidth= widecharmap ? 6 : 4;
2290     GET_RE_DEBUG_FLAGS_DECL;
2291
2292     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2293
2294     /* print out the table precompression.  */
2295     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2296             depth+1 );
2297     Perl_re_indentf( aTHX_  "%s",
2298             depth+1, "------:-----+-----------------\n" );
2299
2300     for( state=1 ; state < next_alloc ; state ++ ) {
2301         U16 charid;
2302
2303         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2304             depth+1, (UV)state  );
2305         if ( ! trie->states[ state ].wordnum ) {
2306             Perl_re_printf( aTHX_  "%5s| ","");
2307         } else {
2308             Perl_re_printf( aTHX_  "W%4x| ",
2309                 trie->states[ state ].wordnum
2310             );
2311         }
2312         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2313             SV ** const tmp = av_fetch( revcharmap,
2314                                         TRIE_LIST_ITEM(state, charid).forid, 0);
2315             if ( tmp ) {
2316                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2317                     colwidth,
2318                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2319                               colwidth,
2320                               PL_colors[0], PL_colors[1],
2321                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2322                               | PERL_PV_ESCAPE_FIRSTCHAR
2323                     ) ,
2324                     TRIE_LIST_ITEM(state, charid).forid,
2325                     (UV)TRIE_LIST_ITEM(state, charid).newstate
2326                 );
2327                 if (!(charid % 10))
2328                     Perl_re_printf( aTHX_  "\n%*s| ",
2329                         (int)((depth * 2) + 14), "");
2330             }
2331         }
2332         Perl_re_printf( aTHX_  "\n");
2333     }
2334 }
2335
2336 /*
2337   Dumps a fully constructed but uncompressed trie in table form.
2338   This is the normal DFA style state transition table, with a few
2339   twists to facilitate compression later.
2340   Used for debugging make_trie().
2341 */
2342 STATIC void
2343 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2344                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2345                           U32 depth)
2346 {
2347     U32 state;
2348     U16 charid;
2349     SV *sv=sv_newmortal();
2350     int colwidth= widecharmap ? 6 : 4;
2351     GET_RE_DEBUG_FLAGS_DECL;
2352
2353     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2354
2355     /*
2356        print out the table precompression so that we can do a visual check
2357        that they are identical.
2358      */
2359
2360     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2361
2362     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2363         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2364         if ( tmp ) {
2365             Perl_re_printf( aTHX_  "%*s",
2366                 colwidth,
2367                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2368                             PL_colors[0], PL_colors[1],
2369                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2370                             PERL_PV_ESCAPE_FIRSTCHAR
2371                 )
2372             );
2373         }
2374     }
2375
2376     Perl_re_printf( aTHX_ "\n");
2377     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2378
2379     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2380         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2381     }
2382
2383     Perl_re_printf( aTHX_  "\n" );
2384
2385     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2386
2387         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2388             depth+1,
2389             (UV)TRIE_NODENUM( state ) );
2390
2391         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2392             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2393             if (v)
2394                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2395             else
2396                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2397         }
2398         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2399             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2400                                             (UV)trie->trans[ state ].check );
2401         } else {
2402             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2403                                             (UV)trie->trans[ state ].check,
2404             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2405         }
2406     }
2407 }
2408
2409 #endif
2410
2411
2412 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2413   startbranch: the first branch in the whole branch sequence
2414   first      : start branch of sequence of branch-exact nodes.
2415                May be the same as startbranch
2416   last       : Thing following the last branch.
2417                May be the same as tail.
2418   tail       : item following the branch sequence
2419   count      : words in the sequence
2420   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2421   depth      : indent depth
2422
2423 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2424
2425 A trie is an N'ary tree where the branches are determined by digital
2426 decomposition of the key. IE, at the root node you look up the 1st character and
2427 follow that branch repeat until you find the end of the branches. Nodes can be
2428 marked as "accepting" meaning they represent a complete word. Eg:
2429
2430   /he|she|his|hers/
2431
2432 would convert into the following structure. Numbers represent states, letters
2433 following numbers represent valid transitions on the letter from that state, if
2434 the number is in square brackets it represents an accepting state, otherwise it
2435 will be in parenthesis.
2436
2437       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2438       |    |
2439       |   (2)
2440       |    |
2441      (1)   +-i->(6)-+-s->[7]
2442       |
2443       +-s->(3)-+-h->(4)-+-e->[5]
2444
2445       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2446
2447 This shows that when matching against the string 'hers' we will begin at state 1
2448 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2449 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2450 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2451 single traverse. We store a mapping from accepting to state to which word was
2452 matched, and then when we have multiple possibilities we try to complete the
2453 rest of the regex in the order in which they occurred in the alternation.
2454
2455 The only prior NFA like behaviour that would be changed by the TRIE support is
2456 the silent ignoring of duplicate alternations which are of the form:
2457
2458  / (DUPE|DUPE) X? (?{ ... }) Y /x
2459
2460 Thus EVAL blocks following a trie may be called a different number of times with
2461 and without the optimisation. With the optimisations dupes will be silently
2462 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2463 the following demonstrates:
2464
2465  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2466
2467 which prints out 'word' three times, but
2468
2469  'words'=~/(word|word|word)(?{ print $1 })S/
2470
2471 which doesnt print it out at all. This is due to other optimisations kicking in.
2472
2473 Example of what happens on a structural level:
2474
2475 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2476
2477    1: CURLYM[1] {1,32767}(18)
2478    5:   BRANCH(8)
2479    6:     EXACT <ac>(16)
2480    8:   BRANCH(11)
2481    9:     EXACT <ad>(16)
2482   11:   BRANCH(14)
2483   12:     EXACT <ab>(16)
2484   16:   SUCCEED(0)
2485   17:   NOTHING(18)
2486   18: END(0)
2487
2488 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2489 and should turn into:
2490
2491    1: CURLYM[1] {1,32767}(18)
2492    5:   TRIE(16)
2493         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2494           <ac>
2495           <ad>
2496           <ab>
2497   16:   SUCCEED(0)
2498   17:   NOTHING(18)
2499   18: END(0)
2500
2501 Cases where tail != last would be like /(?foo|bar)baz/:
2502
2503    1: BRANCH(4)
2504    2:   EXACT <foo>(8)
2505    4: BRANCH(7)
2506    5:   EXACT <bar>(8)
2507    7: TAIL(8)
2508    8: EXACT <baz>(10)
2509   10: END(0)
2510
2511 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2512 and would end up looking like:
2513
2514     1: TRIE(8)
2515       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2516         <foo>
2517         <bar>
2518    7: TAIL(8)
2519    8: EXACT <baz>(10)
2520   10: END(0)
2521
2522     d = uvchr_to_utf8_flags(d, uv, 0);
2523
2524 is the recommended Unicode-aware way of saying
2525
2526     *(d++) = uv;
2527 */
2528
2529 #define TRIE_STORE_REVCHAR(val)                                            \
2530     STMT_START {                                                           \
2531         if (UTF) {                                                         \
2532             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2533             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2534             unsigned char *const kapow = uvchr_to_utf8(flrbbbbb, val);     \
2535             *kapow = '\0';                                                 \
2536             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2537             SvPOK_on(zlopp);                                               \
2538             SvUTF8_on(zlopp);                                              \
2539             av_push(revcharmap, zlopp);                                    \
2540         } else {                                                           \
2541             char ooooff = (char)val;                                           \
2542             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2543         }                                                                  \
2544         } STMT_END
2545
2546 /* This gets the next character from the input, folding it if not already
2547  * folded. */
2548 #define TRIE_READ_CHAR STMT_START {                                           \
2549     wordlen++;                                                                \
2550     if ( UTF ) {                                                              \
2551         /* if it is UTF then it is either already folded, or does not need    \
2552          * folding */                                                         \
2553         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2554     }                                                                         \
2555     else if (folder == PL_fold_latin1) {                                      \
2556         /* This folder implies Unicode rules, which in the range expressible  \
2557          *  by not UTF is the lower case, with the two exceptions, one of     \
2558          *  which should have been taken care of before calling this */       \
2559         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2560         uvc = toLOWER_L1(*uc);                                                \
2561         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2562         len = 1;                                                              \
2563     } else {                                                                  \
2564         /* raw data, will be folded later if needed */                        \
2565         uvc = (U32)*uc;                                                       \
2566         len = 1;                                                              \
2567     }                                                                         \
2568 } STMT_END
2569
2570
2571
2572 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2573     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2574         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2575         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2576         TRIE_LIST_LEN( state ) = ging;                          \
2577     }                                                           \
2578     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2579     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2580     TRIE_LIST_CUR( state )++;                                   \
2581 } STMT_END
2582
2583 #define TRIE_LIST_NEW(state) STMT_START {                       \
2584     Newx( trie->states[ state ].trans.list,                     \
2585         4, reg_trie_trans_le );                                 \
2586      TRIE_LIST_CUR( state ) = 1;                                \
2587      TRIE_LIST_LEN( state ) = 4;                                \
2588 } STMT_END
2589
2590 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2591     U16 dupe= trie->states[ state ].wordnum;                    \
2592     regnode * const noper_next = regnext( noper );              \
2593                                                                 \
2594     DEBUG_r({                                                   \
2595         /* store the word for dumping */                        \
2596         SV* tmp;                                                \
2597         if (OP(noper) != NOTHING)                               \
2598             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2599         else                                                    \
2600             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2601         av_push( trie_words, tmp );                             \
2602     });                                                         \
2603                                                                 \
2604     curword++;                                                  \
2605     trie->wordinfo[curword].prev   = 0;                         \
2606     trie->wordinfo[curword].len    = wordlen;                   \
2607     trie->wordinfo[curword].accept = state;                     \
2608                                                                 \
2609     if ( noper_next < tail ) {                                  \
2610         if (!trie->jump)                                        \
2611             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2612                                                  sizeof(U16) ); \
2613         trie->jump[curword] = (U16)(noper_next - convert);      \
2614         if (!jumper)                                            \
2615             jumper = noper_next;                                \
2616         if (!nextbranch)                                        \
2617             nextbranch= regnext(cur);                           \
2618     }                                                           \
2619                                                                 \
2620     if ( dupe ) {                                               \
2621         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2622         /* chain, so that when the bits of chain are later    */\
2623         /* linked together, the dups appear in the chain      */\
2624         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2625         trie->wordinfo[dupe].prev = curword;                    \
2626     } else {                                                    \
2627         /* we haven't inserted this word yet.                */ \
2628         trie->states[ state ].wordnum = curword;                \
2629     }                                                           \
2630 } STMT_END
2631
2632
2633 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2634      ( ( base + charid >=  ucharcount                                   \
2635          && base + charid < ubound                                      \
2636          && state == trie->trans[ base - ucharcount + charid ].check    \
2637          && trie->trans[ base - ucharcount + charid ].next )            \
2638            ? trie->trans[ base - ucharcount + charid ].next             \
2639            : ( state==1 ? special : 0 )                                 \
2640       )
2641
2642 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2643 STMT_START {                                                \
2644     TRIE_BITMAP_SET(trie, uvc);                             \
2645     /* store the folded codepoint */                        \
2646     if ( folder )                                           \
2647         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2648                                                             \
2649     if ( !UTF ) {                                           \
2650         /* store first byte of utf8 representation of */    \
2651         /* variant codepoints */                            \
2652         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2653             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2654         }                                                   \
2655     }                                                       \
2656 } STMT_END
2657 #define MADE_TRIE       1
2658 #define MADE_JUMP_TRIE  2
2659 #define MADE_EXACT_TRIE 4
2660
2661 STATIC I32
2662 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2663                   regnode *first, regnode *last, regnode *tail,
2664                   U32 word_count, U32 flags, U32 depth)
2665 {
2666     /* first pass, loop through and scan words */
2667     reg_trie_data *trie;
2668     HV *widecharmap = NULL;
2669     AV *revcharmap = newAV();
2670     regnode *cur;
2671     STRLEN len = 0;
2672     UV uvc = 0;
2673     U16 curword = 0;
2674     U32 next_alloc = 0;
2675     regnode *jumper = NULL;
2676     regnode *nextbranch = NULL;
2677     regnode *convert = NULL;
2678     U32 *prev_states; /* temp array mapping each state to previous one */
2679     /* we just use folder as a flag in utf8 */
2680     const U8 * folder = NULL;
2681
2682     /* in the below add_data call we are storing either 'tu' or 'tuaa'
2683      * which stands for one trie structure, one hash, optionally followed
2684      * by two arrays */
2685 #ifdef DEBUGGING
2686     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuaa"));
2687     AV *trie_words = NULL;
2688     /* along with revcharmap, this only used during construction but both are
2689      * useful during debugging so we store them in the struct when debugging.
2690      */
2691 #else
2692     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2693     STRLEN trie_charcount=0;
2694 #endif
2695     SV *re_trie_maxbuff;
2696     GET_RE_DEBUG_FLAGS_DECL;
2697
2698     PERL_ARGS_ASSERT_MAKE_TRIE;
2699 #ifndef DEBUGGING
2700     PERL_UNUSED_ARG(depth);
2701 #endif
2702
2703     switch (flags) {
2704         case EXACT: case EXACT_ONLY8: case EXACTL: break;
2705         case EXACTFAA:
2706         case EXACTFUP:
2707         case EXACTFU:
2708         case EXACTFLU8: folder = PL_fold_latin1; break;
2709         case EXACTF:  folder = PL_fold; break;
2710         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2711     }
2712
2713     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2714     trie->refcount = 1;
2715     trie->startstate = 1;
2716     trie->wordcount = word_count;
2717     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2718     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2719     if (flags == EXACT || flags == EXACT_ONLY8 || flags == EXACTL)
2720         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2721     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2722                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2723
2724     DEBUG_r({
2725         trie_words = newAV();
2726     });
2727
2728     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, GV_ADD);
2729     assert(re_trie_maxbuff);
2730     if (!SvIOK(re_trie_maxbuff)) {
2731         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2732     }
2733     DEBUG_TRIE_COMPILE_r({
2734         Perl_re_indentf( aTHX_
2735           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2736           depth+1,
2737           REG_NODE_NUM(startbranch), REG_NODE_NUM(first),
2738           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2739     });
2740
2741    /* Find the node we are going to overwrite */
2742     if ( first == startbranch && OP( last ) != BRANCH ) {
2743         /* whole branch chain */
2744         convert = first;
2745     } else {
2746         /* branch sub-chain */
2747         convert = NEXTOPER( first );
2748     }
2749
2750     /*  -- First loop and Setup --
2751
2752        We first traverse the branches and scan each word to determine if it
2753        contains widechars, and how many unique chars there are, this is
2754        important as we have to build a table with at least as many columns as we
2755        have unique chars.
2756
2757        We use an array of integers to represent the character codes 0..255
2758        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2759        the native representation of the character value as the key and IV's for
2760        the coded index.
2761
2762        *TODO* If we keep track of how many times each character is used we can
2763        remap the columns so that the table compression later on is more
2764        efficient in terms of memory by ensuring the most common value is in the
2765        middle and the least common are on the outside.  IMO this would be better
2766        than a most to least common mapping as theres a decent chance the most
2767        common letter will share a node with the least common, meaning the node
2768        will not be compressible. With a middle is most common approach the worst
2769        case is when we have the least common nodes twice.
2770
2771      */
2772
2773     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2774         regnode *noper = NEXTOPER( cur );
2775         const U8 *uc;
2776         const U8 *e;
2777         int foldlen = 0;
2778         U32 wordlen      = 0;         /* required init */
2779         STRLEN minchars = 0;
2780         STRLEN maxchars = 0;
2781         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2782                                                bitmap?*/
2783
2784         if (OP(noper) == NOTHING) {
2785             /* skip past a NOTHING at the start of an alternation
2786              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2787              */
2788             regnode *noper_next= regnext(noper);
2789             if (noper_next < tail)
2790                 noper= noper_next;
2791         }
2792
2793         if (    noper < tail
2794             && (    OP(noper) == flags
2795                 || (flags == EXACT && OP(noper) == EXACT_ONLY8)
2796                 || (flags == EXACTFU && (   OP(noper) == EXACTFU_ONLY8
2797                                          || OP(noper) == EXACTFUP))))
2798         {
2799             uc= (U8*)STRING(noper);
2800             e= uc + STR_LEN(noper);
2801         } else {
2802             trie->minlen= 0;
2803             continue;
2804         }
2805
2806
2807         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2808             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2809                                           regardless of encoding */
2810             if (OP( noper ) == EXACTFUP) {
2811                 /* false positives are ok, so just set this */
2812                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2813             }
2814         }
2815
2816         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2817                                            branch */
2818             TRIE_CHARCOUNT(trie)++;
2819             TRIE_READ_CHAR;
2820
2821             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2822              * is in effect.  Under /i, this character can match itself, or
2823              * anything that folds to it.  If not under /i, it can match just
2824              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2825              * all fold to k, and all are single characters.   But some folds
2826              * expand to more than one character, so for example LATIN SMALL
2827              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2828              * the string beginning at 'uc' is 'ffi', it could be matched by
2829              * three characters, or just by the one ligature character. (It
2830              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2831              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2832              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2833              * match.)  The trie needs to know the minimum and maximum number
2834              * of characters that could match so that it can use size alone to
2835              * quickly reject many match attempts.  The max is simple: it is
2836              * the number of folded characters in this branch (since a fold is
2837              * never shorter than what folds to it. */
2838
2839             maxchars++;
2840
2841             /* And the min is equal to the max if not under /i (indicated by
2842              * 'folder' being NULL), or there are no multi-character folds.  If
2843              * there is a multi-character fold, the min is incremented just
2844              * once, for the character that folds to the sequence.  Each
2845              * character in the sequence needs to be added to the list below of
2846              * characters in the trie, but we count only the first towards the
2847              * min number of characters needed.  This is done through the
2848              * variable 'foldlen', which is returned by the macros that look
2849              * for these sequences as the number of bytes the sequence
2850              * occupies.  Each time through the loop, we decrement 'foldlen' by
2851              * how many bytes the current char occupies.  Only when it reaches
2852              * 0 do we increment 'minchars' or look for another multi-character
2853              * sequence. */
2854             if (folder == NULL) {
2855                 minchars++;
2856             }
2857             else if (foldlen > 0) {
2858                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2859             }
2860             else {
2861                 minchars++;
2862
2863                 /* See if *uc is the beginning of a multi-character fold.  If
2864                  * so, we decrement the length remaining to look at, to account
2865                  * for the current character this iteration.  (We can use 'uc'
2866                  * instead of the fold returned by TRIE_READ_CHAR because for
2867                  * non-UTF, the latin1_safe macro is smart enough to account
2868                  * for all the unfolded characters, and because for UTF, the
2869                  * string will already have been folded earlier in the
2870                  * compilation process */
2871                 if (UTF) {
2872                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2873                         foldlen -= UTF8SKIP(uc);
2874                     }
2875                 }
2876                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2877                     foldlen--;
2878                 }
2879             }
2880
2881             /* The current character (and any potential folds) should be added
2882              * to the possible matching characters for this position in this
2883              * branch */
2884             if ( uvc < 256 ) {
2885                 if ( folder ) {
2886                     U8 folded= folder[ (U8) uvc ];
2887                     if ( !trie->charmap[ folded ] ) {
2888                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2889                         TRIE_STORE_REVCHAR( folded );
2890                     }
2891                 }
2892                 if ( !trie->charmap[ uvc ] ) {
2893                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2894                     TRIE_STORE_REVCHAR( uvc );
2895                 }
2896                 if ( set_bit ) {
2897                     /* store the codepoint in the bitmap, and its folded
2898                      * equivalent. */
2899                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2900                     set_bit = 0; /* We've done our bit :-) */
2901                 }
2902             } else {
2903
2904                 /* XXX We could come up with the list of code points that fold
2905                  * to this using PL_utf8_foldclosures, except not for
2906                  * multi-char folds, as there may be multiple combinations
2907                  * there that could work, which needs to wait until runtime to
2908                  * resolve (The comment about LIGATURE FFI above is such an
2909                  * example */
2910
2911                 SV** svpp;
2912                 if ( !widecharmap )
2913                     widecharmap = newHV();
2914
2915                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2916
2917                 if ( !svpp )
2918                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2919
2920                 if ( !SvTRUE( *svpp ) ) {
2921                     sv_setiv( *svpp, ++trie->uniquecharcount );
2922                     TRIE_STORE_REVCHAR(uvc);
2923                 }
2924             }
2925         } /* end loop through characters in this branch of the trie */
2926
2927         /* We take the min and max for this branch and combine to find the min
2928          * and max for all branches processed so far */
2929         if( cur == first ) {
2930             trie->minlen = minchars;
2931             trie->maxlen = maxchars;
2932         } else if (minchars < trie->minlen) {
2933             trie->minlen = minchars;
2934         } else if (maxchars > trie->maxlen) {
2935             trie->maxlen = maxchars;
2936         }
2937     } /* end first pass */
2938     DEBUG_TRIE_COMPILE_r(
2939         Perl_re_indentf( aTHX_
2940                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2941                 depth+1,
2942                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2943                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2944                 (int)trie->minlen, (int)trie->maxlen )
2945     );
2946
2947     /*
2948         We now know what we are dealing with in terms of unique chars and
2949         string sizes so we can calculate how much memory a naive
2950         representation using a flat table  will take. If it's over a reasonable
2951         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2952         conservative but potentially much slower representation using an array
2953         of lists.
2954
2955         At the end we convert both representations into the same compressed
2956         form that will be used in regexec.c for matching with. The latter
2957         is a form that cannot be used to construct with but has memory
2958         properties similar to the list form and access properties similar
2959         to the table form making it both suitable for fast searches and
2960         small enough that its feasable to store for the duration of a program.
2961
2962         See the comment in the code where the compressed table is produced
2963         inplace from the flat tabe representation for an explanation of how
2964         the compression works.
2965
2966     */
2967
2968
2969     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2970     prev_states[1] = 0;
2971
2972     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2973                                                     > SvIV(re_trie_maxbuff) )
2974     {
2975         /*
2976             Second Pass -- Array Of Lists Representation
2977
2978             Each state will be represented by a list of charid:state records
2979             (reg_trie_trans_le) the first such element holds the CUR and LEN
2980             points of the allocated array. (See defines above).
2981
2982             We build the initial structure using the lists, and then convert
2983             it into the compressed table form which allows faster lookups
2984             (but cant be modified once converted).
2985         */
2986
2987         STRLEN transcount = 1;
2988
2989         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
2990             depth+1));
2991
2992         trie->states = (reg_trie_state *)
2993             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2994                                   sizeof(reg_trie_state) );
2995         TRIE_LIST_NEW(1);
2996         next_alloc = 2;
2997
2998         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2999
3000             regnode *noper   = NEXTOPER( cur );
3001             U32 state        = 1;         /* required init */
3002             U16 charid       = 0;         /* sanity init */
3003             U32 wordlen      = 0;         /* required init */
3004
3005             if (OP(noper) == NOTHING) {
3006                 regnode *noper_next= regnext(noper);
3007                 if (noper_next < tail)
3008                     noper= noper_next;
3009             }
3010
3011             if (    noper < tail
3012                 && (    OP(noper) == flags
3013                     || (flags == EXACT && OP(noper) == EXACT_ONLY8)
3014                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_ONLY8
3015                                              || OP(noper) == EXACTFUP))))
3016             {
3017                 const U8 *uc= (U8*)STRING(noper);
3018                 const U8 *e= uc + STR_LEN(noper);
3019
3020                 for ( ; uc < e ; uc += len ) {
3021
3022                     TRIE_READ_CHAR;
3023
3024                     if ( uvc < 256 ) {
3025                         charid = trie->charmap[ uvc ];
3026                     } else {
3027                         SV** const svpp = hv_fetch( widecharmap,
3028                                                     (char*)&uvc,
3029                                                     sizeof( UV ),
3030                                                     0);
3031                         if ( !svpp ) {
3032                             charid = 0;
3033                         } else {
3034                             charid=(U16)SvIV( *svpp );
3035                         }
3036                     }
3037                     /* charid is now 0 if we dont know the char read, or
3038                      * nonzero if we do */
3039                     if ( charid ) {
3040
3041                         U16 check;
3042                         U32 newstate = 0;
3043
3044                         charid--;
3045                         if ( !trie->states[ state ].trans.list ) {
3046                             TRIE_LIST_NEW( state );
3047                         }
3048                         for ( check = 1;
3049                               check <= TRIE_LIST_USED( state );
3050                               check++ )
3051                         {
3052                             if ( TRIE_LIST_ITEM( state, check ).forid
3053                                                                     == charid )
3054                             {
3055                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
3056                                 break;
3057                             }
3058                         }
3059                         if ( ! newstate ) {
3060                             newstate = next_alloc++;
3061                             prev_states[newstate] = state;
3062                             TRIE_LIST_PUSH( state, charid, newstate );
3063                             transcount++;
3064                         }
3065                         state = newstate;
3066                     } else {
3067                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3068                     }
3069                 }
3070             }
3071             TRIE_HANDLE_WORD(state);
3072
3073         } /* end second pass */
3074
3075         /* next alloc is the NEXT state to be allocated */
3076         trie->statecount = next_alloc;
3077         trie->states = (reg_trie_state *)
3078             PerlMemShared_realloc( trie->states,
3079                                    next_alloc
3080                                    * sizeof(reg_trie_state) );
3081
3082         /* and now dump it out before we compress it */
3083         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
3084                                                          revcharmap, next_alloc,
3085                                                          depth+1)
3086         );
3087
3088         trie->trans = (reg_trie_trans *)
3089             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
3090         {
3091             U32 state;
3092             U32 tp = 0;
3093             U32 zp = 0;
3094
3095
3096             for( state=1 ; state < next_alloc ; state ++ ) {
3097                 U32 base=0;
3098
3099                 /*
3100                 DEBUG_TRIE_COMPILE_MORE_r(
3101                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
3102                 );
3103                 */
3104
3105                 if (trie->states[state].trans.list) {
3106                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
3107                     U16 maxid=minid;
3108                     U16 idx;
3109
3110                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3111                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
3112                         if ( forid < minid ) {
3113                             minid=forid;
3114                         } else if ( forid > maxid ) {
3115                             maxid=forid;
3116                         }
3117                     }
3118                     if ( transcount < tp + maxid - minid + 1) {
3119                         transcount *= 2;
3120                         trie->trans = (reg_trie_trans *)
3121                             PerlMemShared_realloc( trie->trans,
3122                                                      transcount
3123                                                      * sizeof(reg_trie_trans) );
3124                         Zero( trie->trans + (transcount / 2),
3125                               transcount / 2,
3126                               reg_trie_trans );
3127                     }
3128                     base = trie->uniquecharcount + tp - minid;
3129                     if ( maxid == minid ) {
3130                         U32 set = 0;
3131                         for ( ; zp < tp ; zp++ ) {
3132                             if ( ! trie->trans[ zp ].next ) {
3133                                 base = trie->uniquecharcount + zp - minid;
3134                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
3135                                                                    1).newstate;
3136                                 trie->trans[ zp ].check = state;
3137                                 set = 1;
3138                                 break;
3139                             }
3140                         }
3141                         if ( !set ) {
3142                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
3143                                                                    1).newstate;
3144                             trie->trans[ tp ].check = state;
3145                             tp++;
3146                             zp = tp;
3147                         }
3148                     } else {
3149                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3150                             const U32 tid = base
3151                                            - trie->uniquecharcount
3152                                            + TRIE_LIST_ITEM( state, idx ).forid;
3153                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
3154                                                                 idx ).newstate;
3155                             trie->trans[ tid ].check = state;
3156                         }
3157                         tp += ( maxid - minid + 1 );
3158                     }
3159                     Safefree(trie->states[ state ].trans.list);
3160                 }
3161                 /*
3162                 DEBUG_TRIE_COMPILE_MORE_r(
3163                     Perl_re_printf( aTHX_  " base: %d\n",base);
3164                 );
3165                 */
3166                 trie->states[ state ].trans.base=base;
3167             }
3168             trie->lasttrans = tp + 1;
3169         }
3170     } else {
3171         /*
3172            Second Pass -- Flat Table Representation.
3173
3174            we dont use the 0 slot of either trans[] or states[] so we add 1 to
3175            each.  We know that we will need Charcount+1 trans at most to store
3176            the data (one row per char at worst case) So we preallocate both
3177            structures assuming worst case.
3178
3179            We then construct the trie using only the .next slots of the entry
3180            structs.
3181
3182            We use the .check field of the first entry of the node temporarily
3183            to make compression both faster and easier by keeping track of how
3184            many non zero fields are in the node.
3185
3186            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
3187            transition.
3188
3189            There are two terms at use here: state as a TRIE_NODEIDX() which is
3190            a number representing the first entry of the node, and state as a
3191            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
3192            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
3193            if there are 2 entrys per node. eg:
3194
3195              A B       A B
3196           1. 2 4    1. 3 7
3197           2. 0 3    3. 0 5
3198           3. 0 0    5. 0 0
3199           4. 0 0    7. 0 0
3200
3201            The table is internally in the right hand, idx form. However as we
3202            also have to deal with the states array which is indexed by nodenum
3203            we have to use TRIE_NODENUM() to convert.
3204
3205         */
3206         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
3207             depth+1));
3208
3209         trie->trans = (reg_trie_trans *)
3210             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
3211                                   * trie->uniquecharcount + 1,
3212                                   sizeof(reg_trie_trans) );
3213         trie->states = (reg_trie_state *)
3214             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3215                                   sizeof(reg_trie_state) );
3216         next_alloc = trie->uniquecharcount + 1;
3217
3218
3219         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3220
3221             regnode *noper   = NEXTOPER( cur );
3222
3223             U32 state        = 1;         /* required init */
3224
3225             U16 charid       = 0;         /* sanity init */
3226             U32 accept_state = 0;         /* sanity init */
3227
3228             U32 wordlen      = 0;         /* required init */
3229
3230             if (OP(noper) == NOTHING) {
3231                 regnode *noper_next= regnext(noper);
3232                 if (noper_next < tail)
3233                     noper= noper_next;
3234             }
3235
3236             if (    noper < tail
3237                 && (    OP(noper) == flags
3238                     || (flags == EXACT && OP(noper) == EXACT_ONLY8)
3239                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_ONLY8
3240                                              || OP(noper) == EXACTFUP))))
3241             {
3242                 const U8 *uc= (U8*)STRING(noper);
3243                 const U8 *e= uc + STR_LEN(noper);
3244
3245                 for ( ; uc < e ; uc += len ) {
3246
3247                     TRIE_READ_CHAR;
3248
3249                     if ( uvc < 256 ) {
3250                         charid = trie->charmap[ uvc ];
3251                     } else {
3252                         SV* const * const svpp = hv_fetch( widecharmap,
3253                                                            (char*)&uvc,
3254                                                            sizeof( UV ),
3255                                                            0);
3256                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3257                     }
3258                     if ( charid ) {
3259                         charid--;
3260                         if ( !trie->trans[ state + charid ].next ) {
3261                             trie->trans[ state + charid ].next = next_alloc;
3262                             trie->trans[ state ].check++;
3263                             prev_states[TRIE_NODENUM(next_alloc)]
3264                                     = TRIE_NODENUM(state);
3265                             next_alloc += trie->uniquecharcount;
3266                         }
3267                         state = trie->trans[ state + charid ].next;
3268                     } else {
3269                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3270                     }
3271                     /* charid is now 0 if we dont know the char read, or
3272                      * nonzero if we do */
3273                 }
3274             }
3275             accept_state = TRIE_NODENUM( state );
3276             TRIE_HANDLE_WORD(accept_state);
3277
3278         } /* end second pass */
3279
3280         /* and now dump it out before we compress it */
3281         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3282                                                           revcharmap,
3283                                                           next_alloc, depth+1));
3284
3285         {
3286         /*
3287            * Inplace compress the table.*
3288
3289            For sparse data sets the table constructed by the trie algorithm will
3290            be mostly 0/FAIL transitions or to put it another way mostly empty.
3291            (Note that leaf nodes will not contain any transitions.)
3292
3293            This algorithm compresses the tables by eliminating most such
3294            transitions, at the cost of a modest bit of extra work during lookup:
3295
3296            - Each states[] entry contains a .base field which indicates the
3297            index in the state[] array wheres its transition data is stored.
3298
3299            - If .base is 0 there are no valid transitions from that node.
3300
3301            - If .base is nonzero then charid is added to it to find an entry in
3302            the trans array.
3303
3304            -If trans[states[state].base+charid].check!=state then the
3305            transition is taken to be a 0/Fail transition. Thus if there are fail
3306            transitions at the front of the node then the .base offset will point
3307            somewhere inside the previous nodes data (or maybe even into a node
3308            even earlier), but the .check field determines if the transition is
3309            valid.
3310
3311            XXX - wrong maybe?
3312            The following process inplace converts the table to the compressed
3313            table: We first do not compress the root node 1,and mark all its
3314            .check pointers as 1 and set its .base pointer as 1 as well. This
3315            allows us to do a DFA construction from the compressed table later,
3316            and ensures that any .base pointers we calculate later are greater
3317            than 0.
3318
3319            - We set 'pos' to indicate the first entry of the second node.
3320
3321            - We then iterate over the columns of the node, finding the first and
3322            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3323            and set the .check pointers accordingly, and advance pos
3324            appropriately and repreat for the next node. Note that when we copy
3325            the next pointers we have to convert them from the original
3326            NODEIDX form to NODENUM form as the former is not valid post
3327            compression.
3328
3329            - If a node has no transitions used we mark its base as 0 and do not
3330            advance the pos pointer.
3331
3332            - If a node only has one transition we use a second pointer into the
3333            structure to fill in allocated fail transitions from other states.
3334            This pointer is independent of the main pointer and scans forward
3335            looking for null transitions that are allocated to a state. When it
3336            finds one it writes the single transition into the "hole".  If the
3337            pointer doesnt find one the single transition is appended as normal.
3338
3339            - Once compressed we can Renew/realloc the structures to release the
3340            excess space.
3341
3342            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3343            specifically Fig 3.47 and the associated pseudocode.
3344
3345            demq
3346         */
3347         const U32 laststate = TRIE_NODENUM( next_alloc );
3348         U32 state, charid;
3349         U32 pos = 0, zp=0;
3350         trie->statecount = laststate;
3351
3352         for ( state = 1 ; state < laststate ; state++ ) {
3353             U8 flag = 0;
3354             const U32 stateidx = TRIE_NODEIDX( state );
3355             const U32 o_used = trie->trans[ stateidx ].check;
3356             U32 used = trie->trans[ stateidx ].check;
3357             trie->trans[ stateidx ].check = 0;
3358
3359             for ( charid = 0;
3360                   used && charid < trie->uniquecharcount;
3361                   charid++ )
3362             {
3363                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3364                     if ( trie->trans[ stateidx + charid ].next ) {
3365                         if (o_used == 1) {
3366                             for ( ; zp < pos ; zp++ ) {
3367                                 if ( ! trie->trans[ zp ].next ) {
3368                                     break;
3369                                 }
3370                             }
3371                             trie->states[ state ].trans.base
3372                                                     = zp
3373                                                       + trie->uniquecharcount
3374                                                       - charid ;
3375                             trie->trans[ zp ].next
3376                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3377                                                              + charid ].next );
3378                             trie->trans[ zp ].check = state;
3379                             if ( ++zp > pos ) pos = zp;
3380                             break;
3381                         }
3382                         used--;
3383                     }
3384                     if ( !flag ) {
3385                         flag = 1;
3386                         trie->states[ state ].trans.base
3387                                        = pos + trie->uniquecharcount - charid ;
3388                     }
3389                     trie->trans[ pos ].next
3390                         = SAFE_TRIE_NODENUM(
3391                                        trie->trans[ stateidx + charid ].next );
3392                     trie->trans[ pos ].check = state;
3393                     pos++;
3394                 }
3395             }
3396         }
3397         trie->lasttrans = pos + 1;
3398         trie->states = (reg_trie_state *)
3399             PerlMemShared_realloc( trie->states, laststate
3400                                    * sizeof(reg_trie_state) );
3401         DEBUG_TRIE_COMPILE_MORE_r(
3402             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3403                 depth+1,
3404                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3405                        + 1 ),
3406                 (IV)next_alloc,
3407                 (IV)pos,
3408                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3409             );
3410
3411         } /* end table compress */
3412     }
3413     DEBUG_TRIE_COMPILE_MORE_r(
3414             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3415                 depth+1,
3416                 (UV)trie->statecount,
3417                 (UV)trie->lasttrans)
3418     );
3419     /* resize the trans array to remove unused space */
3420     trie->trans = (reg_trie_trans *)
3421         PerlMemShared_realloc( trie->trans, trie->lasttrans
3422                                * sizeof(reg_trie_trans) );
3423
3424     {   /* Modify the program and insert the new TRIE node */
3425         U8 nodetype =(U8)(flags & 0xFF);
3426         char *str=NULL;
3427
3428 #ifdef DEBUGGING
3429         regnode *optimize = NULL;
3430 #ifdef RE_TRACK_PATTERN_OFFSETS
3431
3432         U32 mjd_offset = 0;
3433         U32 mjd_nodelen = 0;
3434 #endif /* RE_TRACK_PATTERN_OFFSETS */
3435 #endif /* DEBUGGING */
3436         /*
3437            This means we convert either the first branch or the first Exact,
3438            depending on whether the thing following (in 'last') is a branch
3439            or not and whther first is the startbranch (ie is it a sub part of
3440            the alternation or is it the whole thing.)
3441            Assuming its a sub part we convert the EXACT otherwise we convert
3442            the whole branch sequence, including the first.
3443          */
3444         /* Find the node we are going to overwrite */
3445         if ( first != startbranch || OP( last ) == BRANCH ) {
3446             /* branch sub-chain */
3447             NEXT_OFF( first ) = (U16)(last - first);
3448 #ifdef RE_TRACK_PATTERN_OFFSETS
3449             DEBUG_r({
3450                 mjd_offset= Node_Offset((convert));
3451                 mjd_nodelen= Node_Length((convert));
3452             });
3453 #endif
3454             /* whole branch chain */
3455         }
3456 #ifdef RE_TRACK_PATTERN_OFFSETS
3457         else {
3458             DEBUG_r({
3459                 const  regnode *nop = NEXTOPER( convert );
3460                 mjd_offset= Node_Offset((nop));
3461                 mjd_nodelen= Node_Length((nop));
3462             });
3463         }
3464         DEBUG_OPTIMISE_r(
3465             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3466                 depth+1,
3467                 (UV)mjd_offset, (UV)mjd_nodelen)
3468         );
3469 #endif
3470         /* But first we check to see if there is a common prefix we can
3471            split out as an EXACT and put in front of the TRIE node.  */
3472         trie->startstate= 1;
3473         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3474             /* we want to find the first state that has more than
3475              * one transition, if that state is not the first state
3476              * then we have a common prefix which we can remove.
3477              */
3478             U32 state;
3479             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3480                 U32 ofs = 0;
3481                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3482                                        transition, -1 means none */
3483                 U32 count = 0;
3484                 const U32 base = trie->states[ state ].trans.base;
3485
3486                 /* does this state terminate an alternation? */
3487                 if ( trie->states[state].wordnum )
3488                         count = 1;
3489
3490                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3491                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3492                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3493                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3494                     {
3495                         if ( ++count > 1 ) {
3496                             /* we have more than one transition */
3497                             SV **tmp;
3498                             U8 *ch;
3499                             /* if this is the first state there is no common prefix
3500                              * to extract, so we can exit */
3501                             if ( state == 1 ) break;
3502                             tmp = av_fetch( revcharmap, ofs, 0);
3503                             ch = (U8*)SvPV_nolen_const( *tmp );
3504
3505                             /* if we are on count 2 then we need to initialize the
3506                              * bitmap, and store the previous char if there was one
3507                              * in it*/
3508                             if ( count == 2 ) {
3509                                 /* clear the bitmap */
3510                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3511                                 DEBUG_OPTIMISE_r(
3512                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3513                                         depth+1,
3514                                         (UV)state));
3515                                 if (first_ofs >= 0) {
3516                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3517                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3518
3519                                     TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3520                                     DEBUG_OPTIMISE_r(
3521                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3522                                     );
3523                                 }
3524                             }
3525                             /* store the current firstchar in the bitmap */
3526                             TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3527                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3528                         }
3529                         first_ofs = ofs;
3530                     }
3531                 }
3532                 if ( count == 1 ) {
3533                     /* This state has only one transition, its transition is part
3534                      * of a common prefix - we need to concatenate the char it
3535                      * represents to what we have so far. */
3536                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3537                     STRLEN len;
3538                     char *ch = SvPV( *tmp, len );
3539                     DEBUG_OPTIMISE_r({
3540                         SV *sv=sv_newmortal();
3541                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3542                             depth+1,
3543                             (UV)state, (UV)first_ofs,
3544                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3545                                 PL_colors[0], PL_colors[1],
3546                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3547                                 PERL_PV_ESCAPE_FIRSTCHAR
3548                             )
3549                         );
3550                     });
3551                     if ( state==1 ) {
3552                         OP( convert ) = nodetype;
3553                         str=STRING(convert);
3554                         setSTR_LEN(convert, 0);
3555                     }
3556                     setSTR_LEN(convert, STR_LEN(convert) + len);
3557                     while (len--)
3558                         *str++ = *ch++;
3559                 } else {
3560 #ifdef DEBUGGING
3561                     if (state>1)
3562                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3563 #endif
3564                     break;
3565                 }
3566             }
3567             trie->prefixlen = (state-1);
3568             if (str) {
3569                 regnode *n = convert+NODE_SZ_STR(convert);
3570                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3571                 trie->startstate = state;
3572                 trie->minlen -= (state - 1);
3573                 trie->maxlen -= (state - 1);
3574 #ifdef DEBUGGING
3575                /* At least the UNICOS C compiler choked on this
3576                 * being argument to DEBUG_r(), so let's just have
3577                 * it right here. */
3578                if (
3579 #ifdef PERL_EXT_RE_BUILD
3580                    1
3581 #else
3582                    DEBUG_r_TEST
3583 #endif
3584                    ) {
3585                    regnode *fix = convert;
3586                    U32 word = trie->wordcount;
3587 #ifdef RE_TRACK_PATTERN_OFFSETS
3588                    mjd_nodelen++;
3589 #endif
3590                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3591                    while( ++fix < n ) {
3592                        Set_Node_Offset_Length(fix, 0, 0);
3593                    }
3594                    while (word--) {
3595                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3596                        if (tmp) {
3597                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3598                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3599                            else
3600                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3601                        }
3602                    }
3603                }
3604 #endif
3605                 if (trie->maxlen) {
3606                     convert = n;
3607                 } else {
3608                     NEXT_OFF(convert) = (U16)(tail - convert);
3609                     DEBUG_r(optimize= n);
3610                 }
3611             }
3612         }
3613         if (!jumper)
3614             jumper = last;
3615         if ( trie->maxlen ) {
3616             NEXT_OFF( convert ) = (U16)(tail - convert);
3617             ARG_SET( convert, data_slot );
3618             /* Store the offset to the first unabsorbed branch in
3619                jump[0], which is otherwise unused by the jump logic.
3620                We use this when dumping a trie and during optimisation. */
3621             if (trie->jump)
3622                 trie->jump[0] = (U16)(nextbranch - convert);
3623
3624             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3625              *   and there is a bitmap
3626              *   and the first "jump target" node we found leaves enough room
3627              * then convert the TRIE node into a TRIEC node, with the bitmap
3628              * embedded inline in the opcode - this is hypothetically faster.
3629              */
3630             if ( !trie->states[trie->startstate].wordnum
3631                  && trie->bitmap
3632                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3633             {
3634                 OP( convert ) = TRIEC;
3635                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3636                 PerlMemShared_free(trie->bitmap);
3637                 trie->bitmap= NULL;
3638             } else
3639                 OP( convert ) = TRIE;
3640
3641             /* store the type in the flags */
3642             convert->flags = nodetype;
3643             DEBUG_r({
3644             optimize = convert
3645                       + NODE_STEP_REGNODE
3646                       + regarglen[ OP( convert ) ];
3647             });
3648             /* XXX We really should free up the resource in trie now,
3649                    as we won't use them - (which resources?) dmq */
3650         }
3651         /* needed for dumping*/
3652         DEBUG_r(if (optimize) {
3653             regnode *opt = convert;
3654
3655             while ( ++opt < optimize) {
3656                 Set_Node_Offset_Length(opt, 0, 0);
3657             }
3658             /*
3659                 Try to clean up some of the debris left after the
3660                 optimisation.
3661              */
3662             while( optimize < jumper ) {
3663                 Track_Code( mjd_nodelen += Node_Length((optimize)); );
3664                 OP( optimize ) = OPTIMIZED;
3665                 Set_Node_Offset_Length(optimize, 0, 0);
3666                 optimize++;
3667             }
3668             Set_Node_Offset_Length(convert, mjd_offset, mjd_nodelen);
3669         });
3670     } /* end node insert */
3671
3672     /*  Finish populating the prev field of the wordinfo array.  Walk back
3673      *  from each accept state until we find another accept state, and if
3674      *  so, point the first word's .prev field at the second word. If the
3675      *  second already has a .prev field set, stop now. This will be the
3676      *  case either if we've already processed that word's accept state,
3677      *  or that state had multiple words, and the overspill words were
3678      *  already linked up earlier.
3679      */
3680     {
3681         U16 word;
3682         U32 state;
3683         U16 prev;
3684
3685         for (word=1; word <= trie->wordcount; word++) {
3686             prev = 0;
3687             if (trie->wordinfo[word].prev)
3688                 continue;
3689             state = trie->wordinfo[word].accept;
3690             while (state) {
3691                 state = prev_states[state];
3692                 if (!state)
3693                     break;
3694                 prev = trie->states[state].wordnum;
3695                 if (prev)
3696                     break;
3697             }
3698             trie->wordinfo[word].prev = prev;
3699         }
3700         Safefree(prev_states);
3701     }
3702
3703
3704     /* and now dump out the compressed format */
3705     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3706
3707     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3708 #ifdef DEBUGGING
3709     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3710     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3711 #else
3712     SvREFCNT_dec_NN(revcharmap);
3713 #endif
3714     return trie->jump
3715            ? MADE_JUMP_TRIE
3716            : trie->startstate>1
3717              ? MADE_EXACT_TRIE
3718              : MADE_TRIE;
3719 }
3720
3721 STATIC regnode *
3722 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3723 {
3724 /* The Trie is constructed and compressed now so we can build a fail array if
3725  * it's needed
3726
3727    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3728    3.32 in the
3729    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3730    Ullman 1985/88
3731    ISBN 0-201-10088-6
3732
3733    We find the fail state for each state in the trie, this state is the longest
3734    proper suffix of the current state's 'word' that is also a proper prefix of
3735    another word in our trie. State 1 represents the word '' and is thus the
3736    default fail state. This allows the DFA not to have to restart after its
3737    tried and failed a word at a given point, it simply continues as though it
3738    had been matching the other word in the first place.
3739    Consider
3740       'abcdgu'=~/abcdefg|cdgu/
3741    When we get to 'd' we are still matching the first word, we would encounter
3742    'g' which would fail, which would bring us to the state representing 'd' in
3743    the second word where we would try 'g' and succeed, proceeding to match
3744    'cdgu'.
3745  */
3746  /* add a fail transition */
3747     const U32 trie_offset = ARG(source);
3748     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3749     U32 *q;
3750     const U32 ucharcount = trie->uniquecharcount;
3751     const U32 numstates = trie->statecount;
3752     const U32 ubound = trie->lasttrans + ucharcount;
3753     U32 q_read = 0;
3754     U32 q_write = 0;
3755     U32 charid;
3756     U32 base = trie->states[ 1 ].trans.base;
3757     U32 *fail;
3758     reg_ac_data *aho;
3759     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3760     regnode *stclass;
3761     GET_RE_DEBUG_FLAGS_DECL;
3762
3763     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3764     PERL_UNUSED_CONTEXT;
3765 #ifndef DEBUGGING
3766     PERL_UNUSED_ARG(depth);
3767 #endif
3768
3769     if ( OP(source) == TRIE ) {
3770         struct regnode_1 *op = (struct regnode_1 *)
3771             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3772         StructCopy(source, op, struct regnode_1);
3773         stclass = (regnode *)op;
3774     } else {
3775         struct regnode_charclass *op = (struct regnode_charclass *)
3776             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3777         StructCopy(source, op, struct regnode_charclass);
3778         stclass = (regnode *)op;
3779     }
3780     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3781
3782     ARG_SET( stclass, data_slot );
3783     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3784     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3785     aho->trie=trie_offset;
3786     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3787     Copy( trie->states, aho->states, numstates, reg_trie_state );
3788     Newx( q, numstates, U32);
3789     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3790     aho->refcount = 1;
3791     fail = aho->fail;
3792     /* initialize fail[0..1] to be 1 so that we always have
3793        a valid final fail state */
3794     fail[ 0 ] = fail[ 1 ] = 1;
3795
3796     for ( charid = 0; charid < ucharcount ; charid++ ) {
3797         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3798         if ( newstate ) {
3799             q[ q_write ] = newstate;
3800             /* set to point at the root */
3801             fail[ q[ q_write++ ] ]=1;
3802         }
3803     }
3804     while ( q_read < q_write) {
3805         const U32 cur = q[ q_read++ % numstates ];
3806         base = trie->states[ cur ].trans.base;
3807
3808         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3809             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3810             if (ch_state) {
3811                 U32 fail_state = cur;
3812                 U32 fail_base;
3813                 do {
3814                     fail_state = fail[ fail_state ];
3815                     fail_base = aho->states[ fail_state ].trans.base;
3816                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3817
3818                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3819                 fail[ ch_state ] = fail_state;
3820                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3821                 {
3822                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3823                 }
3824                 q[ q_write++ % numstates] = ch_state;
3825             }
3826         }
3827     }
3828     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3829        when we fail in state 1, this allows us to use the
3830        charclass scan to find a valid start char. This is based on the principle
3831        that theres a good chance the string being searched contains lots of stuff
3832        that cant be a start char.
3833      */
3834     fail[ 0 ] = fail[ 1 ] = 0;
3835     DEBUG_TRIE_COMPILE_r({
3836         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3837                       depth, (UV)numstates
3838         );
3839         for( q_read=1; q_read<numstates; q_read++ ) {
3840             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3841         }
3842         Perl_re_printf( aTHX_  "\n");
3843     });
3844     Safefree(q);
3845     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3846     return stclass;
3847 }
3848
3849
3850 /* The below joins as many adjacent EXACTish nodes as possible into a single
3851  * one.  The regop may be changed if the node(s) contain certain sequences that
3852  * require special handling.  The joining is only done if:
3853  * 1) there is room in the current conglomerated node to entirely contain the
3854  *    next one.
3855  * 2) they are compatible node types
3856  *
3857  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3858  * these get optimized out
3859  *
3860  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3861  * as possible, even if that means splitting an existing node so that its first
3862  * part is moved to the preceeding node.  This would maximise the efficiency of
3863  * memEQ during matching.
3864  *
3865  * If a node is to match under /i (folded), the number of characters it matches
3866  * can be different than its character length if it contains a multi-character
3867  * fold.  *min_subtract is set to the total delta number of characters of the
3868  * input nodes.
3869  *
3870  * And *unfolded_multi_char is set to indicate whether or not the node contains
3871  * an unfolded multi-char fold.  This happens when it won't be known until
3872  * runtime whether the fold is valid or not; namely
3873  *  1) for EXACTF nodes that contain LATIN SMALL LETTER SHARP S, as only if the
3874  *      target string being matched against turns out to be UTF-8 is that fold
3875  *      valid; or
3876  *  2) for EXACTFL nodes whose folding rules depend on the locale in force at
3877  *      runtime.
3878  * (Multi-char folds whose components are all above the Latin1 range are not
3879  * run-time locale dependent, and have already been folded by the time this
3880  * function is called.)
3881  *
3882  * This is as good a place as any to discuss the design of handling these
3883  * multi-character fold sequences.  It's been wrong in Perl for a very long
3884  * time.  There are three code points in Unicode whose multi-character folds
3885  * were long ago discovered to mess things up.  The previous designs for
3886  * dealing with these involved assigning a special node for them.  This
3887  * approach doesn't always work, as evidenced by this example:
3888  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3889  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3890  * would match just the \xDF, it won't be able to handle the case where a
3891  * successful match would have to cross the node's boundary.  The new approach
3892  * that hopefully generally solves the problem generates an EXACTFUP node
3893  * that is "sss" in this case.
3894  *
3895  * It turns out that there are problems with all multi-character folds, and not
3896  * just these three.  Now the code is general, for all such cases.  The
3897  * approach taken is:
3898  * 1)   This routine examines each EXACTFish node that could contain multi-
3899  *      character folded sequences.  Since a single character can fold into
3900  *      such a sequence, the minimum match length for this node is less than
3901  *      the number of characters in the node.  This routine returns in
3902  *      *min_subtract how many characters to subtract from the the actual
3903  *      length of the string to get a real minimum match length; it is 0 if
3904  *      there are no multi-char foldeds.  This delta is used by the caller to
3905  *      adjust the min length of the match, and the delta between min and max,
3906  *      so that the optimizer doesn't reject these possibilities based on size
3907  *      constraints.
3908  *
3909  * 2)   For the sequence involving the LATIN SMALL LETTER SHARP S (U+00DF)
3910  *      under /u, we fold it to 'ss' in regatom(), and in this routine, after
3911  *      joining, we scan for occurrences of the sequence 'ss' in non-UTF-8
3912  *      EXACTFU nodes.  The node type of such nodes is then changed to
3913  *      EXACTFUP, indicating it is problematic, and needs careful handling.
3914  *      (The procedures in step 1) above are sufficient to handle this case in
3915  *      UTF-8 encoded nodes.)  The reason this is problematic is that this is
3916  *      the only case where there is a possible fold length change in non-UTF-8
3917  *      patterns.  By reserving a special node type for problematic cases, the
3918  *      far more common regular EXACTFU nodes can be processed faster.
3919  *      regexec.c takes advantage of this.
3920  *
3921  *      EXACTFUP has been created as a grab-bag for (hopefully uncommon)
3922  *      problematic cases.   These all only occur when the pattern is not
3923  *      UTF-8.  In addition to the 'ss' sequence where there is a possible fold
3924  *      length change, it handles the situation where the string cannot be
3925  *      entirely folded.  The strings in an EXACTFish node are folded as much
3926  *      as possible during compilation in regcomp.c.  This saves effort in
3927  *      regex matching.  By using an EXACTFUP node when it is not possible to
3928  *      fully fold at compile time, regexec.c can know that everything in an
3929  *      EXACTFU node is folded, so folding can be skipped at runtime.  The only
3930  *      case where folding in EXACTFU nodes can't be done at compile time is
3931  *      the presumably uncommon MICRO SIGN, when the pattern isn't UTF-8.  This
3932  *      is because its fold requires UTF-8 to represent.  Thus EXACTFUP nodes
3933  *      handle two very different cases.  Alternatively, there could have been
3934  *      a node type where there are length changes, one for unfolded, and one
3935  *      for both.  If yet another special case needed to be created, the number
3936  *      of required node types would have to go to 7.  khw figures that even
3937  *      though there are plenty of node types to spare, that the maintenance
3938  *      cost wasn't worth the small speedup of doing it that way, especially
3939  *      since he thinks the MICRO SIGN is rarely encountered in practice.
3940  *
3941  *      There are other cases where folding isn't done at compile time, but
3942  *      none of them are under /u, and hence not for EXACTFU nodes.  The folds
3943  *      in EXACTFL nodes aren't known until runtime, and vary as the locale
3944  *      changes.  Some folds in EXACTF depend on if the runtime target string
3945  *      is UTF-8 or not.  (regatom() will create an EXACTFU node even under /di
3946  *      when no fold in it depends on the UTF-8ness of the target string.)
3947  *
3948  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3949  *      validity of the fold won't be known until runtime, and so must remain
3950  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFAA
3951  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3952  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3953  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3954  *      The reason this is a problem is that the optimizer part of regexec.c
3955  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3956  *      that a character in the pattern corresponds to at most a single
3957  *      character in the target string.  (And I do mean character, and not byte
3958  *      here, unlike other parts of the documentation that have never been
3959  *      updated to account for multibyte Unicode.)  Sharp s in EXACTF and
3960  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFAA
3961  *      nodes it can match "\x{17F}\x{17F}".  These, along with other ones in
3962  *      EXACTFL nodes, violate the assumption, and they are the only instances
3963  *      where it is violated.  I'm reluctant to try to change the assumption,
3964  *      as the code involved is impenetrable to me (khw), so instead the code
3965  *      here punts.  This routine examines EXACTFL nodes, and (when the pattern
3966  *      isn't UTF-8) EXACTF and EXACTFAA for such unfolded folds, and returns a
3967  *      boolean indicating whether or not the node contains such a fold.  When
3968  *      it is true, the caller sets a flag that later causes the optimizer in
3969  *      this file to not set values for the floating and fixed string lengths,
3970  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3971  *      assumption.  Thus, there is no optimization based on string lengths for
3972  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3973  *      EXACTF and EXACTFAA nodes that contain the sharp s.  (The reason the
3974  *      assumption is wrong only in these cases is that all other non-UTF-8
3975  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3976  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3977  *      EXACTF nodes because we don't know at compile time if it actually
3978  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3979  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3980  *      always matches; and EXACTFAA where it never does.  In an EXACTFAA node
3981  *      in a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3982  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3983  *      string would require the pattern to be forced into UTF-8, the overhead
3984  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3985  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3986  *      locale.)
3987  *
3988  *      Similarly, the code that generates tries doesn't currently handle
3989  *      not-already-folded multi-char folds, and it looks like a pain to change
3990  *      that.  Therefore, trie generation of EXACTFAA nodes with the sharp s
3991  *      doesn't work.  Instead, such an EXACTFAA is turned into a new regnode,
3992  *      EXACTFAA_NO_TRIE, which the trie code knows not to handle.  Most people
3993  *      using /iaa matching will be doing so almost entirely with ASCII
3994  *      strings, so this should rarely be encountered in practice */
3995
3996 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags)    \
3997     if (PL_regkind[OP(scan)] == EXACT && OP(scan) != LEXACT         \
3998                                       && OP(scan) != LEXACT_ONLY8)  \
3999         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags), NULL, depth+1)
4000
4001 STATIC U32
4002 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
4003                    UV *min_subtract, bool *unfolded_multi_char,
4004                    U32 flags, regnode *val, U32 depth)
4005 {
4006     /* Merge several consecutive EXACTish nodes into one. */
4007
4008     regnode *n = regnext(scan);
4009     U32 stringok = 1;
4010     regnode *next = scan + NODE_SZ_STR(scan);
4011     U32 merged = 0;
4012     U32 stopnow = 0;
4013 #ifdef DEBUGGING
4014     regnode *stop = scan;
4015     GET_RE_DEBUG_FLAGS_DECL;
4016 #else
4017     PERL_UNUSED_ARG(depth);
4018 #endif
4019
4020     PERL_ARGS_ASSERT_JOIN_EXACT;
4021 #ifndef EXPERIMENTAL_INPLACESCAN
4022     PERL_UNUSED_ARG(flags);
4023     PERL_UNUSED_ARG(val);
4024 #endif
4025     DEBUG_PEEP("join", scan, depth, 0);
4026
4027     assert(PL_regkind[OP(scan)] == EXACT);
4028
4029     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
4030      * EXACT ones that are mergeable to the current one. */
4031     while (    n
4032            && (    PL_regkind[OP(n)] == NOTHING
4033                || (stringok && PL_regkind[OP(n)] == EXACT))
4034            && NEXT_OFF(n)
4035            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
4036     {
4037
4038         if (OP(n) == TAIL || n > next)
4039             stringok = 0;
4040         if (PL_regkind[OP(n)] == NOTHING) {
4041             DEBUG_PEEP("skip:", n, depth, 0);
4042             NEXT_OFF(scan) += NEXT_OFF(n);
4043             next = n + NODE_STEP_REGNODE;
4044 #ifdef DEBUGGING
4045             if (stringok)
4046                 stop = n;
4047 #endif
4048             n = regnext(n);
4049         }
4050         else if (stringok) {
4051             const unsigned int oldl = STR_LEN(scan);
4052             regnode * const nnext = regnext(n);
4053
4054             /* XXX I (khw) kind of doubt that this works on platforms (should
4055              * Perl ever run on one) where U8_MAX is above 255 because of lots
4056              * of other assumptions */
4057             /* Don't join if the sum can't fit into a single node */
4058             if (oldl + STR_LEN(n) > U8_MAX)
4059                 break;
4060
4061             /* Joining something that requires UTF-8 with something that
4062              * doesn't, means the result requires UTF-8. */
4063             if (OP(scan) == EXACT && (OP(n) == EXACT_ONLY8)) {
4064                 OP(scan) = EXACT_ONLY8;
4065             }
4066             else if (OP(scan) == EXACT_ONLY8 && (OP(n) == EXACT)) {
4067                 ;   /* join is compatible, no need to change OP */
4068             }
4069             else if ((OP(scan) == EXACTFU) && (OP(n) == EXACTFU_ONLY8)) {
4070                 OP(scan) = EXACTFU_ONLY8;
4071             }
4072             else if ((OP(scan) == EXACTFU_ONLY8) && (OP(n) == EXACTFU)) {
4073                 ;   /* join is compatible, no need to change OP */
4074             }
4075             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU) {
4076                 ;   /* join is compatible, no need to change OP */
4077             }
4078             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU_S_EDGE) {
4079
4080                  /* Under /di, temporary EXACTFU_S_EDGE nodes are generated,
4081                   * which can join with EXACTFU ones.  We check for this case
4082                   * here.  These need to be resolved to either EXACTFU or
4083                   * EXACTF at joining time.  They have nothing in them that
4084                   * would forbid them from being the more desirable EXACTFU
4085                   * nodes except that they begin and/or end with a single [Ss].
4086                   * The reason this is problematic is because they could be
4087                   * joined in this loop with an adjacent node that ends and/or
4088                   * begins with [Ss] which would then form the sequence 'ss',
4089                   * which matches differently under /di than /ui, in which case
4090                   * EXACTFU can't be used.  If the 'ss' sequence doesn't get
4091                   * formed, the nodes get absorbed into any adjacent EXACTFU
4092                   * node.  And if the only adjacent node is EXACTF, they get
4093                   * absorbed into that, under the theory that a longer node is
4094                   * better than two shorter ones, even if one is EXACTFU.  Note
4095                   * that EXACTFU_ONLY8 is generated only for UTF-8 patterns,
4096                   * and the EXACTFU_S_EDGE ones only for non-UTF-8.  */
4097
4098                 if (STRING(n)[STR_LEN(n)-1] == 's') {
4099
4100                     /* Here the joined node would end with 's'.  If the node
4101                      * following the combination is an EXACTF one, it's better to
4102                      * join this trailing edge 's' node with that one, leaving the
4103                      * current one in 'scan' be the more desirable EXACTFU */
4104                     if (OP(nnext) == EXACTF) {
4105                         break;
4106                     }
4107
4108                     OP(scan) = EXACTFU_S_EDGE;
4109
4110                 }   /* Otherwise, the beginning 's' of the 2nd node just
4111                        becomes an interior 's' in 'scan' */
4112             }
4113             else if (OP(scan) == EXACTF && OP(n) == EXACTF) {
4114                 ;   /* join is compatible, no need to change OP */
4115             }
4116             else if (OP(scan) == EXACTF && OP(n) == EXACTFU_S_EDGE) {
4117
4118                 /* EXACTF nodes are compatible for joining with EXACTFU_S_EDGE
4119                  * nodes.  But the latter nodes can be also joined with EXACTFU
4120                  * ones, and that is a better outcome, so if the node following
4121                  * 'n' is EXACTFU, quit now so that those two can be joined
4122                  * later */
4123                 if (OP(nnext) == EXACTFU) {
4124                     break;
4125                 }
4126
4127                 /* The join is compatible, and the combined node will be
4128                  * EXACTF.  (These don't care if they begin or end with 's' */
4129             }
4130             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU_S_EDGE) {
4131                 if (   STRING(scan)[STR_LEN(scan)-1] == 's'
4132                     && STRING(n)[0] == 's')
4133                 {
4134                     /* When combined, we have the sequence 'ss', which means we
4135                      * have to remain /di */
4136                     OP(scan) = EXACTF;
4137                 }
4138             }
4139             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU) {
4140                 if (STRING(n)[0] == 's') {
4141                     ;   /* Here the join is compatible and the combined node
4142                            starts with 's', no need to change OP */
4143                 }
4144                 else {  /* Now the trailing 's' is in the interior */
4145                     OP(scan) = EXACTFU;
4146                 }
4147             }
4148             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTF) {
4149
4150                 /* The join is compatible, and the combined node will be
4151                  * EXACTF.  (These don't care if they begin or end with 's' */
4152                 OP(scan) = EXACTF;
4153             }
4154             else if (OP(scan) != OP(n)) {
4155
4156                 /* The only other compatible joinings are the same node type */
4157                 break;
4158             }
4159
4160             DEBUG_PEEP("merg", n, depth, 0);
4161             merged++;
4162
4163             NEXT_OFF(scan) += NEXT_OFF(n);
4164             setSTR_LEN(scan, STR_LEN(scan) + STR_LEN(n));
4165             next = n + NODE_SZ_STR(n);
4166             /* Now we can overwrite *n : */
4167             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
4168 #ifdef DEBUGGING
4169             stop = next - 1;
4170 #endif
4171             n = nnext;
4172             if (stopnow) break;
4173         }
4174
4175 #ifdef EXPERIMENTAL_INPLACESCAN
4176         if (flags && !NEXT_OFF(n)) {
4177             DEBUG_PEEP("atch", val, depth, 0);
4178             if (reg_off_by_arg[OP(n)]) {
4179                 ARG_SET(n, val - n);
4180             }
4181             else {
4182                 NEXT_OFF(n) = val - n;
4183             }
4184             stopnow = 1;
4185         }
4186 #endif
4187     }
4188
4189     /* This temporary node can now be turned into EXACTFU, and must, as
4190      * regexec.c doesn't handle it */
4191     if (OP(scan) == EXACTFU_S_EDGE) {
4192         OP(scan) = EXACTFU;
4193     }
4194
4195     *min_subtract = 0;
4196     *unfolded_multi_char = FALSE;
4197
4198     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
4199      * can now analyze for sequences of problematic code points.  (Prior to
4200      * this final joining, sequences could have been split over boundaries, and
4201      * hence missed).  The sequences only happen in folding, hence for any
4202      * non-EXACT EXACTish node */
4203     if (OP(scan) != EXACT && OP(scan) != EXACT_ONLY8 && OP(scan) != EXACTL) {
4204         U8* s0 = (U8*) STRING(scan);
4205         U8* s = s0;
4206         U8* s_end = s0 + STR_LEN(scan);
4207
4208         int total_count_delta = 0;  /* Total delta number of characters that
4209                                        multi-char folds expand to */
4210
4211         /* One pass is made over the node's string looking for all the
4212          * possibilities.  To avoid some tests in the loop, there are two main
4213          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
4214          * non-UTF-8 */
4215         if (UTF) {
4216             U8* folded = NULL;
4217
4218             if (OP(scan) == EXACTFL) {
4219                 U8 *d;
4220
4221                 /* An EXACTFL node would already have been changed to another
4222                  * node type unless there is at least one character in it that
4223                  * is problematic; likely a character whose fold definition
4224                  * won't be known until runtime, and so has yet to be folded.
4225                  * For all but the UTF-8 locale, folds are 1-1 in length, but
4226                  * to handle the UTF-8 case, we need to create a temporary
4227                  * folded copy using UTF-8 locale rules in order to analyze it.
4228                  * This is because our macros that look to see if a sequence is
4229                  * a multi-char fold assume everything is folded (otherwise the
4230                  * tests in those macros would be too complicated and slow).
4231                  * Note that here, the non-problematic folds will have already
4232                  * been done, so we can just copy such characters.  We actually
4233                  * don't completely fold the EXACTFL string.  We skip the
4234                  * unfolded multi-char folds, as that would just create work
4235                  * below to figure out the size they already are */
4236
4237                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
4238                 d = folded;
4239                 while (s < s_end) {
4240                     STRLEN s_len = UTF8SKIP(s);
4241                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
4242                         Copy(s, d, s_len, U8);
4243                         d += s_len;
4244                     }
4245                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
4246                         *unfolded_multi_char = TRUE;
4247                         Copy(s, d, s_len, U8);
4248                         d += s_len;
4249                     }
4250                     else if (isASCII(*s)) {
4251                         *(d++) = toFOLD(*s);
4252                     }
4253                     else {
4254                         STRLEN len;
4255                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
4256                         d += len;
4257                     }
4258                     s += s_len;
4259                 }
4260
4261                 /* Point the remainder of the routine to look at our temporary
4262                  * folded copy */
4263                 s = folded;
4264                 s_end = d;
4265             } /* End of creating folded copy of EXACTFL string */
4266
4267             /* Examine the string for a multi-character fold sequence.  UTF-8
4268              * patterns have all characters pre-folded by the time this code is
4269              * executed */
4270             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
4271                                      length sequence we are looking for is 2 */
4272             {
4273                 int count = 0;  /* How many characters in a multi-char fold */
4274                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
4275                 if (! len) {    /* Not a multi-char fold: get next char */
4276                     s += UTF8SKIP(s);
4277                     continue;
4278                 }
4279
4280                 { /* Here is a generic multi-char fold. */
4281                     U8* multi_end  = s + len;
4282
4283                     /* Count how many characters are in it.  In the case of
4284                      * /aa, no folds which contain ASCII code points are
4285                      * allowed, so check for those, and skip if found. */
4286                     if (OP(scan) != EXACTFAA && OP(scan) != EXACTFAA_NO_TRIE) {
4287                         count = utf8_length(s, multi_end);
4288                         s = multi_end;
4289                     }
4290                     else {
4291                         while (s < multi_end) {
4292                             if (isASCII(*s)) {
4293                                 s++;
4294                                 goto next_iteration;
4295                             }
4296                             else {
4297                                 s += UTF8SKIP(s);
4298                             }
4299                             count++;
4300                         }
4301                     }
4302                 }
4303
4304                 /* The delta is how long the sequence is minus 1 (1 is how long
4305                  * the character that folds to the sequence is) */
4306                 total_count_delta += count - 1;
4307               next_iteration: ;
4308             }
4309
4310             /* We created a temporary folded copy of the string in EXACTFL
4311              * nodes.  Therefore we need to be sure it doesn't go below zero,
4312              * as the real string could be shorter */
4313             if (OP(scan) == EXACTFL) {
4314                 int total_chars = utf8_length((U8*) STRING(scan),
4315                                            (U8*) STRING(scan) + STR_LEN(scan));
4316                 if (total_count_delta > total_chars) {
4317                     total_count_delta = total_chars;
4318                 }
4319             }
4320
4321             *min_subtract += total_count_delta;
4322             Safefree(folded);
4323         }
4324         else if (OP(scan) == EXACTFAA) {
4325
4326             /* Non-UTF-8 pattern, EXACTFAA node.  There can't be a multi-char
4327              * fold to the ASCII range (and there are no existing ones in the
4328              * upper latin1 range).  But, as outlined in the comments preceding
4329              * this function, we need to flag any occurrences of the sharp s.
4330              * This character forbids trie formation (because of added
4331              * complexity) */
4332 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
4333    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
4334                                       || UNICODE_DOT_DOT_VERSION > 0)
4335             while (s < s_end) {
4336                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
4337                     OP(scan) = EXACTFAA_NO_TRIE;
4338                     *unfolded_multi_char = TRUE;
4339                     break;
4340                 }
4341                 s++;
4342             }
4343         }
4344         else {
4345
4346             /* Non-UTF-8 pattern, not EXACTFAA node.  Look for the multi-char
4347              * folds that are all Latin1.  As explained in the comments
4348              * preceding this function, we look also for the sharp s in EXACTF
4349              * and EXACTFL nodes; it can be in the final position.  Otherwise
4350              * we can stop looking 1 byte earlier because have to find at least
4351              * two characters for a multi-fold */
4352             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
4353                               ? s_end
4354                               : s_end -1;
4355
4356             while (s < upper) {
4357                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
4358                 if (! len) {    /* Not a multi-char fold. */
4359                     if (*s == LATIN_SMALL_LETTER_SHARP_S
4360                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
4361                     {
4362                         *unfolded_multi_char = TRUE;
4363                     }
4364                     s++;
4365                     continue;
4366                 }
4367
4368                 if (len == 2
4369                     && isALPHA_FOLD_EQ(*s, 's')
4370                     && isALPHA_FOLD_EQ(*(s+1), 's'))
4371                 {
4372
4373                     /* EXACTF nodes need to know that the minimum length
4374                      * changed so that a sharp s in the string can match this
4375                      * ss in the pattern, but they remain EXACTF nodes, as they
4376                      * won't match this unless the target string is is UTF-8,
4377                      * which we don't know until runtime.  EXACTFL nodes can't
4378                      * transform into EXACTFU nodes */
4379                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
4380                         OP(scan) = EXACTFUP;
4381                     }
4382                 }
4383
4384                 *min_subtract += len - 1;
4385                 s += len;
4386             }
4387 #endif
4388         }
4389
4390         if (     STR_LEN(scan) == 1
4391             &&   isALPHA_A(* STRING(scan))
4392             &&  (         OP(scan) == EXACTFAA
4393                  || (     OP(scan) == EXACTFU
4394                      && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(* STRING(scan)))))
4395         {
4396             U8 mask = ~ ('A' ^ 'a'); /* These differ in just one bit */
4397
4398             /* Replace a length 1 ASCII fold pair node with an ANYOFM node,
4399              * with the mask set to the complement of the bit that differs
4400              * between upper and lower case, and the lowest code point of the
4401              * pair (which the '&' forces) */
4402             OP(scan) = ANYOFM;
4403             ARG_SET(scan, *STRING(scan) & mask);
4404             FLAGS(scan) = mask;
4405         }
4406     }
4407
4408 #ifdef DEBUGGING
4409     /* Allow dumping but overwriting the collection of skipped
4410      * ops and/or strings with fake optimized ops */
4411     n = scan + NODE_SZ_STR(scan);
4412     while (n <= stop) {
4413         OP(n) = OPTIMIZED;
4414         FLAGS(n) = 0;
4415         NEXT_OFF(n) = 0;
4416         n++;
4417     }
4418 #endif
4419     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl", scan, depth, 0);});
4420     return stopnow;
4421 }
4422
4423 /* REx optimizer.  Converts nodes into quicker variants "in place".
4424    Finds fixed substrings.  */
4425
4426 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
4427    to the position after last scanned or to NULL. */
4428
4429 #define INIT_AND_WITHP \
4430     assert(!and_withp); \
4431     Newx(and_withp, 1, regnode_ssc); \
4432     SAVEFREEPV(and_withp)
4433
4434
4435 static void
4436 S_unwind_scan_frames(pTHX_ const void *p)
4437 {
4438     scan_frame *f= (scan_frame *)p;
4439     do {
4440         scan_frame *n= f->next_frame;
4441         Safefree(f);
4442         f= n;
4443     } while (f);
4444 }
4445
4446 /* the return from this sub is the minimum length that could possibly match */
4447 STATIC SSize_t
4448 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
4449                         SSize_t *minlenp, SSize_t *deltap,
4450                         regnode *last,
4451                         scan_data_t *data,
4452                         I32 stopparen,
4453                         U32 recursed_depth,
4454                         regnode_ssc *and_withp,
4455                         U32 flags, U32 depth)
4456                         /* scanp: Start here (read-write). */
4457                         /* deltap: Write maxlen-minlen here. */
4458                         /* last: Stop before this one. */
4459                         /* data: string data about the pattern */
4460                         /* stopparen: treat close N as END */
4461                         /* recursed: which subroutines have we recursed into */
4462                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
4463 {
4464     dVAR;
4465     /* There must be at least this number of characters to match */
4466     SSize_t min = 0;
4467     I32 pars = 0, code;
4468     regnode *scan = *scanp, *next;
4469     SSize_t delta = 0;
4470     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
4471     int is_inf_internal = 0;            /* The studied chunk is infinite */
4472     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
4473     scan_data_t data_fake;
4474     SV *re_trie_maxbuff = NULL;
4475     regnode *first_non_open = scan;
4476     SSize_t stopmin = SSize_t_MAX;
4477     scan_frame *frame = NULL;
4478     GET_RE_DEBUG_FLAGS_DECL;
4479
4480     PERL_ARGS_ASSERT_STUDY_CHUNK;
4481     RExC_study_started= 1;
4482
4483     Zero(&data_fake, 1, scan_data_t);
4484
4485     if ( depth == 0 ) {
4486         while (first_non_open && OP(first_non_open) == OPEN)
4487             first_non_open=regnext(first_non_open);
4488     }
4489
4490
4491   fake_study_recurse:
4492     DEBUG_r(
4493         RExC_study_chunk_recursed_count++;
4494     );
4495     DEBUG_OPTIMISE_MORE_r(
4496     {
4497         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4498             depth, (long)stopparen,
4499             (unsigned long)RExC_study_chunk_recursed_count,
4500             (unsigned long)depth, (unsigned long)recursed_depth,
4501             scan,
4502             last);
4503         if (recursed_depth) {
4504             U32 i;
4505             U32 j;
4506             for ( j = 0 ; j < recursed_depth ; j++ ) {
4507                 for ( i = 0 ; i < (U32)RExC_total_parens ; i++ ) {
4508                     if (
4509                         PAREN_TEST(RExC_study_chunk_recursed +
4510                                    ( j * RExC_study_chunk_recursed_bytes), i )
4511                         && (
4512                             !j ||
4513                             !PAREN_TEST(RExC_study_chunk_recursed +
4514                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
4515                         )
4516                     ) {
4517                         Perl_re_printf( aTHX_ " %d",(int)i);
4518                         break;
4519                     }
4520                 }
4521                 if ( j + 1 < recursed_depth ) {
4522                     Perl_re_printf( aTHX_  ",");
4523                 }
4524             }
4525         }
4526         Perl_re_printf( aTHX_ "\n");
4527     }
4528     );
4529     while ( scan && OP(scan) != END && scan < last ){
4530         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4531                                    node length to get a real minimum (because
4532                                    the folded version may be shorter) */
4533         bool unfolded_multi_char = FALSE;
4534         /* Peephole optimizer: */
4535         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4536         DEBUG_PEEP("Peep", scan, depth, flags);
4537
4538
4539         /* The reason we do this here is that we need to deal with things like
4540          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4541          * parsing code, as each (?:..) is handled by a different invocation of
4542          * reg() -- Yves
4543          */
4544         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
4545
4546         /* Follow the next-chain of the current node and optimize
4547            away all the NOTHINGs from it.  */
4548         if (OP(scan) != CURLYX) {
4549             const int max = (reg_off_by_arg[OP(scan)]
4550                        ? I32_MAX
4551                        /* I32 may be smaller than U16 on CRAYs! */
4552                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4553             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
4554             int noff;
4555             regnode *n = scan;
4556
4557             /* Skip NOTHING and LONGJMP. */
4558             while ((n = regnext(n))
4559                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4560                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
4561                    && off + noff < max)
4562                 off += noff;
4563             if (reg_off_by_arg[OP(scan)])
4564                 ARG(scan) = off;
4565             else
4566                 NEXT_OFF(scan) = off;
4567         }
4568
4569         /* The principal pseudo-switch.  Cannot be a switch, since we
4570            look into several different things.  */
4571         if ( OP(scan) == DEFINEP ) {
4572             SSize_t minlen = 0;
4573             SSize_t deltanext = 0;
4574             SSize_t fake_last_close = 0;
4575             I32 f = SCF_IN_DEFINE;
4576
4577             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4578             scan = regnext(scan);
4579             assert( OP(scan) == IFTHEN );
4580             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4581
4582             data_fake.last_closep= &fake_last_close;
4583             minlen = *minlenp;
4584             next = regnext(scan);
4585             scan = NEXTOPER(NEXTOPER(scan));
4586             DEBUG_PEEP("scan", scan, depth, flags);
4587             DEBUG_PEEP("next", next, depth, flags);
4588
4589             /* we suppose the run is continuous, last=next...
4590              * NOTE we dont use the return here! */
4591             /* DEFINEP study_chunk() recursion */
4592             (void)study_chunk(pRExC_state, &scan, &minlen,
4593                               &deltanext, next, &data_fake, stopparen,
4594                               recursed_depth, NULL, f, depth+1);
4595
4596             scan = next;
4597         } else
4598         if (
4599             OP(scan) == BRANCH  ||
4600             OP(scan) == BRANCHJ ||
4601             OP(scan) == IFTHEN
4602         ) {
4603             next = regnext(scan);
4604             code = OP(scan);
4605
4606             /* The op(next)==code check below is to see if we
4607              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4608              * IFTHEN is special as it might not appear in pairs.
4609              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4610              * we dont handle it cleanly. */
4611             if (OP(next) == code || code == IFTHEN) {
4612                 /* NOTE - There is similar code to this block below for
4613                  * handling TRIE nodes on a re-study.  If you change stuff here
4614                  * check there too. */
4615                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
4616                 regnode_ssc accum;
4617                 regnode * const startbranch=scan;
4618
4619                 if (flags & SCF_DO_SUBSTR) {
4620                     /* Cannot merge strings after this. */
4621                     scan_commit(pRExC_state, data, minlenp, is_inf);
4622                 }
4623
4624                 if (flags & SCF_DO_STCLASS)
4625                     ssc_init_zero(pRExC_state, &accum);
4626
4627                 while (OP(scan) == code) {
4628                     SSize_t deltanext, minnext, fake;
4629                     I32 f = 0;
4630                     regnode_ssc this_class;
4631
4632                     DEBUG_PEEP("Branch", scan, depth, flags);
4633
4634                     num++;
4635                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4636                     if (data) {
4637                         data_fake.whilem_c = data->whilem_c;
4638                         data_fake.last_closep = data->last_closep;
4639                     }
4640                     else
4641                         data_fake.last_closep = &fake;
4642
4643                     data_fake.pos_delta = delta;
4644                     next = regnext(scan);
4645
4646                     scan = NEXTOPER(scan); /* everything */
4647                     if (code != BRANCH)    /* everything but BRANCH */
4648                         scan = NEXTOPER(scan);
4649
4650                     if (flags & SCF_DO_STCLASS) {
4651                         ssc_init(pRExC_state, &this_class);
4652                         data_fake.start_class = &this_class;
4653                         f = SCF_DO_STCLASS_AND;
4654                     }
4655                     if (flags & SCF_WHILEM_VISITED_POS)
4656                         f |= SCF_WHILEM_VISITED_POS;
4657
4658                     /* we suppose the run is continuous, last=next...*/
4659                     /* recurse study_chunk() for each BRANCH in an alternation */
4660                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4661                                       &deltanext, next, &data_fake, stopparen,
4662                                       recursed_depth, NULL, f, depth+1);
4663
4664                     if (min1 > minnext)
4665                         min1 = minnext;
4666                     if (deltanext == SSize_t_MAX) {
4667                         is_inf = is_inf_internal = 1;
4668                         max1 = SSize_t_MAX;
4669                     } else if (max1 < minnext + deltanext)
4670                         max1 = minnext + deltanext;
4671                     scan = next;
4672                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4673                         pars++;
4674                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4675                         if ( stopmin > minnext)
4676                             stopmin = min + min1;
4677                         flags &= ~SCF_DO_SUBSTR;
4678                         if (data)
4679                             data->flags |= SCF_SEEN_ACCEPT;
4680                     }
4681                     if (data) {
4682                         if (data_fake.flags & SF_HAS_EVAL)
4683                             data->flags |= SF_HAS_EVAL;
4684                         data->whilem_c = data_fake.whilem_c;
4685                     }
4686                     if (flags & SCF_DO_STCLASS)
4687                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4688                 }
4689                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4690                     min1 = 0;
4691                 if (flags & SCF_DO_SUBSTR) {
4692                     data->pos_min += min1;
4693                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
4694                         data->pos_delta = SSize_t_MAX;
4695                     else
4696                         data->pos_delta += max1 - min1;
4697                     if (max1 != min1 || is_inf)
4698                         data->cur_is_floating = 1;
4699                 }
4700                 min += min1;
4701                 if (delta == SSize_t_MAX
4702                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4703                     delta = SSize_t_MAX;
4704                 else
4705                     delta += max1 - min1;
4706                 if (flags & SCF_DO_STCLASS_OR) {
4707                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4708                     if (min1) {
4709                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4710                         flags &= ~SCF_DO_STCLASS;
4711                     }
4712                 }
4713                 else if (flags & SCF_DO_STCLASS_AND) {
4714                     if (min1) {
4715                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4716                         flags &= ~SCF_DO_STCLASS;
4717                     }
4718                     else {
4719                         /* Switch to OR mode: cache the old value of
4720                          * data->start_class */
4721                         INIT_AND_WITHP;
4722                         StructCopy(data->start_class, and_withp, regnode_ssc);
4723                         flags &= ~SCF_DO_STCLASS_AND;
4724                         StructCopy(&accum, data->start_class, regnode_ssc);
4725                         flags |= SCF_DO_STCLASS_OR;
4726                     }
4727                 }
4728
4729                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4730                         OP( startbranch ) == BRANCH )
4731                 {
4732                 /* demq.
4733
4734                    Assuming this was/is a branch we are dealing with: 'scan'
4735                    now points at the item that follows the branch sequence,
4736                    whatever it is. We now start at the beginning of the
4737                    sequence and look for subsequences of
4738
4739                    BRANCH->EXACT=>x1
4740                    BRANCH->EXACT=>x2
4741                    tail
4742
4743                    which would be constructed from a pattern like
4744                    /A|LIST|OF|WORDS/
4745
4746                    If we can find such a subsequence we need to turn the first
4747                    element into a trie and then add the subsequent branch exact
4748                    strings to the trie.
4749
4750                    We have two cases
4751
4752                      1. patterns where the whole set of branches can be
4753                         converted.
4754
4755                      2. patterns where only a subset can be converted.
4756
4757                    In case 1 we can replace the whole set with a single regop
4758                    for the trie. In case 2 we need to keep the start and end
4759                    branches so
4760
4761                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4762                      becomes BRANCH TRIE; BRANCH X;
4763
4764                   There is an additional case, that being where there is a
4765                   common prefix, which gets split out into an EXACT like node
4766                   preceding the TRIE node.
4767
4768                   If x(1..n)==tail then we can do a simple trie, if not we make
4769                   a "jump" trie, such that when we match the appropriate word
4770                   we "jump" to the appropriate tail node. Essentially we turn
4771                   a nested if into a case structure of sorts.
4772
4773                 */
4774
4775                     int made=0;
4776                     if (!re_trie_maxbuff) {
4777                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4778                         if (!SvIOK(re_trie_maxbuff))
4779                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4780                     }
4781                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4782                         regnode *cur;
4783                         regnode *first = (regnode *)NULL;
4784                         regnode *last = (regnode *)NULL;
4785                         regnode *tail = scan;
4786                         U8 trietype = 0;
4787                         U32 count=0;
4788
4789                         /* var tail is used because there may be a TAIL
4790                            regop in the way. Ie, the exacts will point to the
4791                            thing following the TAIL, but the last branch will
4792                            point at the TAIL. So we advance tail. If we
4793                            have nested (?:) we may have to move through several
4794                            tails.
4795                          */
4796
4797                         while ( OP( tail ) == TAIL ) {
4798                             /* this is the TAIL generated by (?:) */
4799                             tail = regnext( tail );
4800                         }
4801
4802
4803                         DEBUG_TRIE_COMPILE_r({
4804                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4805                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4806                               depth+1,
4807                               "Looking for TRIE'able sequences. Tail node is ",
4808                               (UV) REGNODE_OFFSET(tail),
4809                               SvPV_nolen_const( RExC_mysv )
4810                             );
4811                         });
4812
4813                         /*
4814
4815                             Step through the branches
4816                                 cur represents each branch,
4817                                 noper is the first thing to be matched as part
4818                                       of that branch
4819                                 noper_next is the regnext() of that node.
4820
4821                             We normally handle a case like this
4822                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4823                             support building with NOJUMPTRIE, which restricts
4824                             the trie logic to structures like /FOO|BAR/.
4825
4826                             If noper is a trieable nodetype then the branch is
4827                             a possible optimization target. If we are building
4828                             under NOJUMPTRIE then we require that noper_next is
4829                             the same as scan (our current position in the regex
4830                             program).
4831
4832                             Once we have two or more consecutive such branches
4833                             we can create a trie of the EXACT's contents and
4834                             stitch it in place into the program.
4835
4836                             If the sequence represents all of the branches in
4837                             the alternation we replace the entire thing with a
4838                             single TRIE node.
4839
4840                             Otherwise when it is a subsequence we need to
4841                             stitch it in place and replace only the relevant
4842                             branches. This means the first branch has to remain
4843                             as it is used by the alternation logic, and its
4844                             next pointer, and needs to be repointed at the item
4845                             on the branch chain following the last branch we
4846                             have optimized away.
4847
4848                             This could be either a BRANCH, in which case the
4849                             subsequence is internal, or it could be the item
4850                             following the branch sequence in which case the
4851                             subsequence is at the end (which does not
4852                             necessarily mean the first node is the start of the
4853                             alternation).
4854
4855                             TRIE_TYPE(X) is a define which maps the optype to a
4856                             trietype.
4857
4858                                 optype          |  trietype
4859                                 ----------------+-----------
4860                                 NOTHING         | NOTHING
4861                                 EXACT           | EXACT
4862                                 EXACT_ONLY8     | EXACT
4863                                 EXACTFU         | EXACTFU
4864                                 EXACTFU_ONLY8   | EXACTFU
4865                                 EXACTFUP        | EXACTFU
4866                                 EXACTFAA        | EXACTFAA
4867                                 EXACTL          | EXACTL
4868                                 EXACTFLU8       | EXACTFLU8
4869
4870
4871                         */
4872 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4873                        ? NOTHING                                            \
4874                        : ( EXACT == (X) || EXACT_ONLY8 == (X) )             \
4875                          ? EXACT                                            \
4876                          : (     EXACTFU == (X)                             \
4877                               || EXACTFU_ONLY8 == (X)                       \
4878                               || EXACTFUP == (X) )                          \
4879                            ? EXACTFU                                        \
4880                            : ( EXACTFAA == (X) )                            \
4881                              ? EXACTFAA                                     \
4882                              : ( EXACTL == (X) )                            \
4883                                ? EXACTL                                     \
4884                                : ( EXACTFLU8 == (X) )                       \
4885                                  ? EXACTFLU8                                \
4886                                  : 0 )
4887
4888                         /* dont use tail as the end marker for this traverse */
4889                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4890                             regnode * const noper = NEXTOPER( cur );
4891                             U8 noper_type = OP( noper );
4892                             U8 noper_trietype = TRIE_TYPE( noper_type );
4893 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4894                             regnode * const noper_next = regnext( noper );
4895                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4896                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4897 #endif
4898
4899                             DEBUG_TRIE_COMPILE_r({
4900                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4901                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4902                                    depth+1,
4903                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4904
4905                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4906                                 Perl_re_printf( aTHX_  " -> %d:%s",
4907                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
4908
4909                                 if ( noper_next ) {
4910                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4911                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
4912                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
4913                                 }
4914                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
4915                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4916                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4917                                 );
4918                             });
4919
4920                             /* Is noper a trieable nodetype that can be merged
4921                              * with the current trie (if there is one)? */
4922                             if ( noper_trietype
4923                                   &&
4924                                   (
4925                                         ( noper_trietype == NOTHING )
4926                                         || ( trietype == NOTHING )
4927                                         || ( trietype == noper_trietype )
4928                                   )
4929 #ifdef NOJUMPTRIE
4930                                   && noper_next >= tail
4931 #endif
4932                                   && count < U16_MAX)
4933                             {
4934                                 /* Handle mergable triable node Either we are
4935                                  * the first node in a new trieable sequence,
4936                                  * in which case we do some bookkeeping,
4937                                  * otherwise we update the end pointer. */
4938                                 if ( !first ) {
4939                                     first = cur;
4940                                     if ( noper_trietype == NOTHING ) {
4941 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4942                                         regnode * const noper_next = regnext( noper );
4943                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4944                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4945 #endif
4946
4947                                         if ( noper_next_trietype ) {
4948                                             trietype = noper_next_trietype;
4949                                         } else if (noper_next_type)  {
4950                                             /* a NOTHING regop is 1 regop wide.
4951                                              * We need at least two for a trie
4952                                              * so we can't merge this in */
4953                                             first = NULL;
4954                                         }
4955                                     } else {
4956                                         trietype = noper_trietype;
4957                                     }
4958                                 } else {
4959                                     if ( trietype == NOTHING )
4960                                         trietype = noper_trietype;
4961                                     last = cur;
4962                                 }
4963                                 if (first)
4964                                     count++;
4965                             } /* end handle mergable triable node */
4966                             else {
4967                                 /* handle unmergable node -
4968                                  * noper may either be a triable node which can
4969                                  * not be tried together with the current trie,
4970                                  * or a non triable node */
4971                                 if ( last ) {
4972                                     /* If last is set and trietype is not
4973                                      * NOTHING then we have found at least two
4974                                      * triable branch sequences in a row of a
4975                                      * similar trietype so we can turn them
4976                                      * into a trie. If/when we allow NOTHING to
4977                                      * start a trie sequence this condition
4978                                      * will be required, and it isn't expensive
4979                                      * so we leave it in for now. */
4980                                     if ( trietype && trietype != NOTHING )
4981                                         make_trie( pRExC_state,
4982                                                 startbranch, first, cur, tail,
4983                                                 count, trietype, depth+1 );
4984                                     last = NULL; /* note: we clear/update
4985                                                     first, trietype etc below,
4986                                                     so we dont do it here */
4987                                 }
4988                                 if ( noper_trietype
4989 #ifdef NOJUMPTRIE
4990                                      && noper_next >= tail
4991 #endif
4992                                 ){
4993                                     /* noper is triable, so we can start a new
4994                                      * trie sequence */
4995                                     count = 1;
4996                                     first = cur;
4997                                     trietype = noper_trietype;
4998                                 } else if (first) {
4999                                     /* if we already saw a first but the
5000                                      * current node is not triable then we have
5001                                      * to reset the first information. */
5002                                     count = 0;
5003                                     first = NULL;
5004                                     trietype = 0;
5005                                 }
5006                             } /* end handle unmergable node */
5007                         } /* loop over branches */
5008                         DEBUG_TRIE_COMPILE_r({
5009                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5010                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
5011                               depth+1, SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5012                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
5013                                REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
5014                                PL_reg_name[trietype]
5015                             );
5016
5017                         });
5018                         if ( last && trietype ) {
5019                             if ( trietype != NOTHING ) {
5020                                 /* the last branch of the sequence was part of
5021                                  * a trie, so we have to construct it here
5022                                  * outside of the loop */
5023                                 made= make_trie( pRExC_state, startbranch,
5024                                                  first, scan, tail, count,
5025                                                  trietype, depth+1 );
5026 #ifdef TRIE_STUDY_OPT
5027                                 if ( ((made == MADE_EXACT_TRIE &&
5028                                      startbranch == first)
5029                                      || ( first_non_open == first )) &&
5030                                      depth==0 ) {
5031                                     flags |= SCF_TRIE_RESTUDY;
5032                                     if ( startbranch == first
5033                                          && scan >= tail )
5034                                     {
5035                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
5036                                     }
5037                                 }
5038 #endif
5039                             } else {
5040                                 /* at this point we know whatever we have is a
5041                                  * NOTHING sequence/branch AND if 'startbranch'
5042                                  * is 'first' then we can turn the whole thing
5043                                  * into a NOTHING
5044                                  */
5045                                 if ( startbranch == first ) {
5046                                     regnode *opt;
5047                                     /* the entire thing is a NOTHING sequence,
5048                                      * something like this: (?:|) So we can
5049                                      * turn it into a plain NOTHING op. */
5050                                     DEBUG_TRIE_COMPILE_r({
5051                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5052                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
5053                                           depth+1,
5054                                           SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5055
5056                                     });
5057                                     OP(startbranch)= NOTHING;
5058                                     NEXT_OFF(startbranch)= tail - startbranch;
5059                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
5060                                         OP(opt)= OPTIMIZED;
5061                                 }
5062                             }
5063                         } /* end if ( last) */
5064                     } /* TRIE_MAXBUF is non zero */
5065
5066                 } /* do trie */
5067
5068             }
5069             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
5070                 scan = NEXTOPER(NEXTOPER(scan));
5071             } else                      /* single branch is optimized. */
5072                 scan = NEXTOPER(scan);
5073             continue;
5074         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
5075             I32 paren = 0;
5076             regnode *start = NULL;
5077             regnode *end = NULL;
5078             U32 my_recursed_depth= recursed_depth;
5079
5080             if (OP(scan) != SUSPEND) { /* GOSUB */
5081                 /* Do setup, note this code has side effects beyond
5082                  * the rest of this block. Specifically setting
5083                  * RExC_recurse[] must happen at least once during
5084                  * study_chunk(). */
5085                 paren = ARG(scan);
5086                 RExC_recurse[ARG2L(scan)] = scan;
5087                 start = REGNODE_p(RExC_open_parens[paren]);
5088                 end   = REGNODE_p(RExC_close_parens[paren]);
5089
5090                 /* NOTE we MUST always execute the above code, even
5091                  * if we do nothing with a GOSUB */
5092                 if (
5093                     ( flags & SCF_IN_DEFINE )
5094                     ||
5095                     (
5096                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
5097                         &&
5098                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
5099                     )
5100                 ) {
5101                     /* no need to do anything here if we are in a define. */
5102                     /* or we are after some kind of infinite construct
5103                      * so we can skip recursing into this item.
5104                      * Since it is infinite we will not change the maxlen
5105                      * or delta, and if we miss something that might raise
5106                      * the minlen it will merely pessimise a little.
5107                      *
5108                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
5109                      * might result in a minlen of 1 and not of 4,
5110                      * but this doesn't make us mismatch, just try a bit
5111                      * harder than we should.
5112                      * */
5113                     scan= regnext(scan);
5114                     continue;
5115                 }
5116
5117                 if (
5118                     !recursed_depth
5119                     ||
5120                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
5121                 ) {
5122                     /* it is quite possible that there are more efficient ways
5123                      * to do this. We maintain a bitmap per level of recursion
5124                      * of which patterns we have entered so we can detect if a
5125                      * pattern creates a possible infinite loop. When we
5126                      * recurse down a level we copy the previous levels bitmap
5127                      * down. When we are at recursion level 0 we zero the top
5128                      * level bitmap. It would be nice to implement a different
5129                      * more efficient way of doing this. In particular the top
5130                      * level bitmap may be unnecessary.
5131                      */
5132                     if (!recursed_depth) {
5133                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
5134                     } else {
5135                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
5136                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
5137                              RExC_study_chunk_recursed_bytes, U8);
5138                     }
5139                     /* we havent recursed into this paren yet, so recurse into it */
5140                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
5141                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
5142                     my_recursed_depth= recursed_depth + 1;
5143                 } else {
5144                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
5145                     /* some form of infinite recursion, assume infinite length
5146                      * */
5147                     if (flags & SCF_DO_SUBSTR) {
5148                         scan_commit(pRExC_state, data, minlenp, is_inf);
5149                         data->cur_is_floating = 1;
5150                     }
5151                     is_inf = is_inf_internal = 1;
5152                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5153                         ssc_anything(data->start_class);
5154                     flags &= ~SCF_DO_STCLASS;
5155
5156                     start= NULL; /* reset start so we dont recurse later on. */
5157                 }
5158             } else {
5159                 paren = stopparen;
5160                 start = scan + 2;
5161                 end = regnext(scan);
5162             }
5163             if (start) {
5164                 scan_frame *newframe;
5165                 assert(end);
5166                 if (!RExC_frame_last) {
5167                     Newxz(newframe, 1, scan_frame);
5168                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
5169                     RExC_frame_head= newframe;
5170                     RExC_frame_count++;
5171                 } else if (!RExC_frame_last->next_frame) {
5172                     Newxz(newframe, 1, scan_frame);
5173                     RExC_frame_last->next_frame= newframe;
5174                     newframe->prev_frame= RExC_frame_last;
5175                     RExC_frame_count++;
5176                 } else {
5177                     newframe= RExC_frame_last->next_frame;
5178                 }
5179                 RExC_frame_last= newframe;
5180
5181                 newframe->next_regnode = regnext(scan);
5182                 newframe->last_regnode = last;
5183                 newframe->stopparen = stopparen;
5184                 newframe->prev_recursed_depth = recursed_depth;
5185                 newframe->this_prev_frame= frame;
5186
5187                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
5188                 DEBUG_PEEP("fnew", scan, depth, flags);
5189
5190                 frame = newframe;
5191                 scan =  start;
5192                 stopparen = paren;
5193                 last = end;
5194                 depth = depth + 1;
5195                 recursed_depth= my_recursed_depth;
5196
5197                 continue;
5198             }
5199         }
5200         else if (   OP(scan) == EXACT
5201                  || OP(scan) == LEXACT
5202                  || OP(scan) == EXACT_ONLY8
5203                  || OP(scan) == LEXACT_ONLY8
5204                  || OP(scan) == EXACTL)
5205         {
5206             SSize_t l = STR_LEN(scan);
5207             UV uc;
5208             assert(l);
5209             if (UTF) {
5210                 const U8 * const s = (U8*)STRING(scan);
5211                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
5212                 l = utf8_length(s, s + l);
5213             } else {
5214                 uc = *((U8*)STRING(scan));
5215             }
5216             min += l;
5217             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
5218                 /* The code below prefers earlier match for fixed
5219                    offset, later match for variable offset.  */
5220                 if (data->last_end == -1) { /* Update the start info. */
5221                     data->last_start_min = data->pos_min;
5222                     data->last_start_max = is_inf
5223                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
5224                 }
5225                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
5226                 if (UTF)
5227                     SvUTF8_on(data->last_found);
5228                 {
5229                     SV * const sv = data->last_found;
5230                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5231                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5232                     if (mg && mg->mg_len >= 0)
5233                         mg->mg_len += utf8_length((U8*)STRING(scan),
5234                                               (U8*)STRING(scan)+STR_LEN(scan));
5235                 }
5236                 data->last_end = data->pos_min + l;
5237                 data->pos_min += l; /* As in the first entry. */
5238                 data->flags &= ~SF_BEFORE_EOL;
5239             }
5240
5241             /* ANDing the code point leaves at most it, and not in locale, and
5242              * can't match null string */
5243             if (flags & SCF_DO_STCLASS_AND) {
5244                 ssc_cp_and(data->start_class, uc);
5245                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5246                 ssc_clear_locale(data->start_class);
5247             }
5248             else if (flags & SCF_DO_STCLASS_OR) {
5249                 ssc_add_cp(data->start_class, uc);
5250                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5251
5252                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5253                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5254             }
5255             flags &= ~SCF_DO_STCLASS;
5256         }
5257         else if (PL_regkind[OP(scan)] == EXACT) {
5258             /* But OP != EXACT!, so is EXACTFish */
5259             SSize_t l = STR_LEN(scan);
5260             const U8 * s = (U8*)STRING(scan);
5261
5262             /* Search for fixed substrings supports EXACT only. */
5263             if (flags & SCF_DO_SUBSTR) {
5264                 assert(data);
5265                 scan_commit(pRExC_state, data, minlenp, is_inf);
5266             }
5267             if (UTF) {
5268                 l = utf8_length(s, s + l);
5269             }
5270             if (unfolded_multi_char) {
5271                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
5272             }
5273             min += l - min_subtract;
5274             assert (min >= 0);
5275             delta += min_subtract;
5276             if (flags & SCF_DO_SUBSTR) {
5277                 data->pos_min += l - min_subtract;
5278                 if (data->pos_min < 0) {
5279                     data->pos_min = 0;
5280                 }
5281                 data->pos_delta += min_subtract;
5282                 if (min_subtract) {
5283                     data->cur_is_floating = 1; /* float */
5284                 }
5285             }
5286
5287             if (flags & SCF_DO_STCLASS) {
5288                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
5289
5290                 assert(EXACTF_invlist);
5291                 if (flags & SCF_DO_STCLASS_AND) {
5292                     if (OP(scan) != EXACTFL)
5293                         ssc_clear_locale(data->start_class);
5294                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5295                     ANYOF_POSIXL_ZERO(data->start_class);
5296                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
5297                 }
5298                 else {  /* SCF_DO_STCLASS_OR */
5299                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
5300                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5301
5302                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5303                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5304                 }
5305                 flags &= ~SCF_DO_STCLASS;
5306                 SvREFCNT_dec(EXACTF_invlist);
5307             }
5308         }
5309         else if (REGNODE_VARIES(OP(scan))) {
5310             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
5311             I32 fl = 0, f = flags;
5312             regnode * const oscan = scan;
5313             regnode_ssc this_class;
5314             regnode_ssc *oclass = NULL;
5315             I32 next_is_eval = 0;
5316
5317             switch (PL_regkind[OP(scan)]) {
5318             case WHILEM:                /* End of (?:...)* . */
5319                 scan = NEXTOPER(scan);
5320                 goto finish;
5321             case PLUS:
5322                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5323                     next = NEXTOPER(scan);
5324                     if (   OP(next) == EXACT
5325                         || OP(next) == LEXACT
5326                         || OP(next) == EXACT_ONLY8
5327                         || OP(next) == LEXACT_ONLY8
5328                         || OP(next) == EXACTL
5329                         || (flags & SCF_DO_STCLASS))
5330                     {
5331                         mincount = 1;
5332                         maxcount = REG_INFTY;
5333                         next = regnext(scan);
5334                         scan = NEXTOPER(scan);
5335                         goto do_curly;
5336                     }
5337                 }
5338                 if (flags & SCF_DO_SUBSTR)
5339                     data->pos_min++;
5340                 min++;
5341                 /* FALLTHROUGH */
5342             case STAR:
5343                 next = NEXTOPER(scan);
5344
5345                 /* This temporary node can now be turned into EXACTFU, and
5346                  * must, as regexec.c doesn't handle it */
5347                 if (OP(next) == EXACTFU_S_EDGE) {
5348                     OP(next) = EXACTFU;
5349                 }
5350
5351                 if (     STR_LEN(next) == 1
5352                     &&   isALPHA_A(* STRING(next))
5353                     && (         OP(next) == EXACTFAA
5354                         || (     OP(next) == EXACTFU
5355                             && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(* STRING(next)))))
5356                 {
5357                     /* These differ in just one bit */
5358                     U8 mask = ~ ('A' ^ 'a');
5359
5360                     assert(isALPHA_A(* STRING(next)));
5361
5362                     /* Then replace it by an ANYOFM node, with
5363                     * the mask set to the complement of the
5364                     * bit that differs between upper and lower
5365                     * case, and the lowest code point of the
5366                     * pair (which the '&' forces) */
5367                     OP(next) = ANYOFM;
5368                     ARG_SET(next, *STRING(next) & mask);
5369                     FLAGS(next) = mask;
5370                 }
5371
5372                 if (flags & SCF_DO_STCLASS) {
5373                     mincount = 0;
5374                     maxcount = REG_INFTY;
5375                     next = regnext(scan);
5376                     scan = NEXTOPER(scan);
5377                     goto do_curly;
5378                 }
5379                 if (flags & SCF_DO_SUBSTR) {
5380                     scan_commit(pRExC_state, data, minlenp, is_inf);
5381                     /* Cannot extend fixed substrings */
5382                     data->cur_is_floating = 1; /* float */
5383                 }
5384                 is_inf = is_inf_internal = 1;
5385                 scan = regnext(scan);
5386                 goto optimize_curly_tail;
5387             case CURLY:
5388                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5389                     && (scan->flags == stopparen))
5390                 {
5391                     mincount = 1;
5392                     maxcount = 1;
5393                 } else {
5394                     mincount = ARG1(scan);
5395                     maxcount = ARG2(scan);
5396                 }
5397                 next = regnext(scan);
5398                 if (OP(scan) == CURLYX) {
5399                     I32 lp = (data ? *(data->last_closep) : 0);
5400                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5401                 }
5402                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5403                 next_is_eval = (OP(scan) == EVAL);
5404               do_curly:
5405                 if (flags & SCF_DO_SUBSTR) {
5406                     if (mincount == 0)
5407                         scan_commit(pRExC_state, data, minlenp, is_inf);
5408                     /* Cannot extend fixed substrings */
5409                     pos_before = data->pos_min;
5410                 }
5411                 if (data) {
5412                     fl = data->flags;
5413                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5414                     if (is_inf)
5415                         data->flags |= SF_IS_INF;
5416                 }
5417                 if (flags & SCF_DO_STCLASS) {
5418                     ssc_init(pRExC_state, &this_class);
5419                     oclass = data->start_class;
5420                     data->start_class = &this_class;
5421                     f |= SCF_DO_STCLASS_AND;
5422                     f &= ~SCF_DO_STCLASS_OR;
5423                 }
5424                 /* Exclude from super-linear cache processing any {n,m}
5425                    regops for which the combination of input pos and regex
5426                    pos is not enough information to determine if a match
5427                    will be possible.
5428
5429                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5430                    regex pos at the \s*, the prospects for a match depend not
5431                    only on the input position but also on how many (bar\s*)
5432                    repeats into the {4,8} we are. */
5433                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5434                     f &= ~SCF_WHILEM_VISITED_POS;
5435
5436                 /* This will finish on WHILEM, setting scan, or on NULL: */
5437                 /* recurse study_chunk() on loop bodies */
5438                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5439                                   last, data, stopparen, recursed_depth, NULL,
5440                                   (mincount == 0
5441                                    ? (f & ~SCF_DO_SUBSTR)
5442                                    : f)
5443                                   ,depth+1);
5444
5445                 if (flags & SCF_DO_STCLASS)
5446                     data->start_class = oclass;
5447                 if (mincount == 0 || minnext == 0) {
5448                     if (flags & SCF_DO_STCLASS_OR) {
5449                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5450                     }
5451                     else if (flags & SCF_DO_STCLASS_AND) {
5452                         /* Switch to OR mode: cache the old value of
5453                          * data->start_class */
5454                         INIT_AND_WITHP;
5455                         StructCopy(data->start_class, and_withp, regnode_ssc);
5456                         flags &= ~SCF_DO_STCLASS_AND;
5457                         StructCopy(&this_class, data->start_class, regnode_ssc);
5458                         flags |= SCF_DO_STCLASS_OR;
5459                         ANYOF_FLAGS(data->start_class)
5460                                                 |= SSC_MATCHES_EMPTY_STRING;
5461                     }
5462                 } else {                /* Non-zero len */
5463                     if (flags & SCF_DO_STCLASS_OR) {
5464                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5465                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5466                     }
5467                     else if (flags & SCF_DO_STCLASS_AND)
5468                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5469                     flags &= ~SCF_DO_STCLASS;
5470                 }
5471                 if (!scan)              /* It was not CURLYX, but CURLY. */
5472                     scan = next;
5473                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5474                     /* ? quantifier ok, except for (?{ ... }) */
5475                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5476                     && (minnext == 0) && (deltanext == 0)
5477                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5478                     && maxcount <= REG_INFTY/3) /* Complement check for big
5479                                                    count */
5480                 {
5481                     _WARN_HELPER(RExC_precomp_end, packWARN(WARN_REGEXP),
5482                         Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5483                             "Quantifier unexpected on zero-length expression "
5484                             "in regex m/%" UTF8f "/",
5485                              UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5486                                   RExC_precomp)));
5487                 }
5488
5489                 min += minnext * mincount;
5490                 is_inf_internal |= deltanext == SSize_t_MAX
5491                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5492                 is_inf |= is_inf_internal;
5493                 if (is_inf) {
5494                     delta = SSize_t_MAX;
5495                 } else {
5496                     delta += (minnext + deltanext) * maxcount
5497                              - minnext * mincount;
5498                 }
5499                 /* Try powerful optimization CURLYX => CURLYN. */
5500                 if (  OP(oscan) == CURLYX && data
5501                       && data->flags & SF_IN_PAR
5502                       && !(data->flags & SF_HAS_EVAL)
5503                       && !deltanext && minnext == 1 ) {
5504                     /* Try to optimize to CURLYN.  */
5505                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5506                     regnode * const nxt1 = nxt;
5507 #ifdef DEBUGGING
5508                     regnode *nxt2;
5509 #endif
5510
5511                     /* Skip open. */
5512                     nxt = regnext(nxt);
5513                     if (!REGNODE_SIMPLE(OP(nxt))
5514                         && !(PL_regkind[OP(nxt)] == EXACT
5515                              && STR_LEN(nxt) == 1))
5516                         goto nogo;
5517 #ifdef DEBUGGING
5518                     nxt2 = nxt;
5519 #endif
5520                     nxt = regnext(nxt);
5521                     if (OP(nxt) != CLOSE)
5522                         goto nogo;
5523                     if (RExC_open_parens) {
5524
5525                         /*open->CURLYM*/
5526                         RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5527
5528                         /*close->while*/
5529                         RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt) + 2;
5530                     }
5531                     /* Now we know that nxt2 is the only contents: */
5532                     oscan->flags = (U8)ARG(nxt);
5533                     OP(oscan) = CURLYN;
5534                     OP(nxt1) = NOTHING; /* was OPEN. */
5535
5536 #ifdef DEBUGGING
5537                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5538                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5539                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5540                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5541                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5542                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5543 #endif
5544                 }
5545               nogo:
5546
5547                 /* Try optimization CURLYX => CURLYM. */
5548                 if (  OP(oscan) == CURLYX && data
5549                       && !(data->flags & SF_HAS_PAR)
5550                       && !(data->flags & SF_HAS_EVAL)
5551                       && !deltanext     /* atom is fixed width */
5552                       && minnext != 0   /* CURLYM can't handle zero width */
5553
5554                          /* Nor characters whose fold at run-time may be
5555                           * multi-character */
5556                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5557                 ) {
5558                     /* XXXX How to optimize if data == 0? */
5559                     /* Optimize to a simpler form.  */
5560                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5561                     regnode *nxt2;
5562
5563                     OP(oscan) = CURLYM;
5564                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5565                             && (OP(nxt2) != WHILEM))
5566                         nxt = nxt2;
5567                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5568                     /* Need to optimize away parenths. */
5569                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5570                         /* Set the parenth number.  */
5571                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5572
5573                         oscan->flags = (U8)ARG(nxt);
5574                         if (RExC_open_parens) {
5575                              /*open->CURLYM*/
5576                             RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5577
5578                             /*close->NOTHING*/
5579                             RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt2)
5580                                                          + 1;
5581                         }
5582                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5583                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5584
5585 #ifdef DEBUGGING
5586                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5587                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5588                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5589                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5590 #endif
5591 #if 0
5592                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5593                             regnode *nnxt = regnext(nxt1);
5594                             if (nnxt == nxt) {
5595                                 if (reg_off_by_arg[OP(nxt1)])
5596                                     ARG_SET(nxt1, nxt2 - nxt1);
5597                                 else if (nxt2 - nxt1 < U16_MAX)
5598                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5599                                 else
5600                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5601                             }
5602                             nxt1 = nnxt;
5603                         }
5604 #endif
5605                         /* Optimize again: */
5606                         /* recurse study_chunk() on optimised CURLYX => CURLYM */
5607                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5608                                     NULL, stopparen, recursed_depth, NULL, 0,
5609                                     depth+1);
5610                     }
5611                     else
5612                         oscan->flags = 0;
5613                 }
5614                 else if ((OP(oscan) == CURLYX)
5615                          && (flags & SCF_WHILEM_VISITED_POS)
5616                          /* See the comment on a similar expression above.
5617                             However, this time it's not a subexpression
5618                             we care about, but the expression itself. */
5619                          && (maxcount == REG_INFTY)
5620                          && data) {
5621                     /* This stays as CURLYX, we can put the count/of pair. */
5622                     /* Find WHILEM (as in regexec.c) */
5623                     regnode *nxt = oscan + NEXT_OFF(oscan);
5624
5625                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5626                         nxt += ARG(nxt);
5627                     nxt = PREVOPER(nxt);
5628                     if (nxt->flags & 0xf) {
5629                         /* we've already set whilem count on this node */
5630                     } else if (++data->whilem_c < 16) {
5631                         assert(data->whilem_c <= RExC_whilem_seen);
5632                         nxt->flags = (U8)(data->whilem_c
5633                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5634                     }
5635                 }
5636                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5637                     pars++;
5638                 if (flags & SCF_DO_SUBSTR) {
5639                     SV *last_str = NULL;
5640                     STRLEN last_chrs = 0;
5641                     int counted = mincount != 0;
5642
5643                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5644                                                                   string. */
5645                         SSize_t b = pos_before >= data->last_start_min
5646                             ? pos_before : data->last_start_min;
5647                         STRLEN l;
5648                         const char * const s = SvPV_const(data->last_found, l);
5649                         SSize_t old = b - data->last_start_min;
5650                         assert(old >= 0);
5651
5652                         if (UTF)
5653                             old = utf8_hop_forward((U8*)s, old,
5654                                                (U8 *) SvEND(data->last_found))
5655                                 - (U8*)s;
5656                         l -= old;
5657                         /* Get the added string: */
5658                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5659                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5660                                             (U8*)(s + old + l)) : l;
5661                         if (deltanext == 0 && pos_before == b) {
5662                             /* What was added is a constant string */
5663                             if (mincount > 1) {
5664
5665                                 SvGROW(last_str, (mincount * l) + 1);
5666                                 repeatcpy(SvPVX(last_str) + l,
5667                                           SvPVX_const(last_str), l,
5668                                           mincount - 1);
5669                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5670                                 /* Add additional parts. */
5671                                 SvCUR_set(data->last_found,
5672                                           SvCUR(data->last_found) - l);
5673                                 sv_catsv(data->last_found, last_str);
5674                                 {
5675                                     SV * sv = data->last_found;
5676                                     MAGIC *mg =
5677                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5678                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5679                                     if (mg && mg->mg_len >= 0)
5680                                         mg->mg_len += last_chrs * (mincount-1);
5681                                 }
5682                                 last_chrs *= mincount;
5683                                 data->last_end += l * (mincount - 1);
5684                             }
5685                         } else {
5686                             /* start offset must point into the last copy */
5687                             data->last_start_min += minnext * (mincount - 1);
5688                             data->last_start_max =
5689                               is_inf
5690                                ? SSize_t_MAX
5691                                : data->last_start_max +
5692                                  (maxcount - 1) * (minnext + data->pos_delta);
5693                         }
5694                     }
5695                     /* It is counted once already... */
5696                     data->pos_min += minnext * (mincount - counted);
5697 #if 0
5698 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5699                               " SSize_t_MAX=%" UVuf " minnext=%" UVuf
5700                               " maxcount=%" UVuf " mincount=%" UVuf "\n",
5701     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
5702     (UV)mincount);
5703 if (deltanext != SSize_t_MAX)
5704 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5705     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5706           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
5707 #endif
5708                     if (deltanext == SSize_t_MAX
5709                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
5710                         data->pos_delta = SSize_t_MAX;
5711                     else
5712                         data->pos_delta += - counted * deltanext +
5713                         (minnext + deltanext) * maxcount - minnext * mincount;
5714                     if (mincount != maxcount) {
5715                          /* Cannot extend fixed substrings found inside
5716                             the group.  */
5717                         scan_commit(pRExC_state, data, minlenp, is_inf);
5718                         if (mincount && last_str) {
5719                             SV * const sv = data->last_found;
5720                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5721                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5722
5723                             if (mg)
5724                                 mg->mg_len = -1;
5725                             sv_setsv(sv, last_str);
5726                             data->last_end = data->pos_min;
5727                             data->last_start_min = data->pos_min - last_chrs;
5728                             data->last_start_max = is_inf
5729                                 ? SSize_t_MAX
5730                                 : data->pos_min + data->pos_delta - last_chrs;
5731                         }
5732                         data->cur_is_floating = 1; /* float */
5733                     }
5734                     SvREFCNT_dec(last_str);
5735                 }
5736                 if (data && (fl & SF_HAS_EVAL))
5737                     data->flags |= SF_HAS_EVAL;
5738               optimize_curly_tail:
5739                 if (OP(oscan) != CURLYX) {
5740                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
5741                            && NEXT_OFF(next))
5742                         NEXT_OFF(oscan) += NEXT_OFF(next);
5743                 }
5744                 continue;
5745
5746             default:
5747 #ifdef DEBUGGING
5748                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5749                                                                     OP(scan));
5750 #endif
5751             case REF:
5752             case CLUMP:
5753                 if (flags & SCF_DO_SUBSTR) {
5754                     /* Cannot expect anything... */
5755                     scan_commit(pRExC_state, data, minlenp, is_inf);
5756                     data->cur_is_floating = 1; /* float */
5757                 }
5758                 is_inf = is_inf_internal = 1;
5759                 if (flags & SCF_DO_STCLASS_OR) {
5760                     if (OP(scan) == CLUMP) {
5761                         /* Actually is any start char, but very few code points
5762                          * aren't start characters */
5763                         ssc_match_all_cp(data->start_class);
5764                     }
5765                     else {
5766                         ssc_anything(data->start_class);
5767                     }
5768                 }
5769                 flags &= ~SCF_DO_STCLASS;
5770                 break;
5771             }
5772         }
5773         else if (OP(scan) == LNBREAK) {
5774             if (flags & SCF_DO_STCLASS) {
5775                 if (flags & SCF_DO_STCLASS_AND) {
5776                     ssc_intersection(data->start_class,
5777                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5778                     ssc_clear_locale(data->start_class);
5779                     ANYOF_FLAGS(data->start_class)
5780                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5781                 }
5782                 else if (flags & SCF_DO_STCLASS_OR) {
5783                     ssc_union(data->start_class,
5784                               PL_XPosix_ptrs[_CC_VERTSPACE],
5785                               FALSE);
5786                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5787
5788                     /* See commit msg for
5789                      * 749e076fceedeb708a624933726e7989f2302f6a */
5790                     ANYOF_FLAGS(data->start_class)
5791                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5792                 }
5793                 flags &= ~SCF_DO_STCLASS;
5794             }
5795             min++;
5796             if (delta != SSize_t_MAX)
5797                 delta++;    /* Because of the 2 char string cr-lf */
5798             if (flags & SCF_DO_SUBSTR) {
5799                 /* Cannot expect anything... */
5800                 scan_commit(pRExC_state, data, minlenp, is_inf);
5801                 data->pos_min += 1;
5802                 if (data->pos_delta != SSize_t_MAX) {
5803                     data->pos_delta += 1;
5804                 }
5805                 data->cur_is_floating = 1; /* float */
5806             }
5807         }
5808         else if (REGNODE_SIMPLE(OP(scan))) {
5809
5810             if (flags & SCF_DO_SUBSTR) {
5811                 scan_commit(pRExC_state, data, minlenp, is_inf);
5812                 data->pos_min++;
5813             }
5814             min++;
5815             if (flags & SCF_DO_STCLASS) {
5816                 bool invert = 0;
5817                 SV* my_invlist = NULL;
5818                 U8 namedclass;
5819
5820                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5821                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5822
5823                 /* Some of the logic below assumes that switching
5824                    locale on will only add false positives. */
5825                 switch (OP(scan)) {
5826
5827                 default:
5828 #ifdef DEBUGGING
5829                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5830                                                                      OP(scan));
5831 #endif
5832                 case SANY:
5833                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5834                         ssc_match_all_cp(data->start_class);
5835                     break;
5836
5837                 case REG_ANY:
5838                     {
5839                         SV* REG_ANY_invlist = _new_invlist(2);
5840                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5841                                                             '\n');
5842                         if (flags & SCF_DO_STCLASS_OR) {
5843                             ssc_union(data->start_class,
5844                                       REG_ANY_invlist,
5845                                       TRUE /* TRUE => invert, hence all but \n
5846                                             */
5847                                       );
5848                         }
5849                         else if (flags & SCF_DO_STCLASS_AND) {
5850                             ssc_intersection(data->start_class,
5851                                              REG_ANY_invlist,
5852                                              TRUE  /* TRUE => invert */
5853                                              );
5854                             ssc_clear_locale(data->start_class);
5855                         }
5856                         SvREFCNT_dec_NN(REG_ANY_invlist);
5857                     }
5858                     break;
5859
5860                 case ANYOFD:
5861                 case ANYOFL:
5862                 case ANYOFPOSIXL:
5863                 case ANYOFH:
5864                 case ANYOFHb:
5865                 case ANYOFHr:
5866                 case ANYOF:
5867                     if (flags & SCF_DO_STCLASS_AND)
5868                         ssc_and(pRExC_state, data->start_class,
5869                                 (regnode_charclass *) scan);
5870                     else
5871                         ssc_or(pRExC_state, data->start_class,
5872                                                           (regnode_charclass *) scan);
5873                     break;
5874
5875                 case NANYOFM:
5876                 case ANYOFM:
5877                   {
5878                     SV* cp_list = get_ANYOFM_contents(scan);
5879
5880                     if (flags & SCF_DO_STCLASS_OR) {
5881                         ssc_union(data->start_class, cp_list, invert);
5882                     }
5883                     else if (flags & SCF_DO_STCLASS_AND) {
5884                         ssc_intersection(data->start_class, cp_list, invert);
5885                     }
5886
5887                     SvREFCNT_dec_NN(cp_list);
5888                     break;
5889                   }
5890
5891                 case NPOSIXL:
5892                     invert = 1;
5893                     /* FALLTHROUGH */
5894
5895                 case POSIXL:
5896                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5897                     if (flags & SCF_DO_STCLASS_AND) {
5898                         bool was_there = cBOOL(
5899                                           ANYOF_POSIXL_TEST(data->start_class,
5900                                                                  namedclass));
5901                         ANYOF_POSIXL_ZERO(data->start_class);
5902                         if (was_there) {    /* Do an AND */
5903                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5904                         }
5905                         /* No individual code points can now match */
5906                         data->start_class->invlist
5907                                                 = sv_2mortal(_new_invlist(0));
5908                     }
5909                     else {
5910                         int complement = namedclass + ((invert) ? -1 : 1);
5911
5912                         assert(flags & SCF_DO_STCLASS_OR);
5913
5914                         /* If the complement of this class was already there,
5915                          * the result is that they match all code points,
5916                          * (\d + \D == everything).  Remove the classes from
5917                          * future consideration.  Locale is not relevant in
5918                          * this case */
5919                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5920                             ssc_match_all_cp(data->start_class);
5921                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5922                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5923                         }
5924                         else {  /* The usual case; just add this class to the
5925                                    existing set */
5926                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5927                         }
5928                     }
5929                     break;
5930
5931                 case NPOSIXA:   /* For these, we always know the exact set of
5932                                    what's matched */
5933                     invert = 1;
5934                     /* FALLTHROUGH */
5935                 case POSIXA:
5936                     my_invlist = invlist_clone(PL_Posix_ptrs[FLAGS(scan)], NULL);
5937                     goto join_posix_and_ascii;
5938
5939                 case NPOSIXD:
5940                 case NPOSIXU:
5941                     invert = 1;
5942                     /* FALLTHROUGH */
5943                 case POSIXD:
5944                 case POSIXU:
5945                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)], NULL);
5946
5947                     /* NPOSIXD matches all upper Latin1 code points unless the
5948                      * target string being matched is UTF-8, which is
5949                      * unknowable until match time.  Since we are going to
5950                      * invert, we want to get rid of all of them so that the
5951                      * inversion will match all */
5952                     if (OP(scan) == NPOSIXD) {
5953                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5954                                           &my_invlist);
5955                     }
5956
5957                   join_posix_and_ascii:
5958
5959                     if (flags & SCF_DO_STCLASS_AND) {
5960                         ssc_intersection(data->start_class, my_invlist, invert);
5961                         ssc_clear_locale(data->start_class);
5962                     }
5963                     else {
5964                         assert(flags & SCF_DO_STCLASS_OR);
5965                         ssc_union(data->start_class, my_invlist, invert);
5966                     }
5967                     SvREFCNT_dec(my_invlist);
5968                 }
5969                 if (flags & SCF_DO_STCLASS_OR)
5970                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5971                 flags &= ~SCF_DO_STCLASS;
5972             }
5973         }
5974         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5975             data->flags |= (OP(scan) == MEOL
5976                             ? SF_BEFORE_MEOL
5977                             : SF_BEFORE_SEOL);
5978             scan_commit(pRExC_state, data, minlenp, is_inf);
5979
5980         }
5981         else if (  PL_regkind[OP(scan)] == BRANCHJ
5982                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5983                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5984                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5985         {
5986             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5987                 || OP(scan) == UNLESSM )
5988             {
5989                 /* Negative Lookahead/lookbehind
5990                    In this case we can't do fixed string optimisation.
5991                 */
5992
5993                 SSize_t deltanext, minnext, fake = 0;
5994                 regnode *nscan;
5995                 regnode_ssc intrnl;
5996                 int f = 0;
5997
5998                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5999                 if (data) {
6000                     data_fake.whilem_c = data->whilem_c;
6001                     data_fake.last_closep = data->last_closep;
6002                 }
6003                 else
6004                     data_fake.last_closep = &fake;
6005                 data_fake.pos_delta = delta;
6006                 if ( flags & SCF_DO_STCLASS && !scan->flags
6007                      && OP(scan) == IFMATCH ) { /* Lookahead */
6008                     ssc_init(pRExC_state, &intrnl);
6009                     data_fake.start_class = &intrnl;
6010                     f |= SCF_DO_STCLASS_AND;
6011                 }
6012                 if (flags & SCF_WHILEM_VISITED_POS)
6013                     f |= SCF_WHILEM_VISITED_POS;
6014                 next = regnext(scan);
6015                 nscan = NEXTOPER(NEXTOPER(scan));
6016
6017                 /* recurse study_chunk() for lookahead body */
6018                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
6019                                       last, &data_fake, stopparen,
6020                                       recursed_depth, NULL, f, depth+1);
6021                 if (scan->flags) {
6022                     if (   deltanext < 0
6023                         || deltanext > (I32) U8_MAX
6024                         || minnext > (I32)U8_MAX
6025                         || minnext + deltanext > (I32)U8_MAX)
6026                     {
6027                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6028                               (UV)U8_MAX);
6029                     }
6030
6031                     /* The 'next_off' field has been repurposed to count the
6032                      * additional starting positions to try beyond the initial
6033                      * one.  (This leaves it at 0 for non-variable length
6034                      * matches to avoid breakage for those not using this
6035                      * extension) */
6036                     if (deltanext) {
6037                         scan->next_off = deltanext;
6038                         ckWARNexperimental(RExC_parse,
6039                             WARN_EXPERIMENTAL__VLB,
6040                             "Variable length lookbehind is experimental");
6041                     }
6042                     scan->flags = (U8)minnext + deltanext;
6043                 }
6044                 if (data) {
6045                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6046                         pars++;
6047                     if (data_fake.flags & SF_HAS_EVAL)
6048                         data->flags |= SF_HAS_EVAL;
6049                     data->whilem_c = data_fake.whilem_c;
6050                 }
6051                 if (f & SCF_DO_STCLASS_AND) {
6052                     if (flags & SCF_DO_STCLASS_OR) {
6053                         /* OR before, AND after: ideally we would recurse with
6054                          * data_fake to get the AND applied by study of the
6055                          * remainder of the pattern, and then derecurse;
6056                          * *** HACK *** for now just treat as "no information".
6057                          * See [perl #56690].
6058                          */
6059                         ssc_init(pRExC_state, data->start_class);
6060                     }  else {
6061                         /* AND before and after: combine and continue.  These
6062                          * assertions are zero-length, so can match an EMPTY
6063                          * string */
6064                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6065                         ANYOF_FLAGS(data->start_class)
6066                                                    |= SSC_MATCHES_EMPTY_STRING;
6067                     }
6068                 }
6069             }
6070 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
6071             else {
6072                 /* Positive Lookahead/lookbehind
6073                    In this case we can do fixed string optimisation,
6074                    but we must be careful about it. Note in the case of
6075                    lookbehind the positions will be offset by the minimum
6076                    length of the pattern, something we won't know about
6077                    until after the recurse.
6078                 */
6079                 SSize_t deltanext, fake = 0;
6080                 regnode *nscan;
6081                 regnode_ssc intrnl;
6082                 int f = 0;
6083                 /* We use SAVEFREEPV so that when the full compile
6084                     is finished perl will clean up the allocated
6085                     minlens when it's all done. This way we don't
6086                     have to worry about freeing them when we know
6087                     they wont be used, which would be a pain.
6088                  */
6089                 SSize_t *minnextp;
6090                 Newx( minnextp, 1, SSize_t );
6091                 SAVEFREEPV(minnextp);
6092
6093                 if (data) {
6094                     StructCopy(data, &data_fake, scan_data_t);
6095                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
6096                         f |= SCF_DO_SUBSTR;
6097                         if (scan->flags)
6098                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
6099                         data_fake.last_found=newSVsv(data->last_found);
6100                     }
6101                 }
6102                 else
6103                     data_fake.last_closep = &fake;
6104                 data_fake.flags = 0;
6105                 data_fake.substrs[0].flags = 0;
6106                 data_fake.substrs[1].flags = 0;
6107                 data_fake.pos_delta = delta;
6108                 if (is_inf)
6109                     data_fake.flags |= SF_IS_INF;
6110                 if ( flags & SCF_DO_STCLASS && !scan->flags
6111                      && OP(scan) == IFMATCH ) { /* Lookahead */
6112                     ssc_init(pRExC_state, &intrnl);
6113                     data_fake.start_class = &intrnl;
6114                     f |= SCF_DO_STCLASS_AND;
6115                 }
6116                 if (flags & SCF_WHILEM_VISITED_POS)
6117                     f |= SCF_WHILEM_VISITED_POS;
6118                 next = regnext(scan);
6119                 nscan = NEXTOPER(NEXTOPER(scan));
6120
6121                 /* positive lookahead study_chunk() recursion */
6122                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
6123                                         &deltanext, last, &data_fake,
6124                                         stopparen, recursed_depth, NULL,
6125                                         f, depth+1);
6126                 if (scan->flags) {
6127                     assert(0);  /* This code has never been tested since this
6128                                    is normally not compiled */
6129                     if (   deltanext < 0
6130                         || deltanext > (I32) U8_MAX
6131                         || *minnextp > (I32)U8_MAX
6132                         || *minnextp + deltanext > (I32)U8_MAX)
6133                     {
6134                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6135                               (UV)U8_MAX);
6136                     }
6137
6138                     if (deltanext) {
6139                         scan->next_off = deltanext;
6140                     }
6141                     scan->flags = (U8)*minnextp + deltanext;
6142                 }
6143
6144                 *minnextp += min;
6145
6146                 if (f & SCF_DO_STCLASS_AND) {
6147                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6148                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
6149                 }
6150                 if (data) {
6151                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6152                         pars++;
6153                     if (data_fake.flags & SF_HAS_EVAL)
6154                         data->flags |= SF_HAS_EVAL;
6155                     data->whilem_c = data_fake.whilem_c;
6156                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
6157                         int i;
6158                         if (RExC_rx->minlen<*minnextp)
6159                             RExC_rx->minlen=*minnextp;
6160                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
6161                         SvREFCNT_dec_NN(data_fake.last_found);
6162
6163                         for (i = 0; i < 2; i++) {
6164                             if (data_fake.substrs[i].minlenp != minlenp) {
6165                                 data->substrs[i].min_offset =
6166                                             data_fake.substrs[i].min_offset;
6167                                 data->substrs[i].max_offset =
6168                                             data_fake.substrs[i].max_offset;
6169                                 data->substrs[i].minlenp =
6170                                             data_fake.substrs[i].minlenp;
6171                                 data->substrs[i].lookbehind += scan->flags;
6172                             }
6173                         }
6174                     }
6175                 }
6176             }
6177 #endif
6178         }
6179
6180         else if (OP(scan) == OPEN) {
6181             if (stopparen != (I32)ARG(scan))
6182                 pars++;
6183         }
6184         else if (OP(scan) == CLOSE) {
6185             if (stopparen == (I32)ARG(scan)) {
6186                 break;
6187             }
6188             if ((I32)ARG(scan) == is_par) {
6189                 next = regnext(scan);
6190
6191                 if ( next && (OP(next) != WHILEM) && next < last)
6192                     is_par = 0;         /* Disable optimization */
6193             }
6194             if (data)
6195                 *(data->last_closep) = ARG(scan);
6196         }
6197         else if (OP(scan) == EVAL) {
6198                 if (data)
6199                     data->flags |= SF_HAS_EVAL;
6200         }
6201         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
6202             if (flags & SCF_DO_SUBSTR) {
6203                 scan_commit(pRExC_state, data, minlenp, is_inf);
6204                 flags &= ~SCF_DO_SUBSTR;
6205             }
6206             if (data && OP(scan)==ACCEPT) {
6207                 data->flags |= SCF_SEEN_ACCEPT;
6208                 if (stopmin > min)
6209                     stopmin = min;
6210             }
6211         }
6212         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
6213         {
6214                 if (flags & SCF_DO_SUBSTR) {
6215                     scan_commit(pRExC_state, data, minlenp, is_inf);
6216                     data->cur_is_floating = 1; /* float */
6217                 }
6218                 is_inf = is_inf_internal = 1;
6219                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
6220                     ssc_anything(data->start_class);
6221                 flags &= ~SCF_DO_STCLASS;
6222         }
6223         else if (OP(scan) == GPOS) {
6224             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
6225                 !(delta || is_inf || (data && data->pos_delta)))
6226             {
6227                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
6228                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
6229                 if (RExC_rx->gofs < (STRLEN)min)
6230                     RExC_rx->gofs = min;
6231             } else {
6232                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
6233                 RExC_rx->gofs = 0;
6234             }
6235         }
6236 #ifdef TRIE_STUDY_OPT
6237 #ifdef FULL_TRIE_STUDY
6238         else if (PL_regkind[OP(scan)] == TRIE) {
6239             /* NOTE - There is similar code to this block above for handling
6240                BRANCH nodes on the initial study.  If you change stuff here
6241                check there too. */
6242             regnode *trie_node= scan;
6243             regnode *tail= regnext(scan);
6244             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6245             SSize_t max1 = 0, min1 = SSize_t_MAX;
6246             regnode_ssc accum;
6247
6248             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
6249                 /* Cannot merge strings after this. */
6250                 scan_commit(pRExC_state, data, minlenp, is_inf);
6251             }
6252             if (flags & SCF_DO_STCLASS)
6253                 ssc_init_zero(pRExC_state, &accum);
6254
6255             if (!trie->jump) {
6256                 min1= trie->minlen;
6257                 max1= trie->maxlen;
6258             } else {
6259                 const regnode *nextbranch= NULL;
6260                 U32 word;
6261
6262                 for ( word=1 ; word <= trie->wordcount ; word++)
6263                 {
6264                     SSize_t deltanext=0, minnext=0, f = 0, fake;
6265                     regnode_ssc this_class;
6266
6267                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
6268                     if (data) {
6269                         data_fake.whilem_c = data->whilem_c;
6270                         data_fake.last_closep = data->last_closep;
6271                     }
6272                     else
6273                         data_fake.last_closep = &fake;
6274                     data_fake.pos_delta = delta;
6275                     if (flags & SCF_DO_STCLASS) {
6276                         ssc_init(pRExC_state, &this_class);
6277                         data_fake.start_class = &this_class;
6278                         f = SCF_DO_STCLASS_AND;
6279                     }
6280                     if (flags & SCF_WHILEM_VISITED_POS)
6281                         f |= SCF_WHILEM_VISITED_POS;
6282
6283                     if (trie->jump[word]) {
6284                         if (!nextbranch)
6285                             nextbranch = trie_node + trie->jump[0];
6286                         scan= trie_node + trie->jump[word];
6287                         /* We go from the jump point to the branch that follows
6288                            it. Note this means we need the vestigal unused
6289                            branches even though they arent otherwise used. */
6290                         /* optimise study_chunk() for TRIE */
6291                         minnext = study_chunk(pRExC_state, &scan, minlenp,
6292                             &deltanext, (regnode *)nextbranch, &data_fake,
6293                             stopparen, recursed_depth, NULL, f, depth+1);
6294                     }
6295                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
6296                         nextbranch= regnext((regnode*)nextbranch);
6297
6298                     if (min1 > (SSize_t)(minnext + trie->minlen))
6299                         min1 = minnext + trie->minlen;
6300                     if (deltanext == SSize_t_MAX) {
6301                         is_inf = is_inf_internal = 1;
6302                         max1 = SSize_t_MAX;
6303                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
6304                         max1 = minnext + deltanext + trie->maxlen;
6305
6306                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6307                         pars++;
6308                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
6309                         if ( stopmin > min + min1)
6310                             stopmin = min + min1;
6311                         flags &= ~SCF_DO_SUBSTR;
6312                         if (data)
6313                             data->flags |= SCF_SEEN_ACCEPT;
6314                     }
6315                     if (data) {
6316                         if (data_fake.flags & SF_HAS_EVAL)
6317                             data->flags |= SF_HAS_EVAL;
6318                         data->whilem_c = data_fake.whilem_c;
6319                     }
6320                     if (flags & SCF_DO_STCLASS)
6321                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
6322                 }
6323             }
6324             if (flags & SCF_DO_SUBSTR) {
6325                 data->pos_min += min1;
6326                 data->pos_delta += max1 - min1;
6327                 if (max1 != min1 || is_inf)
6328                     data->cur_is_floating = 1; /* float */
6329             }
6330             min += min1;
6331             if (delta != SSize_t_MAX) {
6332                 if (SSize_t_MAX - (max1 - min1) >= delta)
6333                     delta += max1 - min1;
6334                 else
6335                     delta = SSize_t_MAX;
6336             }
6337             if (flags & SCF_DO_STCLASS_OR) {
6338                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6339                 if (min1) {
6340                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6341                     flags &= ~SCF_DO_STCLASS;
6342                 }
6343             }
6344             else if (flags & SCF_DO_STCLASS_AND) {
6345                 if (min1) {
6346                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6347                     flags &= ~SCF_DO_STCLASS;
6348                 }
6349                 else {
6350                     /* Switch to OR mode: cache the old value of
6351                      * data->start_class */
6352                     INIT_AND_WITHP;
6353                     StructCopy(data->start_class, and_withp, regnode_ssc);
6354                     flags &= ~SCF_DO_STCLASS_AND;
6355                     StructCopy(&accum, data->start_class, regnode_ssc);
6356                     flags |= SCF_DO_STCLASS_OR;
6357                 }
6358             }
6359             scan= tail;
6360             continue;
6361         }
6362 #else
6363         else if (PL_regkind[OP(scan)] == TRIE) {
6364             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6365             U8*bang=NULL;
6366
6367             min += trie->minlen;
6368             delta += (trie->maxlen - trie->minlen);
6369             flags &= ~SCF_DO_STCLASS; /* xxx */
6370             if (flags & SCF_DO_SUBSTR) {
6371                 /* Cannot expect anything... */
6372                 scan_commit(pRExC_state, data, minlenp, is_inf);
6373                 data->pos_min += trie->minlen;
6374                 data->pos_delta += (trie->maxlen - trie->minlen);
6375                 if (trie->maxlen != trie->minlen)
6376                     data->cur_is_floating = 1; /* float */
6377             }
6378             if (trie->jump) /* no more substrings -- for now /grr*/
6379                flags &= ~SCF_DO_SUBSTR;
6380         }
6381 #endif /* old or new */
6382 #endif /* TRIE_STUDY_OPT */
6383
6384         /* Else: zero-length, ignore. */
6385         scan = regnext(scan);
6386     }
6387
6388   finish:
6389     if (frame) {
6390         /* we need to unwind recursion. */
6391         depth = depth - 1;
6392
6393         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
6394         DEBUG_PEEP("fend", scan, depth, flags);
6395
6396         /* restore previous context */
6397         last = frame->last_regnode;
6398         scan = frame->next_regnode;
6399         stopparen = frame->stopparen;
6400         recursed_depth = frame->prev_recursed_depth;
6401
6402         RExC_frame_last = frame->prev_frame;
6403         frame = frame->this_prev_frame;
6404         goto fake_study_recurse;
6405     }
6406
6407     assert(!frame);
6408     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6409
6410     *scanp = scan;
6411     *deltap = is_inf_internal ? SSize_t_MAX : delta;
6412
6413     if (flags & SCF_DO_SUBSTR && is_inf)
6414         data->pos_delta = SSize_t_MAX - data->pos_min;
6415     if (is_par > (I32)U8_MAX)
6416         is_par = 0;
6417     if (is_par && pars==1 && data) {
6418         data->flags |= SF_IN_PAR;
6419         data->flags &= ~SF_HAS_PAR;
6420     }
6421     else if (pars && data) {
6422         data->flags |= SF_HAS_PAR;
6423         data->flags &= ~SF_IN_PAR;
6424     }
6425     if (flags & SCF_DO_STCLASS_OR)
6426         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6427     if (flags & SCF_TRIE_RESTUDY)
6428         data->flags |=  SCF_TRIE_RESTUDY;
6429
6430     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6431
6432     {
6433         SSize_t final_minlen= min < stopmin ? min : stopmin;
6434
6435         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6436             if (final_minlen > SSize_t_MAX - delta)
6437                 RExC_maxlen = SSize_t_MAX;
6438             else if (RExC_maxlen < final_minlen + delta)
6439                 RExC_maxlen = final_minlen + delta;
6440         }
6441         return final_minlen;
6442     }
6443     NOT_REACHED; /* NOTREACHED */
6444 }
6445
6446 STATIC U32
6447 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6448 {
6449     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6450
6451     PERL_ARGS_ASSERT_ADD_DATA;
6452
6453     Renewc(RExC_rxi->data,
6454            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6455            char, struct reg_data);
6456     if(count)
6457         Renew(RExC_rxi->data->what, count + n, U8);
6458     else
6459         Newx(RExC_rxi->data->what, n, U8);
6460     RExC_rxi->data->count = count + n;
6461     Copy(s, RExC_rxi->data->what + count, n, U8);
6462     return count;
6463 }
6464
6465 /*XXX: todo make this not included in a non debugging perl, but appears to be
6466  * used anyway there, in 'use re' */
6467 #ifndef PERL_IN_XSUB_RE
6468 void
6469 Perl_reginitcolors(pTHX)
6470 {
6471     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6472     if (s) {
6473         char *t = savepv(s);
6474         int i = 0;
6475         PL_colors[0] = t;
6476         while (++i < 6) {
6477             t = strchr(t, '\t');
6478             if (t) {
6479                 *t = '\0';
6480                 PL_colors[i] = ++t;
6481             }
6482             else
6483                 PL_colors[i] = t = (char *)"";
6484         }
6485     } else {
6486         int i = 0;
6487         while (i < 6)
6488             PL_colors[i++] = (char *)"";
6489     }
6490     PL_colorset = 1;
6491 }
6492 #endif
6493
6494
6495 #ifdef TRIE_STUDY_OPT
6496 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6497     STMT_START {                                            \
6498         if (                                                \
6499               (data.flags & SCF_TRIE_RESTUDY)               \
6500               && ! restudied++                              \
6501         ) {                                                 \
6502             dOsomething;                                    \
6503             goto reStudy;                                   \
6504         }                                                   \
6505     } STMT_END
6506 #else
6507 #define CHECK_RESTUDY_GOTO_butfirst
6508 #endif
6509
6510 /*
6511  * pregcomp - compile a regular expression into internal code
6512  *
6513  * Decides which engine's compiler to call based on the hint currently in
6514  * scope
6515  */
6516
6517 #ifndef PERL_IN_XSUB_RE
6518
6519 /* return the currently in-scope regex engine (or the default if none)  */
6520
6521 regexp_engine const *
6522 Perl_current_re_engine(pTHX)
6523 {
6524     if (IN_PERL_COMPILETIME) {
6525         HV * const table = GvHV(PL_hintgv);
6526         SV **ptr;
6527
6528         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6529             return &PL_core_reg_engine;
6530         ptr = hv_fetchs(table, "regcomp", FALSE);
6531         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6532             return &PL_core_reg_engine;
6533         return INT2PTR(regexp_engine*, SvIV(*ptr));
6534     }
6535     else {
6536         SV *ptr;
6537         if (!PL_curcop->cop_hints_hash)
6538             return &PL_core_reg_engine;
6539         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6540         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6541             return &PL_core_reg_engine;
6542         return INT2PTR(regexp_engine*, SvIV(ptr));
6543     }
6544 }
6545
6546
6547 REGEXP *
6548 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6549 {
6550     regexp_engine const *eng = current_re_engine();
6551     GET_RE_DEBUG_FLAGS_DECL;
6552
6553     PERL_ARGS_ASSERT_PREGCOMP;
6554
6555     /* Dispatch a request to compile a regexp to correct regexp engine. */
6556     DEBUG_COMPILE_r({
6557         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6558                         PTR2UV(eng));
6559     });
6560     return CALLREGCOMP_ENG(eng, pattern, flags);
6561 }
6562 #endif
6563
6564 /* public(ish) entry point for the perl core's own regex compiling code.
6565  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6566  * pattern rather than a list of OPs, and uses the internal engine rather
6567  * than the current one */
6568
6569 REGEXP *
6570 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6571 {
6572     SV *pat = pattern; /* defeat constness! */
6573     PERL_ARGS_ASSERT_RE_COMPILE;
6574     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6575 #ifdef PERL_IN_XSUB_RE
6576                                 &my_reg_engine,
6577 #else
6578                                 &PL_core_reg_engine,
6579 #endif
6580                                 NULL, NULL, rx_flags, 0);
6581 }
6582
6583
6584 static void
6585 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6586 {
6587     int n;
6588
6589     if (--cbs->refcnt > 0)
6590         return;
6591     for (n = 0; n < cbs->count; n++) {
6592         REGEXP *rx = cbs->cb[n].src_regex;
6593         if (rx) {
6594             cbs->cb[n].src_regex = NULL;
6595             SvREFCNT_dec_NN(rx);
6596         }
6597     }
6598     Safefree(cbs->cb);
6599     Safefree(cbs);
6600 }
6601
6602
6603 static struct reg_code_blocks *
6604 S_alloc_code_blocks(pTHX_  int ncode)
6605 {
6606      struct reg_code_blocks *cbs;
6607     Newx(cbs, 1, struct reg_code_blocks);
6608     cbs->count = ncode;
6609     cbs->refcnt = 1;
6610     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6611     if (ncode)
6612         Newx(cbs->cb, ncode, struct reg_code_block);
6613     else
6614         cbs->cb = NULL;
6615     return cbs;
6616 }
6617
6618
6619 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6620  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6621  * point to the realloced string and length.
6622  *
6623  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6624  * stuff added */
6625
6626 static void
6627 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6628                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6629 {
6630     U8 *const src = (U8*)*pat_p;
6631     U8 *dst, *d;
6632     int n=0;
6633     STRLEN s = 0;
6634     bool do_end = 0;
6635     GET_RE_DEBUG_FLAGS_DECL;
6636
6637     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6638         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6639
6640     /* 1 for each byte + 1 for each byte that expands to two, + trailing NUL */
6641     Newx(dst, *plen_p + variant_under_utf8_count(src, src + *plen_p) + 1, U8);
6642     d = dst;
6643
6644     while (s < *plen_p) {
6645         append_utf8_from_native_byte(src[s], &d);
6646
6647         if (n < num_code_blocks) {
6648             assert(pRExC_state->code_blocks);
6649             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6650                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6651                 assert(*(d - 1) == '(');
6652                 do_end = 1;
6653             }
6654             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6655                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6656                 assert(*(d - 1) == ')');
6657                 do_end = 0;
6658                 n++;
6659             }
6660         }
6661         s++;
6662     }
6663     *d = '\0';
6664     *plen_p = d - dst;
6665     *pat_p = (char*) dst;
6666     SAVEFREEPV(*pat_p);
6667     RExC_orig_utf8 = RExC_utf8 = 1;
6668 }
6669
6670
6671
6672 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6673  * while recording any code block indices, and handling overloading,
6674  * nested qr// objects etc.  If pat is null, it will allocate a new
6675  * string, or just return the first arg, if there's only one.
6676  *
6677  * Returns the malloced/updated pat.
6678  * patternp and pat_count is the array of SVs to be concatted;
6679  * oplist is the optional list of ops that generated the SVs;
6680  * recompile_p is a pointer to a boolean that will be set if
6681  *   the regex will need to be recompiled.
6682  * delim, if non-null is an SV that will be inserted between each element
6683  */
6684
6685 static SV*
6686 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6687                 SV *pat, SV ** const patternp, int pat_count,
6688                 OP *oplist, bool *recompile_p, SV *delim)
6689 {
6690     SV **svp;
6691     int n = 0;
6692     bool use_delim = FALSE;
6693     bool alloced = FALSE;
6694
6695     /* if we know we have at least two args, create an empty string,
6696      * then concatenate args to that. For no args, return an empty string */
6697     if (!pat && pat_count != 1) {
6698         pat = newSVpvs("");
6699         SAVEFREESV(pat);
6700         alloced = TRUE;
6701     }
6702
6703     for (svp = patternp; svp < patternp + pat_count; svp++) {
6704         SV *sv;
6705         SV *rx  = NULL;
6706         STRLEN orig_patlen = 0;
6707         bool code = 0;
6708         SV *msv = use_delim ? delim : *svp;
6709         if (!msv) msv = &PL_sv_undef;
6710
6711         /* if we've got a delimiter, we go round the loop twice for each
6712          * svp slot (except the last), using the delimiter the second
6713          * time round */
6714         if (use_delim) {
6715             svp--;
6716             use_delim = FALSE;
6717         }
6718         else if (delim)
6719             use_delim = TRUE;
6720
6721         if (SvTYPE(msv) == SVt_PVAV) {
6722             /* we've encountered an interpolated array within
6723              * the pattern, e.g. /...@a..../. Expand the list of elements,
6724              * then recursively append elements.
6725              * The code in this block is based on S_pushav() */
6726
6727             AV *const av = (AV*)msv;
6728             const SSize_t maxarg = AvFILL(av) + 1;
6729             SV **array;
6730
6731             if (oplist) {
6732                 assert(oplist->op_type == OP_PADAV
6733                     || oplist->op_type == OP_RV2AV);
6734                 oplist = OpSIBLING(oplist);
6735             }
6736
6737             if (SvRMAGICAL(av)) {
6738                 SSize_t i;
6739
6740                 Newx(array, maxarg, SV*);
6741                 SAVEFREEPV(array);
6742                 for (i=0; i < maxarg; i++) {
6743                     SV ** const svp = av_fetch(av, i, FALSE);
6744                     array[i] = svp ? *svp : &PL_sv_undef;
6745                 }
6746             }
6747             else
6748                 array = AvARRAY(av);
6749
6750             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6751                                 array, maxarg, NULL, recompile_p,
6752                                 /* $" */
6753                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6754
6755             continue;
6756         }
6757
6758
6759         /* we make the assumption here that each op in the list of
6760          * op_siblings maps to one SV pushed onto the stack,
6761          * except for code blocks, with have both an OP_NULL and
6762          * and OP_CONST.
6763          * This allows us to match up the list of SVs against the
6764          * list of OPs to find the next code block.
6765          *
6766          * Note that       PUSHMARK PADSV PADSV ..
6767          * is optimised to
6768          *                 PADRANGE PADSV  PADSV  ..
6769          * so the alignment still works. */
6770
6771         if (oplist) {
6772             if (oplist->op_type == OP_NULL
6773                 && (oplist->op_flags & OPf_SPECIAL))
6774             {
6775                 assert(n < pRExC_state->code_blocks->count);
6776                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6777                 pRExC_state->code_blocks->cb[n].block = oplist;
6778                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6779                 n++;
6780                 code = 1;
6781                 oplist = OpSIBLING(oplist); /* skip CONST */
6782                 assert(oplist);
6783             }
6784             oplist = OpSIBLING(oplist);;
6785         }
6786
6787         /* apply magic and QR overloading to arg */
6788
6789         SvGETMAGIC(msv);
6790         if (SvROK(msv) && SvAMAGIC(msv)) {
6791             SV *sv = AMG_CALLunary(msv, regexp_amg);
6792             if (sv) {
6793                 if (SvROK(sv))
6794                     sv = SvRV(sv);
6795                 if (SvTYPE(sv) != SVt_REGEXP)
6796                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6797                 msv = sv;
6798             }
6799         }
6800
6801         /* try concatenation overload ... */
6802         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6803                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6804         {
6805             sv_setsv(pat, sv);
6806             /* overloading involved: all bets are off over literal
6807              * code. Pretend we haven't seen it */
6808             if (n)
6809                 pRExC_state->code_blocks->count -= n;
6810             n = 0;
6811         }
6812         else  {
6813             /* ... or failing that, try "" overload */
6814             while (SvAMAGIC(msv)
6815                     && (sv = AMG_CALLunary(msv, string_amg))
6816                     && sv != msv
6817                     &&  !(   SvROK(msv)
6818                           && SvROK(sv)
6819                           && SvRV(msv) == SvRV(sv))
6820             ) {
6821                 msv = sv;
6822                 SvGETMAGIC(msv);
6823             }
6824             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6825                 msv = SvRV(msv);
6826
6827             if (pat) {
6828                 /* this is a partially unrolled
6829                  *     sv_catsv_nomg(pat, msv);
6830                  * that allows us to adjust code block indices if
6831                  * needed */
6832                 STRLEN dlen;
6833                 char *dst = SvPV_force_nomg(pat, dlen);
6834                 orig_patlen = dlen;
6835                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6836                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6837                     sv_setpvn(pat, dst, dlen);
6838                     SvUTF8_on(pat);
6839                 }
6840                 sv_catsv_nomg(pat, msv);
6841                 rx = msv;
6842             }
6843             else {
6844                 /* We have only one SV to process, but we need to verify
6845                  * it is properly null terminated or we will fail asserts
6846                  * later. In theory we probably shouldn't get such SV's,
6847                  * but if we do we should handle it gracefully. */
6848                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) || SvIsCOW_shared_hash(msv) ) {
6849                     /* not a string, or a string with a trailing null */
6850                     pat = msv;
6851                 } else {
6852                     /* a string with no trailing null, we need to copy it
6853                      * so it has a trailing null */
6854                     pat = sv_2mortal(newSVsv(msv));
6855                 }
6856             }
6857
6858             if (code)
6859                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
6860         }
6861
6862         /* extract any code blocks within any embedded qr//'s */
6863         if (rx && SvTYPE(rx) == SVt_REGEXP
6864             && RX_ENGINE((REGEXP*)rx)->op_comp)
6865         {
6866
6867             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6868             if (ri->code_blocks && ri->code_blocks->count) {
6869                 int i;
6870                 /* the presence of an embedded qr// with code means
6871                  * we should always recompile: the text of the
6872                  * qr// may not have changed, but it may be a
6873                  * different closure than last time */
6874                 *recompile_p = 1;
6875                 if (pRExC_state->code_blocks) {
6876                     int new_count = pRExC_state->code_blocks->count
6877                             + ri->code_blocks->count;
6878                     Renew(pRExC_state->code_blocks->cb,
6879                             new_count, struct reg_code_block);
6880                     pRExC_state->code_blocks->count = new_count;
6881                 }
6882                 else
6883                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
6884                                                     ri->code_blocks->count);
6885
6886                 for (i=0; i < ri->code_blocks->count; i++) {
6887                     struct reg_code_block *src, *dst;
6888                     STRLEN offset =  orig_patlen
6889                         + ReANY((REGEXP *)rx)->pre_prefix;
6890                     assert(n < pRExC_state->code_blocks->count);
6891                     src = &ri->code_blocks->cb[i];
6892                     dst = &pRExC_state->code_blocks->cb[n];
6893                     dst->start      = src->start + offset;
6894                     dst->end        = src->end   + offset;
6895                     dst->block      = src->block;
6896                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6897                                             src->src_regex
6898                                                 ? src->src_regex
6899                                                 : (REGEXP*)rx);
6900                     n++;
6901                 }
6902             }
6903         }
6904     }
6905     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6906     if (alloced)
6907         SvSETMAGIC(pat);
6908
6909     return pat;
6910 }
6911
6912
6913
6914 /* see if there are any run-time code blocks in the pattern.
6915  * False positives are allowed */
6916
6917 static bool
6918 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6919                     char *pat, STRLEN plen)
6920 {
6921     int n = 0;
6922     STRLEN s;
6923
6924     PERL_UNUSED_CONTEXT;
6925
6926     for (s = 0; s < plen; s++) {
6927         if (   pRExC_state->code_blocks
6928             && n < pRExC_state->code_blocks->count
6929             && s == pRExC_state->code_blocks->cb[n].start)
6930         {
6931             s = pRExC_state->code_blocks->cb[n].end;
6932             n++;
6933             continue;
6934         }
6935         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6936          * positives here */
6937         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6938             (pat[s+2] == '{'
6939                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6940         )
6941             return 1;
6942     }
6943     return 0;
6944 }
6945
6946 /* Handle run-time code blocks. We will already have compiled any direct
6947  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6948  * copy of it, but with any literal code blocks blanked out and
6949  * appropriate chars escaped; then feed it into
6950  *
6951  *    eval "qr'modified_pattern'"
6952  *
6953  * For example,
6954  *
6955  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6956  *
6957  * becomes
6958  *
6959  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6960  *
6961  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6962  * and merge them with any code blocks of the original regexp.
6963  *
6964  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6965  * instead, just save the qr and return FALSE; this tells our caller that
6966  * the original pattern needs upgrading to utf8.
6967  */
6968
6969 static bool
6970 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6971     char *pat, STRLEN plen)
6972 {
6973     SV *qr;
6974
6975     GET_RE_DEBUG_FLAGS_DECL;
6976
6977     if (pRExC_state->runtime_code_qr) {
6978         /* this is the second time we've been called; this should
6979          * only happen if the main pattern got upgraded to utf8
6980          * during compilation; re-use the qr we compiled first time
6981          * round (which should be utf8 too)
6982          */
6983         qr = pRExC_state->runtime_code_qr;
6984         pRExC_state->runtime_code_qr = NULL;
6985         assert(RExC_utf8 && SvUTF8(qr));
6986     }
6987     else {
6988         int n = 0;
6989         STRLEN s;
6990         char *p, *newpat;
6991         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
6992         SV *sv, *qr_ref;
6993         dSP;
6994
6995         /* determine how many extra chars we need for ' and \ escaping */
6996         for (s = 0; s < plen; s++) {
6997             if (pat[s] == '\'' || pat[s] == '\\')
6998                 newlen++;
6999         }
7000
7001         Newx(newpat, newlen, char);
7002         p = newpat;
7003         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
7004
7005         for (s = 0; s < plen; s++) {
7006             if (   pRExC_state->code_blocks
7007                 && n < pRExC_state->code_blocks->count
7008                 && s == pRExC_state->code_blocks->cb[n].start)
7009             {
7010                 /* blank out literal code block so that they aren't
7011                  * recompiled: eg change from/to:
7012                  *     /(?{xyz})/
7013                  *     /(?=====)/
7014                  * and
7015                  *     /(??{xyz})/
7016                  *     /(?======)/
7017                  * and
7018                  *     /(?(?{xyz}))/
7019                  *     /(?(?=====))/
7020                 */
7021                 assert(pat[s]   == '(');
7022                 assert(pat[s+1] == '?');
7023                 *p++ = '(';
7024                 *p++ = '?';
7025                 s += 2;
7026                 while (s < pRExC_state->code_blocks->cb[n].end) {
7027                     *p++ = '=';
7028                     s++;
7029                 }
7030                 *p++ = ')';
7031                 n++;
7032                 continue;
7033             }
7034             if (pat[s] == '\'' || pat[s] == '\\')
7035                 *p++ = '\\';
7036             *p++ = pat[s];
7037         }
7038         *p++ = '\'';
7039         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
7040             *p++ = 'x';
7041             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
7042                 *p++ = 'x';
7043             }
7044         }
7045         *p++ = '\0';
7046         DEBUG_COMPILE_r({
7047             Perl_re_printf( aTHX_
7048                 "%sre-parsing pattern for runtime code:%s %s\n",
7049                 PL_colors[4], PL_colors[5], newpat);
7050         });
7051
7052         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
7053         Safefree(newpat);
7054
7055         ENTER;
7056         SAVETMPS;
7057         save_re_context();
7058         PUSHSTACKi(PERLSI_REQUIRE);
7059         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
7060          * parsing qr''; normally only q'' does this. It also alters
7061          * hints handling */
7062         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
7063         SvREFCNT_dec_NN(sv);
7064         SPAGAIN;
7065         qr_ref = POPs;
7066         PUTBACK;
7067         {
7068             SV * const errsv = ERRSV;
7069             if (SvTRUE_NN(errsv))
7070                 /* use croak_sv ? */
7071                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
7072         }
7073         assert(SvROK(qr_ref));
7074         qr = SvRV(qr_ref);
7075         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
7076         /* the leaving below frees the tmp qr_ref.
7077          * Give qr a life of its own */
7078         SvREFCNT_inc(qr);
7079         POPSTACK;
7080         FREETMPS;
7081         LEAVE;
7082
7083     }
7084
7085     if (!RExC_utf8 && SvUTF8(qr)) {
7086         /* first time through; the pattern got upgraded; save the
7087          * qr for the next time through */
7088         assert(!pRExC_state->runtime_code_qr);
7089         pRExC_state->runtime_code_qr = qr;
7090         return 0;
7091     }
7092
7093
7094     /* extract any code blocks within the returned qr//  */
7095
7096
7097     /* merge the main (r1) and run-time (r2) code blocks into one */
7098     {
7099         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
7100         struct reg_code_block *new_block, *dst;
7101         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
7102         int i1 = 0, i2 = 0;
7103         int r1c, r2c;
7104
7105         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
7106         {
7107             SvREFCNT_dec_NN(qr);
7108             return 1;
7109         }
7110
7111         if (!r1->code_blocks)
7112             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
7113
7114         r1c = r1->code_blocks->count;
7115         r2c = r2->code_blocks->count;
7116
7117         Newx(new_block, r1c + r2c, struct reg_code_block);
7118
7119         dst = new_block;
7120
7121         while (i1 < r1c || i2 < r2c) {
7122             struct reg_code_block *src;
7123             bool is_qr = 0;
7124
7125             if (i1 == r1c) {
7126                 src = &r2->code_blocks->cb[i2++];
7127                 is_qr = 1;
7128             }
7129             else if (i2 == r2c)
7130                 src = &r1->code_blocks->cb[i1++];
7131             else if (  r1->code_blocks->cb[i1].start
7132                      < r2->code_blocks->cb[i2].start)
7133             {
7134                 src = &r1->code_blocks->cb[i1++];
7135                 assert(src->end < r2->code_blocks->cb[i2].start);
7136             }
7137             else {
7138                 assert(  r1->code_blocks->cb[i1].start
7139                        > r2->code_blocks->cb[i2].start);
7140                 src = &r2->code_blocks->cb[i2++];
7141                 is_qr = 1;
7142                 assert(src->end < r1->code_blocks->cb[i1].start);
7143             }
7144
7145             assert(pat[src->start] == '(');
7146             assert(pat[src->end]   == ')');
7147             dst->start      = src->start;
7148             dst->end        = src->end;
7149             dst->block      = src->block;
7150             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
7151                                     : src->src_regex;
7152             dst++;
7153         }
7154         r1->code_blocks->count += r2c;
7155         Safefree(r1->code_blocks->cb);
7156         r1->code_blocks->cb = new_block;
7157     }
7158
7159     SvREFCNT_dec_NN(qr);
7160     return 1;
7161 }
7162
7163
7164 STATIC bool
7165 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
7166                       struct reg_substr_datum  *rsd,
7167                       struct scan_data_substrs *sub,
7168                       STRLEN longest_length)
7169 {
7170     /* This is the common code for setting up the floating and fixed length
7171      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
7172      * as to whether succeeded or not */
7173
7174     I32 t;
7175     SSize_t ml;
7176     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
7177     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
7178
7179     if (! (longest_length
7180            || (eol /* Can't have SEOL and MULTI */
7181                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
7182           )
7183             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
7184         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
7185     {
7186         return FALSE;
7187     }
7188
7189     /* copy the information about the longest from the reg_scan_data
7190         over to the program. */
7191     if (SvUTF8(sub->str)) {
7192         rsd->substr      = NULL;
7193         rsd->utf8_substr = sub->str;
7194     } else {
7195         rsd->substr      = sub->str;
7196         rsd->utf8_substr = NULL;
7197     }
7198     /* end_shift is how many chars that must be matched that
7199         follow this item. We calculate it ahead of time as once the
7200         lookbehind offset is added in we lose the ability to correctly
7201         calculate it.*/
7202     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
7203     rsd->end_shift = ml - sub->min_offset
7204         - longest_length
7205             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
7206              * intead? - DAPM
7207             + (SvTAIL(sub->str) != 0)
7208             */
7209         + sub->lookbehind;
7210
7211     t = (eol/* Can't have SEOL and MULTI */
7212          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
7213     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
7214
7215     return TRUE;
7216 }
7217
7218 STATIC void
7219 S_set_regex_pv(pTHX_ RExC_state_t *pRExC_state, REGEXP *Rx)
7220 {
7221     /* Calculates and sets in the compiled pattern 'Rx' the string to compile,
7222      * properly wrapped with the right modifiers */
7223
7224     bool has_p     = ((RExC_rx->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7225     bool has_charset = RExC_utf8 || (get_regex_charset(RExC_rx->extflags)
7226                                                 != REGEX_DEPENDS_CHARSET);
7227
7228     /* The caret is output if there are any defaults: if not all the STD
7229         * flags are set, or if no character set specifier is needed */
7230     bool has_default =
7231                 (((RExC_rx->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7232                 || ! has_charset);
7233     bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7234                                                 == REG_RUN_ON_COMMENT_SEEN);
7235     U8 reganch = (U8)((RExC_rx->extflags & RXf_PMf_STD_PMMOD)
7236                         >> RXf_PMf_STD_PMMOD_SHIFT);
7237     const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7238     char *p;
7239     STRLEN pat_len = RExC_precomp_end - RExC_precomp;
7240
7241     /* We output all the necessary flags; we never output a minus, as all
7242         * those are defaults, so are
7243         * covered by the caret */
7244     const STRLEN wraplen = pat_len + has_p + has_runon
7245         + has_default       /* If needs a caret */
7246         + PL_bitcount[reganch] /* 1 char for each set standard flag */
7247
7248             /* If needs a character set specifier */
7249         + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7250         + (sizeof("(?:)") - 1);
7251
7252     PERL_ARGS_ASSERT_SET_REGEX_PV;
7253
7254     /* make sure PL_bitcount bounds not exceeded */
7255     assert(sizeof(STD_PAT_MODS) <= 8);
7256
7257     p = sv_grow(MUTABLE_SV(Rx), wraplen + 1); /* +1 for the ending NUL */
7258     SvPOK_on(Rx);
7259     if (RExC_utf8)
7260         SvFLAGS(Rx) |= SVf_UTF8;
7261     *p++='('; *p++='?';
7262
7263     /* If a default, cover it using the caret */
7264     if (has_default) {
7265         *p++= DEFAULT_PAT_MOD;
7266     }
7267     if (has_charset) {
7268         STRLEN len;
7269         const char* name;
7270
7271         name = get_regex_charset_name(RExC_rx->extflags, &len);
7272         if (strEQ(name, DEPENDS_PAT_MODS)) {  /* /d under UTF-8 => /u */
7273             assert(RExC_utf8);
7274             name = UNICODE_PAT_MODS;
7275             len = sizeof(UNICODE_PAT_MODS) - 1;
7276         }
7277         Copy(name, p, len, char);
7278         p += len;
7279     }
7280     if (has_p)
7281         *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7282     {
7283         char ch;
7284         while((ch = *fptr++)) {
7285             if(reganch & 1)
7286                 *p++ = ch;
7287             reganch >>= 1;
7288         }
7289     }
7290
7291     *p++ = ':';
7292     Copy(RExC_precomp, p, pat_len, char);
7293     assert ((RX_WRAPPED(Rx) - p) < 16);
7294     RExC_rx->pre_prefix = p - RX_WRAPPED(Rx);
7295     p += pat_len;
7296
7297     /* Adding a trailing \n causes this to compile properly:
7298             my $R = qr / A B C # D E/x; /($R)/
7299         Otherwise the parens are considered part of the comment */
7300     if (has_runon)
7301         *p++ = '\n';
7302     *p++ = ')';
7303     *p = 0;
7304     SvCUR_set(Rx, p - RX_WRAPPED(Rx));
7305 }
7306
7307 /*
7308  * Perl_re_op_compile - the perl internal RE engine's function to compile a
7309  * regular expression into internal code.
7310  * The pattern may be passed either as:
7311  *    a list of SVs (patternp plus pat_count)
7312  *    a list of OPs (expr)
7313  * If both are passed, the SV list is used, but the OP list indicates
7314  * which SVs are actually pre-compiled code blocks
7315  *
7316  * The SVs in the list have magic and qr overloading applied to them (and
7317  * the list may be modified in-place with replacement SVs in the latter
7318  * case).
7319  *
7320  * If the pattern hasn't changed from old_re, then old_re will be
7321  * returned.
7322  *
7323  * eng is the current engine. If that engine has an op_comp method, then
7324  * handle directly (i.e. we assume that op_comp was us); otherwise, just
7325  * do the initial concatenation of arguments and pass on to the external
7326  * engine.
7327  *
7328  * If is_bare_re is not null, set it to a boolean indicating whether the
7329  * arg list reduced (after overloading) to a single bare regex which has
7330  * been returned (i.e. /$qr/).
7331  *
7332  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
7333  *
7334  * pm_flags contains the PMf_* flags, typically based on those from the
7335  * pm_flags field of the related PMOP. Currently we're only interested in
7336  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
7337  *
7338  * For many years this code had an initial sizing pass that calculated
7339  * (sometimes incorrectly, leading to security holes) the size needed for the
7340  * compiled pattern.  That was changed by commit
7341  * 7c932d07cab18751bfc7515b4320436273a459e2 in 5.29, which reallocs the size, a
7342  * node at a time, as parsing goes along.  Patches welcome to fix any obsolete
7343  * references to this sizing pass.
7344  *
7345  * Now, an initial crude guess as to the size needed is made, based on the
7346  * length of the pattern.  Patches welcome to improve that guess.  That amount
7347  * of space is malloc'd and then immediately freed, and then clawed back node
7348  * by node.  This design is to minimze, to the extent possible, memory churn
7349  * when doing the the reallocs.
7350  *
7351  * A separate parentheses counting pass may be needed in some cases.
7352  * (Previously the sizing pass did this.)  Patches welcome to reduce the number
7353  * of these cases.
7354  *
7355  * The existence of a sizing pass necessitated design decisions that are no
7356  * longer needed.  There are potential areas of simplification.
7357  *
7358  * Beware that the optimization-preparation code in here knows about some
7359  * of the structure of the compiled regexp.  [I'll say.]
7360  */
7361
7362 REGEXP *
7363 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
7364                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
7365                      bool *is_bare_re, const U32 orig_rx_flags, const U32 pm_flags)
7366 {
7367     dVAR;
7368     REGEXP *Rx;         /* Capital 'R' means points to a REGEXP */
7369     STRLEN plen;
7370     char *exp;
7371     regnode *scan;
7372     I32 flags;
7373     SSize_t minlen = 0;
7374     U32 rx_flags;
7375     SV *pat;
7376     SV** new_patternp = patternp;
7377
7378     /* these are all flags - maybe they should be turned
7379      * into a single int with different bit masks */
7380     I32 sawlookahead = 0;
7381     I32 sawplus = 0;
7382     I32 sawopen = 0;
7383     I32 sawminmod = 0;
7384
7385     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
7386     bool recompile = 0;
7387     bool runtime_code = 0;
7388     scan_data_t data;
7389     RExC_state_t RExC_state;
7390     RExC_state_t * const pRExC_state = &RExC_state;
7391 #ifdef TRIE_STUDY_OPT
7392     int restudied = 0;
7393     RExC_state_t copyRExC_state;
7394 #endif
7395     GET_RE_DEBUG_FLAGS_DECL;
7396
7397     PERL_ARGS_ASSERT_RE_OP_COMPILE;
7398
7399     DEBUG_r(if (!PL_colorset) reginitcolors());
7400
7401     /* Initialize these here instead of as-needed, as is quick and avoids
7402      * having to test them each time otherwise */
7403     if (! PL_InBitmap) {
7404 #ifdef DEBUGGING
7405         char * dump_len_string;
7406 #endif
7407
7408         /* This is calculated here, because the Perl program that generates the
7409          * static global ones doesn't currently have access to
7410          * NUM_ANYOF_CODE_POINTS */
7411         PL_InBitmap = _new_invlist(2);
7412         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
7413                                                     NUM_ANYOF_CODE_POINTS - 1);
7414 #ifdef DEBUGGING
7415         dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
7416         if (   ! dump_len_string
7417             || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
7418         {
7419             PL_dump_re_max_len = 60;    /* A reasonable default */
7420         }
7421 #endif
7422     }
7423
7424     pRExC_state->warn_text = NULL;
7425     pRExC_state->unlexed_names = NULL;
7426     pRExC_state->code_blocks = NULL;
7427
7428     if (is_bare_re)
7429         *is_bare_re = FALSE;
7430
7431     if (expr && (expr->op_type == OP_LIST ||
7432                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
7433         /* allocate code_blocks if needed */
7434         OP *o;
7435         int ncode = 0;
7436
7437         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
7438             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
7439                 ncode++; /* count of DO blocks */
7440
7441         if (ncode)
7442             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
7443     }
7444
7445     if (!pat_count) {
7446         /* compile-time pattern with just OP_CONSTs and DO blocks */
7447
7448         int n;
7449         OP *o;
7450
7451         /* find how many CONSTs there are */
7452         assert(expr);
7453         n = 0;
7454         if (expr->op_type == OP_CONST)
7455             n = 1;
7456         else
7457             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7458                 if (o->op_type == OP_CONST)
7459                     n++;
7460             }
7461
7462         /* fake up an SV array */
7463
7464         assert(!new_patternp);
7465         Newx(new_patternp, n, SV*);
7466         SAVEFREEPV(new_patternp);
7467         pat_count = n;
7468
7469         n = 0;
7470         if (expr->op_type == OP_CONST)
7471             new_patternp[n] = cSVOPx_sv(expr);
7472         else
7473             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7474                 if (o->op_type == OP_CONST)
7475                     new_patternp[n++] = cSVOPo_sv;
7476             }
7477
7478     }
7479
7480     DEBUG_PARSE_r(Perl_re_printf( aTHX_
7481         "Assembling pattern from %d elements%s\n", pat_count,
7482             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7483
7484     /* set expr to the first arg op */
7485
7486     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
7487          && expr->op_type != OP_CONST)
7488     {
7489             expr = cLISTOPx(expr)->op_first;
7490             assert(   expr->op_type == OP_PUSHMARK
7491                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
7492                    || expr->op_type == OP_PADRANGE);
7493             expr = OpSIBLING(expr);
7494     }
7495
7496     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
7497                         expr, &recompile, NULL);
7498
7499     /* handle bare (possibly after overloading) regex: foo =~ $re */
7500     {
7501         SV *re = pat;
7502         if (SvROK(re))
7503             re = SvRV(re);
7504         if (SvTYPE(re) == SVt_REGEXP) {
7505             if (is_bare_re)
7506                 *is_bare_re = TRUE;
7507             SvREFCNT_inc(re);
7508             DEBUG_PARSE_r(Perl_re_printf( aTHX_
7509                 "Precompiled pattern%s\n",
7510                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7511
7512             return (REGEXP*)re;
7513         }
7514     }
7515
7516     exp = SvPV_nomg(pat, plen);
7517
7518     if (!eng->op_comp) {
7519         if ((SvUTF8(pat) && IN_BYTES)
7520                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7521         {
7522             /* make a temporary copy; either to convert to bytes,
7523              * or to avoid repeating get-magic / overloaded stringify */
7524             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7525                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7526         }
7527         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7528     }
7529
7530     /* ignore the utf8ness if the pattern is 0 length */
7531     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7532     RExC_uni_semantics = 0;
7533     RExC_contains_locale = 0;
7534     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7535     RExC_in_script_run = 0;
7536     RExC_study_started = 0;
7537     pRExC_state->runtime_code_qr = NULL;
7538     RExC_frame_head= NULL;
7539     RExC_frame_last= NULL;
7540     RExC_frame_count= 0;
7541     RExC_latest_warn_offset = 0;
7542     RExC_use_BRANCHJ = 0;
7543     RExC_total_parens = 0;
7544     RExC_open_parens = NULL;
7545     RExC_close_parens = NULL;
7546     RExC_paren_names = NULL;
7547     RExC_size = 0;
7548     RExC_seen_d_op = FALSE;
7549 #ifdef DEBUGGING
7550     RExC_paren_name_list = NULL;
7551 #endif
7552
7553     DEBUG_r({
7554         RExC_mysv1= sv_newmortal();
7555         RExC_mysv2= sv_newmortal();
7556     });
7557
7558     DEBUG_COMPILE_r({
7559             SV *dsv= sv_newmortal();
7560             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7561             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7562                           PL_colors[4], PL_colors[5], s);
7563         });
7564
7565     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7566      * to utf8 */
7567
7568     if ((pm_flags & PMf_USE_RE_EVAL)
7569                 /* this second condition covers the non-regex literal case,
7570                  * i.e.  $foo =~ '(?{})'. */
7571                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7572     )
7573         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7574
7575   redo_parse:
7576     /* return old regex if pattern hasn't changed */
7577     /* XXX: note in the below we have to check the flags as well as the
7578      * pattern.
7579      *
7580      * Things get a touch tricky as we have to compare the utf8 flag
7581      * independently from the compile flags.  */
7582
7583     if (   old_re
7584         && !recompile
7585         && !!RX_UTF8(old_re) == !!RExC_utf8
7586         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7587         && RX_PRECOMP(old_re)
7588         && RX_PRELEN(old_re) == plen
7589         && memEQ(RX_PRECOMP(old_re), exp, plen)
7590         && !runtime_code /* with runtime code, always recompile */ )
7591     {
7592         DEBUG_COMPILE_r({
7593             SV *dsv= sv_newmortal();
7594             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7595             Perl_re_printf( aTHX_  "%sSkipping recompilation of unchanged REx%s %s\n",
7596                           PL_colors[4], PL_colors[5], s);
7597         });
7598         return old_re;
7599     }
7600
7601     /* Allocate the pattern's SV */
7602     RExC_rx_sv = Rx = (REGEXP*) newSV_type(SVt_REGEXP);
7603     RExC_rx = ReANY(Rx);
7604     if ( RExC_rx == NULL )
7605         FAIL("Regexp out of space");
7606
7607     rx_flags = orig_rx_flags;
7608
7609     if (   (UTF || RExC_uni_semantics)
7610         && initial_charset == REGEX_DEPENDS_CHARSET)
7611     {
7612
7613         /* Set to use unicode semantics if the pattern is in utf8 and has the
7614          * 'depends' charset specified, as it means unicode when utf8  */
7615         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7616         RExC_uni_semantics = 1;
7617     }
7618
7619     RExC_pm_flags = pm_flags;
7620
7621     if (runtime_code) {
7622         assert(TAINTING_get || !TAINT_get);
7623         if (TAINT_get)
7624             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7625
7626         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7627             /* whoops, we have a non-utf8 pattern, whilst run-time code
7628              * got compiled as utf8. Try again with a utf8 pattern */
7629             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7630                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7631             goto redo_parse;
7632         }
7633     }
7634     assert(!pRExC_state->runtime_code_qr);
7635
7636     RExC_sawback = 0;
7637
7638     RExC_seen = 0;
7639     RExC_maxlen = 0;
7640     RExC_in_lookbehind = 0;
7641     RExC_in_lookahead = 0;
7642     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7643     RExC_recode_x_to_native = 0;
7644     RExC_in_multi_char_class = 0;
7645
7646     RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = RExC_precomp = exp;
7647     RExC_precomp_end = RExC_end = exp + plen;
7648     RExC_nestroot = 0;
7649     RExC_whilem_seen = 0;
7650     RExC_end_op = NULL;
7651     RExC_recurse = NULL;
7652     RExC_study_chunk_recursed = NULL;
7653     RExC_study_chunk_recursed_bytes= 0;
7654     RExC_recurse_count = 0;
7655     pRExC_state->code_index = 0;
7656
7657     /* Initialize the string in the compiled pattern.  This is so that there is
7658      * something to output if necessary */
7659     set_regex_pv(pRExC_state, Rx);
7660
7661     DEBUG_PARSE_r({
7662         Perl_re_printf( aTHX_
7663             "Starting parse and generation\n");
7664         RExC_lastnum=0;
7665         RExC_lastparse=NULL;
7666     });
7667
7668     /* Allocate space and zero-initialize. Note, the two step process
7669        of zeroing when in debug mode, thus anything assigned has to
7670        happen after that */
7671     if (!  RExC_size) {
7672
7673         /* On the first pass of the parse, we guess how big this will be.  Then
7674          * we grow in one operation to that amount and then give it back.  As
7675          * we go along, we re-allocate what we need.
7676          *
7677          * XXX Currently the guess is essentially that the pattern will be an
7678          * EXACT node with one byte input, one byte output.  This is crude, and
7679          * better heuristics are welcome.
7680          *
7681          * On any subsequent passes, we guess what we actually computed in the
7682          * latest earlier pass.  Such a pass probably didn't complete so is
7683          * missing stuff.  We could improve those guesses by knowing where the
7684          * parse stopped, and use the length so far plus apply the above
7685          * assumption to what's left. */
7686         RExC_size = STR_SZ(RExC_end - RExC_start);
7687     }
7688
7689     Newxc(RExC_rxi, sizeof(regexp_internal) + RExC_size, char, regexp_internal);
7690     if ( RExC_rxi == NULL )
7691         FAIL("Regexp out of space");
7692
7693     Zero(RExC_rxi, sizeof(regexp_internal) + RExC_size, char);
7694     RXi_SET( RExC_rx, RExC_rxi );
7695
7696     /* We start from 0 (over from 0 in the case this is a reparse.  The first
7697      * node parsed will give back any excess memory we have allocated so far).
7698      * */
7699     RExC_size = 0;
7700
7701     /* non-zero initialization begins here */
7702     RExC_rx->engine= eng;
7703     RExC_rx->extflags = rx_flags;
7704     RXp_COMPFLAGS(RExC_rx) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7705
7706     if (pm_flags & PMf_IS_QR) {
7707         RExC_rxi->code_blocks = pRExC_state->code_blocks;
7708         if (RExC_rxi->code_blocks) {
7709             RExC_rxi->code_blocks->refcnt++;
7710         }
7711     }
7712
7713     RExC_rx->intflags = 0;
7714
7715     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7716     RExC_parse = exp;
7717
7718     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7719      * code makes sure the final byte is an uncounted NUL.  But should this
7720      * ever not be the case, lots of things could read beyond the end of the
7721      * buffer: loops like
7722      *      while(isFOO(*RExC_parse)) RExC_parse++;
7723      *      strchr(RExC_parse, "foo");
7724      * etc.  So it is worth noting. */
7725     assert(*RExC_end == '\0');
7726
7727     RExC_naughty = 0;
7728     RExC_npar = 1;
7729     RExC_parens_buf_size = 0;
7730     RExC_emit_start = RExC_rxi->program;
7731     pRExC_state->code_index = 0;
7732
7733     *((char*) RExC_emit_start) = (char) REG_MAGIC;
7734     RExC_emit = 1;
7735
7736     /* Do the parse */
7737     if (reg(pRExC_state, 0, &flags, 1)) {
7738
7739         /* Success!, But we may need to redo the parse knowing how many parens
7740          * there actually are */
7741         if (IN_PARENS_PASS) {
7742             flags |= RESTART_PARSE;
7743         }
7744
7745         /* We have that number in RExC_npar */
7746         RExC_total_parens = RExC_npar;
7747     }
7748     else if (! MUST_RESTART(flags)) {
7749         ReREFCNT_dec(Rx);
7750         Perl_croak(aTHX_ "panic: reg returned failure to re_op_compile, flags=%#" UVxf, (UV) flags);
7751     }
7752
7753     /* Here, we either have success, or we have to redo the parse for some reason */
7754     if (MUST_RESTART(flags)) {
7755
7756         /* It's possible to write a regexp in ascii that represents Unicode
7757         codepoints outside of the byte range, such as via \x{100}. If we
7758         detect such a sequence we have to convert the entire pattern to utf8
7759         and then recompile, as our sizing calculation will have been based
7760         on 1 byte == 1 character, but we will need to use utf8 to encode
7761         at least some part of the pattern, and therefore must convert the whole
7762         thing.
7763         -- dmq */
7764         if (flags & NEED_UTF8) {
7765
7766             /* We have stored the offset of the final warning output so far.
7767              * That must be adjusted.  Any variant characters between the start
7768              * of the pattern and this warning count for 2 bytes in the final,
7769              * so just add them again */
7770             if (UNLIKELY(RExC_latest_warn_offset > 0)) {
7771                 RExC_latest_warn_offset +=
7772                             variant_under_utf8_count((U8 *) exp, (U8 *) exp
7773                                                 + RExC_latest_warn_offset);
7774             }
7775             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7776             pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7777             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse after upgrade\n"));
7778         }
7779         else {
7780             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse\n"));
7781         }
7782
7783         if (ALL_PARENS_COUNTED) {
7784             /* Make enough room for all the known parens, and zero it */
7785             Renew(RExC_open_parens, RExC_total_parens, regnode_offset);
7786             Zero(RExC_open_parens, RExC_total_parens, regnode_offset);
7787             RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
7788
7789             Renew(RExC_close_parens, RExC_total_parens, regnode_offset);
7790             Zero(RExC_close_parens, RExC_total_parens, regnode_offset);
7791         }
7792         else { /* Parse did not complete.  Reinitialize the parentheses
7793                   structures */
7794             RExC_total_parens = 0;
7795             if (RExC_open_parens) {
7796                 Safefree(RExC_open_parens);
7797                 RExC_open_parens = NULL;
7798             }
7799             if (RExC_close_parens) {
7800                 Safefree(RExC_close_parens);
7801                 RExC_close_parens = NULL;
7802             }
7803         }
7804
7805         /* Clean up what we did in this parse */
7806         SvREFCNT_dec_NN(RExC_rx_sv);
7807
7808         goto redo_parse;
7809     }
7810
7811     /* Here, we have successfully parsed and generated the pattern's program
7812      * for the regex engine.  We are ready to finish things up and look for
7813      * optimizations. */
7814
7815     /* Update the string to compile, with correct modifiers, etc */
7816     set_regex_pv(pRExC_state, Rx);
7817
7818     RExC_rx->nparens = RExC_total_parens - 1;
7819
7820     /* Uses the upper 4 bits of the FLAGS field, so keep within that size */
7821     if (RExC_whilem_seen > 15)
7822         RExC_whilem_seen = 15;
7823
7824     DEBUG_PARSE_r({
7825         Perl_re_printf( aTHX_
7826             "Required size %" IVdf " nodes\n", (IV)RExC_size);
7827         RExC_lastnum=0;
7828         RExC_lastparse=NULL;
7829     });
7830
7831 #ifdef RE_TRACK_PATTERN_OFFSETS
7832     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7833                           "%s %" UVuf " bytes for offset annotations.\n",
7834                           RExC_offsets ? "Got" : "Couldn't get",
7835                           (UV)((RExC_offsets[0] * 2 + 1))));
7836     DEBUG_OFFSETS_r(if (RExC_offsets) {
7837         const STRLEN len = RExC_offsets[0];
7838         STRLEN i;
7839         GET_RE_DEBUG_FLAGS_DECL;
7840         Perl_re_printf( aTHX_
7841                       "Offsets: [%" UVuf "]\n\t", (UV)RExC_offsets[0]);
7842         for (i = 1; i <= len; i++) {
7843             if (RExC_offsets[i*2-1] || RExC_offsets[i*2])
7844                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7845                 (UV)i, (UV)RExC_offsets[i*2-1], (UV)RExC_offsets[i*2]);
7846         }
7847         Perl_re_printf( aTHX_  "\n");
7848     });
7849
7850 #else
7851     SetProgLen(RExC_rxi,RExC_size);
7852 #endif
7853
7854     DEBUG_DUMP_PRE_OPTIMIZE_r({
7855         SV * const sv = sv_newmortal();
7856         RXi_GET_DECL(RExC_rx, ri);
7857         DEBUG_RExC_seen();
7858         Perl_re_printf( aTHX_ "Program before optimization:\n");
7859
7860         (void)dumpuntil(RExC_rx, ri->program, ri->program + 1, NULL, NULL,
7861                         sv, 0, 0);
7862     });
7863
7864     DEBUG_OPTIMISE_r(
7865         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
7866     );
7867
7868     /* XXXX To minimize changes to RE engine we always allocate
7869        3-units-long substrs field. */
7870     Newx(RExC_rx->substrs, 1, struct reg_substr_data);
7871     if (RExC_recurse_count) {
7872         Newx(RExC_recurse, RExC_recurse_count, regnode *);
7873         SAVEFREEPV(RExC_recurse);
7874     }
7875
7876     if (RExC_seen & REG_RECURSE_SEEN) {
7877         /* Note, RExC_total_parens is 1 + the number of parens in a pattern.
7878          * So its 1 if there are no parens. */
7879         RExC_study_chunk_recursed_bytes= (RExC_total_parens >> 3) +
7880                                          ((RExC_total_parens & 0x07) != 0);
7881         Newx(RExC_study_chunk_recursed,
7882              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
7883         SAVEFREEPV(RExC_study_chunk_recursed);
7884     }
7885
7886   reStudy:
7887     RExC_rx->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
7888     DEBUG_r(
7889         RExC_study_chunk_recursed_count= 0;
7890     );
7891     Zero(RExC_rx->substrs, 1, struct reg_substr_data);
7892     if (RExC_study_chunk_recursed) {
7893         Zero(RExC_study_chunk_recursed,
7894              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
7895     }
7896
7897
7898 #ifdef TRIE_STUDY_OPT
7899     if (!restudied) {
7900         StructCopy(&zero_scan_data, &data, scan_data_t);
7901         copyRExC_state = RExC_state;
7902     } else {
7903         U32 seen=RExC_seen;
7904         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
7905
7906         RExC_state = copyRExC_state;
7907         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
7908             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
7909         else
7910             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
7911         StructCopy(&zero_scan_data, &data, scan_data_t);
7912     }
7913 #else
7914     StructCopy(&zero_scan_data, &data, scan_data_t);
7915 #endif
7916
7917     /* Dig out information for optimizations. */
7918     RExC_rx->extflags = RExC_flags; /* was pm_op */
7919     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
7920
7921     if (UTF)
7922         SvUTF8_on(Rx);  /* Unicode in it? */
7923     RExC_rxi->regstclass = NULL;
7924     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
7925         RExC_rx->intflags |= PREGf_NAUGHTY;
7926     scan = RExC_rxi->program + 1;               /* First BRANCH. */
7927
7928     /* testing for BRANCH here tells us whether there is "must appear"
7929        data in the pattern. If there is then we can use it for optimisations */
7930     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
7931                                                   */
7932         SSize_t fake;
7933         STRLEN longest_length[2];
7934         regnode_ssc ch_class; /* pointed to by data */
7935         int stclass_flag;
7936         SSize_t last_close = 0; /* pointed to by data */
7937         regnode *first= scan;
7938         regnode *first_next= regnext(first);
7939         int i;
7940
7941         /*
7942          * Skip introductions and multiplicators >= 1
7943          * so that we can extract the 'meat' of the pattern that must
7944          * match in the large if() sequence following.
7945          * NOTE that EXACT is NOT covered here, as it is normally
7946          * picked up by the optimiser separately.
7947          *
7948          * This is unfortunate as the optimiser isnt handling lookahead
7949          * properly currently.
7950          *
7951          */
7952         while ((OP(first) == OPEN && (sawopen = 1)) ||
7953                /* An OR of *one* alternative - should not happen now. */
7954             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
7955             /* for now we can't handle lookbehind IFMATCH*/
7956             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
7957             (OP(first) == PLUS) ||
7958             (OP(first) == MINMOD) ||
7959                /* An {n,m} with n>0 */
7960             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
7961             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
7962         {
7963                 /*
7964                  * the only op that could be a regnode is PLUS, all the rest
7965                  * will be regnode_1 or regnode_2.
7966                  *
7967                  * (yves doesn't think this is true)
7968                  */
7969                 if (OP(first) == PLUS)
7970                     sawplus = 1;
7971                 else {
7972                     if (OP(first) == MINMOD)
7973                         sawminmod = 1;
7974                     first += regarglen[OP(first)];
7975                 }
7976                 first = NEXTOPER(first);
7977                 first_next= regnext(first);
7978         }
7979
7980         /* Starting-point info. */
7981       again:
7982         DEBUG_PEEP("first:", first, 0, 0);
7983         /* Ignore EXACT as we deal with it later. */
7984         if (PL_regkind[OP(first)] == EXACT) {
7985             if (   OP(first) == EXACT
7986                 || OP(first) == LEXACT
7987                 || OP(first) == EXACT_ONLY8
7988                 || OP(first) == LEXACT_ONLY8
7989                 || OP(first) == EXACTL)
7990             {
7991                 NOOP;   /* Empty, get anchored substr later. */
7992             }
7993             else
7994                 RExC_rxi->regstclass = first;
7995         }
7996 #ifdef TRIE_STCLASS
7997         else if (PL_regkind[OP(first)] == TRIE &&
7998                 ((reg_trie_data *)RExC_rxi->data->data[ ARG(first) ])->minlen>0)
7999         {
8000             /* this can happen only on restudy */
8001             RExC_rxi->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
8002         }
8003 #endif
8004         else if (REGNODE_SIMPLE(OP(first)))
8005             RExC_rxi->regstclass = first;
8006         else if (PL_regkind[OP(first)] == BOUND ||
8007                  PL_regkind[OP(first)] == NBOUND)
8008             RExC_rxi->regstclass = first;
8009         else if (PL_regkind[OP(first)] == BOL) {
8010             RExC_rx->intflags |= (OP(first) == MBOL
8011                            ? PREGf_ANCH_MBOL
8012                            : PREGf_ANCH_SBOL);
8013             first = NEXTOPER(first);
8014             goto again;
8015         }
8016         else if (OP(first) == GPOS) {
8017             RExC_rx->intflags |= PREGf_ANCH_GPOS;
8018             first = NEXTOPER(first);
8019             goto again;
8020         }
8021         else if ((!sawopen || !RExC_sawback) &&
8022             !sawlookahead &&
8023             (OP(first) == STAR &&
8024             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
8025             !(RExC_rx->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
8026         {
8027             /* turn .* into ^.* with an implied $*=1 */
8028             const int type =
8029                 (OP(NEXTOPER(first)) == REG_ANY)
8030                     ? PREGf_ANCH_MBOL
8031                     : PREGf_ANCH_SBOL;
8032             RExC_rx->intflags |= (type | PREGf_IMPLICIT);
8033             first = NEXTOPER(first);
8034             goto again;
8035         }
8036         if (sawplus && !sawminmod && !sawlookahead
8037             && (!sawopen || !RExC_sawback)
8038             && !pRExC_state->code_blocks) /* May examine pos and $& */
8039             /* x+ must match at the 1st pos of run of x's */
8040             RExC_rx->intflags |= PREGf_SKIP;
8041
8042         /* Scan is after the zeroth branch, first is atomic matcher. */
8043 #ifdef TRIE_STUDY_OPT
8044         DEBUG_PARSE_r(
8045             if (!restudied)
8046                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8047                               (IV)(first - scan + 1))
8048         );
8049 #else
8050         DEBUG_PARSE_r(
8051             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8052                 (IV)(first - scan + 1))
8053         );
8054 #endif
8055
8056
8057         /*
8058         * If there's something expensive in the r.e., find the
8059         * longest literal string that must appear and make it the
8060         * regmust.  Resolve ties in favor of later strings, since
8061         * the regstart check works with the beginning of the r.e.
8062         * and avoiding duplication strengthens checking.  Not a
8063         * strong reason, but sufficient in the absence of others.
8064         * [Now we resolve ties in favor of the earlier string if
8065         * it happens that c_offset_min has been invalidated, since the
8066         * earlier string may buy us something the later one won't.]
8067         */
8068
8069         data.substrs[0].str = newSVpvs("");
8070         data.substrs[1].str = newSVpvs("");
8071         data.last_found = newSVpvs("");
8072         data.cur_is_floating = 0; /* initially any found substring is fixed */
8073         ENTER_with_name("study_chunk");
8074         SAVEFREESV(data.substrs[0].str);
8075         SAVEFREESV(data.substrs[1].str);
8076         SAVEFREESV(data.last_found);
8077         first = scan;
8078         if (!RExC_rxi->regstclass) {
8079             ssc_init(pRExC_state, &ch_class);
8080             data.start_class = &ch_class;
8081             stclass_flag = SCF_DO_STCLASS_AND;
8082         } else                          /* XXXX Check for BOUND? */
8083             stclass_flag = 0;
8084         data.last_closep = &last_close;
8085
8086         DEBUG_RExC_seen();
8087         /*
8088          * MAIN ENTRY FOR study_chunk() FOR m/PATTERN/
8089          * (NO top level branches)
8090          */
8091         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
8092                              scan + RExC_size, /* Up to end */
8093             &data, -1, 0, NULL,
8094             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
8095                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
8096             0);
8097
8098
8099         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
8100
8101
8102         if ( RExC_total_parens == 1 && !data.cur_is_floating
8103              && data.last_start_min == 0 && data.last_end > 0
8104              && !RExC_seen_zerolen
8105              && !(RExC_seen & REG_VERBARG_SEEN)
8106              && !(RExC_seen & REG_GPOS_SEEN)
8107         ){
8108             RExC_rx->extflags |= RXf_CHECK_ALL;
8109         }
8110         scan_commit(pRExC_state, &data,&minlen, 0);
8111
8112
8113         /* XXX this is done in reverse order because that's the way the
8114          * code was before it was parameterised. Don't know whether it
8115          * actually needs doing in reverse order. DAPM */
8116         for (i = 1; i >= 0; i--) {
8117             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
8118
8119             if (   !(   i
8120                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
8121                      &&    data.substrs[0].min_offset
8122                         == data.substrs[1].min_offset
8123                      &&    SvCUR(data.substrs[0].str)
8124                         == SvCUR(data.substrs[1].str)
8125                     )
8126                 && S_setup_longest (aTHX_ pRExC_state,
8127                                         &(RExC_rx->substrs->data[i]),
8128                                         &(data.substrs[i]),
8129                                         longest_length[i]))
8130             {
8131                 RExC_rx->substrs->data[i].min_offset =
8132                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
8133
8134                 RExC_rx->substrs->data[i].max_offset = data.substrs[i].max_offset;
8135                 /* Don't offset infinity */
8136                 if (data.substrs[i].max_offset < SSize_t_MAX)
8137                     RExC_rx->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
8138                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
8139             }
8140             else {
8141                 RExC_rx->substrs->data[i].substr      = NULL;
8142                 RExC_rx->substrs->data[i].utf8_substr = NULL;
8143                 longest_length[i] = 0;
8144             }
8145         }
8146
8147         LEAVE_with_name("study_chunk");
8148
8149         if (RExC_rxi->regstclass
8150             && (OP(RExC_rxi->regstclass) == REG_ANY || OP(RExC_rxi->regstclass) == SANY))
8151             RExC_rxi->regstclass = NULL;
8152
8153         if ((!(RExC_rx->substrs->data[0].substr || RExC_rx->substrs->data[0].utf8_substr)
8154               || RExC_rx->substrs->data[0].min_offset)
8155             && stclass_flag
8156             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8157             && is_ssc_worth_it(pRExC_state, data.start_class))
8158         {
8159             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8160
8161             ssc_finalize(pRExC_state, data.start_class);
8162
8163             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8164             StructCopy(data.start_class,
8165                        (regnode_ssc*)RExC_rxi->data->data[n],
8166                        regnode_ssc);
8167             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8168             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8169             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
8170                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8171                       Perl_re_printf( aTHX_
8172                                     "synthetic stclass \"%s\".\n",
8173                                     SvPVX_const(sv));});
8174             data.start_class = NULL;
8175         }
8176
8177         /* A temporary algorithm prefers floated substr to fixed one of
8178          * same length to dig more info. */
8179         i = (longest_length[0] <= longest_length[1]);
8180         RExC_rx->substrs->check_ix = i;
8181         RExC_rx->check_end_shift  = RExC_rx->substrs->data[i].end_shift;
8182         RExC_rx->check_substr     = RExC_rx->substrs->data[i].substr;
8183         RExC_rx->check_utf8       = RExC_rx->substrs->data[i].utf8_substr;
8184         RExC_rx->check_offset_min = RExC_rx->substrs->data[i].min_offset;
8185         RExC_rx->check_offset_max = RExC_rx->substrs->data[i].max_offset;
8186         if (!i && (RExC_rx->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
8187             RExC_rx->intflags |= PREGf_NOSCAN;
8188
8189         if ((RExC_rx->check_substr || RExC_rx->check_utf8) ) {
8190             RExC_rx->extflags |= RXf_USE_INTUIT;
8191             if (SvTAIL(RExC_rx->check_substr ? RExC_rx->check_substr : RExC_rx->check_utf8))
8192                 RExC_rx->extflags |= RXf_INTUIT_TAIL;
8193         }
8194
8195         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
8196         if ( (STRLEN)minlen < longest_length[1] )
8197             minlen= longest_length[1];
8198         if ( (STRLEN)minlen < longest_length[0] )
8199             minlen= longest_length[0];
8200         */
8201     }
8202     else {
8203         /* Several toplevels. Best we can is to set minlen. */
8204         SSize_t fake;
8205         regnode_ssc ch_class;
8206         SSize_t last_close = 0;
8207
8208         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
8209
8210         scan = RExC_rxi->program + 1;
8211         ssc_init(pRExC_state, &ch_class);
8212         data.start_class = &ch_class;
8213         data.last_closep = &last_close;
8214
8215         DEBUG_RExC_seen();
8216         /*
8217          * MAIN ENTRY FOR study_chunk() FOR m/P1|P2|.../
8218          * (patterns WITH top level branches)
8219          */
8220         minlen = study_chunk(pRExC_state,
8221             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
8222             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
8223                                                       ? SCF_TRIE_DOING_RESTUDY
8224                                                       : 0),
8225             0);
8226
8227         CHECK_RESTUDY_GOTO_butfirst(NOOP);
8228
8229         RExC_rx->check_substr = NULL;
8230         RExC_rx->check_utf8 = NULL;
8231         RExC_rx->substrs->data[0].substr      = NULL;
8232         RExC_rx->substrs->data[0].utf8_substr = NULL;
8233         RExC_rx->substrs->data[1].substr      = NULL;
8234         RExC_rx->substrs->data[1].utf8_substr = NULL;
8235
8236         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8237             && is_ssc_worth_it(pRExC_state, data.start_class))
8238         {
8239             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8240
8241             ssc_finalize(pRExC_state, data.start_class);
8242
8243             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8244             StructCopy(data.start_class,
8245                        (regnode_ssc*)RExC_rxi->data->data[n],
8246                        regnode_ssc);
8247             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8248             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8249             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
8250                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8251                       Perl_re_printf( aTHX_
8252                                     "synthetic stclass \"%s\".\n",
8253                                     SvPVX_const(sv));});
8254             data.start_class = NULL;
8255         }
8256     }
8257
8258     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
8259         RExC_rx->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
8260         RExC_rx->maxlen = REG_INFTY;
8261     }
8262     else {
8263         RExC_rx->maxlen = RExC_maxlen;
8264     }
8265
8266     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
8267        the "real" pattern. */
8268     DEBUG_OPTIMISE_r({
8269         Perl_re_printf( aTHX_ "minlen: %" IVdf " RExC_rx->minlen:%" IVdf " maxlen:%" IVdf "\n",
8270                       (IV)minlen, (IV)RExC_rx->minlen, (IV)RExC_maxlen);
8271     });
8272     RExC_rx->minlenret = minlen;
8273     if (RExC_rx->minlen < minlen)
8274         RExC_rx->minlen = minlen;
8275
8276     if (RExC_seen & REG_RECURSE_SEEN ) {
8277         RExC_rx->intflags |= PREGf_RECURSE_SEEN;
8278         Newx(RExC_rx->recurse_locinput, RExC_rx->nparens + 1, char *);
8279     }
8280     if (RExC_seen & REG_GPOS_SEEN)
8281         RExC_rx->intflags |= PREGf_GPOS_SEEN;
8282     if (RExC_seen & REG_LOOKBEHIND_SEEN)
8283         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
8284                                                 lookbehind */
8285     if (pRExC_state->code_blocks)
8286         RExC_rx->extflags |= RXf_EVAL_SEEN;
8287     if (RExC_seen & REG_VERBARG_SEEN)
8288     {
8289         RExC_rx->intflags |= PREGf_VERBARG_SEEN;
8290         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
8291     }
8292     if (RExC_seen & REG_CUTGROUP_SEEN)
8293         RExC_rx->intflags |= PREGf_CUTGROUP_SEEN;
8294     if (pm_flags & PMf_USE_RE_EVAL)
8295         RExC_rx->intflags |= PREGf_USE_RE_EVAL;
8296     if (RExC_paren_names)
8297         RXp_PAREN_NAMES(RExC_rx) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
8298     else
8299         RXp_PAREN_NAMES(RExC_rx) = NULL;
8300
8301     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
8302      * so it can be used in pp.c */
8303     if (RExC_rx->intflags & PREGf_ANCH)
8304         RExC_rx->extflags |= RXf_IS_ANCHORED;
8305
8306
8307     {
8308         /* this is used to identify "special" patterns that might result
8309          * in Perl NOT calling the regex engine and instead doing the match "itself",
8310          * particularly special cases in split//. By having the regex compiler
8311          * do this pattern matching at a regop level (instead of by inspecting the pattern)
8312          * we avoid weird issues with equivalent patterns resulting in different behavior,
8313          * AND we allow non Perl engines to get the same optimizations by the setting the
8314          * flags appropriately - Yves */
8315         regnode *first = RExC_rxi->program + 1;
8316         U8 fop = OP(first);
8317         regnode *next = regnext(first);
8318         U8 nop = OP(next);
8319
8320         if (PL_regkind[fop] == NOTHING && nop == END)
8321             RExC_rx->extflags |= RXf_NULL;
8322         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
8323             /* when fop is SBOL first->flags will be true only when it was
8324              * produced by parsing /\A/, and not when parsing /^/. This is
8325              * very important for the split code as there we want to
8326              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
8327              * See rt #122761 for more details. -- Yves */
8328             RExC_rx->extflags |= RXf_START_ONLY;
8329         else if (fop == PLUS
8330                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
8331                  && nop == END)
8332             RExC_rx->extflags |= RXf_WHITE;
8333         else if ( RExC_rx->extflags & RXf_SPLIT
8334                   && (   fop == EXACT || fop == LEXACT
8335                       || fop == EXACT_ONLY8 || fop == LEXACT_ONLY8
8336                       || fop == EXACTL)
8337                   && STR_LEN(first) == 1
8338                   && *(STRING(first)) == ' '
8339                   && nop == END )
8340             RExC_rx->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
8341
8342     }
8343
8344     if (RExC_contains_locale) {
8345         RXp_EXTFLAGS(RExC_rx) |= RXf_TAINTED;
8346     }
8347
8348 #ifdef DEBUGGING
8349     if (RExC_paren_names) {
8350         RExC_rxi->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
8351         RExC_rxi->data->data[RExC_rxi->name_list_idx]
8352                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
8353     } else
8354 #endif
8355     RExC_rxi->name_list_idx = 0;
8356
8357     while ( RExC_recurse_count > 0 ) {
8358         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
8359         /*
8360          * This data structure is set up in study_chunk() and is used
8361          * to calculate the distance between a GOSUB regopcode and
8362          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
8363          * it refers to.
8364          *
8365          * If for some reason someone writes code that optimises
8366          * away a GOSUB opcode then the assert should be changed to
8367          * an if(scan) to guard the ARG2L_SET() - Yves
8368          *
8369          */
8370         assert(scan && OP(scan) == GOSUB);
8371         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - REGNODE_OFFSET(scan));
8372     }
8373
8374     Newxz(RExC_rx->offs, RExC_total_parens, regexp_paren_pair);
8375     /* assume we don't need to swap parens around before we match */
8376     DEBUG_TEST_r({
8377         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
8378             (unsigned long)RExC_study_chunk_recursed_count);
8379     });
8380     DEBUG_DUMP_r({
8381         DEBUG_RExC_seen();
8382         Perl_re_printf( aTHX_ "Final program:\n");
8383         regdump(RExC_rx);
8384     });
8385
8386     if (RExC_open_parens) {
8387         Safefree(RExC_open_parens);
8388         RExC_open_parens = NULL;
8389     }
8390     if (RExC_close_parens) {
8391         Safefree(RExC_close_parens);
8392         RExC_close_parens = NULL;
8393     }
8394
8395 #ifdef USE_ITHREADS
8396     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
8397      * by setting the regexp SV to readonly-only instead. If the
8398      * pattern's been recompiled, the USEDness should remain. */
8399     if (old_re && SvREADONLY(old_re))
8400         SvREADONLY_on(Rx);
8401 #endif
8402     return Rx;
8403 }
8404
8405
8406 SV*
8407 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
8408                     const U32 flags)
8409 {
8410     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
8411
8412     PERL_UNUSED_ARG(value);
8413
8414     if (flags & RXapif_FETCH) {
8415         return reg_named_buff_fetch(rx, key, flags);
8416     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
8417         Perl_croak_no_modify();
8418         return NULL;
8419     } else if (flags & RXapif_EXISTS) {
8420         return reg_named_buff_exists(rx, key, flags)
8421             ? &PL_sv_yes
8422             : &PL_sv_no;
8423     } else if (flags & RXapif_REGNAMES) {
8424         return reg_named_buff_all(rx, flags);
8425     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
8426         return reg_named_buff_scalar(rx, flags);
8427     } else {
8428         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
8429         return NULL;
8430     }
8431 }
8432
8433 SV*
8434 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
8435                          const U32 flags)
8436 {
8437     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
8438     PERL_UNUSED_ARG(lastkey);
8439
8440     if (flags & RXapif_FIRSTKEY)
8441         return reg_named_buff_firstkey(rx, flags);
8442     else if (flags & RXapif_NEXTKEY)
8443         return reg_named_buff_nextkey(rx, flags);
8444     else {
8445         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
8446                                             (int)flags);
8447         return NULL;
8448     }
8449 }
8450
8451 SV*
8452 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
8453                           const U32 flags)
8454 {
8455     SV *ret;
8456     struct regexp *const rx = ReANY(r);
8457
8458     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
8459
8460     if (rx && RXp_PAREN_NAMES(rx)) {
8461         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
8462         if (he_str) {
8463             IV i;
8464             SV* sv_dat=HeVAL(he_str);
8465             I32 *nums=(I32*)SvPVX(sv_dat);
8466             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
8467             for ( i=0; i<SvIVX(sv_dat); i++ ) {
8468                 if ((I32)(rx->nparens) >= nums[i]
8469                     && rx->offs[nums[i]].start != -1
8470                     && rx->offs[nums[i]].end != -1)
8471                 {
8472                     ret = newSVpvs("");
8473                     CALLREG_NUMBUF_FETCH(r, nums[i], ret);
8474                     if (!retarray)
8475                         return ret;
8476                 } else {
8477                     if (retarray)
8478                         ret = newSVsv(&PL_sv_undef);
8479                 }
8480                 if (retarray)
8481                     av_push(retarray, ret);
8482             }
8483             if (retarray)
8484                 return newRV_noinc(MUTABLE_SV(retarray));
8485         }
8486     }
8487     return NULL;
8488 }
8489
8490 bool
8491 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
8492                            const U32 flags)
8493 {
8494     struct regexp *const rx = ReANY(r);
8495
8496     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
8497
8498     if (rx && RXp_PAREN_NAMES(rx)) {
8499         if (flags & RXapif_ALL) {
8500             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
8501         } else {
8502             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
8503             if (sv) {
8504                 SvREFCNT_dec_NN(sv);
8505                 return TRUE;
8506             } else {
8507                 return FALSE;
8508             }
8509         }
8510     } else {
8511         return FALSE;
8512     }
8513 }
8514
8515 SV*
8516 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8517 {
8518     struct regexp *const rx = ReANY(r);
8519
8520     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8521
8522     if ( rx && RXp_PAREN_NAMES(rx) ) {
8523         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8524
8525         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8526     } else {
8527         return FALSE;
8528     }
8529 }
8530
8531 SV*
8532 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8533 {
8534     struct regexp *const rx = ReANY(r);
8535     GET_RE_DEBUG_FLAGS_DECL;
8536
8537     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8538
8539     if (rx && RXp_PAREN_NAMES(rx)) {
8540         HV *hv = RXp_PAREN_NAMES(rx);
8541         HE *temphe;
8542         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8543             IV i;
8544             IV parno = 0;
8545             SV* sv_dat = HeVAL(temphe);
8546             I32 *nums = (I32*)SvPVX(sv_dat);
8547             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8548                 if ((I32)(rx->lastparen) >= nums[i] &&
8549                     rx->offs[nums[i]].start != -1 &&
8550                     rx->offs[nums[i]].end != -1)
8551                 {
8552                     parno = nums[i];
8553                     break;
8554                 }
8555             }
8556             if (parno || flags & RXapif_ALL) {
8557                 return newSVhek(HeKEY_hek(temphe));
8558             }
8559         }
8560     }
8561     return NULL;
8562 }
8563
8564 SV*
8565 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8566 {
8567     SV *ret;
8568     AV *av;
8569     SSize_t length;
8570     struct regexp *const rx = ReANY(r);
8571
8572     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8573
8574     if (rx && RXp_PAREN_NAMES(rx)) {
8575         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8576             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8577         } else if (flags & RXapif_ONE) {
8578             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8579             av = MUTABLE_AV(SvRV(ret));
8580             length = av_tindex(av);
8581             SvREFCNT_dec_NN(ret);
8582             return newSViv(length + 1);
8583         } else {
8584             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8585                                                 (int)flags);
8586             return NULL;
8587         }
8588     }
8589     return &PL_sv_undef;
8590 }
8591
8592 SV*
8593 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8594 {
8595     struct regexp *const rx = ReANY(r);
8596     AV *av = newAV();
8597
8598     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8599
8600     if (rx && RXp_PAREN_NAMES(rx)) {
8601         HV *hv= RXp_PAREN_NAMES(rx);
8602         HE *temphe;
8603         (void)hv_iterinit(hv);
8604         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8605             IV i;
8606             IV parno = 0;
8607             SV* sv_dat = HeVAL(temphe);
8608             I32 *nums = (I32*)SvPVX(sv_dat);
8609             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8610                 if ((I32)(rx->lastparen) >= nums[i] &&
8611                     rx->offs[nums[i]].start != -1 &&
8612                     rx->offs[nums[i]].end != -1)
8613                 {
8614                     parno = nums[i];
8615                     break;
8616                 }
8617             }
8618             if (parno || flags & RXapif_ALL) {
8619                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8620             }
8621         }
8622     }
8623
8624     return newRV_noinc(MUTABLE_SV(av));
8625 }
8626
8627 void
8628 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8629                              SV * const sv)
8630 {
8631     struct regexp *const rx = ReANY(r);
8632     char *s = NULL;
8633     SSize_t i = 0;
8634     SSize_t s1, t1;
8635     I32 n = paren;
8636
8637     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8638
8639     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8640            || n == RX_BUFF_IDX_CARET_FULLMATCH
8641            || n == RX_BUFF_IDX_CARET_POSTMATCH
8642        )
8643     {
8644         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8645         if (!keepcopy) {
8646             /* on something like
8647              *    $r = qr/.../;
8648              *    /$qr/p;
8649              * the KEEPCOPY is set on the PMOP rather than the regex */
8650             if (PL_curpm && r == PM_GETRE(PL_curpm))
8651                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8652         }
8653         if (!keepcopy)
8654             goto ret_undef;
8655     }
8656
8657     if (!rx->subbeg)
8658         goto ret_undef;
8659
8660     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8661         /* no need to distinguish between them any more */
8662         n = RX_BUFF_IDX_FULLMATCH;
8663
8664     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8665         && rx->offs[0].start != -1)
8666     {
8667         /* $`, ${^PREMATCH} */
8668         i = rx->offs[0].start;
8669         s = rx->subbeg;
8670     }
8671     else
8672     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8673         && rx->offs[0].end != -1)
8674     {
8675         /* $', ${^POSTMATCH} */
8676         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8677         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8678     }
8679     else
8680     if ( 0 <= n && n <= (I32)rx->nparens &&
8681         (s1 = rx->offs[n].start) != -1 &&
8682         (t1 = rx->offs[n].end) != -1)
8683     {
8684         /* $&, ${^MATCH},  $1 ... */
8685         i = t1 - s1;
8686         s = rx->subbeg + s1 - rx->suboffset;
8687     } else {
8688         goto ret_undef;
8689     }
8690
8691     assert(s >= rx->subbeg);
8692     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8693     if (i >= 0) {
8694 #ifdef NO_TAINT_SUPPORT
8695         sv_setpvn(sv, s, i);
8696 #else
8697         const int oldtainted = TAINT_get;
8698         TAINT_NOT;
8699         sv_setpvn(sv, s, i);
8700         TAINT_set(oldtainted);
8701 #endif
8702         if (RXp_MATCH_UTF8(rx))
8703             SvUTF8_on(sv);
8704         else
8705             SvUTF8_off(sv);
8706         if (TAINTING_get) {
8707             if (RXp_MATCH_TAINTED(rx)) {
8708                 if (SvTYPE(sv) >= SVt_PVMG) {
8709                     MAGIC* const mg = SvMAGIC(sv);
8710                     MAGIC* mgt;
8711                     TAINT;
8712                     SvMAGIC_set(sv, mg->mg_moremagic);
8713                     SvTAINT(sv);
8714                     if ((mgt = SvMAGIC(sv))) {
8715                         mg->mg_moremagic = mgt;
8716                         SvMAGIC_set(sv, mg);
8717                     }
8718                 } else {
8719                     TAINT;
8720                     SvTAINT(sv);
8721                 }
8722             } else
8723                 SvTAINTED_off(sv);
8724         }
8725     } else {
8726       ret_undef:
8727         sv_set_undef(sv);
8728         return;
8729     }
8730 }
8731
8732 void
8733 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8734                                                          SV const * const value)
8735 {
8736     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8737
8738     PERL_UNUSED_ARG(rx);
8739     PERL_UNUSED_ARG(paren);
8740     PERL_UNUSED_ARG(value);
8741
8742     if (!PL_localizing)
8743         Perl_croak_no_modify();
8744 }
8745
8746 I32
8747 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8748                               const I32 paren)
8749 {
8750     struct regexp *const rx = ReANY(r);
8751     I32 i;
8752     I32 s1, t1;
8753
8754     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8755
8756     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8757         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8758         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8759     )
8760     {
8761         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8762         if (!keepcopy) {
8763             /* on something like
8764              *    $r = qr/.../;
8765              *    /$qr/p;
8766              * the KEEPCOPY is set on the PMOP rather than the regex */
8767             if (PL_curpm && r == PM_GETRE(PL_curpm))
8768                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8769         }
8770         if (!keepcopy)
8771             goto warn_undef;
8772     }
8773
8774     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8775     switch (paren) {
8776       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8777       case RX_BUFF_IDX_PREMATCH:       /* $` */
8778         if (rx->offs[0].start != -1) {
8779                         i = rx->offs[0].start;
8780                         if (i > 0) {
8781                                 s1 = 0;
8782                                 t1 = i;
8783                                 goto getlen;
8784                         }
8785             }
8786         return 0;
8787
8788       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8789       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8790             if (rx->offs[0].end != -1) {
8791                         i = rx->sublen - rx->offs[0].end;
8792                         if (i > 0) {
8793                                 s1 = rx->offs[0].end;
8794                                 t1 = rx->sublen;
8795                                 goto getlen;
8796                         }
8797             }
8798         return 0;
8799
8800       default: /* $& / ${^MATCH}, $1, $2, ... */
8801             if (paren <= (I32)rx->nparens &&
8802             (s1 = rx->offs[paren].start) != -1 &&
8803             (t1 = rx->offs[paren].end) != -1)
8804             {
8805             i = t1 - s1;
8806             goto getlen;
8807         } else {
8808           warn_undef:
8809             if (ckWARN(WARN_UNINITIALIZED))
8810                 report_uninit((const SV *)sv);
8811             return 0;
8812         }
8813     }
8814   getlen:
8815     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8816         const char * const s = rx->subbeg - rx->suboffset + s1;
8817         const U8 *ep;
8818         STRLEN el;
8819
8820         i = t1 - s1;
8821         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8822                         i = el;
8823     }
8824     return i;
8825 }
8826
8827 SV*
8828 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8829 {
8830     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8831         PERL_UNUSED_ARG(rx);
8832         if (0)
8833             return NULL;
8834         else
8835             return newSVpvs("Regexp");
8836 }
8837
8838 /* Scans the name of a named buffer from the pattern.
8839  * If flags is REG_RSN_RETURN_NULL returns null.
8840  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8841  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8842  * to the parsed name as looked up in the RExC_paren_names hash.
8843  * If there is an error throws a vFAIL().. type exception.
8844  */
8845
8846 #define REG_RSN_RETURN_NULL    0
8847 #define REG_RSN_RETURN_NAME    1
8848 #define REG_RSN_RETURN_DATA    2
8849
8850 STATIC SV*
8851 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8852 {
8853     char *name_start = RExC_parse;
8854     SV* sv_name;
8855
8856     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8857
8858     assert (RExC_parse <= RExC_end);
8859     if (RExC_parse == RExC_end) NOOP;
8860     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8861          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8862           * using do...while */
8863         if (UTF)
8864             do {
8865                 RExC_parse += UTF8SKIP(RExC_parse);
8866             } while (   RExC_parse < RExC_end
8867                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
8868         else
8869             do {
8870                 RExC_parse++;
8871             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
8872     } else {
8873         RExC_parse++; /* so the <- from the vFAIL is after the offending
8874                          character */
8875         vFAIL("Group name must start with a non-digit word character");
8876     }
8877     sv_name = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
8878                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
8879     if ( flags == REG_RSN_RETURN_NAME)
8880         return sv_name;
8881     else if (flags==REG_RSN_RETURN_DATA) {
8882         HE *he_str = NULL;
8883         SV *sv_dat = NULL;
8884         if ( ! sv_name )      /* should not happen*/
8885             Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
8886         if (RExC_paren_names)
8887             he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
8888         if ( he_str )
8889             sv_dat = HeVAL(he_str);
8890         if ( ! sv_dat ) {   /* Didn't find group */
8891
8892             /* It might be a forward reference; we can't fail until we
8893                 * know, by completing the parse to get all the groups, and
8894                 * then reparsing */
8895             if (ALL_PARENS_COUNTED)  {
8896                 vFAIL("Reference to nonexistent named group");
8897             }
8898             else {
8899                 REQUIRE_PARENS_PASS;
8900             }
8901         }
8902         return sv_dat;
8903     }
8904
8905     Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
8906                      (unsigned long) flags);
8907 }
8908
8909 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
8910     if (RExC_lastparse!=RExC_parse) {                           \
8911         Perl_re_printf( aTHX_  "%s",                            \
8912             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
8913                 RExC_end - RExC_parse, 16,                      \
8914                 "", "",                                         \
8915                 PERL_PV_ESCAPE_UNI_DETECT |                     \
8916                 PERL_PV_PRETTY_ELLIPSES   |                     \
8917                 PERL_PV_PRETTY_LTGT       |                     \
8918                 PERL_PV_ESCAPE_RE         |                     \
8919                 PERL_PV_PRETTY_EXACTSIZE                        \
8920             )                                                   \
8921         );                                                      \
8922     } else                                                      \
8923         Perl_re_printf( aTHX_ "%16s","");                       \
8924                                                                 \
8925     if (RExC_lastnum!=RExC_emit)                                \
8926        Perl_re_printf( aTHX_ "|%4d", RExC_emit);                \
8927     else                                                        \
8928        Perl_re_printf( aTHX_ "|%4s","");                        \
8929     Perl_re_printf( aTHX_ "|%*s%-4s",                           \
8930         (int)((depth*2)), "",                                   \
8931         (funcname)                                              \
8932     );                                                          \
8933     RExC_lastnum=RExC_emit;                                     \
8934     RExC_lastparse=RExC_parse;                                  \
8935 })
8936
8937
8938
8939 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
8940     DEBUG_PARSE_MSG((funcname));                            \
8941     Perl_re_printf( aTHX_ "%4s","\n");                                  \
8942 })
8943 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
8944     DEBUG_PARSE_MSG((funcname));                            \
8945     Perl_re_printf( aTHX_ fmt "\n",args);                               \
8946 })
8947
8948 /* This section of code defines the inversion list object and its methods.  The
8949  * interfaces are highly subject to change, so as much as possible is static to
8950  * this file.  An inversion list is here implemented as a malloc'd C UV array
8951  * as an SVt_INVLIST scalar.
8952  *
8953  * An inversion list for Unicode is an array of code points, sorted by ordinal
8954  * number.  Each element gives the code point that begins a range that extends
8955  * up-to but not including the code point given by the next element.  The final
8956  * element gives the first code point of a range that extends to the platform's
8957  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
8958  * ...) give ranges whose code points are all in the inversion list.  We say
8959  * that those ranges are in the set.  The odd-numbered elements give ranges
8960  * whose code points are not in the inversion list, and hence not in the set.
8961  * Thus, element [0] is the first code point in the list.  Element [1]
8962  * is the first code point beyond that not in the list; and element [2] is the
8963  * first code point beyond that that is in the list.  In other words, the first
8964  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
8965  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
8966  * all code points in that range are not in the inversion list.  The third
8967  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
8968  * list, and so forth.  Thus every element whose index is divisible by two
8969  * gives the beginning of a range that is in the list, and every element whose
8970  * index is not divisible by two gives the beginning of a range not in the
8971  * list.  If the final element's index is divisible by two, the inversion list
8972  * extends to the platform's infinity; otherwise the highest code point in the
8973  * inversion list is the contents of that element minus 1.
8974  *
8975  * A range that contains just a single code point N will look like
8976  *  invlist[i]   == N
8977  *  invlist[i+1] == N+1
8978  *
8979  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
8980  * impossible to represent, so element [i+1] is omitted.  The single element
8981  * inversion list
8982  *  invlist[0] == UV_MAX
8983  * contains just UV_MAX, but is interpreted as matching to infinity.
8984  *
8985  * Taking the complement (inverting) an inversion list is quite simple, if the
8986  * first element is 0, remove it; otherwise add a 0 element at the beginning.
8987  * This implementation reserves an element at the beginning of each inversion
8988  * list to always contain 0; there is an additional flag in the header which
8989  * indicates if the list begins at the 0, or is offset to begin at the next
8990  * element.  This means that the inversion list can be inverted without any
8991  * copying; just flip the flag.
8992  *
8993  * More about inversion lists can be found in "Unicode Demystified"
8994  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
8995  *
8996  * The inversion list data structure is currently implemented as an SV pointing
8997  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
8998  * array of UV whose memory management is automatically handled by the existing
8999  * facilities for SV's.
9000  *
9001  * Some of the methods should always be private to the implementation, and some
9002  * should eventually be made public */
9003
9004 /* The header definitions are in F<invlist_inline.h> */
9005
9006 #ifndef PERL_IN_XSUB_RE
9007
9008 PERL_STATIC_INLINE UV*
9009 S__invlist_array_init(SV* const invlist, const bool will_have_0)
9010 {
9011     /* Returns a pointer to the first element in the inversion list's array.
9012      * This is called upon initialization of an inversion list.  Where the
9013      * array begins depends on whether the list has the code point U+0000 in it
9014      * or not.  The other parameter tells it whether the code that follows this
9015      * call is about to put a 0 in the inversion list or not.  The first
9016      * element is either the element reserved for 0, if TRUE, or the element
9017      * after it, if FALSE */
9018
9019     bool* offset = get_invlist_offset_addr(invlist);
9020     UV* zero_addr = (UV *) SvPVX(invlist);
9021
9022     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
9023
9024     /* Must be empty */
9025     assert(! _invlist_len(invlist));
9026
9027     *zero_addr = 0;
9028
9029     /* 1^1 = 0; 1^0 = 1 */
9030     *offset = 1 ^ will_have_0;
9031     return zero_addr + *offset;
9032 }
9033
9034 PERL_STATIC_INLINE void
9035 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
9036 {
9037     /* Sets the current number of elements stored in the inversion list.
9038      * Updates SvCUR correspondingly */
9039     PERL_UNUSED_CONTEXT;
9040     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
9041
9042     assert(is_invlist(invlist));
9043
9044     SvCUR_set(invlist,
9045               (len == 0)
9046                ? 0
9047                : TO_INTERNAL_SIZE(len + offset));
9048     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
9049 }
9050
9051 STATIC void
9052 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
9053 {
9054     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
9055      * steals the list from 'src', so 'src' is made to have a NULL list.  This
9056      * is similar to what SvSetMagicSV() would do, if it were implemented on
9057      * inversion lists, though this routine avoids a copy */
9058
9059     const UV src_len          = _invlist_len(src);
9060     const bool src_offset     = *get_invlist_offset_addr(src);
9061     const STRLEN src_byte_len = SvLEN(src);
9062     char * array              = SvPVX(src);
9063
9064     const int oldtainted = TAINT_get;
9065
9066     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
9067
9068     assert(is_invlist(src));
9069     assert(is_invlist(dest));
9070     assert(! invlist_is_iterating(src));
9071     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
9072
9073     /* Make sure it ends in the right place with a NUL, as our inversion list
9074      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
9075      * asserts it */
9076     array[src_byte_len - 1] = '\0';
9077
9078     TAINT_NOT;      /* Otherwise it breaks */
9079     sv_usepvn_flags(dest,
9080                     (char *) array,
9081                     src_byte_len - 1,
9082
9083                     /* This flag is documented to cause a copy to be avoided */
9084                     SV_HAS_TRAILING_NUL);
9085     TAINT_set(oldtainted);
9086     SvPV_set(src, 0);
9087     SvLEN_set(src, 0);
9088     SvCUR_set(src, 0);
9089
9090     /* Finish up copying over the other fields in an inversion list */
9091     *get_invlist_offset_addr(dest) = src_offset;
9092     invlist_set_len(dest, src_len, src_offset);
9093     *get_invlist_previous_index_addr(dest) = 0;
9094     invlist_iterfinish(dest);
9095 }
9096
9097 PERL_STATIC_INLINE IV*
9098 S_get_invlist_previous_index_addr(SV* invlist)
9099 {
9100     /* Return the address of the IV that is reserved to hold the cached index
9101      * */
9102     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
9103
9104     assert(is_invlist(invlist));
9105
9106     return &(((XINVLIST*) SvANY(invlist))->prev_index);
9107 }
9108
9109 PERL_STATIC_INLINE IV
9110 S_invlist_previous_index(SV* const invlist)
9111 {
9112     /* Returns cached index of previous search */
9113
9114     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
9115
9116     return *get_invlist_previous_index_addr(invlist);
9117 }
9118
9119 PERL_STATIC_INLINE void
9120 S_invlist_set_previous_index(SV* const invlist, const IV index)
9121 {
9122     /* Caches <index> for later retrieval */
9123
9124     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
9125
9126     assert(index == 0 || index < (int) _invlist_len(invlist));
9127
9128     *get_invlist_previous_index_addr(invlist) = index;
9129 }
9130
9131 PERL_STATIC_INLINE void
9132 S_invlist_trim(SV* invlist)
9133 {
9134     /* Free the not currently-being-used space in an inversion list */
9135
9136     /* But don't free up the space needed for the 0 UV that is always at the
9137      * beginning of the list, nor the trailing NUL */
9138     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
9139
9140     PERL_ARGS_ASSERT_INVLIST_TRIM;
9141
9142     assert(is_invlist(invlist));
9143
9144     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
9145 }
9146
9147 PERL_STATIC_INLINE void
9148 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
9149 {
9150     PERL_ARGS_ASSERT_INVLIST_CLEAR;
9151
9152     assert(is_invlist(invlist));
9153
9154     invlist_set_len(invlist, 0, 0);
9155     invlist_trim(invlist);
9156 }
9157
9158 #endif /* ifndef PERL_IN_XSUB_RE */
9159
9160 PERL_STATIC_INLINE bool
9161 S_invlist_is_iterating(SV* const invlist)
9162 {
9163     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
9164
9165     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
9166 }
9167
9168 #ifndef PERL_IN_XSUB_RE
9169
9170 PERL_STATIC_INLINE UV
9171 S_invlist_max(SV* const invlist)
9172 {
9173     /* Returns the maximum number of elements storable in the inversion list's
9174      * array, without having to realloc() */
9175
9176     PERL_ARGS_ASSERT_INVLIST_MAX;
9177
9178     assert(is_invlist(invlist));
9179
9180     /* Assumes worst case, in which the 0 element is not counted in the
9181      * inversion list, so subtracts 1 for that */
9182     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
9183            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
9184            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
9185 }
9186
9187 STATIC void
9188 S_initialize_invlist_guts(pTHX_ SV* invlist, const Size_t initial_size)
9189 {
9190     PERL_ARGS_ASSERT_INITIALIZE_INVLIST_GUTS;
9191
9192     /* First 1 is in case the zero element isn't in the list; second 1 is for
9193      * trailing NUL */
9194     SvGROW(invlist, TO_INTERNAL_SIZE(initial_size + 1) + 1);
9195     invlist_set_len(invlist, 0, 0);
9196
9197     /* Force iterinit() to be used to get iteration to work */
9198     invlist_iterfinish(invlist);
9199
9200     *get_invlist_previous_index_addr(invlist) = 0;
9201 }
9202
9203 SV*
9204 Perl__new_invlist(pTHX_ IV initial_size)
9205 {
9206
9207     /* Return a pointer to a newly constructed inversion list, with enough
9208      * space to store 'initial_size' elements.  If that number is negative, a
9209      * system default is used instead */
9210
9211     SV* new_list;
9212
9213     if (initial_size < 0) {
9214         initial_size = 10;
9215     }
9216
9217     new_list = newSV_type(SVt_INVLIST);
9218     initialize_invlist_guts(new_list, initial_size);
9219
9220     return new_list;
9221 }
9222
9223 SV*
9224 Perl__new_invlist_C_array(pTHX_ const UV* const list)
9225 {
9226     /* Return a pointer to a newly constructed inversion list, initialized to
9227      * point to <list>, which has to be in the exact correct inversion list
9228      * form, including internal fields.  Thus this is a dangerous routine that
9229      * should not be used in the wrong hands.  The passed in 'list' contains
9230      * several header fields at the beginning that are not part of the
9231      * inversion list body proper */
9232
9233     const STRLEN length = (STRLEN) list[0];
9234     const UV version_id =          list[1];
9235     const bool offset   =    cBOOL(list[2]);
9236 #define HEADER_LENGTH 3
9237     /* If any of the above changes in any way, you must change HEADER_LENGTH
9238      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
9239      *      perl -E 'say int(rand 2**31-1)'
9240      */
9241 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
9242                                         data structure type, so that one being
9243                                         passed in can be validated to be an
9244                                         inversion list of the correct vintage.
9245                                        */
9246
9247     SV* invlist = newSV_type(SVt_INVLIST);
9248
9249     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
9250
9251     if (version_id != INVLIST_VERSION_ID) {
9252         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
9253     }
9254
9255     /* The generated array passed in includes header elements that aren't part
9256      * of the list proper, so start it just after them */
9257     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
9258
9259     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
9260                                shouldn't touch it */
9261
9262     *(get_invlist_offset_addr(invlist)) = offset;
9263
9264     /* The 'length' passed to us is the physical number of elements in the
9265      * inversion list.  But if there is an offset the logical number is one
9266      * less than that */
9267     invlist_set_len(invlist, length  - offset, offset);
9268
9269     invlist_set_previous_index(invlist, 0);
9270
9271     /* Initialize the iteration pointer. */
9272     invlist_iterfinish(invlist);
9273
9274     SvREADONLY_on(invlist);
9275
9276     return invlist;
9277 }
9278
9279 STATIC void
9280 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
9281 {
9282     /* Grow the maximum size of an inversion list */
9283
9284     PERL_ARGS_ASSERT_INVLIST_EXTEND;
9285
9286     assert(is_invlist(invlist));
9287
9288     /* Add one to account for the zero element at the beginning which may not
9289      * be counted by the calling parameters */
9290     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
9291 }
9292
9293 STATIC void
9294 S__append_range_to_invlist(pTHX_ SV* const invlist,
9295                                  const UV start, const UV end)
9296 {
9297    /* Subject to change or removal.  Append the range from 'start' to 'end' at
9298     * the end of the inversion list.  The range must be above any existing
9299     * ones. */
9300
9301     UV* array;
9302     UV max = invlist_max(invlist);
9303     UV len = _invlist_len(invlist);
9304     bool offset;
9305
9306     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
9307
9308     if (len == 0) { /* Empty lists must be initialized */
9309         offset = start != 0;
9310         array = _invlist_array_init(invlist, ! offset);
9311     }
9312     else {
9313         /* Here, the existing list is non-empty. The current max entry in the
9314          * list is generally the first value not in the set, except when the
9315          * set extends to the end of permissible values, in which case it is
9316          * the first entry in that final set, and so this call is an attempt to
9317          * append out-of-order */
9318
9319         UV final_element = len - 1;
9320         array = invlist_array(invlist);
9321         if (   array[final_element] > start
9322             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
9323         {
9324             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",
9325                      array[final_element], start,
9326                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
9327         }
9328
9329         /* Here, it is a legal append.  If the new range begins 1 above the end
9330          * of the range below it, it is extending the range below it, so the
9331          * new first value not in the set is one greater than the newly
9332          * extended range.  */
9333         offset = *get_invlist_offset_addr(invlist);
9334         if (array[final_element] == start) {
9335             if (end != UV_MAX) {
9336                 array[final_element] = end + 1;
9337             }
9338             else {
9339                 /* But if the end is the maximum representable on the machine,
9340                  * assume that infinity was actually what was meant.  Just let
9341                  * the range that this would extend to have no end */
9342                 invlist_set_len(invlist, len - 1, offset);
9343             }
9344             return;
9345         }
9346     }
9347
9348     /* Here the new range doesn't extend any existing set.  Add it */
9349
9350     len += 2;   /* Includes an element each for the start and end of range */
9351
9352     /* If wll overflow the existing space, extend, which may cause the array to
9353      * be moved */
9354     if (max < len) {
9355         invlist_extend(invlist, len);
9356
9357         /* Have to set len here to avoid assert failure in invlist_array() */
9358         invlist_set_len(invlist, len, offset);
9359
9360         array = invlist_array(invlist);
9361     }
9362     else {
9363         invlist_set_len(invlist, len, offset);
9364     }
9365
9366     /* The next item on the list starts the range, the one after that is
9367      * one past the new range.  */
9368     array[len - 2] = start;
9369     if (end != UV_MAX) {
9370         array[len - 1] = end + 1;
9371     }
9372     else {
9373         /* But if the end is the maximum representable on the machine, just let
9374          * the range have no end */
9375         invlist_set_len(invlist, len - 1, offset);
9376     }
9377 }
9378
9379 SSize_t
9380 Perl__invlist_search(SV* const invlist, const UV cp)
9381 {
9382     /* Searches the inversion list for the entry that contains the input code
9383      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
9384      * return value is the index into the list's array of the range that
9385      * contains <cp>, that is, 'i' such that
9386      *  array[i] <= cp < array[i+1]
9387      */
9388
9389     IV low = 0;
9390     IV mid;
9391     IV high = _invlist_len(invlist);
9392     const IV highest_element = high - 1;
9393     const UV* array;
9394
9395     PERL_ARGS_ASSERT__INVLIST_SEARCH;
9396
9397     /* If list is empty, return failure. */
9398     if (high == 0) {
9399         return -1;
9400     }
9401
9402     /* (We can't get the array unless we know the list is non-empty) */
9403     array = invlist_array(invlist);
9404
9405     mid = invlist_previous_index(invlist);
9406     assert(mid >=0);
9407     if (mid > highest_element) {
9408         mid = highest_element;
9409     }
9410
9411     /* <mid> contains the cache of the result of the previous call to this
9412      * function (0 the first time).  See if this call is for the same result,
9413      * or if it is for mid-1.  This is under the theory that calls to this
9414      * function will often be for related code points that are near each other.
9415      * And benchmarks show that caching gives better results.  We also test
9416      * here if the code point is within the bounds of the list.  These tests
9417      * replace others that would have had to be made anyway to make sure that
9418      * the array bounds were not exceeded, and these give us extra information
9419      * at the same time */
9420     if (cp >= array[mid]) {
9421         if (cp >= array[highest_element]) {
9422             return highest_element;
9423         }
9424
9425         /* Here, array[mid] <= cp < array[highest_element].  This means that
9426          * the final element is not the answer, so can exclude it; it also
9427          * means that <mid> is not the final element, so can refer to 'mid + 1'
9428          * safely */
9429         if (cp < array[mid + 1]) {
9430             return mid;
9431         }
9432         high--;
9433         low = mid + 1;
9434     }
9435     else { /* cp < aray[mid] */
9436         if (cp < array[0]) { /* Fail if outside the array */
9437             return -1;
9438         }
9439         high = mid;
9440         if (cp >= array[mid - 1]) {
9441             goto found_entry;
9442         }
9443     }
9444
9445     /* Binary search.  What we are looking for is <i> such that
9446      *  array[i] <= cp < array[i+1]
9447      * The loop below converges on the i+1.  Note that there may not be an
9448      * (i+1)th element in the array, and things work nonetheless */
9449     while (low < high) {
9450         mid = (low + high) / 2;
9451         assert(mid <= highest_element);
9452         if (array[mid] <= cp) { /* cp >= array[mid] */
9453             low = mid + 1;
9454
9455             /* We could do this extra test to exit the loop early.
9456             if (cp < array[low]) {
9457                 return mid;
9458             }
9459             */
9460         }
9461         else { /* cp < array[mid] */
9462             high = mid;
9463         }
9464     }
9465
9466   found_entry:
9467     high--;
9468     invlist_set_previous_index(invlist, high);
9469     return high;
9470 }
9471
9472 void
9473 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9474                                          const bool complement_b, SV** output)
9475 {
9476     /* Take the union of two inversion lists and point '*output' to it.  On
9477      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9478      * even 'a' or 'b').  If to an inversion list, the contents of the original
9479      * list will be replaced by the union.  The first list, 'a', may be
9480      * NULL, in which case a copy of the second list is placed in '*output'.
9481      * If 'complement_b' is TRUE, the union is taken of the complement
9482      * (inversion) of 'b' instead of b itself.
9483      *
9484      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9485      * Richard Gillam, published by Addison-Wesley, and explained at some
9486      * length there.  The preface says to incorporate its examples into your
9487      * code at your own risk.
9488      *
9489      * The algorithm is like a merge sort. */
9490
9491     const UV* array_a;    /* a's array */
9492     const UV* array_b;
9493     UV len_a;       /* length of a's array */
9494     UV len_b;
9495
9496     SV* u;                      /* the resulting union */
9497     UV* array_u;
9498     UV len_u = 0;
9499
9500     UV i_a = 0;             /* current index into a's array */
9501     UV i_b = 0;
9502     UV i_u = 0;
9503
9504     /* running count, as explained in the algorithm source book; items are
9505      * stopped accumulating and are output when the count changes to/from 0.
9506      * The count is incremented when we start a range that's in an input's set,
9507      * and decremented when we start a range that's not in a set.  So this
9508      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9509      * and hence nothing goes into the union; 1, just one of the inputs is in
9510      * its set (and its current range gets added to the union); and 2 when both
9511      * inputs are in their sets.  */
9512     UV count = 0;
9513
9514     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9515     assert(a != b);
9516     assert(*output == NULL || is_invlist(*output));
9517
9518     len_b = _invlist_len(b);
9519     if (len_b == 0) {
9520
9521         /* Here, 'b' is empty, hence it's complement is all possible code
9522          * points.  So if the union includes the complement of 'b', it includes
9523          * everything, and we need not even look at 'a'.  It's easiest to
9524          * create a new inversion list that matches everything.  */
9525         if (complement_b) {
9526             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9527
9528             if (*output == NULL) { /* If the output didn't exist, just point it
9529                                       at the new list */
9530                 *output = everything;
9531             }
9532             else { /* Otherwise, replace its contents with the new list */
9533                 invlist_replace_list_destroys_src(*output, everything);
9534                 SvREFCNT_dec_NN(everything);
9535             }
9536
9537             return;
9538         }
9539
9540         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9541          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9542          * output will be empty */
9543
9544         if (a == NULL || _invlist_len(a) == 0) {
9545             if (*output == NULL) {
9546                 *output = _new_invlist(0);
9547             }
9548             else {
9549                 invlist_clear(*output);
9550             }
9551             return;
9552         }
9553
9554         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9555          * union.  We can just return a copy of 'a' if '*output' doesn't point
9556          * to an existing list */
9557         if (*output == NULL) {
9558             *output = invlist_clone(a, NULL);
9559             return;
9560         }
9561
9562         /* If the output is to overwrite 'a', we have a no-op, as it's
9563          * already in 'a' */
9564         if (*output == a) {
9565             return;
9566         }
9567
9568         /* Here, '*output' is to be overwritten by 'a' */
9569         u = invlist_clone(a, NULL);
9570         invlist_replace_list_destroys_src(*output, u);
9571         SvREFCNT_dec_NN(u);
9572
9573         return;
9574     }
9575
9576     /* Here 'b' is not empty.  See about 'a' */
9577
9578     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9579
9580         /* Here, 'a' is empty (and b is not).  That means the union will come
9581          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9582          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9583          * the clone */
9584
9585         SV ** dest = (*output == NULL) ? output : &u;
9586         *dest = invlist_clone(b, NULL);
9587         if (complement_b) {
9588             _invlist_invert(*dest);
9589         }
9590
9591         if (dest == &u) {
9592             invlist_replace_list_destroys_src(*output, u);
9593             SvREFCNT_dec_NN(u);
9594         }
9595
9596         return;
9597     }
9598
9599     /* Here both lists exist and are non-empty */
9600     array_a = invlist_array(a);
9601     array_b = invlist_array(b);
9602
9603     /* If are to take the union of 'a' with the complement of b, set it
9604      * up so are looking at b's complement. */
9605     if (complement_b) {
9606
9607         /* To complement, we invert: if the first element is 0, remove it.  To
9608          * do this, we just pretend the array starts one later */
9609         if (array_b[0] == 0) {
9610             array_b++;
9611             len_b--;
9612         }
9613         else {
9614
9615             /* But if the first element is not zero, we pretend the list starts
9616              * at the 0 that is always stored immediately before the array. */
9617             array_b--;
9618             len_b++;
9619         }
9620     }
9621
9622     /* Size the union for the worst case: that the sets are completely
9623      * disjoint */
9624     u = _new_invlist(len_a + len_b);
9625
9626     /* Will contain U+0000 if either component does */
9627     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9628                                       || (len_b > 0 && array_b[0] == 0));
9629
9630     /* Go through each input list item by item, stopping when have exhausted
9631      * one of them */
9632     while (i_a < len_a && i_b < len_b) {
9633         UV cp;      /* The element to potentially add to the union's array */
9634         bool cp_in_set;   /* is it in the the input list's set or not */
9635
9636         /* We need to take one or the other of the two inputs for the union.
9637          * Since we are merging two sorted lists, we take the smaller of the
9638          * next items.  In case of a tie, we take first the one that is in its
9639          * set.  If we first took the one not in its set, it would decrement
9640          * the count, possibly to 0 which would cause it to be output as ending
9641          * the range, and the next time through we would take the same number,
9642          * and output it again as beginning the next range.  By doing it the
9643          * opposite way, there is no possibility that the count will be
9644          * momentarily decremented to 0, and thus the two adjoining ranges will
9645          * be seamlessly merged.  (In a tie and both are in the set or both not
9646          * in the set, it doesn't matter which we take first.) */
9647         if (       array_a[i_a] < array_b[i_b]
9648             || (   array_a[i_a] == array_b[i_b]
9649                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9650         {
9651             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9652             cp = array_a[i_a++];
9653         }
9654         else {
9655             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9656             cp = array_b[i_b++];
9657         }
9658
9659         /* Here, have chosen which of the two inputs to look at.  Only output
9660          * if the running count changes to/from 0, which marks the
9661          * beginning/end of a range that's in the set */
9662         if (cp_in_set) {
9663             if (count == 0) {
9664                 array_u[i_u++] = cp;
9665             }
9666             count++;
9667         }
9668         else {
9669             count--;
9670             if (count == 0) {
9671                 array_u[i_u++] = cp;
9672             }
9673         }
9674     }
9675
9676
9677     /* The loop above increments the index into exactly one of the input lists
9678      * each iteration, and ends when either index gets to its list end.  That
9679      * means the other index is lower than its end, and so something is
9680      * remaining in that one.  We decrement 'count', as explained below, if
9681      * that list is in its set.  (i_a and i_b each currently index the element
9682      * beyond the one we care about.) */
9683     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9684         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9685     {
9686         count--;
9687     }
9688
9689     /* Above we decremented 'count' if the list that had unexamined elements in
9690      * it was in its set.  This has made it so that 'count' being non-zero
9691      * means there isn't anything left to output; and 'count' equal to 0 means
9692      * that what is left to output is precisely that which is left in the
9693      * non-exhausted input list.
9694      *
9695      * To see why, note first that the exhausted input obviously has nothing
9696      * left to add to the union.  If it was in its set at its end, that means
9697      * the set extends from here to the platform's infinity, and hence so does
9698      * the union and the non-exhausted set is irrelevant.  The exhausted set
9699      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9700      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9701      * 'count' remains at 1.  This is consistent with the decremented 'count'
9702      * != 0 meaning there's nothing left to add to the union.
9703      *
9704      * But if the exhausted input wasn't in its set, it contributed 0 to
9705      * 'count', and the rest of the union will be whatever the other input is.
9706      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9707      * otherwise it gets decremented to 0.  This is consistent with 'count'
9708      * == 0 meaning the remainder of the union is whatever is left in the
9709      * non-exhausted list. */
9710     if (count != 0) {
9711         len_u = i_u;
9712     }
9713     else {
9714         IV copy_count = len_a - i_a;
9715         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9716             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9717         }
9718         else { /* The non-exhausted input is b */
9719             copy_count = len_b - i_b;
9720             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9721         }
9722         len_u = i_u + copy_count;
9723     }
9724
9725     /* Set the result to the final length, which can change the pointer to
9726      * array_u, so re-find it.  (Note that it is unlikely that this will
9727      * change, as we are shrinking the space, not enlarging it) */
9728     if (len_u != _invlist_len(u)) {
9729         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9730         invlist_trim(u);
9731         array_u = invlist_array(u);
9732     }
9733
9734     if (*output == NULL) {  /* Simply return the new inversion list */
9735         *output = u;
9736     }
9737     else {
9738         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9739          * could instead free '*output', and then set it to 'u', but experience
9740          * has shown [perl #127392] that if the input is a mortal, we can get a
9741          * huge build-up of these during regex compilation before they get
9742          * freed. */
9743         invlist_replace_list_destroys_src(*output, u);
9744         SvREFCNT_dec_NN(u);
9745     }
9746
9747     return;
9748 }
9749
9750 void
9751 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9752                                                const bool complement_b, SV** i)
9753 {
9754     /* Take the intersection of two inversion lists and point '*i' to it.  On
9755      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9756      * even 'a' or 'b').  If to an inversion list, the contents of the original
9757      * list will be replaced by the intersection.  The first list, 'a', may be
9758      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9759      * TRUE, the result will be the intersection of 'a' and the complement (or
9760      * inversion) of 'b' instead of 'b' directly.
9761      *
9762      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9763      * Richard Gillam, published by Addison-Wesley, and explained at some
9764      * length there.  The preface says to incorporate its examples into your
9765      * code at your own risk.  In fact, it had bugs
9766      *
9767      * The algorithm is like a merge sort, and is essentially the same as the
9768      * union above
9769      */
9770
9771     const UV* array_a;          /* a's array */
9772     const UV* array_b;
9773     UV len_a;   /* length of a's array */
9774     UV len_b;
9775
9776     SV* r;                   /* the resulting intersection */
9777     UV* array_r;
9778     UV len_r = 0;
9779
9780     UV i_a = 0;             /* current index into a's array */
9781     UV i_b = 0;
9782     UV i_r = 0;
9783
9784     /* running count of how many of the two inputs are postitioned at ranges
9785      * that are in their sets.  As explained in the algorithm source book,
9786      * items are stopped accumulating and are output when the count changes
9787      * to/from 2.  The count is incremented when we start a range that's in an
9788      * input's set, and decremented when we start a range that's not in a set.
9789      * Only when it is 2 are we in the intersection. */
9790     UV count = 0;
9791
9792     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9793     assert(a != b);
9794     assert(*i == NULL || is_invlist(*i));
9795
9796     /* Special case if either one is empty */
9797     len_a = (a == NULL) ? 0 : _invlist_len(a);
9798     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9799         if (len_a != 0 && complement_b) {
9800
9801             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9802              * must be empty.  Here, also we are using 'b's complement, which
9803              * hence must be every possible code point.  Thus the intersection
9804              * is simply 'a'. */
9805
9806             if (*i == a) {  /* No-op */
9807                 return;
9808             }
9809
9810             if (*i == NULL) {
9811                 *i = invlist_clone(a, NULL);
9812                 return;
9813             }
9814
9815             r = invlist_clone(a, NULL);
9816             invlist_replace_list_destroys_src(*i, r);
9817             SvREFCNT_dec_NN(r);
9818             return;
9819         }
9820
9821         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9822          * intersection must be empty */
9823         if (*i == NULL) {
9824             *i = _new_invlist(0);
9825             return;
9826         }
9827
9828         invlist_clear(*i);
9829         return;
9830     }
9831
9832     /* Here both lists exist and are non-empty */
9833     array_a = invlist_array(a);
9834     array_b = invlist_array(b);
9835
9836     /* If are to take the intersection of 'a' with the complement of b, set it
9837      * up so are looking at b's complement. */
9838     if (complement_b) {
9839
9840         /* To complement, we invert: if the first element is 0, remove it.  To
9841          * do this, we just pretend the array starts one later */
9842         if (array_b[0] == 0) {
9843             array_b++;
9844             len_b--;
9845         }
9846         else {
9847
9848             /* But if the first element is not zero, we pretend the list starts
9849              * at the 0 that is always stored immediately before the array. */
9850             array_b--;
9851             len_b++;
9852         }
9853     }
9854
9855     /* Size the intersection for the worst case: that the intersection ends up
9856      * fragmenting everything to be completely disjoint */
9857     r= _new_invlist(len_a + len_b);
9858
9859     /* Will contain U+0000 iff both components do */
9860     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9861                                      && len_b > 0 && array_b[0] == 0);
9862
9863     /* Go through each list item by item, stopping when have exhausted one of
9864      * them */
9865     while (i_a < len_a && i_b < len_b) {
9866         UV cp;      /* The element to potentially add to the intersection's
9867                        array */
9868         bool cp_in_set; /* Is it in the input list's set or not */
9869
9870         /* We need to take one or the other of the two inputs for the
9871          * intersection.  Since we are merging two sorted lists, we take the
9872          * smaller of the next items.  In case of a tie, we take first the one
9873          * that is not in its set (a difference from the union algorithm).  If
9874          * we first took the one in its set, it would increment the count,
9875          * possibly to 2 which would cause it to be output as starting a range
9876          * in the intersection, and the next time through we would take that
9877          * same number, and output it again as ending the set.  By doing the
9878          * opposite of this, there is no possibility that the count will be
9879          * momentarily incremented to 2.  (In a tie and both are in the set or
9880          * both not in the set, it doesn't matter which we take first.) */
9881         if (       array_a[i_a] < array_b[i_b]
9882             || (   array_a[i_a] == array_b[i_b]
9883                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9884         {
9885             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9886             cp = array_a[i_a++];
9887         }
9888         else {
9889             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9890             cp= array_b[i_b++];
9891         }
9892
9893         /* Here, have chosen which of the two inputs to look at.  Only output
9894          * if the running count changes to/from 2, which marks the
9895          * beginning/end of a range that's in the intersection */
9896         if (cp_in_set) {
9897             count++;
9898             if (count == 2) {
9899                 array_r[i_r++] = cp;
9900             }
9901         }
9902         else {
9903             if (count == 2) {
9904                 array_r[i_r++] = cp;
9905             }
9906             count--;
9907         }
9908
9909     }
9910
9911     /* The loop above increments the index into exactly one of the input lists
9912      * each iteration, and ends when either index gets to its list end.  That
9913      * means the other index is lower than its end, and so something is
9914      * remaining in that one.  We increment 'count', as explained below, if the
9915      * exhausted list was in its set.  (i_a and i_b each currently index the
9916      * element beyond the one we care about.) */
9917     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9918         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9919     {
9920         count++;
9921     }
9922
9923     /* Above we incremented 'count' if the exhausted list was in its set.  This
9924      * has made it so that 'count' being below 2 means there is nothing left to
9925      * output; otheriwse what's left to add to the intersection is precisely
9926      * that which is left in the non-exhausted input list.
9927      *
9928      * To see why, note first that the exhausted input obviously has nothing
9929      * left to affect the intersection.  If it was in its set at its end, that
9930      * means the set extends from here to the platform's infinity, and hence
9931      * anything in the non-exhausted's list will be in the intersection, and
9932      * anything not in it won't be.  Hence, the rest of the intersection is
9933      * precisely what's in the non-exhausted list  The exhausted set also
9934      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9935      * it means 'count' is now at least 2.  This is consistent with the
9936      * incremented 'count' being >= 2 means to add the non-exhausted list to
9937      * the intersection.
9938      *
9939      * But if the exhausted input wasn't in its set, it contributed 0 to
9940      * 'count', and the intersection can't include anything further; the
9941      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9942      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9943      * further to add to the intersection. */
9944     if (count < 2) { /* Nothing left to put in the intersection. */
9945         len_r = i_r;
9946     }
9947     else { /* copy the non-exhausted list, unchanged. */
9948         IV copy_count = len_a - i_a;
9949         if (copy_count > 0) {   /* a is the one with stuff left */
9950             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9951         }
9952         else {  /* b is the one with stuff left */
9953             copy_count = len_b - i_b;
9954             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9955         }
9956         len_r = i_r + copy_count;
9957     }
9958
9959     /* Set the result to the final length, which can change the pointer to
9960      * array_r, so re-find it.  (Note that it is unlikely that this will
9961      * change, as we are shrinking the space, not enlarging it) */
9962     if (len_r != _invlist_len(r)) {
9963         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9964         invlist_trim(r);
9965         array_r = invlist_array(r);
9966     }
9967
9968     if (*i == NULL) { /* Simply return the calculated intersection */
9969         *i = r;
9970     }
9971     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9972               instead free '*i', and then set it to 'r', but experience has
9973               shown [perl #127392] that if the input is a mortal, we can get a
9974               huge build-up of these during regex compilation before they get
9975               freed. */
9976         if (len_r) {
9977             invlist_replace_list_destroys_src(*i, r);
9978         }
9979         else {
9980             invlist_clear(*i);
9981         }
9982         SvREFCNT_dec_NN(r);
9983     }
9984
9985     return;
9986 }
9987
9988 SV*
9989 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9990 {
9991     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9992      * set.  A pointer to the inversion list is returned.  This may actually be
9993      * a new list, in which case the passed in one has been destroyed.  The
9994      * passed-in inversion list can be NULL, in which case a new one is created
9995      * with just the one range in it.  The new list is not necessarily
9996      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9997      * result of this function.  The gain would not be large, and in many
9998      * cases, this is called multiple times on a single inversion list, so
9999      * anything freed may almost immediately be needed again.
10000      *
10001      * This used to mostly call the 'union' routine, but that is much more
10002      * heavyweight than really needed for a single range addition */
10003
10004     UV* array;              /* The array implementing the inversion list */
10005     UV len;                 /* How many elements in 'array' */
10006     SSize_t i_s;            /* index into the invlist array where 'start'
10007                                should go */
10008     SSize_t i_e = 0;        /* And the index where 'end' should go */
10009     UV cur_highest;         /* The highest code point in the inversion list
10010                                upon entry to this function */
10011
10012     /* This range becomes the whole inversion list if none already existed */
10013     if (invlist == NULL) {
10014         invlist = _new_invlist(2);
10015         _append_range_to_invlist(invlist, start, end);
10016         return invlist;
10017     }
10018
10019     /* Likewise, if the inversion list is currently empty */
10020     len = _invlist_len(invlist);
10021     if (len == 0) {
10022         _append_range_to_invlist(invlist, start, end);
10023         return invlist;
10024     }
10025
10026     /* Starting here, we have to know the internals of the list */
10027     array = invlist_array(invlist);
10028
10029     /* If the new range ends higher than the current highest ... */
10030     cur_highest = invlist_highest(invlist);
10031     if (end > cur_highest) {
10032
10033         /* If the whole range is higher, we can just append it */
10034         if (start > cur_highest) {
10035             _append_range_to_invlist(invlist, start, end);
10036             return invlist;
10037         }
10038
10039         /* Otherwise, add the portion that is higher ... */
10040         _append_range_to_invlist(invlist, cur_highest + 1, end);
10041
10042         /* ... and continue on below to handle the rest.  As a result of the
10043          * above append, we know that the index of the end of the range is the
10044          * final even numbered one of the array.  Recall that the final element
10045          * always starts a range that extends to infinity.  If that range is in
10046          * the set (meaning the set goes from here to infinity), it will be an
10047          * even index, but if it isn't in the set, it's odd, and the final
10048          * range in the set is one less, which is even. */
10049         if (end == UV_MAX) {
10050             i_e = len;
10051         }
10052         else {
10053             i_e = len - 2;
10054         }
10055     }
10056
10057     /* We have dealt with appending, now see about prepending.  If the new
10058      * range starts lower than the current lowest ... */
10059     if (start < array[0]) {
10060
10061         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
10062          * Let the union code handle it, rather than having to know the
10063          * trickiness in two code places.  */
10064         if (UNLIKELY(start == 0)) {
10065             SV* range_invlist;
10066
10067             range_invlist = _new_invlist(2);
10068             _append_range_to_invlist(range_invlist, start, end);
10069
10070             _invlist_union(invlist, range_invlist, &invlist);
10071
10072             SvREFCNT_dec_NN(range_invlist);
10073
10074             return invlist;
10075         }
10076
10077         /* If the whole new range comes before the first entry, and doesn't
10078          * extend it, we have to insert it as an additional range */
10079         if (end < array[0] - 1) {
10080             i_s = i_e = -1;
10081             goto splice_in_new_range;
10082         }
10083
10084         /* Here the new range adjoins the existing first range, extending it
10085          * downwards. */
10086         array[0] = start;
10087
10088         /* And continue on below to handle the rest.  We know that the index of
10089          * the beginning of the range is the first one of the array */
10090         i_s = 0;
10091     }
10092     else { /* Not prepending any part of the new range to the existing list.
10093             * Find where in the list it should go.  This finds i_s, such that:
10094             *     invlist[i_s] <= start < array[i_s+1]
10095             */
10096         i_s = _invlist_search(invlist, start);
10097     }
10098
10099     /* At this point, any extending before the beginning of the inversion list
10100      * and/or after the end has been done.  This has made it so that, in the
10101      * code below, each endpoint of the new range is either in a range that is
10102      * in the set, or is in a gap between two ranges that are.  This means we
10103      * don't have to worry about exceeding the array bounds.
10104      *
10105      * Find where in the list the new range ends (but we can skip this if we
10106      * have already determined what it is, or if it will be the same as i_s,
10107      * which we already have computed) */
10108     if (i_e == 0) {
10109         i_e = (start == end)
10110               ? i_s
10111               : _invlist_search(invlist, end);
10112     }
10113
10114     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
10115      * is a range that goes to infinity there is no element at invlist[i_e+1],
10116      * so only the first relation holds. */
10117
10118     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10119
10120         /* Here, the ranges on either side of the beginning of the new range
10121          * are in the set, and this range starts in the gap between them.
10122          *
10123          * The new range extends the range above it downwards if the new range
10124          * ends at or above that range's start */
10125         const bool extends_the_range_above = (   end == UV_MAX
10126                                               || end + 1 >= array[i_s+1]);
10127
10128         /* The new range extends the range below it upwards if it begins just
10129          * after where that range ends */
10130         if (start == array[i_s]) {
10131
10132             /* If the new range fills the entire gap between the other ranges,
10133              * they will get merged together.  Other ranges may also get
10134              * merged, depending on how many of them the new range spans.  In
10135              * the general case, we do the merge later, just once, after we
10136              * figure out how many to merge.  But in the case where the new
10137              * range exactly spans just this one gap (possibly extending into
10138              * the one above), we do the merge here, and an early exit.  This
10139              * is done here to avoid having to special case later. */
10140             if (i_e - i_s <= 1) {
10141
10142                 /* If i_e - i_s == 1, it means that the new range terminates
10143                  * within the range above, and hence 'extends_the_range_above'
10144                  * must be true.  (If the range above it extends to infinity,
10145                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
10146                  * will be 0, so no harm done.) */
10147                 if (extends_the_range_above) {
10148                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
10149                     invlist_set_len(invlist,
10150                                     len - 2,
10151                                     *(get_invlist_offset_addr(invlist)));
10152                     return invlist;
10153                 }
10154
10155                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
10156                  * to the same range, and below we are about to decrement i_s
10157                  * */
10158                 i_e--;
10159             }
10160
10161             /* Here, the new range is adjacent to the one below.  (It may also
10162              * span beyond the range above, but that will get resolved later.)
10163              * Extend the range below to include this one. */
10164             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
10165             i_s--;
10166             start = array[i_s];
10167         }
10168         else if (extends_the_range_above) {
10169
10170             /* Here the new range only extends the range above it, but not the
10171              * one below.  It merges with the one above.  Again, we keep i_e
10172              * and i_s in sync if they point to the same range */
10173             if (i_e == i_s) {
10174                 i_e++;
10175             }
10176             i_s++;
10177             array[i_s] = start;
10178         }
10179     }
10180
10181     /* Here, we've dealt with the new range start extending any adjoining
10182      * existing ranges.
10183      *
10184      * If the new range extends to infinity, it is now the final one,
10185      * regardless of what was there before */
10186     if (UNLIKELY(end == UV_MAX)) {
10187         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
10188         return invlist;
10189     }
10190
10191     /* If i_e started as == i_s, it has also been dealt with,
10192      * and been updated to the new i_s, which will fail the following if */
10193     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
10194
10195         /* Here, the ranges on either side of the end of the new range are in
10196          * the set, and this range ends in the gap between them.
10197          *
10198          * If this range is adjacent to (hence extends) the range above it, it
10199          * becomes part of that range; likewise if it extends the range below,
10200          * it becomes part of that range */
10201         if (end + 1 == array[i_e+1]) {
10202             i_e++;
10203             array[i_e] = start;
10204         }
10205         else if (start <= array[i_e]) {
10206             array[i_e] = end + 1;
10207             i_e--;
10208         }
10209     }
10210
10211     if (i_s == i_e) {
10212
10213         /* If the range fits entirely in an existing range (as possibly already
10214          * extended above), it doesn't add anything new */
10215         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10216             return invlist;
10217         }
10218
10219         /* Here, no part of the range is in the list.  Must add it.  It will
10220          * occupy 2 more slots */
10221       splice_in_new_range:
10222
10223         invlist_extend(invlist, len + 2);
10224         array = invlist_array(invlist);
10225         /* Move the rest of the array down two slots. Don't include any
10226          * trailing NUL */
10227         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
10228
10229         /* Do the actual splice */
10230         array[i_e+1] = start;
10231         array[i_e+2] = end + 1;
10232         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
10233         return invlist;
10234     }
10235
10236     /* Here the new range crossed the boundaries of a pre-existing range.  The
10237      * code above has adjusted things so that both ends are in ranges that are
10238      * in the set.  This means everything in between must also be in the set.
10239      * Just squash things together */
10240     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
10241     invlist_set_len(invlist,
10242                     len - i_e + i_s,
10243                     *(get_invlist_offset_addr(invlist)));
10244
10245     return invlist;
10246 }
10247
10248 SV*
10249 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
10250                                  UV** other_elements_ptr)
10251 {
10252     /* Create and return an inversion list whose contents are to be populated
10253      * by the caller.  The caller gives the number of elements (in 'size') and
10254      * the very first element ('element0').  This function will set
10255      * '*other_elements_ptr' to an array of UVs, where the remaining elements
10256      * are to be placed.
10257      *
10258      * Obviously there is some trust involved that the caller will properly
10259      * fill in the other elements of the array.
10260      *
10261      * (The first element needs to be passed in, as the underlying code does
10262      * things differently depending on whether it is zero or non-zero) */
10263
10264     SV* invlist = _new_invlist(size);
10265     bool offset;
10266
10267     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
10268
10269     invlist = add_cp_to_invlist(invlist, element0);
10270     offset = *get_invlist_offset_addr(invlist);
10271
10272     invlist_set_len(invlist, size, offset);
10273     *other_elements_ptr = invlist_array(invlist) + 1;
10274     return invlist;
10275 }
10276
10277 #endif
10278
10279 PERL_STATIC_INLINE SV*
10280 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
10281     return _add_range_to_invlist(invlist, cp, cp);
10282 }
10283
10284 #ifndef PERL_IN_XSUB_RE
10285 void
10286 Perl__invlist_invert(pTHX_ SV* const invlist)
10287 {
10288     /* Complement the input inversion list.  This adds a 0 if the list didn't
10289      * have a zero; removes it otherwise.  As described above, the data
10290      * structure is set up so that this is very efficient */
10291
10292     PERL_ARGS_ASSERT__INVLIST_INVERT;
10293
10294     assert(! invlist_is_iterating(invlist));
10295
10296     /* The inverse of matching nothing is matching everything */
10297     if (_invlist_len(invlist) == 0) {
10298         _append_range_to_invlist(invlist, 0, UV_MAX);
10299         return;
10300     }
10301
10302     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
10303 }
10304
10305 SV*
10306 Perl_invlist_clone(pTHX_ SV* const invlist, SV* new_invlist)
10307 {
10308     /* Return a new inversion list that is a copy of the input one, which is
10309      * unchanged.  The new list will not be mortal even if the old one was. */
10310
10311     const STRLEN nominal_length = _invlist_len(invlist);
10312     const STRLEN physical_length = SvCUR(invlist);
10313     const bool offset = *(get_invlist_offset_addr(invlist));
10314
10315     PERL_ARGS_ASSERT_INVLIST_CLONE;
10316
10317     if (new_invlist == NULL) {
10318         new_invlist = _new_invlist(nominal_length);
10319     }
10320     else {
10321         sv_upgrade(new_invlist, SVt_INVLIST);
10322         initialize_invlist_guts(new_invlist, nominal_length);
10323     }
10324
10325     *(get_invlist_offset_addr(new_invlist)) = offset;
10326     invlist_set_len(new_invlist, nominal_length, offset);
10327     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
10328
10329     return new_invlist;
10330 }
10331
10332 #endif
10333
10334 PERL_STATIC_INLINE STRLEN*
10335 S_get_invlist_iter_addr(SV* invlist)
10336 {
10337     /* Return the address of the UV that contains the current iteration
10338      * position */
10339
10340     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
10341
10342     assert(is_invlist(invlist));
10343
10344     return &(((XINVLIST*) SvANY(invlist))->iterator);
10345 }
10346
10347 PERL_STATIC_INLINE void
10348 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
10349 {
10350     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
10351
10352     *get_invlist_iter_addr(invlist) = 0;
10353 }
10354
10355 PERL_STATIC_INLINE void
10356 S_invlist_iterfinish(SV* invlist)
10357 {
10358     /* Terminate iterator for invlist.  This is to catch development errors.
10359      * Any iteration that is interrupted before completed should call this
10360      * function.  Functions that add code points anywhere else but to the end
10361      * of an inversion list assert that they are not in the middle of an
10362      * iteration.  If they were, the addition would make the iteration
10363      * problematical: if the iteration hadn't reached the place where things
10364      * were being added, it would be ok */
10365
10366     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
10367
10368     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
10369 }
10370
10371 STATIC bool
10372 S_invlist_iternext(SV* invlist, UV* start, UV* end)
10373 {
10374     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
10375      * This call sets in <*start> and <*end>, the next range in <invlist>.
10376      * Returns <TRUE> if successful and the next call will return the next
10377      * range; <FALSE> if was already at the end of the list.  If the latter,
10378      * <*start> and <*end> are unchanged, and the next call to this function
10379      * will start over at the beginning of the list */
10380
10381     STRLEN* pos = get_invlist_iter_addr(invlist);
10382     UV len = _invlist_len(invlist);
10383     UV *array;
10384
10385     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
10386
10387     if (*pos >= len) {
10388         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
10389         return FALSE;
10390     }
10391
10392     array = invlist_array(invlist);
10393
10394     *start = array[(*pos)++];
10395
10396     if (*pos >= len) {
10397         *end = UV_MAX;
10398     }
10399     else {
10400         *end = array[(*pos)++] - 1;
10401     }
10402
10403     return TRUE;
10404 }
10405
10406 PERL_STATIC_INLINE UV
10407 S_invlist_highest(SV* const invlist)
10408 {
10409     /* Returns the highest code point that matches an inversion list.  This API
10410      * has an ambiguity, as it returns 0 under either the highest is actually
10411      * 0, or if the list is empty.  If this distinction matters to you, check
10412      * for emptiness before calling this function */
10413
10414     UV len = _invlist_len(invlist);
10415     UV *array;
10416
10417     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
10418
10419     if (len == 0) {
10420         return 0;
10421     }
10422
10423     array = invlist_array(invlist);
10424
10425     /* The last element in the array in the inversion list always starts a
10426      * range that goes to infinity.  That range may be for code points that are
10427      * matched in the inversion list, or it may be for ones that aren't
10428      * matched.  In the latter case, the highest code point in the set is one
10429      * less than the beginning of this range; otherwise it is the final element
10430      * of this range: infinity */
10431     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10432            ? UV_MAX
10433            : array[len - 1] - 1;
10434 }
10435
10436 STATIC SV *
10437 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10438 {
10439     /* Get the contents of an inversion list into a string SV so that they can
10440      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10441      * traditionally done for debug tracing; otherwise it uses a format
10442      * suitable for just copying to the output, with blanks between ranges and
10443      * a dash between range components */
10444
10445     UV start, end;
10446     SV* output;
10447     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10448     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10449
10450     if (traditional_style) {
10451         output = newSVpvs("\n");
10452     }
10453     else {
10454         output = newSVpvs("");
10455     }
10456
10457     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10458
10459     assert(! invlist_is_iterating(invlist));
10460
10461     invlist_iterinit(invlist);
10462     while (invlist_iternext(invlist, &start, &end)) {
10463         if (end == UV_MAX) {
10464             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFTY%c",
10465                                           start, intra_range_delimiter,
10466                                                  inter_range_delimiter);
10467         }
10468         else if (end != start) {
10469             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10470                                           start,
10471                                                    intra_range_delimiter,
10472                                                   end, inter_range_delimiter);
10473         }
10474         else {
10475             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10476                                           start, inter_range_delimiter);
10477         }
10478     }
10479
10480     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10481         SvCUR_set(output, SvCUR(output) - 1);
10482     }
10483
10484     return output;
10485 }
10486
10487 #ifndef PERL_IN_XSUB_RE
10488 void
10489 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10490                          const char * const indent, SV* const invlist)
10491 {
10492     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10493      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10494      * the string 'indent'.  The output looks like this:
10495          [0] 0x000A .. 0x000D
10496          [2] 0x0085
10497          [4] 0x2028 .. 0x2029
10498          [6] 0x3104 .. INFTY
10499      * This means that the first range of code points matched by the list are
10500      * 0xA through 0xD; the second range contains only the single code point
10501      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10502      * are used to define each range (except if the final range extends to
10503      * infinity, only a single element is needed).  The array index of the
10504      * first element for the corresponding range is given in brackets. */
10505
10506     UV start, end;
10507     STRLEN count = 0;
10508
10509     PERL_ARGS_ASSERT__INVLIST_DUMP;
10510
10511     if (invlist_is_iterating(invlist)) {
10512         Perl_dump_indent(aTHX_ level, file,
10513              "%sCan't dump inversion list because is in middle of iterating\n",
10514              indent);
10515         return;
10516     }
10517
10518     invlist_iterinit(invlist);
10519     while (invlist_iternext(invlist, &start, &end)) {
10520         if (end == UV_MAX) {
10521             Perl_dump_indent(aTHX_ level, file,
10522                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFTY\n",
10523                                    indent, (UV)count, start);
10524         }
10525         else if (end != start) {
10526             Perl_dump_indent(aTHX_ level, file,
10527                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10528                                 indent, (UV)count, start,         end);
10529         }
10530         else {
10531             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10532                                             indent, (UV)count, start);
10533         }
10534         count += 2;
10535     }
10536 }
10537
10538 #endif
10539
10540 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10541 bool
10542 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10543 {
10544     /* Return a boolean as to if the two passed in inversion lists are
10545      * identical.  The final argument, if TRUE, says to take the complement of
10546      * the second inversion list before doing the comparison */
10547
10548     const UV len_a = _invlist_len(a);
10549     UV len_b = _invlist_len(b);
10550
10551     const UV* array_a = NULL;
10552     const UV* array_b = NULL;
10553
10554     PERL_ARGS_ASSERT__INVLISTEQ;
10555
10556     /* This code avoids accessing the arrays unless it knows the length is
10557      * non-zero */
10558
10559     if (len_a == 0) {
10560         if (len_b == 0) {
10561             return ! complement_b;
10562         }
10563     }
10564     else {
10565         array_a = invlist_array(a);
10566     }
10567
10568     if (len_b != 0) {
10569         array_b = invlist_array(b);
10570     }
10571
10572     /* If are to compare 'a' with the complement of b, set it
10573      * up so are looking at b's complement. */
10574     if (complement_b) {
10575
10576         /* The complement of nothing is everything, so <a> would have to have
10577          * just one element, starting at zero (ending at infinity) */
10578         if (len_b == 0) {
10579             return (len_a == 1 && array_a[0] == 0);
10580         }
10581         if (array_b[0] == 0) {
10582
10583             /* Otherwise, to complement, we invert.  Here, the first element is
10584              * 0, just remove it.  To do this, we just pretend the array starts
10585              * one later */
10586
10587             array_b++;
10588             len_b--;
10589         }
10590         else {
10591
10592             /* But if the first element is not zero, we pretend the list starts
10593              * at the 0 that is always stored immediately before the array. */
10594             array_b--;
10595             len_b++;
10596         }
10597     }
10598
10599     return    len_a == len_b
10600            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10601
10602 }
10603 #endif
10604
10605 /*
10606  * As best we can, determine the characters that can match the start of
10607  * the given EXACTF-ish node.  This is for use in creating ssc nodes, so there
10608  * can be false positive matches
10609  *
10610  * Returns the invlist as a new SV*; it is the caller's responsibility to
10611  * call SvREFCNT_dec() when done with it.
10612  */
10613 STATIC SV*
10614 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10615 {
10616     dVAR;
10617     const U8 * s = (U8*)STRING(node);
10618     SSize_t bytelen = STR_LEN(node);
10619     UV uc;
10620     /* Start out big enough for 2 separate code points */
10621     SV* invlist = _new_invlist(4);
10622
10623     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10624
10625     if (! UTF) {
10626         uc = *s;
10627
10628         /* We punt and assume can match anything if the node begins
10629          * with a multi-character fold.  Things are complicated.  For
10630          * example, /ffi/i could match any of:
10631          *  "\N{LATIN SMALL LIGATURE FFI}"
10632          *  "\N{LATIN SMALL LIGATURE FF}I"
10633          *  "F\N{LATIN SMALL LIGATURE FI}"
10634          *  plus several other things; and making sure we have all the
10635          *  possibilities is hard. */
10636         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10637             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10638         }
10639         else {
10640             /* Any Latin1 range character can potentially match any
10641              * other depending on the locale, and in Turkic locales, U+130 and
10642              * U+131 */
10643             if (OP(node) == EXACTFL) {
10644                 _invlist_union(invlist, PL_Latin1, &invlist);
10645                 invlist = add_cp_to_invlist(invlist,
10646                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10647                 invlist = add_cp_to_invlist(invlist,
10648                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10649             }
10650             else {
10651                 /* But otherwise, it matches at least itself.  We can
10652                  * quickly tell if it has a distinct fold, and if so,
10653                  * it matches that as well */
10654                 invlist = add_cp_to_invlist(invlist, uc);
10655                 if (IS_IN_SOME_FOLD_L1(uc))
10656                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10657             }
10658
10659             /* Some characters match above-Latin1 ones under /i.  This
10660              * is true of EXACTFL ones when the locale is UTF-8 */
10661             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10662                 && (! isASCII(uc) || (OP(node) != EXACTFAA
10663                                     && OP(node) != EXACTFAA_NO_TRIE)))
10664             {
10665                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10666             }
10667         }
10668     }
10669     else {  /* Pattern is UTF-8 */
10670         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10671         const U8* e = s + bytelen;
10672         IV fc;
10673
10674         fc = uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10675
10676         /* The only code points that aren't folded in a UTF EXACTFish
10677          * node are are the problematic ones in EXACTFL nodes */
10678         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10679             /* We need to check for the possibility that this EXACTFL
10680              * node begins with a multi-char fold.  Therefore we fold
10681              * the first few characters of it so that we can make that
10682              * check */
10683             U8 *d = folded;
10684             int i;
10685
10686             fc = -1;
10687             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10688                 if (isASCII(*s)) {
10689                     *(d++) = (U8) toFOLD(*s);
10690                     if (fc < 0) {       /* Save the first fold */
10691                         fc = *(d-1);
10692                     }
10693                     s++;
10694                 }
10695                 else {
10696                     STRLEN len;
10697                     UV fold = toFOLD_utf8_safe(s, e, d, &len);
10698                     if (fc < 0) {       /* Save the first fold */
10699                         fc = fold;
10700                     }
10701                     d += len;
10702                     s += UTF8SKIP(s);
10703                 }
10704             }
10705
10706             /* And set up so the code below that looks in this folded
10707              * buffer instead of the node's string */
10708             e = d;
10709             s = folded;
10710         }
10711
10712         /* When we reach here 's' points to the fold of the first
10713          * character(s) of the node; and 'e' points to far enough along
10714          * the folded string to be just past any possible multi-char
10715          * fold.
10716          *
10717          * Unlike the non-UTF-8 case, the macro for determining if a
10718          * string is a multi-char fold requires all the characters to
10719          * already be folded.  This is because of all the complications
10720          * if not.  Note that they are folded anyway, except in EXACTFL
10721          * nodes.  Like the non-UTF case above, we punt if the node
10722          * begins with a multi-char fold  */
10723
10724         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10725             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10726         }
10727         else {  /* Single char fold */
10728             unsigned int k;
10729             unsigned int first_fold;
10730             const unsigned int * remaining_folds;
10731             Size_t folds_count;
10732
10733             /* It matches itself */
10734             invlist = add_cp_to_invlist(invlist, fc);
10735
10736             /* ... plus all the things that fold to it, which are found in
10737              * PL_utf8_foldclosures */
10738             folds_count = _inverse_folds(fc, &first_fold,
10739                                                 &remaining_folds);
10740             for (k = 0; k < folds_count; k++) {
10741                 UV c = (k == 0) ? first_fold : remaining_folds[k-1];
10742
10743                 /* /aa doesn't allow folds between ASCII and non- */
10744                 if (   (OP(node) == EXACTFAA || OP(node) == EXACTFAA_NO_TRIE)
10745                     && isASCII(c) != isASCII(fc))
10746                 {
10747                     continue;
10748                 }
10749
10750                 invlist = add_cp_to_invlist(invlist, c);
10751             }
10752
10753             if (OP(node) == EXACTFL) {
10754
10755                 /* If either [iI] are present in an EXACTFL node the above code
10756                  * should have added its normal case pair, but under a Turkish
10757                  * locale they could match instead the case pairs from it.  Add
10758                  * those as potential matches as well */
10759                 if (isALPHA_FOLD_EQ(fc, 'I')) {
10760                     invlist = add_cp_to_invlist(invlist,
10761                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10762                     invlist = add_cp_to_invlist(invlist,
10763                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10764                 }
10765                 else if (fc == LATIN_SMALL_LETTER_DOTLESS_I) {
10766                     invlist = add_cp_to_invlist(invlist, 'I');
10767                 }
10768                 else if (fc == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE) {
10769                     invlist = add_cp_to_invlist(invlist, 'i');
10770                 }
10771             }
10772         }
10773     }
10774
10775     return invlist;
10776 }
10777
10778 #undef HEADER_LENGTH
10779 #undef TO_INTERNAL_SIZE
10780 #undef FROM_INTERNAL_SIZE
10781 #undef INVLIST_VERSION_ID
10782
10783 /* End of inversion list object */
10784
10785 STATIC void
10786 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10787 {
10788     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10789      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10790      * should point to the first flag; it is updated on output to point to the
10791      * final ')' or ':'.  There needs to be at least one flag, or this will
10792      * abort */
10793
10794     /* for (?g), (?gc), and (?o) warnings; warning
10795        about (?c) will warn about (?g) -- japhy    */
10796
10797 #define WASTED_O  0x01
10798 #define WASTED_G  0x02
10799 #define WASTED_C  0x04
10800 #define WASTED_GC (WASTED_G|WASTED_C)
10801     I32 wastedflags = 0x00;
10802     U32 posflags = 0, negflags = 0;
10803     U32 *flagsp = &posflags;
10804     char has_charset_modifier = '\0';
10805     regex_charset cs;
10806     bool has_use_defaults = FALSE;
10807     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10808     int x_mod_count = 0;
10809
10810     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10811
10812     /* '^' as an initial flag sets certain defaults */
10813     if (UCHARAT(RExC_parse) == '^') {
10814         RExC_parse++;
10815         has_use_defaults = TRUE;
10816         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10817         cs = (RExC_uni_semantics)
10818              ? REGEX_UNICODE_CHARSET
10819              : REGEX_DEPENDS_CHARSET;
10820         set_regex_charset(&RExC_flags, cs);
10821     }
10822     else {
10823         cs = get_regex_charset(RExC_flags);
10824         if (   cs == REGEX_DEPENDS_CHARSET
10825             && RExC_uni_semantics)
10826         {
10827             cs = REGEX_UNICODE_CHARSET;
10828         }
10829     }
10830
10831     while (RExC_parse < RExC_end) {
10832         /* && strchr("iogcmsx", *RExC_parse) */
10833         /* (?g), (?gc) and (?o) are useless here
10834            and must be globally applied -- japhy */
10835         switch (*RExC_parse) {
10836
10837             /* Code for the imsxn flags */
10838             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10839
10840             case LOCALE_PAT_MOD:
10841                 if (has_charset_modifier) {
10842                     goto excess_modifier;
10843                 }
10844                 else if (flagsp == &negflags) {
10845                     goto neg_modifier;
10846                 }
10847                 cs = REGEX_LOCALE_CHARSET;
10848                 has_charset_modifier = LOCALE_PAT_MOD;
10849                 break;
10850             case UNICODE_PAT_MOD:
10851                 if (has_charset_modifier) {
10852                     goto excess_modifier;
10853                 }
10854                 else if (flagsp == &negflags) {
10855                     goto neg_modifier;
10856                 }
10857                 cs = REGEX_UNICODE_CHARSET;
10858                 has_charset_modifier = UNICODE_PAT_MOD;
10859                 break;
10860             case ASCII_RESTRICT_PAT_MOD:
10861                 if (flagsp == &negflags) {
10862                     goto neg_modifier;
10863                 }
10864                 if (has_charset_modifier) {
10865                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10866                         goto excess_modifier;
10867                     }
10868                     /* Doubled modifier implies more restricted */
10869                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10870                 }
10871                 else {
10872                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10873                 }
10874                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10875                 break;
10876             case DEPENDS_PAT_MOD:
10877                 if (has_use_defaults) {
10878                     goto fail_modifiers;
10879                 }
10880                 else if (flagsp == &negflags) {
10881                     goto neg_modifier;
10882                 }
10883                 else if (has_charset_modifier) {
10884                     goto excess_modifier;
10885                 }
10886
10887                 /* The dual charset means unicode semantics if the
10888                  * pattern (or target, not known until runtime) are
10889                  * utf8, or something in the pattern indicates unicode
10890                  * semantics */
10891                 cs = (RExC_uni_semantics)
10892                      ? REGEX_UNICODE_CHARSET
10893                      : REGEX_DEPENDS_CHARSET;
10894                 has_charset_modifier = DEPENDS_PAT_MOD;
10895                 break;
10896               excess_modifier:
10897                 RExC_parse++;
10898                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10899                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10900                 }
10901                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10902                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10903                                         *(RExC_parse - 1));
10904                 }
10905                 else {
10906                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10907                 }
10908                 NOT_REACHED; /*NOTREACHED*/
10909               neg_modifier:
10910                 RExC_parse++;
10911                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10912                                     *(RExC_parse - 1));
10913                 NOT_REACHED; /*NOTREACHED*/
10914             case ONCE_PAT_MOD: /* 'o' */
10915             case GLOBAL_PAT_MOD: /* 'g' */
10916                 if (ckWARN(WARN_REGEXP)) {
10917                     const I32 wflagbit = *RExC_parse == 'o'
10918                                          ? WASTED_O
10919                                          : WASTED_G;
10920                     if (! (wastedflags & wflagbit) ) {
10921                         wastedflags |= wflagbit;
10922                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10923                         vWARN5(
10924                             RExC_parse + 1,
10925                             "Useless (%s%c) - %suse /%c modifier",
10926                             flagsp == &negflags ? "?-" : "?",
10927                             *RExC_parse,
10928                             flagsp == &negflags ? "don't " : "",
10929                             *RExC_parse
10930                         );
10931                     }
10932                 }
10933                 break;
10934
10935             case CONTINUE_PAT_MOD: /* 'c' */
10936                 if (ckWARN(WARN_REGEXP)) {
10937                     if (! (wastedflags & WASTED_C) ) {
10938                         wastedflags |= WASTED_GC;
10939                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10940                         vWARN3(
10941                             RExC_parse + 1,
10942                             "Useless (%sc) - %suse /gc modifier",
10943                             flagsp == &negflags ? "?-" : "?",
10944                             flagsp == &negflags ? "don't " : ""
10945                         );
10946                     }
10947                 }
10948                 break;
10949             case KEEPCOPY_PAT_MOD: /* 'p' */
10950                 if (flagsp == &negflags) {
10951                     ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10952                 } else {
10953                     *flagsp |= RXf_PMf_KEEPCOPY;
10954                 }
10955                 break;
10956             case '-':
10957                 /* A flag is a default iff it is following a minus, so
10958                  * if there is a minus, it means will be trying to
10959                  * re-specify a default which is an error */
10960                 if (has_use_defaults || flagsp == &negflags) {
10961                     goto fail_modifiers;
10962                 }
10963                 flagsp = &negflags;
10964                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10965                 x_mod_count = 0;
10966                 break;
10967             case ':':
10968             case ')':
10969
10970                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10971                     negflags |= RXf_PMf_EXTENDED_MORE;
10972                 }
10973                 RExC_flags |= posflags;
10974
10975                 if (negflags & RXf_PMf_EXTENDED) {
10976                     negflags |= RXf_PMf_EXTENDED_MORE;
10977                 }
10978                 RExC_flags &= ~negflags;
10979                 set_regex_charset(&RExC_flags, cs);
10980
10981                 return;
10982             default:
10983               fail_modifiers:
10984                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
10985                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10986                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10987                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10988                 NOT_REACHED; /*NOTREACHED*/
10989         }
10990
10991         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10992     }
10993
10994     vFAIL("Sequence (?... not terminated");
10995 }
10996
10997 /*
10998  - reg - regular expression, i.e. main body or parenthesized thing
10999  *
11000  * Caller must absorb opening parenthesis.
11001  *
11002  * Combining parenthesis handling with the base level of regular expression
11003  * is a trifle forced, but the need to tie the tails of the branches to what
11004  * follows makes it hard to avoid.
11005  */
11006 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
11007 #ifdef DEBUGGING
11008 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
11009 #else
11010 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
11011 #endif
11012
11013 PERL_STATIC_INLINE regnode_offset
11014 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
11015                              I32 *flagp,
11016                              char * parse_start,
11017                              char ch
11018                       )
11019 {
11020     regnode_offset ret;
11021     char* name_start = RExC_parse;
11022     U32 num = 0;
11023     SV *sv_dat = reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11024     GET_RE_DEBUG_FLAGS_DECL;
11025
11026     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
11027
11028     if (RExC_parse == name_start || *RExC_parse != ch) {
11029         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
11030         vFAIL2("Sequence %.3s... not terminated", parse_start);
11031     }
11032
11033     if (sv_dat) {
11034         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11035         RExC_rxi->data->data[num]=(void*)sv_dat;
11036         SvREFCNT_inc_simple_void_NN(sv_dat);
11037     }
11038     RExC_sawback = 1;
11039     ret = reganode(pRExC_state,
11040                    ((! FOLD)
11041                      ? REFN
11042                      : (ASCII_FOLD_RESTRICTED)
11043                        ? REFFAN
11044                        : (AT_LEAST_UNI_SEMANTICS)
11045                          ? REFFUN
11046                          : (LOC)
11047                            ? REFFLN
11048                            : REFFN),
11049                     num);
11050     *flagp |= HASWIDTH;
11051
11052     Set_Node_Offset(REGNODE_p(ret), parse_start+1);
11053     Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
11054
11055     nextchar(pRExC_state);
11056     return ret;
11057 }
11058
11059 /* On success, returns the offset at which any next node should be placed into
11060  * the regex engine program being compiled.
11061  *
11062  * Returns 0 otherwise, with *flagp set to indicate why:
11063  *  TRYAGAIN        at the end of (?) that only sets flags.
11064  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
11065  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
11066  *  Otherwise would only return 0 if regbranch() returns 0, which cannot
11067  *  happen.  */
11068 STATIC regnode_offset
11069 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp, U32 depth)
11070     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
11071      * 2 is like 1, but indicates that nextchar() has been called to advance
11072      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
11073      * this flag alerts us to the need to check for that */
11074 {
11075     regnode_offset ret = 0;    /* Will be the head of the group. */
11076     regnode_offset br;
11077     regnode_offset lastbr;
11078     regnode_offset ender = 0;
11079     I32 parno = 0;
11080     I32 flags;
11081     U32 oregflags = RExC_flags;
11082     bool have_branch = 0;
11083     bool is_open = 0;
11084     I32 freeze_paren = 0;
11085     I32 after_freeze = 0;
11086     I32 num; /* numeric backreferences */
11087     SV * max_open;  /* Max number of unclosed parens */
11088
11089     char * parse_start = RExC_parse; /* MJD */
11090     char * const oregcomp_parse = RExC_parse;
11091
11092     GET_RE_DEBUG_FLAGS_DECL;
11093
11094     PERL_ARGS_ASSERT_REG;
11095     DEBUG_PARSE("reg ");
11096
11097
11098     max_open = get_sv(RE_COMPILE_RECURSION_LIMIT, GV_ADD);
11099     assert(max_open);
11100     if (!SvIOK(max_open)) {
11101         sv_setiv(max_open, RE_COMPILE_RECURSION_INIT);
11102     }
11103     if (depth > 4 * (UV) SvIV(max_open)) { /* We increase depth by 4 for each
11104                                               open paren */
11105         vFAIL("Too many nested open parens");
11106     }
11107
11108     *flagp = 0;                         /* Tentatively. */
11109
11110     if (RExC_in_lookbehind) {
11111         RExC_in_lookbehind++;
11112     }
11113     if (RExC_in_lookahead) {
11114         RExC_in_lookahead++;
11115     }
11116
11117     /* Having this true makes it feasible to have a lot fewer tests for the
11118      * parse pointer being in scope.  For example, we can write
11119      *      while(isFOO(*RExC_parse)) RExC_parse++;
11120      * instead of
11121      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
11122      */
11123     assert(*RExC_end == '\0');
11124
11125     /* Make an OPEN node, if parenthesized. */
11126     if (paren) {
11127
11128         /* Under /x, space and comments can be gobbled up between the '(' and
11129          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
11130          * intervening space, as the sequence is a token, and a token should be
11131          * indivisible */
11132         bool has_intervening_patws = (paren == 2)
11133                                   && *(RExC_parse - 1) != '(';
11134
11135         if (RExC_parse >= RExC_end) {
11136             vFAIL("Unmatched (");
11137         }
11138
11139         if (paren == 'r') {     /* Atomic script run */
11140             paren = '>';
11141             goto parse_rest;
11142         }
11143         else if ( *RExC_parse == '*') { /* (*VERB:ARG), (*construct:...) */
11144             char *start_verb = RExC_parse + 1;
11145             STRLEN verb_len;
11146             char *start_arg = NULL;
11147             unsigned char op = 0;
11148             int arg_required = 0;
11149             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
11150             bool has_upper = FALSE;
11151
11152             if (has_intervening_patws) {
11153                 RExC_parse++;   /* past the '*' */
11154
11155                 /* For strict backwards compatibility, don't change the message
11156                  * now that we also have lowercase operands */
11157                 if (isUPPER(*RExC_parse)) {
11158                     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
11159                 }
11160                 else {
11161                     vFAIL("In '(*...)', the '(' and '*' must be adjacent");
11162                 }
11163             }
11164             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
11165                 if ( *RExC_parse == ':' ) {
11166                     start_arg = RExC_parse + 1;
11167                     break;
11168                 }
11169                 else if (! UTF) {
11170                     if (isUPPER(*RExC_parse)) {
11171                         has_upper = TRUE;
11172                     }
11173                     RExC_parse++;
11174                 }
11175                 else {
11176                     RExC_parse += UTF8SKIP(RExC_parse);
11177                 }
11178             }
11179             verb_len = RExC_parse - start_verb;
11180             if ( start_arg ) {
11181                 if (RExC_parse >= RExC_end) {
11182                     goto unterminated_verb_pattern;
11183                 }
11184
11185                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11186                 while ( RExC_parse < RExC_end && *RExC_parse != ')' ) {
11187                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11188                 }
11189                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11190                   unterminated_verb_pattern:
11191                     if (has_upper) {
11192                         vFAIL("Unterminated verb pattern argument");
11193                     }
11194                     else {
11195                         vFAIL("Unterminated '(*...' argument");
11196                     }
11197                 }
11198             } else {
11199                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11200                     if (has_upper) {
11201                         vFAIL("Unterminated verb pattern");
11202                     }
11203                     else {
11204                         vFAIL("Unterminated '(*...' construct");
11205                     }
11206                 }
11207             }
11208
11209             /* Here, we know that RExC_parse < RExC_end */
11210
11211             switch ( *start_verb ) {
11212             case 'A':  /* (*ACCEPT) */
11213                 if ( memEQs(start_verb, verb_len,"ACCEPT") ) {
11214                     op = ACCEPT;
11215                     internal_argval = RExC_nestroot;
11216                 }
11217                 break;
11218             case 'C':  /* (*COMMIT) */
11219                 if ( memEQs(start_verb, verb_len,"COMMIT") )
11220                     op = COMMIT;
11221                 break;
11222             case 'F':  /* (*FAIL) */
11223                 if ( verb_len==1 || memEQs(start_verb, verb_len,"FAIL") ) {
11224                     op = OPFAIL;
11225                 }
11226                 break;
11227             case ':':  /* (*:NAME) */
11228             case 'M':  /* (*MARK:NAME) */
11229                 if ( verb_len==0 || memEQs(start_verb, verb_len,"MARK") ) {
11230                     op = MARKPOINT;
11231                     arg_required = 1;
11232                 }
11233                 break;
11234             case 'P':  /* (*PRUNE) */
11235                 if ( memEQs(start_verb, verb_len,"PRUNE") )
11236                     op = PRUNE;
11237                 break;
11238             case 'S':   /* (*SKIP) */
11239                 if ( memEQs(start_verb, verb_len,"SKIP") )
11240                     op = SKIP;
11241                 break;
11242             case 'T':  /* (*THEN) */
11243                 /* [19:06] <TimToady> :: is then */
11244                 if ( memEQs(start_verb, verb_len,"THEN") ) {
11245                     op = CUTGROUP;
11246                     RExC_seen |= REG_CUTGROUP_SEEN;
11247                 }
11248                 break;
11249             case 'a':
11250                 if (   memEQs(start_verb, verb_len, "asr")
11251                     || memEQs(start_verb, verb_len, "atomic_script_run"))
11252                 {
11253                     paren = 'r';        /* Mnemonic: recursed run */
11254                     goto script_run;
11255                 }
11256                 else if (memEQs(start_verb, verb_len, "atomic")) {
11257                     paren = 't';    /* AtOMIC */
11258                     goto alpha_assertions;
11259                 }
11260                 break;
11261             case 'p':
11262                 if (   memEQs(start_verb, verb_len, "plb")
11263                     || memEQs(start_verb, verb_len, "positive_lookbehind"))
11264                 {
11265                     paren = 'b';
11266                     goto lookbehind_alpha_assertions;
11267                 }
11268                 else if (   memEQs(start_verb, verb_len, "pla")
11269                          || memEQs(start_verb, verb_len, "positive_lookahead"))
11270                 {
11271                     paren = 'a';
11272                     goto alpha_assertions;
11273                 }
11274                 break;
11275             case 'n':
11276                 if (   memEQs(start_verb, verb_len, "nlb")
11277                     || memEQs(start_verb, verb_len, "negative_lookbehind"))
11278                 {
11279                     paren = 'B';
11280                     goto lookbehind_alpha_assertions;
11281                 }
11282                 else if (   memEQs(start_verb, verb_len, "nla")
11283                          || memEQs(start_verb, verb_len, "negative_lookahead"))
11284                 {
11285                     paren = 'A';
11286                     goto alpha_assertions;
11287                 }
11288                 break;
11289             case 's':
11290                 if (   memEQs(start_verb, verb_len, "sr")
11291                     || memEQs(start_verb, verb_len, "script_run"))
11292                 {
11293                     regnode_offset atomic;
11294
11295                     paren = 's';
11296
11297                    script_run:
11298
11299                     /* This indicates Unicode rules. */
11300                     REQUIRE_UNI_RULES(flagp, 0);
11301
11302                     if (! start_arg) {
11303                         goto no_colon;
11304                     }
11305
11306                     RExC_parse = start_arg;
11307
11308                     if (RExC_in_script_run) {
11309
11310                         /*  Nested script runs are treated as no-ops, because
11311                          *  if the nested one fails, the outer one must as
11312                          *  well.  It could fail sooner, and avoid (??{} with
11313                          *  side effects, but that is explicitly documented as
11314                          *  undefined behavior. */
11315
11316                         ret = 0;
11317
11318                         if (paren == 's') {
11319                             paren = ':';
11320                             goto parse_rest;
11321                         }
11322
11323                         /* But, the atomic part of a nested atomic script run
11324                          * isn't a no-op, but can be treated just like a '(?>'
11325                          * */
11326                         paren = '>';
11327                         goto parse_rest;
11328                     }
11329
11330                     /* By doing this here, we avoid extra warnings for nested
11331                      * script runs */
11332                     ckWARNexperimental(RExC_parse,
11333                         WARN_EXPERIMENTAL__SCRIPT_RUN,
11334                         "The script_run feature is experimental");
11335
11336                     if (paren == 's') {
11337                         /* Here, we're starting a new regular script run */
11338                         ret = reg_node(pRExC_state, SROPEN);
11339                         RExC_in_script_run = 1;
11340                         is_open = 1;
11341                         goto parse_rest;
11342                     }
11343
11344                     /* Here, we are starting an atomic script run.  This is
11345                      * handled by recursing to deal with the atomic portion
11346                      * separately, enclosed in SROPEN ... SRCLOSE nodes */
11347
11348                     ret = reg_node(pRExC_state, SROPEN);
11349
11350                     RExC_in_script_run = 1;
11351
11352                     atomic = reg(pRExC_state, 'r', &flags, depth);
11353                     if (flags & (RESTART_PARSE|NEED_UTF8)) {
11354                         *flagp = flags & (RESTART_PARSE|NEED_UTF8);
11355                         return 0;
11356                     }
11357
11358                     if (! REGTAIL(pRExC_state, ret, atomic)) {
11359                         REQUIRE_BRANCHJ(flagp, 0);
11360                     }
11361
11362                     if (! REGTAIL(pRExC_state, atomic, reg_node(pRExC_state,
11363                                                                 SRCLOSE)))
11364                     {
11365                         REQUIRE_BRANCHJ(flagp, 0);
11366                     }
11367
11368                     RExC_in_script_run = 0;
11369                     return ret;
11370                 }
11371
11372                 break;
11373
11374             lookbehind_alpha_assertions:
11375                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11376                 RExC_in_lookbehind++;
11377                 /*FALLTHROUGH*/
11378
11379             alpha_assertions:
11380                 ckWARNexperimental(RExC_parse,
11381                         WARN_EXPERIMENTAL__ALPHA_ASSERTIONS,
11382                         "The alpha_assertions feature is experimental");
11383
11384                 RExC_seen_zerolen++;
11385
11386                 if (! start_arg) {
11387                     goto no_colon;
11388                 }
11389
11390                 /* An empty negative lookahead assertion simply is failure */
11391                 if (paren == 'A' && RExC_parse == start_arg) {
11392                     ret=reganode(pRExC_state, OPFAIL, 0);
11393                     nextchar(pRExC_state);
11394                     return ret;
11395                 }
11396
11397                 RExC_parse = start_arg;
11398                 goto parse_rest;
11399
11400               no_colon:
11401                 vFAIL2utf8f(
11402                 "'(*%" UTF8f "' requires a terminating ':'",
11403                 UTF8fARG(UTF, verb_len, start_verb));
11404                 NOT_REACHED; /*NOTREACHED*/
11405
11406             } /* End of switch */
11407             if ( ! op ) {
11408                 RExC_parse += UTF
11409                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
11410                               : 1;
11411                 if (has_upper || verb_len == 0) {
11412                     vFAIL2utf8f(
11413                     "Unknown verb pattern '%" UTF8f "'",
11414                     UTF8fARG(UTF, verb_len, start_verb));
11415                 }
11416                 else {
11417                     vFAIL2utf8f(
11418                     "Unknown '(*...)' construct '%" UTF8f "'",
11419                     UTF8fARG(UTF, verb_len, start_verb));
11420                 }
11421             }
11422             if ( RExC_parse == start_arg ) {
11423                 start_arg = NULL;
11424             }
11425             if ( arg_required && !start_arg ) {
11426                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
11427                     verb_len, start_verb);
11428             }
11429             if (internal_argval == -1) {
11430                 ret = reganode(pRExC_state, op, 0);
11431             } else {
11432                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
11433             }
11434             RExC_seen |= REG_VERBARG_SEEN;
11435             if (start_arg) {
11436                 SV *sv = newSVpvn( start_arg,
11437                                     RExC_parse - start_arg);
11438                 ARG(REGNODE_p(ret)) = add_data( pRExC_state,
11439                                         STR_WITH_LEN("S"));
11440                 RExC_rxi->data->data[ARG(REGNODE_p(ret))]=(void*)sv;
11441                 FLAGS(REGNODE_p(ret)) = 1;
11442             } else {
11443                 FLAGS(REGNODE_p(ret)) = 0;
11444             }
11445             if ( internal_argval != -1 )
11446                 ARG2L_SET(REGNODE_p(ret), internal_argval);
11447             nextchar(pRExC_state);
11448             return ret;
11449         }
11450         else if (*RExC_parse == '?') { /* (?...) */
11451             bool is_logical = 0;
11452             const char * const seqstart = RExC_parse;
11453             const char * endptr;
11454             if (has_intervening_patws) {
11455                 RExC_parse++;
11456                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
11457             }
11458
11459             RExC_parse++;           /* past the '?' */
11460             paren = *RExC_parse;    /* might be a trailing NUL, if not
11461                                        well-formed */
11462             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11463             if (RExC_parse > RExC_end) {
11464                 paren = '\0';
11465             }
11466             ret = 0;                    /* For look-ahead/behind. */
11467             switch (paren) {
11468
11469             case 'P':   /* (?P...) variants for those used to PCRE/Python */
11470                 paren = *RExC_parse;
11471                 if ( paren == '<') {    /* (?P<...>) named capture */
11472                     RExC_parse++;
11473                     if (RExC_parse >= RExC_end) {
11474                         vFAIL("Sequence (?P<... not terminated");
11475                     }
11476                     goto named_capture;
11477                 }
11478                 else if (paren == '>') {   /* (?P>name) named recursion */
11479                     RExC_parse++;
11480                     if (RExC_parse >= RExC_end) {
11481                         vFAIL("Sequence (?P>... not terminated");
11482                     }
11483                     goto named_recursion;
11484                 }
11485                 else if (paren == '=') {   /* (?P=...)  named backref */
11486                     RExC_parse++;
11487                     return handle_named_backref(pRExC_state, flagp,
11488                                                 parse_start, ')');
11489                 }
11490                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11491                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11492                 vFAIL3("Sequence (%.*s...) not recognized",
11493                                 RExC_parse-seqstart, seqstart);
11494                 NOT_REACHED; /*NOTREACHED*/
11495             case '<':           /* (?<...) */
11496                 if (*RExC_parse == '!')
11497                     paren = ',';
11498                 else if (*RExC_parse != '=')
11499               named_capture:
11500                 {               /* (?<...>) */
11501                     char *name_start;
11502                     SV *svname;
11503                     paren= '>';
11504                 /* FALLTHROUGH */
11505             case '\'':          /* (?'...') */
11506                     name_start = RExC_parse;
11507                     svname = reg_scan_name(pRExC_state, REG_RSN_RETURN_NAME);
11508                     if (   RExC_parse == name_start
11509                         || RExC_parse >= RExC_end
11510                         || *RExC_parse != paren)
11511                     {
11512                         vFAIL2("Sequence (?%c... not terminated",
11513                             paren=='>' ? '<' : paren);
11514                     }
11515                     {
11516                         HE *he_str;
11517                         SV *sv_dat = NULL;
11518                         if (!svname) /* shouldn't happen */
11519                             Perl_croak(aTHX_
11520                                 "panic: reg_scan_name returned NULL");
11521                         if (!RExC_paren_names) {
11522                             RExC_paren_names= newHV();
11523                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
11524 #ifdef DEBUGGING
11525                             RExC_paren_name_list= newAV();
11526                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
11527 #endif
11528                         }
11529                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
11530                         if ( he_str )
11531                             sv_dat = HeVAL(he_str);
11532                         if ( ! sv_dat ) {
11533                             /* croak baby croak */
11534                             Perl_croak(aTHX_
11535                                 "panic: paren_name hash element allocation failed");
11536                         } else if ( SvPOK(sv_dat) ) {
11537                             /* (?|...) can mean we have dupes so scan to check
11538                                its already been stored. Maybe a flag indicating
11539                                we are inside such a construct would be useful,
11540                                but the arrays are likely to be quite small, so
11541                                for now we punt -- dmq */
11542                             IV count = SvIV(sv_dat);
11543                             I32 *pv = (I32*)SvPVX(sv_dat);
11544                             IV i;
11545                             for ( i = 0 ; i < count ; i++ ) {
11546                                 if ( pv[i] == RExC_npar ) {
11547                                     count = 0;
11548                                     break;
11549                                 }
11550                             }
11551                             if ( count ) {
11552                                 pv = (I32*)SvGROW(sv_dat,
11553                                                 SvCUR(sv_dat) + sizeof(I32)+1);
11554                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
11555                                 pv[count] = RExC_npar;
11556                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
11557                             }
11558                         } else {
11559                             (void)SvUPGRADE(sv_dat, SVt_PVNV);
11560                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
11561                                                                 sizeof(I32));
11562                             SvIOK_on(sv_dat);
11563                             SvIV_set(sv_dat, 1);
11564                         }
11565 #ifdef DEBUGGING
11566                         /* Yes this does cause a memory leak in debugging Perls
11567                          * */
11568                         if (!av_store(RExC_paren_name_list,
11569                                       RExC_npar, SvREFCNT_inc_NN(svname)))
11570                             SvREFCNT_dec_NN(svname);
11571 #endif
11572
11573                         /*sv_dump(sv_dat);*/
11574                     }
11575                     nextchar(pRExC_state);
11576                     paren = 1;
11577                     goto capturing_parens;
11578                 }
11579
11580                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11581                 RExC_in_lookbehind++;
11582                 RExC_parse++;
11583                 if (RExC_parse >= RExC_end) {
11584                     vFAIL("Sequence (?... not terminated");
11585                 }
11586                 RExC_seen_zerolen++;
11587                 break;
11588             case '=':           /* (?=...) */
11589                 RExC_seen_zerolen++;
11590                 RExC_in_lookahead++;
11591                 break;
11592             case '!':           /* (?!...) */
11593                 RExC_seen_zerolen++;
11594                 /* check if we're really just a "FAIL" assertion */
11595                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11596                                         FALSE /* Don't force to /x */ );
11597                 if (*RExC_parse == ')') {
11598                     ret=reganode(pRExC_state, OPFAIL, 0);
11599                     nextchar(pRExC_state);
11600                     return ret;
11601                 }
11602                 break;
11603             case '|':           /* (?|...) */
11604                 /* branch reset, behave like a (?:...) except that
11605                    buffers in alternations share the same numbers */
11606                 paren = ':';
11607                 after_freeze = freeze_paren = RExC_npar;
11608
11609                 /* XXX This construct currently requires an extra pass.
11610                  * Investigation would be required to see if that could be
11611                  * changed */
11612                 REQUIRE_PARENS_PASS;
11613                 break;
11614             case ':':           /* (?:...) */
11615             case '>':           /* (?>...) */
11616                 break;
11617             case '$':           /* (?$...) */
11618             case '@':           /* (?@...) */
11619                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
11620                 break;
11621             case '0' :           /* (?0) */
11622             case 'R' :           /* (?R) */
11623                 if (RExC_parse == RExC_end || *RExC_parse != ')')
11624                     FAIL("Sequence (?R) not terminated");
11625                 num = 0;
11626                 RExC_seen |= REG_RECURSE_SEEN;
11627
11628                 /* XXX These constructs currently require an extra pass.
11629                  * It probably could be changed */
11630                 REQUIRE_PARENS_PASS;
11631
11632                 *flagp |= POSTPONED;
11633                 goto gen_recurse_regop;
11634                 /*notreached*/
11635             /* named and numeric backreferences */
11636             case '&':            /* (?&NAME) */
11637                 parse_start = RExC_parse - 1;
11638               named_recursion:
11639                 {
11640                     SV *sv_dat = reg_scan_name(pRExC_state,
11641                                                REG_RSN_RETURN_DATA);
11642                    num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
11643                 }
11644                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
11645                     vFAIL("Sequence (?&... not terminated");
11646                 goto gen_recurse_regop;
11647                 /* NOTREACHED */
11648             case '+':
11649                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11650                     RExC_parse++;
11651                     vFAIL("Illegal pattern");
11652                 }
11653                 goto parse_recursion;
11654                 /* NOTREACHED*/
11655             case '-': /* (?-1) */
11656                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11657                     RExC_parse--; /* rewind to let it be handled later */
11658                     goto parse_flags;
11659                 }
11660                 /* FALLTHROUGH */
11661             case '1': case '2': case '3': case '4': /* (?1) */
11662             case '5': case '6': case '7': case '8': case '9':
11663                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
11664               parse_recursion:
11665                 {
11666                     bool is_neg = FALSE;
11667                     UV unum;
11668                     parse_start = RExC_parse - 1; /* MJD */
11669                     if (*RExC_parse == '-') {
11670                         RExC_parse++;
11671                         is_neg = TRUE;
11672                     }
11673                     endptr = RExC_end;
11674                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11675                         && unum <= I32_MAX
11676                     ) {
11677                         num = (I32)unum;
11678                         RExC_parse = (char*)endptr;
11679                     } else
11680                         num = I32_MAX;
11681                     if (is_neg) {
11682                         /* Some limit for num? */
11683                         num = -num;
11684                     }
11685                 }
11686                 if (*RExC_parse!=')')
11687                     vFAIL("Expecting close bracket");
11688
11689               gen_recurse_regop:
11690                 if ( paren == '-' ) {
11691                     /*
11692                     Diagram of capture buffer numbering.
11693                     Top line is the normal capture buffer numbers
11694                     Bottom line is the negative indexing as from
11695                     the X (the (?-2))
11696
11697                     +   1 2    3 4 5 X          6 7
11698                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11699                     -   5 4    3 2 1 X          x x
11700
11701                     */
11702                     num = RExC_npar + num;
11703                     if (num < 1)  {
11704
11705                         /* It might be a forward reference; we can't fail until
11706                          * we know, by completing the parse to get all the
11707                          * groups, and then reparsing */
11708                         if (ALL_PARENS_COUNTED)  {
11709                             RExC_parse++;
11710                             vFAIL("Reference to nonexistent group");
11711                         }
11712                         else {
11713                             REQUIRE_PARENS_PASS;
11714                         }
11715                     }
11716                 } else if ( paren == '+' ) {
11717                     num = RExC_npar + num - 1;
11718                 }
11719                 /* We keep track how many GOSUB items we have produced.
11720                    To start off the ARG2L() of the GOSUB holds its "id",
11721                    which is used later in conjunction with RExC_recurse
11722                    to calculate the offset we need to jump for the GOSUB,
11723                    which it will store in the final representation.
11724                    We have to defer the actual calculation until much later
11725                    as the regop may move.
11726                  */
11727
11728                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11729                 if (num >= RExC_npar) {
11730
11731                     /* It might be a forward reference; we can't fail until we
11732                      * know, by completing the parse to get all the groups, and
11733                      * then reparsing */
11734                     if (ALL_PARENS_COUNTED)  {
11735                         if (num >= RExC_total_parens) {
11736                             RExC_parse++;
11737                             vFAIL("Reference to nonexistent group");
11738                         }
11739                     }
11740                     else {
11741                         REQUIRE_PARENS_PASS;
11742                     }
11743                 }
11744                 RExC_recurse_count++;
11745                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11746                     "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11747                             22, "|    |", (int)(depth * 2 + 1), "",
11748                             (UV)ARG(REGNODE_p(ret)),
11749                             (IV)ARG2L(REGNODE_p(ret))));
11750                 RExC_seen |= REG_RECURSE_SEEN;
11751
11752                 Set_Node_Length(REGNODE_p(ret),
11753                                 1 + regarglen[OP(REGNODE_p(ret))]); /* MJD */
11754                 Set_Node_Offset(REGNODE_p(ret), parse_start); /* MJD */
11755
11756                 *flagp |= POSTPONED;
11757                 assert(*RExC_parse == ')');
11758                 nextchar(pRExC_state);
11759                 return ret;
11760
11761             /* NOTREACHED */
11762
11763             case '?':           /* (??...) */
11764                 is_logical = 1;
11765                 if (*RExC_parse != '{') {
11766                     RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11767                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11768                     vFAIL2utf8f(
11769                         "Sequence (%" UTF8f "...) not recognized",
11770                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11771                     NOT_REACHED; /*NOTREACHED*/
11772                 }
11773                 *flagp |= POSTPONED;
11774                 paren = '{';
11775                 RExC_parse++;
11776                 /* FALLTHROUGH */
11777             case '{':           /* (?{...}) */
11778             {
11779                 U32 n = 0;
11780                 struct reg_code_block *cb;
11781                 OP * o;
11782
11783                 RExC_seen_zerolen++;
11784
11785                 if (   !pRExC_state->code_blocks
11786                     || pRExC_state->code_index
11787                                         >= pRExC_state->code_blocks->count
11788                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11789                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11790                             - RExC_start)
11791                 ) {
11792                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11793                         FAIL("panic: Sequence (?{...}): no code block found\n");
11794                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11795                 }
11796                 /* this is a pre-compiled code block (?{...}) */
11797                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11798                 RExC_parse = RExC_start + cb->end;
11799                 o = cb->block;
11800                 if (cb->src_regex) {
11801                     n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11802                     RExC_rxi->data->data[n] =
11803                         (void*)SvREFCNT_inc((SV*)cb->src_regex);
11804                     RExC_rxi->data->data[n+1] = (void*)o;
11805                 }
11806                 else {
11807                     n = add_data(pRExC_state,
11808                             (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11809                     RExC_rxi->data->data[n] = (void*)o;
11810                 }
11811                 pRExC_state->code_index++;
11812                 nextchar(pRExC_state);
11813
11814                 if (is_logical) {
11815                     regnode_offset eval;
11816                     ret = reg_node(pRExC_state, LOGICAL);
11817
11818                     eval = reg2Lanode(pRExC_state, EVAL,
11819                                        n,
11820
11821                                        /* for later propagation into (??{})
11822                                         * return value */
11823                                        RExC_flags & RXf_PMf_COMPILETIME
11824                                       );
11825                     FLAGS(REGNODE_p(ret)) = 2;
11826                     if (! REGTAIL(pRExC_state, ret, eval)) {
11827                         REQUIRE_BRANCHJ(flagp, 0);
11828                     }
11829                     /* deal with the length of this later - MJD */
11830                     return ret;
11831                 }
11832                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11833                 Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1);
11834                 Set_Node_Offset(REGNODE_p(ret), parse_start);
11835                 return ret;
11836             }
11837             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11838             {
11839                 int is_define= 0;
11840                 const int DEFINE_len = sizeof("DEFINE") - 1;
11841                 if (    RExC_parse < RExC_end - 1
11842                     && (   (       RExC_parse[0] == '?'        /* (?(?...)) */
11843                             && (   RExC_parse[1] == '='
11844                                 || RExC_parse[1] == '!'
11845                                 || RExC_parse[1] == '<'
11846                                 || RExC_parse[1] == '{'))
11847                         || (       RExC_parse[0] == '*'        /* (?(*...)) */
11848                             && (   memBEGINs(RExC_parse + 1,
11849                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11850                                          "pla:")
11851                                 || memBEGINs(RExC_parse + 1,
11852                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11853                                          "plb:")
11854                                 || memBEGINs(RExC_parse + 1,
11855                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11856                                          "nla:")
11857                                 || memBEGINs(RExC_parse + 1,
11858                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11859                                          "nlb:")
11860                                 || memBEGINs(RExC_parse + 1,
11861                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11862                                          "positive_lookahead:")
11863                                 || memBEGINs(RExC_parse + 1,
11864                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11865                                          "positive_lookbehind:")
11866                                 || memBEGINs(RExC_parse + 1,
11867                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11868                                          "negative_lookahead:")
11869                                 || memBEGINs(RExC_parse + 1,
11870                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11871                                          "negative_lookbehind:"))))
11872                 ) { /* Lookahead or eval. */
11873                     I32 flag;
11874                     regnode_offset tail;
11875
11876                     ret = reg_node(pRExC_state, LOGICAL);
11877                     FLAGS(REGNODE_p(ret)) = 1;
11878
11879                     tail = reg(pRExC_state, 1, &flag, depth+1);
11880                     RETURN_FAIL_ON_RESTART(flag, flagp);
11881                     if (! REGTAIL(pRExC_state, ret, tail)) {
11882                         REQUIRE_BRANCHJ(flagp, 0);
11883                     }
11884                     goto insert_if;
11885                 }
11886                 else if (   RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11887                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11888                 {
11889                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11890                     char *name_start= RExC_parse++;
11891                     U32 num = 0;
11892                     SV *sv_dat=reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11893                     if (   RExC_parse == name_start
11894                         || RExC_parse >= RExC_end
11895                         || *RExC_parse != ch)
11896                     {
11897                         vFAIL2("Sequence (?(%c... not terminated",
11898                             (ch == '>' ? '<' : ch));
11899                     }
11900                     RExC_parse++;
11901                     if (sv_dat) {
11902                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11903                         RExC_rxi->data->data[num]=(void*)sv_dat;
11904                         SvREFCNT_inc_simple_void_NN(sv_dat);
11905                     }
11906                     ret = reganode(pRExC_state, GROUPPN, num);
11907                     goto insert_if_check_paren;
11908                 }
11909                 else if (memBEGINs(RExC_parse,
11910                                    (STRLEN) (RExC_end - RExC_parse),
11911                                    "DEFINE"))
11912                 {
11913                     ret = reganode(pRExC_state, DEFINEP, 0);
11914                     RExC_parse += DEFINE_len;
11915                     is_define = 1;
11916                     goto insert_if_check_paren;
11917                 }
11918                 else if (RExC_parse[0] == 'R') {
11919                     RExC_parse++;
11920                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11921                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11922                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11923                      */
11924                     parno = 0;
11925                     if (RExC_parse[0] == '0') {
11926                         parno = 1;
11927                         RExC_parse++;
11928                     }
11929                     else if (inRANGE(RExC_parse[0], '1', '9')) {
11930                         UV uv;
11931                         endptr = RExC_end;
11932                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11933                             && uv <= I32_MAX
11934                         ) {
11935                             parno = (I32)uv + 1;
11936                             RExC_parse = (char*)endptr;
11937                         }
11938                         /* else "Switch condition not recognized" below */
11939                     } else if (RExC_parse[0] == '&') {
11940                         SV *sv_dat;
11941                         RExC_parse++;
11942                         sv_dat = reg_scan_name(pRExC_state,
11943                                                REG_RSN_RETURN_DATA);
11944                         if (sv_dat)
11945                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11946                     }
11947                     ret = reganode(pRExC_state, INSUBP, parno);
11948                     goto insert_if_check_paren;
11949                 }
11950                 else if (inRANGE(RExC_parse[0], '1', '9')) {
11951                     /* (?(1)...) */
11952                     char c;
11953                     UV uv;
11954                     endptr = RExC_end;
11955                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11956                         && uv <= I32_MAX
11957                     ) {
11958                         parno = (I32)uv;
11959                         RExC_parse = (char*)endptr;
11960                     }
11961                     else {
11962                         vFAIL("panic: grok_atoUV returned FALSE");
11963                     }
11964                     ret = reganode(pRExC_state, GROUPP, parno);
11965
11966                  insert_if_check_paren:
11967                     if (UCHARAT(RExC_parse) != ')') {
11968                         RExC_parse += UTF
11969                                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
11970                                       : 1;
11971                         vFAIL("Switch condition not recognized");
11972                     }
11973                     nextchar(pRExC_state);
11974                   insert_if:
11975                     if (! REGTAIL(pRExC_state, ret, reganode(pRExC_state,
11976                                                              IFTHEN, 0)))
11977                     {
11978                         REQUIRE_BRANCHJ(flagp, 0);
11979                     }
11980                     br = regbranch(pRExC_state, &flags, 1, depth+1);
11981                     if (br == 0) {
11982                         RETURN_FAIL_ON_RESTART(flags,flagp);
11983                         FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
11984                               (UV) flags);
11985                     } else
11986                     if (! REGTAIL(pRExC_state, br, reganode(pRExC_state,
11987                                                              LONGJMP, 0)))
11988                     {
11989                         REQUIRE_BRANCHJ(flagp, 0);
11990                     }
11991                     c = UCHARAT(RExC_parse);
11992                     nextchar(pRExC_state);
11993                     if (flags&HASWIDTH)
11994                         *flagp |= HASWIDTH;
11995                     if (c == '|') {
11996                         if (is_define)
11997                             vFAIL("(?(DEFINE)....) does not allow branches");
11998
11999                         /* Fake one for optimizer.  */
12000                         lastbr = reganode(pRExC_state, IFTHEN, 0);
12001
12002                         if (!regbranch(pRExC_state, &flags, 1, depth+1)) {
12003                             RETURN_FAIL_ON_RESTART(flags, flagp);
12004                             FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
12005                                   (UV) flags);
12006                         }
12007                         if (! REGTAIL(pRExC_state, ret, lastbr)) {
12008                             REQUIRE_BRANCHJ(flagp, 0);
12009                         }
12010                         if (flags&HASWIDTH)
12011                             *flagp |= HASWIDTH;
12012                         c = UCHARAT(RExC_parse);
12013                         nextchar(pRExC_state);
12014                     }
12015                     else
12016                         lastbr = 0;
12017                     if (c != ')') {
12018                         if (RExC_parse >= RExC_end)
12019                             vFAIL("Switch (?(condition)... not terminated");
12020                         else
12021                             vFAIL("Switch (?(condition)... contains too many branches");
12022                     }
12023                     ender = reg_node(pRExC_state, TAIL);
12024                     if (! REGTAIL(pRExC_state, br, ender)) {
12025                         REQUIRE_BRANCHJ(flagp, 0);
12026                     }
12027                     if (lastbr) {
12028                         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12029                             REQUIRE_BRANCHJ(flagp, 0);
12030                         }
12031                         if (! REGTAIL(pRExC_state,
12032                                       REGNODE_OFFSET(
12033                                                  NEXTOPER(
12034                                                  NEXTOPER(REGNODE_p(lastbr)))),
12035                                       ender))
12036                         {
12037                             REQUIRE_BRANCHJ(flagp, 0);
12038                         }
12039                     }
12040                     else
12041                         if (! REGTAIL(pRExC_state, ret, ender)) {
12042                             REQUIRE_BRANCHJ(flagp, 0);
12043                         }
12044 #if 0  /* Removing this doesn't cause failures in the test suite -- khw */
12045                     RExC_size++; /* XXX WHY do we need this?!!
12046                                     For large programs it seems to be required
12047                                     but I can't figure out why. -- dmq*/
12048 #endif
12049                     return ret;
12050                 }
12051                 RExC_parse += UTF
12052                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
12053                               : 1;
12054                 vFAIL("Unknown switch condition (?(...))");
12055             }
12056             case '[':           /* (?[ ... ]) */
12057                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
12058                                          oregcomp_parse);
12059             case 0: /* A NUL */
12060                 RExC_parse--; /* for vFAIL to print correctly */
12061                 vFAIL("Sequence (? incomplete");
12062                 break;
12063
12064             case ')':
12065                 if (RExC_strict) {  /* [perl #132851] */
12066                     ckWARNreg(RExC_parse, "Empty (?) without any modifiers");
12067                 }
12068                 /* FALLTHROUGH */
12069             default: /* e.g., (?i) */
12070                 RExC_parse = (char *) seqstart + 1;
12071               parse_flags:
12072                 parse_lparen_question_flags(pRExC_state);
12073                 if (UCHARAT(RExC_parse) != ':') {
12074                     if (RExC_parse < RExC_end)
12075                         nextchar(pRExC_state);
12076                     *flagp = TRYAGAIN;
12077                     return 0;
12078                 }
12079                 paren = ':';
12080                 nextchar(pRExC_state);
12081                 ret = 0;
12082                 goto parse_rest;
12083             } /* end switch */
12084         }
12085         else {
12086             if (*RExC_parse == '{') {
12087                 ckWARNregdep(RExC_parse + 1,
12088                             "Unescaped left brace in regex is "
12089                             "deprecated here (and will be fatal "
12090                             "in Perl 5.32), passed through");
12091             }
12092             /* Not bothering to indent here, as the above 'else' is temporary
12093              * */
12094         if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
12095           capturing_parens:
12096             parno = RExC_npar;
12097             RExC_npar++;
12098             if (! ALL_PARENS_COUNTED) {
12099                 /* If we are in our first pass through (and maybe only pass),
12100                  * we  need to allocate memory for the capturing parentheses
12101                  * data structures.
12102                  */
12103
12104                 if (!RExC_parens_buf_size) {
12105                     /* first guess at number of parens we might encounter */
12106                     RExC_parens_buf_size = 10;
12107
12108                     /* setup RExC_open_parens, which holds the address of each
12109                      * OPEN tag, and to make things simpler for the 0 index the
12110                      * start of the program - this is used later for offsets */
12111                     Newxz(RExC_open_parens, RExC_parens_buf_size,
12112                             regnode_offset);
12113                     RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
12114
12115                     /* setup RExC_close_parens, which holds the address of each
12116                      * CLOSE tag, and to make things simpler for the 0 index
12117                      * the end of the program - this is used later for offsets
12118                      * */
12119                     Newxz(RExC_close_parens, RExC_parens_buf_size,
12120                             regnode_offset);
12121                     /* we dont know where end op starts yet, so we dont need to
12122                      * set RExC_close_parens[0] like we do RExC_open_parens[0]
12123                      * above */
12124                 }
12125                 else if (RExC_npar > RExC_parens_buf_size) {
12126                     I32 old_size = RExC_parens_buf_size;
12127
12128                     RExC_parens_buf_size *= 2;
12129
12130                     Renew(RExC_open_parens, RExC_parens_buf_size,
12131                             regnode_offset);
12132                     Zero(RExC_open_parens + old_size,
12133                             RExC_parens_buf_size - old_size, regnode_offset);
12134
12135                     Renew(RExC_close_parens, RExC_parens_buf_size,
12136                             regnode_offset);
12137                     Zero(RExC_close_parens + old_size,
12138                             RExC_parens_buf_size - old_size, regnode_offset);
12139                 }
12140             }
12141
12142             ret = reganode(pRExC_state, OPEN, parno);
12143             if (!RExC_nestroot)
12144                 RExC_nestroot = parno;
12145             if (RExC_open_parens && !RExC_open_parens[parno])
12146             {
12147                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12148                     "%*s%*s Setting open paren #%" IVdf " to %d\n",
12149                     22, "|    |", (int)(depth * 2 + 1), "",
12150                     (IV)parno, ret));
12151                 RExC_open_parens[parno]= ret;
12152             }
12153
12154             Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
12155             Set_Node_Offset(REGNODE_p(ret), RExC_parse); /* MJD */
12156             is_open = 1;
12157         } else {
12158             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
12159             paren = ':';
12160             ret = 0;
12161         }
12162         }
12163     }
12164     else                        /* ! paren */
12165         ret = 0;
12166
12167    parse_rest:
12168     /* Pick up the branches, linking them together. */
12169     parse_start = RExC_parse;   /* MJD */
12170     br = regbranch(pRExC_state, &flags, 1, depth+1);
12171
12172     /*     branch_len = (paren != 0); */
12173
12174     if (br == 0) {
12175         RETURN_FAIL_ON_RESTART(flags, flagp);
12176         FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12177     }
12178     if (*RExC_parse == '|') {
12179         if (RExC_use_BRANCHJ) {
12180             reginsert(pRExC_state, BRANCHJ, br, depth+1);
12181         }
12182         else {                  /* MJD */
12183             reginsert(pRExC_state, BRANCH, br, depth+1);
12184             Set_Node_Length(REGNODE_p(br), paren != 0);
12185             Set_Node_Offset_To_R(br, parse_start-RExC_start);
12186         }
12187         have_branch = 1;
12188     }
12189     else if (paren == ':') {
12190         *flagp |= flags&SIMPLE;
12191     }
12192     if (is_open) {                              /* Starts with OPEN. */
12193         if (! REGTAIL(pRExC_state, ret, br)) {  /* OPEN -> first. */
12194             REQUIRE_BRANCHJ(flagp, 0);
12195         }
12196     }
12197     else if (paren != '?')              /* Not Conditional */
12198         ret = br;
12199     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
12200     lastbr = br;
12201     while (*RExC_parse == '|') {
12202         if (RExC_use_BRANCHJ) {
12203             bool shut_gcc_up;
12204
12205             ender = reganode(pRExC_state, LONGJMP, 0);
12206
12207             /* Append to the previous. */
12208             shut_gcc_up = REGTAIL(pRExC_state,
12209                          REGNODE_OFFSET(NEXTOPER(NEXTOPER(REGNODE_p(lastbr)))),
12210                          ender);
12211             PERL_UNUSED_VAR(shut_gcc_up);
12212         }
12213         nextchar(pRExC_state);
12214         if (freeze_paren) {
12215             if (RExC_npar > after_freeze)
12216                 after_freeze = RExC_npar;
12217             RExC_npar = freeze_paren;
12218         }
12219         br = regbranch(pRExC_state, &flags, 0, depth+1);
12220
12221         if (br == 0) {
12222             RETURN_FAIL_ON_RESTART(flags, flagp);
12223             FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12224         }
12225         if (!  REGTAIL(pRExC_state, lastbr, br)) {  /* BRANCH -> BRANCH. */
12226             REQUIRE_BRANCHJ(flagp, 0);
12227         }
12228         lastbr = br;
12229         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
12230     }
12231
12232     if (have_branch || paren != ':') {
12233         regnode * br;
12234
12235         /* Make a closing node, and hook it on the end. */
12236         switch (paren) {
12237         case ':':
12238             ender = reg_node(pRExC_state, TAIL);
12239             break;
12240         case 1: case 2:
12241             ender = reganode(pRExC_state, CLOSE, parno);
12242             if ( RExC_close_parens ) {
12243                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12244                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
12245                         22, "|    |", (int)(depth * 2 + 1), "",
12246                         (IV)parno, ender));
12247                 RExC_close_parens[parno]= ender;
12248                 if (RExC_nestroot == parno)
12249                     RExC_nestroot = 0;
12250             }
12251             Set_Node_Offset(REGNODE_p(ender), RExC_parse+1); /* MJD */
12252             Set_Node_Length(REGNODE_p(ender), 1); /* MJD */
12253             break;
12254         case 's':
12255             ender = reg_node(pRExC_state, SRCLOSE);
12256             RExC_in_script_run = 0;
12257             break;
12258         case '<':
12259         case 'a':
12260         case 'A':
12261         case 'b':
12262         case 'B':
12263         case ',':
12264         case '=':
12265         case '!':
12266             *flagp &= ~HASWIDTH;
12267             /* FALLTHROUGH */
12268         case 't':   /* aTomic */
12269         case '>':
12270             ender = reg_node(pRExC_state, SUCCEED);
12271             break;
12272         case 0:
12273             ender = reg_node(pRExC_state, END);
12274             assert(!RExC_end_op); /* there can only be one! */
12275             RExC_end_op = REGNODE_p(ender);
12276             if (RExC_close_parens) {
12277                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12278                     "%*s%*s Setting close paren #0 (END) to %d\n",
12279                     22, "|    |", (int)(depth * 2 + 1), "",
12280                     ender));
12281
12282                 RExC_close_parens[0]= ender;
12283             }
12284             break;
12285         }
12286         DEBUG_PARSE_r(
12287             DEBUG_PARSE_MSG("lsbr");
12288             regprop(RExC_rx, RExC_mysv1, REGNODE_p(lastbr), NULL, pRExC_state);
12289             regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender), NULL, pRExC_state);
12290             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12291                           SvPV_nolen_const(RExC_mysv1),
12292                           (IV)lastbr,
12293                           SvPV_nolen_const(RExC_mysv2),
12294                           (IV)ender,
12295                           (IV)(ender - lastbr)
12296             );
12297         );
12298         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12299             REQUIRE_BRANCHJ(flagp, 0);
12300         }
12301
12302         if (have_branch) {
12303             char is_nothing= 1;
12304             if (depth==1)
12305                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
12306
12307             /* Hook the tails of the branches to the closing node. */
12308             for (br = REGNODE_p(ret); br; br = regnext(br)) {
12309                 const U8 op = PL_regkind[OP(br)];
12310                 if (op == BRANCH) {
12311                     if (! REGTAIL_STUDY(pRExC_state,
12312                                         REGNODE_OFFSET(NEXTOPER(br)),
12313                                         ender))
12314                     {
12315                         REQUIRE_BRANCHJ(flagp, 0);
12316                     }
12317                     if ( OP(NEXTOPER(br)) != NOTHING
12318                          || regnext(NEXTOPER(br)) != REGNODE_p(ender))
12319                         is_nothing= 0;
12320                 }
12321                 else if (op == BRANCHJ) {
12322                     bool shut_gcc_up = REGTAIL_STUDY(pRExC_state,
12323                                         REGNODE_OFFSET(NEXTOPER(NEXTOPER(br))),
12324                                         ender);
12325                     PERL_UNUSED_VAR(shut_gcc_up);
12326                     /* for now we always disable this optimisation * /
12327                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
12328                          || regnext(NEXTOPER(NEXTOPER(br))) != REGNODE_p(ender))
12329                     */
12330                         is_nothing= 0;
12331                 }
12332             }
12333             if (is_nothing) {
12334                 regnode * ret_as_regnode = REGNODE_p(ret);
12335                 br= PL_regkind[OP(ret_as_regnode)] != BRANCH
12336                                ? regnext(ret_as_regnode)
12337                                : ret_as_regnode;
12338                 DEBUG_PARSE_r(
12339                     DEBUG_PARSE_MSG("NADA");
12340                     regprop(RExC_rx, RExC_mysv1, ret_as_regnode,
12341                                      NULL, pRExC_state);
12342                     regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender),
12343                                      NULL, pRExC_state);
12344                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12345                                   SvPV_nolen_const(RExC_mysv1),
12346                                   (IV)REG_NODE_NUM(ret_as_regnode),
12347                                   SvPV_nolen_const(RExC_mysv2),
12348                                   (IV)ender,
12349                                   (IV)(ender - ret)
12350                     );
12351                 );
12352                 OP(br)= NOTHING;
12353                 if (OP(REGNODE_p(ender)) == TAIL) {
12354                     NEXT_OFF(br)= 0;
12355                     RExC_emit= REGNODE_OFFSET(br) + 1;
12356                 } else {
12357                     regnode *opt;
12358                     for ( opt= br + 1; opt < REGNODE_p(ender) ; opt++ )
12359                         OP(opt)= OPTIMIZED;
12360                     NEXT_OFF(br)= REGNODE_p(ender) - br;
12361                 }
12362             }
12363         }
12364     }
12365
12366     {
12367         const char *p;
12368          /* Even/odd or x=don't care: 010101x10x */
12369         static const char parens[] = "=!aA<,>Bbt";
12370          /* flag below is set to 0 up through 'A'; 1 for larger */
12371
12372         if (paren && (p = strchr(parens, paren))) {
12373             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
12374             int flag = (p - parens) > 3;
12375
12376             if (paren == '>' || paren == 't') {
12377                 node = SUSPEND, flag = 0;
12378             }
12379
12380             reginsert(pRExC_state, node, ret, depth+1);
12381             Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12382             Set_Node_Offset(REGNODE_p(ret), parse_start + 1);
12383             FLAGS(REGNODE_p(ret)) = flag;
12384             if (! REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL)))
12385             {
12386                 REQUIRE_BRANCHJ(flagp, 0);
12387             }
12388         }
12389     }
12390
12391     /* Check for proper termination. */
12392     if (paren) {
12393         /* restore original flags, but keep (?p) and, if we've encountered
12394          * something in the parse that changes /d rules into /u, keep the /u */
12395         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
12396         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
12397             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
12398         }
12399         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
12400             RExC_parse = oregcomp_parse;
12401             vFAIL("Unmatched (");
12402         }
12403         nextchar(pRExC_state);
12404     }
12405     else if (!paren && RExC_parse < RExC_end) {
12406         if (*RExC_parse == ')') {
12407             RExC_parse++;
12408             vFAIL("Unmatched )");
12409         }
12410         else
12411             FAIL("Junk on end of regexp");      /* "Can't happen". */
12412         NOT_REACHED; /* NOTREACHED */
12413     }
12414
12415     if (RExC_in_lookbehind) {
12416         RExC_in_lookbehind--;
12417     }
12418     if (RExC_in_lookahead) {
12419         RExC_in_lookahead--;
12420     }
12421     if (after_freeze > RExC_npar)
12422         RExC_npar = after_freeze;
12423     return(ret);
12424 }
12425
12426 /*
12427  - regbranch - one alternative of an | operator
12428  *
12429  * Implements the concatenation operator.
12430  *
12431  * On success, returns the offset at which any next node should be placed into
12432  * the regex engine program being compiled.
12433  *
12434  * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
12435  * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
12436  * UTF-8
12437  */
12438 STATIC regnode_offset
12439 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
12440 {
12441     regnode_offset ret;
12442     regnode_offset chain = 0;
12443     regnode_offset latest;
12444     I32 flags = 0, c = 0;
12445     GET_RE_DEBUG_FLAGS_DECL;
12446
12447     PERL_ARGS_ASSERT_REGBRANCH;
12448
12449     DEBUG_PARSE("brnc");
12450
12451     if (first)
12452         ret = 0;
12453     else {
12454         if (RExC_use_BRANCHJ)
12455             ret = reganode(pRExC_state, BRANCHJ, 0);
12456         else {
12457             ret = reg_node(pRExC_state, BRANCH);
12458             Set_Node_Length(REGNODE_p(ret), 1);
12459         }
12460     }
12461
12462     *flagp = WORST;                     /* Tentatively. */
12463
12464     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
12465                             FALSE /* Don't force to /x */ );
12466     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
12467         flags &= ~TRYAGAIN;
12468         latest = regpiece(pRExC_state, &flags, depth+1);
12469         if (latest == 0) {
12470             if (flags & TRYAGAIN)
12471                 continue;
12472             RETURN_FAIL_ON_RESTART(flags, flagp);
12473             FAIL2("panic: regpiece returned failure, flags=%#" UVxf, (UV) flags);
12474         }
12475         else if (ret == 0)
12476             ret = latest;
12477         *flagp |= flags&(HASWIDTH|POSTPONED);
12478         if (chain == 0)         /* First piece. */
12479             *flagp |= flags&SPSTART;
12480         else {
12481             /* FIXME adding one for every branch after the first is probably
12482              * excessive now we have TRIE support. (hv) */
12483             MARK_NAUGHTY(1);
12484             if (! REGTAIL(pRExC_state, chain, latest)) {
12485                 /* XXX We could just redo this branch, but figuring out what
12486                  * bookkeeping needs to be reset is a pain, and it's likely
12487                  * that other branches that goto END will also be too large */
12488                 REQUIRE_BRANCHJ(flagp, 0);
12489             }
12490         }
12491         chain = latest;
12492         c++;
12493     }
12494     if (chain == 0) {   /* Loop ran zero times. */
12495         chain = reg_node(pRExC_state, NOTHING);
12496         if (ret == 0)
12497             ret = chain;
12498     }
12499     if (c == 1) {
12500         *flagp |= flags&SIMPLE;
12501     }
12502
12503     return ret;
12504 }
12505
12506 /*
12507  - regpiece - something followed by possible quantifier * + ? {n,m}
12508  *
12509  * Note that the branching code sequences used for ? and the general cases
12510  * of * and + are somewhat optimized:  they use the same NOTHING node as
12511  * both the endmarker for their branch list and the body of the last branch.
12512  * It might seem that this node could be dispensed with entirely, but the
12513  * endmarker role is not redundant.
12514  *
12515  * On success, returns the offset at which any next node should be placed into
12516  * the regex engine program being compiled.
12517  *
12518  * Returns 0 otherwise, with *flagp set to indicate why:
12519  *  TRYAGAIN        if regatom() returns 0 with TRYAGAIN.
12520  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
12521  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
12522  */
12523 STATIC regnode_offset
12524 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12525 {
12526     regnode_offset ret;
12527     char op;
12528     char *next;
12529     I32 flags;
12530     const char * const origparse = RExC_parse;
12531     I32 min;
12532     I32 max = REG_INFTY;
12533 #ifdef RE_TRACK_PATTERN_OFFSETS
12534     char *parse_start;
12535 #endif
12536     const char *maxpos = NULL;
12537     UV uv;
12538
12539     /* Save the original in case we change the emitted regop to a FAIL. */
12540     const regnode_offset orig_emit = RExC_emit;
12541
12542     GET_RE_DEBUG_FLAGS_DECL;
12543
12544     PERL_ARGS_ASSERT_REGPIECE;
12545
12546     DEBUG_PARSE("piec");
12547
12548     ret = regatom(pRExC_state, &flags, depth+1);
12549     if (ret == 0) {
12550         RETURN_FAIL_ON_RESTART_OR_FLAGS(flags, flagp, TRYAGAIN);
12551         FAIL2("panic: regatom returned failure, flags=%#" UVxf, (UV) flags);
12552     }
12553
12554     op = *RExC_parse;
12555
12556     if (op == '{' && regcurly(RExC_parse)) {
12557         maxpos = NULL;
12558 #ifdef RE_TRACK_PATTERN_OFFSETS
12559         parse_start = RExC_parse; /* MJD */
12560 #endif
12561         next = RExC_parse + 1;
12562         while (isDIGIT(*next) || *next == ',') {
12563             if (*next == ',') {
12564                 if (maxpos)
12565                     break;
12566                 else
12567                     maxpos = next;
12568             }
12569             next++;
12570         }
12571         if (*next == '}') {             /* got one */
12572             const char* endptr;
12573             if (!maxpos)
12574                 maxpos = next;
12575             RExC_parse++;
12576             if (isDIGIT(*RExC_parse)) {
12577                 endptr = RExC_end;
12578                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
12579                     vFAIL("Invalid quantifier in {,}");
12580                 if (uv >= REG_INFTY)
12581                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12582                 min = (I32)uv;
12583             } else {
12584                 min = 0;
12585             }
12586             if (*maxpos == ',')
12587                 maxpos++;
12588             else
12589                 maxpos = RExC_parse;
12590             if (isDIGIT(*maxpos)) {
12591                 endptr = RExC_end;
12592                 if (!grok_atoUV(maxpos, &uv, &endptr))
12593                     vFAIL("Invalid quantifier in {,}");
12594                 if (uv >= REG_INFTY)
12595                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12596                 max = (I32)uv;
12597             } else {
12598                 max = REG_INFTY;                /* meaning "infinity" */
12599             }
12600             RExC_parse = next;
12601             nextchar(pRExC_state);
12602             if (max < min) {    /* If can't match, warn and optimize to fail
12603                                    unconditionally */
12604                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
12605                 ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
12606                 NEXT_OFF(REGNODE_p(orig_emit)) =
12607                                     regarglen[OPFAIL] + NODE_STEP_REGNODE;
12608                 return ret;
12609             }
12610             else if (min == max && *RExC_parse == '?')
12611             {
12612                 ckWARN2reg(RExC_parse + 1,
12613                            "Useless use of greediness modifier '%c'",
12614                            *RExC_parse);
12615             }
12616
12617           do_curly:
12618             if ((flags&SIMPLE)) {
12619                 if (min == 0 && max == REG_INFTY) {
12620                     reginsert(pRExC_state, STAR, ret, depth+1);
12621                     MARK_NAUGHTY(4);
12622                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12623                     goto nest_check;
12624                 }
12625                 if (min == 1 && max == REG_INFTY) {
12626                     reginsert(pRExC_state, PLUS, ret, depth+1);
12627                     MARK_NAUGHTY(3);
12628                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12629                     goto nest_check;
12630                 }
12631                 MARK_NAUGHTY_EXP(2, 2);
12632                 reginsert(pRExC_state, CURLY, ret, depth+1);
12633                 Set_Node_Offset(REGNODE_p(ret), parse_start+1); /* MJD */
12634                 Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12635             }
12636             else {
12637                 const regnode_offset w = reg_node(pRExC_state, WHILEM);
12638
12639                 FLAGS(REGNODE_p(w)) = 0;
12640                 if (!  REGTAIL(pRExC_state, ret, w)) {
12641                     REQUIRE_BRANCHJ(flagp, 0);
12642                 }
12643                 if (RExC_use_BRANCHJ) {
12644                     reginsert(pRExC_state, LONGJMP, ret, depth+1);
12645                     reginsert(pRExC_state, NOTHING, ret, depth+1);
12646                     NEXT_OFF(REGNODE_p(ret)) = 3;       /* Go over LONGJMP. */
12647                 }
12648                 reginsert(pRExC_state, CURLYX, ret, depth+1);
12649                                 /* MJD hk */
12650                 Set_Node_Offset(REGNODE_p(ret), parse_start+1);
12651                 Set_Node_Length(REGNODE_p(ret),
12652                                 op == '{' ? (RExC_parse - parse_start) : 1);
12653
12654                 if (RExC_use_BRANCHJ)
12655                     NEXT_OFF(REGNODE_p(ret)) = 3;   /* Go over NOTHING to
12656                                                        LONGJMP. */
12657                 if (! REGTAIL(pRExC_state, ret, reg_node(pRExC_state,
12658                                                           NOTHING)))
12659                 {
12660                     REQUIRE_BRANCHJ(flagp, 0);
12661                 }
12662                 RExC_whilem_seen++;
12663                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
12664             }
12665             FLAGS(REGNODE_p(ret)) = 0;
12666
12667             if (min > 0)
12668                 *flagp = WORST;
12669             if (max > 0)
12670                 *flagp |= HASWIDTH;
12671             ARG1_SET(REGNODE_p(ret), (U16)min);
12672             ARG2_SET(REGNODE_p(ret), (U16)max);
12673             if (max == REG_INFTY)
12674                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12675
12676             goto nest_check;
12677         }
12678     }
12679
12680     if (!ISMULT1(op)) {
12681         *flagp = flags;
12682         return(ret);
12683     }
12684
12685 #if 0                           /* Now runtime fix should be reliable. */
12686
12687     /* if this is reinstated, don't forget to put this back into perldiag:
12688
12689             =item Regexp *+ operand could be empty at {#} in regex m/%s/
12690
12691            (F) The part of the regexp subject to either the * or + quantifier
12692            could match an empty string. The {#} shows in the regular
12693            expression about where the problem was discovered.
12694
12695     */
12696
12697     if (!(flags&HASWIDTH) && op != '?')
12698       vFAIL("Regexp *+ operand could be empty");
12699 #endif
12700
12701 #ifdef RE_TRACK_PATTERN_OFFSETS
12702     parse_start = RExC_parse;
12703 #endif
12704     nextchar(pRExC_state);
12705
12706     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
12707
12708     if (op == '*') {
12709         min = 0;
12710         goto do_curly;
12711     }
12712     else if (op == '+') {
12713         min = 1;
12714         goto do_curly;
12715     }
12716     else if (op == '?') {
12717         min = 0; max = 1;
12718         goto do_curly;
12719     }
12720   nest_check:
12721     if (!(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
12722         ckWARN2reg(RExC_parse,
12723                    "%" UTF8f " matches null string many times",
12724                    UTF8fARG(UTF, (RExC_parse >= origparse
12725                                  ? RExC_parse - origparse
12726                                  : 0),
12727                    origparse));
12728     }
12729
12730     if (*RExC_parse == '?') {
12731         nextchar(pRExC_state);
12732         reginsert(pRExC_state, MINMOD, ret, depth+1);
12733         if (! REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE)) {
12734             REQUIRE_BRANCHJ(flagp, 0);
12735         }
12736     }
12737     else if (*RExC_parse == '+') {
12738         regnode_offset ender;
12739         nextchar(pRExC_state);
12740         ender = reg_node(pRExC_state, SUCCEED);
12741         if (! REGTAIL(pRExC_state, ret, ender)) {
12742             REQUIRE_BRANCHJ(flagp, 0);
12743         }
12744         reginsert(pRExC_state, SUSPEND, ret, depth+1);
12745         ender = reg_node(pRExC_state, TAIL);
12746         if (! REGTAIL(pRExC_state, ret, ender)) {
12747             REQUIRE_BRANCHJ(flagp, 0);
12748         }
12749     }
12750
12751     if (ISMULT2(RExC_parse)) {
12752         RExC_parse++;
12753         vFAIL("Nested quantifiers");
12754     }
12755
12756     return(ret);
12757 }
12758
12759 STATIC bool
12760 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
12761                 regnode_offset * node_p,
12762                 UV * code_point_p,
12763                 int * cp_count,
12764                 I32 * flagp,
12765                 const bool strict,
12766                 const U32 depth
12767     )
12768 {
12769  /* This routine teases apart the various meanings of \N and returns
12770   * accordingly.  The input parameters constrain which meaning(s) is/are valid
12771   * in the current context.
12772   *
12773   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
12774   *
12775   * If <code_point_p> is not NULL, the context is expecting the result to be a
12776   * single code point.  If this \N instance turns out to a single code point,
12777   * the function returns TRUE and sets *code_point_p to that code point.
12778   *
12779   * If <node_p> is not NULL, the context is expecting the result to be one of
12780   * the things representable by a regnode.  If this \N instance turns out to be
12781   * one such, the function generates the regnode, returns TRUE and sets *node_p
12782   * to point to the offset of that regnode into the regex engine program being
12783   * compiled.
12784   *
12785   * If this instance of \N isn't legal in any context, this function will
12786   * generate a fatal error and not return.
12787   *
12788   * On input, RExC_parse should point to the first char following the \N at the
12789   * time of the call.  On successful return, RExC_parse will have been updated
12790   * to point to just after the sequence identified by this routine.  Also
12791   * *flagp has been updated as needed.
12792   *
12793   * When there is some problem with the current context and this \N instance,
12794   * the function returns FALSE, without advancing RExC_parse, nor setting
12795   * *node_p, nor *code_point_p, nor *flagp.
12796   *
12797   * If <cp_count> is not NULL, the caller wants to know the length (in code
12798   * points) that this \N sequence matches.  This is set, and the input is
12799   * parsed for errors, even if the function returns FALSE, as detailed below.
12800   *
12801   * There are 6 possibilities here, as detailed in the next 6 paragraphs.
12802   *
12803   * Probably the most common case is for the \N to specify a single code point.
12804   * *cp_count will be set to 1, and *code_point_p will be set to that code
12805   * point.
12806   *
12807   * Another possibility is for the input to be an empty \N{}.  This is no
12808   * longer accepted, and will generate a fatal error.
12809   *
12810   * Another possibility is for a custom charnames handler to be in effect which
12811   * translates the input name to an empty string.  *cp_count will be set to 0.
12812   * *node_p will be set to a generated NOTHING node.
12813   *
12814   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
12815   * set to 0. *node_p will be set to a generated REG_ANY node.
12816   *
12817   * The fifth possibility is that \N resolves to a sequence of more than one
12818   * code points.  *cp_count will be set to the number of code points in the
12819   * sequence. *node_p will be set to a generated node returned by this
12820   * function calling S_reg().
12821   *
12822   * The final possibility is that it is premature to be calling this function;
12823   * the parse needs to be restarted.  This can happen when this changes from
12824   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
12825   * latter occurs only when the fifth possibility would otherwise be in
12826   * effect, and is because one of those code points requires the pattern to be
12827   * recompiled as UTF-8.  The function returns FALSE, and sets the
12828   * RESTART_PARSE and NEED_UTF8 flags in *flagp, as appropriate.  When this
12829   * happens, the caller needs to desist from continuing parsing, and return
12830   * this information to its caller.  This is not set for when there is only one
12831   * code point, as this can be called as part of an ANYOF node, and they can
12832   * store above-Latin1 code points without the pattern having to be in UTF-8.
12833   *
12834   * For non-single-quoted regexes, the tokenizer has resolved character and
12835   * sequence names inside \N{...} into their Unicode values, normalizing the
12836   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
12837   * hex-represented code points in the sequence.  This is done there because
12838   * the names can vary based on what charnames pragma is in scope at the time,
12839   * so we need a way to take a snapshot of what they resolve to at the time of
12840   * the original parse. [perl #56444].
12841   *
12842   * That parsing is skipped for single-quoted regexes, so here we may get
12843   * '\N{NAME}', which is parsed now.  If the single-quoted regex is something
12844   * like '\N{U+41}', that code point is Unicode, and has to be translated into
12845   * the native character set for non-ASCII platforms.  The other possibilities
12846   * are already native, so no translation is done. */
12847
12848     char * endbrace;    /* points to '}' following the name */
12849     char* p = RExC_parse; /* Temporary */
12850
12851     SV * substitute_parse = NULL;
12852     char *orig_end;
12853     char *save_start;
12854     I32 flags;
12855
12856     GET_RE_DEBUG_FLAGS_DECL;
12857
12858     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12859
12860     GET_RE_DEBUG_FLAGS;
12861
12862     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12863     assert(! (node_p && cp_count));               /* At most 1 should be set */
12864
12865     if (cp_count) {     /* Initialize return for the most common case */
12866         *cp_count = 1;
12867     }
12868
12869     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12870      * modifier.  The other meanings do not, so use a temporary until we find
12871      * out which we are being called with */
12872     skip_to_be_ignored_text(pRExC_state, &p,
12873                             FALSE /* Don't force to /x */ );
12874
12875     /* Disambiguate between \N meaning a named character versus \N meaning
12876      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12877      * quantifier, or if there is no '{' at all */
12878     if (*p != '{' || regcurly(p)) {
12879         RExC_parse = p;
12880         if (cp_count) {
12881             *cp_count = -1;
12882         }
12883
12884         if (! node_p) {
12885             return FALSE;
12886         }
12887
12888         *node_p = reg_node(pRExC_state, REG_ANY);
12889         *flagp |= HASWIDTH|SIMPLE;
12890         MARK_NAUGHTY(1);
12891         Set_Node_Length(REGNODE_p(*(node_p)), 1); /* MJD */
12892         return TRUE;
12893     }
12894
12895     /* The test above made sure that the next real character is a '{', but
12896      * under the /x modifier, it could be separated by space (or a comment and
12897      * \n) and this is not allowed (for consistency with \x{...} and the
12898      * tokenizer handling of \N{NAME}). */
12899     if (*RExC_parse != '{') {
12900         vFAIL("Missing braces on \\N{}");
12901     }
12902
12903     RExC_parse++;       /* Skip past the '{' */
12904
12905     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12906     if (! endbrace) { /* no trailing brace */
12907         vFAIL2("Missing right brace on \\%c{}", 'N');
12908     }
12909
12910     /* Here, we have decided it should be a named character or sequence.  These
12911      * imply Unicode semantics */
12912     REQUIRE_UNI_RULES(flagp, FALSE);
12913
12914     /* \N{_} is what toke.c returns to us to indicate a name that evaluates to
12915      * nothing at all (not allowed under strict) */
12916     if (endbrace - RExC_parse == 1 && *RExC_parse == '_') {
12917         RExC_parse = endbrace;
12918         if (strict) {
12919             RExC_parse++;   /* Position after the "}" */
12920             vFAIL("Zero length \\N{}");
12921         }
12922
12923         if (cp_count) {
12924             *cp_count = 0;
12925         }
12926         nextchar(pRExC_state);
12927         if (! node_p) {
12928             return FALSE;
12929         }
12930
12931         *node_p = reg_node(pRExC_state, NOTHING);
12932         return TRUE;
12933     }
12934
12935     if (endbrace - RExC_parse < 2 || ! strBEGINs(RExC_parse, "U+")) {
12936
12937         /* Here, the name isn't of the form  U+....  This can happen if the
12938          * pattern is single-quoted, so didn't get evaluated in toke.c.  Now
12939          * is the time to find out what the name means */
12940
12941         const STRLEN name_len = endbrace - RExC_parse;
12942         SV *  value_sv;     /* What does this name evaluate to */
12943         SV ** value_svp;
12944         const U8 * value;   /* string of name's value */
12945         STRLEN value_len;   /* and its length */
12946
12947         /*  RExC_unlexed_names is a hash of names that weren't evaluated by
12948          *  toke.c, and their values. Make sure is initialized */
12949         if (! RExC_unlexed_names) {
12950             RExC_unlexed_names = newHV();
12951         }
12952
12953         /* If we have already seen this name in this pattern, use that.  This
12954          * allows us to only call the charnames handler once per name per
12955          * pattern.  A broken or malicious handler could return something
12956          * different each time, which could cause the results to vary depending
12957          * on if something gets added or subtracted from the pattern that
12958          * causes the number of passes to change, for example */
12959         if ((value_svp = hv_fetch(RExC_unlexed_names, RExC_parse,
12960                                                       name_len, 0)))
12961         {
12962             value_sv = *value_svp;
12963         }
12964         else { /* Otherwise we have to go out and get the name */
12965             const char * error_msg = NULL;
12966             value_sv = get_and_check_backslash_N_name(RExC_parse, endbrace,
12967                                                       UTF,
12968                                                       &error_msg);
12969             if (error_msg) {
12970                 RExC_parse = endbrace;
12971                 vFAIL(error_msg);
12972             }
12973
12974             /* If no error message, should have gotten a valid return */
12975             assert (value_sv);
12976
12977             /* Save the name's meaning for later use */
12978             if (! hv_store(RExC_unlexed_names, RExC_parse, name_len,
12979                            value_sv, 0))
12980             {
12981                 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
12982             }
12983         }
12984
12985         /* Here, we have the value the name evaluates to in 'value_sv' */
12986         value = (U8 *) SvPV(value_sv, value_len);
12987
12988         /* See if the result is one code point vs 0 or multiple */
12989         if (value_len > 0 && value_len <= (UV) ((SvUTF8(value_sv))
12990                                                ? UTF8SKIP(value)
12991                                                : 1))
12992         {
12993             /* Here, exactly one code point.  If that isn't what is wanted,
12994              * fail */
12995             if (! code_point_p) {
12996                 RExC_parse = p;
12997                 return FALSE;
12998             }
12999
13000             /* Convert from string to numeric code point */
13001             *code_point_p = (SvUTF8(value_sv))
13002                             ? valid_utf8_to_uvchr(value, NULL)
13003                             : *value;
13004
13005             /* Have parsed this entire single code point \N{...}.  *cp_count
13006              * has already been set to 1, so don't do it again. */
13007             RExC_parse = endbrace;
13008             nextchar(pRExC_state);
13009             return TRUE;
13010         } /* End of is a single code point */
13011
13012         /* Count the code points, if caller desires.  The API says to do this
13013          * even if we will later return FALSE */
13014         if (cp_count) {
13015             *cp_count = 0;
13016
13017             *cp_count = (SvUTF8(value_sv))
13018                         ? utf8_length(value, value + value_len)
13019                         : value_len;
13020         }
13021
13022         /* Fail if caller doesn't want to handle a multi-code-point sequence.
13023          * But don't back the pointer up if the caller wants to know how many
13024          * code points there are (they need to handle it themselves in this
13025          * case).  */
13026         if (! node_p) {
13027             if (! cp_count) {
13028                 RExC_parse = p;
13029             }
13030             return FALSE;
13031         }
13032
13033         /* Convert this to a sub-pattern of the form "(?: ... )", and then call
13034          * reg recursively to parse it.  That way, it retains its atomicness,
13035          * while not having to worry about any special handling that some code
13036          * points may have. */
13037
13038         substitute_parse = newSVpvs("?:");
13039         sv_catsv(substitute_parse, value_sv);
13040         sv_catpv(substitute_parse, ")");
13041
13042         /* The value should already be native, so no need to convert on EBCDIC
13043          * platforms.*/
13044         assert(! RExC_recode_x_to_native);
13045
13046     }
13047     else {   /* \N{U+...} */
13048         Size_t count = 0;   /* code point count kept internally */
13049
13050         /* We can get to here when the input is \N{U+...} or when toke.c has
13051          * converted a name to the \N{U+...} form.  This include changing a
13052          * name that evaluates to multiple code points to \N{U+c1.c2.c3 ...} */
13053
13054         RExC_parse += 2;    /* Skip past the 'U+' */
13055
13056         /* Code points are separated by dots.  The '}' terminates the whole
13057          * thing. */
13058
13059         do {    /* Loop until the ending brace */
13060             UV cp = 0;
13061             char * start_digit;     /* The first of the current code point */
13062             if (! isXDIGIT(*RExC_parse)) {
13063                 RExC_parse++;
13064                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
13065             }
13066
13067             start_digit = RExC_parse;
13068             count++;
13069
13070             /* Loop through the hex digits of the current code point */
13071             do {
13072                 /* Adding this digit will shift the result 4 bits.  If that
13073                  * result would be above the legal max, it's overflow */
13074                 if (cp > MAX_LEGAL_CP >> 4) {
13075
13076                     /* Find the end of the code point */
13077                     do {
13078                         RExC_parse ++;
13079                     } while (isXDIGIT(*RExC_parse) || *RExC_parse == '_');
13080
13081                     /* Be sure to synchronize this message with the similar one
13082                      * in utf8.c */
13083                     vFAIL4("Use of code point 0x%.*s is not allowed; the"
13084                         " permissible max is 0x%" UVxf,
13085                         (int) (RExC_parse - start_digit), start_digit,
13086                         MAX_LEGAL_CP);
13087                 }
13088
13089                 /* Accumulate this (valid) digit into the running total */
13090                 cp  = (cp << 4) + READ_XDIGIT(RExC_parse);
13091
13092                 /* READ_XDIGIT advanced the input pointer.  Ignore a single
13093                  * underscore separator */
13094                 if (*RExC_parse == '_' && isXDIGIT(RExC_parse[1])) {
13095                     RExC_parse++;
13096                 }
13097             } while (isXDIGIT(*RExC_parse));
13098
13099             /* Here, have accumulated the next code point */
13100             if (RExC_parse >= endbrace) {   /* If done ... */
13101                 if (count != 1) {
13102                     goto do_concat;
13103                 }
13104
13105                 /* Here, is a single code point; fail if doesn't want that */
13106                 if (! code_point_p) {
13107                     RExC_parse = p;
13108                     return FALSE;
13109                 }
13110
13111                 /* A single code point is easy to handle; just return it */
13112                 *code_point_p = UNI_TO_NATIVE(cp);
13113                 RExC_parse = endbrace;
13114                 nextchar(pRExC_state);
13115                 return TRUE;
13116             }
13117
13118             /* Here, the only legal thing would be a multiple character
13119              * sequence (of the form "\N{U+c1.c2. ... }".   So the next
13120              * character must be a dot (and the one after that can't be the
13121              * endbrace, or we'd have something like \N{U+100.} ) */
13122             if (*RExC_parse != '.' || RExC_parse + 1 >= endbrace) {
13123                 RExC_parse += (RExC_orig_utf8)  /* point to after 1st invalid */
13124                                 ? UTF8SKIP(RExC_parse)
13125                                 : 1;
13126                 if (RExC_parse >= endbrace) { /* Guard against malformed utf8 */
13127                     RExC_parse = endbrace;
13128                 }
13129                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
13130             }
13131
13132             /* Here, looks like its really a multiple character sequence.  Fail
13133              * if that's not what the caller wants.  But continue with counting
13134              * and error checking if they still want a count */
13135             if (! node_p && ! cp_count) {
13136                 return FALSE;
13137             }
13138
13139             /* What is done here is to convert this to a sub-pattern of the
13140              * form \x{char1}\x{char2}...  and then call reg recursively to
13141              * parse it (enclosing in "(?: ... )" ).  That way, it retains its
13142              * atomicness, while not having to worry about special handling
13143              * that some code points may have.  We don't create a subpattern,
13144              * but go through the motions of code point counting and error
13145              * checking, if the caller doesn't want a node returned. */
13146
13147             if (node_p && count == 1) {
13148                 substitute_parse = newSVpvs("?:");
13149             }
13150
13151           do_concat:
13152
13153             if (node_p) {
13154                 /* Convert to notation the rest of the code understands */
13155                 sv_catpvs(substitute_parse, "\\x{");
13156                 sv_catpvn(substitute_parse, start_digit,
13157                                             RExC_parse - start_digit);
13158                 sv_catpvs(substitute_parse, "}");
13159             }
13160
13161             /* Move to after the dot (or ending brace the final time through.)
13162              * */
13163             RExC_parse++;
13164             count++;
13165
13166         } while (RExC_parse < endbrace);
13167
13168         if (! node_p) { /* Doesn't want the node */
13169             assert (cp_count);
13170
13171             *cp_count = count;
13172             return FALSE;
13173         }
13174
13175         sv_catpvs(substitute_parse, ")");
13176
13177         /* The values are Unicode, and therefore have to be converted to native
13178          * on a non-Unicode (meaning non-ASCII) platform. */
13179         SET_recode_x_to_native(1);
13180     }
13181
13182     /* Here, we have the string the name evaluates to, ready to be parsed,
13183      * stored in 'substitute_parse' as a series of valid "\x{...}\x{...}"
13184      * constructs.  This can be called from within a substitute parse already.
13185      * The error reporting mechanism doesn't work for 2 levels of this, but the
13186      * code above has validated this new construct, so there should be no
13187      * errors generated by the below.  And this isn' an exact copy, so the
13188      * mechanism to seamlessly deal with this won't work, so turn off warnings
13189      * during it */
13190     save_start = RExC_start;
13191     orig_end = RExC_end;
13192
13193     RExC_parse = RExC_start = SvPVX(substitute_parse);
13194     RExC_end = RExC_parse + SvCUR(substitute_parse);
13195     TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
13196
13197     *node_p = reg(pRExC_state, 1, &flags, depth+1);
13198
13199     /* Restore the saved values */
13200     RESTORE_WARNINGS;
13201     RExC_start = save_start;
13202     RExC_parse = endbrace;
13203     RExC_end = orig_end;
13204     SET_recode_x_to_native(0);
13205
13206     SvREFCNT_dec_NN(substitute_parse);
13207
13208     if (! *node_p) {
13209         RETURN_FAIL_ON_RESTART(flags, flagp);
13210         FAIL2("panic: reg returned failure to grok_bslash_N, flags=%#" UVxf,
13211             (UV) flags);
13212     }
13213     *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
13214
13215     nextchar(pRExC_state);
13216
13217     return TRUE;
13218 }
13219
13220
13221 PERL_STATIC_INLINE U8
13222 S_compute_EXACTish(RExC_state_t *pRExC_state)
13223 {
13224     U8 op;
13225
13226     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
13227
13228     if (! FOLD) {
13229         return (LOC)
13230                 ? EXACTL
13231                 : EXACT;
13232     }
13233
13234     op = get_regex_charset(RExC_flags);
13235     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
13236         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
13237                  been, so there is no hole */
13238     }
13239
13240     return op + EXACTF;
13241 }
13242
13243 STATIC bool
13244 S_new_regcurly(const char *s, const char *e)
13245 {
13246     /* This is a temporary function designed to match the most lenient form of
13247      * a {m,n} quantifier we ever envision, with either number omitted, and
13248      * spaces anywhere between/before/after them.
13249      *
13250      * If this function fails, then the string it matches is very unlikely to
13251      * ever be considered a valid quantifier, so we can allow the '{' that
13252      * begins it to be considered as a literal */
13253
13254     bool has_min = FALSE;
13255     bool has_max = FALSE;
13256
13257     PERL_ARGS_ASSERT_NEW_REGCURLY;
13258
13259     if (s >= e || *s++ != '{')
13260         return FALSE;
13261
13262     while (s < e && isSPACE(*s)) {
13263         s++;
13264     }
13265     while (s < e && isDIGIT(*s)) {
13266         has_min = TRUE;
13267         s++;
13268     }
13269     while (s < e && isSPACE(*s)) {
13270         s++;
13271     }
13272
13273     if (*s == ',') {
13274         s++;
13275         while (s < e && isSPACE(*s)) {
13276             s++;
13277         }
13278         while (s < e && isDIGIT(*s)) {
13279             has_max = TRUE;
13280             s++;
13281         }
13282         while (s < e && isSPACE(*s)) {
13283             s++;
13284         }
13285     }
13286
13287     return s < e && *s == '}' && (has_min || has_max);
13288 }
13289
13290 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
13291  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
13292
13293 static I32
13294 S_backref_value(char *p, char *e)
13295 {
13296     const char* endptr = e;
13297     UV val;
13298     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
13299         return (I32)val;
13300     return I32_MAX;
13301 }
13302
13303
13304 /*
13305  - regatom - the lowest level
13306
13307    Try to identify anything special at the start of the current parse position.
13308    If there is, then handle it as required. This may involve generating a
13309    single regop, such as for an assertion; or it may involve recursing, such as
13310    to handle a () structure.
13311
13312    If the string doesn't start with something special then we gobble up
13313    as much literal text as we can.  If we encounter a quantifier, we have to
13314    back off the final literal character, as that quantifier applies to just it
13315    and not to the whole string of literals.
13316
13317    Once we have been able to handle whatever type of thing started the
13318    sequence, we return the offset into the regex engine program being compiled
13319    at which any  next regnode should be placed.
13320
13321    Returns 0, setting *flagp to TRYAGAIN if reg() returns 0 with TRYAGAIN.
13322    Returns 0, setting *flagp to RESTART_PARSE if the parse needs to be
13323    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
13324    Otherwise does not return 0.
13325
13326    Note: we have to be careful with escapes, as they can be both literal
13327    and special, and in the case of \10 and friends, context determines which.
13328
13329    A summary of the code structure is:
13330
13331    switch (first_byte) {
13332         cases for each special:
13333             handle this special;
13334             break;
13335         case '\\':
13336             switch (2nd byte) {
13337                 cases for each unambiguous special:
13338                     handle this special;
13339                     break;
13340                 cases for each ambigous special/literal:
13341                     disambiguate;
13342                     if (special)  handle here
13343                     else goto defchar;
13344                 default: // unambiguously literal:
13345                     goto defchar;
13346             }
13347         default:  // is a literal char
13348             // FALL THROUGH
13349         defchar:
13350             create EXACTish node for literal;
13351             while (more input and node isn't full) {
13352                 switch (input_byte) {
13353                    cases for each special;
13354                        make sure parse pointer is set so that the next call to
13355                            regatom will see this special first
13356                        goto loopdone; // EXACTish node terminated by prev. char
13357                    default:
13358                        append char to EXACTISH node;
13359                 }
13360                 get next input byte;
13361             }
13362         loopdone:
13363    }
13364    return the generated node;
13365
13366    Specifically there are two separate switches for handling
13367    escape sequences, with the one for handling literal escapes requiring
13368    a dummy entry for all of the special escapes that are actually handled
13369    by the other.
13370
13371 */
13372
13373 STATIC regnode_offset
13374 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
13375 {
13376     dVAR;
13377     regnode_offset ret = 0;
13378     I32 flags = 0;
13379     char *parse_start;
13380     U8 op;
13381     int invert = 0;
13382
13383     GET_RE_DEBUG_FLAGS_DECL;
13384
13385     *flagp = WORST;             /* Tentatively. */
13386
13387     DEBUG_PARSE("atom");
13388
13389     PERL_ARGS_ASSERT_REGATOM;
13390
13391   tryagain:
13392     parse_start = RExC_parse;
13393     assert(RExC_parse < RExC_end);
13394     switch ((U8)*RExC_parse) {
13395     case '^':
13396         RExC_seen_zerolen++;
13397         nextchar(pRExC_state);
13398         if (RExC_flags & RXf_PMf_MULTILINE)
13399             ret = reg_node(pRExC_state, MBOL);
13400         else
13401             ret = reg_node(pRExC_state, SBOL);
13402         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13403         break;
13404     case '$':
13405         nextchar(pRExC_state);
13406         if (*RExC_parse)
13407             RExC_seen_zerolen++;
13408         if (RExC_flags & RXf_PMf_MULTILINE)
13409             ret = reg_node(pRExC_state, MEOL);
13410         else
13411             ret = reg_node(pRExC_state, SEOL);
13412         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13413         break;
13414     case '.':
13415         nextchar(pRExC_state);
13416         if (RExC_flags & RXf_PMf_SINGLELINE)
13417             ret = reg_node(pRExC_state, SANY);
13418         else
13419             ret = reg_node(pRExC_state, REG_ANY);
13420         *flagp |= HASWIDTH|SIMPLE;
13421         MARK_NAUGHTY(1);
13422         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13423         break;
13424     case '[':
13425     {
13426         char * const oregcomp_parse = ++RExC_parse;
13427         ret = regclass(pRExC_state, flagp, depth+1,
13428                        FALSE, /* means parse the whole char class */
13429                        TRUE, /* allow multi-char folds */
13430                        FALSE, /* don't silence non-portable warnings. */
13431                        (bool) RExC_strict,
13432                        TRUE, /* Allow an optimized regnode result */
13433                        NULL);
13434         if (ret == 0) {
13435             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13436             FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13437                   (UV) *flagp);
13438         }
13439         if (*RExC_parse != ']') {
13440             RExC_parse = oregcomp_parse;
13441             vFAIL("Unmatched [");
13442         }
13443         nextchar(pRExC_state);
13444         Set_Node_Length(REGNODE_p(ret), RExC_parse - oregcomp_parse + 1); /* MJD */
13445         break;
13446     }
13447     case '(':
13448         nextchar(pRExC_state);
13449         ret = reg(pRExC_state, 2, &flags, depth+1);
13450         if (ret == 0) {
13451                 if (flags & TRYAGAIN) {
13452                     if (RExC_parse >= RExC_end) {
13453                          /* Make parent create an empty node if needed. */
13454                         *flagp |= TRYAGAIN;
13455                         return(0);
13456                     }
13457                     goto tryagain;
13458                 }
13459                 RETURN_FAIL_ON_RESTART(flags, flagp);
13460                 FAIL2("panic: reg returned failure to regatom, flags=%#" UVxf,
13461                                                                  (UV) flags);
13462         }
13463         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
13464         break;
13465     case '|':
13466     case ')':
13467         if (flags & TRYAGAIN) {
13468             *flagp |= TRYAGAIN;
13469             return 0;
13470         }
13471         vFAIL("Internal urp");
13472                                 /* Supposed to be caught earlier. */
13473         break;
13474     case '?':
13475     case '+':
13476     case '*':
13477         RExC_parse++;
13478         vFAIL("Quantifier follows nothing");
13479         break;
13480     case '\\':
13481         /* Special Escapes
13482
13483            This switch handles escape sequences that resolve to some kind
13484            of special regop and not to literal text. Escape sequences that
13485            resolve to literal text are handled below in the switch marked
13486            "Literal Escapes".
13487
13488            Every entry in this switch *must* have a corresponding entry
13489            in the literal escape switch. However, the opposite is not
13490            required, as the default for this switch is to jump to the
13491            literal text handling code.
13492         */
13493         RExC_parse++;
13494         switch ((U8)*RExC_parse) {
13495         /* Special Escapes */
13496         case 'A':
13497             RExC_seen_zerolen++;
13498             ret = reg_node(pRExC_state, SBOL);
13499             /* SBOL is shared with /^/ so we set the flags so we can tell
13500              * /\A/ from /^/ in split. */
13501             FLAGS(REGNODE_p(ret)) = 1;
13502             *flagp |= SIMPLE;
13503             goto finish_meta_pat;
13504         case 'G':
13505             ret = reg_node(pRExC_state, GPOS);
13506             RExC_seen |= REG_GPOS_SEEN;
13507             *flagp |= SIMPLE;
13508             goto finish_meta_pat;
13509         case 'K':
13510             if (!RExC_in_lookbehind && !RExC_in_lookahead) {
13511                 RExC_seen_zerolen++;
13512                 ret = reg_node(pRExC_state, KEEPS);
13513                 *flagp |= SIMPLE;
13514                 /* XXX:dmq : disabling in-place substitution seems to
13515                  * be necessary here to avoid cases of memory corruption, as
13516                  * with: C<$_="x" x 80; s/x\K/y/> -- rgs
13517                  */
13518                 RExC_seen |= REG_LOOKBEHIND_SEEN;
13519                 goto finish_meta_pat;
13520             }
13521             else {
13522                 ++RExC_parse; /* advance past the 'K' */
13523                 vFAIL("\\K not permitted in lookahead/lookbehind");
13524             }
13525         case 'Z':
13526             ret = reg_node(pRExC_state, SEOL);
13527             *flagp |= SIMPLE;
13528             RExC_seen_zerolen++;                /* Do not optimize RE away */
13529             goto finish_meta_pat;
13530         case 'z':
13531             ret = reg_node(pRExC_state, EOS);
13532             *flagp |= SIMPLE;
13533             RExC_seen_zerolen++;                /* Do not optimize RE away */
13534             goto finish_meta_pat;
13535         case 'C':
13536             vFAIL("\\C no longer supported");
13537         case 'X':
13538             ret = reg_node(pRExC_state, CLUMP);
13539             *flagp |= HASWIDTH;
13540             goto finish_meta_pat;
13541
13542         case 'B':
13543             invert = 1;
13544             /* FALLTHROUGH */
13545         case 'b':
13546           {
13547             U8 flags = 0;
13548             regex_charset charset = get_regex_charset(RExC_flags);
13549
13550             RExC_seen_zerolen++;
13551             RExC_seen |= REG_LOOKBEHIND_SEEN;
13552             op = BOUND + charset;
13553
13554             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
13555                 flags = TRADITIONAL_BOUND;
13556                 if (op > BOUNDA) {  /* /aa is same as /a */
13557                     op = BOUNDA;
13558                 }
13559             }
13560             else {
13561                 STRLEN length;
13562                 char name = *RExC_parse;
13563                 char * endbrace = NULL;
13564                 RExC_parse += 2;
13565                 endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
13566
13567                 if (! endbrace) {
13568                     vFAIL2("Missing right brace on \\%c{}", name);
13569                 }
13570                 /* XXX Need to decide whether to take spaces or not.  Should be
13571                  * consistent with \p{}, but that currently is SPACE, which
13572                  * means vertical too, which seems wrong
13573                  * while (isBLANK(*RExC_parse)) {
13574                     RExC_parse++;
13575                 }*/
13576                 if (endbrace == RExC_parse) {
13577                     RExC_parse++;  /* After the '}' */
13578                     vFAIL2("Empty \\%c{}", name);
13579                 }
13580                 length = endbrace - RExC_parse;
13581                 /*while (isBLANK(*(RExC_parse + length - 1))) {
13582                     length--;
13583                 }*/
13584                 switch (*RExC_parse) {
13585                     case 'g':
13586                         if (    length != 1
13587                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
13588                         {
13589                             goto bad_bound_type;
13590                         }
13591                         flags = GCB_BOUND;
13592                         break;
13593                     case 'l':
13594                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13595                             goto bad_bound_type;
13596                         }
13597                         flags = LB_BOUND;
13598                         break;
13599                     case 's':
13600                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13601                             goto bad_bound_type;
13602                         }
13603                         flags = SB_BOUND;
13604                         break;
13605                     case 'w':
13606                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13607                             goto bad_bound_type;
13608                         }
13609                         flags = WB_BOUND;
13610                         break;
13611                     default:
13612                       bad_bound_type:
13613                         RExC_parse = endbrace;
13614                         vFAIL2utf8f(
13615                             "'%" UTF8f "' is an unknown bound type",
13616                             UTF8fARG(UTF, length, endbrace - length));
13617                         NOT_REACHED; /*NOTREACHED*/
13618                 }
13619                 RExC_parse = endbrace;
13620                 REQUIRE_UNI_RULES(flagp, 0);
13621
13622                 if (op == BOUND) {
13623                     op = BOUNDU;
13624                 }
13625                 else if (op >= BOUNDA) {  /* /aa is same as /a */
13626                     op = BOUNDU;
13627                     length += 4;
13628
13629                     /* Don't have to worry about UTF-8, in this message because
13630                      * to get here the contents of the \b must be ASCII */
13631                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
13632                               "Using /u for '%.*s' instead of /%s",
13633                               (unsigned) length,
13634                               endbrace - length + 1,
13635                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
13636                               ? ASCII_RESTRICT_PAT_MODS
13637                               : ASCII_MORE_RESTRICT_PAT_MODS);
13638                 }
13639             }
13640
13641             if (op == BOUND) {
13642                 RExC_seen_d_op = TRUE;
13643             }
13644             else if (op == BOUNDL) {
13645                 RExC_contains_locale = 1;
13646             }
13647
13648             if (invert) {
13649                 op += NBOUND - BOUND;
13650             }
13651
13652             ret = reg_node(pRExC_state, op);
13653             FLAGS(REGNODE_p(ret)) = flags;
13654
13655             *flagp |= SIMPLE;
13656
13657             goto finish_meta_pat;
13658           }
13659
13660         case 'R':
13661             ret = reg_node(pRExC_state, LNBREAK);
13662             *flagp |= HASWIDTH|SIMPLE;
13663             goto finish_meta_pat;
13664
13665         case 'd':
13666         case 'D':
13667         case 'h':
13668         case 'H':
13669         case 'p':
13670         case 'P':
13671         case 's':
13672         case 'S':
13673         case 'v':
13674         case 'V':
13675         case 'w':
13676         case 'W':
13677             /* These all have the same meaning inside [brackets], and it knows
13678              * how to do the best optimizations for them.  So, pretend we found
13679              * these within brackets, and let it do the work */
13680             RExC_parse--;
13681
13682             ret = regclass(pRExC_state, flagp, depth+1,
13683                            TRUE, /* means just parse this element */
13684                            FALSE, /* don't allow multi-char folds */
13685                            FALSE, /* don't silence non-portable warnings.  It
13686                                      would be a bug if these returned
13687                                      non-portables */
13688                            (bool) RExC_strict,
13689                            TRUE, /* Allow an optimized regnode result */
13690                            NULL);
13691             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13692             /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
13693              * multi-char folds are allowed.  */
13694             if (!ret)
13695                 FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13696                       (UV) *flagp);
13697
13698             RExC_parse--;   /* regclass() leaves this one too far ahead */
13699
13700           finish_meta_pat:
13701                    /* The escapes above that don't take a parameter can't be
13702                     * followed by a '{'.  But 'pX', 'p{foo}' and
13703                     * correspondingly 'P' can be */
13704             if (   RExC_parse - parse_start == 1
13705                 && UCHARAT(RExC_parse + 1) == '{'
13706                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
13707             {
13708                 RExC_parse += 2;
13709                 vFAIL("Unescaped left brace in regex is illegal here");
13710             }
13711             Set_Node_Offset(REGNODE_p(ret), parse_start);
13712             Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1); /* MJD */
13713             nextchar(pRExC_state);
13714             break;
13715         case 'N':
13716             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
13717              * \N{...} evaluates to a sequence of more than one code points).
13718              * The function call below returns a regnode, which is our result.
13719              * The parameters cause it to fail if the \N{} evaluates to a
13720              * single code point; we handle those like any other literal.  The
13721              * reason that the multicharacter case is handled here and not as
13722              * part of the EXACtish code is because of quantifiers.  In
13723              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
13724              * this way makes that Just Happen. dmq.
13725              * join_exact() will join this up with adjacent EXACTish nodes
13726              * later on, if appropriate. */
13727             ++RExC_parse;
13728             if (grok_bslash_N(pRExC_state,
13729                               &ret,     /* Want a regnode returned */
13730                               NULL,     /* Fail if evaluates to a single code
13731                                            point */
13732                               NULL,     /* Don't need a count of how many code
13733                                            points */
13734                               flagp,
13735                               RExC_strict,
13736                               depth)
13737             ) {
13738                 break;
13739             }
13740
13741             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13742
13743             /* Here, evaluates to a single code point.  Go get that */
13744             RExC_parse = parse_start;
13745             goto defchar;
13746
13747         case 'k':    /* Handle \k<NAME> and \k'NAME' */
13748       parse_named_seq:
13749         {
13750             char ch;
13751             if (   RExC_parse >= RExC_end - 1
13752                 || ((   ch = RExC_parse[1]) != '<'
13753                                       && ch != '\''
13754                                       && ch != '{'))
13755             {
13756                 RExC_parse++;
13757                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13758                 vFAIL2("Sequence %.2s... not terminated", parse_start);
13759             } else {
13760                 RExC_parse += 2;
13761                 ret = handle_named_backref(pRExC_state,
13762                                            flagp,
13763                                            parse_start,
13764                                            (ch == '<')
13765                                            ? '>'
13766                                            : (ch == '{')
13767                                              ? '}'
13768                                              : '\'');
13769             }
13770             break;
13771         }
13772         case 'g':
13773         case '1': case '2': case '3': case '4':
13774         case '5': case '6': case '7': case '8': case '9':
13775             {
13776                 I32 num;
13777                 bool hasbrace = 0;
13778
13779                 if (*RExC_parse == 'g') {
13780                     bool isrel = 0;
13781
13782                     RExC_parse++;
13783                     if (*RExC_parse == '{') {
13784                         RExC_parse++;
13785                         hasbrace = 1;
13786                     }
13787                     if (*RExC_parse == '-') {
13788                         RExC_parse++;
13789                         isrel = 1;
13790                     }
13791                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13792                         if (isrel) RExC_parse--;
13793                         RExC_parse -= 2;
13794                         goto parse_named_seq;
13795                     }
13796
13797                     if (RExC_parse >= RExC_end) {
13798                         goto unterminated_g;
13799                     }
13800                     num = S_backref_value(RExC_parse, RExC_end);
13801                     if (num == 0)
13802                         vFAIL("Reference to invalid group 0");
13803                     else if (num == I32_MAX) {
13804                          if (isDIGIT(*RExC_parse))
13805                             vFAIL("Reference to nonexistent group");
13806                         else
13807                           unterminated_g:
13808                             vFAIL("Unterminated \\g... pattern");
13809                     }
13810
13811                     if (isrel) {
13812                         num = RExC_npar - num;
13813                         if (num < 1)
13814                             vFAIL("Reference to nonexistent or unclosed group");
13815                     }
13816                 }
13817                 else {
13818                     num = S_backref_value(RExC_parse, RExC_end);
13819                     /* bare \NNN might be backref or octal - if it is larger
13820                      * than or equal RExC_npar then it is assumed to be an
13821                      * octal escape. Note RExC_npar is +1 from the actual
13822                      * number of parens. */
13823                     /* Note we do NOT check if num == I32_MAX here, as that is
13824                      * handled by the RExC_npar check */
13825
13826                     if (
13827                         /* any numeric escape < 10 is always a backref */
13828                         num > 9
13829                         /* any numeric escape < RExC_npar is a backref */
13830                         && num >= RExC_npar
13831                         /* cannot be an octal escape if it starts with 8 */
13832                         && *RExC_parse != '8'
13833                         /* cannot be an octal escape if it starts with 9 */
13834                         && *RExC_parse != '9'
13835                     ) {
13836                         /* Probably not meant to be a backref, instead likely
13837                          * to be an octal character escape, e.g. \35 or \777.
13838                          * The above logic should make it obvious why using
13839                          * octal escapes in patterns is problematic. - Yves */
13840                         RExC_parse = parse_start;
13841                         goto defchar;
13842                     }
13843                 }
13844
13845                 /* At this point RExC_parse points at a numeric escape like
13846                  * \12 or \88 or something similar, which we should NOT treat
13847                  * as an octal escape. It may or may not be a valid backref
13848                  * escape. For instance \88888888 is unlikely to be a valid
13849                  * backref. */
13850                 while (isDIGIT(*RExC_parse))
13851                     RExC_parse++;
13852                 if (hasbrace) {
13853                     if (*RExC_parse != '}')
13854                         vFAIL("Unterminated \\g{...} pattern");
13855                     RExC_parse++;
13856                 }
13857                 if (num >= (I32)RExC_npar) {
13858
13859                     /* It might be a forward reference; we can't fail until we
13860                      * know, by completing the parse to get all the groups, and
13861                      * then reparsing */
13862                     if (ALL_PARENS_COUNTED)  {
13863                         if (num >= RExC_total_parens)  {
13864                             vFAIL("Reference to nonexistent group");
13865                         }
13866                     }
13867                     else {
13868                         REQUIRE_PARENS_PASS;
13869                     }
13870                 }
13871                 RExC_sawback = 1;
13872                 ret = reganode(pRExC_state,
13873                                ((! FOLD)
13874                                  ? REF
13875                                  : (ASCII_FOLD_RESTRICTED)
13876                                    ? REFFA
13877                                    : (AT_LEAST_UNI_SEMANTICS)
13878                                      ? REFFU
13879                                      : (LOC)
13880                                        ? REFFL
13881                                        : REFF),
13882                                 num);
13883                 if (OP(REGNODE_p(ret)) == REFF) {
13884                     RExC_seen_d_op = TRUE;
13885                 }
13886                 *flagp |= HASWIDTH;
13887
13888                 /* override incorrect value set in reganode MJD */
13889                 Set_Node_Offset(REGNODE_p(ret), parse_start);
13890                 Set_Node_Cur_Length(REGNODE_p(ret), parse_start-1);
13891                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13892                                         FALSE /* Don't force to /x */ );
13893             }
13894             break;
13895         case '\0':
13896             if (RExC_parse >= RExC_end)
13897                 FAIL("Trailing \\");
13898             /* FALLTHROUGH */
13899         default:
13900             /* Do not generate "unrecognized" warnings here, we fall
13901                back into the quick-grab loop below */
13902             RExC_parse = parse_start;
13903             goto defchar;
13904         } /* end of switch on a \foo sequence */
13905         break;
13906
13907     case '#':
13908
13909         /* '#' comments should have been spaced over before this function was
13910          * called */
13911         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13912         /*
13913         if (RExC_flags & RXf_PMf_EXTENDED) {
13914             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13915             if (RExC_parse < RExC_end)
13916                 goto tryagain;
13917         }
13918         */
13919
13920         /* FALLTHROUGH */
13921
13922     default:
13923           defchar: {
13924
13925             /* Here, we have determined that the next thing is probably a
13926              * literal character.  RExC_parse points to the first byte of its
13927              * definition.  (It still may be an escape sequence that evaluates
13928              * to a single character) */
13929
13930             STRLEN len = 0;
13931             UV ender = 0;
13932             char *p;
13933             char *s;
13934             char *s0;
13935             U32 max_string_len = 255;
13936
13937             /* We may have to reparse the node, artificially stopping filling
13938              * it early, based on info gleaned in the first parse.  This
13939              * variable gives where we stop.  Make it above the normal stopping
13940              * place first time through. */
13941             U32 upper_fill = max_string_len + 1;
13942
13943             /* We start out as an EXACT node, even if under /i, until we find a
13944              * character which is in a fold.  The algorithm now segregates into
13945              * separate nodes, characters that fold from those that don't under
13946              * /i.  (This hopefully will create nodes that are fixed strings
13947              * even under /i, giving the optimizer something to grab on to.)
13948              * So, if a node has something in it and the next character is in
13949              * the opposite category, that node is closed up, and the function
13950              * returns.  Then regatom is called again, and a new node is
13951              * created for the new category. */
13952             U8 node_type = EXACT;
13953
13954             /* Assume the node will be fully used; the excess is given back at
13955              * the end.  We can't make any other length assumptions, as a byte
13956              * input sequence could shrink down. */
13957             Ptrdiff_t current_string_nodes = STR_SZ(max_string_len);
13958
13959             bool next_is_quantifier;
13960             char * oldp = NULL;
13961
13962             /* We can convert EXACTF nodes to EXACTFU if they contain only
13963              * characters that match identically regardless of the target
13964              * string's UTF8ness.  The reason to do this is that EXACTF is not
13965              * trie-able, EXACTFU is, and EXACTFU requires fewer operations at
13966              * runtime.
13967              *
13968              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13969              * contain only above-Latin1 characters (hence must be in UTF8),
13970              * which don't participate in folds with Latin1-range characters,
13971              * as the latter's folds aren't known until runtime. */
13972             bool maybe_exactfu = FOLD && (DEPENDS_SEMANTICS || LOC);
13973
13974             /* Single-character EXACTish nodes are almost always SIMPLE.  This
13975              * allows us to override this as encountered */
13976             U8 maybe_SIMPLE = SIMPLE;
13977
13978             /* Does this node contain something that can't match unless the
13979              * target string is (also) in UTF-8 */
13980             bool requires_utf8_target = FALSE;
13981
13982             /* The sequence 'ss' is problematic in non-UTF-8 patterns. */
13983             bool has_ss = FALSE;
13984
13985             /* So is the MICRO SIGN */
13986             bool has_micro_sign = FALSE;
13987
13988             /* Set when we fill up the current node and there is still more
13989              * text to process */
13990             bool overflowed;
13991
13992             /* Allocate an EXACT node.  The node_type may change below to
13993              * another EXACTish node, but since the size of the node doesn't
13994              * change, it works */
13995             ret = regnode_guts(pRExC_state, node_type, current_string_nodes,
13996                                                                     "exact");
13997             FILL_NODE(ret, node_type);
13998             RExC_emit++;
13999
14000             s = STRING(REGNODE_p(ret));
14001
14002             s0 = s;
14003
14004           reparse:
14005
14006             p = RExC_parse;
14007             len = 0;
14008             s = s0;
14009
14010           continue_parse:
14011
14012             /* This breaks under rare circumstances.  If folding, we do not
14013              * want to split a node at a character that is a non-final in a
14014              * multi-char fold, as an input string could just happen to want to
14015              * match across the node boundary.  The code at the end of the loop
14016              * looks for this, and backs off until it finds not such a
14017              * character, but it is possible (though extremely, extremely
14018              * unlikely) for all characters in the node to be non-final fold
14019              * ones, in which case we just leave the node fully filled, and
14020              * hope that it doesn't match the string in just the wrong place */
14021
14022             assert( ! UTF     /* Is at the beginning of a character */
14023                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
14024                    || UTF8_IS_START(UCHARAT(RExC_parse)));
14025
14026             overflowed = FALSE;
14027
14028             /* Here, we have a literal character.  Find the maximal string of
14029              * them in the input that we can fit into a single EXACTish node.
14030              * We quit at the first non-literal or when the node gets full, or
14031              * under /i the categorization of folding/non-folding character
14032              * changes */
14033             while (p < RExC_end && len < upper_fill) {
14034
14035                 /* In most cases each iteration adds one byte to the output.
14036                  * The exceptions override this */
14037                 Size_t added_len = 1;
14038
14039                 oldp = p;
14040
14041                 /* White space has already been ignored */
14042                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
14043                        || ! is_PATWS_safe((p), RExC_end, UTF));
14044
14045                 switch ((U8)*p) {
14046                 case '^':
14047                 case '$':
14048                 case '.':
14049                 case '[':
14050                 case '(':
14051                 case ')':
14052                 case '|':
14053                     goto loopdone;
14054                 case '\\':
14055                     /* Literal Escapes Switch
14056
14057                        This switch is meant to handle escape sequences that
14058                        resolve to a literal character.
14059
14060                        Every escape sequence that represents something
14061                        else, like an assertion or a char class, is handled
14062                        in the switch marked 'Special Escapes' above in this
14063                        routine, but also has an entry here as anything that
14064                        isn't explicitly mentioned here will be treated as
14065                        an unescaped equivalent literal.
14066                     */
14067
14068                     switch ((U8)*++p) {
14069
14070                     /* These are all the special escapes. */
14071                     case 'A':             /* Start assertion */
14072                     case 'b': case 'B':   /* Word-boundary assertion*/
14073                     case 'C':             /* Single char !DANGEROUS! */
14074                     case 'd': case 'D':   /* digit class */
14075                     case 'g': case 'G':   /* generic-backref, pos assertion */
14076                     case 'h': case 'H':   /* HORIZWS */
14077                     case 'k': case 'K':   /* named backref, keep marker */
14078                     case 'p': case 'P':   /* Unicode property */
14079                               case 'R':   /* LNBREAK */
14080                     case 's': case 'S':   /* space class */
14081                     case 'v': case 'V':   /* VERTWS */
14082                     case 'w': case 'W':   /* word class */
14083                     case 'X':             /* eXtended Unicode "combining
14084                                              character sequence" */
14085                     case 'z': case 'Z':   /* End of line/string assertion */
14086                         --p;
14087                         goto loopdone;
14088
14089                     /* Anything after here is an escape that resolves to a
14090                        literal. (Except digits, which may or may not)
14091                      */
14092                     case 'n':
14093                         ender = '\n';
14094                         p++;
14095                         break;
14096                     case 'N': /* Handle a single-code point named character. */
14097                         RExC_parse = p + 1;
14098                         if (! grok_bslash_N(pRExC_state,
14099                                             NULL,   /* Fail if evaluates to
14100                                                        anything other than a
14101                                                        single code point */
14102                                             &ender, /* The returned single code
14103                                                        point */
14104                                             NULL,   /* Don't need a count of
14105                                                        how many code points */
14106                                             flagp,
14107                                             RExC_strict,
14108                                             depth)
14109                         ) {
14110                             if (*flagp & NEED_UTF8)
14111                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
14112                             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
14113
14114                             /* Here, it wasn't a single code point.  Go close
14115                              * up this EXACTish node.  The switch() prior to
14116                              * this switch handles the other cases */
14117                             RExC_parse = p = oldp;
14118                             goto loopdone;
14119                         }
14120                         p = RExC_parse;
14121                         RExC_parse = parse_start;
14122
14123                         /* The \N{} means the pattern, if previously /d,
14124                          * becomes /u.  That means it can't be an EXACTF node,
14125                          * but an EXACTFU */
14126                         if (node_type == EXACTF) {
14127                             node_type = EXACTFU;
14128
14129                             /* If the node already contains something that
14130                              * differs between EXACTF and EXACTFU, reparse it
14131                              * as EXACTFU */
14132                             if (! maybe_exactfu) {
14133                                 len = 0;
14134                                 s = s0;
14135                                 goto reparse;
14136                             }
14137                         }
14138
14139                         break;
14140                     case 'r':
14141                         ender = '\r';
14142                         p++;
14143                         break;
14144                     case 't':
14145                         ender = '\t';
14146                         p++;
14147                         break;
14148                     case 'f':
14149                         ender = '\f';
14150                         p++;
14151                         break;
14152                     case 'e':
14153                         ender = ESC_NATIVE;
14154                         p++;
14155                         break;
14156                     case 'a':
14157                         ender = '\a';
14158                         p++;
14159                         break;
14160                     case 'o':
14161                         {
14162                             UV result;
14163                             const char* error_msg;
14164
14165                             bool valid = grok_bslash_o(&p,
14166                                                        RExC_end,
14167                                                        &result,
14168                                                        &error_msg,
14169                                                        TO_OUTPUT_WARNINGS(p),
14170                                                        (bool) RExC_strict,
14171                                                        TRUE, /* Output warnings
14172                                                                 for non-
14173                                                                 portables */
14174                                                        UTF);
14175                             if (! valid) {
14176                                 RExC_parse = p; /* going to die anyway; point
14177                                                    to exact spot of failure */
14178                                 vFAIL(error_msg);
14179                             }
14180                             UPDATE_WARNINGS_LOC(p - 1);
14181                             ender = result;
14182                             break;
14183                         }
14184                     case 'x':
14185                         {
14186                             UV result = UV_MAX; /* initialize to erroneous
14187                                                    value */
14188                             const char* error_msg;
14189
14190                             bool valid = grok_bslash_x(&p,
14191                                                        RExC_end,
14192                                                        &result,
14193                                                        &error_msg,
14194                                                        TO_OUTPUT_WARNINGS(p),
14195                                                        (bool) RExC_strict,
14196                                                        TRUE, /* Silence warnings
14197                                                                 for non-
14198                                                                 portables */
14199                                                        UTF);
14200                             if (! valid) {
14201                                 RExC_parse = p; /* going to die anyway; point
14202                                                    to exact spot of failure */
14203                                 vFAIL(error_msg);
14204                             }
14205                             UPDATE_WARNINGS_LOC(p - 1);
14206                             ender = result;
14207
14208 #ifdef EBCDIC
14209                             if (ender < 0x100) {
14210                                 if (RExC_recode_x_to_native) {
14211                                     ender = LATIN1_TO_NATIVE(ender);
14212                                 }
14213                             }
14214 #endif
14215                             break;
14216                         }
14217                     case 'c':
14218                         p++;
14219                         ender = grok_bslash_c(*p, TO_OUTPUT_WARNINGS(p));
14220                         UPDATE_WARNINGS_LOC(p);
14221                         p++;
14222                         break;
14223                     case '8': case '9': /* must be a backreference */
14224                         --p;
14225                         /* we have an escape like \8 which cannot be an octal escape
14226                          * so we exit the loop, and let the outer loop handle this
14227                          * escape which may or may not be a legitimate backref. */
14228                         goto loopdone;
14229                     case '1': case '2': case '3':case '4':
14230                     case '5': case '6': case '7':
14231                         /* When we parse backslash escapes there is ambiguity
14232                          * between backreferences and octal escapes. Any escape
14233                          * from \1 - \9 is a backreference, any multi-digit
14234                          * escape which does not start with 0 and which when
14235                          * evaluated as decimal could refer to an already
14236                          * parsed capture buffer is a back reference. Anything
14237                          * else is octal.
14238                          *
14239                          * Note this implies that \118 could be interpreted as
14240                          * 118 OR as "\11" . "8" depending on whether there
14241                          * were 118 capture buffers defined already in the
14242                          * pattern.  */
14243
14244                         /* NOTE, RExC_npar is 1 more than the actual number of
14245                          * parens we have seen so far, hence the "<" as opposed
14246                          * to "<=" */
14247                         if ( !isDIGIT(p[1]) || S_backref_value(p, RExC_end) < RExC_npar)
14248                         {  /* Not to be treated as an octal constant, go
14249                                    find backref */
14250                             --p;
14251                             goto loopdone;
14252                         }
14253                         /* FALLTHROUGH */
14254                     case '0':
14255                         {
14256                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
14257                             STRLEN numlen = 3;
14258                             ender = grok_oct(p, &numlen, &flags, NULL);
14259                             p += numlen;
14260                             if (   isDIGIT(*p)  /* like \08, \178 */
14261                                 && ckWARN(WARN_REGEXP)
14262                                 && numlen < 3)
14263                             {
14264                                 reg_warn_non_literal_string(
14265                                          p + 1,
14266                                          form_short_octal_warning(p, numlen));
14267                             }
14268                         }
14269                         break;
14270                     case '\0':
14271                         if (p >= RExC_end)
14272                             FAIL("Trailing \\");
14273                         /* FALLTHROUGH */
14274                     default:
14275                         if (isALPHANUMERIC(*p)) {
14276                             /* An alpha followed by '{' is going to fail next
14277                              * iteration, so don't output this warning in that
14278                              * case */
14279                             if (! isALPHA(*p) || *(p + 1) != '{') {
14280                                 ckWARN2reg(p + 1, "Unrecognized escape \\%.1s"
14281                                                   " passed through", p);
14282                             }
14283                         }
14284                         goto normal_default;
14285                     } /* End of switch on '\' */
14286                     break;
14287                 case '{':
14288                     /* Trying to gain new uses for '{' without breaking too
14289                      * much existing code is hard.  The solution currently
14290                      * adopted is:
14291                      *  1)  If there is no ambiguity that a '{' should always
14292                      *      be taken literally, at the start of a construct, we
14293                      *      just do so.
14294                      *  2)  If the literal '{' conflicts with our desired use
14295                      *      of it as a metacharacter, we die.  The deprecation
14296                      *      cycles for this have come and gone.
14297                      *  3)  If there is ambiguity, we raise a simple warning.
14298                      *      This could happen, for example, if the user
14299                      *      intended it to introduce a quantifier, but slightly
14300                      *      misspelled the quantifier.  Without this warning,
14301                      *      the quantifier would silently be taken as a literal
14302                      *      string of characters instead of a meta construct */
14303                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
14304                         if (      RExC_strict
14305                             || (  p > parse_start + 1
14306                                 && isALPHA_A(*(p - 1))
14307                                 && *(p - 2) == '\\')
14308                             || new_regcurly(p, RExC_end))
14309                         {
14310                             RExC_parse = p + 1;
14311                             vFAIL("Unescaped left brace in regex is "
14312                                   "illegal here");
14313                         }
14314                         ckWARNreg(p + 1, "Unescaped left brace in regex is"
14315                                          " passed through");
14316                     }
14317                     goto normal_default;
14318                 case '}':
14319                 case ']':
14320                     if (p > RExC_parse && RExC_strict) {
14321                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
14322                     }
14323                     /*FALLTHROUGH*/
14324                 default:    /* A literal character */
14325                   normal_default:
14326                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
14327                         STRLEN numlen;
14328                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
14329                                                &numlen, UTF8_ALLOW_DEFAULT);
14330                         p += numlen;
14331                     }
14332                     else
14333                         ender = (U8) *p++;
14334                     break;
14335                 } /* End of switch on the literal */
14336
14337                 /* Here, have looked at the literal character, and <ender>
14338                  * contains its ordinal; <p> points to the character after it.
14339                  * */
14340
14341                 if (ender > 255) {
14342                     REQUIRE_UTF8(flagp);
14343                 }
14344
14345                 /* We need to check if the next non-ignored thing is a
14346                  * quantifier.  Move <p> to after anything that should be
14347                  * ignored, which, as a side effect, positions <p> for the next
14348                  * loop iteration */
14349                 skip_to_be_ignored_text(pRExC_state, &p,
14350                                         FALSE /* Don't force to /x */ );
14351
14352                 /* If the next thing is a quantifier, it applies to this
14353                  * character only, which means that this character has to be in
14354                  * its own node and can't just be appended to the string in an
14355                  * existing node, so if there are already other characters in
14356                  * the node, close the node with just them, and set up to do
14357                  * this character again next time through, when it will be the
14358                  * only thing in its new node */
14359
14360                 next_is_quantifier =    LIKELY(p < RExC_end)
14361                                      && UNLIKELY(ISMULT2(p));
14362
14363                 if (next_is_quantifier && LIKELY(len)) {
14364                     p = oldp;
14365                     goto loopdone;
14366                 }
14367
14368                 /* Ready to add 'ender' to the node */
14369
14370                 if (! FOLD) {  /* The simple case, just append the literal */
14371                   not_fold_common:
14372
14373                     /* Don't output if it would overflow */
14374                     if (UNLIKELY(len > max_string_len - ((UTF)
14375                                                          ? UVCHR_SKIP(ender)
14376                                                          : 1)))
14377                     {
14378                         overflowed = TRUE;
14379                         break;
14380                     }
14381
14382                     if (UVCHR_IS_INVARIANT(ender) || ! UTF) {
14383                         *(s++) = (char) ender;
14384                     }
14385                     else {
14386                         U8 * new_s = uvchr_to_utf8((U8*)s, ender);
14387                         added_len = (char *) new_s - s;
14388                         s = (char *) new_s;
14389
14390                         if (ender > 255)  {
14391                             requires_utf8_target = TRUE;
14392                         }
14393                     }
14394                 }
14395                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
14396
14397                     /* Here are folding under /l, and the code point is
14398                      * problematic.  If this is the first character in the
14399                      * node, change the node type to folding.   Otherwise, if
14400                      * this is the first problematic character, close up the
14401                      * existing node, so can start a new node with this one */
14402                     if (! len) {
14403                         node_type = EXACTFL;
14404                         RExC_contains_locale = 1;
14405                     }
14406                     else if (node_type == EXACT) {
14407                         p = oldp;
14408                         goto loopdone;
14409                     }
14410
14411                     /* This problematic code point means we can't simplify
14412                      * things */
14413                     maybe_exactfu = FALSE;
14414
14415                     /* Here, we are adding a problematic fold character.
14416                      * "Problematic" in this context means that its fold isn't
14417                      * known until runtime.  (The non-problematic code points
14418                      * are the above-Latin1 ones that fold to also all
14419                      * above-Latin1.  Their folds don't vary no matter what the
14420                      * locale is.) But here we have characters whose fold
14421                      * depends on the locale.  We just add in the unfolded
14422                      * character, and wait until runtime to fold it */
14423                     goto not_fold_common;
14424                 }
14425                 else /* regular fold; see if actually is in a fold */
14426                      if (   (ender < 256 && ! IS_IN_SOME_FOLD_L1(ender))
14427                          || (ender > 255
14428                             && ! _invlist_contains_cp(PL_in_some_fold, ender)))
14429                 {
14430                     /* Here, folding, but the character isn't in a fold.
14431                      *
14432                      * Start a new node if previous characters in the node were
14433                      * folded */
14434                     if (len && node_type != EXACT) {
14435                         p = oldp;
14436                         goto loopdone;
14437                     }
14438
14439                     /* Here, continuing a node with non-folded characters.  Add
14440                      * this one */
14441                     goto not_fold_common;
14442                 }
14443                 else {  /* Here, does participate in some fold */
14444
14445                     /* If this is the first character in the node, change its
14446                      * type to folding.  Otherwise, if this is the first
14447                      * folding character in the node, close up the existing
14448                      * node, so can start a new node with this one.  */
14449                     if (! len) {
14450                         node_type = compute_EXACTish(pRExC_state);
14451                     }
14452                     else if (node_type == EXACT) {
14453                         p = oldp;
14454                         goto loopdone;
14455                     }
14456
14457                     if (UTF) {  /* Use the folded value */
14458                         if (UVCHR_IS_INVARIANT(ender)) {
14459                             if (UNLIKELY(len + 1 > max_string_len)) {
14460                                 overflowed = TRUE;
14461                                 break;
14462                             }
14463
14464                             *(s)++ = (U8) toFOLD(ender);
14465                         }
14466                         else {
14467                             U8 temp[UTF8_MAXBYTES_CASE+1];
14468
14469                             UV folded = _to_uni_fold_flags(
14470                                     ender,
14471                                     temp,
14472                                     &added_len,
14473                                     FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
14474                                                     ? FOLD_FLAGS_NOMIX_ASCII
14475                                                     : 0));
14476                             if (UNLIKELY(len + added_len > max_string_len)) {
14477                                 overflowed = TRUE;
14478                                 break;
14479                             }
14480
14481                             Copy(temp, s, added_len, char);
14482                             s += added_len;
14483
14484                             if (   folded > 255
14485                                 && LIKELY(folded != GREEK_SMALL_LETTER_MU))
14486                             {
14487                                 /* U+B5 folds to the MU, so its possible for a
14488                                  * non-UTF-8 target to match it */
14489                                 requires_utf8_target = TRUE;
14490                             }
14491                         }
14492                     }
14493                     else {
14494
14495                         /* Here is non-UTF8.  First, see if the character's
14496                          * fold differs between /d and /u. */
14497                         if (PL_fold[ender] != PL_fold_latin1[ender]) {
14498                             maybe_exactfu = FALSE;
14499                         }
14500
14501 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
14502    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
14503                                       || UNICODE_DOT_DOT_VERSION > 0)
14504
14505                         /* On non-ancient Unicode versions, this includes the
14506                          * multi-char fold SHARP S to 'ss' */
14507
14508                         if (   UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)
14509                                  || (   isALPHA_FOLD_EQ(ender, 's')
14510                                      && len > 0
14511                                      && isALPHA_FOLD_EQ(*(s-1), 's')))
14512                         {
14513                             /* Here, we have one of the following:
14514                              *  a)  a SHARP S.  This folds to 'ss' only under
14515                              *      /u rules.  If we are in that situation,
14516                              *      fold the SHARP S to 'ss'.  See the comments
14517                              *      for join_exact() as to why we fold this
14518                              *      non-UTF at compile time, and no others.
14519                              *  b)  'ss'.  When under /u, there's nothing
14520                              *      special needed to be done here.  The
14521                              *      previous iteration handled the first 's',
14522                              *      and this iteration will handle the second.
14523                              *      If, on the otherhand it's not /u, we have
14524                              *      to exclude the possibility of moving to /u,
14525                              *      so that we won't generate an unwanted
14526                              *      match, unless, at runtime, the target
14527                              *      string is in UTF-8.
14528                              * */
14529
14530                             has_ss = TRUE;
14531                             maybe_exactfu = FALSE;  /* Can't generate an
14532                                                        EXACTFU node (unless we
14533                                                        already are in one) */
14534                             if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
14535                                 maybe_SIMPLE = 0;
14536                                 if (node_type == EXACTFU) {
14537
14538                                     if (UNLIKELY(len + 2 > max_string_len)) {
14539                                         overflowed = TRUE;
14540                                         break;
14541                                     }
14542
14543                                     *(s++) = 's';
14544
14545                                     /* Let the code below add in the extra 's'
14546                                      * */
14547                                     ender = 's';
14548                                     added_len = 2;
14549                                 }
14550                             }
14551                         }
14552 #endif
14553
14554                         else if (UNLIKELY(ender == MICRO_SIGN)) {
14555                             has_micro_sign = TRUE;
14556                         }
14557
14558                         if (UNLIKELY(len + 1 > max_string_len)) {
14559                             overflowed = TRUE;
14560                             break;
14561                         }
14562
14563                         *(s++) = (DEPENDS_SEMANTICS)
14564                                  ? (char) toFOLD(ender)
14565
14566                                    /* Under /u, the fold of any character in
14567                                     * the 0-255 range happens to be its
14568                                     * lowercase equivalent, except for LATIN
14569                                     * SMALL LETTER SHARP S, which was handled
14570                                     * above, and the MICRO SIGN, whose fold
14571                                     * requires UTF-8 to represent.  */
14572                                  : (char) toLOWER_L1(ender);
14573                     }
14574                 } /* End of adding current character to the node */
14575
14576                 len += added_len;
14577
14578                 if (next_is_quantifier) {
14579
14580                     /* Here, the next input is a quantifier, and to get here,
14581                      * the current character is the only one in the node. */
14582                     goto loopdone;
14583                 }
14584
14585             } /* End of loop through literal characters */
14586
14587             /* Here we have either exhausted the input or run out of room in
14588              * the node.  If the former, we are done.  (If we encountered a
14589              * character that can't be in the node, transfer is made directly
14590              * to <loopdone>, and so we wouldn't have fallen off the end of the
14591              * loop.)  */
14592             if (LIKELY(! overflowed)) {
14593                 goto loopdone;
14594             }
14595
14596             /* Here we have run out of room.  We can grow plain EXACT and
14597              * LEXACT nodes.  If the pattern is gigantic enough, though,
14598              * eventually we'll have to artificially chunk the pattern into
14599              * multiple nodes. */
14600             if (! LOC && (node_type == EXACT || node_type == LEXACT)) {
14601                 Size_t overhead = 1 + regarglen[OP(REGNODE_p(ret))];
14602                 Size_t overhead_expansion = 0;
14603                 char temp[256];
14604                 Size_t max_nodes_for_string;
14605                 Size_t achievable;
14606                 SSize_t delta;
14607
14608                 /* Here we couldn't fit the final character in the current
14609                  * node, so it will have to be reparsed, no matter what else we
14610                  * do */
14611                 p = oldp;
14612
14613
14614                 /* If would have overflowed a regular EXACT node, switch
14615                  * instead to an LEXACT.  The code below is structured so that
14616                  * the actual growing code is common to changing from an EXACT
14617                  * or just increasing the LEXACT size.  This means that we have
14618                  * to save the string in the EXACT case before growing, and
14619                  * then copy it afterwards to its new location */
14620                 if (node_type == EXACT) {
14621                     overhead_expansion = regarglen[LEXACT] - regarglen[EXACT];
14622                     RExC_emit += overhead_expansion;
14623                     Copy(s0, temp, len, char);
14624                 }
14625
14626                 /* Ready to grow.  If it was a plain EXACT, the string was
14627                  * saved, and the first few bytes of it overwritten by adding
14628                  * an argument field.  We assume, as we do elsewhere in this
14629                  * file, that one byte of remaining input will translate into
14630                  * one byte of output, and if that's too small, we grow again,
14631                  * if too large the excess memory is freed at the end */
14632
14633                 max_nodes_for_string = U16_MAX - overhead - overhead_expansion;
14634                 achievable = MIN(max_nodes_for_string,
14635                                  current_string_nodes + STR_SZ(RExC_end - p));
14636                 delta = achievable - current_string_nodes;
14637
14638                 /* If there is just no more room, go finish up this chunk of
14639                  * the pattern. */
14640                 if (delta <= 0) {
14641                     goto loopdone;
14642                 }
14643
14644                 change_engine_size(pRExC_state, delta + overhead_expansion);
14645                 current_string_nodes += delta;
14646                 max_string_len
14647                            = sizeof(struct regnode) * current_string_nodes;
14648                 upper_fill = max_string_len + 1;
14649
14650                 /* If the length was small, we know this was originally an
14651                  * EXACT node now converted to LEXACT, and the string has to be
14652                  * restored.  Otherwise the string was untouched.  260 is just
14653                  * a number safely above 255 so don't have to worry about
14654                  * getting it precise */
14655                 if (len < 260) {
14656                     node_type = LEXACT;
14657                     FILL_NODE(ret, node_type);
14658                     s0 = STRING(REGNODE_p(ret));
14659                     Copy(temp, s0, len, char);
14660                     s = s0 + len;
14661                 }
14662
14663                 goto continue_parse;
14664             }
14665             else {
14666
14667                 /* Here is /i.  Running out of room creates a problem if we are
14668                  * folding, and the split happens in the middle of a
14669                  * multi-character fold, as a match that should have occurred,
14670                  * won't, due to the way nodes are matched, and our artificial
14671                  * boundary.  So back off until we aren't splitting such a
14672                  * fold.  If there is no such place to back off to, we end up
14673                  * taking the entire node as-is.  This can happen if the node
14674                  * consists entirely of 'f' or entirely of 's' characters (or
14675                  * things that fold to them) as 'ff' and 'ss' are
14676                  * multi-character folds.
14677                  *
14678                  * At this point:
14679                  *  oldp        points to the beginning in the input of the
14680                  *              final character in the node.
14681                  *  p           points to the beginning in the input of the
14682                  *              next character in the input, the one that won't
14683                  *              fit in the node.
14684                  *
14685                  * We aren't in the middle of a multi-char fold unless the
14686                  * final character in the node can appear in a non-final
14687                  * position in such a fold.  Very few characters actually
14688                  * participate in multi-character folds, and fewer still can be
14689                  * in the non-final position.  But it's complicated to know
14690                  * here if that final character is folded or not, so skip this
14691                  * check */
14692
14693                            /* Make sure enough space for final char of node,
14694                             * first char of following node, and the fold of the
14695                             * following char (so we don't have to worry about
14696                             * that fold running off the end */
14697                 U8 foldbuf[UTF8_MAXBYTES_CASE * 5 + 1];
14698                 STRLEN fold_len;
14699                 UV folded;
14700
14701                 assert(FOLD);
14702
14703                 /* The Unicode standard says that multi character folds consist
14704                  * of either two or three characters.  So we create a buffer
14705                  * containing a window of three.  The first is the final
14706                  * character in the node (folded), and then the two that begin
14707                  * the following node.   But if the first character of the
14708                  * following node can't be in a non-final fold position, there
14709                  * is no need to look at its successor character.  The macros
14710                  * used below to check for multi character folds require folded
14711                  * inputs, so we have to fold these.  (The fold of p was likely
14712                  * calculated in the loop above, but it hasn't beeen saved, and
14713                  * khw thinks it would be too entangled to change to do so) */
14714
14715                 if (UTF || LIKELY(UCHARAT(p) != MICRO_SIGN)) {
14716                     folded = _to_uni_fold_flags(ender,
14717                                                 foldbuf,
14718                                                 &fold_len,
14719                                                 FOLD_FLAGS_FULL);
14720                 }
14721                 else {
14722                     foldbuf[0] = folded = MICRO_SIGN;
14723                     fold_len = 1;
14724                 }
14725
14726                 /* Here, foldbuf contains the fold of the first character in
14727                  * the next node.  We may also need the next one (if there is
14728                  * one) to get our third, but if the first character folded to
14729                  * more than one, those extra one(s) will serve as the third.
14730                  * Also, we don't need a third unless the previous one can
14731                  * appear in a non-final position in a fold */
14732                 if (  ((RExC_end - p) > ((UTF) ? UVCHR_SKIP(ender) : 1))
14733                     && (fold_len == 1 || (   UTF
14734                                           && UVCHR_SKIP(folded) == fold_len))
14735                     &&  UNLIKELY(_invlist_contains_cp(PL_NonFinalFold, folded)))
14736                 {
14737                     if (UTF) {
14738                         STRLEN next_fold_len;
14739
14740                         toFOLD_utf8_safe((U8*) p + UTF8SKIP(p),
14741                                          (U8*) RExC_end, foldbuf + fold_len,
14742                                          &next_fold_len);
14743                         fold_len += next_fold_len;
14744                     }
14745                     else {
14746                         if (UNLIKELY(p[1] == LATIN_SMALL_LETTER_SHARP_S)) {
14747                             foldbuf[fold_len] = 's';
14748                         }
14749                         else {
14750                             foldbuf[fold_len] = toLOWER_L1(p[1]);
14751                         }
14752                         fold_len++;
14753                     }
14754                 }
14755
14756                 /* Here foldbuf contains the the fold of p, and if appropriate
14757                  * that of the character following p in the input. */
14758
14759                 /* Search backwards until find a place that doesn't split a
14760                  * multi-char fold */
14761                 while (1) {
14762                     STRLEN s_len;
14763                     char s_fold_buf[UTF8_MAXBYTES_CASE];
14764                     char * s_fold = s_fold_buf;
14765
14766                     if (s <= s0) {
14767
14768                         /* There's no safe place in the node to split.  Quit so
14769                          * will take the whole node */
14770                         break;
14771                     }
14772
14773                     /* Backup 1 character.  The first time through this moves s
14774                      * to point to the final character in the node */
14775                     if (UTF) {
14776                         s = (char *) utf8_hop_back((U8 *) s, -1, (U8 *) s0);
14777                     }
14778                     else {
14779                         s--;
14780                     }
14781
14782                     /* 's' may or may not be folded; so make sure it is, and
14783                      * use just the final character in its fold (should there
14784                      * be more than one */
14785                     if (UTF) {
14786                         toFOLD_utf8_safe((U8*) s,
14787                                          (U8*) s + UTF8SKIP(s),
14788                                          (U8 *) s_fold_buf, &s_len);
14789                         while (s_fold + UTF8SKIP(s_fold) < s_fold_buf + s_len)
14790                         {
14791                             s_fold += UTF8SKIP(s_fold);
14792                         }
14793                         s_len = UTF8SKIP(s_fold);
14794                     }
14795                     else {
14796                         if (UNLIKELY(UCHARAT(s) == LATIN_SMALL_LETTER_SHARP_S))
14797                         {
14798                             s_fold_buf[0] = 's';
14799                         }
14800                         else {  /* This works for all other non-UTF-8 folds
14801                                  */
14802                             s_fold_buf[0] = toLOWER_L1(UCHARAT(s));
14803                         }
14804                         s_len = 1;
14805                     }
14806
14807                     /* Unshift this character to the beginning of the buffer,
14808                      * No longer needed trailing characters are overwritten.
14809                      * */
14810                     Move(foldbuf, foldbuf + s_len, sizeof(foldbuf) - s_len, U8);
14811                     Copy(s_fold, foldbuf, s_len, U8);
14812
14813                     /* If this isn't a multi-character fold, we have found a
14814                      * splittable place.  If this is the final character in the
14815                      * node, that means the node is valid as-is, and can quit.
14816                      * Otherwise, we note how much we can fill the node before
14817                      * coming to a non-splittable position, and go parse it
14818                      * again, stopping there. This is done because we know
14819                      * where in the output to stop, but we don't have a map to
14820                      * where that is in the input.  One could be created, but
14821                      * it seems like overkill for such a rare event as we are
14822                      * dealing with here */
14823                     if (UTF) {
14824                         if (! is_MULTI_CHAR_FOLD_utf8_safe(foldbuf,
14825                                                 foldbuf + UTF8_MAXBYTES_CASE))
14826                         {
14827                             upper_fill = s + UTF8SKIP(s) - s0;
14828                             if (LIKELY(upper_fill == 255)) {
14829                                 break;
14830                             }
14831                             goto reparse;
14832                         }
14833                     }
14834                     else if (! is_MULTI_CHAR_FOLD_latin1_safe(foldbuf,
14835                                                 foldbuf + UTF8_MAXBYTES_CASE))
14836                     {
14837                         upper_fill = s + 1 - s0;
14838                         if (LIKELY(upper_fill == 255)) {
14839                             break;
14840                         }
14841                         goto reparse;
14842                     }
14843                 }
14844
14845                 /* Here the node consists entirely of non-final multi-char
14846                  * folds.  (Likely it is all 'f's or all 's's.)  There's no
14847                  * decent place to split it, so give up and just take the whole
14848                  * thing */
14849
14850             }   /* End of verifying node ends with an appropriate char */
14851
14852             p = oldp;
14853
14854           loopdone:   /* Jumped to when encounters something that shouldn't be
14855                          in the node */
14856
14857             /* Free up any over-allocated space; cast is to silence bogus
14858              * warning in MS VC */
14859             change_engine_size(pRExC_state,
14860                         - (Ptrdiff_t) (current_string_nodes - STR_SZ(len)));
14861
14862             /* I (khw) don't know if you can get here with zero length, but the
14863              * old code handled this situation by creating a zero-length EXACT
14864              * node.  Might as well be NOTHING instead */
14865             if (len == 0) {
14866                 OP(REGNODE_p(ret)) = NOTHING;
14867             }
14868             else {
14869
14870                 /* If the node type is EXACT here, check to see if it
14871                  * should be EXACTL, or EXACT_ONLY8. */
14872                 if (node_type == EXACT) {
14873                     if (LOC) {
14874                         node_type = EXACTL;
14875                     }
14876                     else if (requires_utf8_target) {
14877                         node_type = EXACT_ONLY8;
14878                     }
14879                 }
14880                 else if (node_type == LEXACT) {
14881                     if (requires_utf8_target) {
14882                         node_type = LEXACT_ONLY8;
14883                     }
14884                 }
14885                 else if (FOLD) {
14886                     if (    UNLIKELY(has_micro_sign || has_ss)
14887                         && (node_type == EXACTFU || (   node_type == EXACTF
14888                                                      && maybe_exactfu)))
14889                     {   /* These two conditions are problematic in non-UTF-8
14890                            EXACTFU nodes. */
14891                         assert(! UTF);
14892                         node_type = EXACTFUP;
14893                     }
14894                     else if (node_type == EXACTFL) {
14895
14896                         /* 'maybe_exactfu' is deliberately set above to
14897                          * indicate this node type, where all code points in it
14898                          * are above 255 */
14899                         if (maybe_exactfu) {
14900                             node_type = EXACTFLU8;
14901                         }
14902                     }
14903                     else if (node_type == EXACTF) {  /* Means is /di */
14904
14905                         /* This intermediate variable is needed solely because
14906                          * the asserts in the macro where used exceed Win32's
14907                          * literal string capacity */
14908                         char first_char = * STRING(REGNODE_p(ret));
14909
14910                         /* If 'maybe_exactfu' is clear, then we need to stay
14911                          * /di.  If it is set, it means there are no code
14912                          * points that match differently depending on UTF8ness
14913                          * of the target string, so it can become an EXACTFU
14914                          * node */
14915                         if (! maybe_exactfu) {
14916                             RExC_seen_d_op = TRUE;
14917                         }
14918                         else if (   isALPHA_FOLD_EQ(first_char, 's')
14919                                  || isALPHA_FOLD_EQ(ender, 's'))
14920                         {
14921                             /* But, if the node begins or ends in an 's' we
14922                              * have to defer changing it into an EXACTFU, as
14923                              * the node could later get joined with another one
14924                              * that ends or begins with 's' creating an 'ss'
14925                              * sequence which would then wrongly match the
14926                              * sharp s without the target being UTF-8.  We
14927                              * create a special node that we resolve later when
14928                              * we join nodes together */
14929
14930                             node_type = EXACTFU_S_EDGE;
14931                         }
14932                         else {
14933                             node_type = EXACTFU;
14934                         }
14935                     }
14936
14937                     if (requires_utf8_target && node_type == EXACTFU) {
14938                         node_type = EXACTFU_ONLY8;
14939                     }
14940                 }
14941
14942                 OP(REGNODE_p(ret)) = node_type;
14943                 setSTR_LEN(REGNODE_p(ret), len);
14944                 RExC_emit += STR_SZ(len);
14945
14946                 /* If the node isn't a single character, it can't be SIMPLE */
14947                 if (len > (Size_t) ((UTF) ? UTF8SKIP(STRING(REGNODE_p(ret))) : 1)) {
14948                     maybe_SIMPLE = 0;
14949                 }
14950
14951                 *flagp |= HASWIDTH | maybe_SIMPLE;
14952             }
14953
14954             Set_Node_Length(REGNODE_p(ret), p - parse_start - 1);
14955             RExC_parse = p;
14956
14957             {
14958                 /* len is STRLEN which is unsigned, need to copy to signed */
14959                 IV iv = len;
14960                 if (iv < 0)
14961                     vFAIL("Internal disaster");
14962             }
14963
14964         } /* End of label 'defchar:' */
14965         break;
14966     } /* End of giant switch on input character */
14967
14968     /* Position parse to next real character */
14969     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14970                                             FALSE /* Don't force to /x */ );
14971     if (   *RExC_parse == '{'
14972         && OP(REGNODE_p(ret)) != SBOL && ! regcurly(RExC_parse))
14973     {
14974         if (RExC_strict || new_regcurly(RExC_parse, RExC_end)) {
14975             RExC_parse++;
14976             vFAIL("Unescaped left brace in regex is illegal here");
14977         }
14978         ckWARNreg(RExC_parse + 1, "Unescaped left brace in regex is"
14979                                   " passed through");
14980     }
14981
14982     return(ret);
14983 }
14984
14985
14986 STATIC void
14987 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
14988 {
14989     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
14990      * sets up the bitmap and any flags, removing those code points from the
14991      * inversion list, setting it to NULL should it become completely empty */
14992
14993     dVAR;
14994
14995     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
14996     assert(PL_regkind[OP(node)] == ANYOF);
14997
14998     /* There is no bitmap for this node type */
14999     if (inRANGE(OP(node), ANYOFH, ANYOFHr)) {
15000         return;
15001     }
15002
15003     ANYOF_BITMAP_ZERO(node);
15004     if (*invlist_ptr) {
15005
15006         /* This gets set if we actually need to modify things */
15007         bool change_invlist = FALSE;
15008
15009         UV start, end;
15010
15011         /* Start looking through *invlist_ptr */
15012         invlist_iterinit(*invlist_ptr);
15013         while (invlist_iternext(*invlist_ptr, &start, &end)) {
15014             UV high;
15015             int i;
15016
15017             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
15018                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
15019             }
15020
15021             /* Quit if are above what we should change */
15022             if (start >= NUM_ANYOF_CODE_POINTS) {
15023                 break;
15024             }
15025
15026             change_invlist = TRUE;
15027
15028             /* Set all the bits in the range, up to the max that we are doing */
15029             high = (end < NUM_ANYOF_CODE_POINTS - 1)
15030                    ? end
15031                    : NUM_ANYOF_CODE_POINTS - 1;
15032             for (i = start; i <= (int) high; i++) {
15033                 if (! ANYOF_BITMAP_TEST(node, i)) {
15034                     ANYOF_BITMAP_SET(node, i);
15035                 }
15036             }
15037         }
15038         invlist_iterfinish(*invlist_ptr);
15039
15040         /* Done with loop; remove any code points that are in the bitmap from
15041          * *invlist_ptr; similarly for code points above the bitmap if we have
15042          * a flag to match all of them anyways */
15043         if (change_invlist) {
15044             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
15045         }
15046         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
15047             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
15048         }
15049
15050         /* If have completely emptied it, remove it completely */
15051         if (_invlist_len(*invlist_ptr) == 0) {
15052             SvREFCNT_dec_NN(*invlist_ptr);
15053             *invlist_ptr = NULL;
15054         }
15055     }
15056 }
15057
15058 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
15059    Character classes ([:foo:]) can also be negated ([:^foo:]).
15060    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
15061    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
15062    but trigger failures because they are currently unimplemented. */
15063
15064 #define POSIXCC_DONE(c)   ((c) == ':')
15065 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
15066 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
15067 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
15068
15069 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
15070 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
15071 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
15072
15073 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
15074
15075 /* 'posix_warnings' and 'warn_text' are names of variables in the following
15076  * routine. q.v. */
15077 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
15078         if (posix_warnings) {                                               \
15079             if (! RExC_warn_text ) RExC_warn_text =                         \
15080                                          (AV *) sv_2mortal((SV *) newAV()); \
15081             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                     \
15082                                              WARNING_PREFIX                 \
15083                                              text                           \
15084                                              REPORT_LOCATION,               \
15085                                              REPORT_LOCATION_ARGS(p)));     \
15086         }                                                                   \
15087     } STMT_END
15088 #define CLEAR_POSIX_WARNINGS()                                              \
15089     STMT_START {                                                            \
15090         if (posix_warnings && RExC_warn_text)                               \
15091             av_clear(RExC_warn_text);                                       \
15092     } STMT_END
15093
15094 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
15095     STMT_START {                                                            \
15096         CLEAR_POSIX_WARNINGS();                                             \
15097         return ret;                                                         \
15098     } STMT_END
15099
15100 STATIC int
15101 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
15102
15103     const char * const s,      /* Where the putative posix class begins.
15104                                   Normally, this is one past the '['.  This
15105                                   parameter exists so it can be somewhere
15106                                   besides RExC_parse. */
15107     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
15108                                   NULL */
15109     AV ** posix_warnings,      /* Where to place any generated warnings, or
15110                                   NULL */
15111     const bool check_only      /* Don't die if error */
15112 )
15113 {
15114     /* This parses what the caller thinks may be one of the three POSIX
15115      * constructs:
15116      *  1) a character class, like [:blank:]
15117      *  2) a collating symbol, like [. .]
15118      *  3) an equivalence class, like [= =]
15119      * In the latter two cases, it croaks if it finds a syntactically legal
15120      * one, as these are not handled by Perl.
15121      *
15122      * The main purpose is to look for a POSIX character class.  It returns:
15123      *  a) the class number
15124      *      if it is a completely syntactically and semantically legal class.
15125      *      'updated_parse_ptr', if not NULL, is set to point to just after the
15126      *      closing ']' of the class
15127      *  b) OOB_NAMEDCLASS
15128      *      if it appears that one of the three POSIX constructs was meant, but
15129      *      its specification was somehow defective.  'updated_parse_ptr', if
15130      *      not NULL, is set to point to the character just after the end
15131      *      character of the class.  See below for handling of warnings.
15132      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
15133      *      if it  doesn't appear that a POSIX construct was intended.
15134      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
15135      *      raised.
15136      *
15137      * In b) there may be errors or warnings generated.  If 'check_only' is
15138      * TRUE, then any errors are discarded.  Warnings are returned to the
15139      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
15140      * instead it is NULL, warnings are suppressed.
15141      *
15142      * The reason for this function, and its complexity is that a bracketed
15143      * character class can contain just about anything.  But it's easy to
15144      * mistype the very specific posix class syntax but yielding a valid
15145      * regular bracketed class, so it silently gets compiled into something
15146      * quite unintended.
15147      *
15148      * The solution adopted here maintains backward compatibility except that
15149      * it adds a warning if it looks like a posix class was intended but
15150      * improperly specified.  The warning is not raised unless what is input
15151      * very closely resembles one of the 14 legal posix classes.  To do this,
15152      * it uses fuzzy parsing.  It calculates how many single-character edits it
15153      * would take to transform what was input into a legal posix class.  Only
15154      * if that number is quite small does it think that the intention was a
15155      * posix class.  Obviously these are heuristics, and there will be cases
15156      * where it errs on one side or another, and they can be tweaked as
15157      * experience informs.
15158      *
15159      * The syntax for a legal posix class is:
15160      *
15161      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
15162      *
15163      * What this routine considers syntactically to be an intended posix class
15164      * is this (the comments indicate some restrictions that the pattern
15165      * doesn't show):
15166      *
15167      *  qr/(?x: \[?                         # The left bracket, possibly
15168      *                                      # omitted
15169      *          \h*                         # possibly followed by blanks
15170      *          (?: \^ \h* )?               # possibly a misplaced caret
15171      *          [:;]?                       # The opening class character,
15172      *                                      # possibly omitted.  A typo
15173      *                                      # semi-colon can also be used.
15174      *          \h*
15175      *          \^?                         # possibly a correctly placed
15176      *                                      # caret, but not if there was also
15177      *                                      # a misplaced one
15178      *          \h*
15179      *          .{3,15}                     # The class name.  If there are
15180      *                                      # deviations from the legal syntax,
15181      *                                      # its edit distance must be close
15182      *                                      # to a real class name in order
15183      *                                      # for it to be considered to be
15184      *                                      # an intended posix class.
15185      *          \h*
15186      *          [[:punct:]]?                # The closing class character,
15187      *                                      # possibly omitted.  If not a colon
15188      *                                      # nor semi colon, the class name
15189      *                                      # must be even closer to a valid
15190      *                                      # one
15191      *          \h*
15192      *          \]?                         # The right bracket, possibly
15193      *                                      # omitted.
15194      *     )/
15195      *
15196      * In the above, \h must be ASCII-only.
15197      *
15198      * These are heuristics, and can be tweaked as field experience dictates.
15199      * There will be cases when someone didn't intend to specify a posix class
15200      * that this warns as being so.  The goal is to minimize these, while
15201      * maximizing the catching of things intended to be a posix class that
15202      * aren't parsed as such.
15203      */
15204
15205     const char* p             = s;
15206     const char * const e      = RExC_end;
15207     unsigned complement       = 0;      /* If to complement the class */
15208     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
15209     bool has_opening_bracket  = FALSE;
15210     bool has_opening_colon    = FALSE;
15211     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
15212                                                    valid class */
15213     const char * possible_end = NULL;   /* used for a 2nd parse pass */
15214     const char* name_start;             /* ptr to class name first char */
15215
15216     /* If the number of single-character typos the input name is away from a
15217      * legal name is no more than this number, it is considered to have meant
15218      * the legal name */
15219     int max_distance          = 2;
15220
15221     /* to store the name.  The size determines the maximum length before we
15222      * decide that no posix class was intended.  Should be at least
15223      * sizeof("alphanumeric") */
15224     UV input_text[15];
15225     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
15226
15227     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
15228
15229     CLEAR_POSIX_WARNINGS();
15230
15231     if (p >= e) {
15232         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
15233     }
15234
15235     if (*(p - 1) != '[') {
15236         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
15237         found_problem = TRUE;
15238     }
15239     else {
15240         has_opening_bracket = TRUE;
15241     }
15242
15243     /* They could be confused and think you can put spaces between the
15244      * components */
15245     if (isBLANK(*p)) {
15246         found_problem = TRUE;
15247
15248         do {
15249             p++;
15250         } while (p < e && isBLANK(*p));
15251
15252         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15253     }
15254
15255     /* For [. .] and [= =].  These are quite different internally from [: :],
15256      * so they are handled separately.  */
15257     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
15258                                             and 1 for at least one char in it
15259                                           */
15260     {
15261         const char open_char  = *p;
15262         const char * temp_ptr = p + 1;
15263
15264         /* These two constructs are not handled by perl, and if we find a
15265          * syntactically valid one, we croak.  khw, who wrote this code, finds
15266          * this explanation of them very unclear:
15267          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
15268          * And searching the rest of the internet wasn't very helpful either.
15269          * It looks like just about any byte can be in these constructs,
15270          * depending on the locale.  But unless the pattern is being compiled
15271          * under /l, which is very rare, Perl runs under the C or POSIX locale.
15272          * In that case, it looks like [= =] isn't allowed at all, and that
15273          * [. .] could be any single code point, but for longer strings the
15274          * constituent characters would have to be the ASCII alphabetics plus
15275          * the minus-hyphen.  Any sensible locale definition would limit itself
15276          * to these.  And any portable one definitely should.  Trying to parse
15277          * the general case is a nightmare (see [perl #127604]).  So, this code
15278          * looks only for interiors of these constructs that match:
15279          *      qr/.|[-\w]{2,}/
15280          * Using \w relaxes the apparent rules a little, without adding much
15281          * danger of mistaking something else for one of these constructs.
15282          *
15283          * [. .] in some implementations described on the internet is usable to
15284          * escape a character that otherwise is special in bracketed character
15285          * classes.  For example [.].] means a literal right bracket instead of
15286          * the ending of the class
15287          *
15288          * [= =] can legitimately contain a [. .] construct, but we don't
15289          * handle this case, as that [. .] construct will later get parsed
15290          * itself and croak then.  And [= =] is checked for even when not under
15291          * /l, as Perl has long done so.
15292          *
15293          * The code below relies on there being a trailing NUL, so it doesn't
15294          * have to keep checking if the parse ptr < e.
15295          */
15296         if (temp_ptr[1] == open_char) {
15297             temp_ptr++;
15298         }
15299         else while (    temp_ptr < e
15300                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
15301         {
15302             temp_ptr++;
15303         }
15304
15305         if (*temp_ptr == open_char) {
15306             temp_ptr++;
15307             if (*temp_ptr == ']') {
15308                 temp_ptr++;
15309                 if (! found_problem && ! check_only) {
15310                     RExC_parse = (char *) temp_ptr;
15311                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
15312                             "extensions", open_char, open_char);
15313                 }
15314
15315                 /* Here, the syntax wasn't completely valid, or else the call
15316                  * is to check-only */
15317                 if (updated_parse_ptr) {
15318                     *updated_parse_ptr = (char *) temp_ptr;
15319                 }
15320
15321                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
15322             }
15323         }
15324
15325         /* If we find something that started out to look like one of these
15326          * constructs, but isn't, we continue below so that it can be checked
15327          * for being a class name with a typo of '.' or '=' instead of a colon.
15328          * */
15329     }
15330
15331     /* Here, we think there is a possibility that a [: :] class was meant, and
15332      * we have the first real character.  It could be they think the '^' comes
15333      * first */
15334     if (*p == '^') {
15335         found_problem = TRUE;
15336         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
15337         complement = 1;
15338         p++;
15339
15340         if (isBLANK(*p)) {
15341             found_problem = TRUE;
15342
15343             do {
15344                 p++;
15345             } while (p < e && isBLANK(*p));
15346
15347             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15348         }
15349     }
15350
15351     /* But the first character should be a colon, which they could have easily
15352      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
15353      * distinguish from a colon, so treat that as a colon).  */
15354     if (*p == ':') {
15355         p++;
15356         has_opening_colon = TRUE;
15357     }
15358     else if (*p == ';') {
15359         found_problem = TRUE;
15360         p++;
15361         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15362         has_opening_colon = TRUE;
15363     }
15364     else {
15365         found_problem = TRUE;
15366         ADD_POSIX_WARNING(p, "there must be a starting ':'");
15367
15368         /* Consider an initial punctuation (not one of the recognized ones) to
15369          * be a left terminator */
15370         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
15371             p++;
15372         }
15373     }
15374
15375     /* They may think that you can put spaces between the components */
15376     if (isBLANK(*p)) {
15377         found_problem = TRUE;
15378
15379         do {
15380             p++;
15381         } while (p < e && isBLANK(*p));
15382
15383         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15384     }
15385
15386     if (*p == '^') {
15387
15388         /* We consider something like [^:^alnum:]] to not have been intended to
15389          * be a posix class, but XXX maybe we should */
15390         if (complement) {
15391             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15392         }
15393
15394         complement = 1;
15395         p++;
15396     }
15397
15398     /* Again, they may think that you can put spaces between the components */
15399     if (isBLANK(*p)) {
15400         found_problem = TRUE;
15401
15402         do {
15403             p++;
15404         } while (p < e && isBLANK(*p));
15405
15406         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15407     }
15408
15409     if (*p == ']') {
15410
15411         /* XXX This ']' may be a typo, and something else was meant.  But
15412          * treating it as such creates enough complications, that that
15413          * possibility isn't currently considered here.  So we assume that the
15414          * ']' is what is intended, and if we've already found an initial '[',
15415          * this leaves this construct looking like [:] or [:^], which almost
15416          * certainly weren't intended to be posix classes */
15417         if (has_opening_bracket) {
15418             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15419         }
15420
15421         /* But this function can be called when we parse the colon for
15422          * something like qr/[alpha:]]/, so we back up to look for the
15423          * beginning */
15424         p--;
15425
15426         if (*p == ';') {
15427             found_problem = TRUE;
15428             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15429         }
15430         else if (*p != ':') {
15431
15432             /* XXX We are currently very restrictive here, so this code doesn't
15433              * consider the possibility that, say, /[alpha.]]/ was intended to
15434              * be a posix class. */
15435             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15436         }
15437
15438         /* Here we have something like 'foo:]'.  There was no initial colon,
15439          * and we back up over 'foo.  XXX Unlike the going forward case, we
15440          * don't handle typos of non-word chars in the middle */
15441         has_opening_colon = FALSE;
15442         p--;
15443
15444         while (p > RExC_start && isWORDCHAR(*p)) {
15445             p--;
15446         }
15447         p++;
15448
15449         /* Here, we have positioned ourselves to where we think the first
15450          * character in the potential class is */
15451     }
15452
15453     /* Now the interior really starts.  There are certain key characters that
15454      * can end the interior, or these could just be typos.  To catch both
15455      * cases, we may have to do two passes.  In the first pass, we keep on
15456      * going unless we come to a sequence that matches
15457      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
15458      * This means it takes a sequence to end the pass, so two typos in a row if
15459      * that wasn't what was intended.  If the class is perfectly formed, just
15460      * this one pass is needed.  We also stop if there are too many characters
15461      * being accumulated, but this number is deliberately set higher than any
15462      * real class.  It is set high enough so that someone who thinks that
15463      * 'alphanumeric' is a correct name would get warned that it wasn't.
15464      * While doing the pass, we keep track of where the key characters were in
15465      * it.  If we don't find an end to the class, and one of the key characters
15466      * was found, we redo the pass, but stop when we get to that character.
15467      * Thus the key character was considered a typo in the first pass, but a
15468      * terminator in the second.  If two key characters are found, we stop at
15469      * the second one in the first pass.  Again this can miss two typos, but
15470      * catches a single one
15471      *
15472      * In the first pass, 'possible_end' starts as NULL, and then gets set to
15473      * point to the first key character.  For the second pass, it starts as -1.
15474      * */
15475
15476     name_start = p;
15477   parse_name:
15478     {
15479         bool has_blank               = FALSE;
15480         bool has_upper               = FALSE;
15481         bool has_terminating_colon   = FALSE;
15482         bool has_terminating_bracket = FALSE;
15483         bool has_semi_colon          = FALSE;
15484         unsigned int name_len        = 0;
15485         int punct_count              = 0;
15486
15487         while (p < e) {
15488
15489             /* Squeeze out blanks when looking up the class name below */
15490             if (isBLANK(*p) ) {
15491                 has_blank = TRUE;
15492                 found_problem = TRUE;
15493                 p++;
15494                 continue;
15495             }
15496
15497             /* The name will end with a punctuation */
15498             if (isPUNCT(*p)) {
15499                 const char * peek = p + 1;
15500
15501                 /* Treat any non-']' punctuation followed by a ']' (possibly
15502                  * with intervening blanks) as trying to terminate the class.
15503                  * ']]' is very likely to mean a class was intended (but
15504                  * missing the colon), but the warning message that gets
15505                  * generated shows the error position better if we exit the
15506                  * loop at the bottom (eventually), so skip it here. */
15507                 if (*p != ']') {
15508                     if (peek < e && isBLANK(*peek)) {
15509                         has_blank = TRUE;
15510                         found_problem = TRUE;
15511                         do {
15512                             peek++;
15513                         } while (peek < e && isBLANK(*peek));
15514                     }
15515
15516                     if (peek < e && *peek == ']') {
15517                         has_terminating_bracket = TRUE;
15518                         if (*p == ':') {
15519                             has_terminating_colon = TRUE;
15520                         }
15521                         else if (*p == ';') {
15522                             has_semi_colon = TRUE;
15523                             has_terminating_colon = TRUE;
15524                         }
15525                         else {
15526                             found_problem = TRUE;
15527                         }
15528                         p = peek + 1;
15529                         goto try_posix;
15530                     }
15531                 }
15532
15533                 /* Here we have punctuation we thought didn't end the class.
15534                  * Keep track of the position of the key characters that are
15535                  * more likely to have been class-enders */
15536                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
15537
15538                     /* Allow just one such possible class-ender not actually
15539                      * ending the class. */
15540                     if (possible_end) {
15541                         break;
15542                     }
15543                     possible_end = p;
15544                 }
15545
15546                 /* If we have too many punctuation characters, no use in
15547                  * keeping going */
15548                 if (++punct_count > max_distance) {
15549                     break;
15550                 }
15551
15552                 /* Treat the punctuation as a typo. */
15553                 input_text[name_len++] = *p;
15554                 p++;
15555             }
15556             else if (isUPPER(*p)) { /* Use lowercase for lookup */
15557                 input_text[name_len++] = toLOWER(*p);
15558                 has_upper = TRUE;
15559                 found_problem = TRUE;
15560                 p++;
15561             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
15562                 input_text[name_len++] = *p;
15563                 p++;
15564             }
15565             else {
15566                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
15567                 p+= UTF8SKIP(p);
15568             }
15569
15570             /* The declaration of 'input_text' is how long we allow a potential
15571              * class name to be, before saying they didn't mean a class name at
15572              * all */
15573             if (name_len >= C_ARRAY_LENGTH(input_text)) {
15574                 break;
15575             }
15576         }
15577
15578         /* We get to here when the possible class name hasn't been properly
15579          * terminated before:
15580          *   1) we ran off the end of the pattern; or
15581          *   2) found two characters, each of which might have been intended to
15582          *      be the name's terminator
15583          *   3) found so many punctuation characters in the purported name,
15584          *      that the edit distance to a valid one is exceeded
15585          *   4) we decided it was more characters than anyone could have
15586          *      intended to be one. */
15587
15588         found_problem = TRUE;
15589
15590         /* In the final two cases, we know that looking up what we've
15591          * accumulated won't lead to a match, even a fuzzy one. */
15592         if (   name_len >= C_ARRAY_LENGTH(input_text)
15593             || punct_count > max_distance)
15594         {
15595             /* If there was an intermediate key character that could have been
15596              * an intended end, redo the parse, but stop there */
15597             if (possible_end && possible_end != (char *) -1) {
15598                 possible_end = (char *) -1; /* Special signal value to say
15599                                                we've done a first pass */
15600                 p = name_start;
15601                 goto parse_name;
15602             }
15603
15604             /* Otherwise, it can't have meant to have been a class */
15605             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15606         }
15607
15608         /* If we ran off the end, and the final character was a punctuation
15609          * one, back up one, to look at that final one just below.  Later, we
15610          * will restore the parse pointer if appropriate */
15611         if (name_len && p == e && isPUNCT(*(p-1))) {
15612             p--;
15613             name_len--;
15614         }
15615
15616         if (p < e && isPUNCT(*p)) {
15617             if (*p == ']') {
15618                 has_terminating_bracket = TRUE;
15619
15620                 /* If this is a 2nd ']', and the first one is just below this
15621                  * one, consider that to be the real terminator.  This gives a
15622                  * uniform and better positioning for the warning message  */
15623                 if (   possible_end
15624                     && possible_end != (char *) -1
15625                     && *possible_end == ']'
15626                     && name_len && input_text[name_len - 1] == ']')
15627                 {
15628                     name_len--;
15629                     p = possible_end;
15630
15631                     /* And this is actually equivalent to having done the 2nd
15632                      * pass now, so set it to not try again */
15633                     possible_end = (char *) -1;
15634                 }
15635             }
15636             else {
15637                 if (*p == ':') {
15638                     has_terminating_colon = TRUE;
15639                 }
15640                 else if (*p == ';') {
15641                     has_semi_colon = TRUE;
15642                     has_terminating_colon = TRUE;
15643                 }
15644                 p++;
15645             }
15646         }
15647
15648     try_posix:
15649
15650         /* Here, we have a class name to look up.  We can short circuit the
15651          * stuff below for short names that can't possibly be meant to be a
15652          * class name.  (We can do this on the first pass, as any second pass
15653          * will yield an even shorter name) */
15654         if (name_len < 3) {
15655             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15656         }
15657
15658         /* Find which class it is.  Initially switch on the length of the name.
15659          * */
15660         switch (name_len) {
15661             case 4:
15662                 if (memEQs(name_start, 4, "word")) {
15663                     /* this is not POSIX, this is the Perl \w */
15664                     class_number = ANYOF_WORDCHAR;
15665                 }
15666                 break;
15667             case 5:
15668                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
15669                  *                        graph lower print punct space upper
15670                  * Offset 4 gives the best switch position.  */
15671                 switch (name_start[4]) {
15672                     case 'a':
15673                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
15674                             class_number = ANYOF_ALPHA;
15675                         break;
15676                     case 'e':
15677                         if (memBEGINs(name_start, 5, "spac")) /* space */
15678                             class_number = ANYOF_SPACE;
15679                         break;
15680                     case 'h':
15681                         if (memBEGINs(name_start, 5, "grap")) /* graph */
15682                             class_number = ANYOF_GRAPH;
15683                         break;
15684                     case 'i':
15685                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
15686                             class_number = ANYOF_ASCII;
15687                         break;
15688                     case 'k':
15689                         if (memBEGINs(name_start, 5, "blan")) /* blank */
15690                             class_number = ANYOF_BLANK;
15691                         break;
15692                     case 'l':
15693                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
15694                             class_number = ANYOF_CNTRL;
15695                         break;
15696                     case 'm':
15697                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
15698                             class_number = ANYOF_ALPHANUMERIC;
15699                         break;
15700                     case 'r':
15701                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
15702                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
15703                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
15704                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
15705                         break;
15706                     case 't':
15707                         if (memBEGINs(name_start, 5, "digi")) /* digit */
15708                             class_number = ANYOF_DIGIT;
15709                         else if (memBEGINs(name_start, 5, "prin")) /* print */
15710                             class_number = ANYOF_PRINT;
15711                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
15712                             class_number = ANYOF_PUNCT;
15713                         break;
15714                 }
15715                 break;
15716             case 6:
15717                 if (memEQs(name_start, 6, "xdigit"))
15718                     class_number = ANYOF_XDIGIT;
15719                 break;
15720         }
15721
15722         /* If the name exactly matches a posix class name the class number will
15723          * here be set to it, and the input almost certainly was meant to be a
15724          * posix class, so we can skip further checking.  If instead the syntax
15725          * is exactly correct, but the name isn't one of the legal ones, we
15726          * will return that as an error below.  But if neither of these apply,
15727          * it could be that no posix class was intended at all, or that one
15728          * was, but there was a typo.  We tease these apart by doing fuzzy
15729          * matching on the name */
15730         if (class_number == OOB_NAMEDCLASS && found_problem) {
15731             const UV posix_names[][6] = {
15732                                                 { 'a', 'l', 'n', 'u', 'm' },
15733                                                 { 'a', 'l', 'p', 'h', 'a' },
15734                                                 { 'a', 's', 'c', 'i', 'i' },
15735                                                 { 'b', 'l', 'a', 'n', 'k' },
15736                                                 { 'c', 'n', 't', 'r', 'l' },
15737                                                 { 'd', 'i', 'g', 'i', 't' },
15738                                                 { 'g', 'r', 'a', 'p', 'h' },
15739                                                 { 'l', 'o', 'w', 'e', 'r' },
15740                                                 { 'p', 'r', 'i', 'n', 't' },
15741                                                 { 'p', 'u', 'n', 'c', 't' },
15742                                                 { 's', 'p', 'a', 'c', 'e' },
15743                                                 { 'u', 'p', 'p', 'e', 'r' },
15744                                                 { 'w', 'o', 'r', 'd' },
15745                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
15746                                             };
15747             /* The names of the above all have added NULs to make them the same
15748              * size, so we need to also have the real lengths */
15749             const UV posix_name_lengths[] = {
15750                                                 sizeof("alnum") - 1,
15751                                                 sizeof("alpha") - 1,
15752                                                 sizeof("ascii") - 1,
15753                                                 sizeof("blank") - 1,
15754                                                 sizeof("cntrl") - 1,
15755                                                 sizeof("digit") - 1,
15756                                                 sizeof("graph") - 1,
15757                                                 sizeof("lower") - 1,
15758                                                 sizeof("print") - 1,
15759                                                 sizeof("punct") - 1,
15760                                                 sizeof("space") - 1,
15761                                                 sizeof("upper") - 1,
15762                                                 sizeof("word")  - 1,
15763                                                 sizeof("xdigit")- 1
15764                                             };
15765             unsigned int i;
15766             int temp_max = max_distance;    /* Use a temporary, so if we
15767                                                reparse, we haven't changed the
15768                                                outer one */
15769
15770             /* Use a smaller max edit distance if we are missing one of the
15771              * delimiters */
15772             if (   has_opening_bracket + has_opening_colon < 2
15773                 || has_terminating_bracket + has_terminating_colon < 2)
15774             {
15775                 temp_max--;
15776             }
15777
15778             /* See if the input name is close to a legal one */
15779             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
15780
15781                 /* Short circuit call if the lengths are too far apart to be
15782                  * able to match */
15783                 if (abs( (int) (name_len - posix_name_lengths[i]))
15784                     > temp_max)
15785                 {
15786                     continue;
15787                 }
15788
15789                 if (edit_distance(input_text,
15790                                   posix_names[i],
15791                                   name_len,
15792                                   posix_name_lengths[i],
15793                                   temp_max
15794                                  )
15795                     > -1)
15796                 { /* If it is close, it probably was intended to be a class */
15797                     goto probably_meant_to_be;
15798                 }
15799             }
15800
15801             /* Here the input name is not close enough to a valid class name
15802              * for us to consider it to be intended to be a posix class.  If
15803              * we haven't already done so, and the parse found a character that
15804              * could have been terminators for the name, but which we absorbed
15805              * as typos during the first pass, repeat the parse, signalling it
15806              * to stop at that character */
15807             if (possible_end && possible_end != (char *) -1) {
15808                 possible_end = (char *) -1;
15809                 p = name_start;
15810                 goto parse_name;
15811             }
15812
15813             /* Here neither pass found a close-enough class name */
15814             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15815         }
15816
15817     probably_meant_to_be:
15818
15819         /* Here we think that a posix specification was intended.  Update any
15820          * parse pointer */
15821         if (updated_parse_ptr) {
15822             *updated_parse_ptr = (char *) p;
15823         }
15824
15825         /* If a posix class name was intended but incorrectly specified, we
15826          * output or return the warnings */
15827         if (found_problem) {
15828
15829             /* We set flags for these issues in the parse loop above instead of
15830              * adding them to the list of warnings, because we can parse it
15831              * twice, and we only want one warning instance */
15832             if (has_upper) {
15833                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
15834             }
15835             if (has_blank) {
15836                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15837             }
15838             if (has_semi_colon) {
15839                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15840             }
15841             else if (! has_terminating_colon) {
15842                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
15843             }
15844             if (! has_terminating_bracket) {
15845                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
15846             }
15847
15848             if (   posix_warnings
15849                 && RExC_warn_text
15850                 && av_top_index(RExC_warn_text) > -1)
15851             {
15852                 *posix_warnings = RExC_warn_text;
15853             }
15854         }
15855         else if (class_number != OOB_NAMEDCLASS) {
15856             /* If it is a known class, return the class.  The class number
15857              * #defines are structured so each complement is +1 to the normal
15858              * one */
15859             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
15860         }
15861         else if (! check_only) {
15862
15863             /* Here, it is an unrecognized class.  This is an error (unless the
15864             * call is to check only, which we've already handled above) */
15865             const char * const complement_string = (complement)
15866                                                    ? "^"
15867                                                    : "";
15868             RExC_parse = (char *) p;
15869             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
15870                         complement_string,
15871                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
15872         }
15873     }
15874
15875     return OOB_NAMEDCLASS;
15876 }
15877 #undef ADD_POSIX_WARNING
15878
15879 STATIC unsigned  int
15880 S_regex_set_precedence(const U8 my_operator) {
15881
15882     /* Returns the precedence in the (?[...]) construct of the input operator,
15883      * specified by its character representation.  The precedence follows
15884      * general Perl rules, but it extends this so that ')' and ']' have (low)
15885      * precedence even though they aren't really operators */
15886
15887     switch (my_operator) {
15888         case '!':
15889             return 5;
15890         case '&':
15891             return 4;
15892         case '^':
15893         case '|':
15894         case '+':
15895         case '-':
15896             return 3;
15897         case ')':
15898             return 2;
15899         case ']':
15900             return 1;
15901     }
15902
15903     NOT_REACHED; /* NOTREACHED */
15904     return 0;   /* Silence compiler warning */
15905 }
15906
15907 STATIC regnode_offset
15908 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
15909                     I32 *flagp, U32 depth,
15910                     char * const oregcomp_parse)
15911 {
15912     /* Handle the (?[...]) construct to do set operations */
15913
15914     U8 curchar;                     /* Current character being parsed */
15915     UV start, end;                  /* End points of code point ranges */
15916     SV* final = NULL;               /* The end result inversion list */
15917     SV* result_string;              /* 'final' stringified */
15918     AV* stack;                      /* stack of operators and operands not yet
15919                                        resolved */
15920     AV* fence_stack = NULL;         /* A stack containing the positions in
15921                                        'stack' of where the undealt-with left
15922                                        parens would be if they were actually
15923                                        put there */
15924     /* The 'volatile' is a workaround for an optimiser bug
15925      * in Solaris Studio 12.3. See RT #127455 */
15926     volatile IV fence = 0;          /* Position of where most recent undealt-
15927                                        with left paren in stack is; -1 if none.
15928                                      */
15929     STRLEN len;                     /* Temporary */
15930     regnode_offset node;                  /* Temporary, and final regnode returned by
15931                                        this function */
15932     const bool save_fold = FOLD;    /* Temporary */
15933     char *save_end, *save_parse;    /* Temporaries */
15934     const bool in_locale = LOC;     /* we turn off /l during processing */
15935
15936     GET_RE_DEBUG_FLAGS_DECL;
15937
15938     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
15939
15940     DEBUG_PARSE("xcls");
15941
15942     if (in_locale) {
15943         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
15944     }
15945
15946     /* The use of this operator implies /u.  This is required so that the
15947      * compile time values are valid in all runtime cases */
15948     REQUIRE_UNI_RULES(flagp, 0);
15949
15950     ckWARNexperimental(RExC_parse,
15951                        WARN_EXPERIMENTAL__REGEX_SETS,
15952                        "The regex_sets feature is experimental");
15953
15954     /* Everything in this construct is a metacharacter.  Operands begin with
15955      * either a '\' (for an escape sequence), or a '[' for a bracketed
15956      * character class.  Any other character should be an operator, or
15957      * parenthesis for grouping.  Both types of operands are handled by calling
15958      * regclass() to parse them.  It is called with a parameter to indicate to
15959      * return the computed inversion list.  The parsing here is implemented via
15960      * a stack.  Each entry on the stack is a single character representing one
15961      * of the operators; or else a pointer to an operand inversion list. */
15962
15963 #define IS_OPERATOR(a) SvIOK(a)
15964 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15965
15966     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15967      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15968      * with pronouncing it called it Reverse Polish instead, but now that YOU
15969      * know how to pronounce it you can use the correct term, thus giving due
15970      * credit to the person who invented it, and impressing your geek friends.
15971      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15972      * it is now more like an English initial W (as in wonk) than an L.)
15973      *
15974      * This means that, for example, 'a | b & c' is stored on the stack as
15975      *
15976      * c  [4]
15977      * b  [3]
15978      * &  [2]
15979      * a  [1]
15980      * |  [0]
15981      *
15982      * where the numbers in brackets give the stack [array] element number.
15983      * In this implementation, parentheses are not stored on the stack.
15984      * Instead a '(' creates a "fence" so that the part of the stack below the
15985      * fence is invisible except to the corresponding ')' (this allows us to
15986      * replace testing for parens, by using instead subtraction of the fence
15987      * position).  As new operands are processed they are pushed onto the stack
15988      * (except as noted in the next paragraph).  New operators of higher
15989      * precedence than the current final one are inserted on the stack before
15990      * the lhs operand (so that when the rhs is pushed next, everything will be
15991      * in the correct positions shown above.  When an operator of equal or
15992      * lower precedence is encountered in parsing, all the stacked operations
15993      * of equal or higher precedence are evaluated, leaving the result as the
15994      * top entry on the stack.  This makes higher precedence operations
15995      * evaluate before lower precedence ones, and causes operations of equal
15996      * precedence to left associate.
15997      *
15998      * The only unary operator '!' is immediately pushed onto the stack when
15999      * encountered.  When an operand is encountered, if the top of the stack is
16000      * a '!", the complement is immediately performed, and the '!' popped.  The
16001      * resulting value is treated as a new operand, and the logic in the
16002      * previous paragraph is executed.  Thus in the expression
16003      *      [a] + ! [b]
16004      * the stack looks like
16005      *
16006      * !
16007      * a
16008      * +
16009      *
16010      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
16011      * becomes
16012      *
16013      * !b
16014      * a
16015      * +
16016      *
16017      * A ')' is treated as an operator with lower precedence than all the
16018      * aforementioned ones, which causes all operations on the stack above the
16019      * corresponding '(' to be evaluated down to a single resultant operand.
16020      * Then the fence for the '(' is removed, and the operand goes through the
16021      * algorithm above, without the fence.
16022      *
16023      * A separate stack is kept of the fence positions, so that the position of
16024      * the latest so-far unbalanced '(' is at the top of it.
16025      *
16026      * The ']' ending the construct is treated as the lowest operator of all,
16027      * so that everything gets evaluated down to a single operand, which is the
16028      * result */
16029
16030     sv_2mortal((SV *)(stack = newAV()));
16031     sv_2mortal((SV *)(fence_stack = newAV()));
16032
16033     while (RExC_parse < RExC_end) {
16034         I32 top_index;              /* Index of top-most element in 'stack' */
16035         SV** top_ptr;               /* Pointer to top 'stack' element */
16036         SV* current = NULL;         /* To contain the current inversion list
16037                                        operand */
16038         SV* only_to_avoid_leaks;
16039
16040         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
16041                                 TRUE /* Force /x */ );
16042         if (RExC_parse >= RExC_end) {   /* Fail */
16043             break;
16044         }
16045
16046         curchar = UCHARAT(RExC_parse);
16047
16048 redo_curchar:
16049
16050 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16051                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
16052         DEBUG_U(dump_regex_sets_structures(pRExC_state,
16053                                            stack, fence, fence_stack));
16054 #endif
16055
16056         top_index = av_tindex_skip_len_mg(stack);
16057
16058         switch (curchar) {
16059             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
16060             char stacked_operator;  /* The topmost operator on the 'stack'. */
16061             SV* lhs;                /* Operand to the left of the operator */
16062             SV* rhs;                /* Operand to the right of the operator */
16063             SV* fence_ptr;          /* Pointer to top element of the fence
16064                                        stack */
16065
16066             case '(':
16067
16068                 if (   RExC_parse < RExC_end - 2
16069                     && UCHARAT(RExC_parse + 1) == '?'
16070                     && UCHARAT(RExC_parse + 2) == '^')
16071                 {
16072                     /* If is a '(?', could be an embedded '(?^flags:(?[...])'.
16073                      * This happens when we have some thing like
16074                      *
16075                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
16076                      *   ...
16077                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
16078                      *
16079                      * Here we would be handling the interpolated
16080                      * '$thai_or_lao'.  We handle this by a recursive call to
16081                      * ourselves which returns the inversion list the
16082                      * interpolated expression evaluates to.  We use the flags
16083                      * from the interpolated pattern. */
16084                     U32 save_flags = RExC_flags;
16085                     const char * save_parse;
16086
16087                     RExC_parse += 2;        /* Skip past the '(?' */
16088                     save_parse = RExC_parse;
16089
16090                     /* Parse the flags for the '(?'.  We already know the first
16091                      * flag to parse is a '^' */
16092                     parse_lparen_question_flags(pRExC_state);
16093
16094                     if (   RExC_parse >= RExC_end - 4
16095                         || UCHARAT(RExC_parse) != ':'
16096                         || UCHARAT(++RExC_parse) != '('
16097                         || UCHARAT(++RExC_parse) != '?'
16098                         || UCHARAT(++RExC_parse) != '[')
16099                     {
16100
16101                         /* In combination with the above, this moves the
16102                          * pointer to the point just after the first erroneous
16103                          * character. */
16104                         if (RExC_parse >= RExC_end - 4) {
16105                             RExC_parse = RExC_end;
16106                         }
16107                         else if (RExC_parse != save_parse) {
16108                             RExC_parse += (UTF)
16109                                           ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
16110                                           : 1;
16111                         }
16112                         vFAIL("Expecting '(?flags:(?[...'");
16113                     }
16114
16115                     /* Recurse, with the meat of the embedded expression */
16116                     RExC_parse++;
16117                     (void) handle_regex_sets(pRExC_state, &current, flagp,
16118                                                     depth+1, oregcomp_parse);
16119
16120                     /* Here, 'current' contains the embedded expression's
16121                      * inversion list, and RExC_parse points to the trailing
16122                      * ']'; the next character should be the ')' */
16123                     RExC_parse++;
16124                     if (UCHARAT(RExC_parse) != ')')
16125                         vFAIL("Expecting close paren for nested extended charclass");
16126
16127                     /* Then the ')' matching the original '(' handled by this
16128                      * case: statement */
16129                     RExC_parse++;
16130                     if (UCHARAT(RExC_parse) != ')')
16131                         vFAIL("Expecting close paren for wrapper for nested extended charclass");
16132
16133                     RExC_flags = save_flags;
16134                     goto handle_operand;
16135                 }
16136
16137                 /* A regular '('.  Look behind for illegal syntax */
16138                 if (top_index - fence >= 0) {
16139                     /* If the top entry on the stack is an operator, it had
16140                      * better be a '!', otherwise the entry below the top
16141                      * operand should be an operator */
16142                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
16143                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
16144                         || (   IS_OPERAND(*top_ptr)
16145                             && (   top_index - fence < 1
16146                                 || ! (stacked_ptr = av_fetch(stack,
16147                                                              top_index - 1,
16148                                                              FALSE))
16149                                 || ! IS_OPERATOR(*stacked_ptr))))
16150                     {
16151                         RExC_parse++;
16152                         vFAIL("Unexpected '(' with no preceding operator");
16153                     }
16154                 }
16155
16156                 /* Stack the position of this undealt-with left paren */
16157                 av_push(fence_stack, newSViv(fence));
16158                 fence = top_index + 1;
16159                 break;
16160
16161             case '\\':
16162                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
16163                  * multi-char folds are allowed.  */
16164                 if (!regclass(pRExC_state, flagp, depth+1,
16165                               TRUE, /* means parse just the next thing */
16166                               FALSE, /* don't allow multi-char folds */
16167                               FALSE, /* don't silence non-portable warnings.  */
16168                               TRUE,  /* strict */
16169                               FALSE, /* Require return to be an ANYOF */
16170                               &current))
16171                 {
16172                     goto regclass_failed;
16173                 }
16174
16175                 /* regclass() will return with parsing just the \ sequence,
16176                  * leaving the parse pointer at the next thing to parse */
16177                 RExC_parse--;
16178                 goto handle_operand;
16179
16180             case '[':   /* Is a bracketed character class */
16181             {
16182                 /* See if this is a [:posix:] class. */
16183                 bool is_posix_class = (OOB_NAMEDCLASS
16184                             < handle_possible_posix(pRExC_state,
16185                                                 RExC_parse + 1,
16186                                                 NULL,
16187                                                 NULL,
16188                                                 TRUE /* checking only */));
16189                 /* If it is a posix class, leave the parse pointer at the '['
16190                  * to fool regclass() into thinking it is part of a
16191                  * '[[:posix:]]'. */
16192                 if (! is_posix_class) {
16193                     RExC_parse++;
16194                 }
16195
16196                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
16197                  * multi-char folds are allowed.  */
16198                 if (!regclass(pRExC_state, flagp, depth+1,
16199                                 is_posix_class, /* parse the whole char
16200                                                     class only if not a
16201                                                     posix class */
16202                                 FALSE, /* don't allow multi-char folds */
16203                                 TRUE, /* silence non-portable warnings. */
16204                                 TRUE, /* strict */
16205                                 FALSE, /* Require return to be an ANYOF */
16206                                 &current))
16207                 {
16208                     goto regclass_failed;
16209                 }
16210
16211                 if (! current) {
16212                     break;
16213                 }
16214
16215                 /* function call leaves parse pointing to the ']', except if we
16216                  * faked it */
16217                 if (is_posix_class) {
16218                     RExC_parse--;
16219                 }
16220
16221                 goto handle_operand;
16222             }
16223
16224             case ']':
16225                 if (top_index >= 1) {
16226                     goto join_operators;
16227                 }
16228
16229                 /* Only a single operand on the stack: are done */
16230                 goto done;
16231
16232             case ')':
16233                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
16234                     if (UCHARAT(RExC_parse - 1) == ']')  {
16235                         break;
16236                     }
16237                     RExC_parse++;
16238                     vFAIL("Unexpected ')'");
16239                 }
16240
16241                 /* If nothing after the fence, is missing an operand */
16242                 if (top_index - fence < 0) {
16243                     RExC_parse++;
16244                     goto bad_syntax;
16245                 }
16246                 /* If at least two things on the stack, treat this as an
16247                   * operator */
16248                 if (top_index - fence >= 1) {
16249                     goto join_operators;
16250                 }
16251
16252                 /* Here only a single thing on the fenced stack, and there is a
16253                  * fence.  Get rid of it */
16254                 fence_ptr = av_pop(fence_stack);
16255                 assert(fence_ptr);
16256                 fence = SvIV(fence_ptr);
16257                 SvREFCNT_dec_NN(fence_ptr);
16258                 fence_ptr = NULL;
16259
16260                 if (fence < 0) {
16261                     fence = 0;
16262                 }
16263
16264                 /* Having gotten rid of the fence, we pop the operand at the
16265                  * stack top and process it as a newly encountered operand */
16266                 current = av_pop(stack);
16267                 if (IS_OPERAND(current)) {
16268                     goto handle_operand;
16269                 }
16270
16271                 RExC_parse++;
16272                 goto bad_syntax;
16273
16274             case '&':
16275             case '|':
16276             case '+':
16277             case '-':
16278             case '^':
16279
16280                 /* These binary operators should have a left operand already
16281                  * parsed */
16282                 if (   top_index - fence < 0
16283                     || top_index - fence == 1
16284                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
16285                     || ! IS_OPERAND(*top_ptr))
16286                 {
16287                     goto unexpected_binary;
16288                 }
16289
16290                 /* If only the one operand is on the part of the stack visible
16291                  * to us, we just place this operator in the proper position */
16292                 if (top_index - fence < 2) {
16293
16294                     /* Place the operator before the operand */
16295
16296                     SV* lhs = av_pop(stack);
16297                     av_push(stack, newSVuv(curchar));
16298                     av_push(stack, lhs);
16299                     break;
16300                 }
16301
16302                 /* But if there is something else on the stack, we need to
16303                  * process it before this new operator if and only if the
16304                  * stacked operation has equal or higher precedence than the
16305                  * new one */
16306
16307              join_operators:
16308
16309                 /* The operator on the stack is supposed to be below both its
16310                  * operands */
16311                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
16312                     || IS_OPERAND(*stacked_ptr))
16313                 {
16314                     /* But if not, it's legal and indicates we are completely
16315                      * done if and only if we're currently processing a ']',
16316                      * which should be the final thing in the expression */
16317                     if (curchar == ']') {
16318                         goto done;
16319                     }
16320
16321                   unexpected_binary:
16322                     RExC_parse++;
16323                     vFAIL2("Unexpected binary operator '%c' with no "
16324                            "preceding operand", curchar);
16325                 }
16326                 stacked_operator = (char) SvUV(*stacked_ptr);
16327
16328                 if (regex_set_precedence(curchar)
16329                     > regex_set_precedence(stacked_operator))
16330                 {
16331                     /* Here, the new operator has higher precedence than the
16332                      * stacked one.  This means we need to add the new one to
16333                      * the stack to await its rhs operand (and maybe more
16334                      * stuff).  We put it before the lhs operand, leaving
16335                      * untouched the stacked operator and everything below it
16336                      * */
16337                     lhs = av_pop(stack);
16338                     assert(IS_OPERAND(lhs));
16339
16340                     av_push(stack, newSVuv(curchar));
16341                     av_push(stack, lhs);
16342                     break;
16343                 }
16344
16345                 /* Here, the new operator has equal or lower precedence than
16346                  * what's already there.  This means the operation already
16347                  * there should be performed now, before the new one. */
16348
16349                 rhs = av_pop(stack);
16350                 if (! IS_OPERAND(rhs)) {
16351
16352                     /* This can happen when a ! is not followed by an operand,
16353                      * like in /(?[\t &!])/ */
16354                     goto bad_syntax;
16355                 }
16356
16357                 lhs = av_pop(stack);
16358
16359                 if (! IS_OPERAND(lhs)) {
16360
16361                     /* This can happen when there is an empty (), like in
16362                      * /(?[[0]+()+])/ */
16363                     goto bad_syntax;
16364                 }
16365
16366                 switch (stacked_operator) {
16367                     case '&':
16368                         _invlist_intersection(lhs, rhs, &rhs);
16369                         break;
16370
16371                     case '|':
16372                     case '+':
16373                         _invlist_union(lhs, rhs, &rhs);
16374                         break;
16375
16376                     case '-':
16377                         _invlist_subtract(lhs, rhs, &rhs);
16378                         break;
16379
16380                     case '^':   /* The union minus the intersection */
16381                     {
16382                         SV* i = NULL;
16383                         SV* u = NULL;
16384
16385                         _invlist_union(lhs, rhs, &u);
16386                         _invlist_intersection(lhs, rhs, &i);
16387                         _invlist_subtract(u, i, &rhs);
16388                         SvREFCNT_dec_NN(i);
16389                         SvREFCNT_dec_NN(u);
16390                         break;
16391                     }
16392                 }
16393                 SvREFCNT_dec(lhs);
16394
16395                 /* Here, the higher precedence operation has been done, and the
16396                  * result is in 'rhs'.  We overwrite the stacked operator with
16397                  * the result.  Then we redo this code to either push the new
16398                  * operator onto the stack or perform any higher precedence
16399                  * stacked operation */
16400                 only_to_avoid_leaks = av_pop(stack);
16401                 SvREFCNT_dec(only_to_avoid_leaks);
16402                 av_push(stack, rhs);
16403                 goto redo_curchar;
16404
16405             case '!':   /* Highest priority, right associative */
16406
16407                 /* If what's already at the top of the stack is another '!",
16408                  * they just cancel each other out */
16409                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
16410                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
16411                 {
16412                     only_to_avoid_leaks = av_pop(stack);
16413                     SvREFCNT_dec(only_to_avoid_leaks);
16414                 }
16415                 else { /* Otherwise, since it's right associative, just push
16416                           onto the stack */
16417                     av_push(stack, newSVuv(curchar));
16418                 }
16419                 break;
16420
16421             default:
16422                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16423                 if (RExC_parse >= RExC_end) {
16424                     break;
16425                 }
16426                 vFAIL("Unexpected character");
16427
16428           handle_operand:
16429
16430             /* Here 'current' is the operand.  If something is already on the
16431              * stack, we have to check if it is a !.  But first, the code above
16432              * may have altered the stack in the time since we earlier set
16433              * 'top_index'.  */
16434
16435             top_index = av_tindex_skip_len_mg(stack);
16436             if (top_index - fence >= 0) {
16437                 /* If the top entry on the stack is an operator, it had better
16438                  * be a '!', otherwise the entry below the top operand should
16439                  * be an operator */
16440                 top_ptr = av_fetch(stack, top_index, FALSE);
16441                 assert(top_ptr);
16442                 if (IS_OPERATOR(*top_ptr)) {
16443
16444                     /* The only permissible operator at the top of the stack is
16445                      * '!', which is applied immediately to this operand. */
16446                     curchar = (char) SvUV(*top_ptr);
16447                     if (curchar != '!') {
16448                         SvREFCNT_dec(current);
16449                         vFAIL2("Unexpected binary operator '%c' with no "
16450                                 "preceding operand", curchar);
16451                     }
16452
16453                     _invlist_invert(current);
16454
16455                     only_to_avoid_leaks = av_pop(stack);
16456                     SvREFCNT_dec(only_to_avoid_leaks);
16457
16458                     /* And we redo with the inverted operand.  This allows
16459                      * handling multiple ! in a row */
16460                     goto handle_operand;
16461                 }
16462                           /* Single operand is ok only for the non-binary ')'
16463                            * operator */
16464                 else if ((top_index - fence == 0 && curchar != ')')
16465                          || (top_index - fence > 0
16466                              && (! (stacked_ptr = av_fetch(stack,
16467                                                            top_index - 1,
16468                                                            FALSE))
16469                                  || IS_OPERAND(*stacked_ptr))))
16470                 {
16471                     SvREFCNT_dec(current);
16472                     vFAIL("Operand with no preceding operator");
16473                 }
16474             }
16475
16476             /* Here there was nothing on the stack or the top element was
16477              * another operand.  Just add this new one */
16478             av_push(stack, current);
16479
16480         } /* End of switch on next parse token */
16481
16482         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16483     } /* End of loop parsing through the construct */
16484
16485     vFAIL("Syntax error in (?[...])");
16486
16487   done:
16488
16489     if (RExC_parse >= RExC_end || RExC_parse[1] != ')') {
16490         if (RExC_parse < RExC_end) {
16491             RExC_parse++;
16492         }
16493
16494         vFAIL("Unexpected ']' with no following ')' in (?[...");
16495     }
16496
16497     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
16498         vFAIL("Unmatched (");
16499     }
16500
16501     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
16502         || ((final = av_pop(stack)) == NULL)
16503         || ! IS_OPERAND(final)
16504         || ! is_invlist(final)
16505         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
16506     {
16507       bad_syntax:
16508         SvREFCNT_dec(final);
16509         vFAIL("Incomplete expression within '(?[ ])'");
16510     }
16511
16512     /* Here, 'final' is the resultant inversion list from evaluating the
16513      * expression.  Return it if so requested */
16514     if (return_invlist) {
16515         *return_invlist = final;
16516         return END;
16517     }
16518
16519     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
16520      * expecting a string of ranges and individual code points */
16521     invlist_iterinit(final);
16522     result_string = newSVpvs("");
16523     while (invlist_iternext(final, &start, &end)) {
16524         if (start == end) {
16525             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
16526         }
16527         else {
16528             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
16529                                                      start,          end);
16530         }
16531     }
16532
16533     /* About to generate an ANYOF (or similar) node from the inversion list we
16534      * have calculated */
16535     save_parse = RExC_parse;
16536     RExC_parse = SvPV(result_string, len);
16537     save_end = RExC_end;
16538     RExC_end = RExC_parse + len;
16539     TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
16540
16541     /* We turn off folding around the call, as the class we have constructed
16542      * already has all folding taken into consideration, and we don't want
16543      * regclass() to add to that */
16544     RExC_flags &= ~RXf_PMf_FOLD;
16545     /* regclass() can only return RESTART_PARSE and NEED_UTF8 if multi-char
16546      * folds are allowed.  */
16547     node = regclass(pRExC_state, flagp, depth+1,
16548                     FALSE, /* means parse the whole char class */
16549                     FALSE, /* don't allow multi-char folds */
16550                     TRUE, /* silence non-portable warnings.  The above may very
16551                              well have generated non-portable code points, but
16552                              they're valid on this machine */
16553                     FALSE, /* similarly, no need for strict */
16554                     FALSE, /* Require return to be an ANYOF */
16555                     NULL
16556                 );
16557
16558     RESTORE_WARNINGS;
16559     RExC_parse = save_parse + 1;
16560     RExC_end = save_end;
16561     SvREFCNT_dec_NN(final);
16562     SvREFCNT_dec_NN(result_string);
16563
16564     if (save_fold) {
16565         RExC_flags |= RXf_PMf_FOLD;
16566     }
16567
16568     if (!node)
16569         goto regclass_failed;
16570
16571     /* Fix up the node type if we are in locale.  (We have pretended we are
16572      * under /u for the purposes of regclass(), as this construct will only
16573      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
16574      * as to cause any warnings about bad locales to be output in regexec.c),
16575      * and add the flag that indicates to check if not in a UTF-8 locale.  The
16576      * reason we above forbid optimization into something other than an ANYOF
16577      * node is simply to minimize the number of code changes in regexec.c.
16578      * Otherwise we would have to create new EXACTish node types and deal with
16579      * them.  This decision could be revisited should this construct become
16580      * popular.
16581      *
16582      * (One might think we could look at the resulting ANYOF node and suppress
16583      * the flag if everything is above 255, as those would be UTF-8 only,
16584      * but this isn't true, as the components that led to that result could
16585      * have been locale-affected, and just happen to cancel each other out
16586      * under UTF-8 locales.) */
16587     if (in_locale) {
16588         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
16589
16590         assert(OP(REGNODE_p(node)) == ANYOF);
16591
16592         OP(REGNODE_p(node)) = ANYOFL;
16593         ANYOF_FLAGS(REGNODE_p(node))
16594                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
16595     }
16596
16597     nextchar(pRExC_state);
16598     Set_Node_Length(REGNODE_p(node), RExC_parse - oregcomp_parse + 1); /* MJD */
16599     return node;
16600
16601   regclass_failed:
16602     FAIL2("panic: regclass returned failure to handle_sets, " "flags=%#" UVxf,
16603                                                                 (UV) *flagp);
16604 }
16605
16606 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16607
16608 STATIC void
16609 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
16610                              AV * stack, const IV fence, AV * fence_stack)
16611 {   /* Dumps the stacks in handle_regex_sets() */
16612
16613     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
16614     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
16615     SSize_t i;
16616
16617     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
16618
16619     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
16620
16621     if (stack_top < 0) {
16622         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
16623     }
16624     else {
16625         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
16626         for (i = stack_top; i >= 0; i--) {
16627             SV ** element_ptr = av_fetch(stack, i, FALSE);
16628             if (! element_ptr) {
16629             }
16630
16631             if (IS_OPERATOR(*element_ptr)) {
16632                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
16633                                             (int) i, (int) SvIV(*element_ptr));
16634             }
16635             else {
16636                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
16637                 sv_dump(*element_ptr);
16638             }
16639         }
16640     }
16641
16642     if (fence_stack_top < 0) {
16643         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
16644     }
16645     else {
16646         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
16647         for (i = fence_stack_top; i >= 0; i--) {
16648             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
16649             if (! element_ptr) {
16650             }
16651
16652             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
16653                                             (int) i, (int) SvIV(*element_ptr));
16654         }
16655     }
16656 }
16657
16658 #endif
16659
16660 #undef IS_OPERATOR
16661 #undef IS_OPERAND
16662
16663 STATIC void
16664 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
16665 {
16666     /* This adds the Latin1/above-Latin1 folding rules.
16667      *
16668      * This should be called only for a Latin1-range code points, cp, which is
16669      * known to be involved in a simple fold with other code points above
16670      * Latin1.  It would give false results if /aa has been specified.
16671      * Multi-char folds are outside the scope of this, and must be handled
16672      * specially. */
16673
16674     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
16675
16676     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
16677
16678     /* The rules that are valid for all Unicode versions are hard-coded in */
16679     switch (cp) {
16680         case 'k':
16681         case 'K':
16682           *invlist =
16683              add_cp_to_invlist(*invlist, KELVIN_SIGN);
16684             break;
16685         case 's':
16686         case 'S':
16687           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
16688             break;
16689         case MICRO_SIGN:
16690           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
16691           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
16692             break;
16693         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
16694         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
16695           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
16696             break;
16697         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
16698           *invlist = add_cp_to_invlist(*invlist,
16699                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
16700             break;
16701
16702         default:    /* Other code points are checked against the data for the
16703                        current Unicode version */
16704           {
16705             Size_t folds_count;
16706             unsigned int first_fold;
16707             const unsigned int * remaining_folds;
16708             UV folded_cp;
16709
16710             if (isASCII(cp)) {
16711                 folded_cp = toFOLD(cp);
16712             }
16713             else {
16714                 U8 dummy_fold[UTF8_MAXBYTES_CASE+1];
16715                 Size_t dummy_len;
16716                 folded_cp = _to_fold_latin1(cp, dummy_fold, &dummy_len, 0);
16717             }
16718
16719             if (folded_cp > 255) {
16720                 *invlist = add_cp_to_invlist(*invlist, folded_cp);
16721             }
16722
16723             folds_count = _inverse_folds(folded_cp, &first_fold,
16724                                                     &remaining_folds);
16725             if (folds_count == 0) {
16726
16727                 /* Use deprecated warning to increase the chances of this being
16728                  * output */
16729                 ckWARN2reg_d(RExC_parse,
16730                         "Perl folding rules are not up-to-date for 0x%02X;"
16731                         " please use the perlbug utility to report;", cp);
16732             }
16733             else {
16734                 unsigned int i;
16735
16736                 if (first_fold > 255) {
16737                     *invlist = add_cp_to_invlist(*invlist, first_fold);
16738                 }
16739                 for (i = 0; i < folds_count - 1; i++) {
16740                     if (remaining_folds[i] > 255) {
16741                         *invlist = add_cp_to_invlist(*invlist,
16742                                                     remaining_folds[i]);
16743                     }
16744                 }
16745             }
16746             break;
16747          }
16748     }
16749 }
16750
16751 STATIC void
16752 S_output_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings)
16753 {
16754     /* Output the elements of the array given by '*posix_warnings' as REGEXP
16755      * warnings. */
16756
16757     SV * msg;
16758     const bool first_is_fatal = ckDEAD(packWARN(WARN_REGEXP));
16759
16760     PERL_ARGS_ASSERT_OUTPUT_POSIX_WARNINGS;
16761
16762     if (! TO_OUTPUT_WARNINGS(RExC_parse)) {
16763         return;
16764     }
16765
16766     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
16767         if (first_is_fatal) {           /* Avoid leaking this */
16768             av_undef(posix_warnings);   /* This isn't necessary if the
16769                                             array is mortal, but is a
16770                                             fail-safe */
16771             (void) sv_2mortal(msg);
16772             PREPARE_TO_DIE;
16773         }
16774         Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
16775         SvREFCNT_dec_NN(msg);
16776     }
16777
16778     UPDATE_WARNINGS_LOC(RExC_parse);
16779 }
16780
16781 STATIC AV *
16782 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
16783 {
16784     /* This adds the string scalar <multi_string> to the array
16785      * <multi_char_matches>.  <multi_string> is known to have exactly
16786      * <cp_count> code points in it.  This is used when constructing a
16787      * bracketed character class and we find something that needs to match more
16788      * than a single character.
16789      *
16790      * <multi_char_matches> is actually an array of arrays.  Each top-level
16791      * element is an array that contains all the strings known so far that are
16792      * the same length.  And that length (in number of code points) is the same
16793      * as the index of the top-level array.  Hence, the [2] element is an
16794      * array, each element thereof is a string containing TWO code points;
16795      * while element [3] is for strings of THREE characters, and so on.  Since
16796      * this is for multi-char strings there can never be a [0] nor [1] element.
16797      *
16798      * When we rewrite the character class below, we will do so such that the
16799      * longest strings are written first, so that it prefers the longest
16800      * matching strings first.  This is done even if it turns out that any
16801      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
16802      * Christiansen has agreed that this is ok.  This makes the test for the
16803      * ligature 'ffi' come before the test for 'ff', for example */
16804
16805     AV* this_array;
16806     AV** this_array_ptr;
16807
16808     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
16809
16810     if (! multi_char_matches) {
16811         multi_char_matches = newAV();
16812     }
16813
16814     if (av_exists(multi_char_matches, cp_count)) {
16815         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
16816         this_array = *this_array_ptr;
16817     }
16818     else {
16819         this_array = newAV();
16820         av_store(multi_char_matches, cp_count,
16821                  (SV*) this_array);
16822     }
16823     av_push(this_array, multi_string);
16824
16825     return multi_char_matches;
16826 }
16827
16828 /* The names of properties whose definitions are not known at compile time are
16829  * stored in this SV, after a constant heading.  So if the length has been
16830  * changed since initialization, then there is a run-time definition. */
16831 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
16832                                         (SvCUR(listsv) != initial_listsv_len)
16833
16834 /* There is a restricted set of white space characters that are legal when
16835  * ignoring white space in a bracketed character class.  This generates the
16836  * code to skip them.
16837  *
16838  * There is a line below that uses the same white space criteria but is outside
16839  * this macro.  Both here and there must use the same definition */
16840 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
16841     STMT_START {                                                        \
16842         if (do_skip) {                                                  \
16843             while (isBLANK_A(UCHARAT(p)))                               \
16844             {                                                           \
16845                 p++;                                                    \
16846             }                                                           \
16847         }                                                               \
16848     } STMT_END
16849
16850 STATIC regnode_offset
16851 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
16852                  const bool stop_at_1,  /* Just parse the next thing, don't
16853                                            look for a full character class */
16854                  bool allow_mutiple_chars,
16855                  const bool silence_non_portable,   /* Don't output warnings
16856                                                        about too large
16857                                                        characters */
16858                  const bool strict,
16859                  bool optimizable,                  /* ? Allow a non-ANYOF return
16860                                                        node */
16861                  SV** ret_invlist  /* Return an inversion list, not a node */
16862           )
16863 {
16864     /* parse a bracketed class specification.  Most of these will produce an
16865      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
16866      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
16867      * under /i with multi-character folds: it will be rewritten following the
16868      * paradigm of this example, where the <multi-fold>s are characters which
16869      * fold to multiple character sequences:
16870      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
16871      * gets effectively rewritten as:
16872      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
16873      * reg() gets called (recursively) on the rewritten version, and this
16874      * function will return what it constructs.  (Actually the <multi-fold>s
16875      * aren't physically removed from the [abcdefghi], it's just that they are
16876      * ignored in the recursion by means of a flag:
16877      * <RExC_in_multi_char_class>.)
16878      *
16879      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
16880      * characters, with the corresponding bit set if that character is in the
16881      * list.  For characters above this, an inversion list is used.  There
16882      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
16883      * determinable at compile time
16884      *
16885      * On success, returns the offset at which any next node should be placed
16886      * into the regex engine program being compiled.
16887      *
16888      * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
16889      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
16890      * UTF-8
16891      */
16892
16893     dVAR;
16894     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
16895     IV range = 0;
16896     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
16897     regnode_offset ret = -1;    /* Initialized to an illegal value */
16898     STRLEN numlen;
16899     int namedclass = OOB_NAMEDCLASS;
16900     char *rangebegin = NULL;
16901     SV *listsv = NULL;      /* List of \p{user-defined} whose definitions
16902                                aren't available at the time this was called */
16903     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
16904                                       than just initialized.  */
16905     SV* properties = NULL;    /* Code points that match \p{} \P{} */
16906     SV* posixes = NULL;     /* Code points that match classes like [:word:],
16907                                extended beyond the Latin1 range.  These have to
16908                                be kept separate from other code points for much
16909                                of this function because their handling  is
16910                                different under /i, and for most classes under
16911                                /d as well */
16912     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
16913                                separate for a while from the non-complemented
16914                                versions because of complications with /d
16915                                matching */
16916     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
16917                                   treated more simply than the general case,
16918                                   leading to less compilation and execution
16919                                   work */
16920     UV element_count = 0;   /* Number of distinct elements in the class.
16921                                Optimizations may be possible if this is tiny */
16922     AV * multi_char_matches = NULL; /* Code points that fold to more than one
16923                                        character; used under /i */
16924     UV n;
16925     char * stop_ptr = RExC_end;    /* where to stop parsing */
16926
16927     /* ignore unescaped whitespace? */
16928     const bool skip_white = cBOOL(   ret_invlist
16929                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
16930
16931     /* inversion list of code points this node matches only when the target
16932      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
16933      * /d) */
16934     SV* upper_latin1_only_utf8_matches = NULL;
16935
16936     /* Inversion list of code points this node matches regardless of things
16937      * like locale, folding, utf8ness of the target string */
16938     SV* cp_list = NULL;
16939
16940     /* Like cp_list, but code points on this list need to be checked for things
16941      * that fold to/from them under /i */
16942     SV* cp_foldable_list = NULL;
16943
16944     /* Like cp_list, but code points on this list are valid only when the
16945      * runtime locale is UTF-8 */
16946     SV* only_utf8_locale_list = NULL;
16947
16948     /* In a range, if one of the endpoints is non-character-set portable,
16949      * meaning that it hard-codes a code point that may mean a different
16950      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16951      * mnemonic '\t' which each mean the same character no matter which
16952      * character set the platform is on. */
16953     unsigned int non_portable_endpoint = 0;
16954
16955     /* Is the range unicode? which means on a platform that isn't 1-1 native
16956      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16957      * to be a Unicode value.  */
16958     bool unicode_range = FALSE;
16959     bool invert = FALSE;    /* Is this class to be complemented */
16960
16961     bool warn_super = ALWAYS_WARN_SUPER;
16962
16963     const char * orig_parse = RExC_parse;
16964
16965     /* This variable is used to mark where the end in the input is of something
16966      * that looks like a POSIX construct but isn't.  During the parse, when
16967      * something looks like it could be such a construct is encountered, it is
16968      * checked for being one, but not if we've already checked this area of the
16969      * input.  Only after this position is reached do we check again */
16970     char *not_posix_region_end = RExC_parse - 1;
16971
16972     AV* posix_warnings = NULL;
16973     const bool do_posix_warnings = ckWARN(WARN_REGEXP);
16974     U8 op = END;    /* The returned node-type, initialized to an impossible
16975                        one.  */
16976     U8 anyof_flags = 0;   /* flag bits if the node is an ANYOF-type */
16977     U32 posixl = 0;       /* bit field of posix classes matched under /l */
16978
16979
16980 /* Flags as to what things aren't knowable until runtime.  (Note that these are
16981  * mutually exclusive.) */
16982 #define HAS_USER_DEFINED_PROPERTY 0x01   /* /u any user-defined properties that
16983                                             haven't been defined as of yet */
16984 #define HAS_D_RUNTIME_DEPENDENCY  0x02   /* /d if the target being matched is
16985                                             UTF-8 or not */
16986 #define HAS_L_RUNTIME_DEPENDENCY   0x04 /* /l what the posix classes match and
16987                                             what gets folded */
16988     U32 has_runtime_dependency = 0;     /* OR of the above flags */
16989
16990     GET_RE_DEBUG_FLAGS_DECL;
16991
16992     PERL_ARGS_ASSERT_REGCLASS;
16993 #ifndef DEBUGGING
16994     PERL_UNUSED_ARG(depth);
16995 #endif
16996
16997
16998     /* If wants an inversion list returned, we can't optimize to something
16999      * else. */
17000     if (ret_invlist) {
17001         optimizable = FALSE;
17002     }
17003
17004     DEBUG_PARSE("clas");
17005
17006 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
17007     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
17008                                    && UNICODE_DOT_DOT_VERSION == 0)
17009     allow_mutiple_chars = FALSE;
17010 #endif
17011
17012     /* We include the /i status at the beginning of this so that we can
17013      * know it at runtime */
17014     listsv = sv_2mortal(Perl_newSVpvf(aTHX_ "#%d\n", cBOOL(FOLD)));
17015     initial_listsv_len = SvCUR(listsv);
17016     SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
17017
17018     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17019
17020     assert(RExC_parse <= RExC_end);
17021
17022     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
17023         RExC_parse++;
17024         invert = TRUE;
17025         allow_mutiple_chars = FALSE;
17026         MARK_NAUGHTY(1);
17027         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17028     }
17029
17030     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
17031     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
17032         int maybe_class = handle_possible_posix(pRExC_state,
17033                                                 RExC_parse,
17034                                                 &not_posix_region_end,
17035                                                 NULL,
17036                                                 TRUE /* checking only */);
17037         if (maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
17038             ckWARN4reg(not_posix_region_end,
17039                     "POSIX syntax [%c %c] belongs inside character classes%s",
17040                     *RExC_parse, *RExC_parse,
17041                     (maybe_class == OOB_NAMEDCLASS)
17042                     ? ((POSIXCC_NOTYET(*RExC_parse))
17043                         ? " (but this one isn't implemented)"
17044                         : " (but this one isn't fully valid)")
17045                     : ""
17046                     );
17047         }
17048     }
17049
17050     /* If the caller wants us to just parse a single element, accomplish this
17051      * by faking the loop ending condition */
17052     if (stop_at_1 && RExC_end > RExC_parse) {
17053         stop_ptr = RExC_parse + 1;
17054     }
17055
17056     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
17057     if (UCHARAT(RExC_parse) == ']')
17058         goto charclassloop;
17059
17060     while (1) {
17061
17062         if (   posix_warnings
17063             && av_tindex_skip_len_mg(posix_warnings) >= 0
17064             && RExC_parse > not_posix_region_end)
17065         {
17066             /* Warnings about posix class issues are considered tentative until
17067              * we are far enough along in the parse that we can no longer
17068              * change our mind, at which point we output them.  This is done
17069              * each time through the loop so that a later class won't zap them
17070              * before they have been dealt with. */
17071             output_posix_warnings(pRExC_state, posix_warnings);
17072         }
17073
17074         if  (RExC_parse >= stop_ptr) {
17075             break;
17076         }
17077
17078         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17079
17080         if  (UCHARAT(RExC_parse) == ']') {
17081             break;
17082         }
17083
17084       charclassloop:
17085
17086         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
17087         save_value = value;
17088         save_prevvalue = prevvalue;
17089
17090         if (!range) {
17091             rangebegin = RExC_parse;
17092             element_count++;
17093             non_portable_endpoint = 0;
17094         }
17095         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
17096             value = utf8n_to_uvchr((U8*)RExC_parse,
17097                                    RExC_end - RExC_parse,
17098                                    &numlen, UTF8_ALLOW_DEFAULT);
17099             RExC_parse += numlen;
17100         }
17101         else
17102             value = UCHARAT(RExC_parse++);
17103
17104         if (value == '[') {
17105             char * posix_class_end;
17106             namedclass = handle_possible_posix(pRExC_state,
17107                                                RExC_parse,
17108                                                &posix_class_end,
17109                                                do_posix_warnings ? &posix_warnings : NULL,
17110                                                FALSE    /* die if error */);
17111             if (namedclass > OOB_NAMEDCLASS) {
17112
17113                 /* If there was an earlier attempt to parse this particular
17114                  * posix class, and it failed, it was a false alarm, as this
17115                  * successful one proves */
17116                 if (   posix_warnings
17117                     && av_tindex_skip_len_mg(posix_warnings) >= 0
17118                     && not_posix_region_end >= RExC_parse
17119                     && not_posix_region_end <= posix_class_end)
17120                 {
17121                     av_undef(posix_warnings);
17122                 }
17123
17124                 RExC_parse = posix_class_end;
17125             }
17126             else if (namedclass == OOB_NAMEDCLASS) {
17127                 not_posix_region_end = posix_class_end;
17128             }
17129             else {
17130                 namedclass = OOB_NAMEDCLASS;
17131             }
17132         }
17133         else if (   RExC_parse - 1 > not_posix_region_end
17134                  && MAYBE_POSIXCC(value))
17135         {
17136             (void) handle_possible_posix(
17137                         pRExC_state,
17138                         RExC_parse - 1,  /* -1 because parse has already been
17139                                             advanced */
17140                         &not_posix_region_end,
17141                         do_posix_warnings ? &posix_warnings : NULL,
17142                         TRUE /* checking only */);
17143         }
17144         else if (  strict && ! skip_white
17145                  && (   _generic_isCC(value, _CC_VERTSPACE)
17146                      || is_VERTWS_cp_high(value)))
17147         {
17148             vFAIL("Literal vertical space in [] is illegal except under /x");
17149         }
17150         else if (value == '\\') {
17151             /* Is a backslash; get the code point of the char after it */
17152
17153             if (RExC_parse >= RExC_end) {
17154                 vFAIL("Unmatched [");
17155             }
17156
17157             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
17158                 value = utf8n_to_uvchr((U8*)RExC_parse,
17159                                    RExC_end - RExC_parse,
17160                                    &numlen, UTF8_ALLOW_DEFAULT);
17161                 RExC_parse += numlen;
17162             }
17163             else
17164                 value = UCHARAT(RExC_parse++);
17165
17166             /* Some compilers cannot handle switching on 64-bit integer
17167              * values, therefore value cannot be an UV.  Yes, this will
17168              * be a problem later if we want switch on Unicode.
17169              * A similar issue a little bit later when switching on
17170              * namedclass. --jhi */
17171
17172             /* If the \ is escaping white space when white space is being
17173              * skipped, it means that that white space is wanted literally, and
17174              * is already in 'value'.  Otherwise, need to translate the escape
17175              * into what it signifies. */
17176             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
17177
17178             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
17179             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
17180             case 's':   namedclass = ANYOF_SPACE;       break;
17181             case 'S':   namedclass = ANYOF_NSPACE;      break;
17182             case 'd':   namedclass = ANYOF_DIGIT;       break;
17183             case 'D':   namedclass = ANYOF_NDIGIT;      break;
17184             case 'v':   namedclass = ANYOF_VERTWS;      break;
17185             case 'V':   namedclass = ANYOF_NVERTWS;     break;
17186             case 'h':   namedclass = ANYOF_HORIZWS;     break;
17187             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
17188             case 'N':  /* Handle \N{NAME} in class */
17189                 {
17190                     const char * const backslash_N_beg = RExC_parse - 2;
17191                     int cp_count;
17192
17193                     if (! grok_bslash_N(pRExC_state,
17194                                         NULL,      /* No regnode */
17195                                         &value,    /* Yes single value */
17196                                         &cp_count, /* Multiple code pt count */
17197                                         flagp,
17198                                         strict,
17199                                         depth)
17200                     ) {
17201
17202                         if (*flagp & NEED_UTF8)
17203                             FAIL("panic: grok_bslash_N set NEED_UTF8");
17204
17205                         RETURN_FAIL_ON_RESTART_FLAGP(flagp);
17206
17207                         if (cp_count < 0) {
17208                             vFAIL("\\N in a character class must be a named character: \\N{...}");
17209                         }
17210                         else if (cp_count == 0) {
17211                             ckWARNreg(RExC_parse,
17212                               "Ignoring zero length \\N{} in character class");
17213                         }
17214                         else { /* cp_count > 1 */
17215                             assert(cp_count > 1);
17216                             if (! RExC_in_multi_char_class) {
17217                                 if ( ! allow_mutiple_chars
17218                                     || invert
17219                                     || range
17220                                     || *RExC_parse == '-')
17221                                 {
17222                                     if (strict) {
17223                                         RExC_parse--;
17224                                         vFAIL("\\N{} here is restricted to one character");
17225                                     }
17226                                     ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
17227                                     break; /* <value> contains the first code
17228                                               point. Drop out of the switch to
17229                                               process it */
17230                                 }
17231                                 else {
17232                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
17233                                                  RExC_parse - backslash_N_beg);
17234                                     multi_char_matches
17235                                         = add_multi_match(multi_char_matches,
17236                                                           multi_char_N,
17237                                                           cp_count);
17238                                 }
17239                             }
17240                         } /* End of cp_count != 1 */
17241
17242                         /* This element should not be processed further in this
17243                          * class */
17244                         element_count--;
17245                         value = save_value;
17246                         prevvalue = save_prevvalue;
17247                         continue;   /* Back to top of loop to get next char */
17248                     }
17249
17250                     /* Here, is a single code point, and <value> contains it */
17251                     unicode_range = TRUE;   /* \N{} are Unicode */
17252                 }
17253                 break;
17254             case 'p':
17255             case 'P':
17256                 {
17257                 char *e;
17258
17259                 /* \p means they want Unicode semantics */
17260                 REQUIRE_UNI_RULES(flagp, 0);
17261
17262                 if (RExC_parse >= RExC_end)
17263                     vFAIL2("Empty \\%c", (U8)value);
17264                 if (*RExC_parse == '{') {
17265                     const U8 c = (U8)value;
17266                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
17267                     if (!e) {
17268                         RExC_parse++;
17269                         vFAIL2("Missing right brace on \\%c{}", c);
17270                     }
17271
17272                     RExC_parse++;
17273
17274                     /* White space is allowed adjacent to the braces and after
17275                      * any '^', even when not under /x */
17276                     while (isSPACE(*RExC_parse)) {
17277                          RExC_parse++;
17278                     }
17279
17280                     if (UCHARAT(RExC_parse) == '^') {
17281
17282                         /* toggle.  (The rhs xor gets the single bit that
17283                          * differs between P and p; the other xor inverts just
17284                          * that bit) */
17285                         value ^= 'P' ^ 'p';
17286
17287                         RExC_parse++;
17288                         while (isSPACE(*RExC_parse)) {
17289                             RExC_parse++;
17290                         }
17291                     }
17292
17293                     if (e == RExC_parse)
17294                         vFAIL2("Empty \\%c{}", c);
17295
17296                     n = e - RExC_parse;
17297                     while (isSPACE(*(RExC_parse + n - 1)))
17298                         n--;
17299
17300                 }   /* The \p isn't immediately followed by a '{' */
17301                 else if (! isALPHA(*RExC_parse)) {
17302                     RExC_parse += (UTF)
17303                                   ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
17304                                   : 1;
17305                     vFAIL2("Character following \\%c must be '{' or a "
17306                            "single-character Unicode property name",
17307                            (U8) value);
17308                 }
17309                 else {
17310                     e = RExC_parse;
17311                     n = 1;
17312                 }
17313                 {
17314                     char* name = RExC_parse;
17315
17316                     /* Any message returned about expanding the definition */
17317                     SV* msg = newSVpvs_flags("", SVs_TEMP);
17318
17319                     /* If set TRUE, the property is user-defined as opposed to
17320                      * official Unicode */
17321                     bool user_defined = FALSE;
17322
17323                     SV * prop_definition = parse_uniprop_string(
17324                                             name, n, UTF, FOLD,
17325                                             FALSE, /* This is compile-time */
17326
17327                                             /* We can't defer this defn when
17328                                              * the full result is required in
17329                                              * this call */
17330                                             ! cBOOL(ret_invlist),
17331
17332                                             &user_defined,
17333                                             msg,
17334                                             0 /* Base level */
17335                                            );
17336                     if (SvCUR(msg)) {   /* Assumes any error causes a msg */
17337                         assert(prop_definition == NULL);
17338                         RExC_parse = e + 1;
17339                         if (SvUTF8(msg)) {  /* msg being UTF-8 makes the whole
17340                                                thing so, or else the display is
17341                                                mojibake */
17342                             RExC_utf8 = TRUE;
17343                         }
17344                         /* diag_listed_as: Can't find Unicode property definition "%s" in regex; marked by <-- HERE in m/%s/ */
17345                         vFAIL2utf8f("%" UTF8f, UTF8fARG(SvUTF8(msg),
17346                                     SvCUR(msg), SvPVX(msg)));
17347                     }
17348
17349                     if (! is_invlist(prop_definition)) {
17350
17351                         /* Here, the definition isn't known, so we have gotten
17352                          * returned a string that will be evaluated if and when
17353                          * encountered at runtime.  We add it to the list of
17354                          * such properties, along with whether it should be
17355                          * complemented or not */
17356                         if (value == 'P') {
17357                             sv_catpvs(listsv, "!");
17358                         }
17359                         else {
17360                             sv_catpvs(listsv, "+");
17361                         }
17362                         sv_catsv(listsv, prop_definition);
17363
17364                         has_runtime_dependency |= HAS_USER_DEFINED_PROPERTY;
17365
17366                         /* We don't know yet what this matches, so have to flag
17367                          * it */
17368                         anyof_flags |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
17369                     }
17370                     else {
17371                         assert (prop_definition && is_invlist(prop_definition));
17372
17373                         /* Here we do have the complete property definition
17374                          *
17375                          * Temporary workaround for [perl #133136].  For this
17376                          * precise input that is in the .t that is failing,
17377                          * load utf8.pm, which is what the test wants, so that
17378                          * that .t passes */
17379                         if (     memEQs(RExC_start, e + 1 - RExC_start,
17380                                         "foo\\p{Alnum}")
17381                             && ! hv_common(GvHVn(PL_incgv),
17382                                            NULL,
17383                                            "utf8.pm", sizeof("utf8.pm") - 1,
17384                                            0, HV_FETCH_ISEXISTS, NULL, 0))
17385                         {
17386                             require_pv("utf8.pm");
17387                         }
17388
17389                         if (! user_defined &&
17390                             /* We warn on matching an above-Unicode code point
17391                              * if the match would return true, except don't
17392                              * warn for \p{All}, which has exactly one element
17393                              * = 0 */
17394                             (_invlist_contains_cp(prop_definition, 0x110000)
17395                                 && (! (_invlist_len(prop_definition) == 1
17396                                        && *invlist_array(prop_definition) == 0))))
17397                         {
17398                             warn_super = TRUE;
17399                         }
17400
17401                         /* Invert if asking for the complement */
17402                         if (value == 'P') {
17403                             _invlist_union_complement_2nd(properties,
17404                                                           prop_definition,
17405                                                           &properties);
17406                         }
17407                         else {
17408                             _invlist_union(properties, prop_definition, &properties);
17409                         }
17410                     }
17411                 }
17412
17413                 RExC_parse = e + 1;
17414                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
17415                                                 named */
17416                 }
17417                 break;
17418             case 'n':   value = '\n';                   break;
17419             case 'r':   value = '\r';                   break;
17420             case 't':   value = '\t';                   break;
17421             case 'f':   value = '\f';                   break;
17422             case 'b':   value = '\b';                   break;
17423             case 'e':   value = ESC_NATIVE;             break;
17424             case 'a':   value = '\a';                   break;
17425             case 'o':
17426                 RExC_parse--;   /* function expects to be pointed at the 'o' */
17427                 {
17428                     const char* error_msg;
17429                     bool valid = grok_bslash_o(&RExC_parse,
17430                                                RExC_end,
17431                                                &value,
17432                                                &error_msg,
17433                                                TO_OUTPUT_WARNINGS(RExC_parse),
17434                                                strict,
17435                                                silence_non_portable,
17436                                                UTF);
17437                     if (! valid) {
17438                         vFAIL(error_msg);
17439                     }
17440                     UPDATE_WARNINGS_LOC(RExC_parse - 1);
17441                 }
17442                 non_portable_endpoint++;
17443                 break;
17444             case 'x':
17445                 RExC_parse--;   /* function expects to be pointed at the 'x' */
17446                 {
17447                     const char* error_msg;
17448                     bool valid = grok_bslash_x(&RExC_parse,
17449                                                RExC_end,
17450                                                &value,
17451                                                &error_msg,
17452                                                TO_OUTPUT_WARNINGS(RExC_parse),
17453                                                strict,
17454                                                silence_non_portable,
17455                                                UTF);
17456                     if (! valid) {
17457                         vFAIL(error_msg);
17458                     }
17459                     UPDATE_WARNINGS_LOC(RExC_parse - 1);
17460                 }
17461                 non_portable_endpoint++;
17462                 break;
17463             case 'c':
17464                 value = grok_bslash_c(*RExC_parse, TO_OUTPUT_WARNINGS(RExC_parse));
17465                 UPDATE_WARNINGS_LOC(RExC_parse);
17466                 RExC_parse++;
17467                 non_portable_endpoint++;
17468                 break;
17469             case '0': case '1': case '2': case '3': case '4':
17470             case '5': case '6': case '7':
17471                 {
17472                     /* Take 1-3 octal digits */
17473                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
17474                     numlen = (strict) ? 4 : 3;
17475                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
17476                     RExC_parse += numlen;
17477                     if (numlen != 3) {
17478                         if (strict) {
17479                             RExC_parse += (UTF)
17480                                           ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
17481                                           : 1;
17482                             vFAIL("Need exactly 3 octal digits");
17483                         }
17484                         else if (   numlen < 3 /* like \08, \178 */
17485                                  && RExC_parse < RExC_end
17486                                  && isDIGIT(*RExC_parse)
17487                                  && ckWARN(WARN_REGEXP))
17488                         {
17489                             reg_warn_non_literal_string(
17490                                  RExC_parse + 1,
17491                                  form_short_octal_warning(RExC_parse, numlen));
17492                         }
17493                     }
17494                     non_portable_endpoint++;
17495                     break;
17496                 }
17497             default:
17498                 /* Allow \_ to not give an error */
17499                 if (isWORDCHAR(value) && value != '_') {
17500                     if (strict) {
17501                         vFAIL2("Unrecognized escape \\%c in character class",
17502                                (int)value);
17503                     }
17504                     else {
17505                         ckWARN2reg(RExC_parse,
17506                             "Unrecognized escape \\%c in character class passed through",
17507                             (int)value);
17508                     }
17509                 }
17510                 break;
17511             }   /* End of switch on char following backslash */
17512         } /* end of handling backslash escape sequences */
17513
17514         /* Here, we have the current token in 'value' */
17515
17516         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
17517             U8 classnum;
17518
17519             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
17520              * literal, as is the character that began the false range, i.e.
17521              * the 'a' in the examples */
17522             if (range) {
17523                 const int w = (RExC_parse >= rangebegin)
17524                                 ? RExC_parse - rangebegin
17525                                 : 0;
17526                 if (strict) {
17527                     vFAIL2utf8f(
17528                         "False [] range \"%" UTF8f "\"",
17529                         UTF8fARG(UTF, w, rangebegin));
17530                 }
17531                 else {
17532                     ckWARN2reg(RExC_parse,
17533                         "False [] range \"%" UTF8f "\"",
17534                         UTF8fARG(UTF, w, rangebegin));
17535                     cp_list = add_cp_to_invlist(cp_list, '-');
17536                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
17537                                                             prevvalue);
17538                 }
17539
17540                 range = 0; /* this was not a true range */
17541                 element_count += 2; /* So counts for three values */
17542             }
17543
17544             classnum = namedclass_to_classnum(namedclass);
17545
17546             if (LOC && namedclass < ANYOF_POSIXL_MAX
17547 #ifndef HAS_ISASCII
17548                 && classnum != _CC_ASCII
17549 #endif
17550             ) {
17551                 SV* scratch_list = NULL;
17552
17553                 /* What the Posix classes (like \w, [:space:]) match isn't
17554                  * generally knowable under locale until actual match time.  A
17555                  * special node is used for these which has extra space for a
17556                  * bitmap, with a bit reserved for each named class that is to
17557                  * be matched against.  (This isn't needed for \p{} and
17558                  * pseudo-classes, as they are not affected by locale, and
17559                  * hence are dealt with separately.)  However, if a named class
17560                  * and its complement are both present, then it matches
17561                  * everything, and there is no runtime dependency.  Odd numbers
17562                  * are the complements of the next lower number, so xor works.
17563                  * (Note that something like [\w\D] should match everything,
17564                  * because \d should be a proper subset of \w.  But rather than
17565                  * trust that the locale is well behaved, we leave this to
17566                  * runtime to sort out) */
17567                 if (POSIXL_TEST(posixl, namedclass ^ 1)) {
17568                     cp_list = _add_range_to_invlist(cp_list, 0, UV_MAX);
17569                     POSIXL_ZERO(posixl);
17570                     has_runtime_dependency &= ~HAS_L_RUNTIME_DEPENDENCY;
17571                     anyof_flags &= ~ANYOF_MATCHES_POSIXL;
17572                     continue;   /* We could ignore the rest of the class, but
17573                                    best to parse it for any errors */
17574                 }
17575                 else { /* Here, isn't the complement of any already parsed
17576                           class */
17577                     POSIXL_SET(posixl, namedclass);
17578                     has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
17579                     anyof_flags |= ANYOF_MATCHES_POSIXL;
17580
17581                     /* The above-Latin1 characters are not subject to locale
17582                      * rules.  Just add them to the unconditionally-matched
17583                      * list */
17584
17585                     /* Get the list of the above-Latin1 code points this
17586                      * matches */
17587                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
17588                                             PL_XPosix_ptrs[classnum],
17589
17590                                             /* Odd numbers are complements,
17591                                              * like NDIGIT, NASCII, ... */
17592                                             namedclass % 2 != 0,
17593                                             &scratch_list);
17594                     /* Checking if 'cp_list' is NULL first saves an extra
17595                      * clone.  Its reference count will be decremented at the
17596                      * next union, etc, or if this is the only instance, at the
17597                      * end of the routine */
17598                     if (! cp_list) {
17599                         cp_list = scratch_list;
17600                     }
17601                     else {
17602                         _invlist_union(cp_list, scratch_list, &cp_list);
17603                         SvREFCNT_dec_NN(scratch_list);
17604                     }
17605                     continue;   /* Go get next character */
17606                 }
17607             }
17608             else {
17609
17610                 /* Here, is not /l, or is a POSIX class for which /l doesn't
17611                  * matter (or is a Unicode property, which is skipped here). */
17612                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
17613                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
17614
17615                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
17616                          * nor /l make a difference in what these match,
17617                          * therefore we just add what they match to cp_list. */
17618                         if (classnum != _CC_VERTSPACE) {
17619                             assert(   namedclass == ANYOF_HORIZWS
17620                                    || namedclass == ANYOF_NHORIZWS);
17621
17622                             /* It turns out that \h is just a synonym for
17623                              * XPosixBlank */
17624                             classnum = _CC_BLANK;
17625                         }
17626
17627                         _invlist_union_maybe_complement_2nd(
17628                                 cp_list,
17629                                 PL_XPosix_ptrs[classnum],
17630                                 namedclass % 2 != 0,    /* Complement if odd
17631                                                           (NHORIZWS, NVERTWS)
17632                                                         */
17633                                 &cp_list);
17634                     }
17635                 }
17636                 else if (   AT_LEAST_UNI_SEMANTICS
17637                          || classnum == _CC_ASCII
17638                          || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
17639                                                    || classnum == _CC_XDIGIT)))
17640                 {
17641                     /* We usually have to worry about /d affecting what POSIX
17642                      * classes match, with special code needed because we won't
17643                      * know until runtime what all matches.  But there is no
17644                      * extra work needed under /u and /a; and [:ascii:] is
17645                      * unaffected by /d; and :digit: and :xdigit: don't have
17646                      * runtime differences under /d.  So we can special case
17647                      * these, and avoid some extra work below, and at runtime.
17648                      * */
17649                     _invlist_union_maybe_complement_2nd(
17650                                                      simple_posixes,
17651                                                       ((AT_LEAST_ASCII_RESTRICTED)
17652                                                        ? PL_Posix_ptrs[classnum]
17653                                                        : PL_XPosix_ptrs[classnum]),
17654                                                      namedclass % 2 != 0,
17655                                                      &simple_posixes);
17656                 }
17657                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
17658                            complement and use nposixes */
17659                     SV** posixes_ptr = namedclass % 2 == 0
17660                                        ? &posixes
17661                                        : &nposixes;
17662                     _invlist_union_maybe_complement_2nd(
17663                                                      *posixes_ptr,
17664                                                      PL_XPosix_ptrs[classnum],
17665                                                      namedclass % 2 != 0,
17666                                                      posixes_ptr);
17667                 }
17668             }
17669         } /* end of namedclass \blah */
17670
17671         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17672
17673         /* If 'range' is set, 'value' is the ending of a range--check its
17674          * validity.  (If value isn't a single code point in the case of a
17675          * range, we should have figured that out above in the code that
17676          * catches false ranges).  Later, we will handle each individual code
17677          * point in the range.  If 'range' isn't set, this could be the
17678          * beginning of a range, so check for that by looking ahead to see if
17679          * the next real character to be processed is the range indicator--the
17680          * minus sign */
17681
17682         if (range) {
17683 #ifdef EBCDIC
17684             /* For unicode ranges, we have to test that the Unicode as opposed
17685              * to the native values are not decreasing.  (Above 255, there is
17686              * no difference between native and Unicode) */
17687             if (unicode_range && prevvalue < 255 && value < 255) {
17688                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
17689                     goto backwards_range;
17690                 }
17691             }
17692             else
17693 #endif
17694             if (prevvalue > value) /* b-a */ {
17695                 int w;
17696 #ifdef EBCDIC
17697               backwards_range:
17698 #endif
17699                 w = RExC_parse - rangebegin;
17700                 vFAIL2utf8f(
17701                     "Invalid [] range \"%" UTF8f "\"",
17702                     UTF8fARG(UTF, w, rangebegin));
17703                 NOT_REACHED; /* NOTREACHED */
17704             }
17705         }
17706         else {
17707             prevvalue = value; /* save the beginning of the potential range */
17708             if (! stop_at_1     /* Can't be a range if parsing just one thing */
17709                 && *RExC_parse == '-')
17710             {
17711                 char* next_char_ptr = RExC_parse + 1;
17712
17713                 /* Get the next real char after the '-' */
17714                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
17715
17716                 /* If the '-' is at the end of the class (just before the ']',
17717                  * it is a literal minus; otherwise it is a range */
17718                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
17719                     RExC_parse = next_char_ptr;
17720
17721                     /* a bad range like \w-, [:word:]- ? */
17722                     if (namedclass > OOB_NAMEDCLASS) {
17723                         if (strict || ckWARN(WARN_REGEXP)) {
17724                             const int w = RExC_parse >= rangebegin
17725                                           ?  RExC_parse - rangebegin
17726                                           : 0;
17727                             if (strict) {
17728                                 vFAIL4("False [] range \"%*.*s\"",
17729                                     w, w, rangebegin);
17730                             }
17731                             else {
17732                                 vWARN4(RExC_parse,
17733                                     "False [] range \"%*.*s\"",
17734                                     w, w, rangebegin);
17735                             }
17736                         }
17737                         cp_list = add_cp_to_invlist(cp_list, '-');
17738                         element_count++;
17739                     } else
17740                         range = 1;      /* yeah, it's a range! */
17741                     continue;   /* but do it the next time */
17742                 }
17743             }
17744         }
17745
17746         if (namedclass > OOB_NAMEDCLASS) {
17747             continue;
17748         }
17749
17750         /* Here, we have a single value this time through the loop, and
17751          * <prevvalue> is the beginning of the range, if any; or <value> if
17752          * not. */
17753
17754         /* non-Latin1 code point implies unicode semantics. */
17755         if (value > 255) {
17756             REQUIRE_UNI_RULES(flagp, 0);
17757         }
17758
17759         /* Ready to process either the single value, or the completed range.
17760          * For single-valued non-inverted ranges, we consider the possibility
17761          * of multi-char folds.  (We made a conscious decision to not do this
17762          * for the other cases because it can often lead to non-intuitive
17763          * results.  For example, you have the peculiar case that:
17764          *  "s s" =~ /^[^\xDF]+$/i => Y
17765          *  "ss"  =~ /^[^\xDF]+$/i => N
17766          *
17767          * See [perl #89750] */
17768         if (FOLD && allow_mutiple_chars && value == prevvalue) {
17769             if (    value == LATIN_SMALL_LETTER_SHARP_S
17770                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
17771                                                         value)))
17772             {
17773                 /* Here <value> is indeed a multi-char fold.  Get what it is */
17774
17775                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17776                 STRLEN foldlen;
17777
17778                 UV folded = _to_uni_fold_flags(
17779                                 value,
17780                                 foldbuf,
17781                                 &foldlen,
17782                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
17783                                                    ? FOLD_FLAGS_NOMIX_ASCII
17784                                                    : 0)
17785                                 );
17786
17787                 /* Here, <folded> should be the first character of the
17788                  * multi-char fold of <value>, with <foldbuf> containing the
17789                  * whole thing.  But, if this fold is not allowed (because of
17790                  * the flags), <fold> will be the same as <value>, and should
17791                  * be processed like any other character, so skip the special
17792                  * handling */
17793                 if (folded != value) {
17794
17795                     /* Skip if we are recursed, currently parsing the class
17796                      * again.  Otherwise add this character to the list of
17797                      * multi-char folds. */
17798                     if (! RExC_in_multi_char_class) {
17799                         STRLEN cp_count = utf8_length(foldbuf,
17800                                                       foldbuf + foldlen);
17801                         SV* multi_fold = sv_2mortal(newSVpvs(""));
17802
17803                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
17804
17805                         multi_char_matches
17806                                         = add_multi_match(multi_char_matches,
17807                                                           multi_fold,
17808                                                           cp_count);
17809
17810                     }
17811
17812                     /* This element should not be processed further in this
17813                      * class */
17814                     element_count--;
17815                     value = save_value;
17816                     prevvalue = save_prevvalue;
17817                     continue;
17818                 }
17819             }
17820         }
17821
17822         if (strict && ckWARN(WARN_REGEXP)) {
17823             if (range) {
17824
17825                 /* If the range starts above 255, everything is portable and
17826                  * likely to be so for any forseeable character set, so don't
17827                  * warn. */
17828                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
17829                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
17830                 }
17831                 else if (prevvalue != value) {
17832
17833                     /* Under strict, ranges that stop and/or end in an ASCII
17834                      * printable should have each end point be a portable value
17835                      * for it (preferably like 'A', but we don't warn if it is
17836                      * a (portable) Unicode name or code point), and the range
17837                      * must be be all digits or all letters of the same case.
17838                      * Otherwise, the range is non-portable and unclear as to
17839                      * what it contains */
17840                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
17841                         && (          non_portable_endpoint
17842                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
17843                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
17844                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
17845                     ))) {
17846                         vWARN(RExC_parse, "Ranges of ASCII printables should"
17847                                           " be some subset of \"0-9\","
17848                                           " \"A-Z\", or \"a-z\"");
17849                     }
17850                     else if (prevvalue >= FIRST_NON_ASCII_DECIMAL_DIGIT) {
17851                         SSize_t index_start;
17852                         SSize_t index_final;
17853
17854                         /* But the nature of Unicode and languages mean we
17855                          * can't do the same checks for above-ASCII ranges,
17856                          * except in the case of digit ones.  These should
17857                          * contain only digits from the same group of 10.  The
17858                          * ASCII case is handled just above.  Hence here, the
17859                          * range could be a range of digits.  First some
17860                          * unlikely special cases.  Grandfather in that a range
17861                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
17862                          * if its starting value is one of the 10 digits prior
17863                          * to it.  This is because it is an alternate way of
17864                          * writing 19D1, and some people may expect it to be in
17865                          * that group.  But it is bad, because it won't give
17866                          * the expected results.  In Unicode 5.2 it was
17867                          * considered to be in that group (of 11, hence), but
17868                          * this was fixed in the next version */
17869
17870                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
17871                             goto warn_bad_digit_range;
17872                         }
17873                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17874                                           &&     value <= 0x1D7FF))
17875                         {
17876                             /* This is the only other case currently in Unicode
17877                              * where the algorithm below fails.  The code
17878                              * points just above are the end points of a single
17879                              * range containing only decimal digits.  It is 5
17880                              * different series of 0-9.  All other ranges of
17881                              * digits currently in Unicode are just a single
17882                              * series.  (And mktables will notify us if a later
17883                              * Unicode version breaks this.)
17884                              *
17885                              * If the range being checked is at most 9 long,
17886                              * and the digit values represented are in
17887                              * numerical order, they are from the same series.
17888                              * */
17889                             if (         value - prevvalue > 9
17890                                 ||    (((    value - 0x1D7CE) % 10)
17891                                      <= (prevvalue - 0x1D7CE) % 10))
17892                             {
17893                                 goto warn_bad_digit_range;
17894                             }
17895                         }
17896                         else {
17897
17898                             /* For all other ranges of digits in Unicode, the
17899                              * algorithm is just to check if both end points
17900                              * are in the same series, which is the same range.
17901                              * */
17902                             index_start = _invlist_search(
17903                                                     PL_XPosix_ptrs[_CC_DIGIT],
17904                                                     prevvalue);
17905
17906                             /* Warn if the range starts and ends with a digit,
17907                              * and they are not in the same group of 10. */
17908                             if (   index_start >= 0
17909                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17910                                 && (index_final =
17911                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17912                                                     value)) != index_start
17913                                 && index_final >= 0
17914                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17915                             {
17916                               warn_bad_digit_range:
17917                                 vWARN(RExC_parse, "Ranges of digits should be"
17918                                                   " from the same group of"
17919                                                   " 10");
17920                             }
17921                         }
17922                     }
17923                 }
17924             }
17925             if ((! range || prevvalue == value) && non_portable_endpoint) {
17926                 if (isPRINT_A(value)) {
17927                     char literal[3];
17928                     unsigned d = 0;
17929                     if (isBACKSLASHED_PUNCT(value)) {
17930                         literal[d++] = '\\';
17931                     }
17932                     literal[d++] = (char) value;
17933                     literal[d++] = '\0';
17934
17935                     vWARN4(RExC_parse,
17936                            "\"%.*s\" is more clearly written simply as \"%s\"",
17937                            (int) (RExC_parse - rangebegin),
17938                            rangebegin,
17939                            literal
17940                         );
17941                 }
17942                 else if (isMNEMONIC_CNTRL(value)) {
17943                     vWARN4(RExC_parse,
17944                            "\"%.*s\" is more clearly written simply as \"%s\"",
17945                            (int) (RExC_parse - rangebegin),
17946                            rangebegin,
17947                            cntrl_to_mnemonic((U8) value)
17948                         );
17949                 }
17950             }
17951         }
17952
17953         /* Deal with this element of the class */
17954
17955 #ifndef EBCDIC
17956         cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17957                                                     prevvalue, value);
17958 #else
17959         /* On non-ASCII platforms, for ranges that span all of 0..255, and ones
17960          * that don't require special handling, we can just add the range like
17961          * we do for ASCII platforms */
17962         if ((UNLIKELY(prevvalue == 0) && value >= 255)
17963             || ! (prevvalue < 256
17964                     && (unicode_range
17965                         || (! non_portable_endpoint
17966                             && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17967                                 || (isUPPER_A(prevvalue)
17968                                     && isUPPER_A(value)))))))
17969         {
17970             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17971                                                         prevvalue, value);
17972         }
17973         else {
17974             /* Here, requires special handling.  This can be because it is a
17975              * range whose code points are considered to be Unicode, and so
17976              * must be individually translated into native, or because its a
17977              * subrange of 'A-Z' or 'a-z' which each aren't contiguous in
17978              * EBCDIC, but we have defined them to include only the "expected"
17979              * upper or lower case ASCII alphabetics.  Subranges above 255 are
17980              * the same in native and Unicode, so can be added as a range */
17981             U8 start = NATIVE_TO_LATIN1(prevvalue);
17982             unsigned j;
17983             U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17984             for (j = start; j <= end; j++) {
17985                 cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17986             }
17987             if (value > 255) {
17988                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17989                                                             256, value);
17990             }
17991         }
17992 #endif
17993
17994         range = 0; /* this range (if it was one) is done now */
17995     } /* End of loop through all the text within the brackets */
17996
17997     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17998         output_posix_warnings(pRExC_state, posix_warnings);
17999     }
18000
18001     /* If anything in the class expands to more than one character, we have to
18002      * deal with them by building up a substitute parse string, and recursively
18003      * calling reg() on it, instead of proceeding */
18004     if (multi_char_matches) {
18005         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
18006         I32 cp_count;
18007         STRLEN len;
18008         char *save_end = RExC_end;
18009         char *save_parse = RExC_parse;
18010         char *save_start = RExC_start;
18011         Size_t constructed_prefix_len = 0; /* This gives the length of the
18012                                               constructed portion of the
18013                                               substitute parse. */
18014         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
18015                                        a "|" */
18016         I32 reg_flags;
18017
18018         assert(! invert);
18019         /* Only one level of recursion allowed */
18020         assert(RExC_copy_start_in_constructed == RExC_precomp);
18021
18022 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
18023            because too confusing */
18024         if (invert) {
18025             sv_catpvs(substitute_parse, "(?:");
18026         }
18027 #endif
18028
18029         /* Look at the longest folds first */
18030         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
18031                         cp_count > 0;
18032                         cp_count--)
18033         {
18034
18035             if (av_exists(multi_char_matches, cp_count)) {
18036                 AV** this_array_ptr;
18037                 SV* this_sequence;
18038
18039                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
18040                                                  cp_count, FALSE);
18041                 while ((this_sequence = av_pop(*this_array_ptr)) !=
18042                                                                 &PL_sv_undef)
18043                 {
18044                     if (! first_time) {
18045                         sv_catpvs(substitute_parse, "|");
18046                     }
18047                     first_time = FALSE;
18048
18049                     sv_catpv(substitute_parse, SvPVX(this_sequence));
18050                 }
18051             }
18052         }
18053
18054         /* If the character class contains anything else besides these
18055          * multi-character folds, have to include it in recursive parsing */
18056         if (element_count) {
18057             sv_catpvs(substitute_parse, "|[");
18058             constructed_prefix_len = SvCUR(substitute_parse);
18059             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
18060
18061             /* Put in a closing ']' only if not going off the end, as otherwise
18062              * we are adding something that really isn't there */
18063             if (RExC_parse < RExC_end) {
18064                 sv_catpvs(substitute_parse, "]");
18065             }
18066         }
18067
18068         sv_catpvs(substitute_parse, ")");
18069 #if 0
18070         if (invert) {
18071             /* This is a way to get the parse to skip forward a whole named
18072              * sequence instead of matching the 2nd character when it fails the
18073              * first */
18074             sv_catpvs(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
18075         }
18076 #endif
18077
18078         /* Set up the data structure so that any errors will be properly
18079          * reported.  See the comments at the definition of
18080          * REPORT_LOCATION_ARGS for details */
18081         RExC_copy_start_in_input = (char *) orig_parse;
18082         RExC_start = RExC_parse = SvPV(substitute_parse, len);
18083         RExC_copy_start_in_constructed = RExC_start + constructed_prefix_len;
18084         RExC_end = RExC_parse + len;
18085         RExC_in_multi_char_class = 1;
18086
18087         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
18088
18089         *flagp |= reg_flags & (HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PARSE|NEED_UTF8);
18090
18091         /* And restore so can parse the rest of the pattern */
18092         RExC_parse = save_parse;
18093         RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = save_start;
18094         RExC_end = save_end;
18095         RExC_in_multi_char_class = 0;
18096         SvREFCNT_dec_NN(multi_char_matches);
18097         return ret;
18098     }
18099
18100     /* If folding, we calculate all characters that could fold to or from the
18101      * ones already on the list */
18102     if (cp_foldable_list) {
18103         if (FOLD) {
18104             UV start, end;      /* End points of code point ranges */
18105
18106             SV* fold_intersection = NULL;
18107             SV** use_list;
18108
18109             /* Our calculated list will be for Unicode rules.  For locale
18110              * matching, we have to keep a separate list that is consulted at
18111              * runtime only when the locale indicates Unicode rules (and we
18112              * don't include potential matches in the ASCII/Latin1 range, as
18113              * any code point could fold to any other, based on the run-time
18114              * locale).   For non-locale, we just use the general list */
18115             if (LOC) {
18116                 use_list = &only_utf8_locale_list;
18117             }
18118             else {
18119                 use_list = &cp_list;
18120             }
18121
18122             /* Only the characters in this class that participate in folds need
18123              * be checked.  Get the intersection of this class and all the
18124              * possible characters that are foldable.  This can quickly narrow
18125              * down a large class */
18126             _invlist_intersection(PL_in_some_fold, cp_foldable_list,
18127                                   &fold_intersection);
18128
18129             /* Now look at the foldable characters in this class individually */
18130             invlist_iterinit(fold_intersection);
18131             while (invlist_iternext(fold_intersection, &start, &end)) {
18132                 UV j;
18133                 UV folded;
18134
18135                 /* Look at every character in the range */
18136                 for (j = start; j <= end; j++) {
18137                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
18138                     STRLEN foldlen;
18139                     unsigned int k;
18140                     Size_t folds_count;
18141                     unsigned int first_fold;
18142                     const unsigned int * remaining_folds;
18143
18144                     if (j < 256) {
18145
18146                         /* Under /l, we don't know what code points below 256
18147                          * fold to, except we do know the MICRO SIGN folds to
18148                          * an above-255 character if the locale is UTF-8, so we
18149                          * add it to the special list (in *use_list)  Otherwise
18150                          * we know now what things can match, though some folds
18151                          * are valid under /d only if the target is UTF-8.
18152                          * Those go in a separate list */
18153                         if (      IS_IN_SOME_FOLD_L1(j)
18154                             && ! (LOC && j != MICRO_SIGN))
18155                         {
18156
18157                             /* ASCII is always matched; non-ASCII is matched
18158                              * only under Unicode rules (which could happen
18159                              * under /l if the locale is a UTF-8 one */
18160                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
18161                                 *use_list = add_cp_to_invlist(*use_list,
18162                                                             PL_fold_latin1[j]);
18163                             }
18164                             else if (j != PL_fold_latin1[j]) {
18165                                 upper_latin1_only_utf8_matches
18166                                         = add_cp_to_invlist(
18167                                                 upper_latin1_only_utf8_matches,
18168                                                 PL_fold_latin1[j]);
18169                             }
18170                         }
18171
18172                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
18173                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
18174                         {
18175                             add_above_Latin1_folds(pRExC_state,
18176                                                    (U8) j,
18177                                                    use_list);
18178                         }
18179                         continue;
18180                     }
18181
18182                     /* Here is an above Latin1 character.  We don't have the
18183                      * rules hard-coded for it.  First, get its fold.  This is
18184                      * the simple fold, as the multi-character folds have been
18185                      * handled earlier and separated out */
18186                     folded = _to_uni_fold_flags(j, foldbuf, &foldlen,
18187                                                         (ASCII_FOLD_RESTRICTED)
18188                                                         ? FOLD_FLAGS_NOMIX_ASCII
18189                                                         : 0);
18190
18191                     /* Single character fold of above Latin1.  Add everything
18192                      * in its fold closure to the list that this node should
18193                      * match. */
18194                     folds_count = _inverse_folds(folded, &first_fold,
18195                                                     &remaining_folds);
18196                     for (k = 0; k <= folds_count; k++) {
18197                         UV c = (k == 0)     /* First time through use itself */
18198                                 ? folded
18199                                 : (k == 1)  /* 2nd time use, the first fold */
18200                                    ? first_fold
18201
18202                                      /* Then the remaining ones */
18203                                    : remaining_folds[k-2];
18204
18205                         /* /aa doesn't allow folds between ASCII and non- */
18206                         if ((   ASCII_FOLD_RESTRICTED
18207                             && (isASCII(c) != isASCII(j))))
18208                         {
18209                             continue;
18210                         }
18211
18212                         /* Folds under /l which cross the 255/256 boundary are
18213                          * added to a separate list.  (These are valid only
18214                          * when the locale is UTF-8.) */
18215                         if (c < 256 && LOC) {
18216                             *use_list = add_cp_to_invlist(*use_list, c);
18217                             continue;
18218                         }
18219
18220                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
18221                         {
18222                             cp_list = add_cp_to_invlist(cp_list, c);
18223                         }
18224                         else {
18225                             /* Similarly folds involving non-ascii Latin1
18226                              * characters under /d are added to their list */
18227                             upper_latin1_only_utf8_matches
18228                                     = add_cp_to_invlist(
18229                                                 upper_latin1_only_utf8_matches,
18230                                                 c);
18231                         }
18232                     }
18233                 }
18234             }
18235             SvREFCNT_dec_NN(fold_intersection);
18236         }
18237
18238         /* Now that we have finished adding all the folds, there is no reason
18239          * to keep the foldable list separate */
18240         _invlist_union(cp_list, cp_foldable_list, &cp_list);
18241         SvREFCNT_dec_NN(cp_foldable_list);
18242     }
18243
18244     /* And combine the result (if any) with any inversion lists from posix
18245      * classes.  The lists are kept separate up to now because we don't want to
18246      * fold the classes */
18247     if (simple_posixes) {   /* These are the classes known to be unaffected by
18248                                /a, /aa, and /d */
18249         if (cp_list) {
18250             _invlist_union(cp_list, simple_posixes, &cp_list);
18251             SvREFCNT_dec_NN(simple_posixes);
18252         }
18253         else {
18254             cp_list = simple_posixes;
18255         }
18256     }
18257     if (posixes || nposixes) {
18258         if (! DEPENDS_SEMANTICS) {
18259
18260             /* For everything but /d, we can just add the current 'posixes' and
18261              * 'nposixes' to the main list */
18262             if (posixes) {
18263                 if (cp_list) {
18264                     _invlist_union(cp_list, posixes, &cp_list);
18265                     SvREFCNT_dec_NN(posixes);
18266                 }
18267                 else {
18268                     cp_list = posixes;
18269                 }
18270             }
18271             if (nposixes) {
18272                 if (cp_list) {
18273                     _invlist_union(cp_list, nposixes, &cp_list);
18274                     SvREFCNT_dec_NN(nposixes);
18275                 }
18276                 else {
18277                     cp_list = nposixes;
18278                 }
18279             }
18280         }
18281         else {
18282             /* Under /d, things like \w match upper Latin1 characters only if
18283              * the target string is in UTF-8.  But things like \W match all the
18284              * upper Latin1 characters if the target string is not in UTF-8.
18285              *
18286              * Handle the case with something like \W separately */
18287             if (nposixes) {
18288                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1, NULL);
18289
18290                 /* A complemented posix class matches all upper Latin1
18291                  * characters if not in UTF-8.  And it matches just certain
18292                  * ones when in UTF-8.  That means those certain ones are
18293                  * matched regardless, so can just be added to the
18294                  * unconditional list */
18295                 if (cp_list) {
18296                     _invlist_union(cp_list, nposixes, &cp_list);
18297                     SvREFCNT_dec_NN(nposixes);
18298                     nposixes = NULL;
18299                 }
18300                 else {
18301                     cp_list = nposixes;
18302                 }
18303
18304                 /* Likewise for 'posixes' */
18305                 _invlist_union(posixes, cp_list, &cp_list);
18306
18307                 /* Likewise for anything else in the range that matched only
18308                  * under UTF-8 */
18309                 if (upper_latin1_only_utf8_matches) {
18310                     _invlist_union(cp_list,
18311                                    upper_latin1_only_utf8_matches,
18312                                    &cp_list);
18313                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
18314                     upper_latin1_only_utf8_matches = NULL;
18315                 }
18316
18317                 /* If we don't match all the upper Latin1 characters regardless
18318                  * of UTF-8ness, we have to set a flag to match the rest when
18319                  * not in UTF-8 */
18320                 _invlist_subtract(only_non_utf8_list, cp_list,
18321                                   &only_non_utf8_list);
18322                 if (_invlist_len(only_non_utf8_list) != 0) {
18323                     anyof_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18324                 }
18325                 SvREFCNT_dec_NN(only_non_utf8_list);
18326             }
18327             else {
18328                 /* Here there were no complemented posix classes.  That means
18329                  * the upper Latin1 characters in 'posixes' match only when the
18330                  * target string is in UTF-8.  So we have to add them to the
18331                  * list of those types of code points, while adding the
18332                  * remainder to the unconditional list.
18333                  *
18334                  * First calculate what they are */
18335                 SV* nonascii_but_latin1_properties = NULL;
18336                 _invlist_intersection(posixes, PL_UpperLatin1,
18337                                       &nonascii_but_latin1_properties);
18338
18339                 /* And add them to the final list of such characters. */
18340                 _invlist_union(upper_latin1_only_utf8_matches,
18341                                nonascii_but_latin1_properties,
18342                                &upper_latin1_only_utf8_matches);
18343
18344                 /* Remove them from what now becomes the unconditional list */
18345                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
18346                                   &posixes);
18347
18348                 /* And add those unconditional ones to the final list */
18349                 if (cp_list) {
18350                     _invlist_union(cp_list, posixes, &cp_list);
18351                     SvREFCNT_dec_NN(posixes);
18352                     posixes = NULL;
18353                 }
18354                 else {
18355                     cp_list = posixes;
18356                 }
18357
18358                 SvREFCNT_dec(nonascii_but_latin1_properties);
18359
18360                 /* Get rid of any characters from the conditional list that we
18361                  * now know are matched unconditionally, which may make that
18362                  * list empty */
18363                 _invlist_subtract(upper_latin1_only_utf8_matches,
18364                                   cp_list,
18365                                   &upper_latin1_only_utf8_matches);
18366                 if (_invlist_len(upper_latin1_only_utf8_matches) == 0) {
18367                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
18368                     upper_latin1_only_utf8_matches = NULL;
18369                 }
18370             }
18371         }
18372     }
18373
18374     /* And combine the result (if any) with any inversion list from properties.
18375      * The lists are kept separate up to now so that we can distinguish the two
18376      * in regards to matching above-Unicode.  A run-time warning is generated
18377      * if a Unicode property is matched against a non-Unicode code point. But,
18378      * we allow user-defined properties to match anything, without any warning,
18379      * and we also suppress the warning if there is a portion of the character
18380      * class that isn't a Unicode property, and which matches above Unicode, \W
18381      * or [\x{110000}] for example.
18382      * (Note that in this case, unlike the Posix one above, there is no
18383      * <upper_latin1_only_utf8_matches>, because having a Unicode property
18384      * forces Unicode semantics */
18385     if (properties) {
18386         if (cp_list) {
18387
18388             /* If it matters to the final outcome, see if a non-property
18389              * component of the class matches above Unicode.  If so, the
18390              * warning gets suppressed.  This is true even if just a single
18391              * such code point is specified, as, though not strictly correct if
18392              * another such code point is matched against, the fact that they
18393              * are using above-Unicode code points indicates they should know
18394              * the issues involved */
18395             if (warn_super) {
18396                 warn_super = ! (invert
18397                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
18398             }
18399
18400             _invlist_union(properties, cp_list, &cp_list);
18401             SvREFCNT_dec_NN(properties);
18402         }
18403         else {
18404             cp_list = properties;
18405         }
18406
18407         if (warn_super) {
18408             anyof_flags
18409              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18410
18411             /* Because an ANYOF node is the only one that warns, this node
18412              * can't be optimized into something else */
18413             optimizable = FALSE;
18414         }
18415     }
18416
18417     /* Here, we have calculated what code points should be in the character
18418      * class.
18419      *
18420      * Now we can see about various optimizations.  Fold calculation (which we
18421      * did above) needs to take place before inversion.  Otherwise /[^k]/i
18422      * would invert to include K, which under /i would match k, which it
18423      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
18424      * folded until runtime */
18425
18426     /* If we didn't do folding, it's because some information isn't available
18427      * until runtime; set the run-time fold flag for these  We know to set the
18428      * flag if we have a non-NULL list for UTF-8 locales, or the class matches
18429      * at least one 0-255 range code point */
18430     if (LOC && FOLD) {
18431
18432         /* Some things on the list might be unconditionally included because of
18433          * other components.  Remove them, and clean up the list if it goes to
18434          * 0 elements */
18435         if (only_utf8_locale_list && cp_list) {
18436             _invlist_subtract(only_utf8_locale_list, cp_list,
18437                               &only_utf8_locale_list);
18438
18439             if (_invlist_len(only_utf8_locale_list) == 0) {
18440                 SvREFCNT_dec_NN(only_utf8_locale_list);
18441                 only_utf8_locale_list = NULL;
18442             }
18443         }
18444         if (    only_utf8_locale_list
18445             || (cp_list && (   _invlist_contains_cp(cp_list, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE)
18446                             || _invlist_contains_cp(cp_list, LATIN_SMALL_LETTER_DOTLESS_I))))
18447         {
18448             has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
18449             anyof_flags
18450                  |= ANYOFL_FOLD
18451                  |  ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
18452         }
18453         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
18454             UV start, end;
18455             invlist_iterinit(cp_list);
18456             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
18457                 anyof_flags |= ANYOFL_FOLD;
18458                 has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
18459             }
18460             invlist_iterfinish(cp_list);
18461         }
18462     }
18463     else if (   DEPENDS_SEMANTICS
18464              && (    upper_latin1_only_utf8_matches
18465                  || (anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
18466     {
18467         RExC_seen_d_op = TRUE;
18468         has_runtime_dependency |= HAS_D_RUNTIME_DEPENDENCY;
18469     }
18470
18471     /* Optimize inverted patterns (e.g. [^a-z]) when everything is known at
18472      * compile time. */
18473     if (     cp_list
18474         &&   invert
18475         && ! has_runtime_dependency)
18476     {
18477         _invlist_invert(cp_list);
18478
18479         /* Clear the invert flag since have just done it here */
18480         invert = FALSE;
18481     }
18482
18483     if (ret_invlist) {
18484         *ret_invlist = cp_list;
18485
18486         return RExC_emit;
18487     }
18488
18489     /* All possible optimizations below still have these characteristics.
18490      * (Multi-char folds aren't SIMPLE, but they don't get this far in this
18491      * routine) */
18492     *flagp |= HASWIDTH|SIMPLE;
18493
18494     if (anyof_flags & ANYOF_LOCALE_FLAGS) {
18495         RExC_contains_locale = 1;
18496     }
18497
18498     /* Some character classes are equivalent to other nodes.  Such nodes take
18499      * up less room, and some nodes require fewer operations to execute, than
18500      * ANYOF nodes.  EXACTish nodes may be joinable with adjacent nodes to
18501      * improve efficiency. */
18502
18503     if (optimizable) {
18504         PERL_UINT_FAST8_T i;
18505         Size_t partial_cp_count = 0;
18506         UV start[MAX_FOLD_FROMS+1] = { 0 }; /* +1 for the folded-to char */
18507         UV   end[MAX_FOLD_FROMS+1] = { 0 };
18508
18509         if (cp_list) { /* Count the code points in enough ranges that we would
18510                           see all the ones possible in any fold in this version
18511                           of Unicode */
18512
18513             invlist_iterinit(cp_list);
18514             for (i = 0; i <= MAX_FOLD_FROMS; i++) {
18515                 if (! invlist_iternext(cp_list, &start[i], &end[i])) {
18516                     break;
18517                 }
18518                 partial_cp_count += end[i] - start[i] + 1;
18519             }
18520
18521             invlist_iterfinish(cp_list);
18522         }
18523
18524         /* If we know at compile time that this matches every possible code
18525          * point, any run-time dependencies don't matter */
18526         if (start[0] == 0 && end[0] == UV_MAX) {
18527             if (invert) {
18528                 ret = reganode(pRExC_state, OPFAIL, 0);
18529             }
18530             else {
18531                 ret = reg_node(pRExC_state, SANY);
18532                 MARK_NAUGHTY(1);
18533             }
18534             goto not_anyof;
18535         }
18536
18537         /* Similarly, for /l posix classes, if both a class and its
18538          * complement match, any run-time dependencies don't matter */
18539         if (posixl) {
18540             for (namedclass = 0; namedclass < ANYOF_POSIXL_MAX;
18541                                                         namedclass += 2)
18542             {
18543                 if (   POSIXL_TEST(posixl, namedclass)      /* class */
18544                     && POSIXL_TEST(posixl, namedclass + 1)) /* its complement */
18545                 {
18546                     if (invert) {
18547                         ret = reganode(pRExC_state, OPFAIL, 0);
18548                     }
18549                     else {
18550                         ret = reg_node(pRExC_state, SANY);
18551                         MARK_NAUGHTY(1);
18552                     }
18553                     goto not_anyof;
18554                 }
18555             }
18556             /* For well-behaved locales, some classes are subsets of others,
18557              * so complementing the subset and including the non-complemented
18558              * superset should match everything, like [\D[:alnum:]], and
18559              * [[:^alpha:][:alnum:]], but some implementations of locales are
18560              * buggy, and khw thinks its a bad idea to have optimization change
18561              * behavior, even if it avoids an OS bug in a given case */
18562
18563 #define isSINGLE_BIT_SET(n) isPOWER_OF_2(n)
18564
18565             /* If is a single posix /l class, can optimize to just that op.
18566              * Such a node will not match anything in the Latin1 range, as that
18567              * is not determinable until runtime, but will match whatever the
18568              * class does outside that range.  (Note that some classes won't
18569              * match anything outside the range, like [:ascii:]) */
18570             if (    isSINGLE_BIT_SET(posixl)
18571                 && (partial_cp_count == 0 || start[0] > 255))
18572             {
18573                 U8 classnum;
18574                 SV * class_above_latin1 = NULL;
18575                 bool already_inverted;
18576                 bool are_equivalent;
18577
18578                 /* Compute which bit is set, which is the same thing as, e.g.,
18579                  * ANYOF_CNTRL.  From
18580                  * https://graphics.stanford.edu/~seander/bithacks.html#IntegerLogDeBruijn
18581                  * */
18582                 static const int MultiplyDeBruijnBitPosition2[32] =
18583                     {
18584                     0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8,
18585                     31, 27, 13, 23, 21, 19, 16, 7, 26, 12, 18, 6, 11, 5, 10, 9
18586                     };
18587
18588                 namedclass = MultiplyDeBruijnBitPosition2[(posixl
18589                                                           * 0x077CB531U) >> 27];
18590                 classnum = namedclass_to_classnum(namedclass);
18591
18592                 /* The named classes are such that the inverted number is one
18593                  * larger than the non-inverted one */
18594                 already_inverted = namedclass
18595                                  - classnum_to_namedclass(classnum);
18596
18597                 /* Create an inversion list of the official property, inverted
18598                  * if the constructed node list is inverted, and restricted to
18599                  * only the above latin1 code points, which are the only ones
18600                  * known at compile time */
18601                 _invlist_intersection_maybe_complement_2nd(
18602                                                     PL_AboveLatin1,
18603                                                     PL_XPosix_ptrs[classnum],
18604                                                     already_inverted,
18605                                                     &class_above_latin1);
18606                 are_equivalent = _invlistEQ(class_above_latin1, cp_list,
18607                                                                         FALSE);
18608                 SvREFCNT_dec_NN(class_above_latin1);
18609
18610                 if (are_equivalent) {
18611
18612                     /* Resolve the run-time inversion flag with this possibly
18613                      * inverted class */
18614                     invert = invert ^ already_inverted;
18615
18616                     ret = reg_node(pRExC_state,
18617                                    POSIXL + invert * (NPOSIXL - POSIXL));
18618                     FLAGS(REGNODE_p(ret)) = classnum;
18619                     goto not_anyof;
18620                 }
18621             }
18622         }
18623
18624         /* khw can't think of any other possible transformation involving
18625          * these. */
18626         if (has_runtime_dependency & HAS_USER_DEFINED_PROPERTY) {
18627             goto is_anyof;
18628         }
18629
18630         if (! has_runtime_dependency) {
18631
18632             /* If the list is empty, nothing matches.  This happens, for
18633              * example, when a Unicode property that doesn't match anything is
18634              * the only element in the character class (perluniprops.pod notes
18635              * such properties). */
18636             if (partial_cp_count == 0) {
18637                 if (invert) {
18638                     ret = reg_node(pRExC_state, SANY);
18639                 }
18640                 else {
18641                     ret = reganode(pRExC_state, OPFAIL, 0);
18642                 }
18643
18644                 goto not_anyof;
18645             }
18646
18647             /* If matches everything but \n */
18648             if (   start[0] == 0 && end[0] == '\n' - 1
18649                 && start[1] == '\n' + 1 && end[1] == UV_MAX)
18650             {
18651                 assert (! invert);
18652                 ret = reg_node(pRExC_state, REG_ANY);
18653                 MARK_NAUGHTY(1);
18654                 goto not_anyof;
18655             }
18656         }
18657
18658         /* Next see if can optimize classes that contain just a few code points
18659          * into an EXACTish node.  The reason to do this is to let the
18660          * optimizer join this node with adjacent EXACTish ones.
18661          *
18662          * An EXACTFish node can be generated even if not under /i, and vice
18663          * versa.  But care must be taken.  An EXACTFish node has to be such
18664          * that it only matches precisely the code points in the class, but we
18665          * want to generate the least restrictive one that does that, to
18666          * increase the odds of being able to join with an adjacent node.  For
18667          * example, if the class contains [kK], we have to make it an EXACTFAA
18668          * node to prevent the KELVIN SIGN from matching.  Whether we are under
18669          * /i or not is irrelevant in this case.  Less obvious is the pattern
18670          * qr/[\x{02BC}]n/i.  U+02BC is MODIFIER LETTER APOSTROPHE. That is
18671          * supposed to match the single character U+0149 LATIN SMALL LETTER N
18672          * PRECEDED BY APOSTROPHE.  And so even though there is no simple fold
18673          * that includes \X{02BC}, there is a multi-char fold that does, and so
18674          * the node generated for it must be an EXACTFish one.  On the other
18675          * hand qr/:/i should generate a plain EXACT node since the colon
18676          * participates in no fold whatsoever, and having it EXACT tells the
18677          * optimizer the target string cannot match unless it has a colon in
18678          * it.
18679          *
18680          * We don't typically generate an EXACTish node if doing so would
18681          * require changing the pattern to UTF-8, as that affects /d and
18682          * otherwise is slower.  However, under /i, not changing to UTF-8 can
18683          * miss some potential multi-character folds.  We calculate the
18684          * EXACTish node, and then decide if something would be missed if we
18685          * don't upgrade */
18686         if (   ! posixl
18687             && ! invert
18688
18689                 /* Only try if there are no more code points in the class than
18690                  * in the max possible fold */
18691             &&   partial_cp_count > 0 && partial_cp_count <= MAX_FOLD_FROMS + 1
18692
18693             && (start[0] < 256 || UTF || FOLD))
18694         {
18695             if (partial_cp_count == 1 && ! upper_latin1_only_utf8_matches)
18696             {
18697                 /* We can always make a single code point class into an
18698                  * EXACTish node. */
18699
18700                 if (LOC) {
18701
18702                     /* Here is /l:  Use EXACTL, except /li indicates EXACTFL,
18703                      * as that means there is a fold not known until runtime so
18704                      * shows as only a single code point here. */
18705                     op = (FOLD) ? EXACTFL : EXACTL;
18706                 }
18707                 else if (! FOLD) { /* Not /l and not /i */
18708                     op = (start[0] < 256) ? EXACT : EXACT_ONLY8;
18709                 }
18710                 else if (start[0] < 256) { /* /i, not /l, and the code point is
18711                                               small */
18712
18713                     /* Under /i, it gets a little tricky.  A code point that
18714                      * doesn't participate in a fold should be an EXACT node.
18715                      * We know this one isn't the result of a simple fold, or
18716                      * there'd be more than one code point in the list, but it
18717                      * could be part of a multi- character fold.  In that case
18718                      * we better not create an EXACT node, as we would wrongly
18719                      * be telling the optimizer that this code point must be in
18720                      * the target string, and that is wrong.  This is because
18721                      * if the sequence around this code point forms a
18722                      * multi-char fold, what needs to be in the string could be
18723                      * the code point that folds to the sequence.
18724                      *
18725                      * This handles the case of below-255 code points, as we
18726                      * have an easy look up for those.  The next clause handles
18727                      * the above-256 one */
18728                     op = IS_IN_SOME_FOLD_L1(start[0])
18729                          ? EXACTFU
18730                          : EXACT;
18731                 }
18732                 else {  /* /i, larger code point.  Since we are under /i, and
18733                            have just this code point, we know that it can't
18734                            fold to something else, so PL_InMultiCharFold
18735                            applies to it */
18736                     op = _invlist_contains_cp(PL_InMultiCharFold,
18737                                               start[0])
18738                          ? EXACTFU_ONLY8
18739                          : EXACT_ONLY8;
18740                 }
18741
18742                 value = start[0];
18743             }
18744             else if (  ! (has_runtime_dependency & ~HAS_D_RUNTIME_DEPENDENCY)
18745                      && _invlist_contains_cp(PL_in_some_fold, start[0]))
18746             {
18747                 /* Here, the only runtime dependency, if any, is from /d, and
18748                  * the class matches more than one code point, and the lowest
18749                  * code point participates in some fold.  It might be that the
18750                  * other code points are /i equivalent to this one, and hence
18751                  * they would representable by an EXACTFish node.  Above, we
18752                  * eliminated classes that contain too many code points to be
18753                  * EXACTFish, with the test for MAX_FOLD_FROMS
18754                  *
18755                  * First, special case the ASCII fold pairs, like 'B' and 'b'.
18756                  * We do this because we have EXACTFAA at our disposal for the
18757                  * ASCII range */
18758                 if (partial_cp_count == 2 && isASCII(start[0])) {
18759
18760                     /* The only ASCII characters that participate in folds are
18761                      * alphabetics */
18762                     assert(isALPHA(start[0]));
18763                     if (   end[0] == start[0]   /* First range is a single
18764                                                    character, so 2nd exists */
18765                         && isALPHA_FOLD_EQ(start[0], start[1]))
18766                     {
18767
18768                         /* Here, is part of an ASCII fold pair */
18769
18770                         if (   ASCII_FOLD_RESTRICTED
18771                             || HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(start[0]))
18772                         {
18773                             /* If the second clause just above was true, it
18774                              * means we can't be under /i, or else the list
18775                              * would have included more than this fold pair.
18776                              * Therefore we have to exclude the possibility of
18777                              * whatever else it is that folds to these, by
18778                              * using EXACTFAA */
18779                             op = EXACTFAA;
18780                         }
18781                         else if (HAS_NONLATIN1_FOLD_CLOSURE(start[0])) {
18782
18783                             /* Here, there's no simple fold that start[0] is part
18784                              * of, but there is a multi-character one.  If we
18785                              * are not under /i, we want to exclude that
18786                              * possibility; if under /i, we want to include it
18787                              * */
18788                             op = (FOLD) ? EXACTFU : EXACTFAA;
18789                         }
18790                         else {
18791
18792                             /* Here, the only possible fold start[0] particpates in
18793                              * is with start[1].  /i or not isn't relevant */
18794                             op = EXACTFU;
18795                         }
18796
18797                         value = toFOLD(start[0]);
18798                     }
18799                 }
18800                 else if (  ! upper_latin1_only_utf8_matches
18801                          || (   _invlist_len(upper_latin1_only_utf8_matches)
18802                                                                           == 2
18803                              && PL_fold_latin1[
18804                                invlist_highest(upper_latin1_only_utf8_matches)]
18805                              == start[0]))
18806                 {
18807                     /* Here, the smallest character is non-ascii or there are
18808                      * more than 2 code points matched by this node.  Also, we
18809                      * either don't have /d UTF-8 dependent matches, or if we
18810                      * do, they look like they could be a single character that
18811                      * is the fold of the lowest one in the always-match list.
18812                      * This test quickly excludes most of the false positives
18813                      * when there are /d UTF-8 depdendent matches.  These are
18814                      * like LATIN CAPITAL LETTER A WITH GRAVE matching LATIN
18815                      * SMALL LETTER A WITH GRAVE iff the target string is
18816                      * UTF-8.  (We don't have to worry above about exceeding
18817                      * the array bounds of PL_fold_latin1[] because any code
18818                      * point in 'upper_latin1_only_utf8_matches' is below 256.)
18819                      *
18820                      * EXACTFAA would apply only to pairs (hence exactly 2 code
18821                      * points) in the ASCII range, so we can't use it here to
18822                      * artificially restrict the fold domain, so we check if
18823                      * the class does or does not match some EXACTFish node.
18824                      * Further, if we aren't under /i, and and the folded-to
18825                      * character is part of a multi-character fold, we can't do
18826                      * this optimization, as the sequence around it could be
18827                      * that multi-character fold, and we don't here know the
18828                      * context, so we have to assume it is that multi-char
18829                      * fold, to prevent potential bugs.
18830                      *
18831                      * To do the general case, we first find the fold of the
18832                      * lowest code point (which may be higher than the lowest
18833                      * one), then find everything that folds to it.  (The data
18834                      * structure we have only maps from the folded code points,
18835                      * so we have to do the earlier step.) */
18836
18837                     Size_t foldlen;
18838                     U8 foldbuf[UTF8_MAXBYTES_CASE];
18839                     UV folded = _to_uni_fold_flags(start[0],
18840                                                         foldbuf, &foldlen, 0);
18841                     unsigned int first_fold;
18842                     const unsigned int * remaining_folds;
18843                     Size_t folds_to_this_cp_count = _inverse_folds(
18844                                                             folded,
18845                                                             &first_fold,
18846                                                             &remaining_folds);
18847                     Size_t folds_count = folds_to_this_cp_count + 1;
18848                     SV * fold_list = _new_invlist(folds_count);
18849                     unsigned int i;
18850
18851                     /* If there are UTF-8 dependent matches, create a temporary
18852                      * list of what this node matches, including them. */
18853                     SV * all_cp_list = NULL;
18854                     SV ** use_this_list = &cp_list;
18855
18856                     if (upper_latin1_only_utf8_matches) {
18857                         all_cp_list = _new_invlist(0);
18858                         use_this_list = &all_cp_list;
18859                         _invlist_union(cp_list,
18860                                        upper_latin1_only_utf8_matches,
18861                                        use_this_list);
18862                     }
18863
18864                     /* Having gotten everything that participates in the fold
18865                      * containing the lowest code point, we turn that into an
18866                      * inversion list, making sure everything is included. */
18867                     fold_list = add_cp_to_invlist(fold_list, start[0]);
18868                     fold_list = add_cp_to_invlist(fold_list, folded);
18869                     if (folds_to_this_cp_count > 0) {
18870                         fold_list = add_cp_to_invlist(fold_list, first_fold);
18871                         for (i = 0; i + 1 < folds_to_this_cp_count; i++) {
18872                             fold_list = add_cp_to_invlist(fold_list,
18873                                                         remaining_folds[i]);
18874                         }
18875                     }
18876
18877                     /* If the fold list is identical to what's in this ANYOF
18878                      * node, the node can be represented by an EXACTFish one
18879                      * instead */
18880                     if (_invlistEQ(*use_this_list, fold_list,
18881                                    0 /* Don't complement */ )
18882                     ) {
18883
18884                         /* But, we have to be careful, as mentioned above.
18885                          * Just the right sequence of characters could match
18886                          * this if it is part of a multi-character fold.  That
18887                          * IS what we want if we are under /i.  But it ISN'T
18888                          * what we want if not under /i, as it could match when
18889                          * it shouldn't.  So, when we aren't under /i and this
18890                          * character participates in a multi-char fold, we
18891                          * don't optimize into an EXACTFish node.  So, for each
18892                          * case below we have to check if we are folding
18893                          * and if not, if it is not part of a multi-char fold.
18894                          * */
18895                         if (start[0] > 255) {    /* Highish code point */
18896                             if (FOLD || ! _invlist_contains_cp(
18897                                             PL_InMultiCharFold, folded))
18898                             {
18899                                 op = (LOC)
18900                                      ? EXACTFLU8
18901                                      : (ASCII_FOLD_RESTRICTED)
18902                                        ? EXACTFAA
18903                                        : EXACTFU_ONLY8;
18904                                 value = folded;
18905                             }
18906                         }   /* Below, the lowest code point < 256 */
18907                         else if (    FOLD
18908                                  &&  folded == 's'
18909                                  &&  DEPENDS_SEMANTICS)
18910                         {   /* An EXACTF node containing a single character
18911                                 's', can be an EXACTFU if it doesn't get
18912                                 joined with an adjacent 's' */
18913                             op = EXACTFU_S_EDGE;
18914                             value = folded;
18915                         }
18916                         else if (    FOLD
18917                                 || ! HAS_NONLATIN1_FOLD_CLOSURE(start[0]))
18918                         {
18919                             if (upper_latin1_only_utf8_matches) {
18920                                 op = EXACTF;
18921
18922                                 /* We can't use the fold, as that only matches
18923                                  * under UTF-8 */
18924                                 value = start[0];
18925                             }
18926                             else if (     UNLIKELY(start[0] == MICRO_SIGN)
18927                                      && ! UTF)
18928                             {   /* EXACTFUP is a special node for this
18929                                    character */
18930                                 op = (ASCII_FOLD_RESTRICTED)
18931                                      ? EXACTFAA
18932                                      : EXACTFUP;
18933                                 value = MICRO_SIGN;
18934                             }
18935                             else if (     ASCII_FOLD_RESTRICTED
18936                                      && ! isASCII(start[0]))
18937                             {   /* For ASCII under /iaa, we can use EXACTFU
18938                                    below */
18939                                 op = EXACTFAA;
18940                                 value = folded;
18941                             }
18942                             else {
18943                                 op = EXACTFU;
18944                                 value = folded;
18945                             }
18946                         }
18947                     }
18948
18949                     SvREFCNT_dec_NN(fold_list);
18950                     SvREFCNT_dec(all_cp_list);
18951                 }
18952             }
18953
18954             if (op != END) {
18955
18956                 /* Here, we have calculated what EXACTish node we would use.
18957                  * But we don't use it if it would require converting the
18958                  * pattern to UTF-8, unless not using it could cause us to miss
18959                  * some folds (hence be buggy) */
18960
18961                 if (! UTF && value > 255) {
18962                     SV * in_multis = NULL;
18963
18964                     assert(FOLD);
18965
18966                     /* If there is no code point that is part of a multi-char
18967                      * fold, then there aren't any matches, so we don't do this
18968                      * optimization.  Otherwise, it could match depending on
18969                      * the context around us, so we do upgrade */
18970                     _invlist_intersection(PL_InMultiCharFold, cp_list, &in_multis);
18971                     if (UNLIKELY(_invlist_len(in_multis) != 0)) {
18972                         REQUIRE_UTF8(flagp);
18973                     }
18974                     else {
18975                         op = END;
18976                     }
18977                 }
18978
18979                 if (op != END) {
18980                     U8 len = (UTF) ? UVCHR_SKIP(value) : 1;
18981
18982                     ret = regnode_guts(pRExC_state, op, len, "exact");
18983                     FILL_NODE(ret, op);
18984                     RExC_emit += 1 + STR_SZ(len);
18985                     setSTR_LEN(REGNODE_p(ret), len);
18986                     if (len == 1) {
18987                         *STRING(REGNODE_p(ret)) = (U8) value;
18988                     }
18989                     else {
18990                         uvchr_to_utf8((U8 *) STRING(REGNODE_p(ret)), value);
18991                     }
18992                     goto not_anyof;
18993                 }
18994             }
18995         }
18996
18997         if (! has_runtime_dependency) {
18998
18999             /* See if this can be turned into an ANYOFM node.  Think about the
19000              * bit patterns in two different bytes.  In some positions, the
19001              * bits in each will be 1; and in other positions both will be 0;
19002              * and in some positions the bit will be 1 in one byte, and 0 in
19003              * the other.  Let 'n' be the number of positions where the bits
19004              * differ.  We create a mask which has exactly 'n' 0 bits, each in
19005              * a position where the two bytes differ.  Now take the set of all
19006              * bytes that when ANDed with the mask yield the same result.  That
19007              * set has 2**n elements, and is representable by just two 8 bit
19008              * numbers: the result and the mask.  Importantly, matching the set
19009              * can be vectorized by creating a word full of the result bytes,
19010              * and a word full of the mask bytes, yielding a significant speed
19011              * up.  Here, see if this node matches such a set.  As a concrete
19012              * example consider [01], and the byte representing '0' which is
19013              * 0x30 on ASCII machines.  It has the bits 0011 0000.  Take the
19014              * mask 1111 1110.  If we AND 0x31 and 0x30 with that mask we get
19015              * 0x30.  Any other bytes ANDed yield something else.  So [01],
19016              * which is a common usage, is optimizable into ANYOFM, and can
19017              * benefit from the speed up.  We can only do this on UTF-8
19018              * invariant bytes, because they have the same bit patterns under
19019              * UTF-8 as not. */
19020             PERL_UINT_FAST8_T inverted = 0;
19021 #ifdef EBCDIC
19022             const PERL_UINT_FAST8_T max_permissible = 0xFF;
19023 #else
19024             const PERL_UINT_FAST8_T max_permissible = 0x7F;
19025 #endif
19026             /* If doesn't fit the criteria for ANYOFM, invert and try again.
19027              * If that works we will instead later generate an NANYOFM, and
19028              * invert back when through */
19029             if (invlist_highest(cp_list) > max_permissible) {
19030                 _invlist_invert(cp_list);
19031                 inverted = 1;
19032             }
19033
19034             if (invlist_highest(cp_list) <= max_permissible) {
19035                 UV this_start, this_end;
19036                 UV lowest_cp = UV_MAX;  /* inited to suppress compiler warn */
19037                 U8 bits_differing = 0;
19038                 Size_t full_cp_count = 0;
19039                 bool first_time = TRUE;
19040
19041                 /* Go through the bytes and find the bit positions that differ
19042                  * */
19043                 invlist_iterinit(cp_list);
19044                 while (invlist_iternext(cp_list, &this_start, &this_end)) {
19045                     unsigned int i = this_start;
19046
19047                     if (first_time) {
19048                         if (! UVCHR_IS_INVARIANT(i)) {
19049                             goto done_anyofm;
19050                         }
19051
19052                         first_time = FALSE;
19053                         lowest_cp = this_start;
19054
19055                         /* We have set up the code point to compare with.
19056                          * Don't compare it with itself */
19057                         i++;
19058                     }
19059
19060                     /* Find the bit positions that differ from the lowest code
19061                      * point in the node.  Keep track of all such positions by
19062                      * OR'ing */
19063                     for (; i <= this_end; i++) {
19064                         if (! UVCHR_IS_INVARIANT(i)) {
19065                             goto done_anyofm;
19066                         }
19067
19068                         bits_differing  |= i ^ lowest_cp;
19069                     }
19070
19071                     full_cp_count += this_end - this_start + 1;
19072                 }
19073
19074                 /* At the end of the loop, we count how many bits differ from
19075                  * the bits in lowest code point, call the count 'd'.  If the
19076                  * set we found contains 2**d elements, it is the closure of
19077                  * all code points that differ only in those bit positions.  To
19078                  * convince yourself of that, first note that the number in the
19079                  * closure must be a power of 2, which we test for.  The only
19080                  * way we could have that count and it be some differing set,
19081                  * is if we got some code points that don't differ from the
19082                  * lowest code point in any position, but do differ from each
19083                  * other in some other position.  That means one code point has
19084                  * a 1 in that position, and another has a 0.  But that would
19085                  * mean that one of them differs from the lowest code point in
19086                  * that position, which possibility we've already excluded.  */
19087                 if (  (inverted || full_cp_count > 1)
19088                     && full_cp_count == 1U << PL_bitcount[bits_differing])
19089                 {
19090                     U8 ANYOFM_mask;
19091
19092                     op = ANYOFM + inverted;;
19093
19094                     /* We need to make the bits that differ be 0's */
19095                     ANYOFM_mask = ~ bits_differing; /* This goes into FLAGS */
19096
19097                     /* The argument is the lowest code point */
19098                     ret = reganode(pRExC_state, op, lowest_cp);
19099                     FLAGS(REGNODE_p(ret)) = ANYOFM_mask;
19100                 }
19101
19102               done_anyofm:
19103                 invlist_iterfinish(cp_list);
19104             }
19105
19106             if (inverted) {
19107                 _invlist_invert(cp_list);
19108             }
19109
19110             if (op != END) {
19111                 goto not_anyof;
19112             }
19113         }
19114
19115         if (! (anyof_flags & ANYOF_LOCALE_FLAGS)) {
19116             PERL_UINT_FAST8_T type;
19117             SV * intersection = NULL;
19118             SV* d_invlist = NULL;
19119
19120             /* See if this matches any of the POSIX classes.  The POSIXA and
19121              * POSIXD ones are about the same speed as ANYOF ops, but take less
19122              * room; the ones that have above-Latin1 code point matches are
19123              * somewhat faster than ANYOF.  */
19124
19125             for (type = POSIXA; type >= POSIXD; type--) {
19126                 int posix_class;
19127
19128                 if (type == POSIXL) {   /* But not /l posix classes */
19129                     continue;
19130                 }
19131
19132                 for (posix_class = 0;
19133                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
19134                      posix_class++)
19135                 {
19136                     SV** our_code_points = &cp_list;
19137                     SV** official_code_points;
19138                     int try_inverted;
19139
19140                     if (type == POSIXA) {
19141                         official_code_points = &PL_Posix_ptrs[posix_class];
19142                     }
19143                     else {
19144                         official_code_points = &PL_XPosix_ptrs[posix_class];
19145                     }
19146
19147                     /* Skip non-existent classes of this type.  e.g. \v only
19148                      * has an entry in PL_XPosix_ptrs */
19149                     if (! *official_code_points) {
19150                         continue;
19151                     }
19152
19153                     /* Try both the regular class, and its inversion */
19154                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
19155                         bool this_inverted = invert ^ try_inverted;
19156
19157                         if (type != POSIXD) {
19158
19159                             /* This class that isn't /d can't match if we have
19160                              * /d dependencies */
19161                             if (has_runtime_dependency
19162                                                     & HAS_D_RUNTIME_DEPENDENCY)
19163                             {
19164                                 continue;
19165                             }
19166                         }
19167                         else /* is /d */ if (! this_inverted) {
19168
19169                             /* /d classes don't match anything non-ASCII below
19170                              * 256 unconditionally (which cp_list contains) */
19171                             _invlist_intersection(cp_list, PL_UpperLatin1,
19172                                                            &intersection);
19173                             if (_invlist_len(intersection) != 0) {
19174                                 continue;
19175                             }
19176
19177                             SvREFCNT_dec(d_invlist);
19178                             d_invlist = invlist_clone(cp_list, NULL);
19179
19180                             /* But under UTF-8 it turns into using /u rules.
19181                              * Add the things it matches under these conditions
19182                              * so that we check below that these are identical
19183                              * to what the tested class should match */
19184                             if (upper_latin1_only_utf8_matches) {
19185                                 _invlist_union(
19186                                             d_invlist,
19187                                             upper_latin1_only_utf8_matches,
19188                                             &d_invlist);
19189                             }
19190                             our_code_points = &d_invlist;
19191                         }
19192                         else {  /* POSIXD, inverted.  If this doesn't have this
19193                                    flag set, it isn't /d. */
19194                             if (! (anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
19195                             {
19196                                 continue;
19197                             }
19198                             our_code_points = &cp_list;
19199                         }
19200
19201                         /* Here, have weeded out some things.  We want to see
19202                          * if the list of characters this node contains
19203                          * ('*our_code_points') precisely matches those of the
19204                          * class we are currently checking against
19205                          * ('*official_code_points'). */
19206                         if (_invlistEQ(*our_code_points,
19207                                        *official_code_points,
19208                                        try_inverted))
19209                         {
19210                             /* Here, they precisely match.  Optimize this ANYOF
19211                              * node into its equivalent POSIX one of the
19212                              * correct type, possibly inverted */
19213                             ret = reg_node(pRExC_state, (try_inverted)
19214                                                         ? type + NPOSIXA
19215                                                                 - POSIXA
19216                                                         : type);
19217                             FLAGS(REGNODE_p(ret)) = posix_class;
19218                             SvREFCNT_dec(d_invlist);
19219                             SvREFCNT_dec(intersection);
19220                             goto not_anyof;
19221                         }
19222                     }
19223                 }
19224             }
19225             SvREFCNT_dec(d_invlist);
19226             SvREFCNT_dec(intersection);
19227         }
19228
19229         /* If didn't find an optimization and there is no need for a bitmap,
19230          * optimize to indicate that */
19231         if (     start[0] >= NUM_ANYOF_CODE_POINTS
19232             && ! LOC
19233             && ! upper_latin1_only_utf8_matches
19234             &&   anyof_flags == 0)
19235         {
19236             U8 low_utf8[UTF8_MAXBYTES+1];
19237             UV highest_cp = invlist_highest(cp_list);
19238
19239             op = ANYOFH;
19240
19241             /* Currently the maximum allowed code point by the system is
19242              * IV_MAX.  Higher ones are reserved for future internal use.  This
19243              * particular regnode can be used for higher ones, but we can't
19244              * calculate the code point of those.  IV_MAX suffices though, as
19245              * it will be a large first byte */
19246             (void) uvchr_to_utf8(low_utf8, MIN(start[0], IV_MAX));
19247
19248             /* We store the lowest possible first byte of the UTF-8
19249              * representation, using the flags field.  This allows for quick
19250              * ruling out of some inputs without having to convert from UTF-8
19251              * to code point.  For EBCDIC, this has to be I8. */
19252             anyof_flags = NATIVE_UTF8_TO_I8(low_utf8[0]);
19253
19254             /* If the first UTF-8 start byte for the highest code point in the
19255              * range is suitably small, we may be able to get an upper bound as
19256              * well */
19257             if (highest_cp <= IV_MAX) {
19258                 U8 high_utf8[UTF8_MAXBYTES+1];
19259
19260                 (void) uvchr_to_utf8(high_utf8, highest_cp);
19261
19262                 /* If the lowest and highest are the same, we can get an exact
19263                  * first byte instead of a just minimum.  We signal this with a
19264                  * different regnode */
19265                 if (low_utf8[0] == high_utf8[0]) {
19266
19267                     /* No need to convert to I8 for EBCDIC as this is an exact
19268                      * match */
19269                     anyof_flags = low_utf8[0];
19270                     op = ANYOFHb;
19271                 }
19272                 else if (NATIVE_UTF8_TO_I8(high_utf8[0]) <= MAX_ANYOF_HRx_BYTE)
19273                 {
19274
19275                     /* Here, the high byte is not the same as the low, but is
19276                      * small enough that its reasonable to have a loose upper
19277                      * bound, which is packed in with the strict lower bound.
19278                      * See comments at the definition of MAX_ANYOF_HRx_BYTE.
19279                      * On EBCDIC platforms, I8 is used.  On ASCII platforms I8
19280                      * is the same thing as UTF-8 */
19281
19282                     U8 bits = 0;
19283                     U8 max_range_diff = MAX_ANYOF_HRx_BYTE - anyof_flags;
19284                     U8 range_diff = NATIVE_UTF8_TO_I8(high_utf8[0])
19285                                   - anyof_flags;
19286
19287                     if (range_diff <= max_range_diff / 8) {
19288                         bits = 3;
19289                     }
19290                     else if (range_diff <= max_range_diff / 4) {
19291                         bits = 2;
19292                     }
19293                     else if (range_diff <= max_range_diff / 2) {
19294                         bits = 1;
19295                     }
19296                     anyof_flags = (anyof_flags - 0xC0) << 2 | bits;
19297                     op = ANYOFHr;
19298                 }
19299             }
19300
19301             goto done_finding_op;
19302         }
19303     }   /* End of seeing if can optimize it into a different node */
19304
19305   is_anyof: /* It's going to be an ANYOF node. */
19306     op = (has_runtime_dependency & HAS_D_RUNTIME_DEPENDENCY)
19307          ? ANYOFD
19308          : ((posixl)
19309             ? ANYOFPOSIXL
19310             : ((LOC)
19311                ? ANYOFL
19312                : ANYOF));
19313
19314   done_finding_op:
19315
19316     ret = regnode_guts(pRExC_state, op, regarglen[op], "anyof");
19317     FILL_NODE(ret, op);        /* We set the argument later */
19318     RExC_emit += 1 + regarglen[op];
19319     ANYOF_FLAGS(REGNODE_p(ret)) = anyof_flags;
19320
19321     /* Here, <cp_list> contains all the code points we can determine at
19322      * compile time that match under all conditions.  Go through it, and
19323      * for things that belong in the bitmap, put them there, and delete from
19324      * <cp_list>.  While we are at it, see if everything above 255 is in the
19325      * list, and if so, set a flag to speed up execution */
19326
19327     populate_ANYOF_from_invlist(REGNODE_p(ret), &cp_list);
19328
19329     if (posixl) {
19330         ANYOF_POSIXL_SET_TO_BITMAP(REGNODE_p(ret), posixl);
19331     }
19332
19333     if (invert) {
19334         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_INVERT;
19335     }
19336
19337     /* Here, the bitmap has been populated with all the Latin1 code points that
19338      * always match.  Can now add to the overall list those that match only
19339      * when the target string is UTF-8 (<upper_latin1_only_utf8_matches>).
19340      * */
19341     if (upper_latin1_only_utf8_matches) {
19342         if (cp_list) {
19343             _invlist_union(cp_list,
19344                            upper_latin1_only_utf8_matches,
19345                            &cp_list);
19346             SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
19347         }
19348         else {
19349             cp_list = upper_latin1_only_utf8_matches;
19350         }
19351         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
19352     }
19353
19354     set_ANYOF_arg(pRExC_state, REGNODE_p(ret), cp_list,
19355                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
19356                    ? listsv : NULL,
19357                   only_utf8_locale_list);
19358     return ret;
19359
19360   not_anyof:
19361
19362     /* Here, the node is getting optimized into something that's not an ANYOF
19363      * one.  Finish up. */
19364
19365     Set_Node_Offset_Length(REGNODE_p(ret), orig_parse - RExC_start,
19366                                            RExC_parse - orig_parse);;
19367     SvREFCNT_dec(cp_list);;
19368     return ret;
19369 }
19370
19371 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
19372
19373 STATIC void
19374 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
19375                 regnode* const node,
19376                 SV* const cp_list,
19377                 SV* const runtime_defns,
19378                 SV* const only_utf8_locale_list)
19379 {
19380     /* Sets the arg field of an ANYOF-type node 'node', using information about
19381      * the node passed-in.  If there is nothing outside the node's bitmap, the
19382      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
19383      * the count returned by add_data(), having allocated and stored an array,
19384      * av, as follows:
19385      *
19386      *  av[0] stores the inversion list defining this class as far as known at
19387      *        this time, or PL_sv_undef if nothing definite is now known.
19388      *  av[1] stores the inversion list of code points that match only if the
19389      *        current locale is UTF-8, or if none, PL_sv_undef if there is an
19390      *        av[2], or no entry otherwise.
19391      *  av[2] stores the list of user-defined properties whose subroutine
19392      *        definitions aren't known at this time, or no entry if none. */
19393
19394     UV n;
19395
19396     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
19397
19398     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
19399         assert(! (ANYOF_FLAGS(node)
19400                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
19401         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
19402     }
19403     else {
19404         AV * const av = newAV();
19405         SV *rv;
19406
19407         if (cp_list) {
19408             av_store(av, INVLIST_INDEX, cp_list);
19409         }
19410
19411         if (only_utf8_locale_list) {
19412             av_store(av, ONLY_LOCALE_MATCHES_INDEX, only_utf8_locale_list);
19413         }
19414
19415         if (runtime_defns) {
19416             av_store(av, DEFERRED_USER_DEFINED_INDEX, SvREFCNT_inc(runtime_defns));
19417         }
19418
19419         rv = newRV_noinc(MUTABLE_SV(av));
19420         n = add_data(pRExC_state, STR_WITH_LEN("s"));
19421         RExC_rxi->data->data[n] = (void*)rv;
19422         ARG_SET(node, n);
19423     }
19424 }
19425
19426 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
19427 SV *
19428 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
19429                                         const regnode* node,
19430                                         bool doinit,
19431                                         SV** listsvp,
19432                                         SV** only_utf8_locale_ptr,
19433                                         SV** output_invlist)
19434
19435 {
19436     /* For internal core use only.
19437      * Returns the inversion list for the input 'node' in the regex 'prog'.
19438      * If <doinit> is 'true', will attempt to create the inversion list if not
19439      *    already done.
19440      * If <listsvp> is non-null, will return the printable contents of the
19441      *    property definition.  This can be used to get debugging information
19442      *    even before the inversion list exists, by calling this function with
19443      *    'doinit' set to false, in which case the components that will be used
19444      *    to eventually create the inversion list are returned  (in a printable
19445      *    form).
19446      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
19447      *    store an inversion list of code points that should match only if the
19448      *    execution-time locale is a UTF-8 one.
19449      * If <output_invlist> is not NULL, it is where this routine is to store an
19450      *    inversion list of the code points that would be instead returned in
19451      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
19452      *    when this parameter is used, is just the non-code point data that
19453      *    will go into creating the inversion list.  This currently should be just
19454      *    user-defined properties whose definitions were not known at compile
19455      *    time.  Using this parameter allows for easier manipulation of the
19456      *    inversion list's data by the caller.  It is illegal to call this
19457      *    function with this parameter set, but not <listsvp>
19458      *
19459      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
19460      * that, in spite of this function's name, the inversion list it returns
19461      * may include the bitmap data as well */
19462
19463     SV *si  = NULL;         /* Input initialization string */
19464     SV* invlist = NULL;
19465
19466     RXi_GET_DECL(prog, progi);
19467     const struct reg_data * const data = prog ? progi->data : NULL;
19468
19469     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
19470     assert(! output_invlist || listsvp);
19471
19472     if (data && data->count) {
19473         const U32 n = ARG(node);
19474
19475         if (data->what[n] == 's') {
19476             SV * const rv = MUTABLE_SV(data->data[n]);
19477             AV * const av = MUTABLE_AV(SvRV(rv));
19478             SV **const ary = AvARRAY(av);
19479
19480             invlist = ary[INVLIST_INDEX];
19481
19482             if (av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX) {
19483                 *only_utf8_locale_ptr = ary[ONLY_LOCALE_MATCHES_INDEX];
19484             }
19485
19486             if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
19487                 si = ary[DEFERRED_USER_DEFINED_INDEX];
19488             }
19489
19490             if (doinit && (si || invlist)) {
19491                 if (si) {
19492                     bool user_defined;
19493                     SV * msg = newSVpvs_flags("", SVs_TEMP);
19494
19495                     SV * prop_definition = handle_user_defined_property(
19496                             "", 0, FALSE,   /* There is no \p{}, \P{} */
19497                             SvPVX_const(si)[1] - '0',   /* /i or not has been
19498                                                            stored here for just
19499                                                            this occasion */
19500                             TRUE,           /* run time */
19501                             FALSE,          /* This call must find the defn */
19502                             si,             /* The property definition  */
19503                             &user_defined,
19504                             msg,
19505                             0               /* base level call */
19506                            );
19507
19508                     if (SvCUR(msg)) {
19509                         assert(prop_definition == NULL);
19510
19511                         Perl_croak(aTHX_ "%" UTF8f,
19512                                 UTF8fARG(SvUTF8(msg), SvCUR(msg), SvPVX(msg)));
19513                     }
19514
19515                     if (invlist) {
19516                         _invlist_union(invlist, prop_definition, &invlist);
19517                         SvREFCNT_dec_NN(prop_definition);
19518                     }
19519                     else {
19520                         invlist = prop_definition;
19521                     }
19522
19523                     STATIC_ASSERT_STMT(ONLY_LOCALE_MATCHES_INDEX == 1 + INVLIST_INDEX);
19524                     STATIC_ASSERT_STMT(DEFERRED_USER_DEFINED_INDEX == 1 + ONLY_LOCALE_MATCHES_INDEX);
19525
19526                     av_store(av, INVLIST_INDEX, invlist);
19527                     av_fill(av, (ary[ONLY_LOCALE_MATCHES_INDEX])
19528                                  ? ONLY_LOCALE_MATCHES_INDEX:
19529                                  INVLIST_INDEX);
19530                     si = NULL;
19531                 }
19532             }
19533         }
19534     }
19535
19536     /* If requested, return a printable version of what this ANYOF node matches
19537      * */
19538     if (listsvp) {
19539         SV* matches_string = NULL;
19540
19541         /* This function can be called at compile-time, before everything gets
19542          * resolved, in which case we return the currently best available
19543          * information, which is the string that will eventually be used to do
19544          * that resolving, 'si' */
19545         if (si) {
19546             /* Here, we only have 'si' (and possibly some passed-in data in
19547              * 'invlist', which is handled below)  If the caller only wants
19548              * 'si', use that.  */
19549             if (! output_invlist) {
19550                 matches_string = newSVsv(si);
19551             }
19552             else {
19553                 /* But if the caller wants an inversion list of the node, we
19554                  * need to parse 'si' and place as much as possible in the
19555                  * desired output inversion list, making 'matches_string' only
19556                  * contain the currently unresolvable things */
19557                 const char *si_string = SvPVX(si);
19558                 STRLEN remaining = SvCUR(si);
19559                 UV prev_cp = 0;
19560                 U8 count = 0;
19561
19562                 /* Ignore everything before the first new-line */
19563                 while (*si_string != '\n' && remaining > 0) {
19564                     si_string++;
19565                     remaining--;
19566                 }
19567                 assert(remaining > 0);
19568
19569                 si_string++;
19570                 remaining--;
19571
19572                 while (remaining > 0) {
19573
19574                     /* The data consists of just strings defining user-defined
19575                      * property names, but in prior incarnations, and perhaps
19576                      * somehow from pluggable regex engines, it could still
19577                      * hold hex code point definitions.  Each component of a
19578                      * range would be separated by a tab, and each range by a
19579                      * new-line.  If these are found, instead add them to the
19580                      * inversion list */
19581                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
19582                                      |PERL_SCAN_SILENT_NON_PORTABLE;
19583                     STRLEN len = remaining;
19584                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
19585
19586                     /* If the hex decode routine found something, it should go
19587                      * up to the next \n */
19588                     if (   *(si_string + len) == '\n') {
19589                         if (count) {    /* 2nd code point on line */
19590                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
19591                         }
19592                         else {
19593                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
19594                         }
19595                         count = 0;
19596                         goto prepare_for_next_iteration;
19597                     }
19598
19599                     /* If the hex decode was instead for the lower range limit,
19600                      * save it, and go parse the upper range limit */
19601                     if (*(si_string + len) == '\t') {
19602                         assert(count == 0);
19603
19604                         prev_cp = cp;
19605                         count = 1;
19606                       prepare_for_next_iteration:
19607                         si_string += len + 1;
19608                         remaining -= len + 1;
19609                         continue;
19610                     }
19611
19612                     /* Here, didn't find a legal hex number.  Just add it from
19613                      * here to the next \n */
19614
19615                     remaining -= len;
19616                     while (*(si_string + len) != '\n' && remaining > 0) {
19617                         remaining--;
19618                         len++;
19619                     }
19620                     if (*(si_string + len) == '\n') {
19621                         len++;
19622                         remaining--;
19623                     }
19624                     if (matches_string) {
19625                         sv_catpvn(matches_string, si_string, len - 1);
19626                     }
19627                     else {
19628                         matches_string = newSVpvn(si_string, len - 1);
19629                     }
19630                     si_string += len;
19631                     sv_catpvs(matches_string, " ");
19632                 } /* end of loop through the text */
19633
19634                 assert(matches_string);
19635                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
19636                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
19637                 }
19638             } /* end of has an 'si' */
19639         }
19640
19641         /* Add the stuff that's already known */
19642         if (invlist) {
19643
19644             /* Again, if the caller doesn't want the output inversion list, put
19645              * everything in 'matches-string' */
19646             if (! output_invlist) {
19647                 if ( ! matches_string) {
19648                     matches_string = newSVpvs("\n");
19649                 }
19650                 sv_catsv(matches_string, invlist_contents(invlist,
19651                                                   TRUE /* traditional style */
19652                                                   ));
19653             }
19654             else if (! *output_invlist) {
19655                 *output_invlist = invlist_clone(invlist, NULL);
19656             }
19657             else {
19658                 _invlist_union(*output_invlist, invlist, output_invlist);
19659             }
19660         }
19661
19662         *listsvp = matches_string;
19663     }
19664
19665     return invlist;
19666 }
19667 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
19668
19669 /* reg_skipcomment()
19670
19671    Absorbs an /x style # comment from the input stream,
19672    returning a pointer to the first character beyond the comment, or if the
19673    comment terminates the pattern without anything following it, this returns
19674    one past the final character of the pattern (in other words, RExC_end) and
19675    sets the REG_RUN_ON_COMMENT_SEEN flag.
19676
19677    Note it's the callers responsibility to ensure that we are
19678    actually in /x mode
19679
19680 */
19681
19682 PERL_STATIC_INLINE char*
19683 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
19684 {
19685     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
19686
19687     assert(*p == '#');
19688
19689     while (p < RExC_end) {
19690         if (*(++p) == '\n') {
19691             return p+1;
19692         }
19693     }
19694
19695     /* we ran off the end of the pattern without ending the comment, so we have
19696      * to add an \n when wrapping */
19697     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
19698     return p;
19699 }
19700
19701 STATIC void
19702 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
19703                                 char ** p,
19704                                 const bool force_to_xmod
19705                          )
19706 {
19707     /* If the text at the current parse position '*p' is a '(?#...)' comment,
19708      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
19709      * is /x whitespace, advance '*p' so that on exit it points to the first
19710      * byte past all such white space and comments */
19711
19712     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
19713
19714     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
19715
19716     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
19717
19718     for (;;) {
19719         if (RExC_end - (*p) >= 3
19720             && *(*p)     == '('
19721             && *(*p + 1) == '?'
19722             && *(*p + 2) == '#')
19723         {
19724             while (*(*p) != ')') {
19725                 if ((*p) == RExC_end)
19726                     FAIL("Sequence (?#... not terminated");
19727                 (*p)++;
19728             }
19729             (*p)++;
19730             continue;
19731         }
19732
19733         if (use_xmod) {
19734             const char * save_p = *p;
19735             while ((*p) < RExC_end) {
19736                 STRLEN len;
19737                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
19738                     (*p) += len;
19739                 }
19740                 else if (*(*p) == '#') {
19741                     (*p) = reg_skipcomment(pRExC_state, (*p));
19742                 }
19743                 else {
19744                     break;
19745                 }
19746             }
19747             if (*p != save_p) {
19748                 continue;
19749             }
19750         }
19751
19752         break;
19753     }
19754
19755     return;
19756 }
19757
19758 /* nextchar()
19759
19760    Advances the parse position by one byte, unless that byte is the beginning
19761    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
19762    those two cases, the parse position is advanced beyond all such comments and
19763    white space.
19764
19765    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
19766 */
19767
19768 STATIC void
19769 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
19770 {
19771     PERL_ARGS_ASSERT_NEXTCHAR;
19772
19773     if (RExC_parse < RExC_end) {
19774         assert(   ! UTF
19775                || UTF8_IS_INVARIANT(*RExC_parse)
19776                || UTF8_IS_START(*RExC_parse));
19777
19778         RExC_parse += (UTF)
19779                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
19780                       : 1;
19781
19782         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
19783                                 FALSE /* Don't force /x */ );
19784     }
19785 }
19786
19787 STATIC void
19788 S_change_engine_size(pTHX_ RExC_state_t *pRExC_state, const Ptrdiff_t size)
19789 {
19790     /* 'size' is the delta number of smallest regnode equivalents to add or
19791      * subtract from the current memory allocated to the regex engine being
19792      * constructed. */
19793
19794     PERL_ARGS_ASSERT_CHANGE_ENGINE_SIZE;
19795
19796     RExC_size += size;
19797
19798     Renewc(RExC_rxi,
19799            sizeof(regexp_internal) + (RExC_size + 1) * sizeof(regnode),
19800                                                 /* +1 for REG_MAGIC */
19801            char,
19802            regexp_internal);
19803     if ( RExC_rxi == NULL )
19804         FAIL("Regexp out of space");
19805     RXi_SET(RExC_rx, RExC_rxi);
19806
19807     RExC_emit_start = RExC_rxi->program;
19808     if (size > 0) {
19809         Zero(REGNODE_p(RExC_emit), size, regnode);
19810     }
19811
19812 #ifdef RE_TRACK_PATTERN_OFFSETS
19813     Renew(RExC_offsets, 2*RExC_size+1, U32);
19814     if (size > 0) {
19815         Zero(RExC_offsets + 2*(RExC_size - size) + 1, 2 * size, U32);
19816     }
19817     RExC_offsets[0] = RExC_size;
19818 #endif
19819 }
19820
19821 STATIC regnode_offset
19822 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
19823 {
19824     /* Allocate a regnode for 'op', with 'extra_size' extra (smallest) regnode
19825      * equivalents space.  It aligns and increments RExC_size and RExC_emit
19826      *
19827      * It returns the regnode's offset into the regex engine program */
19828
19829     const regnode_offset ret = RExC_emit;
19830
19831     GET_RE_DEBUG_FLAGS_DECL;
19832
19833     PERL_ARGS_ASSERT_REGNODE_GUTS;
19834
19835     SIZE_ALIGN(RExC_size);
19836     change_engine_size(pRExC_state, (Ptrdiff_t) 1 + extra_size);
19837     NODE_ALIGN_FILL(REGNODE_p(ret));
19838 #ifndef RE_TRACK_PATTERN_OFFSETS
19839     PERL_UNUSED_ARG(name);
19840     PERL_UNUSED_ARG(op);
19841 #else
19842     assert(extra_size >= regarglen[op] || PL_regkind[op] == ANYOF);
19843
19844     if (RExC_offsets) {         /* MJD */
19845         MJD_OFFSET_DEBUG(
19846               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
19847               name, __LINE__,
19848               PL_reg_name[op],
19849               (UV)(RExC_emit) > RExC_offsets[0]
19850                 ? "Overwriting end of array!\n" : "OK",
19851               (UV)(RExC_emit),
19852               (UV)(RExC_parse - RExC_start),
19853               (UV)RExC_offsets[0]));
19854         Set_Node_Offset(REGNODE_p(RExC_emit), RExC_parse + (op == END));
19855     }
19856 #endif
19857     return(ret);
19858 }
19859
19860 /*
19861 - reg_node - emit a node
19862 */
19863 STATIC regnode_offset /* Location. */
19864 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
19865 {
19866     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
19867     regnode_offset ptr = ret;
19868
19869     PERL_ARGS_ASSERT_REG_NODE;
19870
19871     assert(regarglen[op] == 0);
19872
19873     FILL_ADVANCE_NODE(ptr, op);
19874     RExC_emit = ptr;
19875     return(ret);
19876 }
19877
19878 /*
19879 - reganode - emit a node with an argument
19880 */
19881 STATIC regnode_offset /* Location. */
19882 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
19883 {
19884     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
19885     regnode_offset ptr = ret;
19886
19887     PERL_ARGS_ASSERT_REGANODE;
19888
19889     /* ANYOF are special cased to allow non-length 1 args */
19890     assert(regarglen[op] == 1);
19891
19892     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
19893     RExC_emit = ptr;
19894     return(ret);
19895 }
19896
19897 STATIC regnode_offset
19898 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
19899 {
19900     /* emit a node with U32 and I32 arguments */
19901
19902     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
19903     regnode_offset ptr = ret;
19904
19905     PERL_ARGS_ASSERT_REG2LANODE;
19906
19907     assert(regarglen[op] == 2);
19908
19909     FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
19910     RExC_emit = ptr;
19911     return(ret);
19912 }
19913
19914 /*
19915 - reginsert - insert an operator in front of already-emitted operand
19916 *
19917 * That means that on exit 'operand' is the offset of the newly inserted
19918 * operator, and the original operand has been relocated.
19919 *
19920 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
19921 * set up NEXT_OFF() of the inserted node if needed. Something like this:
19922 *
19923 *   reginsert(pRExC, OPFAIL, orig_emit, depth+1);
19924 *   NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
19925 *
19926 * ALSO NOTE - FLAGS(newly-inserted-operator) will be set to 0 as well.
19927 */
19928 STATIC void
19929 S_reginsert(pTHX_ RExC_state_t *pRExC_state, const U8 op,
19930                   const regnode_offset operand, const U32 depth)
19931 {
19932     regnode *src;
19933     regnode *dst;
19934     regnode *place;
19935     const int offset = regarglen[(U8)op];
19936     const int size = NODE_STEP_REGNODE + offset;
19937     GET_RE_DEBUG_FLAGS_DECL;
19938
19939     PERL_ARGS_ASSERT_REGINSERT;
19940     PERL_UNUSED_CONTEXT;
19941     PERL_UNUSED_ARG(depth);
19942 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
19943     DEBUG_PARSE_FMT("inst"," - %s", PL_reg_name[op]);
19944     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
19945                                     studying. If this is wrong then we need to adjust RExC_recurse
19946                                     below like we do with RExC_open_parens/RExC_close_parens. */
19947     change_engine_size(pRExC_state, (Ptrdiff_t) size);
19948     src = REGNODE_p(RExC_emit);
19949     RExC_emit += size;
19950     dst = REGNODE_p(RExC_emit);
19951
19952     /* If we are in a "count the parentheses" pass, the numbers are unreliable,
19953      * and [perl #133871] shows this can lead to problems, so skip this
19954      * realignment of parens until a later pass when they are reliable */
19955     if (! IN_PARENS_PASS && RExC_open_parens) {
19956         int paren;
19957         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
19958         /* remember that RExC_npar is rex->nparens + 1,
19959          * iow it is 1 more than the number of parens seen in
19960          * the pattern so far. */
19961         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
19962             /* note, RExC_open_parens[0] is the start of the
19963              * regex, it can't move. RExC_close_parens[0] is the end
19964              * of the regex, it *can* move. */
19965             if ( paren && RExC_open_parens[paren] >= operand ) {
19966                 /*DEBUG_PARSE_FMT("open"," - %d", size);*/
19967                 RExC_open_parens[paren] += size;
19968             } else {
19969                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
19970             }
19971             if ( RExC_close_parens[paren] >= operand ) {
19972                 /*DEBUG_PARSE_FMT("close"," - %d", size);*/
19973                 RExC_close_parens[paren] += size;
19974             } else {
19975                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
19976             }
19977         }
19978     }
19979     if (RExC_end_op)
19980         RExC_end_op += size;
19981
19982     while (src > REGNODE_p(operand)) {
19983         StructCopy(--src, --dst, regnode);
19984 #ifdef RE_TRACK_PATTERN_OFFSETS
19985         if (RExC_offsets) {     /* MJD 20010112 */
19986             MJD_OFFSET_DEBUG(
19987                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
19988                   "reginsert",
19989                   __LINE__,
19990                   PL_reg_name[op],
19991                   (UV)(REGNODE_OFFSET(dst)) > RExC_offsets[0]
19992                     ? "Overwriting end of array!\n" : "OK",
19993                   (UV)REGNODE_OFFSET(src),
19994                   (UV)REGNODE_OFFSET(dst),
19995                   (UV)RExC_offsets[0]));
19996             Set_Node_Offset_To_R(REGNODE_OFFSET(dst), Node_Offset(src));
19997             Set_Node_Length_To_R(REGNODE_OFFSET(dst), Node_Length(src));
19998         }
19999 #endif
20000     }
20001
20002     place = REGNODE_p(operand); /* Op node, where operand used to be. */
20003 #ifdef RE_TRACK_PATTERN_OFFSETS
20004     if (RExC_offsets) {         /* MJD */
20005         MJD_OFFSET_DEBUG(
20006               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
20007               "reginsert",
20008               __LINE__,
20009               PL_reg_name[op],
20010               (UV)REGNODE_OFFSET(place) > RExC_offsets[0]
20011               ? "Overwriting end of array!\n" : "OK",
20012               (UV)REGNODE_OFFSET(place),
20013               (UV)(RExC_parse - RExC_start),
20014               (UV)RExC_offsets[0]));
20015         Set_Node_Offset(place, RExC_parse);
20016         Set_Node_Length(place, 1);
20017     }
20018 #endif
20019     src = NEXTOPER(place);
20020     FLAGS(place) = 0;
20021     FILL_NODE(operand, op);
20022
20023     /* Zero out any arguments in the new node */
20024     Zero(src, offset, regnode);
20025 }
20026
20027 /*
20028 - regtail - set the next-pointer at the end of a node chain of p to val.  If
20029             that value won't fit in the space available, instead returns FALSE.
20030             (Except asserts if we can't fit in the largest space the regex
20031             engine is designed for.)
20032 - SEE ALSO: regtail_study
20033 */
20034 STATIC bool
20035 S_regtail(pTHX_ RExC_state_t * pRExC_state,
20036                 const regnode_offset p,
20037                 const regnode_offset val,
20038                 const U32 depth)
20039 {
20040     regnode_offset scan;
20041     GET_RE_DEBUG_FLAGS_DECL;
20042
20043     PERL_ARGS_ASSERT_REGTAIL;
20044 #ifndef DEBUGGING
20045     PERL_UNUSED_ARG(depth);
20046 #endif
20047
20048     /* Find last node. */
20049     scan = (regnode_offset) p;
20050     for (;;) {
20051         regnode * const temp = regnext(REGNODE_p(scan));
20052         DEBUG_PARSE_r({
20053             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
20054             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
20055             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
20056                 SvPV_nolen_const(RExC_mysv), scan,
20057                     (temp == NULL ? "->" : ""),
20058                     (temp == NULL ? PL_reg_name[OP(REGNODE_p(val))] : "")
20059             );
20060         });
20061         if (temp == NULL)
20062             break;
20063         scan = REGNODE_OFFSET(temp);
20064     }
20065
20066     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
20067         assert((UV) (val - scan) <= U32_MAX);
20068         ARG_SET(REGNODE_p(scan), val - scan);
20069     }
20070     else {
20071         if (val - scan > U16_MAX) {
20072             /* Populate this with something that won't loop and will likely
20073              * lead to a crash if the caller ignores the failure return, and
20074              * execution continues */
20075             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
20076             return FALSE;
20077         }
20078         NEXT_OFF(REGNODE_p(scan)) = val - scan;
20079     }
20080
20081     return TRUE;
20082 }
20083
20084 #ifdef DEBUGGING
20085 /*
20086 - regtail_study - set the next-pointer at the end of a node chain of p to val.
20087 - Look for optimizable sequences at the same time.
20088 - currently only looks for EXACT chains.
20089
20090 This is experimental code. The idea is to use this routine to perform
20091 in place optimizations on branches and groups as they are constructed,
20092 with the long term intention of removing optimization from study_chunk so
20093 that it is purely analytical.
20094
20095 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
20096 to control which is which.
20097
20098 This used to return a value that was ignored.  It was a problem that it is
20099 #ifdef'd to be another function that didn't return a value.  khw has changed it
20100 so both currently return a pass/fail return.
20101
20102 */
20103 /* TODO: All four parms should be const */
20104
20105 STATIC bool
20106 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode_offset p,
20107                       const regnode_offset val, U32 depth)
20108 {
20109     regnode_offset scan;
20110     U8 exact = PSEUDO;
20111 #ifdef EXPERIMENTAL_INPLACESCAN
20112     I32 min = 0;
20113 #endif
20114     GET_RE_DEBUG_FLAGS_DECL;
20115
20116     PERL_ARGS_ASSERT_REGTAIL_STUDY;
20117
20118
20119     /* Find last node. */
20120
20121     scan = p;
20122     for (;;) {
20123         regnode * const temp = regnext(REGNODE_p(scan));
20124 #ifdef EXPERIMENTAL_INPLACESCAN
20125         if (PL_regkind[OP(REGNODE_p(scan))] == EXACT) {
20126             bool unfolded_multi_char;   /* Unexamined in this routine */
20127             if (join_exact(pRExC_state, scan, &min,
20128                            &unfolded_multi_char, 1, REGNODE_p(val), depth+1))
20129                 return TRUE; /* Was return EXACT */
20130         }
20131 #endif
20132         if ( exact ) {
20133             switch (OP(REGNODE_p(scan))) {
20134                 case LEXACT:
20135                 case EXACT:
20136                 case LEXACT_ONLY8:
20137                 case EXACT_ONLY8:
20138                 case EXACTL:
20139                 case EXACTF:
20140                 case EXACTFU_S_EDGE:
20141                 case EXACTFAA_NO_TRIE:
20142                 case EXACTFAA:
20143                 case EXACTFU:
20144                 case EXACTFU_ONLY8:
20145                 case EXACTFLU8:
20146                 case EXACTFUP:
20147                 case EXACTFL:
20148                         if( exact == PSEUDO )
20149                             exact= OP(REGNODE_p(scan));
20150                         else if ( exact != OP(REGNODE_p(scan)) )
20151                             exact= 0;
20152                 case NOTHING:
20153                     break;
20154                 default:
20155                     exact= 0;
20156             }
20157         }
20158         DEBUG_PARSE_r({
20159             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
20160             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
20161             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
20162                 SvPV_nolen_const(RExC_mysv),
20163                 scan,
20164                 PL_reg_name[exact]);
20165         });
20166         if (temp == NULL)
20167             break;
20168         scan = REGNODE_OFFSET(temp);
20169     }
20170     DEBUG_PARSE_r({
20171         DEBUG_PARSE_MSG("");
20172         regprop(RExC_rx, RExC_mysv, REGNODE_p(val), NULL, pRExC_state);
20173         Perl_re_printf( aTHX_
20174                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
20175                       SvPV_nolen_const(RExC_mysv),
20176                       (IV)val,
20177                       (IV)(val - scan)
20178         );
20179     });
20180     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
20181         assert((UV) (val - scan) <= U32_MAX);
20182         ARG_SET(REGNODE_p(scan), val - scan);
20183     }
20184     else {
20185         if (val - scan > U16_MAX) {
20186             /* Populate this with something that won't loop and will likely
20187              * lead to a crash if the caller ignores the failure return, and
20188              * execution continues */
20189             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
20190             return FALSE;
20191         }
20192         NEXT_OFF(REGNODE_p(scan)) = val - scan;
20193     }
20194
20195     return TRUE; /* Was 'return exact' */
20196 }
20197 #endif
20198
20199 STATIC SV*
20200 S_get_ANYOFM_contents(pTHX_ const regnode * n) {
20201
20202     /* Returns an inversion list of all the code points matched by the
20203      * ANYOFM/NANYOFM node 'n' */
20204
20205     SV * cp_list = _new_invlist(-1);
20206     const U8 lowest = (U8) ARG(n);
20207     unsigned int i;
20208     U8 count = 0;
20209     U8 needed = 1U << PL_bitcount[ (U8) ~ FLAGS(n)];
20210
20211     PERL_ARGS_ASSERT_GET_ANYOFM_CONTENTS;
20212
20213     /* Starting with the lowest code point, any code point that ANDed with the
20214      * mask yields the lowest code point is in the set */
20215     for (i = lowest; i <= 0xFF; i++) {
20216         if ((i & FLAGS(n)) == ARG(n)) {
20217             cp_list = add_cp_to_invlist(cp_list, i);
20218             count++;
20219
20220             /* We know how many code points (a power of two) that are in the
20221              * set.  No use looking once we've got that number */
20222             if (count >= needed) break;
20223         }
20224     }
20225
20226     if (OP(n) == NANYOFM) {
20227         _invlist_invert(cp_list);
20228     }
20229     return cp_list;
20230 }
20231
20232 /*
20233  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
20234  */
20235 #ifdef DEBUGGING
20236
20237 static void
20238 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
20239 {
20240     int bit;
20241     int set=0;
20242
20243     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
20244
20245     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
20246         if (flags & (1<<bit)) {
20247             if (!set++ && lead)
20248                 Perl_re_printf( aTHX_  "%s", lead);
20249             Perl_re_printf( aTHX_  "%s ", PL_reg_intflags_name[bit]);
20250         }
20251     }
20252     if (lead)  {
20253         if (set)
20254             Perl_re_printf( aTHX_  "\n");
20255         else
20256             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
20257     }
20258 }
20259
20260 static void
20261 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
20262 {
20263     int bit;
20264     int set=0;
20265     regex_charset cs;
20266
20267     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
20268
20269     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
20270         if (flags & (1<<bit)) {
20271             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
20272                 continue;
20273             }
20274             if (!set++ && lead)
20275                 Perl_re_printf( aTHX_  "%s", lead);
20276             Perl_re_printf( aTHX_  "%s ", PL_reg_extflags_name[bit]);
20277         }
20278     }
20279     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
20280             if (!set++ && lead) {
20281                 Perl_re_printf( aTHX_  "%s", lead);
20282             }
20283             switch (cs) {
20284                 case REGEX_UNICODE_CHARSET:
20285                     Perl_re_printf( aTHX_  "UNICODE");
20286                     break;
20287                 case REGEX_LOCALE_CHARSET:
20288                     Perl_re_printf( aTHX_  "LOCALE");
20289                     break;
20290                 case REGEX_ASCII_RESTRICTED_CHARSET:
20291                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
20292                     break;
20293                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
20294                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
20295                     break;
20296                 default:
20297                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
20298                     break;
20299             }
20300     }
20301     if (lead)  {
20302         if (set)
20303             Perl_re_printf( aTHX_  "\n");
20304         else
20305             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
20306     }
20307 }
20308 #endif
20309
20310 void
20311 Perl_regdump(pTHX_ const regexp *r)
20312 {
20313 #ifdef DEBUGGING
20314     int i;
20315     SV * const sv = sv_newmortal();
20316     SV *dsv= sv_newmortal();
20317     RXi_GET_DECL(r, ri);
20318     GET_RE_DEBUG_FLAGS_DECL;
20319
20320     PERL_ARGS_ASSERT_REGDUMP;
20321
20322     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
20323
20324     /* Header fields of interest. */
20325     for (i = 0; i < 2; i++) {
20326         if (r->substrs->data[i].substr) {
20327             RE_PV_QUOTED_DECL(s, 0, dsv,
20328                             SvPVX_const(r->substrs->data[i].substr),
20329                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
20330                             PL_dump_re_max_len);
20331             Perl_re_printf( aTHX_
20332                           "%s %s%s at %" IVdf "..%" UVuf " ",
20333                           i ? "floating" : "anchored",
20334                           s,
20335                           RE_SV_TAIL(r->substrs->data[i].substr),
20336                           (IV)r->substrs->data[i].min_offset,
20337                           (UV)r->substrs->data[i].max_offset);
20338         }
20339         else if (r->substrs->data[i].utf8_substr) {
20340             RE_PV_QUOTED_DECL(s, 1, dsv,
20341                             SvPVX_const(r->substrs->data[i].utf8_substr),
20342                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
20343                             30);
20344             Perl_re_printf( aTHX_
20345                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
20346                           i ? "floating" : "anchored",
20347                           s,
20348                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
20349                           (IV)r->substrs->data[i].min_offset,
20350                           (UV)r->substrs->data[i].max_offset);
20351         }
20352     }
20353
20354     if (r->check_substr || r->check_utf8)
20355         Perl_re_printf( aTHX_
20356                       (const char *)
20357                       (   r->check_substr == r->substrs->data[1].substr
20358                        && r->check_utf8   == r->substrs->data[1].utf8_substr
20359                        ? "(checking floating" : "(checking anchored"));
20360     if (r->intflags & PREGf_NOSCAN)
20361         Perl_re_printf( aTHX_  " noscan");
20362     if (r->extflags & RXf_CHECK_ALL)
20363         Perl_re_printf( aTHX_  " isall");
20364     if (r->check_substr || r->check_utf8)
20365         Perl_re_printf( aTHX_  ") ");
20366
20367     if (ri->regstclass) {
20368         regprop(r, sv, ri->regstclass, NULL, NULL);
20369         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
20370     }
20371     if (r->intflags & PREGf_ANCH) {
20372         Perl_re_printf( aTHX_  "anchored");
20373         if (r->intflags & PREGf_ANCH_MBOL)
20374             Perl_re_printf( aTHX_  "(MBOL)");
20375         if (r->intflags & PREGf_ANCH_SBOL)
20376             Perl_re_printf( aTHX_  "(SBOL)");
20377         if (r->intflags & PREGf_ANCH_GPOS)
20378             Perl_re_printf( aTHX_  "(GPOS)");
20379         Perl_re_printf( aTHX_ " ");
20380     }
20381     if (r->intflags & PREGf_GPOS_SEEN)
20382         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
20383     if (r->intflags & PREGf_SKIP)
20384         Perl_re_printf( aTHX_  "plus ");
20385     if (r->intflags & PREGf_IMPLICIT)
20386         Perl_re_printf( aTHX_  "implicit ");
20387     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
20388     if (r->extflags & RXf_EVAL_SEEN)
20389         Perl_re_printf( aTHX_  "with eval ");
20390     Perl_re_printf( aTHX_  "\n");
20391     DEBUG_FLAGS_r({
20392         regdump_extflags("r->extflags: ", r->extflags);
20393         regdump_intflags("r->intflags: ", r->intflags);
20394     });
20395 #else
20396     PERL_ARGS_ASSERT_REGDUMP;
20397     PERL_UNUSED_CONTEXT;
20398     PERL_UNUSED_ARG(r);
20399 #endif  /* DEBUGGING */
20400 }
20401
20402 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
20403 #ifdef DEBUGGING
20404
20405 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
20406      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
20407      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
20408      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
20409      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
20410      || _CC_VERTSPACE != 15
20411 #   error Need to adjust order of anyofs[]
20412 #  endif
20413 static const char * const anyofs[] = {
20414     "\\w",
20415     "\\W",
20416     "\\d",
20417     "\\D",
20418     "[:alpha:]",
20419     "[:^alpha:]",
20420     "[:lower:]",
20421     "[:^lower:]",
20422     "[:upper:]",
20423     "[:^upper:]",
20424     "[:punct:]",
20425     "[:^punct:]",
20426     "[:print:]",
20427     "[:^print:]",
20428     "[:alnum:]",
20429     "[:^alnum:]",
20430     "[:graph:]",
20431     "[:^graph:]",
20432     "[:cased:]",
20433     "[:^cased:]",
20434     "\\s",
20435     "\\S",
20436     "[:blank:]",
20437     "[:^blank:]",
20438     "[:xdigit:]",
20439     "[:^xdigit:]",
20440     "[:cntrl:]",
20441     "[:^cntrl:]",
20442     "[:ascii:]",
20443     "[:^ascii:]",
20444     "\\v",
20445     "\\V"
20446 };
20447 #endif
20448
20449 /*
20450 - regprop - printable representation of opcode, with run time support
20451 */
20452
20453 void
20454 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
20455 {
20456 #ifdef DEBUGGING
20457     dVAR;
20458     int k;
20459     RXi_GET_DECL(prog, progi);
20460     GET_RE_DEBUG_FLAGS_DECL;
20461
20462     PERL_ARGS_ASSERT_REGPROP;
20463
20464     SvPVCLEAR(sv);
20465
20466     if (OP(o) > REGNODE_MAX) {          /* regnode.type is unsigned */
20467         if (pRExC_state) {  /* This gives more info, if we have it */
20468             FAIL3("panic: corrupted regexp opcode %d > %d",
20469                   (int)OP(o), (int)REGNODE_MAX);
20470         }
20471         else {
20472             Perl_croak(aTHX_ "panic: corrupted regexp opcode %d > %d",
20473                              (int)OP(o), (int)REGNODE_MAX);
20474         }
20475     }
20476     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
20477
20478     k = PL_regkind[OP(o)];
20479
20480     if (k == EXACT) {
20481         sv_catpvs(sv, " ");
20482         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
20483          * is a crude hack but it may be the best for now since
20484          * we have no flag "this EXACTish node was UTF-8"
20485          * --jhi */
20486         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
20487                   PL_colors[0], PL_colors[1],
20488                   PERL_PV_ESCAPE_UNI_DETECT |
20489                   PERL_PV_ESCAPE_NONASCII   |
20490                   PERL_PV_PRETTY_ELLIPSES   |
20491                   PERL_PV_PRETTY_LTGT       |
20492                   PERL_PV_PRETTY_NOCLEAR
20493                   );
20494     } else if (k == TRIE) {
20495         /* print the details of the trie in dumpuntil instead, as
20496          * progi->data isn't available here */
20497         const char op = OP(o);
20498         const U32 n = ARG(o);
20499         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
20500                (reg_ac_data *)progi->data->data[n] :
20501                NULL;
20502         const reg_trie_data * const trie
20503             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
20504
20505         Perl_sv_catpvf(aTHX_ sv, "-%s", PL_reg_name[o->flags]);
20506         DEBUG_TRIE_COMPILE_r({
20507           if (trie->jump)
20508             sv_catpvs(sv, "(JUMP)");
20509           Perl_sv_catpvf(aTHX_ sv,
20510             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
20511             (UV)trie->startstate,
20512             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
20513             (UV)trie->wordcount,
20514             (UV)trie->minlen,
20515             (UV)trie->maxlen,
20516             (UV)TRIE_CHARCOUNT(trie),
20517             (UV)trie->uniquecharcount
20518           );
20519         });
20520         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
20521             sv_catpvs(sv, "[");
20522             (void) put_charclass_bitmap_innards(sv,
20523                                                 ((IS_ANYOF_TRIE(op))
20524                                                  ? ANYOF_BITMAP(o)
20525                                                  : TRIE_BITMAP(trie)),
20526                                                 NULL,
20527                                                 NULL,
20528                                                 NULL,
20529                                                 FALSE
20530                                                );
20531             sv_catpvs(sv, "]");
20532         }
20533     } else if (k == CURLY) {
20534         U32 lo = ARG1(o), hi = ARG2(o);
20535         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
20536             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
20537         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
20538         if (hi == REG_INFTY)
20539             sv_catpvs(sv, "INFTY");
20540         else
20541             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
20542         sv_catpvs(sv, "}");
20543     }
20544     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
20545         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
20546     else if (k == REF || k == OPEN || k == CLOSE
20547              || k == GROUPP || OP(o)==ACCEPT)
20548     {
20549         AV *name_list= NULL;
20550         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
20551         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
20552         if ( RXp_PAREN_NAMES(prog) ) {
20553             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
20554         } else if ( pRExC_state ) {
20555             name_list= RExC_paren_name_list;
20556         }
20557         if (name_list) {
20558             if ( k != REF || (OP(o) < REFN)) {
20559                 SV **name= av_fetch(name_list, parno, 0 );
20560                 if (name)
20561                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20562             }
20563             else {
20564                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
20565                 I32 *nums=(I32*)SvPVX(sv_dat);
20566                 SV **name= av_fetch(name_list, nums[0], 0 );
20567                 I32 n;
20568                 if (name) {
20569                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
20570                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
20571                                     (n ? "," : ""), (IV)nums[n]);
20572                     }
20573                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20574                 }
20575             }
20576         }
20577         if ( k == REF && reginfo) {
20578             U32 n = ARG(o);  /* which paren pair */
20579             I32 ln = prog->offs[n].start;
20580             if (prog->lastparen < n || ln == -1 || prog->offs[n].end == -1)
20581                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
20582             else if (ln == prog->offs[n].end)
20583                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
20584             else {
20585                 const char *s = reginfo->strbeg + ln;
20586                 Perl_sv_catpvf(aTHX_ sv, ": ");
20587                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
20588                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
20589             }
20590         }
20591     } else if (k == GOSUB) {
20592         AV *name_list= NULL;
20593         if ( RXp_PAREN_NAMES(prog) ) {
20594             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
20595         } else if ( pRExC_state ) {
20596             name_list= RExC_paren_name_list;
20597         }
20598
20599         /* Paren and offset */
20600         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
20601                 (int)((o + (int)ARG2L(o)) - progi->program) );
20602         if (name_list) {
20603             SV **name= av_fetch(name_list, ARG(o), 0 );
20604             if (name)
20605                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20606         }
20607     }
20608     else if (k == LOGICAL)
20609         /* 2: embedded, otherwise 1 */
20610         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
20611     else if (k == ANYOF) {
20612         const U8 flags = inRANGE(OP(o), ANYOFH, ANYOFHr)
20613                           ? 0
20614                           : ANYOF_FLAGS(o);
20615         bool do_sep = FALSE;    /* Do we need to separate various components of
20616                                    the output? */
20617         /* Set if there is still an unresolved user-defined property */
20618         SV *unresolved                = NULL;
20619
20620         /* Things that are ignored except when the runtime locale is UTF-8 */
20621         SV *only_utf8_locale_invlist = NULL;
20622
20623         /* Code points that don't fit in the bitmap */
20624         SV *nonbitmap_invlist = NULL;
20625
20626         /* And things that aren't in the bitmap, but are small enough to be */
20627         SV* bitmap_range_not_in_bitmap = NULL;
20628
20629         const bool inverted = flags & ANYOF_INVERT;
20630
20631         if (OP(o) == ANYOFL || OP(o) == ANYOFPOSIXL) {
20632             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
20633                 sv_catpvs(sv, "{utf8-locale-reqd}");
20634             }
20635             if (flags & ANYOFL_FOLD) {
20636                 sv_catpvs(sv, "{i}");
20637             }
20638         }
20639
20640         /* If there is stuff outside the bitmap, get it */
20641         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
20642             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
20643                                                 &unresolved,
20644                                                 &only_utf8_locale_invlist,
20645                                                 &nonbitmap_invlist);
20646             /* The non-bitmap data may contain stuff that could fit in the
20647              * bitmap.  This could come from a user-defined property being
20648              * finally resolved when this call was done; or much more likely
20649              * because there are matches that require UTF-8 to be valid, and so
20650              * aren't in the bitmap.  This is teased apart later */
20651             _invlist_intersection(nonbitmap_invlist,
20652                                   PL_InBitmap,
20653                                   &bitmap_range_not_in_bitmap);
20654             /* Leave just the things that don't fit into the bitmap */
20655             _invlist_subtract(nonbitmap_invlist,
20656                               PL_InBitmap,
20657                               &nonbitmap_invlist);
20658         }
20659
20660         /* Obey this flag to add all above-the-bitmap code points */
20661         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
20662             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
20663                                                       NUM_ANYOF_CODE_POINTS,
20664                                                       UV_MAX);
20665         }
20666
20667         /* Ready to start outputting.  First, the initial left bracket */
20668         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20669
20670         if (! inRANGE(OP(o), ANYOFH, ANYOFHr)) {
20671             /* Then all the things that could fit in the bitmap */
20672             do_sep = put_charclass_bitmap_innards(sv,
20673                                                   ANYOF_BITMAP(o),
20674                                                   bitmap_range_not_in_bitmap,
20675                                                   only_utf8_locale_invlist,
20676                                                   o,
20677
20678                                                   /* Can't try inverting for a
20679                                                    * better display if there
20680                                                    * are things that haven't
20681                                                    * been resolved */
20682                                                   unresolved != NULL);
20683             SvREFCNT_dec(bitmap_range_not_in_bitmap);
20684
20685             /* If there are user-defined properties which haven't been defined
20686              * yet, output them.  If the result is not to be inverted, it is
20687              * clearest to output them in a separate [] from the bitmap range
20688              * stuff.  If the result is to be complemented, we have to show
20689              * everything in one [], as the inversion applies to the whole
20690              * thing.  Use {braces} to separate them from anything in the
20691              * bitmap and anything above the bitmap. */
20692             if (unresolved) {
20693                 if (inverted) {
20694                     if (! do_sep) { /* If didn't output anything in the bitmap
20695                                      */
20696                         sv_catpvs(sv, "^");
20697                     }
20698                     sv_catpvs(sv, "{");
20699                 }
20700                 else if (do_sep) {
20701                     Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1],
20702                                                       PL_colors[0]);
20703                 }
20704                 sv_catsv(sv, unresolved);
20705                 if (inverted) {
20706                     sv_catpvs(sv, "}");
20707                 }
20708                 do_sep = ! inverted;
20709             }
20710         }
20711
20712         /* And, finally, add the above-the-bitmap stuff */
20713         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
20714             SV* contents;
20715
20716             /* See if truncation size is overridden */
20717             const STRLEN dump_len = (PL_dump_re_max_len > 256)
20718                                     ? PL_dump_re_max_len
20719                                     : 256;
20720
20721             /* This is output in a separate [] */
20722             if (do_sep) {
20723                 Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1], PL_colors[0]);
20724             }
20725
20726             /* And, for easy of understanding, it is shown in the
20727              * uncomplemented form if possible.  The one exception being if
20728              * there are unresolved items, where the inversion has to be
20729              * delayed until runtime */
20730             if (inverted && ! unresolved) {
20731                 _invlist_invert(nonbitmap_invlist);
20732                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
20733             }
20734
20735             contents = invlist_contents(nonbitmap_invlist,
20736                                         FALSE /* output suitable for catsv */
20737                                        );
20738
20739             /* If the output is shorter than the permissible maximum, just do it. */
20740             if (SvCUR(contents) <= dump_len) {
20741                 sv_catsv(sv, contents);
20742             }
20743             else {
20744                 const char * contents_string = SvPVX(contents);
20745                 STRLEN i = dump_len;
20746
20747                 /* Otherwise, start at the permissible max and work back to the
20748                  * first break possibility */
20749                 while (i > 0 && contents_string[i] != ' ') {
20750                     i--;
20751                 }
20752                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
20753                                        find a legal break */
20754                     i = dump_len;
20755                 }
20756
20757                 sv_catpvn(sv, contents_string, i);
20758                 sv_catpvs(sv, "...");
20759             }
20760
20761             SvREFCNT_dec_NN(contents);
20762             SvREFCNT_dec_NN(nonbitmap_invlist);
20763         }
20764
20765         /* And finally the matching, closing ']' */
20766         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20767
20768         if (inRANGE(OP(o), ANYOFH, ANYOFHr)) {
20769             U8 lowest = (OP(o) != ANYOFHr)
20770                          ? FLAGS(o)
20771                          : LOWEST_ANYOF_HRx_BYTE(FLAGS(o));
20772             U8 highest = (OP(o) == ANYOFHb)
20773                          ? lowest
20774                          : OP(o) == ANYOFH
20775                            ? 0xFF
20776                            : HIGHEST_ANYOF_HRx_BYTE(FLAGS(o));
20777             Perl_sv_catpvf(aTHX_ sv, " (First UTF-8 byte=%02X", lowest);
20778             if (lowest != highest) {
20779                 Perl_sv_catpvf(aTHX_ sv, "-%02X", highest);
20780             }
20781             Perl_sv_catpvf(aTHX_ sv, ")");
20782         }
20783
20784         SvREFCNT_dec(unresolved);
20785     }
20786     else if (k == ANYOFM) {
20787         SV * cp_list = get_ANYOFM_contents(o);
20788
20789         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20790         if (OP(o) == NANYOFM) {
20791             _invlist_invert(cp_list);
20792         }
20793
20794         put_charclass_bitmap_innards(sv, NULL, cp_list, NULL, NULL, TRUE);
20795         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20796
20797         SvREFCNT_dec(cp_list);
20798     }
20799     else if (k == POSIXD || k == NPOSIXD) {
20800         U8 index = FLAGS(o) * 2;
20801         if (index < C_ARRAY_LENGTH(anyofs)) {
20802             if (*anyofs[index] != '[')  {
20803                 sv_catpvs(sv, "[");
20804             }
20805             sv_catpv(sv, anyofs[index]);
20806             if (*anyofs[index] != '[')  {
20807                 sv_catpvs(sv, "]");
20808             }
20809         }
20810         else {
20811             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
20812         }
20813     }
20814     else if (k == BOUND || k == NBOUND) {
20815         /* Must be synced with order of 'bound_type' in regcomp.h */
20816         const char * const bounds[] = {
20817             "",      /* Traditional */
20818             "{gcb}",
20819             "{lb}",
20820             "{sb}",
20821             "{wb}"
20822         };
20823         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
20824         sv_catpv(sv, bounds[FLAGS(o)]);
20825     }
20826     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH)) {
20827         Perl_sv_catpvf(aTHX_ sv, "[%d", -(o->flags));
20828         if (o->next_off) {
20829             Perl_sv_catpvf(aTHX_ sv, "..-%d", o->flags - o->next_off);
20830         }
20831         Perl_sv_catpvf(aTHX_ sv, "]");
20832     }
20833     else if (OP(o) == SBOL)
20834         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
20835
20836     /* add on the verb argument if there is one */
20837     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
20838         if ( ARG(o) )
20839             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
20840                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
20841         else
20842             sv_catpvs(sv, ":NULL");
20843     }
20844 #else
20845     PERL_UNUSED_CONTEXT;
20846     PERL_UNUSED_ARG(sv);
20847     PERL_UNUSED_ARG(o);
20848     PERL_UNUSED_ARG(prog);
20849     PERL_UNUSED_ARG(reginfo);
20850     PERL_UNUSED_ARG(pRExC_state);
20851 #endif  /* DEBUGGING */
20852 }
20853
20854
20855
20856 SV *
20857 Perl_re_intuit_string(pTHX_ REGEXP * const r)
20858 {                               /* Assume that RE_INTUIT is set */
20859     struct regexp *const prog = ReANY(r);
20860     GET_RE_DEBUG_FLAGS_DECL;
20861
20862     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
20863     PERL_UNUSED_CONTEXT;
20864
20865     DEBUG_COMPILE_r(
20866         {
20867             const char * const s = SvPV_nolen_const(RX_UTF8(r)
20868                       ? prog->check_utf8 : prog->check_substr);
20869
20870             if (!PL_colorset) reginitcolors();
20871             Perl_re_printf( aTHX_
20872                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
20873                       PL_colors[4],
20874                       RX_UTF8(r) ? "utf8 " : "",
20875                       PL_colors[5], PL_colors[0],
20876                       s,
20877                       PL_colors[1],
20878                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
20879         } );
20880
20881     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
20882     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
20883 }
20884
20885 /*
20886    pregfree()
20887
20888    handles refcounting and freeing the perl core regexp structure. When
20889    it is necessary to actually free the structure the first thing it
20890    does is call the 'free' method of the regexp_engine associated to
20891    the regexp, allowing the handling of the void *pprivate; member
20892    first. (This routine is not overridable by extensions, which is why
20893    the extensions free is called first.)
20894
20895    See regdupe and regdupe_internal if you change anything here.
20896 */
20897 #ifndef PERL_IN_XSUB_RE
20898 void
20899 Perl_pregfree(pTHX_ REGEXP *r)
20900 {
20901     SvREFCNT_dec(r);
20902 }
20903
20904 void
20905 Perl_pregfree2(pTHX_ REGEXP *rx)
20906 {
20907     struct regexp *const r = ReANY(rx);
20908     GET_RE_DEBUG_FLAGS_DECL;
20909
20910     PERL_ARGS_ASSERT_PREGFREE2;
20911
20912     if (! r)
20913         return;
20914
20915     if (r->mother_re) {
20916         ReREFCNT_dec(r->mother_re);
20917     } else {
20918         CALLREGFREE_PVT(rx); /* free the private data */
20919         SvREFCNT_dec(RXp_PAREN_NAMES(r));
20920     }
20921     if (r->substrs) {
20922         int i;
20923         for (i = 0; i < 2; i++) {
20924             SvREFCNT_dec(r->substrs->data[i].substr);
20925             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
20926         }
20927         Safefree(r->substrs);
20928     }
20929     RX_MATCH_COPY_FREE(rx);
20930 #ifdef PERL_ANY_COW
20931     SvREFCNT_dec(r->saved_copy);
20932 #endif
20933     Safefree(r->offs);
20934     SvREFCNT_dec(r->qr_anoncv);
20935     if (r->recurse_locinput)
20936         Safefree(r->recurse_locinput);
20937 }
20938
20939
20940 /*  reg_temp_copy()
20941
20942     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
20943     except that dsv will be created if NULL.
20944
20945     This function is used in two main ways. First to implement
20946         $r = qr/....; $s = $$r;
20947
20948     Secondly, it is used as a hacky workaround to the structural issue of
20949     match results
20950     being stored in the regexp structure which is in turn stored in
20951     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
20952     could be PL_curpm in multiple contexts, and could require multiple
20953     result sets being associated with the pattern simultaneously, such
20954     as when doing a recursive match with (??{$qr})
20955
20956     The solution is to make a lightweight copy of the regexp structure
20957     when a qr// is returned from the code executed by (??{$qr}) this
20958     lightweight copy doesn't actually own any of its data except for
20959     the starp/end and the actual regexp structure itself.
20960
20961 */
20962
20963
20964 REGEXP *
20965 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
20966 {
20967     struct regexp *drx;
20968     struct regexp *const srx = ReANY(ssv);
20969     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
20970
20971     PERL_ARGS_ASSERT_REG_TEMP_COPY;
20972
20973     if (!dsv)
20974         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
20975     else {
20976         assert(SvTYPE(dsv) == SVt_REGEXP || (SvTYPE(dsv) == SVt_PVLV));
20977
20978         /* our only valid caller, sv_setsv_flags(), should have done
20979          * a SV_CHECK_THINKFIRST_COW_DROP() by now */
20980         assert(!SvOOK(dsv));
20981         assert(!SvIsCOW(dsv));
20982         assert(!SvROK(dsv));
20983
20984         if (SvPVX_const(dsv)) {
20985             if (SvLEN(dsv))
20986                 Safefree(SvPVX(dsv));
20987             SvPVX(dsv) = NULL;
20988         }
20989         SvLEN_set(dsv, 0);
20990         SvCUR_set(dsv, 0);
20991         SvOK_off((SV *)dsv);
20992
20993         if (islv) {
20994             /* For PVLVs, the head (sv_any) points to an XPVLV, while
20995              * the LV's xpvlenu_rx will point to a regexp body, which
20996              * we allocate here */
20997             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
20998             assert(!SvPVX(dsv));
20999             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
21000             temp->sv_any = NULL;
21001             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
21002             SvREFCNT_dec_NN(temp);
21003             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
21004                ing below will not set it. */
21005             SvCUR_set(dsv, SvCUR(ssv));
21006         }
21007     }
21008     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
21009        sv_force_normal(sv) is called.  */
21010     SvFAKE_on(dsv);
21011     drx = ReANY(dsv);
21012
21013     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
21014     SvPV_set(dsv, RX_WRAPPED(ssv));
21015     /* We share the same string buffer as the original regexp, on which we
21016        hold a reference count, incremented when mother_re is set below.
21017        The string pointer is copied here, being part of the regexp struct.
21018      */
21019     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
21020            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
21021     if (!islv)
21022         SvLEN_set(dsv, 0);
21023     if (srx->offs) {
21024         const I32 npar = srx->nparens+1;
21025         Newx(drx->offs, npar, regexp_paren_pair);
21026         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
21027     }
21028     if (srx->substrs) {
21029         int i;
21030         Newx(drx->substrs, 1, struct reg_substr_data);
21031         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
21032
21033         for (i = 0; i < 2; i++) {
21034             SvREFCNT_inc_void(drx->substrs->data[i].substr);
21035             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
21036         }
21037
21038         /* check_substr and check_utf8, if non-NULL, point to either their
21039            anchored or float namesakes, and don't hold a second reference.  */
21040     }
21041     RX_MATCH_COPIED_off(dsv);
21042 #ifdef PERL_ANY_COW
21043     drx->saved_copy = NULL;
21044 #endif
21045     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
21046     SvREFCNT_inc_void(drx->qr_anoncv);
21047     if (srx->recurse_locinput)
21048         Newx(drx->recurse_locinput, srx->nparens + 1, char *);
21049
21050     return dsv;
21051 }
21052 #endif
21053
21054
21055 /* regfree_internal()
21056
21057    Free the private data in a regexp. This is overloadable by
21058    extensions. Perl takes care of the regexp structure in pregfree(),
21059    this covers the *pprivate pointer which technically perl doesn't
21060    know about, however of course we have to handle the
21061    regexp_internal structure when no extension is in use.
21062
21063    Note this is called before freeing anything in the regexp
21064    structure.
21065  */
21066
21067 void
21068 Perl_regfree_internal(pTHX_ REGEXP * const rx)
21069 {
21070     struct regexp *const r = ReANY(rx);
21071     RXi_GET_DECL(r, ri);
21072     GET_RE_DEBUG_FLAGS_DECL;
21073
21074     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
21075
21076     if (! ri) {
21077         return;
21078     }
21079
21080     DEBUG_COMPILE_r({
21081         if (!PL_colorset)
21082             reginitcolors();
21083         {
21084             SV *dsv= sv_newmortal();
21085             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
21086                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
21087             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
21088                 PL_colors[4], PL_colors[5], s);
21089         }
21090     });
21091
21092 #ifdef RE_TRACK_PATTERN_OFFSETS
21093     if (ri->u.offsets)
21094         Safefree(ri->u.offsets);             /* 20010421 MJD */
21095 #endif
21096     if (ri->code_blocks)
21097         S_free_codeblocks(aTHX_ ri->code_blocks);
21098
21099     if (ri->data) {
21100         int n = ri->data->count;
21101
21102         while (--n >= 0) {
21103           /* If you add a ->what type here, update the comment in regcomp.h */
21104             switch (ri->data->what[n]) {
21105             case 'a':
21106             case 'r':
21107             case 's':
21108             case 'S':
21109             case 'u':
21110                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
21111                 break;
21112             case 'f':
21113                 Safefree(ri->data->data[n]);
21114                 break;
21115             case 'l':
21116             case 'L':
21117                 break;
21118             case 'T':
21119                 { /* Aho Corasick add-on structure for a trie node.
21120                      Used in stclass optimization only */
21121                     U32 refcount;
21122                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
21123 #ifdef USE_ITHREADS
21124                     dVAR;
21125 #endif
21126                     OP_REFCNT_LOCK;
21127                     refcount = --aho->refcount;
21128                     OP_REFCNT_UNLOCK;
21129                     if ( !refcount ) {
21130                         PerlMemShared_free(aho->states);
21131                         PerlMemShared_free(aho->fail);
21132                          /* do this last!!!! */
21133                         PerlMemShared_free(ri->data->data[n]);
21134                         /* we should only ever get called once, so
21135                          * assert as much, and also guard the free
21136                          * which /might/ happen twice. At the least
21137                          * it will make code anlyzers happy and it
21138                          * doesn't cost much. - Yves */
21139                         assert(ri->regstclass);
21140                         if (ri->regstclass) {
21141                             PerlMemShared_free(ri->regstclass);
21142                             ri->regstclass = 0;
21143                         }
21144                     }
21145                 }
21146                 break;
21147             case 't':
21148                 {
21149                     /* trie structure. */
21150                     U32 refcount;
21151                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
21152 #ifdef USE_ITHREADS
21153                     dVAR;
21154 #endif
21155                     OP_REFCNT_LOCK;
21156                     refcount = --trie->refcount;
21157                     OP_REFCNT_UNLOCK;
21158                     if ( !refcount ) {
21159                         PerlMemShared_free(trie->charmap);
21160                         PerlMemShared_free(trie->states);
21161                         PerlMemShared_free(trie->trans);
21162                         if (trie->bitmap)
21163                             PerlMemShared_free(trie->bitmap);
21164                         if (trie->jump)
21165                             PerlMemShared_free(trie->jump);
21166                         PerlMemShared_free(trie->wordinfo);
21167                         /* do this last!!!! */
21168                         PerlMemShared_free(ri->data->data[n]);
21169                     }
21170                 }
21171                 break;
21172             default:
21173                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
21174                                                     ri->data->what[n]);
21175             }
21176         }
21177         Safefree(ri->data->what);
21178         Safefree(ri->data);
21179     }
21180
21181     Safefree(ri);
21182 }
21183
21184 #define av_dup_inc(s, t)        MUTABLE_AV(sv_dup_inc((const SV *)s, t))
21185 #define hv_dup_inc(s, t)        MUTABLE_HV(sv_dup_inc((const SV *)s, t))
21186 #define SAVEPVN(p, n)   ((p) ? savepvn(p, n) : NULL)
21187
21188 /*
21189    re_dup_guts - duplicate a regexp.
21190
21191    This routine is expected to clone a given regexp structure. It is only
21192    compiled under USE_ITHREADS.
21193
21194    After all of the core data stored in struct regexp is duplicated
21195    the regexp_engine.dupe method is used to copy any private data
21196    stored in the *pprivate pointer. This allows extensions to handle
21197    any duplication it needs to do.
21198
21199    See pregfree() and regfree_internal() if you change anything here.
21200 */
21201 #if defined(USE_ITHREADS)
21202 #ifndef PERL_IN_XSUB_RE
21203 void
21204 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
21205 {
21206     dVAR;
21207     I32 npar;
21208     const struct regexp *r = ReANY(sstr);
21209     struct regexp *ret = ReANY(dstr);
21210
21211     PERL_ARGS_ASSERT_RE_DUP_GUTS;
21212
21213     npar = r->nparens+1;
21214     Newx(ret->offs, npar, regexp_paren_pair);
21215     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
21216
21217     if (ret->substrs) {
21218         /* Do it this way to avoid reading from *r after the StructCopy().
21219            That way, if any of the sv_dup_inc()s dislodge *r from the L1
21220            cache, it doesn't matter.  */
21221         int i;
21222         const bool anchored = r->check_substr
21223             ? r->check_substr == r->substrs->data[0].substr
21224             : r->check_utf8   == r->substrs->data[0].utf8_substr;
21225         Newx(ret->substrs, 1, struct reg_substr_data);
21226         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
21227
21228         for (i = 0; i < 2; i++) {
21229             ret->substrs->data[i].substr =
21230                         sv_dup_inc(ret->substrs->data[i].substr, param);
21231             ret->substrs->data[i].utf8_substr =
21232                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
21233         }
21234
21235         /* check_substr and check_utf8, if non-NULL, point to either their
21236            anchored or float namesakes, and don't hold a second reference.  */
21237
21238         if (ret->check_substr) {
21239             if (anchored) {
21240                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
21241
21242                 ret->check_substr = ret->substrs->data[0].substr;
21243                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
21244             } else {
21245                 assert(r->check_substr == r->substrs->data[1].substr);
21246                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
21247
21248                 ret->check_substr = ret->substrs->data[1].substr;
21249                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
21250             }
21251         } else if (ret->check_utf8) {
21252             if (anchored) {
21253                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
21254             } else {
21255                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
21256             }
21257         }
21258     }
21259
21260     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
21261     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
21262     if (r->recurse_locinput)
21263         Newx(ret->recurse_locinput, r->nparens + 1, char *);
21264
21265     if (ret->pprivate)
21266         RXi_SET(ret, CALLREGDUPE_PVT(dstr, param));
21267
21268     if (RX_MATCH_COPIED(dstr))
21269         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
21270     else
21271         ret->subbeg = NULL;
21272 #ifdef PERL_ANY_COW
21273     ret->saved_copy = NULL;
21274 #endif
21275
21276     /* Whether mother_re be set or no, we need to copy the string.  We
21277        cannot refrain from copying it when the storage points directly to
21278        our mother regexp, because that's
21279                1: a buffer in a different thread
21280                2: something we no longer hold a reference on
21281                so we need to copy it locally.  */
21282     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
21283     /* set malloced length to a non-zero value so it will be freed
21284      * (otherwise in combination with SVf_FAKE it looks like an alien
21285      * buffer). It doesn't have to be the actual malloced size, since it
21286      * should never be grown */
21287     SvLEN_set(dstr, SvCUR(sstr)+1);
21288     ret->mother_re   = NULL;
21289 }
21290 #endif /* PERL_IN_XSUB_RE */
21291
21292 /*
21293    regdupe_internal()
21294
21295    This is the internal complement to regdupe() which is used to copy
21296    the structure pointed to by the *pprivate pointer in the regexp.
21297    This is the core version of the extension overridable cloning hook.
21298    The regexp structure being duplicated will be copied by perl prior
21299    to this and will be provided as the regexp *r argument, however
21300    with the /old/ structures pprivate pointer value. Thus this routine
21301    may override any copying normally done by perl.
21302
21303    It returns a pointer to the new regexp_internal structure.
21304 */
21305
21306 void *
21307 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
21308 {
21309     dVAR;
21310     struct regexp *const r = ReANY(rx);
21311     regexp_internal *reti;
21312     int len;
21313     RXi_GET_DECL(r, ri);
21314
21315     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
21316
21317     len = ProgLen(ri);
21318
21319     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
21320           char, regexp_internal);
21321     Copy(ri->program, reti->program, len+1, regnode);
21322
21323
21324     if (ri->code_blocks) {
21325         int n;
21326         Newx(reti->code_blocks, 1, struct reg_code_blocks);
21327         Newx(reti->code_blocks->cb, ri->code_blocks->count,
21328                     struct reg_code_block);
21329         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
21330              ri->code_blocks->count, struct reg_code_block);
21331         for (n = 0; n < ri->code_blocks->count; n++)
21332              reti->code_blocks->cb[n].src_regex = (REGEXP*)
21333                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
21334         reti->code_blocks->count = ri->code_blocks->count;
21335         reti->code_blocks->refcnt = 1;
21336     }
21337     else
21338         reti->code_blocks = NULL;
21339
21340     reti->regstclass = NULL;
21341
21342     if (ri->data) {
21343         struct reg_data *d;
21344         const int count = ri->data->count;
21345         int i;
21346
21347         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
21348                 char, struct reg_data);
21349         Newx(d->what, count, U8);
21350
21351         d->count = count;
21352         for (i = 0; i < count; i++) {
21353             d->what[i] = ri->data->what[i];
21354             switch (d->what[i]) {
21355                 /* see also regcomp.h and regfree_internal() */
21356             case 'a': /* actually an AV, but the dup function is identical.
21357                          values seem to be "plain sv's" generally. */
21358             case 'r': /* a compiled regex (but still just another SV) */
21359             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
21360                          this use case should go away, the code could have used
21361                          'a' instead - see S_set_ANYOF_arg() for array contents. */
21362             case 'S': /* actually an SV, but the dup function is identical.  */
21363             case 'u': /* actually an HV, but the dup function is identical.
21364                          values are "plain sv's" */
21365                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
21366                 break;
21367             case 'f':
21368                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
21369                  * patterns which could start with several different things. Pre-TRIE
21370                  * this was more important than it is now, however this still helps
21371                  * in some places, for instance /x?a+/ might produce a SSC equivalent
21372                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
21373                  * in regexec.c
21374                  */
21375                 /* This is cheating. */
21376                 Newx(d->data[i], 1, regnode_ssc);
21377                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
21378                 reti->regstclass = (regnode*)d->data[i];
21379                 break;
21380             case 'T':
21381                 /* AHO-CORASICK fail table */
21382                 /* Trie stclasses are readonly and can thus be shared
21383                  * without duplication. We free the stclass in pregfree
21384                  * when the corresponding reg_ac_data struct is freed.
21385                  */
21386                 reti->regstclass= ri->regstclass;
21387                 /* FALLTHROUGH */
21388             case 't':
21389                 /* TRIE transition table */
21390                 OP_REFCNT_LOCK;
21391                 ((reg_trie_data*)ri->data->data[i])->refcount++;
21392                 OP_REFCNT_UNLOCK;
21393                 /* FALLTHROUGH */
21394             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
21395             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
21396                          is not from another regexp */
21397                 d->data[i] = ri->data->data[i];
21398                 break;
21399             default:
21400                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
21401                                                            ri->data->what[i]);
21402             }
21403         }
21404
21405         reti->data = d;
21406     }
21407     else
21408         reti->data = NULL;
21409
21410     reti->name_list_idx = ri->name_list_idx;
21411
21412 #ifdef RE_TRACK_PATTERN_OFFSETS
21413     if (ri->u.offsets) {
21414         Newx(reti->u.offsets, 2*len+1, U32);
21415         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
21416     }
21417 #else
21418     SetProgLen(reti, len);
21419 #endif
21420
21421     return (void*)reti;
21422 }
21423
21424 #endif    /* USE_ITHREADS */
21425
21426 #ifndef PERL_IN_XSUB_RE
21427
21428 /*
21429  - regnext - dig the "next" pointer out of a node
21430  */
21431 regnode *
21432 Perl_regnext(pTHX_ regnode *p)
21433 {
21434     I32 offset;
21435
21436     if (!p)
21437         return(NULL);
21438
21439     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
21440         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
21441                                                 (int)OP(p), (int)REGNODE_MAX);
21442     }
21443
21444     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
21445     if (offset == 0)
21446         return(NULL);
21447
21448     return(p+offset);
21449 }
21450
21451 #endif
21452
21453 STATIC void
21454 S_re_croak2(pTHX_ bool utf8, const char* pat1, const char* pat2,...)
21455 {
21456     va_list args;
21457     STRLEN l1 = strlen(pat1);
21458     STRLEN l2 = strlen(pat2);
21459     char buf[512];
21460     SV *msv;
21461     const char *message;
21462
21463     PERL_ARGS_ASSERT_RE_CROAK2;
21464
21465     if (l1 > 510)
21466         l1 = 510;
21467     if (l1 + l2 > 510)
21468         l2 = 510 - l1;
21469     Copy(pat1, buf, l1 , char);
21470     Copy(pat2, buf + l1, l2 , char);
21471     buf[l1 + l2] = '\n';
21472     buf[l1 + l2 + 1] = '\0';
21473     va_start(args, pat2);
21474     msv = vmess(buf, &args);
21475     va_end(args);
21476     message = SvPV_const(msv, l1);
21477     if (l1 > 512)
21478         l1 = 512;
21479     Copy(message, buf, l1 , char);
21480     /* l1-1 to avoid \n */
21481     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
21482 }
21483
21484 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
21485
21486 #ifndef PERL_IN_XSUB_RE
21487 void
21488 Perl_save_re_context(pTHX)
21489 {
21490     I32 nparens = -1;
21491     I32 i;
21492
21493     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
21494
21495     if (PL_curpm) {
21496         const REGEXP * const rx = PM_GETRE(PL_curpm);
21497         if (rx)
21498             nparens = RX_NPARENS(rx);
21499     }
21500
21501     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
21502      * that PL_curpm will be null, but that utf8.pm and the modules it
21503      * loads will only use $1..$3.
21504      * The t/porting/re_context.t test file checks this assumption.
21505      */
21506     if (nparens == -1)
21507         nparens = 3;
21508
21509     for (i = 1; i <= nparens; i++) {
21510         char digits[TYPE_CHARS(long)];
21511         const STRLEN len = my_snprintf(digits, sizeof(digits),
21512                                        "%lu", (long)i);
21513         GV *const *const gvp
21514             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
21515
21516         if (gvp) {
21517             GV * const gv = *gvp;
21518             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
21519                 save_scalar(gv);
21520         }
21521     }
21522 }
21523 #endif
21524
21525 #ifdef DEBUGGING
21526
21527 STATIC void
21528 S_put_code_point(pTHX_ SV *sv, UV c)
21529 {
21530     PERL_ARGS_ASSERT_PUT_CODE_POINT;
21531
21532     if (c > 255) {
21533         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
21534     }
21535     else if (isPRINT(c)) {
21536         const char string = (char) c;
21537
21538         /* We use {phrase} as metanotation in the class, so also escape literal
21539          * braces */
21540         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
21541             sv_catpvs(sv, "\\");
21542         sv_catpvn(sv, &string, 1);
21543     }
21544     else if (isMNEMONIC_CNTRL(c)) {
21545         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
21546     }
21547     else {
21548         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
21549     }
21550 }
21551
21552 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
21553
21554 STATIC void
21555 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
21556 {
21557     /* Appends to 'sv' a displayable version of the range of code points from
21558      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
21559      * that have them, when they occur at the beginning or end of the range.
21560      * It uses hex to output the remaining code points, unless 'allow_literals'
21561      * is true, in which case the printable ASCII ones are output as-is (though
21562      * some of these will be escaped by put_code_point()).
21563      *
21564      * NOTE:  This is designed only for printing ranges of code points that fit
21565      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
21566      */
21567
21568     const unsigned int min_range_count = 3;
21569
21570     assert(start <= end);
21571
21572     PERL_ARGS_ASSERT_PUT_RANGE;
21573
21574     while (start <= end) {
21575         UV this_end;
21576         const char * format;
21577
21578         if (end - start < min_range_count) {
21579
21580             /* Output chars individually when they occur in short ranges */
21581             for (; start <= end; start++) {
21582                 put_code_point(sv, start);
21583             }
21584             break;
21585         }
21586
21587         /* If permitted by the input options, and there is a possibility that
21588          * this range contains a printable literal, look to see if there is
21589          * one. */
21590         if (allow_literals && start <= MAX_PRINT_A) {
21591
21592             /* If the character at the beginning of the range isn't an ASCII
21593              * printable, effectively split the range into two parts:
21594              *  1) the portion before the first such printable,
21595              *  2) the rest
21596              * and output them separately. */
21597             if (! isPRINT_A(start)) {
21598                 UV temp_end = start + 1;
21599
21600                 /* There is no point looking beyond the final possible
21601                  * printable, in MAX_PRINT_A */
21602                 UV max = MIN(end, MAX_PRINT_A);
21603
21604                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
21605                     temp_end++;
21606                 }
21607
21608                 /* Here, temp_end points to one beyond the first printable if
21609                  * found, or to one beyond 'max' if not.  If none found, make
21610                  * sure that we use the entire range */
21611                 if (temp_end > MAX_PRINT_A) {
21612                     temp_end = end + 1;
21613                 }
21614
21615                 /* Output the first part of the split range: the part that
21616                  * doesn't have printables, with the parameter set to not look
21617                  * for literals (otherwise we would infinitely recurse) */
21618                 put_range(sv, start, temp_end - 1, FALSE);
21619
21620                 /* The 2nd part of the range (if any) starts here. */
21621                 start = temp_end;
21622
21623                 /* We do a continue, instead of dropping down, because even if
21624                  * the 2nd part is non-empty, it could be so short that we want
21625                  * to output it as individual characters, as tested for at the
21626                  * top of this loop.  */
21627                 continue;
21628             }
21629
21630             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
21631              * output a sub-range of just the digits or letters, then process
21632              * the remaining portion as usual. */
21633             if (isALPHANUMERIC_A(start)) {
21634                 UV mask = (isDIGIT_A(start))
21635                            ? _CC_DIGIT
21636                              : isUPPER_A(start)
21637                                ? _CC_UPPER
21638                                : _CC_LOWER;
21639                 UV temp_end = start + 1;
21640
21641                 /* Find the end of the sub-range that includes just the
21642                  * characters in the same class as the first character in it */
21643                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
21644                     temp_end++;
21645                 }
21646                 temp_end--;
21647
21648                 /* For short ranges, don't duplicate the code above to output
21649                  * them; just call recursively */
21650                 if (temp_end - start < min_range_count) {
21651                     put_range(sv, start, temp_end, FALSE);
21652                 }
21653                 else {  /* Output as a range */
21654                     put_code_point(sv, start);
21655                     sv_catpvs(sv, "-");
21656                     put_code_point(sv, temp_end);
21657                 }
21658                 start = temp_end + 1;
21659                 continue;
21660             }
21661
21662             /* We output any other printables as individual characters */
21663             if (isPUNCT_A(start) || isSPACE_A(start)) {
21664                 while (start <= end && (isPUNCT_A(start)
21665                                         || isSPACE_A(start)))
21666                 {
21667                     put_code_point(sv, start);
21668                     start++;
21669                 }
21670                 continue;
21671             }
21672         } /* End of looking for literals */
21673
21674         /* Here is not to output as a literal.  Some control characters have
21675          * mnemonic names.  Split off any of those at the beginning and end of
21676          * the range to print mnemonically.  It isn't possible for many of
21677          * these to be in a row, so this won't overwhelm with output */
21678         if (   start <= end
21679             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
21680         {
21681             while (isMNEMONIC_CNTRL(start) && start <= end) {
21682                 put_code_point(sv, start);
21683                 start++;
21684             }
21685
21686             /* If this didn't take care of the whole range ... */
21687             if (start <= end) {
21688
21689                 /* Look backwards from the end to find the final non-mnemonic
21690                  * */
21691                 UV temp_end = end;
21692                 while (isMNEMONIC_CNTRL(temp_end)) {
21693                     temp_end--;
21694                 }
21695
21696                 /* And separately output the interior range that doesn't start
21697                  * or end with mnemonics */
21698                 put_range(sv, start, temp_end, FALSE);
21699
21700                 /* Then output the mnemonic trailing controls */
21701                 start = temp_end + 1;
21702                 while (start <= end) {
21703                     put_code_point(sv, start);
21704                     start++;
21705                 }
21706                 break;
21707             }
21708         }
21709
21710         /* As a final resort, output the range or subrange as hex. */
21711
21712         if (start >= NUM_ANYOF_CODE_POINTS) {
21713             this_end = end;
21714         }
21715         else {
21716             this_end = (end < NUM_ANYOF_CODE_POINTS)
21717                         ? end
21718                         : NUM_ANYOF_CODE_POINTS - 1;
21719         }
21720 #if NUM_ANYOF_CODE_POINTS > 256
21721         format = (this_end < 256)
21722                  ? "\\x%02" UVXf "-\\x%02" UVXf
21723                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
21724 #else
21725         format = "\\x%02" UVXf "-\\x%02" UVXf;
21726 #endif
21727         GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral);
21728         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
21729         GCC_DIAG_RESTORE_STMT;
21730         break;
21731     }
21732 }
21733
21734 STATIC void
21735 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
21736 {
21737     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
21738      * 'invlist' */
21739
21740     UV start, end;
21741     bool allow_literals = TRUE;
21742
21743     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
21744
21745     /* Generally, it is more readable if printable characters are output as
21746      * literals, but if a range (nearly) spans all of them, it's best to output
21747      * it as a single range.  This code will use a single range if all but 2
21748      * ASCII printables are in it */
21749     invlist_iterinit(invlist);
21750     while (invlist_iternext(invlist, &start, &end)) {
21751
21752         /* If the range starts beyond the final printable, it doesn't have any
21753          * in it */
21754         if (start > MAX_PRINT_A) {
21755             break;
21756         }
21757
21758         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
21759          * all but two, the range must start and end no later than 2 from
21760          * either end */
21761         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
21762             if (end > MAX_PRINT_A) {
21763                 end = MAX_PRINT_A;
21764             }
21765             if (start < ' ') {
21766                 start = ' ';
21767             }
21768             if (end - start >= MAX_PRINT_A - ' ' - 2) {
21769                 allow_literals = FALSE;
21770             }
21771             break;
21772         }
21773     }
21774     invlist_iterfinish(invlist);
21775
21776     /* Here we have figured things out.  Output each range */
21777     invlist_iterinit(invlist);
21778     while (invlist_iternext(invlist, &start, &end)) {
21779         if (start >= NUM_ANYOF_CODE_POINTS) {
21780             break;
21781         }
21782         put_range(sv, start, end, allow_literals);
21783     }
21784     invlist_iterfinish(invlist);
21785
21786     return;
21787 }
21788
21789 STATIC SV*
21790 S_put_charclass_bitmap_innards_common(pTHX_
21791         SV* invlist,            /* The bitmap */
21792         SV* posixes,            /* Under /l, things like [:word:], \S */
21793         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
21794         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
21795         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
21796         const bool invert       /* Is the result to be inverted? */
21797 )
21798 {
21799     /* Create and return an SV containing a displayable version of the bitmap
21800      * and associated information determined by the input parameters.  If the
21801      * output would have been only the inversion indicator '^', NULL is instead
21802      * returned. */
21803
21804     dVAR;
21805     SV * output;
21806
21807     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
21808
21809     if (invert) {
21810         output = newSVpvs("^");
21811     }
21812     else {
21813         output = newSVpvs("");
21814     }
21815
21816     /* First, the code points in the bitmap that are unconditionally there */
21817     put_charclass_bitmap_innards_invlist(output, invlist);
21818
21819     /* Traditionally, these have been placed after the main code points */
21820     if (posixes) {
21821         sv_catsv(output, posixes);
21822     }
21823
21824     if (only_utf8 && _invlist_len(only_utf8)) {
21825         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
21826         put_charclass_bitmap_innards_invlist(output, only_utf8);
21827     }
21828
21829     if (not_utf8 && _invlist_len(not_utf8)) {
21830         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
21831         put_charclass_bitmap_innards_invlist(output, not_utf8);
21832     }
21833
21834     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
21835         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
21836         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
21837
21838         /* This is the only list in this routine that can legally contain code
21839          * points outside the bitmap range.  The call just above to
21840          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
21841          * output them here.  There's about a half-dozen possible, and none in
21842          * contiguous ranges longer than 2 */
21843         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21844             UV start, end;
21845             SV* above_bitmap = NULL;
21846
21847             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
21848
21849             invlist_iterinit(above_bitmap);
21850             while (invlist_iternext(above_bitmap, &start, &end)) {
21851                 UV i;
21852
21853                 for (i = start; i <= end; i++) {
21854                     put_code_point(output, i);
21855                 }
21856             }
21857             invlist_iterfinish(above_bitmap);
21858             SvREFCNT_dec_NN(above_bitmap);
21859         }
21860     }
21861
21862     if (invert && SvCUR(output) == 1) {
21863         return NULL;
21864     }
21865
21866     return output;
21867 }
21868
21869 STATIC bool
21870 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
21871                                      char *bitmap,
21872                                      SV *nonbitmap_invlist,
21873                                      SV *only_utf8_locale_invlist,
21874                                      const regnode * const node,
21875                                      const bool force_as_is_display)
21876 {
21877     /* Appends to 'sv' a displayable version of the innards of the bracketed
21878      * character class defined by the other arguments:
21879      *  'bitmap' points to the bitmap, or NULL if to ignore that.
21880      *  'nonbitmap_invlist' is an inversion list of the code points that are in
21881      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
21882      *      none.  The reasons for this could be that they require some
21883      *      condition such as the target string being or not being in UTF-8
21884      *      (under /d), or because they came from a user-defined property that
21885      *      was not resolved at the time of the regex compilation (under /u)
21886      *  'only_utf8_locale_invlist' is an inversion list of the code points that
21887      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
21888      *  'node' is the regex pattern ANYOF node.  It is needed only when the
21889      *      above two parameters are not null, and is passed so that this
21890      *      routine can tease apart the various reasons for them.
21891      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
21892      *      to invert things to see if that leads to a cleaner display.  If
21893      *      FALSE, this routine is free to use its judgment about doing this.
21894      *
21895      * It returns TRUE if there was actually something output.  (It may be that
21896      * the bitmap, etc is empty.)
21897      *
21898      * When called for outputting the bitmap of a non-ANYOF node, just pass the
21899      * bitmap, with the succeeding parameters set to NULL, and the final one to
21900      * FALSE.
21901      */
21902
21903     /* In general, it tries to display the 'cleanest' representation of the
21904      * innards, choosing whether to display them inverted or not, regardless of
21905      * whether the class itself is to be inverted.  However,  there are some
21906      * cases where it can't try inverting, as what actually matches isn't known
21907      * until runtime, and hence the inversion isn't either. */
21908
21909     dVAR;
21910     bool inverting_allowed = ! force_as_is_display;
21911
21912     int i;
21913     STRLEN orig_sv_cur = SvCUR(sv);
21914
21915     SV* invlist;            /* Inversion list we accumulate of code points that
21916                                are unconditionally matched */
21917     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
21918                                UTF-8 */
21919     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
21920                              */
21921     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
21922     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
21923                                        is UTF-8 */
21924
21925     SV* as_is_display;      /* The output string when we take the inputs
21926                                literally */
21927     SV* inverted_display;   /* The output string when we invert the inputs */
21928
21929     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
21930
21931     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
21932                                                    to match? */
21933     /* We are biased in favor of displaying things without them being inverted,
21934      * as that is generally easier to understand */
21935     const int bias = 5;
21936
21937     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
21938
21939     /* Start off with whatever code points are passed in.  (We clone, so we
21940      * don't change the caller's list) */
21941     if (nonbitmap_invlist) {
21942         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
21943         invlist = invlist_clone(nonbitmap_invlist, NULL);
21944     }
21945     else {  /* Worst case size is every other code point is matched */
21946         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
21947     }
21948
21949     if (flags) {
21950         if (OP(node) == ANYOFD) {
21951
21952             /* This flag indicates that the code points below 0x100 in the
21953              * nonbitmap list are precisely the ones that match only when the
21954              * target is UTF-8 (they should all be non-ASCII). */
21955             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
21956             {
21957                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
21958                 _invlist_subtract(invlist, only_utf8, &invlist);
21959             }
21960
21961             /* And this flag for matching all non-ASCII 0xFF and below */
21962             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
21963             {
21964                 not_utf8 = invlist_clone(PL_UpperLatin1, NULL);
21965             }
21966         }
21967         else if (OP(node) == ANYOFL || OP(node) == ANYOFPOSIXL) {
21968
21969             /* If either of these flags are set, what matches isn't
21970              * determinable except during execution, so don't know enough here
21971              * to invert */
21972             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
21973                 inverting_allowed = FALSE;
21974             }
21975
21976             /* What the posix classes match also varies at runtime, so these
21977              * will be output symbolically. */
21978             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
21979                 int i;
21980
21981                 posixes = newSVpvs("");
21982                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
21983                     if (ANYOF_POSIXL_TEST(node, i)) {
21984                         sv_catpv(posixes, anyofs[i]);
21985                     }
21986                 }
21987             }
21988         }
21989     }
21990
21991     /* Accumulate the bit map into the unconditional match list */
21992     if (bitmap) {
21993         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
21994             if (BITMAP_TEST(bitmap, i)) {
21995                 int start = i++;
21996                 for (;
21997                      i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i);
21998                      i++)
21999                 { /* empty */ }
22000                 invlist = _add_range_to_invlist(invlist, start, i-1);
22001             }
22002         }
22003     }
22004
22005     /* Make sure that the conditional match lists don't have anything in them
22006      * that match unconditionally; otherwise the output is quite confusing.
22007      * This could happen if the code that populates these misses some
22008      * duplication. */
22009     if (only_utf8) {
22010         _invlist_subtract(only_utf8, invlist, &only_utf8);
22011     }
22012     if (not_utf8) {
22013         _invlist_subtract(not_utf8, invlist, &not_utf8);
22014     }
22015
22016     if (only_utf8_locale_invlist) {
22017
22018         /* Since this list is passed in, we have to make a copy before
22019          * modifying it */
22020         only_utf8_locale = invlist_clone(only_utf8_locale_invlist, NULL);
22021
22022         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
22023
22024         /* And, it can get really weird for us to try outputting an inverted
22025          * form of this list when it has things above the bitmap, so don't even
22026          * try */
22027         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
22028             inverting_allowed = FALSE;
22029         }
22030     }
22031
22032     /* Calculate what the output would be if we take the input as-is */
22033     as_is_display = put_charclass_bitmap_innards_common(invlist,
22034                                                     posixes,
22035                                                     only_utf8,
22036                                                     not_utf8,
22037                                                     only_utf8_locale,
22038                                                     invert);
22039
22040     /* If have to take the output as-is, just do that */
22041     if (! inverting_allowed) {
22042         if (as_is_display) {
22043             sv_catsv(sv, as_is_display);
22044             SvREFCNT_dec_NN(as_is_display);
22045         }
22046     }
22047     else { /* But otherwise, create the output again on the inverted input, and
22048               use whichever version is shorter */
22049
22050         int inverted_bias, as_is_bias;
22051
22052         /* We will apply our bias to whichever of the the results doesn't have
22053          * the '^' */
22054         if (invert) {
22055             invert = FALSE;
22056             as_is_bias = bias;
22057             inverted_bias = 0;
22058         }
22059         else {
22060             invert = TRUE;
22061             as_is_bias = 0;
22062             inverted_bias = bias;
22063         }
22064
22065         /* Now invert each of the lists that contribute to the output,
22066          * excluding from the result things outside the possible range */
22067
22068         /* For the unconditional inversion list, we have to add in all the
22069          * conditional code points, so that when inverted, they will be gone
22070          * from it */
22071         _invlist_union(only_utf8, invlist, &invlist);
22072         _invlist_union(not_utf8, invlist, &invlist);
22073         _invlist_union(only_utf8_locale, invlist, &invlist);
22074         _invlist_invert(invlist);
22075         _invlist_intersection(invlist, PL_InBitmap, &invlist);
22076
22077         if (only_utf8) {
22078             _invlist_invert(only_utf8);
22079             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
22080         }
22081         else if (not_utf8) {
22082
22083             /* If a code point matches iff the target string is not in UTF-8,
22084              * then complementing the result has it not match iff not in UTF-8,
22085              * which is the same thing as matching iff it is UTF-8. */
22086             only_utf8 = not_utf8;
22087             not_utf8 = NULL;
22088         }
22089
22090         if (only_utf8_locale) {
22091             _invlist_invert(only_utf8_locale);
22092             _invlist_intersection(only_utf8_locale,
22093                                   PL_InBitmap,
22094                                   &only_utf8_locale);
22095         }
22096
22097         inverted_display = put_charclass_bitmap_innards_common(
22098                                             invlist,
22099                                             posixes,
22100                                             only_utf8,
22101                                             not_utf8,
22102                                             only_utf8_locale, invert);
22103
22104         /* Use the shortest representation, taking into account our bias
22105          * against showing it inverted */
22106         if (   inverted_display
22107             && (   ! as_is_display
22108                 || (  SvCUR(inverted_display) + inverted_bias
22109                     < SvCUR(as_is_display)    + as_is_bias)))
22110         {
22111             sv_catsv(sv, inverted_display);
22112         }
22113         else if (as_is_display) {
22114             sv_catsv(sv, as_is_display);
22115         }
22116
22117         SvREFCNT_dec(as_is_display);
22118         SvREFCNT_dec(inverted_display);
22119     }
22120
22121     SvREFCNT_dec_NN(invlist);
22122     SvREFCNT_dec(only_utf8);
22123     SvREFCNT_dec(not_utf8);
22124     SvREFCNT_dec(posixes);
22125     SvREFCNT_dec(only_utf8_locale);
22126
22127     return SvCUR(sv) > orig_sv_cur;
22128 }
22129
22130 #define CLEAR_OPTSTART                                                       \
22131     if (optstart) STMT_START {                                               \
22132         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
22133                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
22134         optstart=NULL;                                                       \
22135     } STMT_END
22136
22137 #define DUMPUNTIL(b,e)                                                       \
22138                     CLEAR_OPTSTART;                                          \
22139                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
22140
22141 STATIC const regnode *
22142 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
22143             const regnode *last, const regnode *plast,
22144             SV* sv, I32 indent, U32 depth)
22145 {
22146     U8 op = PSEUDO;     /* Arbitrary non-END op. */
22147     const regnode *next;
22148     const regnode *optstart= NULL;
22149
22150     RXi_GET_DECL(r, ri);
22151     GET_RE_DEBUG_FLAGS_DECL;
22152
22153     PERL_ARGS_ASSERT_DUMPUNTIL;
22154
22155 #ifdef DEBUG_DUMPUNTIL
22156     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n", indent, node-start,
22157         last ? last-start : 0, plast ? plast-start : 0);
22158 #endif
22159
22160     if (plast && plast < last)
22161         last= plast;
22162
22163     while (PL_regkind[op] != END && (!last || node < last)) {
22164         assert(node);
22165         /* While that wasn't END last time... */
22166         NODE_ALIGN(node);
22167         op = OP(node);
22168         if (op == CLOSE || op == SRCLOSE || op == WHILEM)
22169             indent--;
22170         next = regnext((regnode *)node);
22171
22172         /* Where, what. */
22173         if (OP(node) == OPTIMIZED) {
22174             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
22175                 optstart = node;
22176             else
22177                 goto after_print;
22178         } else
22179             CLEAR_OPTSTART;
22180
22181         regprop(r, sv, node, NULL, NULL);
22182         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
22183                       (int)(2*indent + 1), "", SvPVX_const(sv));
22184
22185         if (OP(node) != OPTIMIZED) {
22186             if (next == NULL)           /* Next ptr. */
22187                 Perl_re_printf( aTHX_  " (0)");
22188             else if (PL_regkind[(U8)op] == BRANCH
22189                      && PL_regkind[OP(next)] != BRANCH )
22190                 Perl_re_printf( aTHX_  " (FAIL)");
22191             else
22192                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
22193             Perl_re_printf( aTHX_ "\n");
22194         }
22195
22196       after_print:
22197         if (PL_regkind[(U8)op] == BRANCHJ) {
22198             assert(next);
22199             {
22200                 const regnode *nnode = (OP(next) == LONGJMP
22201                                        ? regnext((regnode *)next)
22202                                        : next);
22203                 if (last && nnode > last)
22204                     nnode = last;
22205                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
22206             }
22207         }
22208         else if (PL_regkind[(U8)op] == BRANCH) {
22209             assert(next);
22210             DUMPUNTIL(NEXTOPER(node), next);
22211         }
22212         else if ( PL_regkind[(U8)op]  == TRIE ) {
22213             const regnode *this_trie = node;
22214             const char op = OP(node);
22215             const U32 n = ARG(node);
22216             const reg_ac_data * const ac = op>=AHOCORASICK ?
22217                (reg_ac_data *)ri->data->data[n] :
22218                NULL;
22219             const reg_trie_data * const trie =
22220                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
22221 #ifdef DEBUGGING
22222             AV *const trie_words
22223                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
22224 #endif
22225             const regnode *nextbranch= NULL;
22226             I32 word_idx;
22227             SvPVCLEAR(sv);
22228             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
22229                 SV ** const elem_ptr = av_fetch(trie_words, word_idx, 0);
22230
22231                 Perl_re_indentf( aTHX_  "%s ",
22232                     indent+3,
22233                     elem_ptr
22234                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
22235                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
22236                                 PL_colors[0], PL_colors[1],
22237                                 (SvUTF8(*elem_ptr)
22238                                  ? PERL_PV_ESCAPE_UNI
22239                                  : 0)
22240                                 | PERL_PV_PRETTY_ELLIPSES
22241                                 | PERL_PV_PRETTY_LTGT
22242                             )
22243                     : "???"
22244                 );
22245                 if (trie->jump) {
22246                     U16 dist= trie->jump[word_idx+1];
22247                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
22248                                (UV)((dist ? this_trie + dist : next) - start));
22249                     if (dist) {
22250                         if (!nextbranch)
22251                             nextbranch= this_trie + trie->jump[0];
22252                         DUMPUNTIL(this_trie + dist, nextbranch);
22253                     }
22254                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
22255                         nextbranch= regnext((regnode *)nextbranch);
22256                 } else {
22257                     Perl_re_printf( aTHX_  "\n");
22258                 }
22259             }
22260             if (last && next > last)
22261                 node= last;
22262             else
22263                 node= next;
22264         }
22265         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
22266             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
22267                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
22268         }
22269         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
22270             assert(next);
22271             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
22272         }
22273         else if ( op == PLUS || op == STAR) {
22274             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
22275         }
22276         else if (PL_regkind[(U8)op] == EXACT) {
22277             /* Literal string, where present. */
22278             node += NODE_SZ_STR(node) - 1;
22279             node = NEXTOPER(node);
22280         }
22281         else {
22282             node = NEXTOPER(node);
22283             node += regarglen[(U8)op];
22284         }
22285         if (op == CURLYX || op == OPEN || op == SROPEN)
22286             indent++;
22287     }
22288     CLEAR_OPTSTART;
22289 #ifdef DEBUG_DUMPUNTIL
22290     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
22291 #endif
22292     return node;
22293 }
22294
22295 #endif  /* DEBUGGING */
22296
22297 #ifndef PERL_IN_XSUB_RE
22298
22299 #include "uni_keywords.h"
22300
22301 void
22302 Perl_init_uniprops(pTHX)
22303 {
22304     dVAR;
22305
22306     PL_user_def_props = newHV();
22307
22308 #ifdef USE_ITHREADS
22309
22310     HvSHAREKEYS_off(PL_user_def_props);
22311     PL_user_def_props_aTHX = aTHX;
22312
22313 #endif
22314
22315     /* Set up the inversion list global variables */
22316
22317     PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
22318     PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALNUM]);
22319     PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALPHA]);
22320     PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXBLANK]);
22321     PL_XPosix_ptrs[_CC_CASED] =  _new_invlist_C_array(uni_prop_ptrs[UNI_CASED]);
22322     PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXCNTRL]);
22323     PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXDIGIT]);
22324     PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXGRAPH]);
22325     PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXLOWER]);
22326     PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPRINT]);
22327     PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPUNCT]);
22328     PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXSPACE]);
22329     PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXUPPER]);
22330     PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_VERTSPACE]);
22331     PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXWORD]);
22332     PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXXDIGIT]);
22333
22334     PL_Posix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
22335     PL_Posix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALNUM]);
22336     PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALPHA]);
22337     PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXBLANK]);
22338     PL_Posix_ptrs[_CC_CASED] = PL_Posix_ptrs[_CC_ALPHA];
22339     PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXCNTRL]);
22340     PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXDIGIT]);
22341     PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXGRAPH]);
22342     PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXLOWER]);
22343     PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPRINT]);
22344     PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPUNCT]);
22345     PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXSPACE]);
22346     PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXUPPER]);
22347     PL_Posix_ptrs[_CC_VERTSPACE] = NULL;
22348     PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXWORD]);
22349     PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXXDIGIT]);
22350
22351     PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
22352     PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
22353     PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
22354     PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
22355     PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
22356
22357     PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
22358     PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
22359     PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
22360
22361     PL_Assigned_invlist = _new_invlist_C_array(uni_prop_ptrs[UNI_ASSIGNED]);
22362
22363     PL_utf8_perl_idstart = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDSTART]);
22364     PL_utf8_perl_idcont = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDCONT]);
22365
22366     PL_utf8_charname_begin = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_BEGIN]);
22367     PL_utf8_charname_continue = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_CONTINUE]);
22368
22369     PL_in_some_fold = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_ANY_FOLDS]);
22370     PL_HasMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
22371                                             UNI__PERL_FOLDS_TO_MULTI_CHAR]);
22372     PL_InMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
22373                                             UNI__PERL_IS_IN_MULTI_CHAR_FOLD]);
22374     PL_NonFinalFold = _new_invlist_C_array(uni_prop_ptrs[
22375                                             UNI__PERL_NON_FINAL_FOLDS]);
22376
22377     PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
22378     PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
22379     PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
22380     PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
22381     PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
22382     PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
22383     PL_utf8_mark = _new_invlist_C_array(uni_prop_ptrs[UNI_M]);
22384     PL_CCC_non0_non230 = _new_invlist_C_array(_Perl_CCC_non0_non230_invlist);
22385     PL_Private_Use = _new_invlist_C_array(uni_prop_ptrs[UNI_CO]);
22386
22387 #ifdef UNI_XIDC
22388     /* The below are used only by deprecated functions.  They could be removed */
22389     PL_utf8_xidcont  = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDC]);
22390     PL_utf8_idcont   = _new_invlist_C_array(uni_prop_ptrs[UNI_IDC]);
22391     PL_utf8_xidstart = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDS]);
22392 #endif
22393 }
22394
22395 #if 0
22396
22397 This code was mainly added for backcompat to give a warning for non-portable
22398 code points in user-defined properties.  But experiments showed that the
22399 warning in earlier perls were only omitted on overflow, which should be an
22400 error, so there really isnt a backcompat issue, and actually adding the
22401 warning when none was present before might cause breakage, for little gain.  So
22402 khw left this code in, but not enabled.  Tests were never added.
22403
22404 embed.fnc entry:
22405 Ei      |const char *|get_extended_utf8_msg|const UV cp
22406
22407 PERL_STATIC_INLINE const char *
22408 S_get_extended_utf8_msg(pTHX_ const UV cp)
22409 {
22410     U8 dummy[UTF8_MAXBYTES + 1];
22411     HV *msgs;
22412     SV **msg;
22413
22414     uvchr_to_utf8_flags_msgs(dummy, cp, UNICODE_WARN_PERL_EXTENDED,
22415                              &msgs);
22416
22417     msg = hv_fetchs(msgs, "text", 0);
22418     assert(msg);
22419
22420     (void) sv_2mortal((SV *) msgs);
22421
22422     return SvPVX(*msg);
22423 }
22424
22425 #endif
22426
22427 SV *
22428 Perl_handle_user_defined_property(pTHX_
22429
22430     /* Parses the contents of a user-defined property definition; returning the
22431      * expanded definition if possible.  If so, the return is an inversion
22432      * list.
22433      *
22434      * If there are subroutines that are part of the expansion and which aren't
22435      * known at the time of the call to this function, this returns what
22436      * parse_uniprop_string() returned for the first one encountered.
22437      *
22438      * If an error was found, NULL is returned, and 'msg' gets a suitable
22439      * message appended to it.  (Appending allows the back trace of how we got
22440      * to the faulty definition to be displayed through nested calls of
22441      * user-defined subs.)
22442      *
22443      * The caller IS responsible for freeing any returned SV.
22444      *
22445      * The syntax of the contents is pretty much described in perlunicode.pod,
22446      * but we also allow comments on each line */
22447
22448     const char * name,          /* Name of property */
22449     const STRLEN name_len,      /* The name's length in bytes */
22450     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22451     const bool to_fold,         /* ? Is this under /i */
22452     const bool runtime,         /* ? Are we in compile- or run-time */
22453     const bool deferrable,      /* Is it ok for this property's full definition
22454                                    to be deferred until later? */
22455     SV* contents,               /* The property's definition */
22456     bool *user_defined_ptr,     /* This will be set TRUE as we wouldn't be
22457                                    getting called unless this is thought to be
22458                                    a user-defined property */
22459     SV * msg,                   /* Any error or warning msg(s) are appended to
22460                                    this */
22461     const STRLEN level)         /* Recursion level of this call */
22462 {
22463     STRLEN len;
22464     const char * string         = SvPV_const(contents, len);
22465     const char * const e        = string + len;
22466     const bool is_contents_utf8 = cBOOL(SvUTF8(contents));
22467     const STRLEN msgs_length_on_entry = SvCUR(msg);
22468
22469     const char * s0 = string;   /* Points to first byte in the current line
22470                                    being parsed in 'string' */
22471     const char overflow_msg[] = "Code point too large in \"";
22472     SV* running_definition = NULL;
22473
22474     PERL_ARGS_ASSERT_HANDLE_USER_DEFINED_PROPERTY;
22475
22476     *user_defined_ptr = TRUE;
22477
22478     /* Look at each line */
22479     while (s0 < e) {
22480         const char * s;     /* Current byte */
22481         char op = '+';      /* Default operation is 'union' */
22482         IV   min = 0;       /* range begin code point */
22483         IV   max = -1;      /* and range end */
22484         SV* this_definition;
22485
22486         /* Skip comment lines */
22487         if (*s0 == '#') {
22488             s0 = strchr(s0, '\n');
22489             if (s0 == NULL) {
22490                 break;
22491             }
22492             s0++;
22493             continue;
22494         }
22495
22496         /* For backcompat, allow an empty first line */
22497         if (*s0 == '\n') {
22498             s0++;
22499             continue;
22500         }
22501
22502         /* First character in the line may optionally be the operation */
22503         if (   *s0 == '+'
22504             || *s0 == '!'
22505             || *s0 == '-'
22506             || *s0 == '&')
22507         {
22508             op = *s0++;
22509         }
22510
22511         /* If the line is one or two hex digits separated by blank space, its
22512          * a range; otherwise it is either another user-defined property or an
22513          * error */
22514
22515         s = s0;
22516
22517         if (! isXDIGIT(*s)) {
22518             goto check_if_property;
22519         }
22520
22521         do { /* Each new hex digit will add 4 bits. */
22522             if (min > ( (IV) MAX_LEGAL_CP >> 4)) {
22523                 s = strchr(s, '\n');
22524                 if (s == NULL) {
22525                     s = e;
22526                 }
22527                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22528                 sv_catpv(msg, overflow_msg);
22529                 Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22530                                      UTF8fARG(is_contents_utf8, s - s0, s0));
22531                 sv_catpvs(msg, "\"");
22532                 goto return_failure;
22533             }
22534
22535             /* Accumulate this digit into the value */
22536             min = (min << 4) + READ_XDIGIT(s);
22537         } while (isXDIGIT(*s));
22538
22539         while (isBLANK(*s)) { s++; }
22540
22541         /* We allow comments at the end of the line */
22542         if (*s == '#') {
22543             s = strchr(s, '\n');
22544             if (s == NULL) {
22545                 s = e;
22546             }
22547             s++;
22548         }
22549         else if (s < e && *s != '\n') {
22550             if (! isXDIGIT(*s)) {
22551                 goto check_if_property;
22552             }
22553
22554             /* Look for the high point of the range */
22555             max = 0;
22556             do {
22557                 if (max > ( (IV) MAX_LEGAL_CP >> 4)) {
22558                     s = strchr(s, '\n');
22559                     if (s == NULL) {
22560                         s = e;
22561                     }
22562                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22563                     sv_catpv(msg, overflow_msg);
22564                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22565                                       UTF8fARG(is_contents_utf8, s - s0, s0));
22566                     sv_catpvs(msg, "\"");
22567                     goto return_failure;
22568                 }
22569
22570                 max = (max << 4) + READ_XDIGIT(s);
22571             } while (isXDIGIT(*s));
22572
22573             while (isBLANK(*s)) { s++; }
22574
22575             if (*s == '#') {
22576                 s = strchr(s, '\n');
22577                 if (s == NULL) {
22578                     s = e;
22579                 }
22580             }
22581             else if (s < e && *s != '\n') {
22582                 goto check_if_property;
22583             }
22584         }
22585
22586         if (max == -1) {    /* The line only had one entry */
22587             max = min;
22588         }
22589         else if (max < min) {
22590             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22591             sv_catpvs(msg, "Illegal range in \"");
22592             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22593                                 UTF8fARG(is_contents_utf8, s - s0, s0));
22594             sv_catpvs(msg, "\"");
22595             goto return_failure;
22596         }
22597
22598 #if 0   /* See explanation at definition above of get_extended_utf8_msg() */
22599
22600         if (   UNICODE_IS_PERL_EXTENDED(min)
22601             || UNICODE_IS_PERL_EXTENDED(max))
22602         {
22603             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22604
22605             /* If both code points are non-portable, warn only on the lower
22606              * one. */
22607             sv_catpv(msg, get_extended_utf8_msg(
22608                                             (UNICODE_IS_PERL_EXTENDED(min))
22609                                             ? min : max));
22610             sv_catpvs(msg, " in \"");
22611             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22612                                  UTF8fARG(is_contents_utf8, s - s0, s0));
22613             sv_catpvs(msg, "\"");
22614         }
22615
22616 #endif
22617
22618         /* Here, this line contains a legal range */
22619         this_definition = sv_2mortal(_new_invlist(2));
22620         this_definition = _add_range_to_invlist(this_definition, min, max);
22621         goto calculate;
22622
22623       check_if_property:
22624
22625         /* Here it isn't a legal range line.  See if it is a legal property
22626          * line.  First find the end of the meat of the line */
22627         s = strpbrk(s, "#\n");
22628         if (s == NULL) {
22629             s = e;
22630         }
22631
22632         /* Ignore trailing blanks in keeping with the requirements of
22633          * parse_uniprop_string() */
22634         s--;
22635         while (s > s0 && isBLANK_A(*s)) {
22636             s--;
22637         }
22638         s++;
22639
22640         this_definition = parse_uniprop_string(s0, s - s0,
22641                                                is_utf8, to_fold, runtime,
22642                                                deferrable,
22643                                                user_defined_ptr, msg,
22644                                                (name_len == 0)
22645                                                 ? level /* Don't increase level
22646                                                            if input is empty */
22647                                                 : level + 1
22648                                               );
22649         if (this_definition == NULL) {
22650             goto return_failure;    /* 'msg' should have had the reason
22651                                        appended to it by the above call */
22652         }
22653
22654         if (! is_invlist(this_definition)) {    /* Unknown at this time */
22655             return newSVsv(this_definition);
22656         }
22657
22658         if (*s != '\n') {
22659             s = strchr(s, '\n');
22660             if (s == NULL) {
22661                 s = e;
22662             }
22663         }
22664
22665       calculate:
22666
22667         switch (op) {
22668             case '+':
22669                 _invlist_union(running_definition, this_definition,
22670                                                         &running_definition);
22671                 break;
22672             case '-':
22673                 _invlist_subtract(running_definition, this_definition,
22674                                                         &running_definition);
22675                 break;
22676             case '&':
22677                 _invlist_intersection(running_definition, this_definition,
22678                                                         &running_definition);
22679                 break;
22680             case '!':
22681                 _invlist_union_complement_2nd(running_definition,
22682                                         this_definition, &running_definition);
22683                 break;
22684             default:
22685                 Perl_croak(aTHX_ "panic: %s: %d: Unexpected operation %d",
22686                                  __FILE__, __LINE__, op);
22687                 break;
22688         }
22689
22690         /* Position past the '\n' */
22691         s0 = s + 1;
22692     }   /* End of loop through the lines of 'contents' */
22693
22694     /* Here, we processed all the lines in 'contents' without error.  If we
22695      * didn't add any warnings, simply return success */
22696     if (msgs_length_on_entry == SvCUR(msg)) {
22697
22698         /* If the expansion was empty, the answer isn't nothing: its an empty
22699          * inversion list */
22700         if (running_definition == NULL) {
22701             running_definition = _new_invlist(1);
22702         }
22703
22704         return running_definition;
22705     }
22706
22707     /* Otherwise, add some explanatory text, but we will return success */
22708     goto return_msg;
22709
22710   return_failure:
22711     running_definition = NULL;
22712
22713   return_msg:
22714
22715     if (name_len > 0) {
22716         sv_catpvs(msg, " in expansion of ");
22717         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
22718     }
22719
22720     return running_definition;
22721 }
22722
22723 /* As explained below, certain operations need to take place in the first
22724  * thread created.  These macros switch contexts */
22725 #ifdef USE_ITHREADS
22726 #  define DECLARATION_FOR_GLOBAL_CONTEXT                                    \
22727                                         PerlInterpreter * save_aTHX = aTHX;
22728 #  define SWITCH_TO_GLOBAL_CONTEXT                                          \
22729                            PERL_SET_CONTEXT((aTHX = PL_user_def_props_aTHX))
22730 #  define RESTORE_CONTEXT  PERL_SET_CONTEXT((aTHX = save_aTHX));
22731 #  define CUR_CONTEXT      aTHX
22732 #  define ORIGINAL_CONTEXT save_aTHX
22733 #else
22734 #  define DECLARATION_FOR_GLOBAL_CONTEXT
22735 #  define SWITCH_TO_GLOBAL_CONTEXT          NOOP
22736 #  define RESTORE_CONTEXT                   NOOP
22737 #  define CUR_CONTEXT                       NULL
22738 #  define ORIGINAL_CONTEXT                  NULL
22739 #endif
22740
22741 STATIC void
22742 S_delete_recursion_entry(pTHX_ void *key)
22743 {
22744     /* Deletes the entry used to detect recursion when expanding user-defined
22745      * properties.  This is a function so it can be set up to be called even if
22746      * the program unexpectedly quits */
22747
22748     dVAR;
22749     SV ** current_entry;
22750     const STRLEN key_len = strlen((const char *) key);
22751     DECLARATION_FOR_GLOBAL_CONTEXT;
22752
22753     SWITCH_TO_GLOBAL_CONTEXT;
22754
22755     /* If the entry is one of these types, it is a permanent entry, and not the
22756      * one used to detect recursions.  This function should delete only the
22757      * recursion entry */
22758     current_entry = hv_fetch(PL_user_def_props, (const char *) key, key_len, 0);
22759     if (     current_entry
22760         && ! is_invlist(*current_entry)
22761         && ! SvPOK(*current_entry))
22762     {
22763         (void) hv_delete(PL_user_def_props, (const char *) key, key_len,
22764                                                                     G_DISCARD);
22765     }
22766
22767     RESTORE_CONTEXT;
22768 }
22769
22770 STATIC SV *
22771 S_get_fq_name(pTHX_
22772               const char * const name,    /* The first non-blank in the \p{}, \P{} */
22773               const Size_t name_len,      /* Its length in bytes, not including any trailing space */
22774               const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22775               const bool has_colon_colon
22776              )
22777 {
22778     /* Returns a mortal SV containing the fully qualified version of the input
22779      * name */
22780
22781     SV * fq_name;
22782
22783     fq_name = newSVpvs_flags("", SVs_TEMP);
22784
22785     /* Use the current package if it wasn't included in our input */
22786     if (! has_colon_colon) {
22787         const HV * pkg = (IN_PERL_COMPILETIME)
22788                          ? PL_curstash
22789                          : CopSTASH(PL_curcop);
22790         const char* pkgname = HvNAME(pkg);
22791
22792         Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
22793                       UTF8fARG(is_utf8, strlen(pkgname), pkgname));
22794         sv_catpvs(fq_name, "::");
22795     }
22796
22797     Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
22798                          UTF8fARG(is_utf8, name_len, name));
22799     return fq_name;
22800 }
22801
22802 SV *
22803 Perl_parse_uniprop_string(pTHX_
22804
22805     /* Parse the interior of a \p{}, \P{}.  Returns its definition if knowable
22806      * now.  If so, the return is an inversion list.
22807      *
22808      * If the property is user-defined, it is a subroutine, which in turn
22809      * may call other subroutines.  This function will call the whole nest of
22810      * them to get the definition they return; if some aren't known at the time
22811      * of the call to this function, the fully qualified name of the highest
22812      * level sub is returned.  It is an error to call this function at runtime
22813      * without every sub defined.
22814      *
22815      * If an error was found, NULL is returned, and 'msg' gets a suitable
22816      * message appended to it.  (Appending allows the back trace of how we got
22817      * to the faulty definition to be displayed through nested calls of
22818      * user-defined subs.)
22819      *
22820      * The caller should NOT try to free any returned inversion list.
22821      *
22822      * Other parameters will be set on return as described below */
22823
22824     const char * const name,    /* The first non-blank in the \p{}, \P{} */
22825     const Size_t name_len,      /* Its length in bytes, not including any
22826                                    trailing space */
22827     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22828     const bool to_fold,         /* ? Is this under /i */
22829     const bool runtime,         /* TRUE if this is being called at run time */
22830     const bool deferrable,      /* TRUE if it's ok for the definition to not be
22831                                    known at this call */
22832     bool *user_defined_ptr,     /* Upon return from this function it will be
22833                                    set to TRUE if any component is a
22834                                    user-defined property */
22835     SV * msg,                   /* Any error or warning msg(s) are appended to
22836                                    this */
22837    const STRLEN level)          /* Recursion level of this call */
22838 {
22839     dVAR;
22840     char* lookup_name;          /* normalized name for lookup in our tables */
22841     unsigned lookup_len;        /* Its length */
22842     bool stricter = FALSE;      /* Some properties have stricter name
22843                                    normalization rules, which we decide upon
22844                                    based on parsing */
22845
22846     /* nv= or numeric_value=, or possibly one of the cjk numeric properties
22847      * (though it requires extra effort to download them from Unicode and
22848      * compile perl to know about them) */
22849     bool is_nv_type = FALSE;
22850
22851     unsigned int i, j = 0;
22852     int equals_pos = -1;    /* Where the '=' is found, or negative if none */
22853     int slash_pos  = -1;    /* Where the '/' is found, or negative if none */
22854     int table_index = 0;    /* The entry number for this property in the table
22855                                of all Unicode property names */
22856     bool starts_with_Is = FALSE;  /* ? Does the name start with 'Is' */
22857     Size_t lookup_offset = 0;   /* Used to ignore the first few characters of
22858                                    the normalized name in certain situations */
22859     Size_t non_pkg_begin = 0;   /* Offset of first byte in 'name' that isn't
22860                                    part of a package name */
22861     bool could_be_user_defined = TRUE;  /* ? Could this be a user-defined
22862                                              property rather than a Unicode
22863                                              one. */
22864     SV * prop_definition = NULL;  /* The returned definition of 'name' or NULL
22865                                      if an error.  If it is an inversion list,
22866                                      it is the definition.  Otherwise it is a
22867                                      string containing the fully qualified sub
22868                                      name of 'name' */
22869     SV * fq_name = NULL;        /* For user-defined properties, the fully
22870                                    qualified name */
22871     bool invert_return = FALSE; /* ? Do we need to complement the result before
22872                                      returning it */
22873
22874     PERL_ARGS_ASSERT_PARSE_UNIPROP_STRING;
22875
22876     /* The input will be normalized into 'lookup_name' */
22877     Newx(lookup_name, name_len, char);
22878     SAVEFREEPV(lookup_name);
22879
22880     /* Parse the input. */
22881     for (i = 0; i < name_len; i++) {
22882         char cur = name[i];
22883
22884         /* Most of the characters in the input will be of this ilk, being parts
22885          * of a name */
22886         if (isIDCONT_A(cur)) {
22887
22888             /* Case differences are ignored.  Our lookup routine assumes
22889              * everything is lowercase, so normalize to that */
22890             if (isUPPER_A(cur)) {
22891                 lookup_name[j++] = toLOWER_A(cur);
22892                 continue;
22893             }
22894
22895             if (cur == '_') { /* Don't include these in the normalized name */
22896                 continue;
22897             }
22898
22899             lookup_name[j++] = cur;
22900
22901             /* The first character in a user-defined name must be of this type.
22902              * */
22903             if (i - non_pkg_begin == 0 && ! isIDFIRST_A(cur)) {
22904                 could_be_user_defined = FALSE;
22905             }
22906
22907             continue;
22908         }
22909
22910         /* Here, the character is not something typically in a name,  But these
22911          * two types of characters (and the '_' above) can be freely ignored in
22912          * most situations.  Later it may turn out we shouldn't have ignored
22913          * them, and we have to reparse, but we don't have enough information
22914          * yet to make that decision */
22915         if (cur == '-' || isSPACE_A(cur)) {
22916             could_be_user_defined = FALSE;
22917             continue;
22918         }
22919
22920         /* An equals sign or single colon mark the end of the first part of
22921          * the property name */
22922         if (    cur == '='
22923             || (cur == ':' && (i >= name_len - 1 || name[i+1] != ':')))
22924         {
22925             lookup_name[j++] = '='; /* Treat the colon as an '=' */
22926             equals_pos = j; /* Note where it occurred in the input */
22927             could_be_user_defined = FALSE;
22928             break;
22929         }
22930
22931         /* Otherwise, this character is part of the name. */
22932         lookup_name[j++] = cur;
22933
22934         /* Here it isn't a single colon, so if it is a colon, it must be a
22935          * double colon */
22936         if (cur == ':') {
22937
22938             /* A double colon should be a package qualifier.  We note its
22939              * position and continue.  Note that one could have
22940              *      pkg1::pkg2::...::foo
22941              * so that the position at the end of the loop will be just after
22942              * the final qualifier */
22943
22944             i++;
22945             non_pkg_begin = i + 1;
22946             lookup_name[j++] = ':';
22947         }
22948         else { /* Only word chars (and '::') can be in a user-defined name */
22949             could_be_user_defined = FALSE;
22950         }
22951     } /* End of parsing through the lhs of the property name (or all of it if
22952          no rhs) */
22953
22954 #define STRLENs(s)  (sizeof("" s "") - 1)
22955
22956     /* If there is a single package name 'utf8::', it is ambiguous.  It could
22957      * be for a user-defined property, or it could be a Unicode property, as
22958      * all of them are considered to be for that package.  For the purposes of
22959      * parsing the rest of the property, strip it off */
22960     if (non_pkg_begin == STRLENs("utf8::") && memBEGINPs(name, name_len, "utf8::")) {
22961         lookup_name +=  STRLENs("utf8::");
22962         j -=  STRLENs("utf8::");
22963         equals_pos -=  STRLENs("utf8::");
22964     }
22965
22966     /* Here, we are either done with the whole property name, if it was simple;
22967      * or are positioned just after the '=' if it is compound. */
22968
22969     if (equals_pos >= 0) {
22970         assert(! stricter); /* We shouldn't have set this yet */
22971
22972         /* Space immediately after the '=' is ignored */
22973         i++;
22974         for (; i < name_len; i++) {
22975             if (! isSPACE_A(name[i])) {
22976                 break;
22977             }
22978         }
22979
22980         /* Most punctuation after the equals indicates a subpattern, like
22981          * \p{foo=/bar/} */
22982         if (   isPUNCT_A(name[i])
22983             && name[i] != '-'
22984             && name[i] != '+'
22985             && name[i] != '_'
22986             && name[i] != '{')
22987         {
22988             /* Find the property.  The table includes the equals sign, so we
22989              * use 'j' as-is */
22990             table_index = match_uniprop((U8 *) lookup_name, j);
22991             if (table_index) {
22992                 const char * const * prop_values
22993                                             = UNI_prop_value_ptrs[table_index];
22994                 SV * subpattern;
22995                 Size_t subpattern_len;
22996                 REGEXP * subpattern_re;
22997                 char open = name[i++];
22998                 char close;
22999                 const char * pos_in_brackets;
23000                 bool escaped = 0;
23001
23002                 /* A backslash means the real delimitter is the next character.
23003                  * */
23004                 if (open == '\\') {
23005                     open = name[i++];
23006                     escaped = 1;
23007                 }
23008
23009                 /* This data structure is constructed so that the matching
23010                  * closing bracket is 3 past its matching opening.  The second
23011                  * set of closing is so that if the opening is something like
23012                  * ']', the closing will be that as well.  Something similar is
23013                  * done in toke.c */
23014                 pos_in_brackets = strchr("([<)]>)]>", open);
23015                 close = (pos_in_brackets) ? pos_in_brackets[3] : open;
23016
23017                 if (    i >= name_len
23018                     ||  name[name_len-1] != close
23019                     || (escaped && name[name_len-2] != '\\'))
23020                 {
23021                     sv_catpvs(msg, "Unicode property wildcard not terminated");
23022                     goto append_name_to_msg;
23023                 }
23024
23025                 Perl_ck_warner_d(aTHX_
23026                     packWARN(WARN_EXPERIMENTAL__UNIPROP_WILDCARDS),
23027                     "The Unicode property wildcards feature is experimental");
23028
23029                 /* Now create and compile the wildcard subpattern.  Use /iaa
23030                  * because nothing outside of ASCII will match, and it the
23031                  * property values should all match /i.  Note that when the
23032                  * pattern fails to compile, our added text to the user's
23033                  * pattern will be displayed to the user, which is not so
23034                  * desirable. */
23035                 subpattern_len = name_len - i - 1 - escaped;
23036                 subpattern = Perl_newSVpvf(aTHX_ "(?iaa:%.*s)",
23037                                               (unsigned) subpattern_len,
23038                                               name + i);
23039                 subpattern = sv_2mortal(subpattern);
23040                 subpattern_re = re_compile(subpattern, 0);
23041                 assert(subpattern_re);  /* Should have died if didn't compile
23042                                          successfully */
23043
23044                 /* For each legal property value, see if the supplied pattern
23045                  * matches it. */
23046                 while (*prop_values) {
23047                     const char * const entry = *prop_values;
23048                     const Size_t len = strlen(entry);
23049                     SV* entry_sv = newSVpvn_flags(entry, len, SVs_TEMP);
23050
23051                     if (pregexec(subpattern_re,
23052                                  (char *) entry,
23053                                  (char *) entry + len,
23054                                  (char *) entry, 0,
23055                                  entry_sv,
23056                                  0))
23057                     { /* Here, matched.  Add to the returned list */
23058                         Size_t total_len = j + len;
23059                         SV * sub_invlist = NULL;
23060                         char * this_string;
23061
23062                         /* We know this is a legal \p{property=value}.  Call
23063                          * the function to return the list of code points that
23064                          * match it */
23065                         Newxz(this_string, total_len + 1, char);
23066                         Copy(lookup_name, this_string, j, char);
23067                         my_strlcat(this_string, entry, total_len + 1);
23068                         SAVEFREEPV(this_string);
23069                         sub_invlist = parse_uniprop_string(this_string,
23070                                                            total_len,
23071                                                            is_utf8,
23072                                                            to_fold,
23073                                                            runtime,
23074                                                            deferrable,
23075                                                            user_defined_ptr,
23076                                                            msg,
23077                                                            level + 1);
23078                         _invlist_union(prop_definition, sub_invlist,
23079                                        &prop_definition);
23080                     }
23081
23082                     prop_values++;  /* Next iteration, look at next propvalue */
23083                 } /* End of looking through property values; (the data
23084                      structure is terminated by a NULL ptr) */
23085
23086                 SvREFCNT_dec_NN(subpattern_re);
23087
23088                 if (prop_definition) {
23089                     return prop_definition;
23090                 }
23091
23092                 sv_catpvs(msg, "No Unicode property value wildcard matches:");
23093                 goto append_name_to_msg;
23094             }
23095
23096             /* Here's how khw thinks we should proceed to handle the properties
23097              * not yet done:    Bidi Mirroring Glyph
23098                                 Bidi Paired Bracket
23099                                 Case Folding  (both full and simple)
23100                                 Decomposition Mapping
23101                                 Equivalent Unified Ideograph
23102                                 Name
23103                                 Name Alias
23104                                 Lowercase Mapping  (both full and simple)
23105                                 NFKC Case Fold
23106                                 Titlecase Mapping  (both full and simple)
23107                                 Uppercase Mapping  (both full and simple)
23108              * Move the part that looks at the property values into a perl
23109              * script, like utf8_heavy.pl is done.  This makes things somewhat
23110              * easier, but most importantly, it avoids always adding all these
23111              * strings to the memory usage when the feature is little-used.
23112              *
23113              * The property values would all be concatenated into a single
23114              * string per property with each value on a separate line, and the
23115              * code point it's for on alternating lines.  Then we match the
23116              * user's input pattern m//mg, without having to worry about their
23117              * uses of '^' and '$'.  Only the values that aren't the default
23118              * would be in the strings.  Code points would be in UTF-8.  The
23119              * search pattern that we would construct would look like
23120              * (?: \n (code-point_re) \n (?aam: user-re ) \n )
23121              * And so $1 would contain the code point that matched the user-re.
23122              * For properties where the default is the code point itself, such
23123              * as any of the case changing mappings, the string would otherwise
23124              * consist of all Unicode code points in UTF-8 strung together.
23125              * This would be impractical.  So instead, examine their compiled
23126              * pattern, looking at the ssc.  If none, reject the pattern as an
23127              * error.  Otherwise run the pattern against every code point in
23128              * the ssc.  The ssc is kind of like tr18's 3.9 Possible Match Sets
23129              * And it might be good to create an API to return the ssc.
23130              *
23131              * For the name properties, a new function could be created in
23132              * charnames which essentially does the same thing as above,
23133              * sharing Name.pl with the other charname functions.  Don't know
23134              * about loose name matching, or algorithmically determined names.
23135              * Decomposition.pl similarly.
23136              *
23137              * It might be that a new pattern modifier would have to be
23138              * created, like /t for resTricTed, which changed the behavior of
23139              * some constructs in their subpattern, like \A. */
23140         } /* End of is a wildcard subppattern */
23141
23142
23143         /* Certain properties whose values are numeric need special handling.
23144          * They may optionally be prefixed by 'is'.  Ignore that prefix for the
23145          * purposes of checking if this is one of those properties */
23146         if (memBEGINPs(lookup_name, j, "is")) {
23147             lookup_offset = 2;
23148         }
23149
23150         /* Then check if it is one of these specially-handled properties.  The
23151          * possibilities are hard-coded because easier this way, and the list
23152          * is unlikely to change.
23153          *
23154          * All numeric value type properties are of this ilk, and are also
23155          * special in a different way later on.  So find those first.  There
23156          * are several numeric value type properties in the Unihan DB (which is
23157          * unlikely to be compiled with perl, but we handle it here in case it
23158          * does get compiled).  They all end with 'numeric'.  The interiors
23159          * aren't checked for the precise property.  This would stop working if
23160          * a cjk property were to be created that ended with 'numeric' and
23161          * wasn't a numeric type */
23162         is_nv_type = memEQs(lookup_name + lookup_offset,
23163                        j - 1 - lookup_offset, "numericvalue")
23164                   || memEQs(lookup_name + lookup_offset,
23165                       j - 1 - lookup_offset, "nv")
23166                   || (   memENDPs(lookup_name + lookup_offset,
23167                             j - 1 - lookup_offset, "numeric")
23168                       && (   memBEGINPs(lookup_name + lookup_offset,
23169                                       j - 1 - lookup_offset, "cjk")
23170                           || memBEGINPs(lookup_name + lookup_offset,
23171                                       j - 1 - lookup_offset, "k")));
23172         if (   is_nv_type
23173             || memEQs(lookup_name + lookup_offset,
23174                       j - 1 - lookup_offset, "canonicalcombiningclass")
23175             || memEQs(lookup_name + lookup_offset,
23176                       j - 1 - lookup_offset, "ccc")
23177             || memEQs(lookup_name + lookup_offset,
23178                       j - 1 - lookup_offset, "age")
23179             || memEQs(lookup_name + lookup_offset,
23180                       j - 1 - lookup_offset, "in")
23181             || memEQs(lookup_name + lookup_offset,
23182                       j - 1 - lookup_offset, "presentin"))
23183         {
23184             unsigned int k;
23185
23186             /* Since the stuff after the '=' is a number, we can't throw away
23187              * '-' willy-nilly, as those could be a minus sign.  Other stricter
23188              * rules also apply.  However, these properties all can have the
23189              * rhs not be a number, in which case they contain at least one
23190              * alphabetic.  In those cases, the stricter rules don't apply.
23191              * But the numeric type properties can have the alphas [Ee] to
23192              * signify an exponent, and it is still a number with stricter
23193              * rules.  So look for an alpha that signifies not-strict */
23194             stricter = TRUE;
23195             for (k = i; k < name_len; k++) {
23196                 if (   isALPHA_A(name[k])
23197                     && (! is_nv_type || ! isALPHA_FOLD_EQ(name[k], 'E')))
23198                 {
23199                     stricter = FALSE;
23200                     break;
23201                 }
23202             }
23203         }
23204
23205         if (stricter) {
23206
23207             /* A number may have a leading '+' or '-'.  The latter is retained
23208              * */
23209             if (name[i] == '+') {
23210                 i++;
23211             }
23212             else if (name[i] == '-') {
23213                 lookup_name[j++] = '-';
23214                 i++;
23215             }
23216
23217             /* Skip leading zeros including single underscores separating the
23218              * zeros, or between the final leading zero and the first other
23219              * digit */
23220             for (; i < name_len - 1; i++) {
23221                 if (    name[i] != '0'
23222                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
23223                 {
23224                     break;
23225                 }
23226             }
23227         }
23228     }
23229     else {  /* No '=' */
23230
23231        /* Only a few properties without an '=' should be parsed with stricter
23232         * rules.  The list is unlikely to change. */
23233         if (   memBEGINPs(lookup_name, j, "perl")
23234             && memNEs(lookup_name + 4, j - 4, "space")
23235             && memNEs(lookup_name + 4, j - 4, "word"))
23236         {
23237             stricter = TRUE;
23238
23239             /* We set the inputs back to 0 and the code below will reparse,
23240              * using strict */
23241             i = j = 0;
23242         }
23243     }
23244
23245     /* Here, we have either finished the property, or are positioned to parse
23246      * the remainder, and we know if stricter rules apply.  Finish out, if not
23247      * already done */
23248     for (; i < name_len; i++) {
23249         char cur = name[i];
23250
23251         /* In all instances, case differences are ignored, and we normalize to
23252          * lowercase */
23253         if (isUPPER_A(cur)) {
23254             lookup_name[j++] = toLOWER(cur);
23255             continue;
23256         }
23257
23258         /* An underscore is skipped, but not under strict rules unless it
23259          * separates two digits */
23260         if (cur == '_') {
23261             if (    stricter
23262                 && (     i == 0 || (int) i == equals_pos || i == name_len- 1
23263                     || ! isDIGIT_A(name[i-1]) || ! isDIGIT_A(name[i+1])))
23264             {
23265                 lookup_name[j++] = '_';
23266             }
23267             continue;
23268         }
23269
23270         /* Hyphens are skipped except under strict */
23271         if (cur == '-' && ! stricter) {
23272             continue;
23273         }
23274
23275         /* XXX Bug in documentation.  It says white space skipped adjacent to
23276          * non-word char.  Maybe we should, but shouldn't skip it next to a dot
23277          * in a number */
23278         if (isSPACE_A(cur) && ! stricter) {
23279             continue;
23280         }
23281
23282         lookup_name[j++] = cur;
23283
23284         /* Unless this is a non-trailing slash, we are done with it */
23285         if (i >= name_len - 1 || cur != '/') {
23286             continue;
23287         }
23288
23289         slash_pos = j;
23290
23291         /* A slash in the 'numeric value' property indicates that what follows
23292          * is a denominator.  It can have a leading '+' and '0's that should be
23293          * skipped.  But we have never allowed a negative denominator, so treat
23294          * a minus like every other character.  (No need to rule out a second
23295          * '/', as that won't match anything anyway */
23296         if (is_nv_type) {
23297             i++;
23298             if (i < name_len && name[i] == '+') {
23299                 i++;
23300             }
23301
23302             /* Skip leading zeros including underscores separating digits */
23303             for (; i < name_len - 1; i++) {
23304                 if (   name[i] != '0'
23305                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
23306                 {
23307                     break;
23308                 }
23309             }
23310
23311             /* Store the first real character in the denominator */
23312             if (i < name_len) {
23313                 lookup_name[j++] = name[i];
23314             }
23315         }
23316     }
23317
23318     /* Here are completely done parsing the input 'name', and 'lookup_name'
23319      * contains a copy, normalized.
23320      *
23321      * This special case is grandfathered in: 'L_' and 'GC=L_' are accepted and
23322      * different from without the underscores.  */
23323     if (  (   UNLIKELY(memEQs(lookup_name, j, "l"))
23324            || UNLIKELY(memEQs(lookup_name, j, "gc=l")))
23325         && UNLIKELY(name[name_len-1] == '_'))
23326     {
23327         lookup_name[j++] = '&';
23328     }
23329
23330     /* If the original input began with 'In' or 'Is', it could be a subroutine
23331      * call to a user-defined property instead of a Unicode property name. */
23332     if (    name_len - non_pkg_begin > 2
23333         &&  name[non_pkg_begin+0] == 'I'
23334         && (name[non_pkg_begin+1] == 'n' || name[non_pkg_begin+1] == 's'))
23335     {
23336         /* Names that start with In have different characterstics than those
23337          * that start with Is */
23338         if (name[non_pkg_begin+1] == 's') {
23339             starts_with_Is = TRUE;
23340         }
23341     }
23342     else {
23343         could_be_user_defined = FALSE;
23344     }
23345
23346     if (could_be_user_defined) {
23347         CV* user_sub;
23348
23349         /* If the user defined property returns the empty string, it could
23350          * easily be because the pattern is being compiled before the data it
23351          * actually needs to compile is available.  This could be argued to be
23352          * a bug in the perl code, but this is a change of behavior for Perl,
23353          * so we handle it.  This means that intentionally returning nothing
23354          * will not be resolved until runtime */
23355         bool empty_return = FALSE;
23356
23357         /* Here, the name could be for a user defined property, which are
23358          * implemented as subs. */
23359         user_sub = get_cvn_flags(name, name_len, 0);
23360         if (user_sub) {
23361             const char insecure[] = "Insecure user-defined property";
23362
23363             /* Here, there is a sub by the correct name.  Normally we call it
23364              * to get the property definition */
23365             dSP;
23366             SV * user_sub_sv = MUTABLE_SV(user_sub);
23367             SV * error;     /* Any error returned by calling 'user_sub' */
23368             SV * key;       /* The key into the hash of user defined sub names
23369                              */
23370             SV * placeholder;
23371             SV ** saved_user_prop_ptr;      /* Hash entry for this property */
23372
23373             /* How many times to retry when another thread is in the middle of
23374              * expanding the same definition we want */
23375             PERL_INT_FAST8_T retry_countdown = 10;
23376
23377             DECLARATION_FOR_GLOBAL_CONTEXT;
23378
23379             /* If we get here, we know this property is user-defined */
23380             *user_defined_ptr = TRUE;
23381
23382             /* We refuse to call a potentially tainted subroutine; returning an
23383              * error instead */
23384             if (TAINT_get) {
23385                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23386                 sv_catpvn(msg, insecure, sizeof(insecure) - 1);
23387                 goto append_name_to_msg;
23388             }
23389
23390             /* In principal, we only call each subroutine property definition
23391              * once during the life of the program.  This guarantees that the
23392              * property definition never changes.  The results of the single
23393              * sub call are stored in a hash, which is used instead for future
23394              * references to this property.  The property definition is thus
23395              * immutable.  But, to allow the user to have a /i-dependent
23396              * definition, we call the sub once for non-/i, and once for /i,
23397              * should the need arise, passing the /i status as a parameter.
23398              *
23399              * We start by constructing the hash key name, consisting of the
23400              * fully qualified subroutine name, preceded by the /i status, so
23401              * that there is a key for /i and a different key for non-/i */
23402             key = newSVpvn(((to_fold) ? "1" : "0"), 1);
23403             fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
23404                                           non_pkg_begin != 0);
23405             sv_catsv(key, fq_name);
23406             sv_2mortal(key);
23407
23408             /* We only call the sub once throughout the life of the program
23409              * (with the /i, non-/i exception noted above).  That means the
23410              * hash must be global and accessible to all threads.  It is
23411              * created at program start-up, before any threads are created, so
23412              * is accessible to all children.  But this creates some
23413              * complications.
23414              *
23415              * 1) The keys can't be shared, or else problems arise; sharing is
23416              *    turned off at hash creation time
23417              * 2) All SVs in it are there for the remainder of the life of the
23418              *    program, and must be created in the same interpreter context
23419              *    as the hash, or else they will be freed from the wrong pool
23420              *    at global destruction time.  This is handled by switching to
23421              *    the hash's context to create each SV going into it, and then
23422              *    immediately switching back
23423              * 3) All accesses to the hash must be controlled by a mutex, to
23424              *    prevent two threads from getting an unstable state should
23425              *    they simultaneously be accessing it.  The code below is
23426              *    crafted so that the mutex is locked whenever there is an
23427              *    access and unlocked only when the next stable state is
23428              *    achieved.
23429              *
23430              * The hash stores either the definition of the property if it was
23431              * valid, or, if invalid, the error message that was raised.  We
23432              * use the type of SV to distinguish.
23433              *
23434              * There's also the need to guard against the definition expansion
23435              * from infinitely recursing.  This is handled by storing the aTHX
23436              * of the expanding thread during the expansion.  Again the SV type
23437              * is used to distinguish this from the other two cases.  If we
23438              * come to here and the hash entry for this property is our aTHX,
23439              * it means we have recursed, and the code assumes that we would
23440              * infinitely recurse, so instead stops and raises an error.
23441              * (Any recursion has always been treated as infinite recursion in
23442              * this feature.)
23443              *
23444              * If instead, the entry is for a different aTHX, it means that
23445              * that thread has gotten here first, and hasn't finished expanding
23446              * the definition yet.  We just have to wait until it is done.  We
23447              * sleep and retry a few times, returning an error if the other
23448              * thread doesn't complete. */
23449
23450           re_fetch:
23451             USER_PROP_MUTEX_LOCK;
23452
23453             /* If we have an entry for this key, the subroutine has already
23454              * been called once with this /i status. */
23455             saved_user_prop_ptr = hv_fetch(PL_user_def_props,
23456                                                    SvPVX(key), SvCUR(key), 0);
23457             if (saved_user_prop_ptr) {
23458
23459                 /* If the saved result is an inversion list, it is the valid
23460                  * definition of this property */
23461                 if (is_invlist(*saved_user_prop_ptr)) {
23462                     prop_definition = *saved_user_prop_ptr;
23463
23464                     /* The SV in the hash won't be removed until global
23465                      * destruction, so it is stable and we can unlock */
23466                     USER_PROP_MUTEX_UNLOCK;
23467
23468                     /* The caller shouldn't try to free this SV */
23469                     return prop_definition;
23470                 }
23471
23472                 /* Otherwise, if it is a string, it is the error message
23473                  * that was returned when we first tried to evaluate this
23474                  * property.  Fail, and append the message */
23475                 if (SvPOK(*saved_user_prop_ptr)) {
23476                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23477                     sv_catsv(msg, *saved_user_prop_ptr);
23478
23479                     /* The SV in the hash won't be removed until global
23480                      * destruction, so it is stable and we can unlock */
23481                     USER_PROP_MUTEX_UNLOCK;
23482
23483                     return NULL;
23484                 }
23485
23486                 assert(SvIOK(*saved_user_prop_ptr));
23487
23488                 /* Here, we have an unstable entry in the hash.  Either another
23489                  * thread is in the middle of expanding the property's
23490                  * definition, or we are ourselves recursing.  We use the aTHX
23491                  * in it to distinguish */
23492                 if (SvIV(*saved_user_prop_ptr) != PTR2IV(CUR_CONTEXT)) {
23493
23494                     /* Here, it's another thread doing the expanding.  We've
23495                      * looked as much as we are going to at the contents of the
23496                      * hash entry.  It's safe to unlock. */
23497                     USER_PROP_MUTEX_UNLOCK;
23498
23499                     /* Retry a few times */
23500                     if (retry_countdown-- > 0) {
23501                         PerlProc_sleep(1);
23502                         goto re_fetch;
23503                     }
23504
23505                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23506                     sv_catpvs(msg, "Timeout waiting for another thread to "
23507                                    "define");
23508                     goto append_name_to_msg;
23509                 }
23510
23511                 /* Here, we are recursing; don't dig any deeper */
23512                 USER_PROP_MUTEX_UNLOCK;
23513
23514                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23515                 sv_catpvs(msg,
23516                           "Infinite recursion in user-defined property");
23517                 goto append_name_to_msg;
23518             }
23519
23520             /* Here, this thread has exclusive control, and there is no entry
23521              * for this property in the hash.  So we have the go ahead to
23522              * expand the definition ourselves. */
23523
23524             PUSHSTACKi(PERLSI_MAGIC);
23525             ENTER;
23526
23527             /* Create a temporary placeholder in the hash to detect recursion
23528              * */
23529             SWITCH_TO_GLOBAL_CONTEXT;
23530             placeholder= newSVuv(PTR2IV(ORIGINAL_CONTEXT));
23531             (void) hv_store_ent(PL_user_def_props, key, placeholder, 0);
23532             RESTORE_CONTEXT;
23533
23534             /* Now that we have a placeholder, we can let other threads
23535              * continue */
23536             USER_PROP_MUTEX_UNLOCK;
23537
23538             /* Make sure the placeholder always gets destroyed */
23539             SAVEDESTRUCTOR_X(S_delete_recursion_entry, SvPVX(key));
23540
23541             PUSHMARK(SP);
23542             SAVETMPS;
23543
23544             /* Call the user's function, with the /i status as a parameter.
23545              * Note that we have gone to a lot of trouble to keep this call
23546              * from being within the locked mutex region. */
23547             XPUSHs(boolSV(to_fold));
23548             PUTBACK;
23549
23550             /* The following block was taken from swash_init().  Presumably
23551              * they apply to here as well, though we no longer use a swash --
23552              * khw */
23553             SAVEHINTS();
23554             save_re_context();
23555             /* We might get here via a subroutine signature which uses a utf8
23556              * parameter name, at which point PL_subname will have been set
23557              * but not yet used. */
23558             save_item(PL_subname);
23559
23560             (void) call_sv(user_sub_sv, G_EVAL|G_SCALAR);
23561
23562             SPAGAIN;
23563
23564             error = ERRSV;
23565             if (TAINT_get || SvTRUE(error)) {
23566                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23567                 if (SvTRUE(error)) {
23568                     sv_catpvs(msg, "Error \"");
23569                     sv_catsv(msg, error);
23570                     sv_catpvs(msg, "\"");
23571                 }
23572                 if (TAINT_get) {
23573                     if (SvTRUE(error)) sv_catpvs(msg, "; ");
23574                     sv_catpvn(msg, insecure, sizeof(insecure) - 1);
23575                 }
23576
23577                 if (name_len > 0) {
23578                     sv_catpvs(msg, " in expansion of ");
23579                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8,
23580                                                                   name_len,
23581                                                                   name));
23582                 }
23583
23584                 (void) POPs;
23585                 prop_definition = NULL;
23586             }
23587             else {  /* G_SCALAR guarantees a single return value */
23588                 SV * contents = POPs;
23589
23590                 /* The contents is supposed to be the expansion of the property
23591                  * definition.  If the definition is deferrable, and we got an
23592                  * empty string back, set a flag to later defer it (after clean
23593                  * up below). */
23594                 if (      deferrable
23595                     && (! SvPOK(contents) || SvCUR(contents) == 0))
23596                 {
23597                         empty_return = TRUE;
23598                 }
23599                 else { /* Otherwise, call a function to check for valid syntax,
23600                           and handle it */
23601
23602                     prop_definition = handle_user_defined_property(
23603                                                     name, name_len,
23604                                                     is_utf8, to_fold, runtime,
23605                                                     deferrable,
23606                                                     contents, user_defined_ptr,
23607                                                     msg,
23608                                                     level);
23609                 }
23610             }
23611
23612             /* Here, we have the results of the expansion.  Delete the
23613              * placeholder, and if the definition is now known, replace it with
23614              * that definition.  We need exclusive access to the hash, and we
23615              * can't let anyone else in, between when we delete the placeholder
23616              * and add the permanent entry */
23617             USER_PROP_MUTEX_LOCK;
23618
23619             S_delete_recursion_entry(aTHX_ SvPVX(key));
23620
23621             if (    ! empty_return
23622                 && (! prop_definition || is_invlist(prop_definition)))
23623             {
23624                 /* If we got success we use the inversion list defining the
23625                  * property; otherwise use the error message */
23626                 SWITCH_TO_GLOBAL_CONTEXT;
23627                 (void) hv_store_ent(PL_user_def_props,
23628                                     key,
23629                                     ((prop_definition)
23630                                      ? newSVsv(prop_definition)
23631                                      : newSVsv(msg)),
23632                                     0);
23633                 RESTORE_CONTEXT;
23634             }
23635
23636             /* All done, and the hash now has a permanent entry for this
23637              * property.  Give up exclusive control */
23638             USER_PROP_MUTEX_UNLOCK;
23639
23640             FREETMPS;
23641             LEAVE;
23642             POPSTACK;
23643
23644             if (empty_return) {
23645                 goto definition_deferred;
23646             }
23647
23648             if (prop_definition) {
23649
23650                 /* If the definition is for something not known at this time,
23651                  * we toss it, and go return the main property name, as that's
23652                  * the one the user will be aware of */
23653                 if (! is_invlist(prop_definition)) {
23654                     SvREFCNT_dec_NN(prop_definition);
23655                     goto definition_deferred;
23656                 }
23657
23658                 sv_2mortal(prop_definition);
23659             }
23660
23661             /* And return */
23662             return prop_definition;
23663
23664         }   /* End of calling the subroutine for the user-defined property */
23665     }       /* End of it could be a user-defined property */
23666
23667     /* Here it wasn't a user-defined property that is known at this time.  See
23668      * if it is a Unicode property */
23669
23670     lookup_len = j;     /* This is a more mnemonic name than 'j' */
23671
23672     /* Get the index into our pointer table of the inversion list corresponding
23673      * to the property */
23674     table_index = match_uniprop((U8 *) lookup_name, lookup_len);
23675
23676     /* If it didn't find the property ... */
23677     if (table_index == 0) {
23678
23679         /* Try again stripping off any initial 'Is'.  This is because we
23680          * promise that an initial Is is optional.  The same isn't true of
23681          * names that start with 'In'.  Those can match only blocks, and the
23682          * lookup table already has those accounted for. */
23683         if (starts_with_Is) {
23684             lookup_name += 2;
23685             lookup_len -= 2;
23686             equals_pos -= 2;
23687             slash_pos -= 2;
23688
23689             table_index = match_uniprop((U8 *) lookup_name, lookup_len);
23690         }
23691
23692         if (table_index == 0) {
23693             char * canonical;
23694
23695             /* Here, we didn't find it.  If not a numeric type property, and
23696              * can't be a user-defined one, it isn't a legal property */
23697             if (! is_nv_type) {
23698                 if (! could_be_user_defined) {
23699                     goto failed;
23700                 }
23701
23702                 /* Here, the property name is legal as a user-defined one.   At
23703                  * compile time, it might just be that the subroutine for that
23704                  * property hasn't been encountered yet, but at runtime, it's
23705                  * an error to try to use an undefined one */
23706                 if (! deferrable) {
23707                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23708                     sv_catpvs(msg, "Unknown user-defined property name");
23709                     goto append_name_to_msg;
23710                 }
23711
23712                 goto definition_deferred;
23713             } /* End of isn't a numeric type property */
23714
23715             /* The numeric type properties need more work to decide.  What we
23716              * do is make sure we have the number in canonical form and look
23717              * that up. */
23718
23719             if (slash_pos < 0) {    /* No slash */
23720
23721                 /* When it isn't a rational, take the input, convert it to a
23722                  * NV, then create a canonical string representation of that
23723                  * NV. */
23724
23725                 NV value;
23726                 SSize_t value_len = lookup_len - equals_pos;
23727
23728                 /* Get the value */
23729                 if (   value_len <= 0
23730                     || my_atof3(lookup_name + equals_pos, &value,
23731                                 value_len)
23732                           != lookup_name + lookup_len)
23733                 {
23734                     goto failed;
23735                 }
23736
23737                 /* If the value is an integer, the canonical value is integral
23738                  * */
23739                 if (Perl_ceil(value) == value) {
23740                     canonical = Perl_form(aTHX_ "%.*s%.0" NVff,
23741                                             equals_pos, lookup_name, value);
23742                 }
23743                 else {  /* Otherwise, it is %e with a known precision */
23744                     char * exp_ptr;
23745
23746                     canonical = Perl_form(aTHX_ "%.*s%.*" NVef,
23747                                                 equals_pos, lookup_name,
23748                                                 PL_E_FORMAT_PRECISION, value);
23749
23750                     /* The exponent generated is expecting two digits, whereas
23751                      * %e on some systems will generate three.  Remove leading
23752                      * zeros in excess of 2 from the exponent.  We start
23753                      * looking for them after the '=' */
23754                     exp_ptr = strchr(canonical + equals_pos, 'e');
23755                     if (exp_ptr) {
23756                         char * cur_ptr = exp_ptr + 2; /* past the 'e[+-]' */
23757                         SSize_t excess_exponent_len = strlen(cur_ptr) - 2;
23758
23759                         assert(*(cur_ptr - 1) == '-' || *(cur_ptr - 1) == '+');
23760
23761                         if (excess_exponent_len > 0) {
23762                             SSize_t leading_zeros = strspn(cur_ptr, "0");
23763                             SSize_t excess_leading_zeros
23764                                     = MIN(leading_zeros, excess_exponent_len);
23765                             if (excess_leading_zeros > 0) {
23766                                 Move(cur_ptr + excess_leading_zeros,
23767                                      cur_ptr,
23768                                      strlen(cur_ptr) - excess_leading_zeros
23769                                        + 1,  /* Copy the NUL as well */
23770                                      char);
23771                             }
23772                         }
23773                     }
23774                 }
23775             }
23776             else {  /* Has a slash.  Create a rational in canonical form  */
23777                 UV numerator, denominator, gcd, trial;
23778                 const char * end_ptr;
23779                 const char * sign = "";
23780
23781                 /* We can't just find the numerator, denominator, and do the
23782                  * division, then use the method above, because that is
23783                  * inexact.  And the input could be a rational that is within
23784                  * epsilon (given our precision) of a valid rational, and would
23785                  * then incorrectly compare valid.
23786                  *
23787                  * We're only interested in the part after the '=' */
23788                 const char * this_lookup_name = lookup_name + equals_pos;
23789                 lookup_len -= equals_pos;
23790                 slash_pos -= equals_pos;
23791
23792                 /* Handle any leading minus */
23793                 if (this_lookup_name[0] == '-') {
23794                     sign = "-";
23795                     this_lookup_name++;
23796                     lookup_len--;
23797                     slash_pos--;
23798                 }
23799
23800                 /* Convert the numerator to numeric */
23801                 end_ptr = this_lookup_name + slash_pos;
23802                 if (! grok_atoUV(this_lookup_name, &numerator, &end_ptr)) {
23803                     goto failed;
23804                 }
23805
23806                 /* It better have included all characters before the slash */
23807                 if (*end_ptr != '/') {
23808                     goto failed;
23809                 }
23810
23811                 /* Set to look at just the denominator */
23812                 this_lookup_name += slash_pos;
23813                 lookup_len -= slash_pos;
23814                 end_ptr = this_lookup_name + lookup_len;
23815
23816                 /* Convert the denominator to numeric */
23817                 if (! grok_atoUV(this_lookup_name, &denominator, &end_ptr)) {
23818                     goto failed;
23819                 }
23820
23821                 /* It better be the rest of the characters, and don't divide by
23822                  * 0 */
23823                 if (   end_ptr != this_lookup_name + lookup_len
23824                     || denominator == 0)
23825                 {
23826                     goto failed;
23827                 }
23828
23829                 /* Get the greatest common denominator using
23830                    http://en.wikipedia.org/wiki/Euclidean_algorithm */
23831                 gcd = numerator;
23832                 trial = denominator;
23833                 while (trial != 0) {
23834                     UV temp = trial;
23835                     trial = gcd % trial;
23836                     gcd = temp;
23837                 }
23838
23839                 /* If already in lowest possible terms, we have already tried
23840                  * looking this up */
23841                 if (gcd == 1) {
23842                     goto failed;
23843                 }
23844
23845                 /* Reduce the rational, which should put it in canonical form
23846                  * */
23847                 numerator /= gcd;
23848                 denominator /= gcd;
23849
23850                 canonical = Perl_form(aTHX_ "%.*s%s%" UVuf "/%" UVuf,
23851                         equals_pos, lookup_name, sign, numerator, denominator);
23852             }
23853
23854             /* Here, we have the number in canonical form.  Try that */
23855             table_index = match_uniprop((U8 *) canonical, strlen(canonical));
23856             if (table_index == 0) {
23857                 goto failed;
23858             }
23859         }   /* End of still didn't find the property in our table */
23860     }       /* End of       didn't find the property in our table */
23861
23862     /* Here, we have a non-zero return, which is an index into a table of ptrs.
23863      * A negative return signifies that the real index is the absolute value,
23864      * but the result needs to be inverted */
23865     if (table_index < 0) {
23866         invert_return = TRUE;
23867         table_index = -table_index;
23868     }
23869
23870     /* Out-of band indices indicate a deprecated property.  The proper index is
23871      * modulo it with the table size.  And dividing by the table size yields
23872      * an offset into a table constructed by regen/mk_invlists.pl to contain
23873      * the corresponding warning message */
23874     if (table_index > MAX_UNI_KEYWORD_INDEX) {
23875         Size_t warning_offset = table_index / MAX_UNI_KEYWORD_INDEX;
23876         table_index %= MAX_UNI_KEYWORD_INDEX;
23877         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
23878                 "Use of '%.*s' in \\p{} or \\P{} is deprecated because: %s",
23879                 (int) name_len, name, deprecated_property_msgs[warning_offset]);
23880     }
23881
23882     /* In a few properties, a different property is used under /i.  These are
23883      * unlikely to change, so are hard-coded here. */
23884     if (to_fold) {
23885         if (   table_index == UNI_XPOSIXUPPER
23886             || table_index == UNI_XPOSIXLOWER
23887             || table_index == UNI_TITLE)
23888         {
23889             table_index = UNI_CASED;
23890         }
23891         else if (   table_index == UNI_UPPERCASELETTER
23892                  || table_index == UNI_LOWERCASELETTER
23893 #  ifdef UNI_TITLECASELETTER   /* Missing from early Unicodes */
23894                  || table_index == UNI_TITLECASELETTER
23895 #  endif
23896         ) {
23897             table_index = UNI_CASEDLETTER;
23898         }
23899         else if (  table_index == UNI_POSIXUPPER
23900                 || table_index == UNI_POSIXLOWER)
23901         {
23902             table_index = UNI_POSIXALPHA;
23903         }
23904     }
23905
23906     /* Create and return the inversion list */
23907     prop_definition =_new_invlist_C_array(uni_prop_ptrs[table_index]);
23908     sv_2mortal(prop_definition);
23909
23910
23911     /* See if there is a private use override to add to this definition */
23912     {
23913         COPHH * hinthash = (IN_PERL_COMPILETIME)
23914                            ? CopHINTHASH_get(&PL_compiling)
23915                            : CopHINTHASH_get(PL_curcop);
23916         SV * pu_overrides = cophh_fetch_pv(hinthash, "private_use", 0, 0);
23917
23918         if (UNLIKELY(pu_overrides && SvPOK(pu_overrides))) {
23919
23920             /* See if there is an element in the hints hash for this table */
23921             SV * pu_lookup = Perl_newSVpvf(aTHX_ "%d=", table_index);
23922             const char * pos = strstr(SvPVX(pu_overrides), SvPVX(pu_lookup));
23923
23924             if (pos) {
23925                 bool dummy;
23926                 SV * pu_definition;
23927                 SV * pu_invlist;
23928                 SV * expanded_prop_definition =
23929                             sv_2mortal(invlist_clone(prop_definition, NULL));
23930
23931                 /* If so, it's definition is the string from here to the next
23932                  * \a character.  And its format is the same as a user-defined
23933                  * property */
23934                 pos += SvCUR(pu_lookup);
23935                 pu_definition = newSVpvn(pos, strchr(pos, '\a') - pos);
23936                 pu_invlist = handle_user_defined_property(lookup_name,
23937                                                           lookup_len,
23938                                                           0, /* Not UTF-8 */
23939                                                           0, /* Not folded */
23940                                                           runtime,
23941                                                           deferrable,
23942                                                           pu_definition,
23943                                                           &dummy,
23944                                                           msg,
23945                                                           level);
23946                 if (TAINT_get) {
23947                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23948                     sv_catpvs(msg, "Insecure private-use override");
23949                     goto append_name_to_msg;
23950                 }
23951
23952                 /* For now, as a safety measure, make sure that it doesn't
23953                  * override non-private use code points */
23954                 _invlist_intersection(pu_invlist, PL_Private_Use, &pu_invlist);
23955
23956                 /* Add it to the list to be returned */
23957                 _invlist_union(prop_definition, pu_invlist,
23958                                &expanded_prop_definition);
23959                 prop_definition = expanded_prop_definition;
23960                 Perl_ck_warner_d(aTHX_ packWARN(WARN_EXPERIMENTAL__PRIVATE_USE), "The private_use feature is experimental");
23961             }
23962         }
23963     }
23964
23965     if (invert_return) {
23966         _invlist_invert(prop_definition);
23967     }
23968     return prop_definition;
23969
23970
23971   failed:
23972     if (non_pkg_begin != 0) {
23973         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23974         sv_catpvs(msg, "Illegal user-defined property name");
23975     }
23976     else {
23977         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23978         sv_catpvs(msg, "Can't find Unicode property definition");
23979     }
23980     /* FALLTHROUGH */
23981
23982   append_name_to_msg:
23983     {
23984         const char * prefix = (runtime && level == 0) ?  " \\p{" : " \"";
23985         const char * suffix = (runtime && level == 0) ?  "}" : "\"";
23986
23987         sv_catpv(msg, prefix);
23988         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
23989         sv_catpv(msg, suffix);
23990     }
23991
23992     return NULL;
23993
23994   definition_deferred:
23995
23996     /* Here it could yet to be defined, so defer evaluation of this
23997      * until its needed at runtime.  We need the fully qualified property name
23998      * to avoid ambiguity, and a trailing newline */
23999     if (! fq_name) {
24000         fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
24001                                       non_pkg_begin != 0 /* If has "::" */
24002                                );
24003     }
24004     sv_catpvs(fq_name, "\n");
24005
24006     *user_defined_ptr = TRUE;
24007     return fq_name;
24008 }
24009
24010 #endif
24011
24012 /*
24013  * ex: set ts=8 sts=4 sw=4 et:
24014  */