This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
parts/apicheck.pl: Ignore some hard-to-handle functions
[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                         STR_LEN(convert)=0;
3555                     }
3556                     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) \
3998         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags), NULL, depth+1)
3999
4000 STATIC U32
4001 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
4002                    UV *min_subtract, bool *unfolded_multi_char,
4003                    U32 flags, regnode *val, U32 depth)
4004 {
4005     /* Merge several consecutive EXACTish nodes into one. */
4006
4007     regnode *n = regnext(scan);
4008     U32 stringok = 1;
4009     regnode *next = scan + NODE_SZ_STR(scan);
4010     U32 merged = 0;
4011     U32 stopnow = 0;
4012 #ifdef DEBUGGING
4013     regnode *stop = scan;
4014     GET_RE_DEBUG_FLAGS_DECL;
4015 #else
4016     PERL_UNUSED_ARG(depth);
4017 #endif
4018
4019     PERL_ARGS_ASSERT_JOIN_EXACT;
4020 #ifndef EXPERIMENTAL_INPLACESCAN
4021     PERL_UNUSED_ARG(flags);
4022     PERL_UNUSED_ARG(val);
4023 #endif
4024     DEBUG_PEEP("join", scan, depth, 0);
4025
4026     assert(PL_regkind[OP(scan)] == EXACT);
4027
4028     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
4029      * EXACT ones that are mergeable to the current one. */
4030     while (    n
4031            && (    PL_regkind[OP(n)] == NOTHING
4032                || (stringok && PL_regkind[OP(n)] == EXACT))
4033            && NEXT_OFF(n)
4034            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
4035     {
4036
4037         if (OP(n) == TAIL || n > next)
4038             stringok = 0;
4039         if (PL_regkind[OP(n)] == NOTHING) {
4040             DEBUG_PEEP("skip:", n, depth, 0);
4041             NEXT_OFF(scan) += NEXT_OFF(n);
4042             next = n + NODE_STEP_REGNODE;
4043 #ifdef DEBUGGING
4044             if (stringok)
4045                 stop = n;
4046 #endif
4047             n = regnext(n);
4048         }
4049         else if (stringok) {
4050             const unsigned int oldl = STR_LEN(scan);
4051             regnode * const nnext = regnext(n);
4052
4053             /* XXX I (khw) kind of doubt that this works on platforms (should
4054              * Perl ever run on one) where U8_MAX is above 255 because of lots
4055              * of other assumptions */
4056             /* Don't join if the sum can't fit into a single node */
4057             if (oldl + STR_LEN(n) > U8_MAX)
4058                 break;
4059
4060             /* Joining something that requires UTF-8 with something that
4061              * doesn't, means the result requires UTF-8. */
4062             if (OP(scan) == EXACT && (OP(n) == EXACT_ONLY8)) {
4063                 OP(scan) = EXACT_ONLY8;
4064             }
4065             else if (OP(scan) == EXACT_ONLY8 && (OP(n) == EXACT)) {
4066                 ;   /* join is compatible, no need to change OP */
4067             }
4068             else if ((OP(scan) == EXACTFU) && (OP(n) == EXACTFU_ONLY8)) {
4069                 OP(scan) = EXACTFU_ONLY8;
4070             }
4071             else if ((OP(scan) == EXACTFU_ONLY8) && (OP(n) == EXACTFU)) {
4072                 ;   /* join is compatible, no need to change OP */
4073             }
4074             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU) {
4075                 ;   /* join is compatible, no need to change OP */
4076             }
4077             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU_S_EDGE) {
4078
4079                  /* Under /di, temporary EXACTFU_S_EDGE nodes are generated,
4080                   * which can join with EXACTFU ones.  We check for this case
4081                   * here.  These need to be resolved to either EXACTFU or
4082                   * EXACTF at joining time.  They have nothing in them that
4083                   * would forbid them from being the more desirable EXACTFU
4084                   * nodes except that they begin and/or end with a single [Ss].
4085                   * The reason this is problematic is because they could be
4086                   * joined in this loop with an adjacent node that ends and/or
4087                   * begins with [Ss] which would then form the sequence 'ss',
4088                   * which matches differently under /di than /ui, in which case
4089                   * EXACTFU can't be used.  If the 'ss' sequence doesn't get
4090                   * formed, the nodes get absorbed into any adjacent EXACTFU
4091                   * node.  And if the only adjacent node is EXACTF, they get
4092                   * absorbed into that, under the theory that a longer node is
4093                   * better than two shorter ones, even if one is EXACTFU.  Note
4094                   * that EXACTFU_ONLY8 is generated only for UTF-8 patterns,
4095                   * and the EXACTFU_S_EDGE ones only for non-UTF-8.  */
4096
4097                 if (STRING(n)[STR_LEN(n)-1] == 's') {
4098
4099                     /* Here the joined node would end with 's'.  If the node
4100                      * following the combination is an EXACTF one, it's better to
4101                      * join this trailing edge 's' node with that one, leaving the
4102                      * current one in 'scan' be the more desirable EXACTFU */
4103                     if (OP(nnext) == EXACTF) {
4104                         break;
4105                     }
4106
4107                     OP(scan) = EXACTFU_S_EDGE;
4108
4109                 }   /* Otherwise, the beginning 's' of the 2nd node just
4110                        becomes an interior 's' in 'scan' */
4111             }
4112             else if (OP(scan) == EXACTF && OP(n) == EXACTF) {
4113                 ;   /* join is compatible, no need to change OP */
4114             }
4115             else if (OP(scan) == EXACTF && OP(n) == EXACTFU_S_EDGE) {
4116
4117                 /* EXACTF nodes are compatible for joining with EXACTFU_S_EDGE
4118                  * nodes.  But the latter nodes can be also joined with EXACTFU
4119                  * ones, and that is a better outcome, so if the node following
4120                  * 'n' is EXACTFU, quit now so that those two can be joined
4121                  * later */
4122                 if (OP(nnext) == EXACTFU) {
4123                     break;
4124                 }
4125
4126                 /* The join is compatible, and the combined node will be
4127                  * EXACTF.  (These don't care if they begin or end with 's' */
4128             }
4129             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU_S_EDGE) {
4130                 if (   STRING(scan)[STR_LEN(scan)-1] == 's'
4131                     && STRING(n)[0] == 's')
4132                 {
4133                     /* When combined, we have the sequence 'ss', which means we
4134                      * have to remain /di */
4135                     OP(scan) = EXACTF;
4136                 }
4137             }
4138             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU) {
4139                 if (STRING(n)[0] == 's') {
4140                     ;   /* Here the join is compatible and the combined node
4141                            starts with 's', no need to change OP */
4142                 }
4143                 else {  /* Now the trailing 's' is in the interior */
4144                     OP(scan) = EXACTFU;
4145                 }
4146             }
4147             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTF) {
4148
4149                 /* The join is compatible, and the combined node will be
4150                  * EXACTF.  (These don't care if they begin or end with 's' */
4151                 OP(scan) = EXACTF;
4152             }
4153             else if (OP(scan) != OP(n)) {
4154
4155                 /* The only other compatible joinings are the same node type */
4156                 break;
4157             }
4158
4159             DEBUG_PEEP("merg", n, depth, 0);
4160             merged++;
4161
4162             NEXT_OFF(scan) += NEXT_OFF(n);
4163             STR_LEN(scan) += STR_LEN(n);
4164             next = n + NODE_SZ_STR(n);
4165             /* Now we can overwrite *n : */
4166             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
4167 #ifdef DEBUGGING
4168             stop = next - 1;
4169 #endif
4170             n = nnext;
4171             if (stopnow) break;
4172         }
4173
4174 #ifdef EXPERIMENTAL_INPLACESCAN
4175         if (flags && !NEXT_OFF(n)) {
4176             DEBUG_PEEP("atch", val, depth, 0);
4177             if (reg_off_by_arg[OP(n)]) {
4178                 ARG_SET(n, val - n);
4179             }
4180             else {
4181                 NEXT_OFF(n) = val - n;
4182             }
4183             stopnow = 1;
4184         }
4185 #endif
4186     }
4187
4188     /* This temporary node can now be turned into EXACTFU, and must, as
4189      * regexec.c doesn't handle it */
4190     if (OP(scan) == EXACTFU_S_EDGE) {
4191         OP(scan) = EXACTFU;
4192     }
4193
4194     *min_subtract = 0;
4195     *unfolded_multi_char = FALSE;
4196
4197     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
4198      * can now analyze for sequences of problematic code points.  (Prior to
4199      * this final joining, sequences could have been split over boundaries, and
4200      * hence missed).  The sequences only happen in folding, hence for any
4201      * non-EXACT EXACTish node */
4202     if (OP(scan) != EXACT && OP(scan) != EXACT_ONLY8 && OP(scan) != EXACTL) {
4203         U8* s0 = (U8*) STRING(scan);
4204         U8* s = s0;
4205         U8* s_end = s0 + STR_LEN(scan);
4206
4207         int total_count_delta = 0;  /* Total delta number of characters that
4208                                        multi-char folds expand to */
4209
4210         /* One pass is made over the node's string looking for all the
4211          * possibilities.  To avoid some tests in the loop, there are two main
4212          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
4213          * non-UTF-8 */
4214         if (UTF) {
4215             U8* folded = NULL;
4216
4217             if (OP(scan) == EXACTFL) {
4218                 U8 *d;
4219
4220                 /* An EXACTFL node would already have been changed to another
4221                  * node type unless there is at least one character in it that
4222                  * is problematic; likely a character whose fold definition
4223                  * won't be known until runtime, and so has yet to be folded.
4224                  * For all but the UTF-8 locale, folds are 1-1 in length, but
4225                  * to handle the UTF-8 case, we need to create a temporary
4226                  * folded copy using UTF-8 locale rules in order to analyze it.
4227                  * This is because our macros that look to see if a sequence is
4228                  * a multi-char fold assume everything is folded (otherwise the
4229                  * tests in those macros would be too complicated and slow).
4230                  * Note that here, the non-problematic folds will have already
4231                  * been done, so we can just copy such characters.  We actually
4232                  * don't completely fold the EXACTFL string.  We skip the
4233                  * unfolded multi-char folds, as that would just create work
4234                  * below to figure out the size they already are */
4235
4236                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
4237                 d = folded;
4238                 while (s < s_end) {
4239                     STRLEN s_len = UTF8SKIP(s);
4240                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
4241                         Copy(s, d, s_len, U8);
4242                         d += s_len;
4243                     }
4244                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
4245                         *unfolded_multi_char = TRUE;
4246                         Copy(s, d, s_len, U8);
4247                         d += s_len;
4248                     }
4249                     else if (isASCII(*s)) {
4250                         *(d++) = toFOLD(*s);
4251                     }
4252                     else {
4253                         STRLEN len;
4254                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
4255                         d += len;
4256                     }
4257                     s += s_len;
4258                 }
4259
4260                 /* Point the remainder of the routine to look at our temporary
4261                  * folded copy */
4262                 s = folded;
4263                 s_end = d;
4264             } /* End of creating folded copy of EXACTFL string */
4265
4266             /* Examine the string for a multi-character fold sequence.  UTF-8
4267              * patterns have all characters pre-folded by the time this code is
4268              * executed */
4269             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
4270                                      length sequence we are looking for is 2 */
4271             {
4272                 int count = 0;  /* How many characters in a multi-char fold */
4273                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
4274                 if (! len) {    /* Not a multi-char fold: get next char */
4275                     s += UTF8SKIP(s);
4276                     continue;
4277                 }
4278
4279                 { /* Here is a generic multi-char fold. */
4280                     U8* multi_end  = s + len;
4281
4282                     /* Count how many characters are in it.  In the case of
4283                      * /aa, no folds which contain ASCII code points are
4284                      * allowed, so check for those, and skip if found. */
4285                     if (OP(scan) != EXACTFAA && OP(scan) != EXACTFAA_NO_TRIE) {
4286                         count = utf8_length(s, multi_end);
4287                         s = multi_end;
4288                     }
4289                     else {
4290                         while (s < multi_end) {
4291                             if (isASCII(*s)) {
4292                                 s++;
4293                                 goto next_iteration;
4294                             }
4295                             else {
4296                                 s += UTF8SKIP(s);
4297                             }
4298                             count++;
4299                         }
4300                     }
4301                 }
4302
4303                 /* The delta is how long the sequence is minus 1 (1 is how long
4304                  * the character that folds to the sequence is) */
4305                 total_count_delta += count - 1;
4306               next_iteration: ;
4307             }
4308
4309             /* We created a temporary folded copy of the string in EXACTFL
4310              * nodes.  Therefore we need to be sure it doesn't go below zero,
4311              * as the real string could be shorter */
4312             if (OP(scan) == EXACTFL) {
4313                 int total_chars = utf8_length((U8*) STRING(scan),
4314                                            (U8*) STRING(scan) + STR_LEN(scan));
4315                 if (total_count_delta > total_chars) {
4316                     total_count_delta = total_chars;
4317                 }
4318             }
4319
4320             *min_subtract += total_count_delta;
4321             Safefree(folded);
4322         }
4323         else if (OP(scan) == EXACTFAA) {
4324
4325             /* Non-UTF-8 pattern, EXACTFAA node.  There can't be a multi-char
4326              * fold to the ASCII range (and there are no existing ones in the
4327              * upper latin1 range).  But, as outlined in the comments preceding
4328              * this function, we need to flag any occurrences of the sharp s.
4329              * This character forbids trie formation (because of added
4330              * complexity) */
4331 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
4332    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
4333                                       || UNICODE_DOT_DOT_VERSION > 0)
4334             while (s < s_end) {
4335                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
4336                     OP(scan) = EXACTFAA_NO_TRIE;
4337                     *unfolded_multi_char = TRUE;
4338                     break;
4339                 }
4340                 s++;
4341             }
4342         }
4343         else {
4344
4345             /* Non-UTF-8 pattern, not EXACTFAA node.  Look for the multi-char
4346              * folds that are all Latin1.  As explained in the comments
4347              * preceding this function, we look also for the sharp s in EXACTF
4348              * and EXACTFL nodes; it can be in the final position.  Otherwise
4349              * we can stop looking 1 byte earlier because have to find at least
4350              * two characters for a multi-fold */
4351             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
4352                               ? s_end
4353                               : s_end -1;
4354
4355             while (s < upper) {
4356                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
4357                 if (! len) {    /* Not a multi-char fold. */
4358                     if (*s == LATIN_SMALL_LETTER_SHARP_S
4359                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
4360                     {
4361                         *unfolded_multi_char = TRUE;
4362                     }
4363                     s++;
4364                     continue;
4365                 }
4366
4367                 if (len == 2
4368                     && isALPHA_FOLD_EQ(*s, 's')
4369                     && isALPHA_FOLD_EQ(*(s+1), 's'))
4370                 {
4371
4372                     /* EXACTF nodes need to know that the minimum length
4373                      * changed so that a sharp s in the string can match this
4374                      * ss in the pattern, but they remain EXACTF nodes, as they
4375                      * won't match this unless the target string is is UTF-8,
4376                      * which we don't know until runtime.  EXACTFL nodes can't
4377                      * transform into EXACTFU nodes */
4378                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
4379                         OP(scan) = EXACTFUP;
4380                     }
4381                 }
4382
4383                 *min_subtract += len - 1;
4384                 s += len;
4385             }
4386 #endif
4387         }
4388
4389         if (     STR_LEN(scan) == 1
4390             &&   isALPHA_A(* STRING(scan))
4391             &&  (         OP(scan) == EXACTFAA
4392                  || (     OP(scan) == EXACTFU
4393                      && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(* STRING(scan)))))
4394         {
4395             U8 mask = ~ ('A' ^ 'a'); /* These differ in just one bit */
4396
4397             /* Replace a length 1 ASCII fold pair node with an ANYOFM node,
4398              * with the mask set to the complement of the bit that differs
4399              * between upper and lower case, and the lowest code point of the
4400              * pair (which the '&' forces) */
4401             OP(scan) = ANYOFM;
4402             ARG_SET(scan, *STRING(scan) & mask);
4403             FLAGS(scan) = mask;
4404         }
4405     }
4406
4407 #ifdef DEBUGGING
4408     /* Allow dumping but overwriting the collection of skipped
4409      * ops and/or strings with fake optimized ops */
4410     n = scan + NODE_SZ_STR(scan);
4411     while (n <= stop) {
4412         OP(n) = OPTIMIZED;
4413         FLAGS(n) = 0;
4414         NEXT_OFF(n) = 0;
4415         n++;
4416     }
4417 #endif
4418     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl", scan, depth, 0);});
4419     return stopnow;
4420 }
4421
4422 /* REx optimizer.  Converts nodes into quicker variants "in place".
4423    Finds fixed substrings.  */
4424
4425 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
4426    to the position after last scanned or to NULL. */
4427
4428 #define INIT_AND_WITHP \
4429     assert(!and_withp); \
4430     Newx(and_withp, 1, regnode_ssc); \
4431     SAVEFREEPV(and_withp)
4432
4433
4434 static void
4435 S_unwind_scan_frames(pTHX_ const void *p)
4436 {
4437     scan_frame *f= (scan_frame *)p;
4438     do {
4439         scan_frame *n= f->next_frame;
4440         Safefree(f);
4441         f= n;
4442     } while (f);
4443 }
4444
4445 /* the return from this sub is the minimum length that could possibly match */
4446 STATIC SSize_t
4447 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
4448                         SSize_t *minlenp, SSize_t *deltap,
4449                         regnode *last,
4450                         scan_data_t *data,
4451                         I32 stopparen,
4452                         U32 recursed_depth,
4453                         regnode_ssc *and_withp,
4454                         U32 flags, U32 depth)
4455                         /* scanp: Start here (read-write). */
4456                         /* deltap: Write maxlen-minlen here. */
4457                         /* last: Stop before this one. */
4458                         /* data: string data about the pattern */
4459                         /* stopparen: treat close N as END */
4460                         /* recursed: which subroutines have we recursed into */
4461                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
4462 {
4463     dVAR;
4464     /* There must be at least this number of characters to match */
4465     SSize_t min = 0;
4466     I32 pars = 0, code;
4467     regnode *scan = *scanp, *next;
4468     SSize_t delta = 0;
4469     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
4470     int is_inf_internal = 0;            /* The studied chunk is infinite */
4471     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
4472     scan_data_t data_fake;
4473     SV *re_trie_maxbuff = NULL;
4474     regnode *first_non_open = scan;
4475     SSize_t stopmin = SSize_t_MAX;
4476     scan_frame *frame = NULL;
4477     GET_RE_DEBUG_FLAGS_DECL;
4478
4479     PERL_ARGS_ASSERT_STUDY_CHUNK;
4480     RExC_study_started= 1;
4481
4482     Zero(&data_fake, 1, scan_data_t);
4483
4484     if ( depth == 0 ) {
4485         while (first_non_open && OP(first_non_open) == OPEN)
4486             first_non_open=regnext(first_non_open);
4487     }
4488
4489
4490   fake_study_recurse:
4491     DEBUG_r(
4492         RExC_study_chunk_recursed_count++;
4493     );
4494     DEBUG_OPTIMISE_MORE_r(
4495     {
4496         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4497             depth, (long)stopparen,
4498             (unsigned long)RExC_study_chunk_recursed_count,
4499             (unsigned long)depth, (unsigned long)recursed_depth,
4500             scan,
4501             last);
4502         if (recursed_depth) {
4503             U32 i;
4504             U32 j;
4505             for ( j = 0 ; j < recursed_depth ; j++ ) {
4506                 for ( i = 0 ; i < (U32)RExC_total_parens ; i++ ) {
4507                     if (
4508                         PAREN_TEST(RExC_study_chunk_recursed +
4509                                    ( j * RExC_study_chunk_recursed_bytes), i )
4510                         && (
4511                             !j ||
4512                             !PAREN_TEST(RExC_study_chunk_recursed +
4513                                    (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
4514                         )
4515                     ) {
4516                         Perl_re_printf( aTHX_ " %d",(int)i);
4517                         break;
4518                     }
4519                 }
4520                 if ( j + 1 < recursed_depth ) {
4521                     Perl_re_printf( aTHX_  ",");
4522                 }
4523             }
4524         }
4525         Perl_re_printf( aTHX_ "\n");
4526     }
4527     );
4528     while ( scan && OP(scan) != END && scan < last ){
4529         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4530                                    node length to get a real minimum (because
4531                                    the folded version may be shorter) */
4532         bool unfolded_multi_char = FALSE;
4533         /* Peephole optimizer: */
4534         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4535         DEBUG_PEEP("Peep", scan, depth, flags);
4536
4537
4538         /* The reason we do this here is that we need to deal with things like
4539          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4540          * parsing code, as each (?:..) is handled by a different invocation of
4541          * reg() -- Yves
4542          */
4543         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
4544
4545         /* Follow the next-chain of the current node and optimize
4546            away all the NOTHINGs from it.  */
4547         if (OP(scan) != CURLYX) {
4548             const int max = (reg_off_by_arg[OP(scan)]
4549                        ? I32_MAX
4550                        /* I32 may be smaller than U16 on CRAYs! */
4551                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4552             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
4553             int noff;
4554             regnode *n = scan;
4555
4556             /* Skip NOTHING and LONGJMP. */
4557             while ((n = regnext(n))
4558                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4559                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
4560                    && off + noff < max)
4561                 off += noff;
4562             if (reg_off_by_arg[OP(scan)])
4563                 ARG(scan) = off;
4564             else
4565                 NEXT_OFF(scan) = off;
4566         }
4567
4568         /* The principal pseudo-switch.  Cannot be a switch, since we
4569            look into several different things.  */
4570         if ( OP(scan) == DEFINEP ) {
4571             SSize_t minlen = 0;
4572             SSize_t deltanext = 0;
4573             SSize_t fake_last_close = 0;
4574             I32 f = SCF_IN_DEFINE;
4575
4576             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4577             scan = regnext(scan);
4578             assert( OP(scan) == IFTHEN );
4579             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4580
4581             data_fake.last_closep= &fake_last_close;
4582             minlen = *minlenp;
4583             next = regnext(scan);
4584             scan = NEXTOPER(NEXTOPER(scan));
4585             DEBUG_PEEP("scan", scan, depth, flags);
4586             DEBUG_PEEP("next", next, depth, flags);
4587
4588             /* we suppose the run is continuous, last=next...
4589              * NOTE we dont use the return here! */
4590             /* DEFINEP study_chunk() recursion */
4591             (void)study_chunk(pRExC_state, &scan, &minlen,
4592                               &deltanext, next, &data_fake, stopparen,
4593                               recursed_depth, NULL, f, depth+1);
4594
4595             scan = next;
4596         } else
4597         if (
4598             OP(scan) == BRANCH  ||
4599             OP(scan) == BRANCHJ ||
4600             OP(scan) == IFTHEN
4601         ) {
4602             next = regnext(scan);
4603             code = OP(scan);
4604
4605             /* The op(next)==code check below is to see if we
4606              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4607              * IFTHEN is special as it might not appear in pairs.
4608              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4609              * we dont handle it cleanly. */
4610             if (OP(next) == code || code == IFTHEN) {
4611                 /* NOTE - There is similar code to this block below for
4612                  * handling TRIE nodes on a re-study.  If you change stuff here
4613                  * check there too. */
4614                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
4615                 regnode_ssc accum;
4616                 regnode * const startbranch=scan;
4617
4618                 if (flags & SCF_DO_SUBSTR) {
4619                     /* Cannot merge strings after this. */
4620                     scan_commit(pRExC_state, data, minlenp, is_inf);
4621                 }
4622
4623                 if (flags & SCF_DO_STCLASS)
4624                     ssc_init_zero(pRExC_state, &accum);
4625
4626                 while (OP(scan) == code) {
4627                     SSize_t deltanext, minnext, fake;
4628                     I32 f = 0;
4629                     regnode_ssc this_class;
4630
4631                     DEBUG_PEEP("Branch", scan, depth, flags);
4632
4633                     num++;
4634                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4635                     if (data) {
4636                         data_fake.whilem_c = data->whilem_c;
4637                         data_fake.last_closep = data->last_closep;
4638                     }
4639                     else
4640                         data_fake.last_closep = &fake;
4641
4642                     data_fake.pos_delta = delta;
4643                     next = regnext(scan);
4644
4645                     scan = NEXTOPER(scan); /* everything */
4646                     if (code != BRANCH)    /* everything but BRANCH */
4647                         scan = NEXTOPER(scan);
4648
4649                     if (flags & SCF_DO_STCLASS) {
4650                         ssc_init(pRExC_state, &this_class);
4651                         data_fake.start_class = &this_class;
4652                         f = SCF_DO_STCLASS_AND;
4653                     }
4654                     if (flags & SCF_WHILEM_VISITED_POS)
4655                         f |= SCF_WHILEM_VISITED_POS;
4656
4657                     /* we suppose the run is continuous, last=next...*/
4658                     /* recurse study_chunk() for each BRANCH in an alternation */
4659                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4660                                       &deltanext, next, &data_fake, stopparen,
4661                                       recursed_depth, NULL, f, depth+1);
4662
4663                     if (min1 > minnext)
4664                         min1 = minnext;
4665                     if (deltanext == SSize_t_MAX) {
4666                         is_inf = is_inf_internal = 1;
4667                         max1 = SSize_t_MAX;
4668                     } else if (max1 < minnext + deltanext)
4669                         max1 = minnext + deltanext;
4670                     scan = next;
4671                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4672                         pars++;
4673                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4674                         if ( stopmin > minnext)
4675                             stopmin = min + min1;
4676                         flags &= ~SCF_DO_SUBSTR;
4677                         if (data)
4678                             data->flags |= SCF_SEEN_ACCEPT;
4679                     }
4680                     if (data) {
4681                         if (data_fake.flags & SF_HAS_EVAL)
4682                             data->flags |= SF_HAS_EVAL;
4683                         data->whilem_c = data_fake.whilem_c;
4684                     }
4685                     if (flags & SCF_DO_STCLASS)
4686                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4687                 }
4688                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4689                     min1 = 0;
4690                 if (flags & SCF_DO_SUBSTR) {
4691                     data->pos_min += min1;
4692                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
4693                         data->pos_delta = SSize_t_MAX;
4694                     else
4695                         data->pos_delta += max1 - min1;
4696                     if (max1 != min1 || is_inf)
4697                         data->cur_is_floating = 1;
4698                 }
4699                 min += min1;
4700                 if (delta == SSize_t_MAX
4701                  || SSize_t_MAX - delta - (max1 - min1) < 0)
4702                     delta = SSize_t_MAX;
4703                 else
4704                     delta += max1 - min1;
4705                 if (flags & SCF_DO_STCLASS_OR) {
4706                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4707                     if (min1) {
4708                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4709                         flags &= ~SCF_DO_STCLASS;
4710                     }
4711                 }
4712                 else if (flags & SCF_DO_STCLASS_AND) {
4713                     if (min1) {
4714                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4715                         flags &= ~SCF_DO_STCLASS;
4716                     }
4717                     else {
4718                         /* Switch to OR mode: cache the old value of
4719                          * data->start_class */
4720                         INIT_AND_WITHP;
4721                         StructCopy(data->start_class, and_withp, regnode_ssc);
4722                         flags &= ~SCF_DO_STCLASS_AND;
4723                         StructCopy(&accum, data->start_class, regnode_ssc);
4724                         flags |= SCF_DO_STCLASS_OR;
4725                     }
4726                 }
4727
4728                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
4729                         OP( startbranch ) == BRANCH )
4730                 {
4731                 /* demq.
4732
4733                    Assuming this was/is a branch we are dealing with: 'scan'
4734                    now points at the item that follows the branch sequence,
4735                    whatever it is. We now start at the beginning of the
4736                    sequence and look for subsequences of
4737
4738                    BRANCH->EXACT=>x1
4739                    BRANCH->EXACT=>x2
4740                    tail
4741
4742                    which would be constructed from a pattern like
4743                    /A|LIST|OF|WORDS/
4744
4745                    If we can find such a subsequence we need to turn the first
4746                    element into a trie and then add the subsequent branch exact
4747                    strings to the trie.
4748
4749                    We have two cases
4750
4751                      1. patterns where the whole set of branches can be
4752                         converted.
4753
4754                      2. patterns where only a subset can be converted.
4755
4756                    In case 1 we can replace the whole set with a single regop
4757                    for the trie. In case 2 we need to keep the start and end
4758                    branches so
4759
4760                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4761                      becomes BRANCH TRIE; BRANCH X;
4762
4763                   There is an additional case, that being where there is a
4764                   common prefix, which gets split out into an EXACT like node
4765                   preceding the TRIE node.
4766
4767                   If x(1..n)==tail then we can do a simple trie, if not we make
4768                   a "jump" trie, such that when we match the appropriate word
4769                   we "jump" to the appropriate tail node. Essentially we turn
4770                   a nested if into a case structure of sorts.
4771
4772                 */
4773
4774                     int made=0;
4775                     if (!re_trie_maxbuff) {
4776                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4777                         if (!SvIOK(re_trie_maxbuff))
4778                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4779                     }
4780                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4781                         regnode *cur;
4782                         regnode *first = (regnode *)NULL;
4783                         regnode *last = (regnode *)NULL;
4784                         regnode *tail = scan;
4785                         U8 trietype = 0;
4786                         U32 count=0;
4787
4788                         /* var tail is used because there may be a TAIL
4789                            regop in the way. Ie, the exacts will point to the
4790                            thing following the TAIL, but the last branch will
4791                            point at the TAIL. So we advance tail. If we
4792                            have nested (?:) we may have to move through several
4793                            tails.
4794                          */
4795
4796                         while ( OP( tail ) == TAIL ) {
4797                             /* this is the TAIL generated by (?:) */
4798                             tail = regnext( tail );
4799                         }
4800
4801
4802                         DEBUG_TRIE_COMPILE_r({
4803                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4804                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4805                               depth+1,
4806                               "Looking for TRIE'able sequences. Tail node is ",
4807                               (UV) REGNODE_OFFSET(tail),
4808                               SvPV_nolen_const( RExC_mysv )
4809                             );
4810                         });
4811
4812                         /*
4813
4814                             Step through the branches
4815                                 cur represents each branch,
4816                                 noper is the first thing to be matched as part
4817                                       of that branch
4818                                 noper_next is the regnext() of that node.
4819
4820                             We normally handle a case like this
4821                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4822                             support building with NOJUMPTRIE, which restricts
4823                             the trie logic to structures like /FOO|BAR/.
4824
4825                             If noper is a trieable nodetype then the branch is
4826                             a possible optimization target. If we are building
4827                             under NOJUMPTRIE then we require that noper_next is
4828                             the same as scan (our current position in the regex
4829                             program).
4830
4831                             Once we have two or more consecutive such branches
4832                             we can create a trie of the EXACT's contents and
4833                             stitch it in place into the program.
4834
4835                             If the sequence represents all of the branches in
4836                             the alternation we replace the entire thing with a
4837                             single TRIE node.
4838
4839                             Otherwise when it is a subsequence we need to
4840                             stitch it in place and replace only the relevant
4841                             branches. This means the first branch has to remain
4842                             as it is used by the alternation logic, and its
4843                             next pointer, and needs to be repointed at the item
4844                             on the branch chain following the last branch we
4845                             have optimized away.
4846
4847                             This could be either a BRANCH, in which case the
4848                             subsequence is internal, or it could be the item
4849                             following the branch sequence in which case the
4850                             subsequence is at the end (which does not
4851                             necessarily mean the first node is the start of the
4852                             alternation).
4853
4854                             TRIE_TYPE(X) is a define which maps the optype to a
4855                             trietype.
4856
4857                                 optype          |  trietype
4858                                 ----------------+-----------
4859                                 NOTHING         | NOTHING
4860                                 EXACT           | EXACT
4861                                 EXACT_ONLY8     | EXACT
4862                                 EXACTFU         | EXACTFU
4863                                 EXACTFU_ONLY8   | EXACTFU
4864                                 EXACTFUP        | EXACTFU
4865                                 EXACTFAA        | EXACTFAA
4866                                 EXACTL          | EXACTL
4867                                 EXACTFLU8       | EXACTFLU8
4868
4869
4870                         */
4871 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4872                        ? NOTHING                                            \
4873                        : ( EXACT == (X) || EXACT_ONLY8 == (X) )             \
4874                          ? EXACT                                            \
4875                          : (     EXACTFU == (X)                             \
4876                               || EXACTFU_ONLY8 == (X)                       \
4877                               || EXACTFUP == (X) )                          \
4878                            ? EXACTFU                                        \
4879                            : ( EXACTFAA == (X) )                            \
4880                              ? EXACTFAA                                     \
4881                              : ( EXACTL == (X) )                            \
4882                                ? EXACTL                                     \
4883                                : ( EXACTFLU8 == (X) )                       \
4884                                  ? EXACTFLU8                                \
4885                                  : 0 )
4886
4887                         /* dont use tail as the end marker for this traverse */
4888                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4889                             regnode * const noper = NEXTOPER( cur );
4890                             U8 noper_type = OP( noper );
4891                             U8 noper_trietype = TRIE_TYPE( noper_type );
4892 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4893                             regnode * const noper_next = regnext( noper );
4894                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4895                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4896 #endif
4897
4898                             DEBUG_TRIE_COMPILE_r({
4899                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4900                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4901                                    depth+1,
4902                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4903
4904                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4905                                 Perl_re_printf( aTHX_  " -> %d:%s",
4906                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
4907
4908                                 if ( noper_next ) {
4909                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4910                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
4911                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
4912                                 }
4913                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
4914                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4915                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4916                                 );
4917                             });
4918
4919                             /* Is noper a trieable nodetype that can be merged
4920                              * with the current trie (if there is one)? */
4921                             if ( noper_trietype
4922                                   &&
4923                                   (
4924                                         ( noper_trietype == NOTHING )
4925                                         || ( trietype == NOTHING )
4926                                         || ( trietype == noper_trietype )
4927                                   )
4928 #ifdef NOJUMPTRIE
4929                                   && noper_next >= tail
4930 #endif
4931                                   && count < U16_MAX)
4932                             {
4933                                 /* Handle mergable triable node Either we are
4934                                  * the first node in a new trieable sequence,
4935                                  * in which case we do some bookkeeping,
4936                                  * otherwise we update the end pointer. */
4937                                 if ( !first ) {
4938                                     first = cur;
4939                                     if ( noper_trietype == NOTHING ) {
4940 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4941                                         regnode * const noper_next = regnext( noper );
4942                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4943                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4944 #endif
4945
4946                                         if ( noper_next_trietype ) {
4947                                             trietype = noper_next_trietype;
4948                                         } else if (noper_next_type)  {
4949                                             /* a NOTHING regop is 1 regop wide.
4950                                              * We need at least two for a trie
4951                                              * so we can't merge this in */
4952                                             first = NULL;
4953                                         }
4954                                     } else {
4955                                         trietype = noper_trietype;
4956                                     }
4957                                 } else {
4958                                     if ( trietype == NOTHING )
4959                                         trietype = noper_trietype;
4960                                     last = cur;
4961                                 }
4962                                 if (first)
4963                                     count++;
4964                             } /* end handle mergable triable node */
4965                             else {
4966                                 /* handle unmergable node -
4967                                  * noper may either be a triable node which can
4968                                  * not be tried together with the current trie,
4969                                  * or a non triable node */
4970                                 if ( last ) {
4971                                     /* If last is set and trietype is not
4972                                      * NOTHING then we have found at least two
4973                                      * triable branch sequences in a row of a
4974                                      * similar trietype so we can turn them
4975                                      * into a trie. If/when we allow NOTHING to
4976                                      * start a trie sequence this condition
4977                                      * will be required, and it isn't expensive
4978                                      * so we leave it in for now. */
4979                                     if ( trietype && trietype != NOTHING )
4980                                         make_trie( pRExC_state,
4981                                                 startbranch, first, cur, tail,
4982                                                 count, trietype, depth+1 );
4983                                     last = NULL; /* note: we clear/update
4984                                                     first, trietype etc below,
4985                                                     so we dont do it here */
4986                                 }
4987                                 if ( noper_trietype
4988 #ifdef NOJUMPTRIE
4989                                      && noper_next >= tail
4990 #endif
4991                                 ){
4992                                     /* noper is triable, so we can start a new
4993                                      * trie sequence */
4994                                     count = 1;
4995                                     first = cur;
4996                                     trietype = noper_trietype;
4997                                 } else if (first) {
4998                                     /* if we already saw a first but the
4999                                      * current node is not triable then we have
5000                                      * to reset the first information. */
5001                                     count = 0;
5002                                     first = NULL;
5003                                     trietype = 0;
5004                                 }
5005                             } /* end handle unmergable node */
5006                         } /* loop over branches */
5007                         DEBUG_TRIE_COMPILE_r({
5008                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5009                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
5010                               depth+1, SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5011                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
5012                                REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
5013                                PL_reg_name[trietype]
5014                             );
5015
5016                         });
5017                         if ( last && trietype ) {
5018                             if ( trietype != NOTHING ) {
5019                                 /* the last branch of the sequence was part of
5020                                  * a trie, so we have to construct it here
5021                                  * outside of the loop */
5022                                 made= make_trie( pRExC_state, startbranch,
5023                                                  first, scan, tail, count,
5024                                                  trietype, depth+1 );
5025 #ifdef TRIE_STUDY_OPT
5026                                 if ( ((made == MADE_EXACT_TRIE &&
5027                                      startbranch == first)
5028                                      || ( first_non_open == first )) &&
5029                                      depth==0 ) {
5030                                     flags |= SCF_TRIE_RESTUDY;
5031                                     if ( startbranch == first
5032                                          && scan >= tail )
5033                                     {
5034                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
5035                                     }
5036                                 }
5037 #endif
5038                             } else {
5039                                 /* at this point we know whatever we have is a
5040                                  * NOTHING sequence/branch AND if 'startbranch'
5041                                  * is 'first' then we can turn the whole thing
5042                                  * into a NOTHING
5043                                  */
5044                                 if ( startbranch == first ) {
5045                                     regnode *opt;
5046                                     /* the entire thing is a NOTHING sequence,
5047                                      * something like this: (?:|) So we can
5048                                      * turn it into a plain NOTHING op. */
5049                                     DEBUG_TRIE_COMPILE_r({
5050                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5051                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
5052                                           depth+1,
5053                                           SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5054
5055                                     });
5056                                     OP(startbranch)= NOTHING;
5057                                     NEXT_OFF(startbranch)= tail - startbranch;
5058                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
5059                                         OP(opt)= OPTIMIZED;
5060                                 }
5061                             }
5062                         } /* end if ( last) */
5063                     } /* TRIE_MAXBUF is non zero */
5064
5065                 } /* do trie */
5066
5067             }
5068             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
5069                 scan = NEXTOPER(NEXTOPER(scan));
5070             } else                      /* single branch is optimized. */
5071                 scan = NEXTOPER(scan);
5072             continue;
5073         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
5074             I32 paren = 0;
5075             regnode *start = NULL;
5076             regnode *end = NULL;
5077             U32 my_recursed_depth= recursed_depth;
5078
5079             if (OP(scan) != SUSPEND) { /* GOSUB */
5080                 /* Do setup, note this code has side effects beyond
5081                  * the rest of this block. Specifically setting
5082                  * RExC_recurse[] must happen at least once during
5083                  * study_chunk(). */
5084                 paren = ARG(scan);
5085                 RExC_recurse[ARG2L(scan)] = scan;
5086                 start = REGNODE_p(RExC_open_parens[paren]);
5087                 end   = REGNODE_p(RExC_close_parens[paren]);
5088
5089                 /* NOTE we MUST always execute the above code, even
5090                  * if we do nothing with a GOSUB */
5091                 if (
5092                     ( flags & SCF_IN_DEFINE )
5093                     ||
5094                     (
5095                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
5096                         &&
5097                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
5098                     )
5099                 ) {
5100                     /* no need to do anything here if we are in a define. */
5101                     /* or we are after some kind of infinite construct
5102                      * so we can skip recursing into this item.
5103                      * Since it is infinite we will not change the maxlen
5104                      * or delta, and if we miss something that might raise
5105                      * the minlen it will merely pessimise a little.
5106                      *
5107                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
5108                      * might result in a minlen of 1 and not of 4,
5109                      * but this doesn't make us mismatch, just try a bit
5110                      * harder than we should.
5111                      * */
5112                     scan= regnext(scan);
5113                     continue;
5114                 }
5115
5116                 if (
5117                     !recursed_depth
5118                     ||
5119                     !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
5120                 ) {
5121                     /* it is quite possible that there are more efficient ways
5122                      * to do this. We maintain a bitmap per level of recursion
5123                      * of which patterns we have entered so we can detect if a
5124                      * pattern creates a possible infinite loop. When we
5125                      * recurse down a level we copy the previous levels bitmap
5126                      * down. When we are at recursion level 0 we zero the top
5127                      * level bitmap. It would be nice to implement a different
5128                      * more efficient way of doing this. In particular the top
5129                      * level bitmap may be unnecessary.
5130                      */
5131                     if (!recursed_depth) {
5132                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
5133                     } else {
5134                         Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
5135                              RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
5136                              RExC_study_chunk_recursed_bytes, U8);
5137                     }
5138                     /* we havent recursed into this paren yet, so recurse into it */
5139                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
5140                     PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
5141                     my_recursed_depth= recursed_depth + 1;
5142                 } else {
5143                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
5144                     /* some form of infinite recursion, assume infinite length
5145                      * */
5146                     if (flags & SCF_DO_SUBSTR) {
5147                         scan_commit(pRExC_state, data, minlenp, is_inf);
5148                         data->cur_is_floating = 1;
5149                     }
5150                     is_inf = is_inf_internal = 1;
5151                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5152                         ssc_anything(data->start_class);
5153                     flags &= ~SCF_DO_STCLASS;
5154
5155                     start= NULL; /* reset start so we dont recurse later on. */
5156                 }
5157             } else {
5158                 paren = stopparen;
5159                 start = scan + 2;
5160                 end = regnext(scan);
5161             }
5162             if (start) {
5163                 scan_frame *newframe;
5164                 assert(end);
5165                 if (!RExC_frame_last) {
5166                     Newxz(newframe, 1, scan_frame);
5167                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
5168                     RExC_frame_head= newframe;
5169                     RExC_frame_count++;
5170                 } else if (!RExC_frame_last->next_frame) {
5171                     Newxz(newframe, 1, scan_frame);
5172                     RExC_frame_last->next_frame= newframe;
5173                     newframe->prev_frame= RExC_frame_last;
5174                     RExC_frame_count++;
5175                 } else {
5176                     newframe= RExC_frame_last->next_frame;
5177                 }
5178                 RExC_frame_last= newframe;
5179
5180                 newframe->next_regnode = regnext(scan);
5181                 newframe->last_regnode = last;
5182                 newframe->stopparen = stopparen;
5183                 newframe->prev_recursed_depth = recursed_depth;
5184                 newframe->this_prev_frame= frame;
5185
5186                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
5187                 DEBUG_PEEP("fnew", scan, depth, flags);
5188
5189                 frame = newframe;
5190                 scan =  start;
5191                 stopparen = paren;
5192                 last = end;
5193                 depth = depth + 1;
5194                 recursed_depth= my_recursed_depth;
5195
5196                 continue;
5197             }
5198         }
5199         else if (   OP(scan) == EXACT
5200                  || OP(scan) == EXACT_ONLY8
5201                  || OP(scan) == EXACTL)
5202         {
5203             SSize_t l = STR_LEN(scan);
5204             UV uc;
5205             assert(l);
5206             if (UTF) {
5207                 const U8 * const s = (U8*)STRING(scan);
5208                 uc = utf8_to_uvchr_buf(s, s + l, NULL);
5209                 l = utf8_length(s, s + l);
5210             } else {
5211                 uc = *((U8*)STRING(scan));
5212             }
5213             min += l;
5214             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
5215                 /* The code below prefers earlier match for fixed
5216                    offset, later match for variable offset.  */
5217                 if (data->last_end == -1) { /* Update the start info. */
5218                     data->last_start_min = data->pos_min;
5219                     data->last_start_max = is_inf
5220                         ? SSize_t_MAX : data->pos_min + data->pos_delta;
5221                 }
5222                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
5223                 if (UTF)
5224                     SvUTF8_on(data->last_found);
5225                 {
5226                     SV * const sv = data->last_found;
5227                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5228                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5229                     if (mg && mg->mg_len >= 0)
5230                         mg->mg_len += utf8_length((U8*)STRING(scan),
5231                                               (U8*)STRING(scan)+STR_LEN(scan));
5232                 }
5233                 data->last_end = data->pos_min + l;
5234                 data->pos_min += l; /* As in the first entry. */
5235                 data->flags &= ~SF_BEFORE_EOL;
5236             }
5237
5238             /* ANDing the code point leaves at most it, and not in locale, and
5239              * can't match null string */
5240             if (flags & SCF_DO_STCLASS_AND) {
5241                 ssc_cp_and(data->start_class, uc);
5242                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5243                 ssc_clear_locale(data->start_class);
5244             }
5245             else if (flags & SCF_DO_STCLASS_OR) {
5246                 ssc_add_cp(data->start_class, uc);
5247                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5248
5249                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5250                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5251             }
5252             flags &= ~SCF_DO_STCLASS;
5253         }
5254         else if (PL_regkind[OP(scan)] == EXACT) {
5255             /* But OP != EXACT!, so is EXACTFish */
5256             SSize_t l = STR_LEN(scan);
5257             const U8 * s = (U8*)STRING(scan);
5258
5259             /* Search for fixed substrings supports EXACT only. */
5260             if (flags & SCF_DO_SUBSTR) {
5261                 assert(data);
5262                 scan_commit(pRExC_state, data, minlenp, is_inf);
5263             }
5264             if (UTF) {
5265                 l = utf8_length(s, s + l);
5266             }
5267             if (unfolded_multi_char) {
5268                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
5269             }
5270             min += l - min_subtract;
5271             assert (min >= 0);
5272             delta += min_subtract;
5273             if (flags & SCF_DO_SUBSTR) {
5274                 data->pos_min += l - min_subtract;
5275                 if (data->pos_min < 0) {
5276                     data->pos_min = 0;
5277                 }
5278                 data->pos_delta += min_subtract;
5279                 if (min_subtract) {
5280                     data->cur_is_floating = 1; /* float */
5281                 }
5282             }
5283
5284             if (flags & SCF_DO_STCLASS) {
5285                 SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
5286
5287                 assert(EXACTF_invlist);
5288                 if (flags & SCF_DO_STCLASS_AND) {
5289                     if (OP(scan) != EXACTFL)
5290                         ssc_clear_locale(data->start_class);
5291                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5292                     ANYOF_POSIXL_ZERO(data->start_class);
5293                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
5294                 }
5295                 else {  /* SCF_DO_STCLASS_OR */
5296                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
5297                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5298
5299                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5300                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5301                 }
5302                 flags &= ~SCF_DO_STCLASS;
5303                 SvREFCNT_dec(EXACTF_invlist);
5304             }
5305         }
5306         else if (REGNODE_VARIES(OP(scan))) {
5307             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
5308             I32 fl = 0, f = flags;
5309             regnode * const oscan = scan;
5310             regnode_ssc this_class;
5311             regnode_ssc *oclass = NULL;
5312             I32 next_is_eval = 0;
5313
5314             switch (PL_regkind[OP(scan)]) {
5315             case WHILEM:                /* End of (?:...)* . */
5316                 scan = NEXTOPER(scan);
5317                 goto finish;
5318             case PLUS:
5319                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5320                     next = NEXTOPER(scan);
5321                     if (   OP(next) == EXACT
5322                         || OP(next) == EXACT_ONLY8
5323                         || OP(next) == EXACTL
5324                         || (flags & SCF_DO_STCLASS))
5325                     {
5326                         mincount = 1;
5327                         maxcount = REG_INFTY;
5328                         next = regnext(scan);
5329                         scan = NEXTOPER(scan);
5330                         goto do_curly;
5331                     }
5332                 }
5333                 if (flags & SCF_DO_SUBSTR)
5334                     data->pos_min++;
5335                 min++;
5336                 /* FALLTHROUGH */
5337             case STAR:
5338                 next = NEXTOPER(scan);
5339
5340                 /* This temporary node can now be turned into EXACTFU, and
5341                  * must, as regexec.c doesn't handle it */
5342                 if (OP(next) == EXACTFU_S_EDGE) {
5343                     OP(next) = EXACTFU;
5344                 }
5345
5346                 if (     STR_LEN(next) == 1
5347                     &&   isALPHA_A(* STRING(next))
5348                     && (         OP(next) == EXACTFAA
5349                         || (     OP(next) == EXACTFU
5350                             && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(* STRING(next)))))
5351                 {
5352                     /* These differ in just one bit */
5353                     U8 mask = ~ ('A' ^ 'a');
5354
5355                     assert(isALPHA_A(* STRING(next)));
5356
5357                     /* Then replace it by an ANYOFM node, with
5358                     * the mask set to the complement of the
5359                     * bit that differs between upper and lower
5360                     * case, and the lowest code point of the
5361                     * pair (which the '&' forces) */
5362                     OP(next) = ANYOFM;
5363                     ARG_SET(next, *STRING(next) & mask);
5364                     FLAGS(next) = mask;
5365                 }
5366
5367                 if (flags & SCF_DO_STCLASS) {
5368                     mincount = 0;
5369                     maxcount = REG_INFTY;
5370                     next = regnext(scan);
5371                     scan = NEXTOPER(scan);
5372                     goto do_curly;
5373                 }
5374                 if (flags & SCF_DO_SUBSTR) {
5375                     scan_commit(pRExC_state, data, minlenp, is_inf);
5376                     /* Cannot extend fixed substrings */
5377                     data->cur_is_floating = 1; /* float */
5378                 }
5379                 is_inf = is_inf_internal = 1;
5380                 scan = regnext(scan);
5381                 goto optimize_curly_tail;
5382             case CURLY:
5383                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5384                     && (scan->flags == stopparen))
5385                 {
5386                     mincount = 1;
5387                     maxcount = 1;
5388                 } else {
5389                     mincount = ARG1(scan);
5390                     maxcount = ARG2(scan);
5391                 }
5392                 next = regnext(scan);
5393                 if (OP(scan) == CURLYX) {
5394                     I32 lp = (data ? *(data->last_closep) : 0);
5395                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5396                 }
5397                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5398                 next_is_eval = (OP(scan) == EVAL);
5399               do_curly:
5400                 if (flags & SCF_DO_SUBSTR) {
5401                     if (mincount == 0)
5402                         scan_commit(pRExC_state, data, minlenp, is_inf);
5403                     /* Cannot extend fixed substrings */
5404                     pos_before = data->pos_min;
5405                 }
5406                 if (data) {
5407                     fl = data->flags;
5408                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5409                     if (is_inf)
5410                         data->flags |= SF_IS_INF;
5411                 }
5412                 if (flags & SCF_DO_STCLASS) {
5413                     ssc_init(pRExC_state, &this_class);
5414                     oclass = data->start_class;
5415                     data->start_class = &this_class;
5416                     f |= SCF_DO_STCLASS_AND;
5417                     f &= ~SCF_DO_STCLASS_OR;
5418                 }
5419                 /* Exclude from super-linear cache processing any {n,m}
5420                    regops for which the combination of input pos and regex
5421                    pos is not enough information to determine if a match
5422                    will be possible.
5423
5424                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5425                    regex pos at the \s*, the prospects for a match depend not
5426                    only on the input position but also on how many (bar\s*)
5427                    repeats into the {4,8} we are. */
5428                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5429                     f &= ~SCF_WHILEM_VISITED_POS;
5430
5431                 /* This will finish on WHILEM, setting scan, or on NULL: */
5432                 /* recurse study_chunk() on loop bodies */
5433                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5434                                   last, data, stopparen, recursed_depth, NULL,
5435                                   (mincount == 0
5436                                    ? (f & ~SCF_DO_SUBSTR)
5437                                    : f)
5438                                   ,depth+1);
5439
5440                 if (flags & SCF_DO_STCLASS)
5441                     data->start_class = oclass;
5442                 if (mincount == 0 || minnext == 0) {
5443                     if (flags & SCF_DO_STCLASS_OR) {
5444                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5445                     }
5446                     else if (flags & SCF_DO_STCLASS_AND) {
5447                         /* Switch to OR mode: cache the old value of
5448                          * data->start_class */
5449                         INIT_AND_WITHP;
5450                         StructCopy(data->start_class, and_withp, regnode_ssc);
5451                         flags &= ~SCF_DO_STCLASS_AND;
5452                         StructCopy(&this_class, data->start_class, regnode_ssc);
5453                         flags |= SCF_DO_STCLASS_OR;
5454                         ANYOF_FLAGS(data->start_class)
5455                                                 |= SSC_MATCHES_EMPTY_STRING;
5456                     }
5457                 } else {                /* Non-zero len */
5458                     if (flags & SCF_DO_STCLASS_OR) {
5459                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5460                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5461                     }
5462                     else if (flags & SCF_DO_STCLASS_AND)
5463                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5464                     flags &= ~SCF_DO_STCLASS;
5465                 }
5466                 if (!scan)              /* It was not CURLYX, but CURLY. */
5467                     scan = next;
5468                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5469                     /* ? quantifier ok, except for (?{ ... }) */
5470                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5471                     && (minnext == 0) && (deltanext == 0)
5472                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5473                     && maxcount <= REG_INFTY/3) /* Complement check for big
5474                                                    count */
5475                 {
5476                     _WARN_HELPER(RExC_precomp_end, packWARN(WARN_REGEXP),
5477                         Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5478                             "Quantifier unexpected on zero-length expression "
5479                             "in regex m/%" UTF8f "/",
5480                              UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5481                                   RExC_precomp)));
5482                 }
5483
5484                 min += minnext * mincount;
5485                 is_inf_internal |= deltanext == SSize_t_MAX
5486                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5487                 is_inf |= is_inf_internal;
5488                 if (is_inf) {
5489                     delta = SSize_t_MAX;
5490                 } else {
5491                     delta += (minnext + deltanext) * maxcount
5492                              - minnext * mincount;
5493                 }
5494                 /* Try powerful optimization CURLYX => CURLYN. */
5495                 if (  OP(oscan) == CURLYX && data
5496                       && data->flags & SF_IN_PAR
5497                       && !(data->flags & SF_HAS_EVAL)
5498                       && !deltanext && minnext == 1 ) {
5499                     /* Try to optimize to CURLYN.  */
5500                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5501                     regnode * const nxt1 = nxt;
5502 #ifdef DEBUGGING
5503                     regnode *nxt2;
5504 #endif
5505
5506                     /* Skip open. */
5507                     nxt = regnext(nxt);
5508                     if (!REGNODE_SIMPLE(OP(nxt))
5509                         && !(PL_regkind[OP(nxt)] == EXACT
5510                              && STR_LEN(nxt) == 1))
5511                         goto nogo;
5512 #ifdef DEBUGGING
5513                     nxt2 = nxt;
5514 #endif
5515                     nxt = regnext(nxt);
5516                     if (OP(nxt) != CLOSE)
5517                         goto nogo;
5518                     if (RExC_open_parens) {
5519
5520                         /*open->CURLYM*/
5521                         RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5522
5523                         /*close->while*/
5524                         RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt) + 2;
5525                     }
5526                     /* Now we know that nxt2 is the only contents: */
5527                     oscan->flags = (U8)ARG(nxt);
5528                     OP(oscan) = CURLYN;
5529                     OP(nxt1) = NOTHING; /* was OPEN. */
5530
5531 #ifdef DEBUGGING
5532                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5533                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5534                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5535                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5536                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5537                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5538 #endif
5539                 }
5540               nogo:
5541
5542                 /* Try optimization CURLYX => CURLYM. */
5543                 if (  OP(oscan) == CURLYX && data
5544                       && !(data->flags & SF_HAS_PAR)
5545                       && !(data->flags & SF_HAS_EVAL)
5546                       && !deltanext     /* atom is fixed width */
5547                       && minnext != 0   /* CURLYM can't handle zero width */
5548
5549                          /* Nor characters whose fold at run-time may be
5550                           * multi-character */
5551                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5552                 ) {
5553                     /* XXXX How to optimize if data == 0? */
5554                     /* Optimize to a simpler form.  */
5555                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5556                     regnode *nxt2;
5557
5558                     OP(oscan) = CURLYM;
5559                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5560                             && (OP(nxt2) != WHILEM))
5561                         nxt = nxt2;
5562                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5563                     /* Need to optimize away parenths. */
5564                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5565                         /* Set the parenth number.  */
5566                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5567
5568                         oscan->flags = (U8)ARG(nxt);
5569                         if (RExC_open_parens) {
5570                              /*open->CURLYM*/
5571                             RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5572
5573                             /*close->NOTHING*/
5574                             RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt2)
5575                                                          + 1;
5576                         }
5577                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5578                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5579
5580 #ifdef DEBUGGING
5581                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5582                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5583                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5584                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5585 #endif
5586 #if 0
5587                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5588                             regnode *nnxt = regnext(nxt1);
5589                             if (nnxt == nxt) {
5590                                 if (reg_off_by_arg[OP(nxt1)])
5591                                     ARG_SET(nxt1, nxt2 - nxt1);
5592                                 else if (nxt2 - nxt1 < U16_MAX)
5593                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5594                                 else
5595                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5596                             }
5597                             nxt1 = nnxt;
5598                         }
5599 #endif
5600                         /* Optimize again: */
5601                         /* recurse study_chunk() on optimised CURLYX => CURLYM */
5602                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5603                                     NULL, stopparen, recursed_depth, NULL, 0,
5604                                     depth+1);
5605                     }
5606                     else
5607                         oscan->flags = 0;
5608                 }
5609                 else if ((OP(oscan) == CURLYX)
5610                          && (flags & SCF_WHILEM_VISITED_POS)
5611                          /* See the comment on a similar expression above.
5612                             However, this time it's not a subexpression
5613                             we care about, but the expression itself. */
5614                          && (maxcount == REG_INFTY)
5615                          && data) {
5616                     /* This stays as CURLYX, we can put the count/of pair. */
5617                     /* Find WHILEM (as in regexec.c) */
5618                     regnode *nxt = oscan + NEXT_OFF(oscan);
5619
5620                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5621                         nxt += ARG(nxt);
5622                     nxt = PREVOPER(nxt);
5623                     if (nxt->flags & 0xf) {
5624                         /* we've already set whilem count on this node */
5625                     } else if (++data->whilem_c < 16) {
5626                         assert(data->whilem_c <= RExC_whilem_seen);
5627                         nxt->flags = (U8)(data->whilem_c
5628                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5629                     }
5630                 }
5631                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5632                     pars++;
5633                 if (flags & SCF_DO_SUBSTR) {
5634                     SV *last_str = NULL;
5635                     STRLEN last_chrs = 0;
5636                     int counted = mincount != 0;
5637
5638                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5639                                                                   string. */
5640                         SSize_t b = pos_before >= data->last_start_min
5641                             ? pos_before : data->last_start_min;
5642                         STRLEN l;
5643                         const char * const s = SvPV_const(data->last_found, l);
5644                         SSize_t old = b - data->last_start_min;
5645                         assert(old >= 0);
5646
5647                         if (UTF)
5648                             old = utf8_hop_forward((U8*)s, old,
5649                                                (U8 *) SvEND(data->last_found))
5650                                 - (U8*)s;
5651                         l -= old;
5652                         /* Get the added string: */
5653                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5654                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5655                                             (U8*)(s + old + l)) : l;
5656                         if (deltanext == 0 && pos_before == b) {
5657                             /* What was added is a constant string */
5658                             if (mincount > 1) {
5659
5660                                 SvGROW(last_str, (mincount * l) + 1);
5661                                 repeatcpy(SvPVX(last_str) + l,
5662                                           SvPVX_const(last_str), l,
5663                                           mincount - 1);
5664                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5665                                 /* Add additional parts. */
5666                                 SvCUR_set(data->last_found,
5667                                           SvCUR(data->last_found) - l);
5668                                 sv_catsv(data->last_found, last_str);
5669                                 {
5670                                     SV * sv = data->last_found;
5671                                     MAGIC *mg =
5672                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5673                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5674                                     if (mg && mg->mg_len >= 0)
5675                                         mg->mg_len += last_chrs * (mincount-1);
5676                                 }
5677                                 last_chrs *= mincount;
5678                                 data->last_end += l * (mincount - 1);
5679                             }
5680                         } else {
5681                             /* start offset must point into the last copy */
5682                             data->last_start_min += minnext * (mincount - 1);
5683                             data->last_start_max =
5684                               is_inf
5685                                ? SSize_t_MAX
5686                                : data->last_start_max +
5687                                  (maxcount - 1) * (minnext + data->pos_delta);
5688                         }
5689                     }
5690                     /* It is counted once already... */
5691                     data->pos_min += minnext * (mincount - counted);
5692 #if 0
5693 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5694                               " SSize_t_MAX=%" UVuf " minnext=%" UVuf
5695                               " maxcount=%" UVuf " mincount=%" UVuf "\n",
5696     (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
5697     (UV)mincount);
5698 if (deltanext != SSize_t_MAX)
5699 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5700     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5701           - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
5702 #endif
5703                     if (deltanext == SSize_t_MAX
5704                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
5705                         data->pos_delta = SSize_t_MAX;
5706                     else
5707                         data->pos_delta += - counted * deltanext +
5708                         (minnext + deltanext) * maxcount - minnext * mincount;
5709                     if (mincount != maxcount) {
5710                          /* Cannot extend fixed substrings found inside
5711                             the group.  */
5712                         scan_commit(pRExC_state, data, minlenp, is_inf);
5713                         if (mincount && last_str) {
5714                             SV * const sv = data->last_found;
5715                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5716                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5717
5718                             if (mg)
5719                                 mg->mg_len = -1;
5720                             sv_setsv(sv, last_str);
5721                             data->last_end = data->pos_min;
5722                             data->last_start_min = data->pos_min - last_chrs;
5723                             data->last_start_max = is_inf
5724                                 ? SSize_t_MAX
5725                                 : data->pos_min + data->pos_delta - last_chrs;
5726                         }
5727                         data->cur_is_floating = 1; /* float */
5728                     }
5729                     SvREFCNT_dec(last_str);
5730                 }
5731                 if (data && (fl & SF_HAS_EVAL))
5732                     data->flags |= SF_HAS_EVAL;
5733               optimize_curly_tail:
5734                 if (OP(oscan) != CURLYX) {
5735                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
5736                            && NEXT_OFF(next))
5737                         NEXT_OFF(oscan) += NEXT_OFF(next);
5738                 }
5739                 continue;
5740
5741             default:
5742 #ifdef DEBUGGING
5743                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5744                                                                     OP(scan));
5745 #endif
5746             case REF:
5747             case CLUMP:
5748                 if (flags & SCF_DO_SUBSTR) {
5749                     /* Cannot expect anything... */
5750                     scan_commit(pRExC_state, data, minlenp, is_inf);
5751                     data->cur_is_floating = 1; /* float */
5752                 }
5753                 is_inf = is_inf_internal = 1;
5754                 if (flags & SCF_DO_STCLASS_OR) {
5755                     if (OP(scan) == CLUMP) {
5756                         /* Actually is any start char, but very few code points
5757                          * aren't start characters */
5758                         ssc_match_all_cp(data->start_class);
5759                     }
5760                     else {
5761                         ssc_anything(data->start_class);
5762                     }
5763                 }
5764                 flags &= ~SCF_DO_STCLASS;
5765                 break;
5766             }
5767         }
5768         else if (OP(scan) == LNBREAK) {
5769             if (flags & SCF_DO_STCLASS) {
5770                 if (flags & SCF_DO_STCLASS_AND) {
5771                     ssc_intersection(data->start_class,
5772                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5773                     ssc_clear_locale(data->start_class);
5774                     ANYOF_FLAGS(data->start_class)
5775                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5776                 }
5777                 else if (flags & SCF_DO_STCLASS_OR) {
5778                     ssc_union(data->start_class,
5779                               PL_XPosix_ptrs[_CC_VERTSPACE],
5780                               FALSE);
5781                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5782
5783                     /* See commit msg for
5784                      * 749e076fceedeb708a624933726e7989f2302f6a */
5785                     ANYOF_FLAGS(data->start_class)
5786                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5787                 }
5788                 flags &= ~SCF_DO_STCLASS;
5789             }
5790             min++;
5791             if (delta != SSize_t_MAX)
5792                 delta++;    /* Because of the 2 char string cr-lf */
5793             if (flags & SCF_DO_SUBSTR) {
5794                 /* Cannot expect anything... */
5795                 scan_commit(pRExC_state, data, minlenp, is_inf);
5796                 data->pos_min += 1;
5797                 if (data->pos_delta != SSize_t_MAX) {
5798                     data->pos_delta += 1;
5799                 }
5800                 data->cur_is_floating = 1; /* float */
5801             }
5802         }
5803         else if (REGNODE_SIMPLE(OP(scan))) {
5804
5805             if (flags & SCF_DO_SUBSTR) {
5806                 scan_commit(pRExC_state, data, minlenp, is_inf);
5807                 data->pos_min++;
5808             }
5809             min++;
5810             if (flags & SCF_DO_STCLASS) {
5811                 bool invert = 0;
5812                 SV* my_invlist = NULL;
5813                 U8 namedclass;
5814
5815                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5816                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5817
5818                 /* Some of the logic below assumes that switching
5819                    locale on will only add false positives. */
5820                 switch (OP(scan)) {
5821
5822                 default:
5823 #ifdef DEBUGGING
5824                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5825                                                                      OP(scan));
5826 #endif
5827                 case SANY:
5828                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5829                         ssc_match_all_cp(data->start_class);
5830                     break;
5831
5832                 case REG_ANY:
5833                     {
5834                         SV* REG_ANY_invlist = _new_invlist(2);
5835                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5836                                                             '\n');
5837                         if (flags & SCF_DO_STCLASS_OR) {
5838                             ssc_union(data->start_class,
5839                                       REG_ANY_invlist,
5840                                       TRUE /* TRUE => invert, hence all but \n
5841                                             */
5842                                       );
5843                         }
5844                         else if (flags & SCF_DO_STCLASS_AND) {
5845                             ssc_intersection(data->start_class,
5846                                              REG_ANY_invlist,
5847                                              TRUE  /* TRUE => invert */
5848                                              );
5849                             ssc_clear_locale(data->start_class);
5850                         }
5851                         SvREFCNT_dec_NN(REG_ANY_invlist);
5852                     }
5853                     break;
5854
5855                 case ANYOFD:
5856                 case ANYOFL:
5857                 case ANYOFPOSIXL:
5858                 case ANYOFH:
5859                 case ANYOFHb:
5860                 case ANYOFHr:
5861                 case ANYOF:
5862                     if (flags & SCF_DO_STCLASS_AND)
5863                         ssc_and(pRExC_state, data->start_class,
5864                                 (regnode_charclass *) scan);
5865                     else
5866                         ssc_or(pRExC_state, data->start_class,
5867                                                           (regnode_charclass *) scan);
5868                     break;
5869
5870                 case NANYOFM:
5871                 case ANYOFM:
5872                   {
5873                     SV* cp_list = get_ANYOFM_contents(scan);
5874
5875                     if (flags & SCF_DO_STCLASS_OR) {
5876                         ssc_union(data->start_class, cp_list, invert);
5877                     }
5878                     else if (flags & SCF_DO_STCLASS_AND) {
5879                         ssc_intersection(data->start_class, cp_list, invert);
5880                     }
5881
5882                     SvREFCNT_dec_NN(cp_list);
5883                     break;
5884                   }
5885
5886                 case NPOSIXL:
5887                     invert = 1;
5888                     /* FALLTHROUGH */
5889
5890                 case POSIXL:
5891                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5892                     if (flags & SCF_DO_STCLASS_AND) {
5893                         bool was_there = cBOOL(
5894                                           ANYOF_POSIXL_TEST(data->start_class,
5895                                                                  namedclass));
5896                         ANYOF_POSIXL_ZERO(data->start_class);
5897                         if (was_there) {    /* Do an AND */
5898                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5899                         }
5900                         /* No individual code points can now match */
5901                         data->start_class->invlist
5902                                                 = sv_2mortal(_new_invlist(0));
5903                     }
5904                     else {
5905                         int complement = namedclass + ((invert) ? -1 : 1);
5906
5907                         assert(flags & SCF_DO_STCLASS_OR);
5908
5909                         /* If the complement of this class was already there,
5910                          * the result is that they match all code points,
5911                          * (\d + \D == everything).  Remove the classes from
5912                          * future consideration.  Locale is not relevant in
5913                          * this case */
5914                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5915                             ssc_match_all_cp(data->start_class);
5916                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5917                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
5918                         }
5919                         else {  /* The usual case; just add this class to the
5920                                    existing set */
5921                             ANYOF_POSIXL_SET(data->start_class, namedclass);
5922                         }
5923                     }
5924                     break;
5925
5926                 case NPOSIXA:   /* For these, we always know the exact set of
5927                                    what's matched */
5928                     invert = 1;
5929                     /* FALLTHROUGH */
5930                 case POSIXA:
5931                     my_invlist = invlist_clone(PL_Posix_ptrs[FLAGS(scan)], NULL);
5932                     goto join_posix_and_ascii;
5933
5934                 case NPOSIXD:
5935                 case NPOSIXU:
5936                     invert = 1;
5937                     /* FALLTHROUGH */
5938                 case POSIXD:
5939                 case POSIXU:
5940                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)], NULL);
5941
5942                     /* NPOSIXD matches all upper Latin1 code points unless the
5943                      * target string being matched is UTF-8, which is
5944                      * unknowable until match time.  Since we are going to
5945                      * invert, we want to get rid of all of them so that the
5946                      * inversion will match all */
5947                     if (OP(scan) == NPOSIXD) {
5948                         _invlist_subtract(my_invlist, PL_UpperLatin1,
5949                                           &my_invlist);
5950                     }
5951
5952                   join_posix_and_ascii:
5953
5954                     if (flags & SCF_DO_STCLASS_AND) {
5955                         ssc_intersection(data->start_class, my_invlist, invert);
5956                         ssc_clear_locale(data->start_class);
5957                     }
5958                     else {
5959                         assert(flags & SCF_DO_STCLASS_OR);
5960                         ssc_union(data->start_class, my_invlist, invert);
5961                     }
5962                     SvREFCNT_dec(my_invlist);
5963                 }
5964                 if (flags & SCF_DO_STCLASS_OR)
5965                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5966                 flags &= ~SCF_DO_STCLASS;
5967             }
5968         }
5969         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5970             data->flags |= (OP(scan) == MEOL
5971                             ? SF_BEFORE_MEOL
5972                             : SF_BEFORE_SEOL);
5973             scan_commit(pRExC_state, data, minlenp, is_inf);
5974
5975         }
5976         else if (  PL_regkind[OP(scan)] == BRANCHJ
5977                  /* Lookbehind, or need to calculate parens/evals/stclass: */
5978                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
5979                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5980         {
5981             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5982                 || OP(scan) == UNLESSM )
5983             {
5984                 /* Negative Lookahead/lookbehind
5985                    In this case we can't do fixed string optimisation.
5986                 */
5987
5988                 SSize_t deltanext, minnext, fake = 0;
5989                 regnode *nscan;
5990                 regnode_ssc intrnl;
5991                 int f = 0;
5992
5993                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5994                 if (data) {
5995                     data_fake.whilem_c = data->whilem_c;
5996                     data_fake.last_closep = data->last_closep;
5997                 }
5998                 else
5999                     data_fake.last_closep = &fake;
6000                 data_fake.pos_delta = delta;
6001                 if ( flags & SCF_DO_STCLASS && !scan->flags
6002                      && OP(scan) == IFMATCH ) { /* Lookahead */
6003                     ssc_init(pRExC_state, &intrnl);
6004                     data_fake.start_class = &intrnl;
6005                     f |= SCF_DO_STCLASS_AND;
6006                 }
6007                 if (flags & SCF_WHILEM_VISITED_POS)
6008                     f |= SCF_WHILEM_VISITED_POS;
6009                 next = regnext(scan);
6010                 nscan = NEXTOPER(NEXTOPER(scan));
6011
6012                 /* recurse study_chunk() for lookahead body */
6013                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
6014                                       last, &data_fake, stopparen,
6015                                       recursed_depth, NULL, f, depth+1);
6016                 if (scan->flags) {
6017                     if (   deltanext < 0
6018                         || deltanext > (I32) U8_MAX
6019                         || minnext > (I32)U8_MAX
6020                         || minnext + deltanext > (I32)U8_MAX)
6021                     {
6022                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6023                               (UV)U8_MAX);
6024                     }
6025
6026                     /* The 'next_off' field has been repurposed to count the
6027                      * additional starting positions to try beyond the initial
6028                      * one.  (This leaves it at 0 for non-variable length
6029                      * matches to avoid breakage for those not using this
6030                      * extension) */
6031                     if (deltanext) {
6032                         scan->next_off = deltanext;
6033                         ckWARNexperimental(RExC_parse,
6034                             WARN_EXPERIMENTAL__VLB,
6035                             "Variable length lookbehind is experimental");
6036                     }
6037                     scan->flags = (U8)minnext + deltanext;
6038                 }
6039                 if (data) {
6040                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6041                         pars++;
6042                     if (data_fake.flags & SF_HAS_EVAL)
6043                         data->flags |= SF_HAS_EVAL;
6044                     data->whilem_c = data_fake.whilem_c;
6045                 }
6046                 if (f & SCF_DO_STCLASS_AND) {
6047                     if (flags & SCF_DO_STCLASS_OR) {
6048                         /* OR before, AND after: ideally we would recurse with
6049                          * data_fake to get the AND applied by study of the
6050                          * remainder of the pattern, and then derecurse;
6051                          * *** HACK *** for now just treat as "no information".
6052                          * See [perl #56690].
6053                          */
6054                         ssc_init(pRExC_state, data->start_class);
6055                     }  else {
6056                         /* AND before and after: combine and continue.  These
6057                          * assertions are zero-length, so can match an EMPTY
6058                          * string */
6059                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6060                         ANYOF_FLAGS(data->start_class)
6061                                                    |= SSC_MATCHES_EMPTY_STRING;
6062                     }
6063                 }
6064             }
6065 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
6066             else {
6067                 /* Positive Lookahead/lookbehind
6068                    In this case we can do fixed string optimisation,
6069                    but we must be careful about it. Note in the case of
6070                    lookbehind the positions will be offset by the minimum
6071                    length of the pattern, something we won't know about
6072                    until after the recurse.
6073                 */
6074                 SSize_t deltanext, fake = 0;
6075                 regnode *nscan;
6076                 regnode_ssc intrnl;
6077                 int f = 0;
6078                 /* We use SAVEFREEPV so that when the full compile
6079                     is finished perl will clean up the allocated
6080                     minlens when it's all done. This way we don't
6081                     have to worry about freeing them when we know
6082                     they wont be used, which would be a pain.
6083                  */
6084                 SSize_t *minnextp;
6085                 Newx( minnextp, 1, SSize_t );
6086                 SAVEFREEPV(minnextp);
6087
6088                 if (data) {
6089                     StructCopy(data, &data_fake, scan_data_t);
6090                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
6091                         f |= SCF_DO_SUBSTR;
6092                         if (scan->flags)
6093                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
6094                         data_fake.last_found=newSVsv(data->last_found);
6095                     }
6096                 }
6097                 else
6098                     data_fake.last_closep = &fake;
6099                 data_fake.flags = 0;
6100                 data_fake.substrs[0].flags = 0;
6101                 data_fake.substrs[1].flags = 0;
6102                 data_fake.pos_delta = delta;
6103                 if (is_inf)
6104                     data_fake.flags |= SF_IS_INF;
6105                 if ( flags & SCF_DO_STCLASS && !scan->flags
6106                      && OP(scan) == IFMATCH ) { /* Lookahead */
6107                     ssc_init(pRExC_state, &intrnl);
6108                     data_fake.start_class = &intrnl;
6109                     f |= SCF_DO_STCLASS_AND;
6110                 }
6111                 if (flags & SCF_WHILEM_VISITED_POS)
6112                     f |= SCF_WHILEM_VISITED_POS;
6113                 next = regnext(scan);
6114                 nscan = NEXTOPER(NEXTOPER(scan));
6115
6116                 /* positive lookahead study_chunk() recursion */
6117                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
6118                                         &deltanext, last, &data_fake,
6119                                         stopparen, recursed_depth, NULL,
6120                                         f, depth+1);
6121                 if (scan->flags) {
6122                     assert(0);  /* This code has never been tested since this
6123                                    is normally not compiled */
6124                     if (   deltanext < 0
6125                         || deltanext > (I32) U8_MAX
6126                         || *minnextp > (I32)U8_MAX
6127                         || *minnextp + deltanext > (I32)U8_MAX)
6128                     {
6129                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6130                               (UV)U8_MAX);
6131                     }
6132
6133                     if (deltanext) {
6134                         scan->next_off = deltanext;
6135                     }
6136                     scan->flags = (U8)*minnextp + deltanext;
6137                 }
6138
6139                 *minnextp += min;
6140
6141                 if (f & SCF_DO_STCLASS_AND) {
6142                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6143                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
6144                 }
6145                 if (data) {
6146                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6147                         pars++;
6148                     if (data_fake.flags & SF_HAS_EVAL)
6149                         data->flags |= SF_HAS_EVAL;
6150                     data->whilem_c = data_fake.whilem_c;
6151                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
6152                         int i;
6153                         if (RExC_rx->minlen<*minnextp)
6154                             RExC_rx->minlen=*minnextp;
6155                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
6156                         SvREFCNT_dec_NN(data_fake.last_found);
6157
6158                         for (i = 0; i < 2; i++) {
6159                             if (data_fake.substrs[i].minlenp != minlenp) {
6160                                 data->substrs[i].min_offset =
6161                                             data_fake.substrs[i].min_offset;
6162                                 data->substrs[i].max_offset =
6163                                             data_fake.substrs[i].max_offset;
6164                                 data->substrs[i].minlenp =
6165                                             data_fake.substrs[i].minlenp;
6166                                 data->substrs[i].lookbehind += scan->flags;
6167                             }
6168                         }
6169                     }
6170                 }
6171             }
6172 #endif
6173         }
6174
6175         else if (OP(scan) == OPEN) {
6176             if (stopparen != (I32)ARG(scan))
6177                 pars++;
6178         }
6179         else if (OP(scan) == CLOSE) {
6180             if (stopparen == (I32)ARG(scan)) {
6181                 break;
6182             }
6183             if ((I32)ARG(scan) == is_par) {
6184                 next = regnext(scan);
6185
6186                 if ( next && (OP(next) != WHILEM) && next < last)
6187                     is_par = 0;         /* Disable optimization */
6188             }
6189             if (data)
6190                 *(data->last_closep) = ARG(scan);
6191         }
6192         else if (OP(scan) == EVAL) {
6193                 if (data)
6194                     data->flags |= SF_HAS_EVAL;
6195         }
6196         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
6197             if (flags & SCF_DO_SUBSTR) {
6198                 scan_commit(pRExC_state, data, minlenp, is_inf);
6199                 flags &= ~SCF_DO_SUBSTR;
6200             }
6201             if (data && OP(scan)==ACCEPT) {
6202                 data->flags |= SCF_SEEN_ACCEPT;
6203                 if (stopmin > min)
6204                     stopmin = min;
6205             }
6206         }
6207         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
6208         {
6209                 if (flags & SCF_DO_SUBSTR) {
6210                     scan_commit(pRExC_state, data, minlenp, is_inf);
6211                     data->cur_is_floating = 1; /* float */
6212                 }
6213                 is_inf = is_inf_internal = 1;
6214                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
6215                     ssc_anything(data->start_class);
6216                 flags &= ~SCF_DO_STCLASS;
6217         }
6218         else if (OP(scan) == GPOS) {
6219             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
6220                 !(delta || is_inf || (data && data->pos_delta)))
6221             {
6222                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
6223                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
6224                 if (RExC_rx->gofs < (STRLEN)min)
6225                     RExC_rx->gofs = min;
6226             } else {
6227                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
6228                 RExC_rx->gofs = 0;
6229             }
6230         }
6231 #ifdef TRIE_STUDY_OPT
6232 #ifdef FULL_TRIE_STUDY
6233         else if (PL_regkind[OP(scan)] == TRIE) {
6234             /* NOTE - There is similar code to this block above for handling
6235                BRANCH nodes on the initial study.  If you change stuff here
6236                check there too. */
6237             regnode *trie_node= scan;
6238             regnode *tail= regnext(scan);
6239             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6240             SSize_t max1 = 0, min1 = SSize_t_MAX;
6241             regnode_ssc accum;
6242
6243             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
6244                 /* Cannot merge strings after this. */
6245                 scan_commit(pRExC_state, data, minlenp, is_inf);
6246             }
6247             if (flags & SCF_DO_STCLASS)
6248                 ssc_init_zero(pRExC_state, &accum);
6249
6250             if (!trie->jump) {
6251                 min1= trie->minlen;
6252                 max1= trie->maxlen;
6253             } else {
6254                 const regnode *nextbranch= NULL;
6255                 U32 word;
6256
6257                 for ( word=1 ; word <= trie->wordcount ; word++)
6258                 {
6259                     SSize_t deltanext=0, minnext=0, f = 0, fake;
6260                     regnode_ssc this_class;
6261
6262                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
6263                     if (data) {
6264                         data_fake.whilem_c = data->whilem_c;
6265                         data_fake.last_closep = data->last_closep;
6266                     }
6267                     else
6268                         data_fake.last_closep = &fake;
6269                     data_fake.pos_delta = delta;
6270                     if (flags & SCF_DO_STCLASS) {
6271                         ssc_init(pRExC_state, &this_class);
6272                         data_fake.start_class = &this_class;
6273                         f = SCF_DO_STCLASS_AND;
6274                     }
6275                     if (flags & SCF_WHILEM_VISITED_POS)
6276                         f |= SCF_WHILEM_VISITED_POS;
6277
6278                     if (trie->jump[word]) {
6279                         if (!nextbranch)
6280                             nextbranch = trie_node + trie->jump[0];
6281                         scan= trie_node + trie->jump[word];
6282                         /* We go from the jump point to the branch that follows
6283                            it. Note this means we need the vestigal unused
6284                            branches even though they arent otherwise used. */
6285                         /* optimise study_chunk() for TRIE */
6286                         minnext = study_chunk(pRExC_state, &scan, minlenp,
6287                             &deltanext, (regnode *)nextbranch, &data_fake,
6288                             stopparen, recursed_depth, NULL, f, depth+1);
6289                     }
6290                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
6291                         nextbranch= regnext((regnode*)nextbranch);
6292
6293                     if (min1 > (SSize_t)(minnext + trie->minlen))
6294                         min1 = minnext + trie->minlen;
6295                     if (deltanext == SSize_t_MAX) {
6296                         is_inf = is_inf_internal = 1;
6297                         max1 = SSize_t_MAX;
6298                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
6299                         max1 = minnext + deltanext + trie->maxlen;
6300
6301                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6302                         pars++;
6303                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
6304                         if ( stopmin > min + min1)
6305                             stopmin = min + min1;
6306                         flags &= ~SCF_DO_SUBSTR;
6307                         if (data)
6308                             data->flags |= SCF_SEEN_ACCEPT;
6309                     }
6310                     if (data) {
6311                         if (data_fake.flags & SF_HAS_EVAL)
6312                             data->flags |= SF_HAS_EVAL;
6313                         data->whilem_c = data_fake.whilem_c;
6314                     }
6315                     if (flags & SCF_DO_STCLASS)
6316                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
6317                 }
6318             }
6319             if (flags & SCF_DO_SUBSTR) {
6320                 data->pos_min += min1;
6321                 data->pos_delta += max1 - min1;
6322                 if (max1 != min1 || is_inf)
6323                     data->cur_is_floating = 1; /* float */
6324             }
6325             min += min1;
6326             if (delta != SSize_t_MAX) {
6327                 if (SSize_t_MAX - (max1 - min1) >= delta)
6328                     delta += max1 - min1;
6329                 else
6330                     delta = SSize_t_MAX;
6331             }
6332             if (flags & SCF_DO_STCLASS_OR) {
6333                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6334                 if (min1) {
6335                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6336                     flags &= ~SCF_DO_STCLASS;
6337                 }
6338             }
6339             else if (flags & SCF_DO_STCLASS_AND) {
6340                 if (min1) {
6341                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6342                     flags &= ~SCF_DO_STCLASS;
6343                 }
6344                 else {
6345                     /* Switch to OR mode: cache the old value of
6346                      * data->start_class */
6347                     INIT_AND_WITHP;
6348                     StructCopy(data->start_class, and_withp, regnode_ssc);
6349                     flags &= ~SCF_DO_STCLASS_AND;
6350                     StructCopy(&accum, data->start_class, regnode_ssc);
6351                     flags |= SCF_DO_STCLASS_OR;
6352                 }
6353             }
6354             scan= tail;
6355             continue;
6356         }
6357 #else
6358         else if (PL_regkind[OP(scan)] == TRIE) {
6359             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6360             U8*bang=NULL;
6361
6362             min += trie->minlen;
6363             delta += (trie->maxlen - trie->minlen);
6364             flags &= ~SCF_DO_STCLASS; /* xxx */
6365             if (flags & SCF_DO_SUBSTR) {
6366                 /* Cannot expect anything... */
6367                 scan_commit(pRExC_state, data, minlenp, is_inf);
6368                 data->pos_min += trie->minlen;
6369                 data->pos_delta += (trie->maxlen - trie->minlen);
6370                 if (trie->maxlen != trie->minlen)
6371                     data->cur_is_floating = 1; /* float */
6372             }
6373             if (trie->jump) /* no more substrings -- for now /grr*/
6374                flags &= ~SCF_DO_SUBSTR;
6375         }
6376 #endif /* old or new */
6377 #endif /* TRIE_STUDY_OPT */
6378
6379         /* Else: zero-length, ignore. */
6380         scan = regnext(scan);
6381     }
6382
6383   finish:
6384     if (frame) {
6385         /* we need to unwind recursion. */
6386         depth = depth - 1;
6387
6388         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
6389         DEBUG_PEEP("fend", scan, depth, flags);
6390
6391         /* restore previous context */
6392         last = frame->last_regnode;
6393         scan = frame->next_regnode;
6394         stopparen = frame->stopparen;
6395         recursed_depth = frame->prev_recursed_depth;
6396
6397         RExC_frame_last = frame->prev_frame;
6398         frame = frame->this_prev_frame;
6399         goto fake_study_recurse;
6400     }
6401
6402     assert(!frame);
6403     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6404
6405     *scanp = scan;
6406     *deltap = is_inf_internal ? SSize_t_MAX : delta;
6407
6408     if (flags & SCF_DO_SUBSTR && is_inf)
6409         data->pos_delta = SSize_t_MAX - data->pos_min;
6410     if (is_par > (I32)U8_MAX)
6411         is_par = 0;
6412     if (is_par && pars==1 && data) {
6413         data->flags |= SF_IN_PAR;
6414         data->flags &= ~SF_HAS_PAR;
6415     }
6416     else if (pars && data) {
6417         data->flags |= SF_HAS_PAR;
6418         data->flags &= ~SF_IN_PAR;
6419     }
6420     if (flags & SCF_DO_STCLASS_OR)
6421         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6422     if (flags & SCF_TRIE_RESTUDY)
6423         data->flags |=  SCF_TRIE_RESTUDY;
6424
6425     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6426
6427     {
6428         SSize_t final_minlen= min < stopmin ? min : stopmin;
6429
6430         if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6431             if (final_minlen > SSize_t_MAX - delta)
6432                 RExC_maxlen = SSize_t_MAX;
6433             else if (RExC_maxlen < final_minlen + delta)
6434                 RExC_maxlen = final_minlen + delta;
6435         }
6436         return final_minlen;
6437     }
6438     NOT_REACHED; /* NOTREACHED */
6439 }
6440
6441 STATIC U32
6442 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6443 {
6444     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6445
6446     PERL_ARGS_ASSERT_ADD_DATA;
6447
6448     Renewc(RExC_rxi->data,
6449            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6450            char, struct reg_data);
6451     if(count)
6452         Renew(RExC_rxi->data->what, count + n, U8);
6453     else
6454         Newx(RExC_rxi->data->what, n, U8);
6455     RExC_rxi->data->count = count + n;
6456     Copy(s, RExC_rxi->data->what + count, n, U8);
6457     return count;
6458 }
6459
6460 /*XXX: todo make this not included in a non debugging perl, but appears to be
6461  * used anyway there, in 'use re' */
6462 #ifndef PERL_IN_XSUB_RE
6463 void
6464 Perl_reginitcolors(pTHX)
6465 {
6466     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6467     if (s) {
6468         char *t = savepv(s);
6469         int i = 0;
6470         PL_colors[0] = t;
6471         while (++i < 6) {
6472             t = strchr(t, '\t');
6473             if (t) {
6474                 *t = '\0';
6475                 PL_colors[i] = ++t;
6476             }
6477             else
6478                 PL_colors[i] = t = (char *)"";
6479         }
6480     } else {
6481         int i = 0;
6482         while (i < 6)
6483             PL_colors[i++] = (char *)"";
6484     }
6485     PL_colorset = 1;
6486 }
6487 #endif
6488
6489
6490 #ifdef TRIE_STUDY_OPT
6491 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6492     STMT_START {                                            \
6493         if (                                                \
6494               (data.flags & SCF_TRIE_RESTUDY)               \
6495               && ! restudied++                              \
6496         ) {                                                 \
6497             dOsomething;                                    \
6498             goto reStudy;                                   \
6499         }                                                   \
6500     } STMT_END
6501 #else
6502 #define CHECK_RESTUDY_GOTO_butfirst
6503 #endif
6504
6505 /*
6506  * pregcomp - compile a regular expression into internal code
6507  *
6508  * Decides which engine's compiler to call based on the hint currently in
6509  * scope
6510  */
6511
6512 #ifndef PERL_IN_XSUB_RE
6513
6514 /* return the currently in-scope regex engine (or the default if none)  */
6515
6516 regexp_engine const *
6517 Perl_current_re_engine(pTHX)
6518 {
6519     if (IN_PERL_COMPILETIME) {
6520         HV * const table = GvHV(PL_hintgv);
6521         SV **ptr;
6522
6523         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6524             return &PL_core_reg_engine;
6525         ptr = hv_fetchs(table, "regcomp", FALSE);
6526         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6527             return &PL_core_reg_engine;
6528         return INT2PTR(regexp_engine*, SvIV(*ptr));
6529     }
6530     else {
6531         SV *ptr;
6532         if (!PL_curcop->cop_hints_hash)
6533             return &PL_core_reg_engine;
6534         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6535         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6536             return &PL_core_reg_engine;
6537         return INT2PTR(regexp_engine*, SvIV(ptr));
6538     }
6539 }
6540
6541
6542 REGEXP *
6543 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6544 {
6545     regexp_engine const *eng = current_re_engine();
6546     GET_RE_DEBUG_FLAGS_DECL;
6547
6548     PERL_ARGS_ASSERT_PREGCOMP;
6549
6550     /* Dispatch a request to compile a regexp to correct regexp engine. */
6551     DEBUG_COMPILE_r({
6552         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6553                         PTR2UV(eng));
6554     });
6555     return CALLREGCOMP_ENG(eng, pattern, flags);
6556 }
6557 #endif
6558
6559 /* public(ish) entry point for the perl core's own regex compiling code.
6560  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6561  * pattern rather than a list of OPs, and uses the internal engine rather
6562  * than the current one */
6563
6564 REGEXP *
6565 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6566 {
6567     SV *pat = pattern; /* defeat constness! */
6568     PERL_ARGS_ASSERT_RE_COMPILE;
6569     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6570 #ifdef PERL_IN_XSUB_RE
6571                                 &my_reg_engine,
6572 #else
6573                                 &PL_core_reg_engine,
6574 #endif
6575                                 NULL, NULL, rx_flags, 0);
6576 }
6577
6578
6579 static void
6580 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6581 {
6582     int n;
6583
6584     if (--cbs->refcnt > 0)
6585         return;
6586     for (n = 0; n < cbs->count; n++) {
6587         REGEXP *rx = cbs->cb[n].src_regex;
6588         if (rx) {
6589             cbs->cb[n].src_regex = NULL;
6590             SvREFCNT_dec_NN(rx);
6591         }
6592     }
6593     Safefree(cbs->cb);
6594     Safefree(cbs);
6595 }
6596
6597
6598 static struct reg_code_blocks *
6599 S_alloc_code_blocks(pTHX_  int ncode)
6600 {
6601      struct reg_code_blocks *cbs;
6602     Newx(cbs, 1, struct reg_code_blocks);
6603     cbs->count = ncode;
6604     cbs->refcnt = 1;
6605     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6606     if (ncode)
6607         Newx(cbs->cb, ncode, struct reg_code_block);
6608     else
6609         cbs->cb = NULL;
6610     return cbs;
6611 }
6612
6613
6614 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6615  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6616  * point to the realloced string and length.
6617  *
6618  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6619  * stuff added */
6620
6621 static void
6622 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6623                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6624 {
6625     U8 *const src = (U8*)*pat_p;
6626     U8 *dst, *d;
6627     int n=0;
6628     STRLEN s = 0;
6629     bool do_end = 0;
6630     GET_RE_DEBUG_FLAGS_DECL;
6631
6632     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6633         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6634
6635     /* 1 for each byte + 1 for each byte that expands to two, + trailing NUL */
6636     Newx(dst, *plen_p + variant_under_utf8_count(src, src + *plen_p) + 1, U8);
6637     d = dst;
6638
6639     while (s < *plen_p) {
6640         append_utf8_from_native_byte(src[s], &d);
6641
6642         if (n < num_code_blocks) {
6643             assert(pRExC_state->code_blocks);
6644             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6645                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6646                 assert(*(d - 1) == '(');
6647                 do_end = 1;
6648             }
6649             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6650                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6651                 assert(*(d - 1) == ')');
6652                 do_end = 0;
6653                 n++;
6654             }
6655         }
6656         s++;
6657     }
6658     *d = '\0';
6659     *plen_p = d - dst;
6660     *pat_p = (char*) dst;
6661     SAVEFREEPV(*pat_p);
6662     RExC_orig_utf8 = RExC_utf8 = 1;
6663 }
6664
6665
6666
6667 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6668  * while recording any code block indices, and handling overloading,
6669  * nested qr// objects etc.  If pat is null, it will allocate a new
6670  * string, or just return the first arg, if there's only one.
6671  *
6672  * Returns the malloced/updated pat.
6673  * patternp and pat_count is the array of SVs to be concatted;
6674  * oplist is the optional list of ops that generated the SVs;
6675  * recompile_p is a pointer to a boolean that will be set if
6676  *   the regex will need to be recompiled.
6677  * delim, if non-null is an SV that will be inserted between each element
6678  */
6679
6680 static SV*
6681 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6682                 SV *pat, SV ** const patternp, int pat_count,
6683                 OP *oplist, bool *recompile_p, SV *delim)
6684 {
6685     SV **svp;
6686     int n = 0;
6687     bool use_delim = FALSE;
6688     bool alloced = FALSE;
6689
6690     /* if we know we have at least two args, create an empty string,
6691      * then concatenate args to that. For no args, return an empty string */
6692     if (!pat && pat_count != 1) {
6693         pat = newSVpvs("");
6694         SAVEFREESV(pat);
6695         alloced = TRUE;
6696     }
6697
6698     for (svp = patternp; svp < patternp + pat_count; svp++) {
6699         SV *sv;
6700         SV *rx  = NULL;
6701         STRLEN orig_patlen = 0;
6702         bool code = 0;
6703         SV *msv = use_delim ? delim : *svp;
6704         if (!msv) msv = &PL_sv_undef;
6705
6706         /* if we've got a delimiter, we go round the loop twice for each
6707          * svp slot (except the last), using the delimiter the second
6708          * time round */
6709         if (use_delim) {
6710             svp--;
6711             use_delim = FALSE;
6712         }
6713         else if (delim)
6714             use_delim = TRUE;
6715
6716         if (SvTYPE(msv) == SVt_PVAV) {
6717             /* we've encountered an interpolated array within
6718              * the pattern, e.g. /...@a..../. Expand the list of elements,
6719              * then recursively append elements.
6720              * The code in this block is based on S_pushav() */
6721
6722             AV *const av = (AV*)msv;
6723             const SSize_t maxarg = AvFILL(av) + 1;
6724             SV **array;
6725
6726             if (oplist) {
6727                 assert(oplist->op_type == OP_PADAV
6728                     || oplist->op_type == OP_RV2AV);
6729                 oplist = OpSIBLING(oplist);
6730             }
6731
6732             if (SvRMAGICAL(av)) {
6733                 SSize_t i;
6734
6735                 Newx(array, maxarg, SV*);
6736                 SAVEFREEPV(array);
6737                 for (i=0; i < maxarg; i++) {
6738                     SV ** const svp = av_fetch(av, i, FALSE);
6739                     array[i] = svp ? *svp : &PL_sv_undef;
6740                 }
6741             }
6742             else
6743                 array = AvARRAY(av);
6744
6745             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6746                                 array, maxarg, NULL, recompile_p,
6747                                 /* $" */
6748                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6749
6750             continue;
6751         }
6752
6753
6754         /* we make the assumption here that each op in the list of
6755          * op_siblings maps to one SV pushed onto the stack,
6756          * except for code blocks, with have both an OP_NULL and
6757          * and OP_CONST.
6758          * This allows us to match up the list of SVs against the
6759          * list of OPs to find the next code block.
6760          *
6761          * Note that       PUSHMARK PADSV PADSV ..
6762          * is optimised to
6763          *                 PADRANGE PADSV  PADSV  ..
6764          * so the alignment still works. */
6765
6766         if (oplist) {
6767             if (oplist->op_type == OP_NULL
6768                 && (oplist->op_flags & OPf_SPECIAL))
6769             {
6770                 assert(n < pRExC_state->code_blocks->count);
6771                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6772                 pRExC_state->code_blocks->cb[n].block = oplist;
6773                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6774                 n++;
6775                 code = 1;
6776                 oplist = OpSIBLING(oplist); /* skip CONST */
6777                 assert(oplist);
6778             }
6779             oplist = OpSIBLING(oplist);;
6780         }
6781
6782         /* apply magic and QR overloading to arg */
6783
6784         SvGETMAGIC(msv);
6785         if (SvROK(msv) && SvAMAGIC(msv)) {
6786             SV *sv = AMG_CALLunary(msv, regexp_amg);
6787             if (sv) {
6788                 if (SvROK(sv))
6789                     sv = SvRV(sv);
6790                 if (SvTYPE(sv) != SVt_REGEXP)
6791                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6792                 msv = sv;
6793             }
6794         }
6795
6796         /* try concatenation overload ... */
6797         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6798                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6799         {
6800             sv_setsv(pat, sv);
6801             /* overloading involved: all bets are off over literal
6802              * code. Pretend we haven't seen it */
6803             if (n)
6804                 pRExC_state->code_blocks->count -= n;
6805             n = 0;
6806         }
6807         else  {
6808             /* ... or failing that, try "" overload */
6809             while (SvAMAGIC(msv)
6810                     && (sv = AMG_CALLunary(msv, string_amg))
6811                     && sv != msv
6812                     &&  !(   SvROK(msv)
6813                           && SvROK(sv)
6814                           && SvRV(msv) == SvRV(sv))
6815             ) {
6816                 msv = sv;
6817                 SvGETMAGIC(msv);
6818             }
6819             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6820                 msv = SvRV(msv);
6821
6822             if (pat) {
6823                 /* this is a partially unrolled
6824                  *     sv_catsv_nomg(pat, msv);
6825                  * that allows us to adjust code block indices if
6826                  * needed */
6827                 STRLEN dlen;
6828                 char *dst = SvPV_force_nomg(pat, dlen);
6829                 orig_patlen = dlen;
6830                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6831                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6832                     sv_setpvn(pat, dst, dlen);
6833                     SvUTF8_on(pat);
6834                 }
6835                 sv_catsv_nomg(pat, msv);
6836                 rx = msv;
6837             }
6838             else {
6839                 /* We have only one SV to process, but we need to verify
6840                  * it is properly null terminated or we will fail asserts
6841                  * later. In theory we probably shouldn't get such SV's,
6842                  * but if we do we should handle it gracefully. */
6843                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) || SvIsCOW_shared_hash(msv) ) {
6844                     /* not a string, or a string with a trailing null */
6845                     pat = msv;
6846                 } else {
6847                     /* a string with no trailing null, we need to copy it
6848                      * so it has a trailing null */
6849                     pat = sv_2mortal(newSVsv(msv));
6850                 }
6851             }
6852
6853             if (code)
6854                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
6855         }
6856
6857         /* extract any code blocks within any embedded qr//'s */
6858         if (rx && SvTYPE(rx) == SVt_REGEXP
6859             && RX_ENGINE((REGEXP*)rx)->op_comp)
6860         {
6861
6862             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6863             if (ri->code_blocks && ri->code_blocks->count) {
6864                 int i;
6865                 /* the presence of an embedded qr// with code means
6866                  * we should always recompile: the text of the
6867                  * qr// may not have changed, but it may be a
6868                  * different closure than last time */
6869                 *recompile_p = 1;
6870                 if (pRExC_state->code_blocks) {
6871                     int new_count = pRExC_state->code_blocks->count
6872                             + ri->code_blocks->count;
6873                     Renew(pRExC_state->code_blocks->cb,
6874                             new_count, struct reg_code_block);
6875                     pRExC_state->code_blocks->count = new_count;
6876                 }
6877                 else
6878                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
6879                                                     ri->code_blocks->count);
6880
6881                 for (i=0; i < ri->code_blocks->count; i++) {
6882                     struct reg_code_block *src, *dst;
6883                     STRLEN offset =  orig_patlen
6884                         + ReANY((REGEXP *)rx)->pre_prefix;
6885                     assert(n < pRExC_state->code_blocks->count);
6886                     src = &ri->code_blocks->cb[i];
6887                     dst = &pRExC_state->code_blocks->cb[n];
6888                     dst->start      = src->start + offset;
6889                     dst->end        = src->end   + offset;
6890                     dst->block      = src->block;
6891                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6892                                             src->src_regex
6893                                                 ? src->src_regex
6894                                                 : (REGEXP*)rx);
6895                     n++;
6896                 }
6897             }
6898         }
6899     }
6900     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6901     if (alloced)
6902         SvSETMAGIC(pat);
6903
6904     return pat;
6905 }
6906
6907
6908
6909 /* see if there are any run-time code blocks in the pattern.
6910  * False positives are allowed */
6911
6912 static bool
6913 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6914                     char *pat, STRLEN plen)
6915 {
6916     int n = 0;
6917     STRLEN s;
6918
6919     PERL_UNUSED_CONTEXT;
6920
6921     for (s = 0; s < plen; s++) {
6922         if (   pRExC_state->code_blocks
6923             && n < pRExC_state->code_blocks->count
6924             && s == pRExC_state->code_blocks->cb[n].start)
6925         {
6926             s = pRExC_state->code_blocks->cb[n].end;
6927             n++;
6928             continue;
6929         }
6930         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6931          * positives here */
6932         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6933             (pat[s+2] == '{'
6934                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6935         )
6936             return 1;
6937     }
6938     return 0;
6939 }
6940
6941 /* Handle run-time code blocks. We will already have compiled any direct
6942  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6943  * copy of it, but with any literal code blocks blanked out and
6944  * appropriate chars escaped; then feed it into
6945  *
6946  *    eval "qr'modified_pattern'"
6947  *
6948  * For example,
6949  *
6950  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6951  *
6952  * becomes
6953  *
6954  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6955  *
6956  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6957  * and merge them with any code blocks of the original regexp.
6958  *
6959  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6960  * instead, just save the qr and return FALSE; this tells our caller that
6961  * the original pattern needs upgrading to utf8.
6962  */
6963
6964 static bool
6965 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6966     char *pat, STRLEN plen)
6967 {
6968     SV *qr;
6969
6970     GET_RE_DEBUG_FLAGS_DECL;
6971
6972     if (pRExC_state->runtime_code_qr) {
6973         /* this is the second time we've been called; this should
6974          * only happen if the main pattern got upgraded to utf8
6975          * during compilation; re-use the qr we compiled first time
6976          * round (which should be utf8 too)
6977          */
6978         qr = pRExC_state->runtime_code_qr;
6979         pRExC_state->runtime_code_qr = NULL;
6980         assert(RExC_utf8 && SvUTF8(qr));
6981     }
6982     else {
6983         int n = 0;
6984         STRLEN s;
6985         char *p, *newpat;
6986         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
6987         SV *sv, *qr_ref;
6988         dSP;
6989
6990         /* determine how many extra chars we need for ' and \ escaping */
6991         for (s = 0; s < plen; s++) {
6992             if (pat[s] == '\'' || pat[s] == '\\')
6993                 newlen++;
6994         }
6995
6996         Newx(newpat, newlen, char);
6997         p = newpat;
6998         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6999
7000         for (s = 0; s < plen; s++) {
7001             if (   pRExC_state->code_blocks
7002                 && n < pRExC_state->code_blocks->count
7003                 && s == pRExC_state->code_blocks->cb[n].start)
7004             {
7005                 /* blank out literal code block so that they aren't
7006                  * recompiled: eg change from/to:
7007                  *     /(?{xyz})/
7008                  *     /(?=====)/
7009                  * and
7010                  *     /(??{xyz})/
7011                  *     /(?======)/
7012                  * and
7013                  *     /(?(?{xyz}))/
7014                  *     /(?(?=====))/
7015                 */
7016                 assert(pat[s]   == '(');
7017                 assert(pat[s+1] == '?');
7018                 *p++ = '(';
7019                 *p++ = '?';
7020                 s += 2;
7021                 while (s < pRExC_state->code_blocks->cb[n].end) {
7022                     *p++ = '=';
7023                     s++;
7024                 }
7025                 *p++ = ')';
7026                 n++;
7027                 continue;
7028             }
7029             if (pat[s] == '\'' || pat[s] == '\\')
7030                 *p++ = '\\';
7031             *p++ = pat[s];
7032         }
7033         *p++ = '\'';
7034         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
7035             *p++ = 'x';
7036             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
7037                 *p++ = 'x';
7038             }
7039         }
7040         *p++ = '\0';
7041         DEBUG_COMPILE_r({
7042             Perl_re_printf( aTHX_
7043                 "%sre-parsing pattern for runtime code:%s %s\n",
7044                 PL_colors[4], PL_colors[5], newpat);
7045         });
7046
7047         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
7048         Safefree(newpat);
7049
7050         ENTER;
7051         SAVETMPS;
7052         save_re_context();
7053         PUSHSTACKi(PERLSI_REQUIRE);
7054         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
7055          * parsing qr''; normally only q'' does this. It also alters
7056          * hints handling */
7057         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
7058         SvREFCNT_dec_NN(sv);
7059         SPAGAIN;
7060         qr_ref = POPs;
7061         PUTBACK;
7062         {
7063             SV * const errsv = ERRSV;
7064             if (SvTRUE_NN(errsv))
7065                 /* use croak_sv ? */
7066                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
7067         }
7068         assert(SvROK(qr_ref));
7069         qr = SvRV(qr_ref);
7070         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
7071         /* the leaving below frees the tmp qr_ref.
7072          * Give qr a life of its own */
7073         SvREFCNT_inc(qr);
7074         POPSTACK;
7075         FREETMPS;
7076         LEAVE;
7077
7078     }
7079
7080     if (!RExC_utf8 && SvUTF8(qr)) {
7081         /* first time through; the pattern got upgraded; save the
7082          * qr for the next time through */
7083         assert(!pRExC_state->runtime_code_qr);
7084         pRExC_state->runtime_code_qr = qr;
7085         return 0;
7086     }
7087
7088
7089     /* extract any code blocks within the returned qr//  */
7090
7091
7092     /* merge the main (r1) and run-time (r2) code blocks into one */
7093     {
7094         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
7095         struct reg_code_block *new_block, *dst;
7096         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
7097         int i1 = 0, i2 = 0;
7098         int r1c, r2c;
7099
7100         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
7101         {
7102             SvREFCNT_dec_NN(qr);
7103             return 1;
7104         }
7105
7106         if (!r1->code_blocks)
7107             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
7108
7109         r1c = r1->code_blocks->count;
7110         r2c = r2->code_blocks->count;
7111
7112         Newx(new_block, r1c + r2c, struct reg_code_block);
7113
7114         dst = new_block;
7115
7116         while (i1 < r1c || i2 < r2c) {
7117             struct reg_code_block *src;
7118             bool is_qr = 0;
7119
7120             if (i1 == r1c) {
7121                 src = &r2->code_blocks->cb[i2++];
7122                 is_qr = 1;
7123             }
7124             else if (i2 == r2c)
7125                 src = &r1->code_blocks->cb[i1++];
7126             else if (  r1->code_blocks->cb[i1].start
7127                      < r2->code_blocks->cb[i2].start)
7128             {
7129                 src = &r1->code_blocks->cb[i1++];
7130                 assert(src->end < r2->code_blocks->cb[i2].start);
7131             }
7132             else {
7133                 assert(  r1->code_blocks->cb[i1].start
7134                        > r2->code_blocks->cb[i2].start);
7135                 src = &r2->code_blocks->cb[i2++];
7136                 is_qr = 1;
7137                 assert(src->end < r1->code_blocks->cb[i1].start);
7138             }
7139
7140             assert(pat[src->start] == '(');
7141             assert(pat[src->end]   == ')');
7142             dst->start      = src->start;
7143             dst->end        = src->end;
7144             dst->block      = src->block;
7145             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
7146                                     : src->src_regex;
7147             dst++;
7148         }
7149         r1->code_blocks->count += r2c;
7150         Safefree(r1->code_blocks->cb);
7151         r1->code_blocks->cb = new_block;
7152     }
7153
7154     SvREFCNT_dec_NN(qr);
7155     return 1;
7156 }
7157
7158
7159 STATIC bool
7160 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
7161                       struct reg_substr_datum  *rsd,
7162                       struct scan_data_substrs *sub,
7163                       STRLEN longest_length)
7164 {
7165     /* This is the common code for setting up the floating and fixed length
7166      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
7167      * as to whether succeeded or not */
7168
7169     I32 t;
7170     SSize_t ml;
7171     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
7172     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
7173
7174     if (! (longest_length
7175            || (eol /* Can't have SEOL and MULTI */
7176                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
7177           )
7178             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
7179         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
7180     {
7181         return FALSE;
7182     }
7183
7184     /* copy the information about the longest from the reg_scan_data
7185         over to the program. */
7186     if (SvUTF8(sub->str)) {
7187         rsd->substr      = NULL;
7188         rsd->utf8_substr = sub->str;
7189     } else {
7190         rsd->substr      = sub->str;
7191         rsd->utf8_substr = NULL;
7192     }
7193     /* end_shift is how many chars that must be matched that
7194         follow this item. We calculate it ahead of time as once the
7195         lookbehind offset is added in we lose the ability to correctly
7196         calculate it.*/
7197     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
7198     rsd->end_shift = ml - sub->min_offset
7199         - longest_length
7200             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
7201              * intead? - DAPM
7202             + (SvTAIL(sub->str) != 0)
7203             */
7204         + sub->lookbehind;
7205
7206     t = (eol/* Can't have SEOL and MULTI */
7207          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
7208     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
7209
7210     return TRUE;
7211 }
7212
7213 STATIC void
7214 S_set_regex_pv(pTHX_ RExC_state_t *pRExC_state, REGEXP *Rx)
7215 {
7216     /* Calculates and sets in the compiled pattern 'Rx' the string to compile,
7217      * properly wrapped with the right modifiers */
7218
7219     bool has_p     = ((RExC_rx->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7220     bool has_charset = RExC_utf8 || (get_regex_charset(RExC_rx->extflags)
7221                                                 != REGEX_DEPENDS_CHARSET);
7222
7223     /* The caret is output if there are any defaults: if not all the STD
7224         * flags are set, or if no character set specifier is needed */
7225     bool has_default =
7226                 (((RExC_rx->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7227                 || ! has_charset);
7228     bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7229                                                 == REG_RUN_ON_COMMENT_SEEN);
7230     U8 reganch = (U8)((RExC_rx->extflags & RXf_PMf_STD_PMMOD)
7231                         >> RXf_PMf_STD_PMMOD_SHIFT);
7232     const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7233     char *p;
7234     STRLEN pat_len = RExC_precomp_end - RExC_precomp;
7235
7236     /* We output all the necessary flags; we never output a minus, as all
7237         * those are defaults, so are
7238         * covered by the caret */
7239     const STRLEN wraplen = pat_len + has_p + has_runon
7240         + has_default       /* If needs a caret */
7241         + PL_bitcount[reganch] /* 1 char for each set standard flag */
7242
7243             /* If needs a character set specifier */
7244         + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7245         + (sizeof("(?:)") - 1);
7246
7247     PERL_ARGS_ASSERT_SET_REGEX_PV;
7248
7249     /* make sure PL_bitcount bounds not exceeded */
7250     assert(sizeof(STD_PAT_MODS) <= 8);
7251
7252     p = sv_grow(MUTABLE_SV(Rx), wraplen + 1); /* +1 for the ending NUL */
7253     SvPOK_on(Rx);
7254     if (RExC_utf8)
7255         SvFLAGS(Rx) |= SVf_UTF8;
7256     *p++='('; *p++='?';
7257
7258     /* If a default, cover it using the caret */
7259     if (has_default) {
7260         *p++= DEFAULT_PAT_MOD;
7261     }
7262     if (has_charset) {
7263         STRLEN len;
7264         const char* name;
7265
7266         name = get_regex_charset_name(RExC_rx->extflags, &len);
7267         if (strEQ(name, DEPENDS_PAT_MODS)) {  /* /d under UTF-8 => /u */
7268             assert(RExC_utf8);
7269             name = UNICODE_PAT_MODS;
7270             len = sizeof(UNICODE_PAT_MODS) - 1;
7271         }
7272         Copy(name, p, len, char);
7273         p += len;
7274     }
7275     if (has_p)
7276         *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7277     {
7278         char ch;
7279         while((ch = *fptr++)) {
7280             if(reganch & 1)
7281                 *p++ = ch;
7282             reganch >>= 1;
7283         }
7284     }
7285
7286     *p++ = ':';
7287     Copy(RExC_precomp, p, pat_len, char);
7288     assert ((RX_WRAPPED(Rx) - p) < 16);
7289     RExC_rx->pre_prefix = p - RX_WRAPPED(Rx);
7290     p += pat_len;
7291
7292     /* Adding a trailing \n causes this to compile properly:
7293             my $R = qr / A B C # D E/x; /($R)/
7294         Otherwise the parens are considered part of the comment */
7295     if (has_runon)
7296         *p++ = '\n';
7297     *p++ = ')';
7298     *p = 0;
7299     SvCUR_set(Rx, p - RX_WRAPPED(Rx));
7300 }
7301
7302 /*
7303  * Perl_re_op_compile - the perl internal RE engine's function to compile a
7304  * regular expression into internal code.
7305  * The pattern may be passed either as:
7306  *    a list of SVs (patternp plus pat_count)
7307  *    a list of OPs (expr)
7308  * If both are passed, the SV list is used, but the OP list indicates
7309  * which SVs are actually pre-compiled code blocks
7310  *
7311  * The SVs in the list have magic and qr overloading applied to them (and
7312  * the list may be modified in-place with replacement SVs in the latter
7313  * case).
7314  *
7315  * If the pattern hasn't changed from old_re, then old_re will be
7316  * returned.
7317  *
7318  * eng is the current engine. If that engine has an op_comp method, then
7319  * handle directly (i.e. we assume that op_comp was us); otherwise, just
7320  * do the initial concatenation of arguments and pass on to the external
7321  * engine.
7322  *
7323  * If is_bare_re is not null, set it to a boolean indicating whether the
7324  * arg list reduced (after overloading) to a single bare regex which has
7325  * been returned (i.e. /$qr/).
7326  *
7327  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
7328  *
7329  * pm_flags contains the PMf_* flags, typically based on those from the
7330  * pm_flags field of the related PMOP. Currently we're only interested in
7331  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
7332  *
7333  * For many years this code had an initial sizing pass that calculated
7334  * (sometimes incorrectly, leading to security holes) the size needed for the
7335  * compiled pattern.  That was changed by commit
7336  * 7c932d07cab18751bfc7515b4320436273a459e2 in 5.29, which reallocs the size, a
7337  * node at a time, as parsing goes along.  Patches welcome to fix any obsolete
7338  * references to this sizing pass.
7339  *
7340  * Now, an initial crude guess as to the size needed is made, based on the
7341  * length of the pattern.  Patches welcome to improve that guess.  That amount
7342  * of space is malloc'd and then immediately freed, and then clawed back node
7343  * by node.  This design is to minimze, to the extent possible, memory churn
7344  * when doing the the reallocs.
7345  *
7346  * A separate parentheses counting pass may be needed in some cases.
7347  * (Previously the sizing pass did this.)  Patches welcome to reduce the number
7348  * of these cases.
7349  *
7350  * The existence of a sizing pass necessitated design decisions that are no
7351  * longer needed.  There are potential areas of simplification.
7352  *
7353  * Beware that the optimization-preparation code in here knows about some
7354  * of the structure of the compiled regexp.  [I'll say.]
7355  */
7356
7357 REGEXP *
7358 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
7359                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
7360                      bool *is_bare_re, const U32 orig_rx_flags, const U32 pm_flags)
7361 {
7362     dVAR;
7363     REGEXP *Rx;         /* Capital 'R' means points to a REGEXP */
7364     STRLEN plen;
7365     char *exp;
7366     regnode *scan;
7367     I32 flags;
7368     SSize_t minlen = 0;
7369     U32 rx_flags;
7370     SV *pat;
7371     SV** new_patternp = patternp;
7372
7373     /* these are all flags - maybe they should be turned
7374      * into a single int with different bit masks */
7375     I32 sawlookahead = 0;
7376     I32 sawplus = 0;
7377     I32 sawopen = 0;
7378     I32 sawminmod = 0;
7379
7380     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
7381     bool recompile = 0;
7382     bool runtime_code = 0;
7383     scan_data_t data;
7384     RExC_state_t RExC_state;
7385     RExC_state_t * const pRExC_state = &RExC_state;
7386 #ifdef TRIE_STUDY_OPT
7387     int restudied = 0;
7388     RExC_state_t copyRExC_state;
7389 #endif
7390     GET_RE_DEBUG_FLAGS_DECL;
7391
7392     PERL_ARGS_ASSERT_RE_OP_COMPILE;
7393
7394     DEBUG_r(if (!PL_colorset) reginitcolors());
7395
7396     /* Initialize these here instead of as-needed, as is quick and avoids
7397      * having to test them each time otherwise */
7398     if (! PL_InBitmap) {
7399 #ifdef DEBUGGING
7400         char * dump_len_string;
7401 #endif
7402
7403         /* This is calculated here, because the Perl program that generates the
7404          * static global ones doesn't currently have access to
7405          * NUM_ANYOF_CODE_POINTS */
7406         PL_InBitmap = _new_invlist(2);
7407         PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
7408                                                     NUM_ANYOF_CODE_POINTS - 1);
7409 #ifdef DEBUGGING
7410         dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
7411         if (   ! dump_len_string
7412             || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
7413         {
7414             PL_dump_re_max_len = 60;    /* A reasonable default */
7415         }
7416 #endif
7417     }
7418
7419     pRExC_state->warn_text = NULL;
7420     pRExC_state->unlexed_names = NULL;
7421     pRExC_state->code_blocks = NULL;
7422
7423     if (is_bare_re)
7424         *is_bare_re = FALSE;
7425
7426     if (expr && (expr->op_type == OP_LIST ||
7427                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
7428         /* allocate code_blocks if needed */
7429         OP *o;
7430         int ncode = 0;
7431
7432         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
7433             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
7434                 ncode++; /* count of DO blocks */
7435
7436         if (ncode)
7437             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
7438     }
7439
7440     if (!pat_count) {
7441         /* compile-time pattern with just OP_CONSTs and DO blocks */
7442
7443         int n;
7444         OP *o;
7445
7446         /* find how many CONSTs there are */
7447         assert(expr);
7448         n = 0;
7449         if (expr->op_type == OP_CONST)
7450             n = 1;
7451         else
7452             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7453                 if (o->op_type == OP_CONST)
7454                     n++;
7455             }
7456
7457         /* fake up an SV array */
7458
7459         assert(!new_patternp);
7460         Newx(new_patternp, n, SV*);
7461         SAVEFREEPV(new_patternp);
7462         pat_count = n;
7463
7464         n = 0;
7465         if (expr->op_type == OP_CONST)
7466             new_patternp[n] = cSVOPx_sv(expr);
7467         else
7468             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7469                 if (o->op_type == OP_CONST)
7470                     new_patternp[n++] = cSVOPo_sv;
7471             }
7472
7473     }
7474
7475     DEBUG_PARSE_r(Perl_re_printf( aTHX_
7476         "Assembling pattern from %d elements%s\n", pat_count,
7477             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7478
7479     /* set expr to the first arg op */
7480
7481     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
7482          && expr->op_type != OP_CONST)
7483     {
7484             expr = cLISTOPx(expr)->op_first;
7485             assert(   expr->op_type == OP_PUSHMARK
7486                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
7487                    || expr->op_type == OP_PADRANGE);
7488             expr = OpSIBLING(expr);
7489     }
7490
7491     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
7492                         expr, &recompile, NULL);
7493
7494     /* handle bare (possibly after overloading) regex: foo =~ $re */
7495     {
7496         SV *re = pat;
7497         if (SvROK(re))
7498             re = SvRV(re);
7499         if (SvTYPE(re) == SVt_REGEXP) {
7500             if (is_bare_re)
7501                 *is_bare_re = TRUE;
7502             SvREFCNT_inc(re);
7503             DEBUG_PARSE_r(Perl_re_printf( aTHX_
7504                 "Precompiled pattern%s\n",
7505                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7506
7507             return (REGEXP*)re;
7508         }
7509     }
7510
7511     exp = SvPV_nomg(pat, plen);
7512
7513     if (!eng->op_comp) {
7514         if ((SvUTF8(pat) && IN_BYTES)
7515                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7516         {
7517             /* make a temporary copy; either to convert to bytes,
7518              * or to avoid repeating get-magic / overloaded stringify */
7519             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7520                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7521         }
7522         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7523     }
7524
7525     /* ignore the utf8ness if the pattern is 0 length */
7526     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7527     RExC_uni_semantics = 0;
7528     RExC_contains_locale = 0;
7529     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7530     RExC_in_script_run = 0;
7531     RExC_study_started = 0;
7532     pRExC_state->runtime_code_qr = NULL;
7533     RExC_frame_head= NULL;
7534     RExC_frame_last= NULL;
7535     RExC_frame_count= 0;
7536     RExC_latest_warn_offset = 0;
7537     RExC_use_BRANCHJ = 0;
7538     RExC_total_parens = 0;
7539     RExC_open_parens = NULL;
7540     RExC_close_parens = NULL;
7541     RExC_paren_names = NULL;
7542     RExC_size = 0;
7543     RExC_seen_d_op = FALSE;
7544 #ifdef DEBUGGING
7545     RExC_paren_name_list = NULL;
7546 #endif
7547
7548     DEBUG_r({
7549         RExC_mysv1= sv_newmortal();
7550         RExC_mysv2= sv_newmortal();
7551     });
7552
7553     DEBUG_COMPILE_r({
7554             SV *dsv= sv_newmortal();
7555             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7556             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7557                           PL_colors[4], PL_colors[5], s);
7558         });
7559
7560     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7561      * to utf8 */
7562
7563     if ((pm_flags & PMf_USE_RE_EVAL)
7564                 /* this second condition covers the non-regex literal case,
7565                  * i.e.  $foo =~ '(?{})'. */
7566                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7567     )
7568         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7569
7570   redo_parse:
7571     /* return old regex if pattern hasn't changed */
7572     /* XXX: note in the below we have to check the flags as well as the
7573      * pattern.
7574      *
7575      * Things get a touch tricky as we have to compare the utf8 flag
7576      * independently from the compile flags.  */
7577
7578     if (   old_re
7579         && !recompile
7580         && !!RX_UTF8(old_re) == !!RExC_utf8
7581         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7582         && RX_PRECOMP(old_re)
7583         && RX_PRELEN(old_re) == plen
7584         && memEQ(RX_PRECOMP(old_re), exp, plen)
7585         && !runtime_code /* with runtime code, always recompile */ )
7586     {
7587         DEBUG_COMPILE_r({
7588             SV *dsv= sv_newmortal();
7589             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7590             Perl_re_printf( aTHX_  "%sSkipping recompilation of unchanged REx%s %s\n",
7591                           PL_colors[4], PL_colors[5], s);
7592         });
7593         return old_re;
7594     }
7595
7596     /* Allocate the pattern's SV */
7597     RExC_rx_sv = Rx = (REGEXP*) newSV_type(SVt_REGEXP);
7598     RExC_rx = ReANY(Rx);
7599     if ( RExC_rx == NULL )
7600         FAIL("Regexp out of space");
7601
7602     rx_flags = orig_rx_flags;
7603
7604     if (   (UTF || RExC_uni_semantics)
7605         && initial_charset == REGEX_DEPENDS_CHARSET)
7606     {
7607
7608         /* Set to use unicode semantics if the pattern is in utf8 and has the
7609          * 'depends' charset specified, as it means unicode when utf8  */
7610         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7611         RExC_uni_semantics = 1;
7612     }
7613
7614     RExC_pm_flags = pm_flags;
7615
7616     if (runtime_code) {
7617         assert(TAINTING_get || !TAINT_get);
7618         if (TAINT_get)
7619             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7620
7621         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7622             /* whoops, we have a non-utf8 pattern, whilst run-time code
7623              * got compiled as utf8. Try again with a utf8 pattern */
7624             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7625                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7626             goto redo_parse;
7627         }
7628     }
7629     assert(!pRExC_state->runtime_code_qr);
7630
7631     RExC_sawback = 0;
7632
7633     RExC_seen = 0;
7634     RExC_maxlen = 0;
7635     RExC_in_lookbehind = 0;
7636     RExC_in_lookahead = 0;
7637     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7638     RExC_recode_x_to_native = 0;
7639     RExC_in_multi_char_class = 0;
7640
7641     RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = RExC_precomp = exp;
7642     RExC_precomp_end = RExC_end = exp + plen;
7643     RExC_nestroot = 0;
7644     RExC_whilem_seen = 0;
7645     RExC_end_op = NULL;
7646     RExC_recurse = NULL;
7647     RExC_study_chunk_recursed = NULL;
7648     RExC_study_chunk_recursed_bytes= 0;
7649     RExC_recurse_count = 0;
7650     pRExC_state->code_index = 0;
7651
7652     /* Initialize the string in the compiled pattern.  This is so that there is
7653      * something to output if necessary */
7654     set_regex_pv(pRExC_state, Rx);
7655
7656     DEBUG_PARSE_r({
7657         Perl_re_printf( aTHX_
7658             "Starting parse and generation\n");
7659         RExC_lastnum=0;
7660         RExC_lastparse=NULL;
7661     });
7662
7663     /* Allocate space and zero-initialize. Note, the two step process
7664        of zeroing when in debug mode, thus anything assigned has to
7665        happen after that */
7666     if (!  RExC_size) {
7667
7668         /* On the first pass of the parse, we guess how big this will be.  Then
7669          * we grow in one operation to that amount and then give it back.  As
7670          * we go along, we re-allocate what we need.
7671          *
7672          * XXX Currently the guess is essentially that the pattern will be an
7673          * EXACT node with one byte input, one byte output.  This is crude, and
7674          * better heuristics are welcome.
7675          *
7676          * On any subsequent passes, we guess what we actually computed in the
7677          * latest earlier pass.  Such a pass probably didn't complete so is
7678          * missing stuff.  We could improve those guesses by knowing where the
7679          * parse stopped, and use the length so far plus apply the above
7680          * assumption to what's left. */
7681         RExC_size = STR_SZ(RExC_end - RExC_start);
7682     }
7683
7684     Newxc(RExC_rxi, sizeof(regexp_internal) + RExC_size, char, regexp_internal);
7685     if ( RExC_rxi == NULL )
7686         FAIL("Regexp out of space");
7687
7688     Zero(RExC_rxi, sizeof(regexp_internal) + RExC_size, char);
7689     RXi_SET( RExC_rx, RExC_rxi );
7690
7691     /* We start from 0 (over from 0 in the case this is a reparse.  The first
7692      * node parsed will give back any excess memory we have allocated so far).
7693      * */
7694     RExC_size = 0;
7695
7696     /* non-zero initialization begins here */
7697     RExC_rx->engine= eng;
7698     RExC_rx->extflags = rx_flags;
7699     RXp_COMPFLAGS(RExC_rx) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7700
7701     if (pm_flags & PMf_IS_QR) {
7702         RExC_rxi->code_blocks = pRExC_state->code_blocks;
7703         if (RExC_rxi->code_blocks) {
7704             RExC_rxi->code_blocks->refcnt++;
7705         }
7706     }
7707
7708     RExC_rx->intflags = 0;
7709
7710     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7711     RExC_parse = exp;
7712
7713     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7714      * code makes sure the final byte is an uncounted NUL.  But should this
7715      * ever not be the case, lots of things could read beyond the end of the
7716      * buffer: loops like
7717      *      while(isFOO(*RExC_parse)) RExC_parse++;
7718      *      strchr(RExC_parse, "foo");
7719      * etc.  So it is worth noting. */
7720     assert(*RExC_end == '\0');
7721
7722     RExC_naughty = 0;
7723     RExC_npar = 1;
7724     RExC_parens_buf_size = 0;
7725     RExC_emit_start = RExC_rxi->program;
7726     pRExC_state->code_index = 0;
7727
7728     *((char*) RExC_emit_start) = (char) REG_MAGIC;
7729     RExC_emit = 1;
7730
7731     /* Do the parse */
7732     if (reg(pRExC_state, 0, &flags, 1)) {
7733
7734         /* Success!, But we may need to redo the parse knowing how many parens
7735          * there actually are */
7736         if (IN_PARENS_PASS) {
7737             flags |= RESTART_PARSE;
7738         }
7739
7740         /* We have that number in RExC_npar */
7741         RExC_total_parens = RExC_npar;
7742     }
7743     else if (! MUST_RESTART(flags)) {
7744         ReREFCNT_dec(Rx);
7745         Perl_croak(aTHX_ "panic: reg returned failure to re_op_compile, flags=%#" UVxf, (UV) flags);
7746     }
7747
7748     /* Here, we either have success, or we have to redo the parse for some reason */
7749     if (MUST_RESTART(flags)) {
7750
7751         /* It's possible to write a regexp in ascii that represents Unicode
7752         codepoints outside of the byte range, such as via \x{100}. If we
7753         detect such a sequence we have to convert the entire pattern to utf8
7754         and then recompile, as our sizing calculation will have been based
7755         on 1 byte == 1 character, but we will need to use utf8 to encode
7756         at least some part of the pattern, and therefore must convert the whole
7757         thing.
7758         -- dmq */
7759         if (flags & NEED_UTF8) {
7760
7761             /* We have stored the offset of the final warning output so far.
7762              * That must be adjusted.  Any variant characters between the start
7763              * of the pattern and this warning count for 2 bytes in the final,
7764              * so just add them again */
7765             if (UNLIKELY(RExC_latest_warn_offset > 0)) {
7766                 RExC_latest_warn_offset +=
7767                             variant_under_utf8_count((U8 *) exp, (U8 *) exp
7768                                                 + RExC_latest_warn_offset);
7769             }
7770             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7771             pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7772             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse after upgrade\n"));
7773         }
7774         else {
7775             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse\n"));
7776         }
7777
7778         if (ALL_PARENS_COUNTED) {
7779             /* Make enough room for all the known parens, and zero it */
7780             Renew(RExC_open_parens, RExC_total_parens, regnode_offset);
7781             Zero(RExC_open_parens, RExC_total_parens, regnode_offset);
7782             RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
7783
7784             Renew(RExC_close_parens, RExC_total_parens, regnode_offset);
7785             Zero(RExC_close_parens, RExC_total_parens, regnode_offset);
7786         }
7787         else { /* Parse did not complete.  Reinitialize the parentheses
7788                   structures */
7789             RExC_total_parens = 0;
7790             if (RExC_open_parens) {
7791                 Safefree(RExC_open_parens);
7792                 RExC_open_parens = NULL;
7793             }
7794             if (RExC_close_parens) {
7795                 Safefree(RExC_close_parens);
7796                 RExC_close_parens = NULL;
7797             }
7798         }
7799
7800         /* Clean up what we did in this parse */
7801         SvREFCNT_dec_NN(RExC_rx_sv);
7802
7803         goto redo_parse;
7804     }
7805
7806     /* Here, we have successfully parsed and generated the pattern's program
7807      * for the regex engine.  We are ready to finish things up and look for
7808      * optimizations. */
7809
7810     /* Update the string to compile, with correct modifiers, etc */
7811     set_regex_pv(pRExC_state, Rx);
7812
7813     RExC_rx->nparens = RExC_total_parens - 1;
7814
7815     /* Uses the upper 4 bits of the FLAGS field, so keep within that size */
7816     if (RExC_whilem_seen > 15)
7817         RExC_whilem_seen = 15;
7818
7819     DEBUG_PARSE_r({
7820         Perl_re_printf( aTHX_
7821             "Required size %" IVdf " nodes\n", (IV)RExC_size);
7822         RExC_lastnum=0;
7823         RExC_lastparse=NULL;
7824     });
7825
7826 #ifdef RE_TRACK_PATTERN_OFFSETS
7827     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7828                           "%s %" UVuf " bytes for offset annotations.\n",
7829                           RExC_offsets ? "Got" : "Couldn't get",
7830                           (UV)((RExC_offsets[0] * 2 + 1))));
7831     DEBUG_OFFSETS_r(if (RExC_offsets) {
7832         const STRLEN len = RExC_offsets[0];
7833         STRLEN i;
7834         GET_RE_DEBUG_FLAGS_DECL;
7835         Perl_re_printf( aTHX_
7836                       "Offsets: [%" UVuf "]\n\t", (UV)RExC_offsets[0]);
7837         for (i = 1; i <= len; i++) {
7838             if (RExC_offsets[i*2-1] || RExC_offsets[i*2])
7839                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7840                 (UV)i, (UV)RExC_offsets[i*2-1], (UV)RExC_offsets[i*2]);
7841         }
7842         Perl_re_printf( aTHX_  "\n");
7843     });
7844
7845 #else
7846     SetProgLen(RExC_rxi,RExC_size);
7847 #endif
7848
7849     DEBUG_DUMP_PRE_OPTIMIZE_r({
7850         SV * const sv = sv_newmortal();
7851         RXi_GET_DECL(RExC_rx, ri);
7852         DEBUG_RExC_seen();
7853         Perl_re_printf( aTHX_ "Program before optimization:\n");
7854
7855         (void)dumpuntil(RExC_rx, ri->program, ri->program + 1, NULL, NULL,
7856                         sv, 0, 0);
7857     });
7858
7859     DEBUG_OPTIMISE_r(
7860         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
7861     );
7862
7863     /* XXXX To minimize changes to RE engine we always allocate
7864        3-units-long substrs field. */
7865     Newx(RExC_rx->substrs, 1, struct reg_substr_data);
7866     if (RExC_recurse_count) {
7867         Newx(RExC_recurse, RExC_recurse_count, regnode *);
7868         SAVEFREEPV(RExC_recurse);
7869     }
7870
7871     if (RExC_seen & REG_RECURSE_SEEN) {
7872         /* Note, RExC_total_parens is 1 + the number of parens in a pattern.
7873          * So its 1 if there are no parens. */
7874         RExC_study_chunk_recursed_bytes= (RExC_total_parens >> 3) +
7875                                          ((RExC_total_parens & 0x07) != 0);
7876         Newx(RExC_study_chunk_recursed,
7877              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
7878         SAVEFREEPV(RExC_study_chunk_recursed);
7879     }
7880
7881   reStudy:
7882     RExC_rx->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
7883     DEBUG_r(
7884         RExC_study_chunk_recursed_count= 0;
7885     );
7886     Zero(RExC_rx->substrs, 1, struct reg_substr_data);
7887     if (RExC_study_chunk_recursed) {
7888         Zero(RExC_study_chunk_recursed,
7889              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
7890     }
7891
7892
7893 #ifdef TRIE_STUDY_OPT
7894     if (!restudied) {
7895         StructCopy(&zero_scan_data, &data, scan_data_t);
7896         copyRExC_state = RExC_state;
7897     } else {
7898         U32 seen=RExC_seen;
7899         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
7900
7901         RExC_state = copyRExC_state;
7902         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
7903             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
7904         else
7905             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
7906         StructCopy(&zero_scan_data, &data, scan_data_t);
7907     }
7908 #else
7909     StructCopy(&zero_scan_data, &data, scan_data_t);
7910 #endif
7911
7912     /* Dig out information for optimizations. */
7913     RExC_rx->extflags = RExC_flags; /* was pm_op */
7914     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
7915
7916     if (UTF)
7917         SvUTF8_on(Rx);  /* Unicode in it? */
7918     RExC_rxi->regstclass = NULL;
7919     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
7920         RExC_rx->intflags |= PREGf_NAUGHTY;
7921     scan = RExC_rxi->program + 1;               /* First BRANCH. */
7922
7923     /* testing for BRANCH here tells us whether there is "must appear"
7924        data in the pattern. If there is then we can use it for optimisations */
7925     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
7926                                                   */
7927         SSize_t fake;
7928         STRLEN longest_length[2];
7929         regnode_ssc ch_class; /* pointed to by data */
7930         int stclass_flag;
7931         SSize_t last_close = 0; /* pointed to by data */
7932         regnode *first= scan;
7933         regnode *first_next= regnext(first);
7934         int i;
7935
7936         /*
7937          * Skip introductions and multiplicators >= 1
7938          * so that we can extract the 'meat' of the pattern that must
7939          * match in the large if() sequence following.
7940          * NOTE that EXACT is NOT covered here, as it is normally
7941          * picked up by the optimiser separately.
7942          *
7943          * This is unfortunate as the optimiser isnt handling lookahead
7944          * properly currently.
7945          *
7946          */
7947         while ((OP(first) == OPEN && (sawopen = 1)) ||
7948                /* An OR of *one* alternative - should not happen now. */
7949             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
7950             /* for now we can't handle lookbehind IFMATCH*/
7951             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
7952             (OP(first) == PLUS) ||
7953             (OP(first) == MINMOD) ||
7954                /* An {n,m} with n>0 */
7955             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
7956             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
7957         {
7958                 /*
7959                  * the only op that could be a regnode is PLUS, all the rest
7960                  * will be regnode_1 or regnode_2.
7961                  *
7962                  * (yves doesn't think this is true)
7963                  */
7964                 if (OP(first) == PLUS)
7965                     sawplus = 1;
7966                 else {
7967                     if (OP(first) == MINMOD)
7968                         sawminmod = 1;
7969                     first += regarglen[OP(first)];
7970                 }
7971                 first = NEXTOPER(first);
7972                 first_next= regnext(first);
7973         }
7974
7975         /* Starting-point info. */
7976       again:
7977         DEBUG_PEEP("first:", first, 0, 0);
7978         /* Ignore EXACT as we deal with it later. */
7979         if (PL_regkind[OP(first)] == EXACT) {
7980             if (   OP(first) == EXACT
7981                 || OP(first) == EXACT_ONLY8
7982                 || OP(first) == EXACTL)
7983             {
7984                 NOOP;   /* Empty, get anchored substr later. */
7985             }
7986             else
7987                 RExC_rxi->regstclass = first;
7988         }
7989 #ifdef TRIE_STCLASS
7990         else if (PL_regkind[OP(first)] == TRIE &&
7991                 ((reg_trie_data *)RExC_rxi->data->data[ ARG(first) ])->minlen>0)
7992         {
7993             /* this can happen only on restudy */
7994             RExC_rxi->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7995         }
7996 #endif
7997         else if (REGNODE_SIMPLE(OP(first)))
7998             RExC_rxi->regstclass = first;
7999         else if (PL_regkind[OP(first)] == BOUND ||
8000                  PL_regkind[OP(first)] == NBOUND)
8001             RExC_rxi->regstclass = first;
8002         else if (PL_regkind[OP(first)] == BOL) {
8003             RExC_rx->intflags |= (OP(first) == MBOL
8004                            ? PREGf_ANCH_MBOL
8005                            : PREGf_ANCH_SBOL);
8006             first = NEXTOPER(first);
8007             goto again;
8008         }
8009         else if (OP(first) == GPOS) {
8010             RExC_rx->intflags |= PREGf_ANCH_GPOS;
8011             first = NEXTOPER(first);
8012             goto again;
8013         }
8014         else if ((!sawopen || !RExC_sawback) &&
8015             !sawlookahead &&
8016             (OP(first) == STAR &&
8017             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
8018             !(RExC_rx->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
8019         {
8020             /* turn .* into ^.* with an implied $*=1 */
8021             const int type =
8022                 (OP(NEXTOPER(first)) == REG_ANY)
8023                     ? PREGf_ANCH_MBOL
8024                     : PREGf_ANCH_SBOL;
8025             RExC_rx->intflags |= (type | PREGf_IMPLICIT);
8026             first = NEXTOPER(first);
8027             goto again;
8028         }
8029         if (sawplus && !sawminmod && !sawlookahead
8030             && (!sawopen || !RExC_sawback)
8031             && !pRExC_state->code_blocks) /* May examine pos and $& */
8032             /* x+ must match at the 1st pos of run of x's */
8033             RExC_rx->intflags |= PREGf_SKIP;
8034
8035         /* Scan is after the zeroth branch, first is atomic matcher. */
8036 #ifdef TRIE_STUDY_OPT
8037         DEBUG_PARSE_r(
8038             if (!restudied)
8039                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8040                               (IV)(first - scan + 1))
8041         );
8042 #else
8043         DEBUG_PARSE_r(
8044             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8045                 (IV)(first - scan + 1))
8046         );
8047 #endif
8048
8049
8050         /*
8051         * If there's something expensive in the r.e., find the
8052         * longest literal string that must appear and make it the
8053         * regmust.  Resolve ties in favor of later strings, since
8054         * the regstart check works with the beginning of the r.e.
8055         * and avoiding duplication strengthens checking.  Not a
8056         * strong reason, but sufficient in the absence of others.
8057         * [Now we resolve ties in favor of the earlier string if
8058         * it happens that c_offset_min has been invalidated, since the
8059         * earlier string may buy us something the later one won't.]
8060         */
8061
8062         data.substrs[0].str = newSVpvs("");
8063         data.substrs[1].str = newSVpvs("");
8064         data.last_found = newSVpvs("");
8065         data.cur_is_floating = 0; /* initially any found substring is fixed */
8066         ENTER_with_name("study_chunk");
8067         SAVEFREESV(data.substrs[0].str);
8068         SAVEFREESV(data.substrs[1].str);
8069         SAVEFREESV(data.last_found);
8070         first = scan;
8071         if (!RExC_rxi->regstclass) {
8072             ssc_init(pRExC_state, &ch_class);
8073             data.start_class = &ch_class;
8074             stclass_flag = SCF_DO_STCLASS_AND;
8075         } else                          /* XXXX Check for BOUND? */
8076             stclass_flag = 0;
8077         data.last_closep = &last_close;
8078
8079         DEBUG_RExC_seen();
8080         /*
8081          * MAIN ENTRY FOR study_chunk() FOR m/PATTERN/
8082          * (NO top level branches)
8083          */
8084         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
8085                              scan + RExC_size, /* Up to end */
8086             &data, -1, 0, NULL,
8087             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
8088                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
8089             0);
8090
8091
8092         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
8093
8094
8095         if ( RExC_total_parens == 1 && !data.cur_is_floating
8096              && data.last_start_min == 0 && data.last_end > 0
8097              && !RExC_seen_zerolen
8098              && !(RExC_seen & REG_VERBARG_SEEN)
8099              && !(RExC_seen & REG_GPOS_SEEN)
8100         ){
8101             RExC_rx->extflags |= RXf_CHECK_ALL;
8102         }
8103         scan_commit(pRExC_state, &data,&minlen, 0);
8104
8105
8106         /* XXX this is done in reverse order because that's the way the
8107          * code was before it was parameterised. Don't know whether it
8108          * actually needs doing in reverse order. DAPM */
8109         for (i = 1; i >= 0; i--) {
8110             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
8111
8112             if (   !(   i
8113                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
8114                      &&    data.substrs[0].min_offset
8115                         == data.substrs[1].min_offset
8116                      &&    SvCUR(data.substrs[0].str)
8117                         == SvCUR(data.substrs[1].str)
8118                     )
8119                 && S_setup_longest (aTHX_ pRExC_state,
8120                                         &(RExC_rx->substrs->data[i]),
8121                                         &(data.substrs[i]),
8122                                         longest_length[i]))
8123             {
8124                 RExC_rx->substrs->data[i].min_offset =
8125                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
8126
8127                 RExC_rx->substrs->data[i].max_offset = data.substrs[i].max_offset;
8128                 /* Don't offset infinity */
8129                 if (data.substrs[i].max_offset < SSize_t_MAX)
8130                     RExC_rx->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
8131                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
8132             }
8133             else {
8134                 RExC_rx->substrs->data[i].substr      = NULL;
8135                 RExC_rx->substrs->data[i].utf8_substr = NULL;
8136                 longest_length[i] = 0;
8137             }
8138         }
8139
8140         LEAVE_with_name("study_chunk");
8141
8142         if (RExC_rxi->regstclass
8143             && (OP(RExC_rxi->regstclass) == REG_ANY || OP(RExC_rxi->regstclass) == SANY))
8144             RExC_rxi->regstclass = NULL;
8145
8146         if ((!(RExC_rx->substrs->data[0].substr || RExC_rx->substrs->data[0].utf8_substr)
8147               || RExC_rx->substrs->data[0].min_offset)
8148             && stclass_flag
8149             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8150             && is_ssc_worth_it(pRExC_state, data.start_class))
8151         {
8152             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8153
8154             ssc_finalize(pRExC_state, data.start_class);
8155
8156             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8157             StructCopy(data.start_class,
8158                        (regnode_ssc*)RExC_rxi->data->data[n],
8159                        regnode_ssc);
8160             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8161             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8162             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
8163                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8164                       Perl_re_printf( aTHX_
8165                                     "synthetic stclass \"%s\".\n",
8166                                     SvPVX_const(sv));});
8167             data.start_class = NULL;
8168         }
8169
8170         /* A temporary algorithm prefers floated substr to fixed one of
8171          * same length to dig more info. */
8172         i = (longest_length[0] <= longest_length[1]);
8173         RExC_rx->substrs->check_ix = i;
8174         RExC_rx->check_end_shift  = RExC_rx->substrs->data[i].end_shift;
8175         RExC_rx->check_substr     = RExC_rx->substrs->data[i].substr;
8176         RExC_rx->check_utf8       = RExC_rx->substrs->data[i].utf8_substr;
8177         RExC_rx->check_offset_min = RExC_rx->substrs->data[i].min_offset;
8178         RExC_rx->check_offset_max = RExC_rx->substrs->data[i].max_offset;
8179         if (!i && (RExC_rx->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
8180             RExC_rx->intflags |= PREGf_NOSCAN;
8181
8182         if ((RExC_rx->check_substr || RExC_rx->check_utf8) ) {
8183             RExC_rx->extflags |= RXf_USE_INTUIT;
8184             if (SvTAIL(RExC_rx->check_substr ? RExC_rx->check_substr : RExC_rx->check_utf8))
8185                 RExC_rx->extflags |= RXf_INTUIT_TAIL;
8186         }
8187
8188         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
8189         if ( (STRLEN)minlen < longest_length[1] )
8190             minlen= longest_length[1];
8191         if ( (STRLEN)minlen < longest_length[0] )
8192             minlen= longest_length[0];
8193         */
8194     }
8195     else {
8196         /* Several toplevels. Best we can is to set minlen. */
8197         SSize_t fake;
8198         regnode_ssc ch_class;
8199         SSize_t last_close = 0;
8200
8201         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
8202
8203         scan = RExC_rxi->program + 1;
8204         ssc_init(pRExC_state, &ch_class);
8205         data.start_class = &ch_class;
8206         data.last_closep = &last_close;
8207
8208         DEBUG_RExC_seen();
8209         /*
8210          * MAIN ENTRY FOR study_chunk() FOR m/P1|P2|.../
8211          * (patterns WITH top level branches)
8212          */
8213         minlen = study_chunk(pRExC_state,
8214             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
8215             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
8216                                                       ? SCF_TRIE_DOING_RESTUDY
8217                                                       : 0),
8218             0);
8219
8220         CHECK_RESTUDY_GOTO_butfirst(NOOP);
8221
8222         RExC_rx->check_substr = NULL;
8223         RExC_rx->check_utf8 = NULL;
8224         RExC_rx->substrs->data[0].substr      = NULL;
8225         RExC_rx->substrs->data[0].utf8_substr = NULL;
8226         RExC_rx->substrs->data[1].substr      = NULL;
8227         RExC_rx->substrs->data[1].utf8_substr = NULL;
8228
8229         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8230             && is_ssc_worth_it(pRExC_state, data.start_class))
8231         {
8232             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8233
8234             ssc_finalize(pRExC_state, data.start_class);
8235
8236             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8237             StructCopy(data.start_class,
8238                        (regnode_ssc*)RExC_rxi->data->data[n],
8239                        regnode_ssc);
8240             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8241             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8242             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
8243                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8244                       Perl_re_printf( aTHX_
8245                                     "synthetic stclass \"%s\".\n",
8246                                     SvPVX_const(sv));});
8247             data.start_class = NULL;
8248         }
8249     }
8250
8251     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
8252         RExC_rx->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
8253         RExC_rx->maxlen = REG_INFTY;
8254     }
8255     else {
8256         RExC_rx->maxlen = RExC_maxlen;
8257     }
8258
8259     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
8260        the "real" pattern. */
8261     DEBUG_OPTIMISE_r({
8262         Perl_re_printf( aTHX_ "minlen: %" IVdf " RExC_rx->minlen:%" IVdf " maxlen:%" IVdf "\n",
8263                       (IV)minlen, (IV)RExC_rx->minlen, (IV)RExC_maxlen);
8264     });
8265     RExC_rx->minlenret = minlen;
8266     if (RExC_rx->minlen < minlen)
8267         RExC_rx->minlen = minlen;
8268
8269     if (RExC_seen & REG_RECURSE_SEEN ) {
8270         RExC_rx->intflags |= PREGf_RECURSE_SEEN;
8271         Newx(RExC_rx->recurse_locinput, RExC_rx->nparens + 1, char *);
8272     }
8273     if (RExC_seen & REG_GPOS_SEEN)
8274         RExC_rx->intflags |= PREGf_GPOS_SEEN;
8275     if (RExC_seen & REG_LOOKBEHIND_SEEN)
8276         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
8277                                                 lookbehind */
8278     if (pRExC_state->code_blocks)
8279         RExC_rx->extflags |= RXf_EVAL_SEEN;
8280     if (RExC_seen & REG_VERBARG_SEEN)
8281     {
8282         RExC_rx->intflags |= PREGf_VERBARG_SEEN;
8283         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
8284     }
8285     if (RExC_seen & REG_CUTGROUP_SEEN)
8286         RExC_rx->intflags |= PREGf_CUTGROUP_SEEN;
8287     if (pm_flags & PMf_USE_RE_EVAL)
8288         RExC_rx->intflags |= PREGf_USE_RE_EVAL;
8289     if (RExC_paren_names)
8290         RXp_PAREN_NAMES(RExC_rx) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
8291     else
8292         RXp_PAREN_NAMES(RExC_rx) = NULL;
8293
8294     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
8295      * so it can be used in pp.c */
8296     if (RExC_rx->intflags & PREGf_ANCH)
8297         RExC_rx->extflags |= RXf_IS_ANCHORED;
8298
8299
8300     {
8301         /* this is used to identify "special" patterns that might result
8302          * in Perl NOT calling the regex engine and instead doing the match "itself",
8303          * particularly special cases in split//. By having the regex compiler
8304          * do this pattern matching at a regop level (instead of by inspecting the pattern)
8305          * we avoid weird issues with equivalent patterns resulting in different behavior,
8306          * AND we allow non Perl engines to get the same optimizations by the setting the
8307          * flags appropriately - Yves */
8308         regnode *first = RExC_rxi->program + 1;
8309         U8 fop = OP(first);
8310         regnode *next = regnext(first);
8311         U8 nop = OP(next);
8312
8313         if (PL_regkind[fop] == NOTHING && nop == END)
8314             RExC_rx->extflags |= RXf_NULL;
8315         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
8316             /* when fop is SBOL first->flags will be true only when it was
8317              * produced by parsing /\A/, and not when parsing /^/. This is
8318              * very important for the split code as there we want to
8319              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
8320              * See rt #122761 for more details. -- Yves */
8321             RExC_rx->extflags |= RXf_START_ONLY;
8322         else if (fop == PLUS
8323                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
8324                  && nop == END)
8325             RExC_rx->extflags |= RXf_WHITE;
8326         else if ( RExC_rx->extflags & RXf_SPLIT
8327                   && (fop == EXACT || fop == EXACT_ONLY8 || fop == EXACTL)
8328                   && STR_LEN(first) == 1
8329                   && *(STRING(first)) == ' '
8330                   && nop == END )
8331             RExC_rx->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
8332
8333     }
8334
8335     if (RExC_contains_locale) {
8336         RXp_EXTFLAGS(RExC_rx) |= RXf_TAINTED;
8337     }
8338
8339 #ifdef DEBUGGING
8340     if (RExC_paren_names) {
8341         RExC_rxi->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
8342         RExC_rxi->data->data[RExC_rxi->name_list_idx]
8343                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
8344     } else
8345 #endif
8346     RExC_rxi->name_list_idx = 0;
8347
8348     while ( RExC_recurse_count > 0 ) {
8349         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
8350         /*
8351          * This data structure is set up in study_chunk() and is used
8352          * to calculate the distance between a GOSUB regopcode and
8353          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
8354          * it refers to.
8355          *
8356          * If for some reason someone writes code that optimises
8357          * away a GOSUB opcode then the assert should be changed to
8358          * an if(scan) to guard the ARG2L_SET() - Yves
8359          *
8360          */
8361         assert(scan && OP(scan) == GOSUB);
8362         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - REGNODE_OFFSET(scan));
8363     }
8364
8365     Newxz(RExC_rx->offs, RExC_total_parens, regexp_paren_pair);
8366     /* assume we don't need to swap parens around before we match */
8367     DEBUG_TEST_r({
8368         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
8369             (unsigned long)RExC_study_chunk_recursed_count);
8370     });
8371     DEBUG_DUMP_r({
8372         DEBUG_RExC_seen();
8373         Perl_re_printf( aTHX_ "Final program:\n");
8374         regdump(RExC_rx);
8375     });
8376
8377     if (RExC_open_parens) {
8378         Safefree(RExC_open_parens);
8379         RExC_open_parens = NULL;
8380     }
8381     if (RExC_close_parens) {
8382         Safefree(RExC_close_parens);
8383         RExC_close_parens = NULL;
8384     }
8385
8386 #ifdef USE_ITHREADS
8387     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
8388      * by setting the regexp SV to readonly-only instead. If the
8389      * pattern's been recompiled, the USEDness should remain. */
8390     if (old_re && SvREADONLY(old_re))
8391         SvREADONLY_on(Rx);
8392 #endif
8393     return Rx;
8394 }
8395
8396
8397 SV*
8398 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
8399                     const U32 flags)
8400 {
8401     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
8402
8403     PERL_UNUSED_ARG(value);
8404
8405     if (flags & RXapif_FETCH) {
8406         return reg_named_buff_fetch(rx, key, flags);
8407     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
8408         Perl_croak_no_modify();
8409         return NULL;
8410     } else if (flags & RXapif_EXISTS) {
8411         return reg_named_buff_exists(rx, key, flags)
8412             ? &PL_sv_yes
8413             : &PL_sv_no;
8414     } else if (flags & RXapif_REGNAMES) {
8415         return reg_named_buff_all(rx, flags);
8416     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
8417         return reg_named_buff_scalar(rx, flags);
8418     } else {
8419         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
8420         return NULL;
8421     }
8422 }
8423
8424 SV*
8425 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
8426                          const U32 flags)
8427 {
8428     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
8429     PERL_UNUSED_ARG(lastkey);
8430
8431     if (flags & RXapif_FIRSTKEY)
8432         return reg_named_buff_firstkey(rx, flags);
8433     else if (flags & RXapif_NEXTKEY)
8434         return reg_named_buff_nextkey(rx, flags);
8435     else {
8436         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
8437                                             (int)flags);
8438         return NULL;
8439     }
8440 }
8441
8442 SV*
8443 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
8444                           const U32 flags)
8445 {
8446     SV *ret;
8447     struct regexp *const rx = ReANY(r);
8448
8449     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
8450
8451     if (rx && RXp_PAREN_NAMES(rx)) {
8452         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
8453         if (he_str) {
8454             IV i;
8455             SV* sv_dat=HeVAL(he_str);
8456             I32 *nums=(I32*)SvPVX(sv_dat);
8457             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
8458             for ( i=0; i<SvIVX(sv_dat); i++ ) {
8459                 if ((I32)(rx->nparens) >= nums[i]
8460                     && rx->offs[nums[i]].start != -1
8461                     && rx->offs[nums[i]].end != -1)
8462                 {
8463                     ret = newSVpvs("");
8464                     CALLREG_NUMBUF_FETCH(r, nums[i], ret);
8465                     if (!retarray)
8466                         return ret;
8467                 } else {
8468                     if (retarray)
8469                         ret = newSVsv(&PL_sv_undef);
8470                 }
8471                 if (retarray)
8472                     av_push(retarray, ret);
8473             }
8474             if (retarray)
8475                 return newRV_noinc(MUTABLE_SV(retarray));
8476         }
8477     }
8478     return NULL;
8479 }
8480
8481 bool
8482 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
8483                            const U32 flags)
8484 {
8485     struct regexp *const rx = ReANY(r);
8486
8487     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
8488
8489     if (rx && RXp_PAREN_NAMES(rx)) {
8490         if (flags & RXapif_ALL) {
8491             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
8492         } else {
8493             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
8494             if (sv) {
8495                 SvREFCNT_dec_NN(sv);
8496                 return TRUE;
8497             } else {
8498                 return FALSE;
8499             }
8500         }
8501     } else {
8502         return FALSE;
8503     }
8504 }
8505
8506 SV*
8507 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8508 {
8509     struct regexp *const rx = ReANY(r);
8510
8511     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8512
8513     if ( rx && RXp_PAREN_NAMES(rx) ) {
8514         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8515
8516         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8517     } else {
8518         return FALSE;
8519     }
8520 }
8521
8522 SV*
8523 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8524 {
8525     struct regexp *const rx = ReANY(r);
8526     GET_RE_DEBUG_FLAGS_DECL;
8527
8528     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8529
8530     if (rx && RXp_PAREN_NAMES(rx)) {
8531         HV *hv = RXp_PAREN_NAMES(rx);
8532         HE *temphe;
8533         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8534             IV i;
8535             IV parno = 0;
8536             SV* sv_dat = HeVAL(temphe);
8537             I32 *nums = (I32*)SvPVX(sv_dat);
8538             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8539                 if ((I32)(rx->lastparen) >= nums[i] &&
8540                     rx->offs[nums[i]].start != -1 &&
8541                     rx->offs[nums[i]].end != -1)
8542                 {
8543                     parno = nums[i];
8544                     break;
8545                 }
8546             }
8547             if (parno || flags & RXapif_ALL) {
8548                 return newSVhek(HeKEY_hek(temphe));
8549             }
8550         }
8551     }
8552     return NULL;
8553 }
8554
8555 SV*
8556 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8557 {
8558     SV *ret;
8559     AV *av;
8560     SSize_t length;
8561     struct regexp *const rx = ReANY(r);
8562
8563     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8564
8565     if (rx && RXp_PAREN_NAMES(rx)) {
8566         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8567             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8568         } else if (flags & RXapif_ONE) {
8569             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8570             av = MUTABLE_AV(SvRV(ret));
8571             length = av_tindex(av);
8572             SvREFCNT_dec_NN(ret);
8573             return newSViv(length + 1);
8574         } else {
8575             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8576                                                 (int)flags);
8577             return NULL;
8578         }
8579     }
8580     return &PL_sv_undef;
8581 }
8582
8583 SV*
8584 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8585 {
8586     struct regexp *const rx = ReANY(r);
8587     AV *av = newAV();
8588
8589     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8590
8591     if (rx && RXp_PAREN_NAMES(rx)) {
8592         HV *hv= RXp_PAREN_NAMES(rx);
8593         HE *temphe;
8594         (void)hv_iterinit(hv);
8595         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8596             IV i;
8597             IV parno = 0;
8598             SV* sv_dat = HeVAL(temphe);
8599             I32 *nums = (I32*)SvPVX(sv_dat);
8600             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8601                 if ((I32)(rx->lastparen) >= nums[i] &&
8602                     rx->offs[nums[i]].start != -1 &&
8603                     rx->offs[nums[i]].end != -1)
8604                 {
8605                     parno = nums[i];
8606                     break;
8607                 }
8608             }
8609             if (parno || flags & RXapif_ALL) {
8610                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8611             }
8612         }
8613     }
8614
8615     return newRV_noinc(MUTABLE_SV(av));
8616 }
8617
8618 void
8619 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8620                              SV * const sv)
8621 {
8622     struct regexp *const rx = ReANY(r);
8623     char *s = NULL;
8624     SSize_t i = 0;
8625     SSize_t s1, t1;
8626     I32 n = paren;
8627
8628     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8629
8630     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8631            || n == RX_BUFF_IDX_CARET_FULLMATCH
8632            || n == RX_BUFF_IDX_CARET_POSTMATCH
8633        )
8634     {
8635         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8636         if (!keepcopy) {
8637             /* on something like
8638              *    $r = qr/.../;
8639              *    /$qr/p;
8640              * the KEEPCOPY is set on the PMOP rather than the regex */
8641             if (PL_curpm && r == PM_GETRE(PL_curpm))
8642                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8643         }
8644         if (!keepcopy)
8645             goto ret_undef;
8646     }
8647
8648     if (!rx->subbeg)
8649         goto ret_undef;
8650
8651     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8652         /* no need to distinguish between them any more */
8653         n = RX_BUFF_IDX_FULLMATCH;
8654
8655     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8656         && rx->offs[0].start != -1)
8657     {
8658         /* $`, ${^PREMATCH} */
8659         i = rx->offs[0].start;
8660         s = rx->subbeg;
8661     }
8662     else
8663     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8664         && rx->offs[0].end != -1)
8665     {
8666         /* $', ${^POSTMATCH} */
8667         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8668         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8669     }
8670     else
8671     if ( 0 <= n && n <= (I32)rx->nparens &&
8672         (s1 = rx->offs[n].start) != -1 &&
8673         (t1 = rx->offs[n].end) != -1)
8674     {
8675         /* $&, ${^MATCH},  $1 ... */
8676         i = t1 - s1;
8677         s = rx->subbeg + s1 - rx->suboffset;
8678     } else {
8679         goto ret_undef;
8680     }
8681
8682     assert(s >= rx->subbeg);
8683     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8684     if (i >= 0) {
8685 #ifdef NO_TAINT_SUPPORT
8686         sv_setpvn(sv, s, i);
8687 #else
8688         const int oldtainted = TAINT_get;
8689         TAINT_NOT;
8690         sv_setpvn(sv, s, i);
8691         TAINT_set(oldtainted);
8692 #endif
8693         if (RXp_MATCH_UTF8(rx))
8694             SvUTF8_on(sv);
8695         else
8696             SvUTF8_off(sv);
8697         if (TAINTING_get) {
8698             if (RXp_MATCH_TAINTED(rx)) {
8699                 if (SvTYPE(sv) >= SVt_PVMG) {
8700                     MAGIC* const mg = SvMAGIC(sv);
8701                     MAGIC* mgt;
8702                     TAINT;
8703                     SvMAGIC_set(sv, mg->mg_moremagic);
8704                     SvTAINT(sv);
8705                     if ((mgt = SvMAGIC(sv))) {
8706                         mg->mg_moremagic = mgt;
8707                         SvMAGIC_set(sv, mg);
8708                     }
8709                 } else {
8710                     TAINT;
8711                     SvTAINT(sv);
8712                 }
8713             } else
8714                 SvTAINTED_off(sv);
8715         }
8716     } else {
8717       ret_undef:
8718         sv_set_undef(sv);
8719         return;
8720     }
8721 }
8722
8723 void
8724 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8725                                                          SV const * const value)
8726 {
8727     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8728
8729     PERL_UNUSED_ARG(rx);
8730     PERL_UNUSED_ARG(paren);
8731     PERL_UNUSED_ARG(value);
8732
8733     if (!PL_localizing)
8734         Perl_croak_no_modify();
8735 }
8736
8737 I32
8738 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8739                               const I32 paren)
8740 {
8741     struct regexp *const rx = ReANY(r);
8742     I32 i;
8743     I32 s1, t1;
8744
8745     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8746
8747     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8748         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8749         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8750     )
8751     {
8752         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8753         if (!keepcopy) {
8754             /* on something like
8755              *    $r = qr/.../;
8756              *    /$qr/p;
8757              * the KEEPCOPY is set on the PMOP rather than the regex */
8758             if (PL_curpm && r == PM_GETRE(PL_curpm))
8759                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8760         }
8761         if (!keepcopy)
8762             goto warn_undef;
8763     }
8764
8765     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8766     switch (paren) {
8767       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8768       case RX_BUFF_IDX_PREMATCH:       /* $` */
8769         if (rx->offs[0].start != -1) {
8770                         i = rx->offs[0].start;
8771                         if (i > 0) {
8772                                 s1 = 0;
8773                                 t1 = i;
8774                                 goto getlen;
8775                         }
8776             }
8777         return 0;
8778
8779       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8780       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8781             if (rx->offs[0].end != -1) {
8782                         i = rx->sublen - rx->offs[0].end;
8783                         if (i > 0) {
8784                                 s1 = rx->offs[0].end;
8785                                 t1 = rx->sublen;
8786                                 goto getlen;
8787                         }
8788             }
8789         return 0;
8790
8791       default: /* $& / ${^MATCH}, $1, $2, ... */
8792             if (paren <= (I32)rx->nparens &&
8793             (s1 = rx->offs[paren].start) != -1 &&
8794             (t1 = rx->offs[paren].end) != -1)
8795             {
8796             i = t1 - s1;
8797             goto getlen;
8798         } else {
8799           warn_undef:
8800             if (ckWARN(WARN_UNINITIALIZED))
8801                 report_uninit((const SV *)sv);
8802             return 0;
8803         }
8804     }
8805   getlen:
8806     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8807         const char * const s = rx->subbeg - rx->suboffset + s1;
8808         const U8 *ep;
8809         STRLEN el;
8810
8811         i = t1 - s1;
8812         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8813                         i = el;
8814     }
8815     return i;
8816 }
8817
8818 SV*
8819 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8820 {
8821     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8822         PERL_UNUSED_ARG(rx);
8823         if (0)
8824             return NULL;
8825         else
8826             return newSVpvs("Regexp");
8827 }
8828
8829 /* Scans the name of a named buffer from the pattern.
8830  * If flags is REG_RSN_RETURN_NULL returns null.
8831  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8832  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8833  * to the parsed name as looked up in the RExC_paren_names hash.
8834  * If there is an error throws a vFAIL().. type exception.
8835  */
8836
8837 #define REG_RSN_RETURN_NULL    0
8838 #define REG_RSN_RETURN_NAME    1
8839 #define REG_RSN_RETURN_DATA    2
8840
8841 STATIC SV*
8842 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8843 {
8844     char *name_start = RExC_parse;
8845     SV* sv_name;
8846
8847     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8848
8849     assert (RExC_parse <= RExC_end);
8850     if (RExC_parse == RExC_end) NOOP;
8851     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8852          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8853           * using do...while */
8854         if (UTF)
8855             do {
8856                 RExC_parse += UTF8SKIP(RExC_parse);
8857             } while (   RExC_parse < RExC_end
8858                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
8859         else
8860             do {
8861                 RExC_parse++;
8862             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
8863     } else {
8864         RExC_parse++; /* so the <- from the vFAIL is after the offending
8865                          character */
8866         vFAIL("Group name must start with a non-digit word character");
8867     }
8868     sv_name = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
8869                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
8870     if ( flags == REG_RSN_RETURN_NAME)
8871         return sv_name;
8872     else if (flags==REG_RSN_RETURN_DATA) {
8873         HE *he_str = NULL;
8874         SV *sv_dat = NULL;
8875         if ( ! sv_name )      /* should not happen*/
8876             Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
8877         if (RExC_paren_names)
8878             he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
8879         if ( he_str )
8880             sv_dat = HeVAL(he_str);
8881         if ( ! sv_dat ) {   /* Didn't find group */
8882
8883             /* It might be a forward reference; we can't fail until we
8884                 * know, by completing the parse to get all the groups, and
8885                 * then reparsing */
8886             if (ALL_PARENS_COUNTED)  {
8887                 vFAIL("Reference to nonexistent named group");
8888             }
8889             else {
8890                 REQUIRE_PARENS_PASS;
8891             }
8892         }
8893         return sv_dat;
8894     }
8895
8896     Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
8897                      (unsigned long) flags);
8898 }
8899
8900 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
8901     if (RExC_lastparse!=RExC_parse) {                           \
8902         Perl_re_printf( aTHX_  "%s",                            \
8903             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
8904                 RExC_end - RExC_parse, 16,                      \
8905                 "", "",                                         \
8906                 PERL_PV_ESCAPE_UNI_DETECT |                     \
8907                 PERL_PV_PRETTY_ELLIPSES   |                     \
8908                 PERL_PV_PRETTY_LTGT       |                     \
8909                 PERL_PV_ESCAPE_RE         |                     \
8910                 PERL_PV_PRETTY_EXACTSIZE                        \
8911             )                                                   \
8912         );                                                      \
8913     } else                                                      \
8914         Perl_re_printf( aTHX_ "%16s","");                       \
8915                                                                 \
8916     if (RExC_lastnum!=RExC_emit)                                \
8917        Perl_re_printf( aTHX_ "|%4d", RExC_emit);                \
8918     else                                                        \
8919        Perl_re_printf( aTHX_ "|%4s","");                        \
8920     Perl_re_printf( aTHX_ "|%*s%-4s",                           \
8921         (int)((depth*2)), "",                                   \
8922         (funcname)                                              \
8923     );                                                          \
8924     RExC_lastnum=RExC_emit;                                     \
8925     RExC_lastparse=RExC_parse;                                  \
8926 })
8927
8928
8929
8930 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
8931     DEBUG_PARSE_MSG((funcname));                            \
8932     Perl_re_printf( aTHX_ "%4s","\n");                                  \
8933 })
8934 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
8935     DEBUG_PARSE_MSG((funcname));                            \
8936     Perl_re_printf( aTHX_ fmt "\n",args);                               \
8937 })
8938
8939 /* This section of code defines the inversion list object and its methods.  The
8940  * interfaces are highly subject to change, so as much as possible is static to
8941  * this file.  An inversion list is here implemented as a malloc'd C UV array
8942  * as an SVt_INVLIST scalar.
8943  *
8944  * An inversion list for Unicode is an array of code points, sorted by ordinal
8945  * number.  Each element gives the code point that begins a range that extends
8946  * up-to but not including the code point given by the next element.  The final
8947  * element gives the first code point of a range that extends to the platform's
8948  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
8949  * ...) give ranges whose code points are all in the inversion list.  We say
8950  * that those ranges are in the set.  The odd-numbered elements give ranges
8951  * whose code points are not in the inversion list, and hence not in the set.
8952  * Thus, element [0] is the first code point in the list.  Element [1]
8953  * is the first code point beyond that not in the list; and element [2] is the
8954  * first code point beyond that that is in the list.  In other words, the first
8955  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
8956  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
8957  * all code points in that range are not in the inversion list.  The third
8958  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
8959  * list, and so forth.  Thus every element whose index is divisible by two
8960  * gives the beginning of a range that is in the list, and every element whose
8961  * index is not divisible by two gives the beginning of a range not in the
8962  * list.  If the final element's index is divisible by two, the inversion list
8963  * extends to the platform's infinity; otherwise the highest code point in the
8964  * inversion list is the contents of that element minus 1.
8965  *
8966  * A range that contains just a single code point N will look like
8967  *  invlist[i]   == N
8968  *  invlist[i+1] == N+1
8969  *
8970  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
8971  * impossible to represent, so element [i+1] is omitted.  The single element
8972  * inversion list
8973  *  invlist[0] == UV_MAX
8974  * contains just UV_MAX, but is interpreted as matching to infinity.
8975  *
8976  * Taking the complement (inverting) an inversion list is quite simple, if the
8977  * first element is 0, remove it; otherwise add a 0 element at the beginning.
8978  * This implementation reserves an element at the beginning of each inversion
8979  * list to always contain 0; there is an additional flag in the header which
8980  * indicates if the list begins at the 0, or is offset to begin at the next
8981  * element.  This means that the inversion list can be inverted without any
8982  * copying; just flip the flag.
8983  *
8984  * More about inversion lists can be found in "Unicode Demystified"
8985  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
8986  *
8987  * The inversion list data structure is currently implemented as an SV pointing
8988  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
8989  * array of UV whose memory management is automatically handled by the existing
8990  * facilities for SV's.
8991  *
8992  * Some of the methods should always be private to the implementation, and some
8993  * should eventually be made public */
8994
8995 /* The header definitions are in F<invlist_inline.h> */
8996
8997 #ifndef PERL_IN_XSUB_RE
8998
8999 PERL_STATIC_INLINE UV*
9000 S__invlist_array_init(SV* const invlist, const bool will_have_0)
9001 {
9002     /* Returns a pointer to the first element in the inversion list's array.
9003      * This is called upon initialization of an inversion list.  Where the
9004      * array begins depends on whether the list has the code point U+0000 in it
9005      * or not.  The other parameter tells it whether the code that follows this
9006      * call is about to put a 0 in the inversion list or not.  The first
9007      * element is either the element reserved for 0, if TRUE, or the element
9008      * after it, if FALSE */
9009
9010     bool* offset = get_invlist_offset_addr(invlist);
9011     UV* zero_addr = (UV *) SvPVX(invlist);
9012
9013     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
9014
9015     /* Must be empty */
9016     assert(! _invlist_len(invlist));
9017
9018     *zero_addr = 0;
9019
9020     /* 1^1 = 0; 1^0 = 1 */
9021     *offset = 1 ^ will_have_0;
9022     return zero_addr + *offset;
9023 }
9024
9025 PERL_STATIC_INLINE void
9026 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
9027 {
9028     /* Sets the current number of elements stored in the inversion list.
9029      * Updates SvCUR correspondingly */
9030     PERL_UNUSED_CONTEXT;
9031     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
9032
9033     assert(is_invlist(invlist));
9034
9035     SvCUR_set(invlist,
9036               (len == 0)
9037                ? 0
9038                : TO_INTERNAL_SIZE(len + offset));
9039     assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
9040 }
9041
9042 STATIC void
9043 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
9044 {
9045     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
9046      * steals the list from 'src', so 'src' is made to have a NULL list.  This
9047      * is similar to what SvSetMagicSV() would do, if it were implemented on
9048      * inversion lists, though this routine avoids a copy */
9049
9050     const UV src_len          = _invlist_len(src);
9051     const bool src_offset     = *get_invlist_offset_addr(src);
9052     const STRLEN src_byte_len = SvLEN(src);
9053     char * array              = SvPVX(src);
9054
9055     const int oldtainted = TAINT_get;
9056
9057     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
9058
9059     assert(is_invlist(src));
9060     assert(is_invlist(dest));
9061     assert(! invlist_is_iterating(src));
9062     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
9063
9064     /* Make sure it ends in the right place with a NUL, as our inversion list
9065      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
9066      * asserts it */
9067     array[src_byte_len - 1] = '\0';
9068
9069     TAINT_NOT;      /* Otherwise it breaks */
9070     sv_usepvn_flags(dest,
9071                     (char *) array,
9072                     src_byte_len - 1,
9073
9074                     /* This flag is documented to cause a copy to be avoided */
9075                     SV_HAS_TRAILING_NUL);
9076     TAINT_set(oldtainted);
9077     SvPV_set(src, 0);
9078     SvLEN_set(src, 0);
9079     SvCUR_set(src, 0);
9080
9081     /* Finish up copying over the other fields in an inversion list */
9082     *get_invlist_offset_addr(dest) = src_offset;
9083     invlist_set_len(dest, src_len, src_offset);
9084     *get_invlist_previous_index_addr(dest) = 0;
9085     invlist_iterfinish(dest);
9086 }
9087
9088 PERL_STATIC_INLINE IV*
9089 S_get_invlist_previous_index_addr(SV* invlist)
9090 {
9091     /* Return the address of the IV that is reserved to hold the cached index
9092      * */
9093     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
9094
9095     assert(is_invlist(invlist));
9096
9097     return &(((XINVLIST*) SvANY(invlist))->prev_index);
9098 }
9099
9100 PERL_STATIC_INLINE IV
9101 S_invlist_previous_index(SV* const invlist)
9102 {
9103     /* Returns cached index of previous search */
9104
9105     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
9106
9107     return *get_invlist_previous_index_addr(invlist);
9108 }
9109
9110 PERL_STATIC_INLINE void
9111 S_invlist_set_previous_index(SV* const invlist, const IV index)
9112 {
9113     /* Caches <index> for later retrieval */
9114
9115     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
9116
9117     assert(index == 0 || index < (int) _invlist_len(invlist));
9118
9119     *get_invlist_previous_index_addr(invlist) = index;
9120 }
9121
9122 PERL_STATIC_INLINE void
9123 S_invlist_trim(SV* invlist)
9124 {
9125     /* Free the not currently-being-used space in an inversion list */
9126
9127     /* But don't free up the space needed for the 0 UV that is always at the
9128      * beginning of the list, nor the trailing NUL */
9129     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
9130
9131     PERL_ARGS_ASSERT_INVLIST_TRIM;
9132
9133     assert(is_invlist(invlist));
9134
9135     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
9136 }
9137
9138 PERL_STATIC_INLINE void
9139 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
9140 {
9141     PERL_ARGS_ASSERT_INVLIST_CLEAR;
9142
9143     assert(is_invlist(invlist));
9144
9145     invlist_set_len(invlist, 0, 0);
9146     invlist_trim(invlist);
9147 }
9148
9149 #endif /* ifndef PERL_IN_XSUB_RE */
9150
9151 PERL_STATIC_INLINE bool
9152 S_invlist_is_iterating(SV* const invlist)
9153 {
9154     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
9155
9156     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
9157 }
9158
9159 #ifndef PERL_IN_XSUB_RE
9160
9161 PERL_STATIC_INLINE UV
9162 S_invlist_max(SV* const invlist)
9163 {
9164     /* Returns the maximum number of elements storable in the inversion list's
9165      * array, without having to realloc() */
9166
9167     PERL_ARGS_ASSERT_INVLIST_MAX;
9168
9169     assert(is_invlist(invlist));
9170
9171     /* Assumes worst case, in which the 0 element is not counted in the
9172      * inversion list, so subtracts 1 for that */
9173     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
9174            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
9175            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
9176 }
9177
9178 STATIC void
9179 S_initialize_invlist_guts(pTHX_ SV* invlist, const Size_t initial_size)
9180 {
9181     PERL_ARGS_ASSERT_INITIALIZE_INVLIST_GUTS;
9182
9183     /* First 1 is in case the zero element isn't in the list; second 1 is for
9184      * trailing NUL */
9185     SvGROW(invlist, TO_INTERNAL_SIZE(initial_size + 1) + 1);
9186     invlist_set_len(invlist, 0, 0);
9187
9188     /* Force iterinit() to be used to get iteration to work */
9189     invlist_iterfinish(invlist);
9190
9191     *get_invlist_previous_index_addr(invlist) = 0;
9192 }
9193
9194 SV*
9195 Perl__new_invlist(pTHX_ IV initial_size)
9196 {
9197
9198     /* Return a pointer to a newly constructed inversion list, with enough
9199      * space to store 'initial_size' elements.  If that number is negative, a
9200      * system default is used instead */
9201
9202     SV* new_list;
9203
9204     if (initial_size < 0) {
9205         initial_size = 10;
9206     }
9207
9208     new_list = newSV_type(SVt_INVLIST);
9209     initialize_invlist_guts(new_list, initial_size);
9210
9211     return new_list;
9212 }
9213
9214 SV*
9215 Perl__new_invlist_C_array(pTHX_ const UV* const list)
9216 {
9217     /* Return a pointer to a newly constructed inversion list, initialized to
9218      * point to <list>, which has to be in the exact correct inversion list
9219      * form, including internal fields.  Thus this is a dangerous routine that
9220      * should not be used in the wrong hands.  The passed in 'list' contains
9221      * several header fields at the beginning that are not part of the
9222      * inversion list body proper */
9223
9224     const STRLEN length = (STRLEN) list[0];
9225     const UV version_id =          list[1];
9226     const bool offset   =    cBOOL(list[2]);
9227 #define HEADER_LENGTH 3
9228     /* If any of the above changes in any way, you must change HEADER_LENGTH
9229      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
9230      *      perl -E 'say int(rand 2**31-1)'
9231      */
9232 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
9233                                         data structure type, so that one being
9234                                         passed in can be validated to be an
9235                                         inversion list of the correct vintage.
9236                                        */
9237
9238     SV* invlist = newSV_type(SVt_INVLIST);
9239
9240     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
9241
9242     if (version_id != INVLIST_VERSION_ID) {
9243         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
9244     }
9245
9246     /* The generated array passed in includes header elements that aren't part
9247      * of the list proper, so start it just after them */
9248     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
9249
9250     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
9251                                shouldn't touch it */
9252
9253     *(get_invlist_offset_addr(invlist)) = offset;
9254
9255     /* The 'length' passed to us is the physical number of elements in the
9256      * inversion list.  But if there is an offset the logical number is one
9257      * less than that */
9258     invlist_set_len(invlist, length  - offset, offset);
9259
9260     invlist_set_previous_index(invlist, 0);
9261
9262     /* Initialize the iteration pointer. */
9263     invlist_iterfinish(invlist);
9264
9265     SvREADONLY_on(invlist);
9266
9267     return invlist;
9268 }
9269
9270 STATIC void
9271 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
9272 {
9273     /* Grow the maximum size of an inversion list */
9274
9275     PERL_ARGS_ASSERT_INVLIST_EXTEND;
9276
9277     assert(is_invlist(invlist));
9278
9279     /* Add one to account for the zero element at the beginning which may not
9280      * be counted by the calling parameters */
9281     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
9282 }
9283
9284 STATIC void
9285 S__append_range_to_invlist(pTHX_ SV* const invlist,
9286                                  const UV start, const UV end)
9287 {
9288    /* Subject to change or removal.  Append the range from 'start' to 'end' at
9289     * the end of the inversion list.  The range must be above any existing
9290     * ones. */
9291
9292     UV* array;
9293     UV max = invlist_max(invlist);
9294     UV len = _invlist_len(invlist);
9295     bool offset;
9296
9297     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
9298
9299     if (len == 0) { /* Empty lists must be initialized */
9300         offset = start != 0;
9301         array = _invlist_array_init(invlist, ! offset);
9302     }
9303     else {
9304         /* Here, the existing list is non-empty. The current max entry in the
9305          * list is generally the first value not in the set, except when the
9306          * set extends to the end of permissible values, in which case it is
9307          * the first entry in that final set, and so this call is an attempt to
9308          * append out-of-order */
9309
9310         UV final_element = len - 1;
9311         array = invlist_array(invlist);
9312         if (   array[final_element] > start
9313             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
9314         {
9315             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",
9316                      array[final_element], start,
9317                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
9318         }
9319
9320         /* Here, it is a legal append.  If the new range begins 1 above the end
9321          * of the range below it, it is extending the range below it, so the
9322          * new first value not in the set is one greater than the newly
9323          * extended range.  */
9324         offset = *get_invlist_offset_addr(invlist);
9325         if (array[final_element] == start) {
9326             if (end != UV_MAX) {
9327                 array[final_element] = end + 1;
9328             }
9329             else {
9330                 /* But if the end is the maximum representable on the machine,
9331                  * assume that infinity was actually what was meant.  Just let
9332                  * the range that this would extend to have no end */
9333                 invlist_set_len(invlist, len - 1, offset);
9334             }
9335             return;
9336         }
9337     }
9338
9339     /* Here the new range doesn't extend any existing set.  Add it */
9340
9341     len += 2;   /* Includes an element each for the start and end of range */
9342
9343     /* If wll overflow the existing space, extend, which may cause the array to
9344      * be moved */
9345     if (max < len) {
9346         invlist_extend(invlist, len);
9347
9348         /* Have to set len here to avoid assert failure in invlist_array() */
9349         invlist_set_len(invlist, len, offset);
9350
9351         array = invlist_array(invlist);
9352     }
9353     else {
9354         invlist_set_len(invlist, len, offset);
9355     }
9356
9357     /* The next item on the list starts the range, the one after that is
9358      * one past the new range.  */
9359     array[len - 2] = start;
9360     if (end != UV_MAX) {
9361         array[len - 1] = end + 1;
9362     }
9363     else {
9364         /* But if the end is the maximum representable on the machine, just let
9365          * the range have no end */
9366         invlist_set_len(invlist, len - 1, offset);
9367     }
9368 }
9369
9370 SSize_t
9371 Perl__invlist_search(SV* const invlist, const UV cp)
9372 {
9373     /* Searches the inversion list for the entry that contains the input code
9374      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
9375      * return value is the index into the list's array of the range that
9376      * contains <cp>, that is, 'i' such that
9377      *  array[i] <= cp < array[i+1]
9378      */
9379
9380     IV low = 0;
9381     IV mid;
9382     IV high = _invlist_len(invlist);
9383     const IV highest_element = high - 1;
9384     const UV* array;
9385
9386     PERL_ARGS_ASSERT__INVLIST_SEARCH;
9387
9388     /* If list is empty, return failure. */
9389     if (high == 0) {
9390         return -1;
9391     }
9392
9393     /* (We can't get the array unless we know the list is non-empty) */
9394     array = invlist_array(invlist);
9395
9396     mid = invlist_previous_index(invlist);
9397     assert(mid >=0);
9398     if (mid > highest_element) {
9399         mid = highest_element;
9400     }
9401
9402     /* <mid> contains the cache of the result of the previous call to this
9403      * function (0 the first time).  See if this call is for the same result,
9404      * or if it is for mid-1.  This is under the theory that calls to this
9405      * function will often be for related code points that are near each other.
9406      * And benchmarks show that caching gives better results.  We also test
9407      * here if the code point is within the bounds of the list.  These tests
9408      * replace others that would have had to be made anyway to make sure that
9409      * the array bounds were not exceeded, and these give us extra information
9410      * at the same time */
9411     if (cp >= array[mid]) {
9412         if (cp >= array[highest_element]) {
9413             return highest_element;
9414         }
9415
9416         /* Here, array[mid] <= cp < array[highest_element].  This means that
9417          * the final element is not the answer, so can exclude it; it also
9418          * means that <mid> is not the final element, so can refer to 'mid + 1'
9419          * safely */
9420         if (cp < array[mid + 1]) {
9421             return mid;
9422         }
9423         high--;
9424         low = mid + 1;
9425     }
9426     else { /* cp < aray[mid] */
9427         if (cp < array[0]) { /* Fail if outside the array */
9428             return -1;
9429         }
9430         high = mid;
9431         if (cp >= array[mid - 1]) {
9432             goto found_entry;
9433         }
9434     }
9435
9436     /* Binary search.  What we are looking for is <i> such that
9437      *  array[i] <= cp < array[i+1]
9438      * The loop below converges on the i+1.  Note that there may not be an
9439      * (i+1)th element in the array, and things work nonetheless */
9440     while (low < high) {
9441         mid = (low + high) / 2;
9442         assert(mid <= highest_element);
9443         if (array[mid] <= cp) { /* cp >= array[mid] */
9444             low = mid + 1;
9445
9446             /* We could do this extra test to exit the loop early.
9447             if (cp < array[low]) {
9448                 return mid;
9449             }
9450             */
9451         }
9452         else { /* cp < array[mid] */
9453             high = mid;
9454         }
9455     }
9456
9457   found_entry:
9458     high--;
9459     invlist_set_previous_index(invlist, high);
9460     return high;
9461 }
9462
9463 void
9464 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9465                                          const bool complement_b, SV** output)
9466 {
9467     /* Take the union of two inversion lists and point '*output' to it.  On
9468      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9469      * even 'a' or 'b').  If to an inversion list, the contents of the original
9470      * list will be replaced by the union.  The first list, 'a', may be
9471      * NULL, in which case a copy of the second list is placed in '*output'.
9472      * If 'complement_b' is TRUE, the union is taken of the complement
9473      * (inversion) of 'b' instead of b itself.
9474      *
9475      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9476      * Richard Gillam, published by Addison-Wesley, and explained at some
9477      * length there.  The preface says to incorporate its examples into your
9478      * code at your own risk.
9479      *
9480      * The algorithm is like a merge sort. */
9481
9482     const UV* array_a;    /* a's array */
9483     const UV* array_b;
9484     UV len_a;       /* length of a's array */
9485     UV len_b;
9486
9487     SV* u;                      /* the resulting union */
9488     UV* array_u;
9489     UV len_u = 0;
9490
9491     UV i_a = 0;             /* current index into a's array */
9492     UV i_b = 0;
9493     UV i_u = 0;
9494
9495     /* running count, as explained in the algorithm source book; items are
9496      * stopped accumulating and are output when the count changes to/from 0.
9497      * The count is incremented when we start a range that's in an input's set,
9498      * and decremented when we start a range that's not in a set.  So this
9499      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9500      * and hence nothing goes into the union; 1, just one of the inputs is in
9501      * its set (and its current range gets added to the union); and 2 when both
9502      * inputs are in their sets.  */
9503     UV count = 0;
9504
9505     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9506     assert(a != b);
9507     assert(*output == NULL || is_invlist(*output));
9508
9509     len_b = _invlist_len(b);
9510     if (len_b == 0) {
9511
9512         /* Here, 'b' is empty, hence it's complement is all possible code
9513          * points.  So if the union includes the complement of 'b', it includes
9514          * everything, and we need not even look at 'a'.  It's easiest to
9515          * create a new inversion list that matches everything.  */
9516         if (complement_b) {
9517             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9518
9519             if (*output == NULL) { /* If the output didn't exist, just point it
9520                                       at the new list */
9521                 *output = everything;
9522             }
9523             else { /* Otherwise, replace its contents with the new list */
9524                 invlist_replace_list_destroys_src(*output, everything);
9525                 SvREFCNT_dec_NN(everything);
9526             }
9527
9528             return;
9529         }
9530
9531         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9532          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9533          * output will be empty */
9534
9535         if (a == NULL || _invlist_len(a) == 0) {
9536             if (*output == NULL) {
9537                 *output = _new_invlist(0);
9538             }
9539             else {
9540                 invlist_clear(*output);
9541             }
9542             return;
9543         }
9544
9545         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9546          * union.  We can just return a copy of 'a' if '*output' doesn't point
9547          * to an existing list */
9548         if (*output == NULL) {
9549             *output = invlist_clone(a, NULL);
9550             return;
9551         }
9552
9553         /* If the output is to overwrite 'a', we have a no-op, as it's
9554          * already in 'a' */
9555         if (*output == a) {
9556             return;
9557         }
9558
9559         /* Here, '*output' is to be overwritten by 'a' */
9560         u = invlist_clone(a, NULL);
9561         invlist_replace_list_destroys_src(*output, u);
9562         SvREFCNT_dec_NN(u);
9563
9564         return;
9565     }
9566
9567     /* Here 'b' is not empty.  See about 'a' */
9568
9569     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9570
9571         /* Here, 'a' is empty (and b is not).  That means the union will come
9572          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9573          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9574          * the clone */
9575
9576         SV ** dest = (*output == NULL) ? output : &u;
9577         *dest = invlist_clone(b, NULL);
9578         if (complement_b) {
9579             _invlist_invert(*dest);
9580         }
9581
9582         if (dest == &u) {
9583             invlist_replace_list_destroys_src(*output, u);
9584             SvREFCNT_dec_NN(u);
9585         }
9586
9587         return;
9588     }
9589
9590     /* Here both lists exist and are non-empty */
9591     array_a = invlist_array(a);
9592     array_b = invlist_array(b);
9593
9594     /* If are to take the union of 'a' with the complement of b, set it
9595      * up so are looking at b's complement. */
9596     if (complement_b) {
9597
9598         /* To complement, we invert: if the first element is 0, remove it.  To
9599          * do this, we just pretend the array starts one later */
9600         if (array_b[0] == 0) {
9601             array_b++;
9602             len_b--;
9603         }
9604         else {
9605
9606             /* But if the first element is not zero, we pretend the list starts
9607              * at the 0 that is always stored immediately before the array. */
9608             array_b--;
9609             len_b++;
9610         }
9611     }
9612
9613     /* Size the union for the worst case: that the sets are completely
9614      * disjoint */
9615     u = _new_invlist(len_a + len_b);
9616
9617     /* Will contain U+0000 if either component does */
9618     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9619                                       || (len_b > 0 && array_b[0] == 0));
9620
9621     /* Go through each input list item by item, stopping when have exhausted
9622      * one of them */
9623     while (i_a < len_a && i_b < len_b) {
9624         UV cp;      /* The element to potentially add to the union's array */
9625         bool cp_in_set;   /* is it in the the input list's set or not */
9626
9627         /* We need to take one or the other of the two inputs for the union.
9628          * Since we are merging two sorted lists, we take the smaller of the
9629          * next items.  In case of a tie, we take first the one that is in its
9630          * set.  If we first took the one not in its set, it would decrement
9631          * the count, possibly to 0 which would cause it to be output as ending
9632          * the range, and the next time through we would take the same number,
9633          * and output it again as beginning the next range.  By doing it the
9634          * opposite way, there is no possibility that the count will be
9635          * momentarily decremented to 0, and thus the two adjoining ranges will
9636          * be seamlessly merged.  (In a tie and both are in the set or both not
9637          * in the set, it doesn't matter which we take first.) */
9638         if (       array_a[i_a] < array_b[i_b]
9639             || (   array_a[i_a] == array_b[i_b]
9640                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9641         {
9642             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9643             cp = array_a[i_a++];
9644         }
9645         else {
9646             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9647             cp = array_b[i_b++];
9648         }
9649
9650         /* Here, have chosen which of the two inputs to look at.  Only output
9651          * if the running count changes to/from 0, which marks the
9652          * beginning/end of a range that's in the set */
9653         if (cp_in_set) {
9654             if (count == 0) {
9655                 array_u[i_u++] = cp;
9656             }
9657             count++;
9658         }
9659         else {
9660             count--;
9661             if (count == 0) {
9662                 array_u[i_u++] = cp;
9663             }
9664         }
9665     }
9666
9667
9668     /* The loop above increments the index into exactly one of the input lists
9669      * each iteration, and ends when either index gets to its list end.  That
9670      * means the other index is lower than its end, and so something is
9671      * remaining in that one.  We decrement 'count', as explained below, if
9672      * that list is in its set.  (i_a and i_b each currently index the element
9673      * beyond the one we care about.) */
9674     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9675         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9676     {
9677         count--;
9678     }
9679
9680     /* Above we decremented 'count' if the list that had unexamined elements in
9681      * it was in its set.  This has made it so that 'count' being non-zero
9682      * means there isn't anything left to output; and 'count' equal to 0 means
9683      * that what is left to output is precisely that which is left in the
9684      * non-exhausted input list.
9685      *
9686      * To see why, note first that the exhausted input obviously has nothing
9687      * left to add to the union.  If it was in its set at its end, that means
9688      * the set extends from here to the platform's infinity, and hence so does
9689      * the union and the non-exhausted set is irrelevant.  The exhausted set
9690      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9691      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9692      * 'count' remains at 1.  This is consistent with the decremented 'count'
9693      * != 0 meaning there's nothing left to add to the union.
9694      *
9695      * But if the exhausted input wasn't in its set, it contributed 0 to
9696      * 'count', and the rest of the union will be whatever the other input is.
9697      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9698      * otherwise it gets decremented to 0.  This is consistent with 'count'
9699      * == 0 meaning the remainder of the union is whatever is left in the
9700      * non-exhausted list. */
9701     if (count != 0) {
9702         len_u = i_u;
9703     }
9704     else {
9705         IV copy_count = len_a - i_a;
9706         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9707             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9708         }
9709         else { /* The non-exhausted input is b */
9710             copy_count = len_b - i_b;
9711             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9712         }
9713         len_u = i_u + copy_count;
9714     }
9715
9716     /* Set the result to the final length, which can change the pointer to
9717      * array_u, so re-find it.  (Note that it is unlikely that this will
9718      * change, as we are shrinking the space, not enlarging it) */
9719     if (len_u != _invlist_len(u)) {
9720         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9721         invlist_trim(u);
9722         array_u = invlist_array(u);
9723     }
9724
9725     if (*output == NULL) {  /* Simply return the new inversion list */
9726         *output = u;
9727     }
9728     else {
9729         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9730          * could instead free '*output', and then set it to 'u', but experience
9731          * has shown [perl #127392] that if the input is a mortal, we can get a
9732          * huge build-up of these during regex compilation before they get
9733          * freed. */
9734         invlist_replace_list_destroys_src(*output, u);
9735         SvREFCNT_dec_NN(u);
9736     }
9737
9738     return;
9739 }
9740
9741 void
9742 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9743                                                const bool complement_b, SV** i)
9744 {
9745     /* Take the intersection of two inversion lists and point '*i' to it.  On
9746      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9747      * even 'a' or 'b').  If to an inversion list, the contents of the original
9748      * list will be replaced by the intersection.  The first list, 'a', may be
9749      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9750      * TRUE, the result will be the intersection of 'a' and the complement (or
9751      * inversion) of 'b' instead of 'b' directly.
9752      *
9753      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9754      * Richard Gillam, published by Addison-Wesley, and explained at some
9755      * length there.  The preface says to incorporate its examples into your
9756      * code at your own risk.  In fact, it had bugs
9757      *
9758      * The algorithm is like a merge sort, and is essentially the same as the
9759      * union above
9760      */
9761
9762     const UV* array_a;          /* a's array */
9763     const UV* array_b;
9764     UV len_a;   /* length of a's array */
9765     UV len_b;
9766
9767     SV* r;                   /* the resulting intersection */
9768     UV* array_r;
9769     UV len_r = 0;
9770
9771     UV i_a = 0;             /* current index into a's array */
9772     UV i_b = 0;
9773     UV i_r = 0;
9774
9775     /* running count of how many of the two inputs are postitioned at ranges
9776      * that are in their sets.  As explained in the algorithm source book,
9777      * items are stopped accumulating and are output when the count changes
9778      * to/from 2.  The count is incremented when we start a range that's in an
9779      * input's set, and decremented when we start a range that's not in a set.
9780      * Only when it is 2 are we in the intersection. */
9781     UV count = 0;
9782
9783     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9784     assert(a != b);
9785     assert(*i == NULL || is_invlist(*i));
9786
9787     /* Special case if either one is empty */
9788     len_a = (a == NULL) ? 0 : _invlist_len(a);
9789     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9790         if (len_a != 0 && complement_b) {
9791
9792             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9793              * must be empty.  Here, also we are using 'b's complement, which
9794              * hence must be every possible code point.  Thus the intersection
9795              * is simply 'a'. */
9796
9797             if (*i == a) {  /* No-op */
9798                 return;
9799             }
9800
9801             if (*i == NULL) {
9802                 *i = invlist_clone(a, NULL);
9803                 return;
9804             }
9805
9806             r = invlist_clone(a, NULL);
9807             invlist_replace_list_destroys_src(*i, r);
9808             SvREFCNT_dec_NN(r);
9809             return;
9810         }
9811
9812         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9813          * intersection must be empty */
9814         if (*i == NULL) {
9815             *i = _new_invlist(0);
9816             return;
9817         }
9818
9819         invlist_clear(*i);
9820         return;
9821     }
9822
9823     /* Here both lists exist and are non-empty */
9824     array_a = invlist_array(a);
9825     array_b = invlist_array(b);
9826
9827     /* If are to take the intersection of 'a' with the complement of b, set it
9828      * up so are looking at b's complement. */
9829     if (complement_b) {
9830
9831         /* To complement, we invert: if the first element is 0, remove it.  To
9832          * do this, we just pretend the array starts one later */
9833         if (array_b[0] == 0) {
9834             array_b++;
9835             len_b--;
9836         }
9837         else {
9838
9839             /* But if the first element is not zero, we pretend the list starts
9840              * at the 0 that is always stored immediately before the array. */
9841             array_b--;
9842             len_b++;
9843         }
9844     }
9845
9846     /* Size the intersection for the worst case: that the intersection ends up
9847      * fragmenting everything to be completely disjoint */
9848     r= _new_invlist(len_a + len_b);
9849
9850     /* Will contain U+0000 iff both components do */
9851     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9852                                      && len_b > 0 && array_b[0] == 0);
9853
9854     /* Go through each list item by item, stopping when have exhausted one of
9855      * them */
9856     while (i_a < len_a && i_b < len_b) {
9857         UV cp;      /* The element to potentially add to the intersection's
9858                        array */
9859         bool cp_in_set; /* Is it in the input list's set or not */
9860
9861         /* We need to take one or the other of the two inputs for the
9862          * intersection.  Since we are merging two sorted lists, we take the
9863          * smaller of the next items.  In case of a tie, we take first the one
9864          * that is not in its set (a difference from the union algorithm).  If
9865          * we first took the one in its set, it would increment the count,
9866          * possibly to 2 which would cause it to be output as starting a range
9867          * in the intersection, and the next time through we would take that
9868          * same number, and output it again as ending the set.  By doing the
9869          * opposite of this, there is no possibility that the count will be
9870          * momentarily incremented to 2.  (In a tie and both are in the set or
9871          * both not in the set, it doesn't matter which we take first.) */
9872         if (       array_a[i_a] < array_b[i_b]
9873             || (   array_a[i_a] == array_b[i_b]
9874                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9875         {
9876             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9877             cp = array_a[i_a++];
9878         }
9879         else {
9880             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9881             cp= array_b[i_b++];
9882         }
9883
9884         /* Here, have chosen which of the two inputs to look at.  Only output
9885          * if the running count changes to/from 2, which marks the
9886          * beginning/end of a range that's in the intersection */
9887         if (cp_in_set) {
9888             count++;
9889             if (count == 2) {
9890                 array_r[i_r++] = cp;
9891             }
9892         }
9893         else {
9894             if (count == 2) {
9895                 array_r[i_r++] = cp;
9896             }
9897             count--;
9898         }
9899
9900     }
9901
9902     /* The loop above increments the index into exactly one of the input lists
9903      * each iteration, and ends when either index gets to its list end.  That
9904      * means the other index is lower than its end, and so something is
9905      * remaining in that one.  We increment 'count', as explained below, if the
9906      * exhausted list was in its set.  (i_a and i_b each currently index the
9907      * element beyond the one we care about.) */
9908     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9909         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9910     {
9911         count++;
9912     }
9913
9914     /* Above we incremented 'count' if the exhausted list was in its set.  This
9915      * has made it so that 'count' being below 2 means there is nothing left to
9916      * output; otheriwse what's left to add to the intersection is precisely
9917      * that which is left in the non-exhausted input list.
9918      *
9919      * To see why, note first that the exhausted input obviously has nothing
9920      * left to affect the intersection.  If it was in its set at its end, that
9921      * means the set extends from here to the platform's infinity, and hence
9922      * anything in the non-exhausted's list will be in the intersection, and
9923      * anything not in it won't be.  Hence, the rest of the intersection is
9924      * precisely what's in the non-exhausted list  The exhausted set also
9925      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
9926      * it means 'count' is now at least 2.  This is consistent with the
9927      * incremented 'count' being >= 2 means to add the non-exhausted list to
9928      * the intersection.
9929      *
9930      * But if the exhausted input wasn't in its set, it contributed 0 to
9931      * 'count', and the intersection can't include anything further; the
9932      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
9933      * incremented.  This is consistent with 'count' being < 2 meaning nothing
9934      * further to add to the intersection. */
9935     if (count < 2) { /* Nothing left to put in the intersection. */
9936         len_r = i_r;
9937     }
9938     else { /* copy the non-exhausted list, unchanged. */
9939         IV copy_count = len_a - i_a;
9940         if (copy_count > 0) {   /* a is the one with stuff left */
9941             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
9942         }
9943         else {  /* b is the one with stuff left */
9944             copy_count = len_b - i_b;
9945             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
9946         }
9947         len_r = i_r + copy_count;
9948     }
9949
9950     /* Set the result to the final length, which can change the pointer to
9951      * array_r, so re-find it.  (Note that it is unlikely that this will
9952      * change, as we are shrinking the space, not enlarging it) */
9953     if (len_r != _invlist_len(r)) {
9954         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
9955         invlist_trim(r);
9956         array_r = invlist_array(r);
9957     }
9958
9959     if (*i == NULL) { /* Simply return the calculated intersection */
9960         *i = r;
9961     }
9962     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
9963               instead free '*i', and then set it to 'r', but experience has
9964               shown [perl #127392] that if the input is a mortal, we can get a
9965               huge build-up of these during regex compilation before they get
9966               freed. */
9967         if (len_r) {
9968             invlist_replace_list_destroys_src(*i, r);
9969         }
9970         else {
9971             invlist_clear(*i);
9972         }
9973         SvREFCNT_dec_NN(r);
9974     }
9975
9976     return;
9977 }
9978
9979 SV*
9980 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
9981 {
9982     /* Add the range from 'start' to 'end' inclusive to the inversion list's
9983      * set.  A pointer to the inversion list is returned.  This may actually be
9984      * a new list, in which case the passed in one has been destroyed.  The
9985      * passed-in inversion list can be NULL, in which case a new one is created
9986      * with just the one range in it.  The new list is not necessarily
9987      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
9988      * result of this function.  The gain would not be large, and in many
9989      * cases, this is called multiple times on a single inversion list, so
9990      * anything freed may almost immediately be needed again.
9991      *
9992      * This used to mostly call the 'union' routine, but that is much more
9993      * heavyweight than really needed for a single range addition */
9994
9995     UV* array;              /* The array implementing the inversion list */
9996     UV len;                 /* How many elements in 'array' */
9997     SSize_t i_s;            /* index into the invlist array where 'start'
9998                                should go */
9999     SSize_t i_e = 0;        /* And the index where 'end' should go */
10000     UV cur_highest;         /* The highest code point in the inversion list
10001                                upon entry to this function */
10002
10003     /* This range becomes the whole inversion list if none already existed */
10004     if (invlist == NULL) {
10005         invlist = _new_invlist(2);
10006         _append_range_to_invlist(invlist, start, end);
10007         return invlist;
10008     }
10009
10010     /* Likewise, if the inversion list is currently empty */
10011     len = _invlist_len(invlist);
10012     if (len == 0) {
10013         _append_range_to_invlist(invlist, start, end);
10014         return invlist;
10015     }
10016
10017     /* Starting here, we have to know the internals of the list */
10018     array = invlist_array(invlist);
10019
10020     /* If the new range ends higher than the current highest ... */
10021     cur_highest = invlist_highest(invlist);
10022     if (end > cur_highest) {
10023
10024         /* If the whole range is higher, we can just append it */
10025         if (start > cur_highest) {
10026             _append_range_to_invlist(invlist, start, end);
10027             return invlist;
10028         }
10029
10030         /* Otherwise, add the portion that is higher ... */
10031         _append_range_to_invlist(invlist, cur_highest + 1, end);
10032
10033         /* ... and continue on below to handle the rest.  As a result of the
10034          * above append, we know that the index of the end of the range is the
10035          * final even numbered one of the array.  Recall that the final element
10036          * always starts a range that extends to infinity.  If that range is in
10037          * the set (meaning the set goes from here to infinity), it will be an
10038          * even index, but if it isn't in the set, it's odd, and the final
10039          * range in the set is one less, which is even. */
10040         if (end == UV_MAX) {
10041             i_e = len;
10042         }
10043         else {
10044             i_e = len - 2;
10045         }
10046     }
10047
10048     /* We have dealt with appending, now see about prepending.  If the new
10049      * range starts lower than the current lowest ... */
10050     if (start < array[0]) {
10051
10052         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
10053          * Let the union code handle it, rather than having to know the
10054          * trickiness in two code places.  */
10055         if (UNLIKELY(start == 0)) {
10056             SV* range_invlist;
10057
10058             range_invlist = _new_invlist(2);
10059             _append_range_to_invlist(range_invlist, start, end);
10060
10061             _invlist_union(invlist, range_invlist, &invlist);
10062
10063             SvREFCNT_dec_NN(range_invlist);
10064
10065             return invlist;
10066         }
10067
10068         /* If the whole new range comes before the first entry, and doesn't
10069          * extend it, we have to insert it as an additional range */
10070         if (end < array[0] - 1) {
10071             i_s = i_e = -1;
10072             goto splice_in_new_range;
10073         }
10074
10075         /* Here the new range adjoins the existing first range, extending it
10076          * downwards. */
10077         array[0] = start;
10078
10079         /* And continue on below to handle the rest.  We know that the index of
10080          * the beginning of the range is the first one of the array */
10081         i_s = 0;
10082     }
10083     else { /* Not prepending any part of the new range to the existing list.
10084             * Find where in the list it should go.  This finds i_s, such that:
10085             *     invlist[i_s] <= start < array[i_s+1]
10086             */
10087         i_s = _invlist_search(invlist, start);
10088     }
10089
10090     /* At this point, any extending before the beginning of the inversion list
10091      * and/or after the end has been done.  This has made it so that, in the
10092      * code below, each endpoint of the new range is either in a range that is
10093      * in the set, or is in a gap between two ranges that are.  This means we
10094      * don't have to worry about exceeding the array bounds.
10095      *
10096      * Find where in the list the new range ends (but we can skip this if we
10097      * have already determined what it is, or if it will be the same as i_s,
10098      * which we already have computed) */
10099     if (i_e == 0) {
10100         i_e = (start == end)
10101               ? i_s
10102               : _invlist_search(invlist, end);
10103     }
10104
10105     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
10106      * is a range that goes to infinity there is no element at invlist[i_e+1],
10107      * so only the first relation holds. */
10108
10109     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10110
10111         /* Here, the ranges on either side of the beginning of the new range
10112          * are in the set, and this range starts in the gap between them.
10113          *
10114          * The new range extends the range above it downwards if the new range
10115          * ends at or above that range's start */
10116         const bool extends_the_range_above = (   end == UV_MAX
10117                                               || end + 1 >= array[i_s+1]);
10118
10119         /* The new range extends the range below it upwards if it begins just
10120          * after where that range ends */
10121         if (start == array[i_s]) {
10122
10123             /* If the new range fills the entire gap between the other ranges,
10124              * they will get merged together.  Other ranges may also get
10125              * merged, depending on how many of them the new range spans.  In
10126              * the general case, we do the merge later, just once, after we
10127              * figure out how many to merge.  But in the case where the new
10128              * range exactly spans just this one gap (possibly extending into
10129              * the one above), we do the merge here, and an early exit.  This
10130              * is done here to avoid having to special case later. */
10131             if (i_e - i_s <= 1) {
10132
10133                 /* If i_e - i_s == 1, it means that the new range terminates
10134                  * within the range above, and hence 'extends_the_range_above'
10135                  * must be true.  (If the range above it extends to infinity,
10136                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
10137                  * will be 0, so no harm done.) */
10138                 if (extends_the_range_above) {
10139                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
10140                     invlist_set_len(invlist,
10141                                     len - 2,
10142                                     *(get_invlist_offset_addr(invlist)));
10143                     return invlist;
10144                 }
10145
10146                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
10147                  * to the same range, and below we are about to decrement i_s
10148                  * */
10149                 i_e--;
10150             }
10151
10152             /* Here, the new range is adjacent to the one below.  (It may also
10153              * span beyond the range above, but that will get resolved later.)
10154              * Extend the range below to include this one. */
10155             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
10156             i_s--;
10157             start = array[i_s];
10158         }
10159         else if (extends_the_range_above) {
10160
10161             /* Here the new range only extends the range above it, but not the
10162              * one below.  It merges with the one above.  Again, we keep i_e
10163              * and i_s in sync if they point to the same range */
10164             if (i_e == i_s) {
10165                 i_e++;
10166             }
10167             i_s++;
10168             array[i_s] = start;
10169         }
10170     }
10171
10172     /* Here, we've dealt with the new range start extending any adjoining
10173      * existing ranges.
10174      *
10175      * If the new range extends to infinity, it is now the final one,
10176      * regardless of what was there before */
10177     if (UNLIKELY(end == UV_MAX)) {
10178         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
10179         return invlist;
10180     }
10181
10182     /* If i_e started as == i_s, it has also been dealt with,
10183      * and been updated to the new i_s, which will fail the following if */
10184     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
10185
10186         /* Here, the ranges on either side of the end of the new range are in
10187          * the set, and this range ends in the gap between them.
10188          *
10189          * If this range is adjacent to (hence extends) the range above it, it
10190          * becomes part of that range; likewise if it extends the range below,
10191          * it becomes part of that range */
10192         if (end + 1 == array[i_e+1]) {
10193             i_e++;
10194             array[i_e] = start;
10195         }
10196         else if (start <= array[i_e]) {
10197             array[i_e] = end + 1;
10198             i_e--;
10199         }
10200     }
10201
10202     if (i_s == i_e) {
10203
10204         /* If the range fits entirely in an existing range (as possibly already
10205          * extended above), it doesn't add anything new */
10206         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10207             return invlist;
10208         }
10209
10210         /* Here, no part of the range is in the list.  Must add it.  It will
10211          * occupy 2 more slots */
10212       splice_in_new_range:
10213
10214         invlist_extend(invlist, len + 2);
10215         array = invlist_array(invlist);
10216         /* Move the rest of the array down two slots. Don't include any
10217          * trailing NUL */
10218         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
10219
10220         /* Do the actual splice */
10221         array[i_e+1] = start;
10222         array[i_e+2] = end + 1;
10223         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
10224         return invlist;
10225     }
10226
10227     /* Here the new range crossed the boundaries of a pre-existing range.  The
10228      * code above has adjusted things so that both ends are in ranges that are
10229      * in the set.  This means everything in between must also be in the set.
10230      * Just squash things together */
10231     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
10232     invlist_set_len(invlist,
10233                     len - i_e + i_s,
10234                     *(get_invlist_offset_addr(invlist)));
10235
10236     return invlist;
10237 }
10238
10239 SV*
10240 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
10241                                  UV** other_elements_ptr)
10242 {
10243     /* Create and return an inversion list whose contents are to be populated
10244      * by the caller.  The caller gives the number of elements (in 'size') and
10245      * the very first element ('element0').  This function will set
10246      * '*other_elements_ptr' to an array of UVs, where the remaining elements
10247      * are to be placed.
10248      *
10249      * Obviously there is some trust involved that the caller will properly
10250      * fill in the other elements of the array.
10251      *
10252      * (The first element needs to be passed in, as the underlying code does
10253      * things differently depending on whether it is zero or non-zero) */
10254
10255     SV* invlist = _new_invlist(size);
10256     bool offset;
10257
10258     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
10259
10260     invlist = add_cp_to_invlist(invlist, element0);
10261     offset = *get_invlist_offset_addr(invlist);
10262
10263     invlist_set_len(invlist, size, offset);
10264     *other_elements_ptr = invlist_array(invlist) + 1;
10265     return invlist;
10266 }
10267
10268 #endif
10269
10270 PERL_STATIC_INLINE SV*
10271 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
10272     return _add_range_to_invlist(invlist, cp, cp);
10273 }
10274
10275 #ifndef PERL_IN_XSUB_RE
10276 void
10277 Perl__invlist_invert(pTHX_ SV* const invlist)
10278 {
10279     /* Complement the input inversion list.  This adds a 0 if the list didn't
10280      * have a zero; removes it otherwise.  As described above, the data
10281      * structure is set up so that this is very efficient */
10282
10283     PERL_ARGS_ASSERT__INVLIST_INVERT;
10284
10285     assert(! invlist_is_iterating(invlist));
10286
10287     /* The inverse of matching nothing is matching everything */
10288     if (_invlist_len(invlist) == 0) {
10289         _append_range_to_invlist(invlist, 0, UV_MAX);
10290         return;
10291     }
10292
10293     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
10294 }
10295
10296 SV*
10297 Perl_invlist_clone(pTHX_ SV* const invlist, SV* new_invlist)
10298 {
10299     /* Return a new inversion list that is a copy of the input one, which is
10300      * unchanged.  The new list will not be mortal even if the old one was. */
10301
10302     const STRLEN nominal_length = _invlist_len(invlist);
10303     const STRLEN physical_length = SvCUR(invlist);
10304     const bool offset = *(get_invlist_offset_addr(invlist));
10305
10306     PERL_ARGS_ASSERT_INVLIST_CLONE;
10307
10308     if (new_invlist == NULL) {
10309         new_invlist = _new_invlist(nominal_length);
10310     }
10311     else {
10312         sv_upgrade(new_invlist, SVt_INVLIST);
10313         initialize_invlist_guts(new_invlist, nominal_length);
10314     }
10315
10316     *(get_invlist_offset_addr(new_invlist)) = offset;
10317     invlist_set_len(new_invlist, nominal_length, offset);
10318     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
10319
10320     return new_invlist;
10321 }
10322
10323 #endif
10324
10325 PERL_STATIC_INLINE STRLEN*
10326 S_get_invlist_iter_addr(SV* invlist)
10327 {
10328     /* Return the address of the UV that contains the current iteration
10329      * position */
10330
10331     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
10332
10333     assert(is_invlist(invlist));
10334
10335     return &(((XINVLIST*) SvANY(invlist))->iterator);
10336 }
10337
10338 PERL_STATIC_INLINE void
10339 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
10340 {
10341     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
10342
10343     *get_invlist_iter_addr(invlist) = 0;
10344 }
10345
10346 PERL_STATIC_INLINE void
10347 S_invlist_iterfinish(SV* invlist)
10348 {
10349     /* Terminate iterator for invlist.  This is to catch development errors.
10350      * Any iteration that is interrupted before completed should call this
10351      * function.  Functions that add code points anywhere else but to the end
10352      * of an inversion list assert that they are not in the middle of an
10353      * iteration.  If they were, the addition would make the iteration
10354      * problematical: if the iteration hadn't reached the place where things
10355      * were being added, it would be ok */
10356
10357     PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
10358
10359     *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
10360 }
10361
10362 STATIC bool
10363 S_invlist_iternext(SV* invlist, UV* start, UV* end)
10364 {
10365     /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
10366      * This call sets in <*start> and <*end>, the next range in <invlist>.
10367      * Returns <TRUE> if successful and the next call will return the next
10368      * range; <FALSE> if was already at the end of the list.  If the latter,
10369      * <*start> and <*end> are unchanged, and the next call to this function
10370      * will start over at the beginning of the list */
10371
10372     STRLEN* pos = get_invlist_iter_addr(invlist);
10373     UV len = _invlist_len(invlist);
10374     UV *array;
10375
10376     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
10377
10378     if (*pos >= len) {
10379         *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
10380         return FALSE;
10381     }
10382
10383     array = invlist_array(invlist);
10384
10385     *start = array[(*pos)++];
10386
10387     if (*pos >= len) {
10388         *end = UV_MAX;
10389     }
10390     else {
10391         *end = array[(*pos)++] - 1;
10392     }
10393
10394     return TRUE;
10395 }
10396
10397 PERL_STATIC_INLINE UV
10398 S_invlist_highest(SV* const invlist)
10399 {
10400     /* Returns the highest code point that matches an inversion list.  This API
10401      * has an ambiguity, as it returns 0 under either the highest is actually
10402      * 0, or if the list is empty.  If this distinction matters to you, check
10403      * for emptiness before calling this function */
10404
10405     UV len = _invlist_len(invlist);
10406     UV *array;
10407
10408     PERL_ARGS_ASSERT_INVLIST_HIGHEST;
10409
10410     if (len == 0) {
10411         return 0;
10412     }
10413
10414     array = invlist_array(invlist);
10415
10416     /* The last element in the array in the inversion list always starts a
10417      * range that goes to infinity.  That range may be for code points that are
10418      * matched in the inversion list, or it may be for ones that aren't
10419      * matched.  In the latter case, the highest code point in the set is one
10420      * less than the beginning of this range; otherwise it is the final element
10421      * of this range: infinity */
10422     return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
10423            ? UV_MAX
10424            : array[len - 1] - 1;
10425 }
10426
10427 STATIC SV *
10428 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10429 {
10430     /* Get the contents of an inversion list into a string SV so that they can
10431      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10432      * traditionally done for debug tracing; otherwise it uses a format
10433      * suitable for just copying to the output, with blanks between ranges and
10434      * a dash between range components */
10435
10436     UV start, end;
10437     SV* output;
10438     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10439     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10440
10441     if (traditional_style) {
10442         output = newSVpvs("\n");
10443     }
10444     else {
10445         output = newSVpvs("");
10446     }
10447
10448     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10449
10450     assert(! invlist_is_iterating(invlist));
10451
10452     invlist_iterinit(invlist);
10453     while (invlist_iternext(invlist, &start, &end)) {
10454         if (end == UV_MAX) {
10455             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFTY%c",
10456                                           start, intra_range_delimiter,
10457                                                  inter_range_delimiter);
10458         }
10459         else if (end != start) {
10460             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10461                                           start,
10462                                                    intra_range_delimiter,
10463                                                   end, inter_range_delimiter);
10464         }
10465         else {
10466             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10467                                           start, inter_range_delimiter);
10468         }
10469     }
10470
10471     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10472         SvCUR_set(output, SvCUR(output) - 1);
10473     }
10474
10475     return output;
10476 }
10477
10478 #ifndef PERL_IN_XSUB_RE
10479 void
10480 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10481                          const char * const indent, SV* const invlist)
10482 {
10483     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10484      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10485      * the string 'indent'.  The output looks like this:
10486          [0] 0x000A .. 0x000D
10487          [2] 0x0085
10488          [4] 0x2028 .. 0x2029
10489          [6] 0x3104 .. INFTY
10490      * This means that the first range of code points matched by the list are
10491      * 0xA through 0xD; the second range contains only the single code point
10492      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10493      * are used to define each range (except if the final range extends to
10494      * infinity, only a single element is needed).  The array index of the
10495      * first element for the corresponding range is given in brackets. */
10496
10497     UV start, end;
10498     STRLEN count = 0;
10499
10500     PERL_ARGS_ASSERT__INVLIST_DUMP;
10501
10502     if (invlist_is_iterating(invlist)) {
10503         Perl_dump_indent(aTHX_ level, file,
10504              "%sCan't dump inversion list because is in middle of iterating\n",
10505              indent);
10506         return;
10507     }
10508
10509     invlist_iterinit(invlist);
10510     while (invlist_iternext(invlist, &start, &end)) {
10511         if (end == UV_MAX) {
10512             Perl_dump_indent(aTHX_ level, file,
10513                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFTY\n",
10514                                    indent, (UV)count, start);
10515         }
10516         else if (end != start) {
10517             Perl_dump_indent(aTHX_ level, file,
10518                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10519                                 indent, (UV)count, start,         end);
10520         }
10521         else {
10522             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10523                                             indent, (UV)count, start);
10524         }
10525         count += 2;
10526     }
10527 }
10528
10529 #endif
10530
10531 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10532 bool
10533 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10534 {
10535     /* Return a boolean as to if the two passed in inversion lists are
10536      * identical.  The final argument, if TRUE, says to take the complement of
10537      * the second inversion list before doing the comparison */
10538
10539     const UV len_a = _invlist_len(a);
10540     UV len_b = _invlist_len(b);
10541
10542     const UV* array_a = NULL;
10543     const UV* array_b = NULL;
10544
10545     PERL_ARGS_ASSERT__INVLISTEQ;
10546
10547     /* This code avoids accessing the arrays unless it knows the length is
10548      * non-zero */
10549
10550     if (len_a == 0) {
10551         if (len_b == 0) {
10552             return ! complement_b;
10553         }
10554     }
10555     else {
10556         array_a = invlist_array(a);
10557     }
10558
10559     if (len_b != 0) {
10560         array_b = invlist_array(b);
10561     }
10562
10563     /* If are to compare 'a' with the complement of b, set it
10564      * up so are looking at b's complement. */
10565     if (complement_b) {
10566
10567         /* The complement of nothing is everything, so <a> would have to have
10568          * just one element, starting at zero (ending at infinity) */
10569         if (len_b == 0) {
10570             return (len_a == 1 && array_a[0] == 0);
10571         }
10572         if (array_b[0] == 0) {
10573
10574             /* Otherwise, to complement, we invert.  Here, the first element is
10575              * 0, just remove it.  To do this, we just pretend the array starts
10576              * one later */
10577
10578             array_b++;
10579             len_b--;
10580         }
10581         else {
10582
10583             /* But if the first element is not zero, we pretend the list starts
10584              * at the 0 that is always stored immediately before the array. */
10585             array_b--;
10586             len_b++;
10587         }
10588     }
10589
10590     return    len_a == len_b
10591            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10592
10593 }
10594 #endif
10595
10596 /*
10597  * As best we can, determine the characters that can match the start of
10598  * the given EXACTF-ish node.  This is for use in creating ssc nodes, so there
10599  * can be false positive matches
10600  *
10601  * Returns the invlist as a new SV*; it is the caller's responsibility to
10602  * call SvREFCNT_dec() when done with it.
10603  */
10604 STATIC SV*
10605 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10606 {
10607     dVAR;
10608     const U8 * s = (U8*)STRING(node);
10609     SSize_t bytelen = STR_LEN(node);
10610     UV uc;
10611     /* Start out big enough for 2 separate code points */
10612     SV* invlist = _new_invlist(4);
10613
10614     PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
10615
10616     if (! UTF) {
10617         uc = *s;
10618
10619         /* We punt and assume can match anything if the node begins
10620          * with a multi-character fold.  Things are complicated.  For
10621          * example, /ffi/i could match any of:
10622          *  "\N{LATIN SMALL LIGATURE FFI}"
10623          *  "\N{LATIN SMALL LIGATURE FF}I"
10624          *  "F\N{LATIN SMALL LIGATURE FI}"
10625          *  plus several other things; and making sure we have all the
10626          *  possibilities is hard. */
10627         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10628             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10629         }
10630         else {
10631             /* Any Latin1 range character can potentially match any
10632              * other depending on the locale, and in Turkic locales, U+130 and
10633              * U+131 */
10634             if (OP(node) == EXACTFL) {
10635                 _invlist_union(invlist, PL_Latin1, &invlist);
10636                 invlist = add_cp_to_invlist(invlist,
10637                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10638                 invlist = add_cp_to_invlist(invlist,
10639                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10640             }
10641             else {
10642                 /* But otherwise, it matches at least itself.  We can
10643                  * quickly tell if it has a distinct fold, and if so,
10644                  * it matches that as well */
10645                 invlist = add_cp_to_invlist(invlist, uc);
10646                 if (IS_IN_SOME_FOLD_L1(uc))
10647                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10648             }
10649
10650             /* Some characters match above-Latin1 ones under /i.  This
10651              * is true of EXACTFL ones when the locale is UTF-8 */
10652             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10653                 && (! isASCII(uc) || (OP(node) != EXACTFAA
10654                                     && OP(node) != EXACTFAA_NO_TRIE)))
10655             {
10656                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10657             }
10658         }
10659     }
10660     else {  /* Pattern is UTF-8 */
10661         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10662         const U8* e = s + bytelen;
10663         IV fc;
10664
10665         fc = uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10666
10667         /* The only code points that aren't folded in a UTF EXACTFish
10668          * node are are the problematic ones in EXACTFL nodes */
10669         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10670             /* We need to check for the possibility that this EXACTFL
10671              * node begins with a multi-char fold.  Therefore we fold
10672              * the first few characters of it so that we can make that
10673              * check */
10674             U8 *d = folded;
10675             int i;
10676
10677             fc = -1;
10678             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10679                 if (isASCII(*s)) {
10680                     *(d++) = (U8) toFOLD(*s);
10681                     if (fc < 0) {       /* Save the first fold */
10682                         fc = *(d-1);
10683                     }
10684                     s++;
10685                 }
10686                 else {
10687                     STRLEN len;
10688                     UV fold = toFOLD_utf8_safe(s, e, d, &len);
10689                     if (fc < 0) {       /* Save the first fold */
10690                         fc = fold;
10691                     }
10692                     d += len;
10693                     s += UTF8SKIP(s);
10694                 }
10695             }
10696
10697             /* And set up so the code below that looks in this folded
10698              * buffer instead of the node's string */
10699             e = d;
10700             s = folded;
10701         }
10702
10703         /* When we reach here 's' points to the fold of the first
10704          * character(s) of the node; and 'e' points to far enough along
10705          * the folded string to be just past any possible multi-char
10706          * fold.
10707          *
10708          * Unlike the non-UTF-8 case, the macro for determining if a
10709          * string is a multi-char fold requires all the characters to
10710          * already be folded.  This is because of all the complications
10711          * if not.  Note that they are folded anyway, except in EXACTFL
10712          * nodes.  Like the non-UTF case above, we punt if the node
10713          * begins with a multi-char fold  */
10714
10715         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10716             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10717         }
10718         else {  /* Single char fold */
10719             unsigned int k;
10720             unsigned int first_fold;
10721             const unsigned int * remaining_folds;
10722             Size_t folds_count;
10723
10724             /* It matches itself */
10725             invlist = add_cp_to_invlist(invlist, fc);
10726
10727             /* ... plus all the things that fold to it, which are found in
10728              * PL_utf8_foldclosures */
10729             folds_count = _inverse_folds(fc, &first_fold,
10730                                                 &remaining_folds);
10731             for (k = 0; k < folds_count; k++) {
10732                 UV c = (k == 0) ? first_fold : remaining_folds[k-1];
10733
10734                 /* /aa doesn't allow folds between ASCII and non- */
10735                 if (   (OP(node) == EXACTFAA || OP(node) == EXACTFAA_NO_TRIE)
10736                     && isASCII(c) != isASCII(fc))
10737                 {
10738                     continue;
10739                 }
10740
10741                 invlist = add_cp_to_invlist(invlist, c);
10742             }
10743
10744             if (OP(node) == EXACTFL) {
10745
10746                 /* If either [iI] are present in an EXACTFL node the above code
10747                  * should have added its normal case pair, but under a Turkish
10748                  * locale they could match instead the case pairs from it.  Add
10749                  * those as potential matches as well */
10750                 if (isALPHA_FOLD_EQ(fc, 'I')) {
10751                     invlist = add_cp_to_invlist(invlist,
10752                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10753                     invlist = add_cp_to_invlist(invlist,
10754                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10755                 }
10756                 else if (fc == LATIN_SMALL_LETTER_DOTLESS_I) {
10757                     invlist = add_cp_to_invlist(invlist, 'I');
10758                 }
10759                 else if (fc == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE) {
10760                     invlist = add_cp_to_invlist(invlist, 'i');
10761                 }
10762             }
10763         }
10764     }
10765
10766     return invlist;
10767 }
10768
10769 #undef HEADER_LENGTH
10770 #undef TO_INTERNAL_SIZE
10771 #undef FROM_INTERNAL_SIZE
10772 #undef INVLIST_VERSION_ID
10773
10774 /* End of inversion list object */
10775
10776 STATIC void
10777 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10778 {
10779     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10780      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10781      * should point to the first flag; it is updated on output to point to the
10782      * final ')' or ':'.  There needs to be at least one flag, or this will
10783      * abort */
10784
10785     /* for (?g), (?gc), and (?o) warnings; warning
10786        about (?c) will warn about (?g) -- japhy    */
10787
10788 #define WASTED_O  0x01
10789 #define WASTED_G  0x02
10790 #define WASTED_C  0x04
10791 #define WASTED_GC (WASTED_G|WASTED_C)
10792     I32 wastedflags = 0x00;
10793     U32 posflags = 0, negflags = 0;
10794     U32 *flagsp = &posflags;
10795     char has_charset_modifier = '\0';
10796     regex_charset cs;
10797     bool has_use_defaults = FALSE;
10798     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10799     int x_mod_count = 0;
10800
10801     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10802
10803     /* '^' as an initial flag sets certain defaults */
10804     if (UCHARAT(RExC_parse) == '^') {
10805         RExC_parse++;
10806         has_use_defaults = TRUE;
10807         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10808         cs = (RExC_uni_semantics)
10809              ? REGEX_UNICODE_CHARSET
10810              : REGEX_DEPENDS_CHARSET;
10811         set_regex_charset(&RExC_flags, cs);
10812     }
10813     else {
10814         cs = get_regex_charset(RExC_flags);
10815         if (   cs == REGEX_DEPENDS_CHARSET
10816             && RExC_uni_semantics)
10817         {
10818             cs = REGEX_UNICODE_CHARSET;
10819         }
10820     }
10821
10822     while (RExC_parse < RExC_end) {
10823         /* && strchr("iogcmsx", *RExC_parse) */
10824         /* (?g), (?gc) and (?o) are useless here
10825            and must be globally applied -- japhy */
10826         switch (*RExC_parse) {
10827
10828             /* Code for the imsxn flags */
10829             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10830
10831             case LOCALE_PAT_MOD:
10832                 if (has_charset_modifier) {
10833                     goto excess_modifier;
10834                 }
10835                 else if (flagsp == &negflags) {
10836                     goto neg_modifier;
10837                 }
10838                 cs = REGEX_LOCALE_CHARSET;
10839                 has_charset_modifier = LOCALE_PAT_MOD;
10840                 break;
10841             case UNICODE_PAT_MOD:
10842                 if (has_charset_modifier) {
10843                     goto excess_modifier;
10844                 }
10845                 else if (flagsp == &negflags) {
10846                     goto neg_modifier;
10847                 }
10848                 cs = REGEX_UNICODE_CHARSET;
10849                 has_charset_modifier = UNICODE_PAT_MOD;
10850                 break;
10851             case ASCII_RESTRICT_PAT_MOD:
10852                 if (flagsp == &negflags) {
10853                     goto neg_modifier;
10854                 }
10855                 if (has_charset_modifier) {
10856                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10857                         goto excess_modifier;
10858                     }
10859                     /* Doubled modifier implies more restricted */
10860                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10861                 }
10862                 else {
10863                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10864                 }
10865                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10866                 break;
10867             case DEPENDS_PAT_MOD:
10868                 if (has_use_defaults) {
10869                     goto fail_modifiers;
10870                 }
10871                 else if (flagsp == &negflags) {
10872                     goto neg_modifier;
10873                 }
10874                 else if (has_charset_modifier) {
10875                     goto excess_modifier;
10876                 }
10877
10878                 /* The dual charset means unicode semantics if the
10879                  * pattern (or target, not known until runtime) are
10880                  * utf8, or something in the pattern indicates unicode
10881                  * semantics */
10882                 cs = (RExC_uni_semantics)
10883                      ? REGEX_UNICODE_CHARSET
10884                      : REGEX_DEPENDS_CHARSET;
10885                 has_charset_modifier = DEPENDS_PAT_MOD;
10886                 break;
10887               excess_modifier:
10888                 RExC_parse++;
10889                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10890                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10891                 }
10892                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10893                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10894                                         *(RExC_parse - 1));
10895                 }
10896                 else {
10897                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10898                 }
10899                 NOT_REACHED; /*NOTREACHED*/
10900               neg_modifier:
10901                 RExC_parse++;
10902                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10903                                     *(RExC_parse - 1));
10904                 NOT_REACHED; /*NOTREACHED*/
10905             case ONCE_PAT_MOD: /* 'o' */
10906             case GLOBAL_PAT_MOD: /* 'g' */
10907                 if (ckWARN(WARN_REGEXP)) {
10908                     const I32 wflagbit = *RExC_parse == 'o'
10909                                          ? WASTED_O
10910                                          : WASTED_G;
10911                     if (! (wastedflags & wflagbit) ) {
10912                         wastedflags |= wflagbit;
10913                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10914                         vWARN5(
10915                             RExC_parse + 1,
10916                             "Useless (%s%c) - %suse /%c modifier",
10917                             flagsp == &negflags ? "?-" : "?",
10918                             *RExC_parse,
10919                             flagsp == &negflags ? "don't " : "",
10920                             *RExC_parse
10921                         );
10922                     }
10923                 }
10924                 break;
10925
10926             case CONTINUE_PAT_MOD: /* 'c' */
10927                 if (ckWARN(WARN_REGEXP)) {
10928                     if (! (wastedflags & WASTED_C) ) {
10929                         wastedflags |= WASTED_GC;
10930                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10931                         vWARN3(
10932                             RExC_parse + 1,
10933                             "Useless (%sc) - %suse /gc modifier",
10934                             flagsp == &negflags ? "?-" : "?",
10935                             flagsp == &negflags ? "don't " : ""
10936                         );
10937                     }
10938                 }
10939                 break;
10940             case KEEPCOPY_PAT_MOD: /* 'p' */
10941                 if (flagsp == &negflags) {
10942                     ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10943                 } else {
10944                     *flagsp |= RXf_PMf_KEEPCOPY;
10945                 }
10946                 break;
10947             case '-':
10948                 /* A flag is a default iff it is following a minus, so
10949                  * if there is a minus, it means will be trying to
10950                  * re-specify a default which is an error */
10951                 if (has_use_defaults || flagsp == &negflags) {
10952                     goto fail_modifiers;
10953                 }
10954                 flagsp = &negflags;
10955                 wastedflags = 0;  /* reset so (?g-c) warns twice */
10956                 x_mod_count = 0;
10957                 break;
10958             case ':':
10959             case ')':
10960
10961                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
10962                     negflags |= RXf_PMf_EXTENDED_MORE;
10963                 }
10964                 RExC_flags |= posflags;
10965
10966                 if (negflags & RXf_PMf_EXTENDED) {
10967                     negflags |= RXf_PMf_EXTENDED_MORE;
10968                 }
10969                 RExC_flags &= ~negflags;
10970                 set_regex_charset(&RExC_flags, cs);
10971
10972                 return;
10973             default:
10974               fail_modifiers:
10975                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
10976                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10977                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
10978                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10979                 NOT_REACHED; /*NOTREACHED*/
10980         }
10981
10982         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10983     }
10984
10985     vFAIL("Sequence (?... not terminated");
10986 }
10987
10988 /*
10989  - reg - regular expression, i.e. main body or parenthesized thing
10990  *
10991  * Caller must absorb opening parenthesis.
10992  *
10993  * Combining parenthesis handling with the base level of regular expression
10994  * is a trifle forced, but the need to tie the tails of the branches to what
10995  * follows makes it hard to avoid.
10996  */
10997 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
10998 #ifdef DEBUGGING
10999 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
11000 #else
11001 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
11002 #endif
11003
11004 PERL_STATIC_INLINE regnode_offset
11005 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
11006                              I32 *flagp,
11007                              char * parse_start,
11008                              char ch
11009                       )
11010 {
11011     regnode_offset ret;
11012     char* name_start = RExC_parse;
11013     U32 num = 0;
11014     SV *sv_dat = reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11015     GET_RE_DEBUG_FLAGS_DECL;
11016
11017     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
11018
11019     if (RExC_parse == name_start || *RExC_parse != ch) {
11020         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
11021         vFAIL2("Sequence %.3s... not terminated", parse_start);
11022     }
11023
11024     if (sv_dat) {
11025         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11026         RExC_rxi->data->data[num]=(void*)sv_dat;
11027         SvREFCNT_inc_simple_void_NN(sv_dat);
11028     }
11029     RExC_sawback = 1;
11030     ret = reganode(pRExC_state,
11031                    ((! FOLD)
11032                      ? REFN
11033                      : (ASCII_FOLD_RESTRICTED)
11034                        ? REFFAN
11035                        : (AT_LEAST_UNI_SEMANTICS)
11036                          ? REFFUN
11037                          : (LOC)
11038                            ? REFFLN
11039                            : REFFN),
11040                     num);
11041     *flagp |= HASWIDTH;
11042
11043     Set_Node_Offset(REGNODE_p(ret), parse_start+1);
11044     Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
11045
11046     nextchar(pRExC_state);
11047     return ret;
11048 }
11049
11050 /* On success, returns the offset at which any next node should be placed into
11051  * the regex engine program being compiled.
11052  *
11053  * Returns 0 otherwise, with *flagp set to indicate why:
11054  *  TRYAGAIN        at the end of (?) that only sets flags.
11055  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
11056  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
11057  *  Otherwise would only return 0 if regbranch() returns 0, which cannot
11058  *  happen.  */
11059 STATIC regnode_offset
11060 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp, U32 depth)
11061     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
11062      * 2 is like 1, but indicates that nextchar() has been called to advance
11063      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
11064      * this flag alerts us to the need to check for that */
11065 {
11066     regnode_offset ret = 0;    /* Will be the head of the group. */
11067     regnode_offset br;
11068     regnode_offset lastbr;
11069     regnode_offset ender = 0;
11070     I32 parno = 0;
11071     I32 flags;
11072     U32 oregflags = RExC_flags;
11073     bool have_branch = 0;
11074     bool is_open = 0;
11075     I32 freeze_paren = 0;
11076     I32 after_freeze = 0;
11077     I32 num; /* numeric backreferences */
11078     SV * max_open;  /* Max number of unclosed parens */
11079
11080     char * parse_start = RExC_parse; /* MJD */
11081     char * const oregcomp_parse = RExC_parse;
11082
11083     GET_RE_DEBUG_FLAGS_DECL;
11084
11085     PERL_ARGS_ASSERT_REG;
11086     DEBUG_PARSE("reg ");
11087
11088
11089     max_open = get_sv(RE_COMPILE_RECURSION_LIMIT, GV_ADD);
11090     assert(max_open);
11091     if (!SvIOK(max_open)) {
11092         sv_setiv(max_open, RE_COMPILE_RECURSION_INIT);
11093     }
11094     if (depth > 4 * (UV) SvIV(max_open)) { /* We increase depth by 4 for each
11095                                               open paren */
11096         vFAIL("Too many nested open parens");
11097     }
11098
11099     *flagp = 0;                         /* Tentatively. */
11100
11101     if (RExC_in_lookbehind) {
11102         RExC_in_lookbehind++;
11103     }
11104     if (RExC_in_lookahead) {
11105         RExC_in_lookahead++;
11106     }
11107
11108     /* Having this true makes it feasible to have a lot fewer tests for the
11109      * parse pointer being in scope.  For example, we can write
11110      *      while(isFOO(*RExC_parse)) RExC_parse++;
11111      * instead of
11112      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
11113      */
11114     assert(*RExC_end == '\0');
11115
11116     /* Make an OPEN node, if parenthesized. */
11117     if (paren) {
11118
11119         /* Under /x, space and comments can be gobbled up between the '(' and
11120          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
11121          * intervening space, as the sequence is a token, and a token should be
11122          * indivisible */
11123         bool has_intervening_patws = (paren == 2)
11124                                   && *(RExC_parse - 1) != '(';
11125
11126         if (RExC_parse >= RExC_end) {
11127             vFAIL("Unmatched (");
11128         }
11129
11130         if (paren == 'r') {     /* Atomic script run */
11131             paren = '>';
11132             goto parse_rest;
11133         }
11134         else if ( *RExC_parse == '*') { /* (*VERB:ARG), (*construct:...) */
11135             char *start_verb = RExC_parse + 1;
11136             STRLEN verb_len;
11137             char *start_arg = NULL;
11138             unsigned char op = 0;
11139             int arg_required = 0;
11140             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
11141             bool has_upper = FALSE;
11142
11143             if (has_intervening_patws) {
11144                 RExC_parse++;   /* past the '*' */
11145
11146                 /* For strict backwards compatibility, don't change the message
11147                  * now that we also have lowercase operands */
11148                 if (isUPPER(*RExC_parse)) {
11149                     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
11150                 }
11151                 else {
11152                     vFAIL("In '(*...)', the '(' and '*' must be adjacent");
11153                 }
11154             }
11155             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
11156                 if ( *RExC_parse == ':' ) {
11157                     start_arg = RExC_parse + 1;
11158                     break;
11159                 }
11160                 else if (! UTF) {
11161                     if (isUPPER(*RExC_parse)) {
11162                         has_upper = TRUE;
11163                     }
11164                     RExC_parse++;
11165                 }
11166                 else {
11167                     RExC_parse += UTF8SKIP(RExC_parse);
11168                 }
11169             }
11170             verb_len = RExC_parse - start_verb;
11171             if ( start_arg ) {
11172                 if (RExC_parse >= RExC_end) {
11173                     goto unterminated_verb_pattern;
11174                 }
11175
11176                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11177                 while ( RExC_parse < RExC_end && *RExC_parse != ')' ) {
11178                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11179                 }
11180                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11181                   unterminated_verb_pattern:
11182                     if (has_upper) {
11183                         vFAIL("Unterminated verb pattern argument");
11184                     }
11185                     else {
11186                         vFAIL("Unterminated '(*...' argument");
11187                     }
11188                 }
11189             } else {
11190                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11191                     if (has_upper) {
11192                         vFAIL("Unterminated verb pattern");
11193                     }
11194                     else {
11195                         vFAIL("Unterminated '(*...' construct");
11196                     }
11197                 }
11198             }
11199
11200             /* Here, we know that RExC_parse < RExC_end */
11201
11202             switch ( *start_verb ) {
11203             case 'A':  /* (*ACCEPT) */
11204                 if ( memEQs(start_verb, verb_len,"ACCEPT") ) {
11205                     op = ACCEPT;
11206                     internal_argval = RExC_nestroot;
11207                 }
11208                 break;
11209             case 'C':  /* (*COMMIT) */
11210                 if ( memEQs(start_verb, verb_len,"COMMIT") )
11211                     op = COMMIT;
11212                 break;
11213             case 'F':  /* (*FAIL) */
11214                 if ( verb_len==1 || memEQs(start_verb, verb_len,"FAIL") ) {
11215                     op = OPFAIL;
11216                 }
11217                 break;
11218             case ':':  /* (*:NAME) */
11219             case 'M':  /* (*MARK:NAME) */
11220                 if ( verb_len==0 || memEQs(start_verb, verb_len,"MARK") ) {
11221                     op = MARKPOINT;
11222                     arg_required = 1;
11223                 }
11224                 break;
11225             case 'P':  /* (*PRUNE) */
11226                 if ( memEQs(start_verb, verb_len,"PRUNE") )
11227                     op = PRUNE;
11228                 break;
11229             case 'S':   /* (*SKIP) */
11230                 if ( memEQs(start_verb, verb_len,"SKIP") )
11231                     op = SKIP;
11232                 break;
11233             case 'T':  /* (*THEN) */
11234                 /* [19:06] <TimToady> :: is then */
11235                 if ( memEQs(start_verb, verb_len,"THEN") ) {
11236                     op = CUTGROUP;
11237                     RExC_seen |= REG_CUTGROUP_SEEN;
11238                 }
11239                 break;
11240             case 'a':
11241                 if (   memEQs(start_verb, verb_len, "asr")
11242                     || memEQs(start_verb, verb_len, "atomic_script_run"))
11243                 {
11244                     paren = 'r';        /* Mnemonic: recursed run */
11245                     goto script_run;
11246                 }
11247                 else if (memEQs(start_verb, verb_len, "atomic")) {
11248                     paren = 't';    /* AtOMIC */
11249                     goto alpha_assertions;
11250                 }
11251                 break;
11252             case 'p':
11253                 if (   memEQs(start_verb, verb_len, "plb")
11254                     || memEQs(start_verb, verb_len, "positive_lookbehind"))
11255                 {
11256                     paren = 'b';
11257                     goto lookbehind_alpha_assertions;
11258                 }
11259                 else if (   memEQs(start_verb, verb_len, "pla")
11260                          || memEQs(start_verb, verb_len, "positive_lookahead"))
11261                 {
11262                     paren = 'a';
11263                     goto alpha_assertions;
11264                 }
11265                 break;
11266             case 'n':
11267                 if (   memEQs(start_verb, verb_len, "nlb")
11268                     || memEQs(start_verb, verb_len, "negative_lookbehind"))
11269                 {
11270                     paren = 'B';
11271                     goto lookbehind_alpha_assertions;
11272                 }
11273                 else if (   memEQs(start_verb, verb_len, "nla")
11274                          || memEQs(start_verb, verb_len, "negative_lookahead"))
11275                 {
11276                     paren = 'A';
11277                     goto alpha_assertions;
11278                 }
11279                 break;
11280             case 's':
11281                 if (   memEQs(start_verb, verb_len, "sr")
11282                     || memEQs(start_verb, verb_len, "script_run"))
11283                 {
11284                     regnode_offset atomic;
11285
11286                     paren = 's';
11287
11288                    script_run:
11289
11290                     /* This indicates Unicode rules. */
11291                     REQUIRE_UNI_RULES(flagp, 0);
11292
11293                     if (! start_arg) {
11294                         goto no_colon;
11295                     }
11296
11297                     RExC_parse = start_arg;
11298
11299                     if (RExC_in_script_run) {
11300
11301                         /*  Nested script runs are treated as no-ops, because
11302                          *  if the nested one fails, the outer one must as
11303                          *  well.  It could fail sooner, and avoid (??{} with
11304                          *  side effects, but that is explicitly documented as
11305                          *  undefined behavior. */
11306
11307                         ret = 0;
11308
11309                         if (paren == 's') {
11310                             paren = ':';
11311                             goto parse_rest;
11312                         }
11313
11314                         /* But, the atomic part of a nested atomic script run
11315                          * isn't a no-op, but can be treated just like a '(?>'
11316                          * */
11317                         paren = '>';
11318                         goto parse_rest;
11319                     }
11320
11321                     /* By doing this here, we avoid extra warnings for nested
11322                      * script runs */
11323                     ckWARNexperimental(RExC_parse,
11324                         WARN_EXPERIMENTAL__SCRIPT_RUN,
11325                         "The script_run feature is experimental");
11326
11327                     if (paren == 's') {
11328                         /* Here, we're starting a new regular script run */
11329                         ret = reg_node(pRExC_state, SROPEN);
11330                         RExC_in_script_run = 1;
11331                         is_open = 1;
11332                         goto parse_rest;
11333                     }
11334
11335                     /* Here, we are starting an atomic script run.  This is
11336                      * handled by recursing to deal with the atomic portion
11337                      * separately, enclosed in SROPEN ... SRCLOSE nodes */
11338
11339                     ret = reg_node(pRExC_state, SROPEN);
11340
11341                     RExC_in_script_run = 1;
11342
11343                     atomic = reg(pRExC_state, 'r', &flags, depth);
11344                     if (flags & (RESTART_PARSE|NEED_UTF8)) {
11345                         *flagp = flags & (RESTART_PARSE|NEED_UTF8);
11346                         return 0;
11347                     }
11348
11349                     if (! REGTAIL(pRExC_state, ret, atomic)) {
11350                         REQUIRE_BRANCHJ(flagp, 0);
11351                     }
11352
11353                     if (! REGTAIL(pRExC_state, atomic, reg_node(pRExC_state,
11354                                                                 SRCLOSE)))
11355                     {
11356                         REQUIRE_BRANCHJ(flagp, 0);
11357                     }
11358
11359                     RExC_in_script_run = 0;
11360                     return ret;
11361                 }
11362
11363                 break;
11364
11365             lookbehind_alpha_assertions:
11366                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11367                 RExC_in_lookbehind++;
11368                 /*FALLTHROUGH*/
11369
11370             alpha_assertions:
11371                 ckWARNexperimental(RExC_parse,
11372                         WARN_EXPERIMENTAL__ALPHA_ASSERTIONS,
11373                         "The alpha_assertions feature is experimental");
11374
11375                 RExC_seen_zerolen++;
11376
11377                 if (! start_arg) {
11378                     goto no_colon;
11379                 }
11380
11381                 /* An empty negative lookahead assertion simply is failure */
11382                 if (paren == 'A' && RExC_parse == start_arg) {
11383                     ret=reganode(pRExC_state, OPFAIL, 0);
11384                     nextchar(pRExC_state);
11385                     return ret;
11386                 }
11387
11388                 RExC_parse = start_arg;
11389                 goto parse_rest;
11390
11391               no_colon:
11392                 vFAIL2utf8f(
11393                 "'(*%" UTF8f "' requires a terminating ':'",
11394                 UTF8fARG(UTF, verb_len, start_verb));
11395                 NOT_REACHED; /*NOTREACHED*/
11396
11397             } /* End of switch */
11398             if ( ! op ) {
11399                 RExC_parse += UTF
11400                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
11401                               : 1;
11402                 if (has_upper || verb_len == 0) {
11403                     vFAIL2utf8f(
11404                     "Unknown verb pattern '%" UTF8f "'",
11405                     UTF8fARG(UTF, verb_len, start_verb));
11406                 }
11407                 else {
11408                     vFAIL2utf8f(
11409                     "Unknown '(*...)' construct '%" UTF8f "'",
11410                     UTF8fARG(UTF, verb_len, start_verb));
11411                 }
11412             }
11413             if ( RExC_parse == start_arg ) {
11414                 start_arg = NULL;
11415             }
11416             if ( arg_required && !start_arg ) {
11417                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
11418                     verb_len, start_verb);
11419             }
11420             if (internal_argval == -1) {
11421                 ret = reganode(pRExC_state, op, 0);
11422             } else {
11423                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
11424             }
11425             RExC_seen |= REG_VERBARG_SEEN;
11426             if (start_arg) {
11427                 SV *sv = newSVpvn( start_arg,
11428                                     RExC_parse - start_arg);
11429                 ARG(REGNODE_p(ret)) = add_data( pRExC_state,
11430                                         STR_WITH_LEN("S"));
11431                 RExC_rxi->data->data[ARG(REGNODE_p(ret))]=(void*)sv;
11432                 FLAGS(REGNODE_p(ret)) = 1;
11433             } else {
11434                 FLAGS(REGNODE_p(ret)) = 0;
11435             }
11436             if ( internal_argval != -1 )
11437                 ARG2L_SET(REGNODE_p(ret), internal_argval);
11438             nextchar(pRExC_state);
11439             return ret;
11440         }
11441         else if (*RExC_parse == '?') { /* (?...) */
11442             bool is_logical = 0;
11443             const char * const seqstart = RExC_parse;
11444             const char * endptr;
11445             if (has_intervening_patws) {
11446                 RExC_parse++;
11447                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
11448             }
11449
11450             RExC_parse++;           /* past the '?' */
11451             paren = *RExC_parse;    /* might be a trailing NUL, if not
11452                                        well-formed */
11453             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11454             if (RExC_parse > RExC_end) {
11455                 paren = '\0';
11456             }
11457             ret = 0;                    /* For look-ahead/behind. */
11458             switch (paren) {
11459
11460             case 'P':   /* (?P...) variants for those used to PCRE/Python */
11461                 paren = *RExC_parse;
11462                 if ( paren == '<') {    /* (?P<...>) named capture */
11463                     RExC_parse++;
11464                     if (RExC_parse >= RExC_end) {
11465                         vFAIL("Sequence (?P<... not terminated");
11466                     }
11467                     goto named_capture;
11468                 }
11469                 else if (paren == '>') {   /* (?P>name) named recursion */
11470                     RExC_parse++;
11471                     if (RExC_parse >= RExC_end) {
11472                         vFAIL("Sequence (?P>... not terminated");
11473                     }
11474                     goto named_recursion;
11475                 }
11476                 else if (paren == '=') {   /* (?P=...)  named backref */
11477                     RExC_parse++;
11478                     return handle_named_backref(pRExC_state, flagp,
11479                                                 parse_start, ')');
11480                 }
11481                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11482                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11483                 vFAIL3("Sequence (%.*s...) not recognized",
11484                                 RExC_parse-seqstart, seqstart);
11485                 NOT_REACHED; /*NOTREACHED*/
11486             case '<':           /* (?<...) */
11487                 if (*RExC_parse == '!')
11488                     paren = ',';
11489                 else if (*RExC_parse != '=')
11490               named_capture:
11491                 {               /* (?<...>) */
11492                     char *name_start;
11493                     SV *svname;
11494                     paren= '>';
11495                 /* FALLTHROUGH */
11496             case '\'':          /* (?'...') */
11497                     name_start = RExC_parse;
11498                     svname = reg_scan_name(pRExC_state, REG_RSN_RETURN_NAME);
11499                     if (   RExC_parse == name_start
11500                         || RExC_parse >= RExC_end
11501                         || *RExC_parse != paren)
11502                     {
11503                         vFAIL2("Sequence (?%c... not terminated",
11504                             paren=='>' ? '<' : paren);
11505                     }
11506                     {
11507                         HE *he_str;
11508                         SV *sv_dat = NULL;
11509                         if (!svname) /* shouldn't happen */
11510                             Perl_croak(aTHX_
11511                                 "panic: reg_scan_name returned NULL");
11512                         if (!RExC_paren_names) {
11513                             RExC_paren_names= newHV();
11514                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
11515 #ifdef DEBUGGING
11516                             RExC_paren_name_list= newAV();
11517                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
11518 #endif
11519                         }
11520                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
11521                         if ( he_str )
11522                             sv_dat = HeVAL(he_str);
11523                         if ( ! sv_dat ) {
11524                             /* croak baby croak */
11525                             Perl_croak(aTHX_
11526                                 "panic: paren_name hash element allocation failed");
11527                         } else if ( SvPOK(sv_dat) ) {
11528                             /* (?|...) can mean we have dupes so scan to check
11529                                its already been stored. Maybe a flag indicating
11530                                we are inside such a construct would be useful,
11531                                but the arrays are likely to be quite small, so
11532                                for now we punt -- dmq */
11533                             IV count = SvIV(sv_dat);
11534                             I32 *pv = (I32*)SvPVX(sv_dat);
11535                             IV i;
11536                             for ( i = 0 ; i < count ; i++ ) {
11537                                 if ( pv[i] == RExC_npar ) {
11538                                     count = 0;
11539                                     break;
11540                                 }
11541                             }
11542                             if ( count ) {
11543                                 pv = (I32*)SvGROW(sv_dat,
11544                                                 SvCUR(sv_dat) + sizeof(I32)+1);
11545                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
11546                                 pv[count] = RExC_npar;
11547                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
11548                             }
11549                         } else {
11550                             (void)SvUPGRADE(sv_dat, SVt_PVNV);
11551                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
11552                                                                 sizeof(I32));
11553                             SvIOK_on(sv_dat);
11554                             SvIV_set(sv_dat, 1);
11555                         }
11556 #ifdef DEBUGGING
11557                         /* Yes this does cause a memory leak in debugging Perls
11558                          * */
11559                         if (!av_store(RExC_paren_name_list,
11560                                       RExC_npar, SvREFCNT_inc_NN(svname)))
11561                             SvREFCNT_dec_NN(svname);
11562 #endif
11563
11564                         /*sv_dump(sv_dat);*/
11565                     }
11566                     nextchar(pRExC_state);
11567                     paren = 1;
11568                     goto capturing_parens;
11569                 }
11570
11571                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11572                 RExC_in_lookbehind++;
11573                 RExC_parse++;
11574                 if (RExC_parse >= RExC_end) {
11575                     vFAIL("Sequence (?... not terminated");
11576                 }
11577                 RExC_seen_zerolen++;
11578                 break;
11579             case '=':           /* (?=...) */
11580                 RExC_seen_zerolen++;
11581                 RExC_in_lookahead++;
11582                 break;
11583             case '!':           /* (?!...) */
11584                 RExC_seen_zerolen++;
11585                 /* check if we're really just a "FAIL" assertion */
11586                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11587                                         FALSE /* Don't force to /x */ );
11588                 if (*RExC_parse == ')') {
11589                     ret=reganode(pRExC_state, OPFAIL, 0);
11590                     nextchar(pRExC_state);
11591                     return ret;
11592                 }
11593                 break;
11594             case '|':           /* (?|...) */
11595                 /* branch reset, behave like a (?:...) except that
11596                    buffers in alternations share the same numbers */
11597                 paren = ':';
11598                 after_freeze = freeze_paren = RExC_npar;
11599
11600                 /* XXX This construct currently requires an extra pass.
11601                  * Investigation would be required to see if that could be
11602                  * changed */
11603                 REQUIRE_PARENS_PASS;
11604                 break;
11605             case ':':           /* (?:...) */
11606             case '>':           /* (?>...) */
11607                 break;
11608             case '$':           /* (?$...) */
11609             case '@':           /* (?@...) */
11610                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
11611                 break;
11612             case '0' :           /* (?0) */
11613             case 'R' :           /* (?R) */
11614                 if (RExC_parse == RExC_end || *RExC_parse != ')')
11615                     FAIL("Sequence (?R) not terminated");
11616                 num = 0;
11617                 RExC_seen |= REG_RECURSE_SEEN;
11618
11619                 /* XXX These constructs currently require an extra pass.
11620                  * It probably could be changed */
11621                 REQUIRE_PARENS_PASS;
11622
11623                 *flagp |= POSTPONED;
11624                 goto gen_recurse_regop;
11625                 /*notreached*/
11626             /* named and numeric backreferences */
11627             case '&':            /* (?&NAME) */
11628                 parse_start = RExC_parse - 1;
11629               named_recursion:
11630                 {
11631                     SV *sv_dat = reg_scan_name(pRExC_state,
11632                                                REG_RSN_RETURN_DATA);
11633                    num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
11634                 }
11635                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
11636                     vFAIL("Sequence (?&... not terminated");
11637                 goto gen_recurse_regop;
11638                 /* NOTREACHED */
11639             case '+':
11640                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11641                     RExC_parse++;
11642                     vFAIL("Illegal pattern");
11643                 }
11644                 goto parse_recursion;
11645                 /* NOTREACHED*/
11646             case '-': /* (?-1) */
11647                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11648                     RExC_parse--; /* rewind to let it be handled later */
11649                     goto parse_flags;
11650                 }
11651                 /* FALLTHROUGH */
11652             case '1': case '2': case '3': case '4': /* (?1) */
11653             case '5': case '6': case '7': case '8': case '9':
11654                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
11655               parse_recursion:
11656                 {
11657                     bool is_neg = FALSE;
11658                     UV unum;
11659                     parse_start = RExC_parse - 1; /* MJD */
11660                     if (*RExC_parse == '-') {
11661                         RExC_parse++;
11662                         is_neg = TRUE;
11663                     }
11664                     endptr = RExC_end;
11665                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11666                         && unum <= I32_MAX
11667                     ) {
11668                         num = (I32)unum;
11669                         RExC_parse = (char*)endptr;
11670                     } else
11671                         num = I32_MAX;
11672                     if (is_neg) {
11673                         /* Some limit for num? */
11674                         num = -num;
11675                     }
11676                 }
11677                 if (*RExC_parse!=')')
11678                     vFAIL("Expecting close bracket");
11679
11680               gen_recurse_regop:
11681                 if ( paren == '-' ) {
11682                     /*
11683                     Diagram of capture buffer numbering.
11684                     Top line is the normal capture buffer numbers
11685                     Bottom line is the negative indexing as from
11686                     the X (the (?-2))
11687
11688                     +   1 2    3 4 5 X          6 7
11689                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11690                     -   5 4    3 2 1 X          x x
11691
11692                     */
11693                     num = RExC_npar + num;
11694                     if (num < 1)  {
11695
11696                         /* It might be a forward reference; we can't fail until
11697                          * we know, by completing the parse to get all the
11698                          * groups, and then reparsing */
11699                         if (ALL_PARENS_COUNTED)  {
11700                             RExC_parse++;
11701                             vFAIL("Reference to nonexistent group");
11702                         }
11703                         else {
11704                             REQUIRE_PARENS_PASS;
11705                         }
11706                     }
11707                 } else if ( paren == '+' ) {
11708                     num = RExC_npar + num - 1;
11709                 }
11710                 /* We keep track how many GOSUB items we have produced.
11711                    To start off the ARG2L() of the GOSUB holds its "id",
11712                    which is used later in conjunction with RExC_recurse
11713                    to calculate the offset we need to jump for the GOSUB,
11714                    which it will store in the final representation.
11715                    We have to defer the actual calculation until much later
11716                    as the regop may move.
11717                  */
11718
11719                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11720                 if (num >= RExC_npar) {
11721
11722                     /* It might be a forward reference; we can't fail until we
11723                      * know, by completing the parse to get all the groups, and
11724                      * then reparsing */
11725                     if (ALL_PARENS_COUNTED)  {
11726                         if (num >= RExC_total_parens) {
11727                             RExC_parse++;
11728                             vFAIL("Reference to nonexistent group");
11729                         }
11730                     }
11731                     else {
11732                         REQUIRE_PARENS_PASS;
11733                     }
11734                 }
11735                 RExC_recurse_count++;
11736                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11737                     "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11738                             22, "|    |", (int)(depth * 2 + 1), "",
11739                             (UV)ARG(REGNODE_p(ret)),
11740                             (IV)ARG2L(REGNODE_p(ret))));
11741                 RExC_seen |= REG_RECURSE_SEEN;
11742
11743                 Set_Node_Length(REGNODE_p(ret),
11744                                 1 + regarglen[OP(REGNODE_p(ret))]); /* MJD */
11745                 Set_Node_Offset(REGNODE_p(ret), parse_start); /* MJD */
11746
11747                 *flagp |= POSTPONED;
11748                 assert(*RExC_parse == ')');
11749                 nextchar(pRExC_state);
11750                 return ret;
11751
11752             /* NOTREACHED */
11753
11754             case '?':           /* (??...) */
11755                 is_logical = 1;
11756                 if (*RExC_parse != '{') {
11757                     RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11758                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11759                     vFAIL2utf8f(
11760                         "Sequence (%" UTF8f "...) not recognized",
11761                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11762                     NOT_REACHED; /*NOTREACHED*/
11763                 }
11764                 *flagp |= POSTPONED;
11765                 paren = '{';
11766                 RExC_parse++;
11767                 /* FALLTHROUGH */
11768             case '{':           /* (?{...}) */
11769             {
11770                 U32 n = 0;
11771                 struct reg_code_block *cb;
11772                 OP * o;
11773
11774                 RExC_seen_zerolen++;
11775
11776                 if (   !pRExC_state->code_blocks
11777                     || pRExC_state->code_index
11778                                         >= pRExC_state->code_blocks->count
11779                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11780                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11781                             - RExC_start)
11782                 ) {
11783                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11784                         FAIL("panic: Sequence (?{...}): no code block found\n");
11785                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11786                 }
11787                 /* this is a pre-compiled code block (?{...}) */
11788                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11789                 RExC_parse = RExC_start + cb->end;
11790                 o = cb->block;
11791                 if (cb->src_regex) {
11792                     n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11793                     RExC_rxi->data->data[n] =
11794                         (void*)SvREFCNT_inc((SV*)cb->src_regex);
11795                     RExC_rxi->data->data[n+1] = (void*)o;
11796                 }
11797                 else {
11798                     n = add_data(pRExC_state,
11799                             (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11800                     RExC_rxi->data->data[n] = (void*)o;
11801                 }
11802                 pRExC_state->code_index++;
11803                 nextchar(pRExC_state);
11804
11805                 if (is_logical) {
11806                     regnode_offset eval;
11807                     ret = reg_node(pRExC_state, LOGICAL);
11808
11809                     eval = reg2Lanode(pRExC_state, EVAL,
11810                                        n,
11811
11812                                        /* for later propagation into (??{})
11813                                         * return value */
11814                                        RExC_flags & RXf_PMf_COMPILETIME
11815                                       );
11816                     FLAGS(REGNODE_p(ret)) = 2;
11817                     if (! REGTAIL(pRExC_state, ret, eval)) {
11818                         REQUIRE_BRANCHJ(flagp, 0);
11819                     }
11820                     /* deal with the length of this later - MJD */
11821                     return ret;
11822                 }
11823                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11824                 Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1);
11825                 Set_Node_Offset(REGNODE_p(ret), parse_start);
11826                 return ret;
11827             }
11828             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11829             {
11830                 int is_define= 0;
11831                 const int DEFINE_len = sizeof("DEFINE") - 1;
11832                 if (    RExC_parse < RExC_end - 1
11833                     && (   (       RExC_parse[0] == '?'        /* (?(?...)) */
11834                             && (   RExC_parse[1] == '='
11835                                 || RExC_parse[1] == '!'
11836                                 || RExC_parse[1] == '<'
11837                                 || RExC_parse[1] == '{'))
11838                         || (       RExC_parse[0] == '*'        /* (?(*...)) */
11839                             && (   memBEGINs(RExC_parse + 1,
11840                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11841                                          "pla:")
11842                                 || memBEGINs(RExC_parse + 1,
11843                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11844                                          "plb:")
11845                                 || memBEGINs(RExC_parse + 1,
11846                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11847                                          "nla:")
11848                                 || memBEGINs(RExC_parse + 1,
11849                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11850                                          "nlb:")
11851                                 || memBEGINs(RExC_parse + 1,
11852                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11853                                          "positive_lookahead:")
11854                                 || memBEGINs(RExC_parse + 1,
11855                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11856                                          "positive_lookbehind:")
11857                                 || memBEGINs(RExC_parse + 1,
11858                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11859                                          "negative_lookahead:")
11860                                 || memBEGINs(RExC_parse + 1,
11861                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11862                                          "negative_lookbehind:"))))
11863                 ) { /* Lookahead or eval. */
11864                     I32 flag;
11865                     regnode_offset tail;
11866
11867                     ret = reg_node(pRExC_state, LOGICAL);
11868                     FLAGS(REGNODE_p(ret)) = 1;
11869
11870                     tail = reg(pRExC_state, 1, &flag, depth+1);
11871                     RETURN_FAIL_ON_RESTART(flag, flagp);
11872                     if (! REGTAIL(pRExC_state, ret, tail)) {
11873                         REQUIRE_BRANCHJ(flagp, 0);
11874                     }
11875                     goto insert_if;
11876                 }
11877                 else if (   RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11878                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11879                 {
11880                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11881                     char *name_start= RExC_parse++;
11882                     U32 num = 0;
11883                     SV *sv_dat=reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11884                     if (   RExC_parse == name_start
11885                         || RExC_parse >= RExC_end
11886                         || *RExC_parse != ch)
11887                     {
11888                         vFAIL2("Sequence (?(%c... not terminated",
11889                             (ch == '>' ? '<' : ch));
11890                     }
11891                     RExC_parse++;
11892                     if (sv_dat) {
11893                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11894                         RExC_rxi->data->data[num]=(void*)sv_dat;
11895                         SvREFCNT_inc_simple_void_NN(sv_dat);
11896                     }
11897                     ret = reganode(pRExC_state, GROUPPN, num);
11898                     goto insert_if_check_paren;
11899                 }
11900                 else if (memBEGINs(RExC_parse,
11901                                    (STRLEN) (RExC_end - RExC_parse),
11902                                    "DEFINE"))
11903                 {
11904                     ret = reganode(pRExC_state, DEFINEP, 0);
11905                     RExC_parse += DEFINE_len;
11906                     is_define = 1;
11907                     goto insert_if_check_paren;
11908                 }
11909                 else if (RExC_parse[0] == 'R') {
11910                     RExC_parse++;
11911                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11912                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11913                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11914                      */
11915                     parno = 0;
11916                     if (RExC_parse[0] == '0') {
11917                         parno = 1;
11918                         RExC_parse++;
11919                     }
11920                     else if (inRANGE(RExC_parse[0], '1', '9')) {
11921                         UV uv;
11922                         endptr = RExC_end;
11923                         if (grok_atoUV(RExC_parse, &uv, &endptr)
11924                             && uv <= I32_MAX
11925                         ) {
11926                             parno = (I32)uv + 1;
11927                             RExC_parse = (char*)endptr;
11928                         }
11929                         /* else "Switch condition not recognized" below */
11930                     } else if (RExC_parse[0] == '&') {
11931                         SV *sv_dat;
11932                         RExC_parse++;
11933                         sv_dat = reg_scan_name(pRExC_state,
11934                                                REG_RSN_RETURN_DATA);
11935                         if (sv_dat)
11936                             parno = 1 + *((I32 *)SvPVX(sv_dat));
11937                     }
11938                     ret = reganode(pRExC_state, INSUBP, parno);
11939                     goto insert_if_check_paren;
11940                 }
11941                 else if (inRANGE(RExC_parse[0], '1', '9')) {
11942                     /* (?(1)...) */
11943                     char c;
11944                     UV uv;
11945                     endptr = RExC_end;
11946                     if (grok_atoUV(RExC_parse, &uv, &endptr)
11947                         && uv <= I32_MAX
11948                     ) {
11949                         parno = (I32)uv;
11950                         RExC_parse = (char*)endptr;
11951                     }
11952                     else {
11953                         vFAIL("panic: grok_atoUV returned FALSE");
11954                     }
11955                     ret = reganode(pRExC_state, GROUPP, parno);
11956
11957                  insert_if_check_paren:
11958                     if (UCHARAT(RExC_parse) != ')') {
11959                         RExC_parse += UTF
11960                                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
11961                                       : 1;
11962                         vFAIL("Switch condition not recognized");
11963                     }
11964                     nextchar(pRExC_state);
11965                   insert_if:
11966                     if (! REGTAIL(pRExC_state, ret, reganode(pRExC_state,
11967                                                              IFTHEN, 0)))
11968                     {
11969                         REQUIRE_BRANCHJ(flagp, 0);
11970                     }
11971                     br = regbranch(pRExC_state, &flags, 1, depth+1);
11972                     if (br == 0) {
11973                         RETURN_FAIL_ON_RESTART(flags,flagp);
11974                         FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
11975                               (UV) flags);
11976                     } else
11977                     if (! REGTAIL(pRExC_state, br, reganode(pRExC_state,
11978                                                              LONGJMP, 0)))
11979                     {
11980                         REQUIRE_BRANCHJ(flagp, 0);
11981                     }
11982                     c = UCHARAT(RExC_parse);
11983                     nextchar(pRExC_state);
11984                     if (flags&HASWIDTH)
11985                         *flagp |= HASWIDTH;
11986                     if (c == '|') {
11987                         if (is_define)
11988                             vFAIL("(?(DEFINE)....) does not allow branches");
11989
11990                         /* Fake one for optimizer.  */
11991                         lastbr = reganode(pRExC_state, IFTHEN, 0);
11992
11993                         if (!regbranch(pRExC_state, &flags, 1, depth+1)) {
11994                             RETURN_FAIL_ON_RESTART(flags, flagp);
11995                             FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
11996                                   (UV) flags);
11997                         }
11998                         if (! REGTAIL(pRExC_state, ret, lastbr)) {
11999                             REQUIRE_BRANCHJ(flagp, 0);
12000                         }
12001                         if (flags&HASWIDTH)
12002                             *flagp |= HASWIDTH;
12003                         c = UCHARAT(RExC_parse);
12004                         nextchar(pRExC_state);
12005                     }
12006                     else
12007                         lastbr = 0;
12008                     if (c != ')') {
12009                         if (RExC_parse >= RExC_end)
12010                             vFAIL("Switch (?(condition)... not terminated");
12011                         else
12012                             vFAIL("Switch (?(condition)... contains too many branches");
12013                     }
12014                     ender = reg_node(pRExC_state, TAIL);
12015                     if (! REGTAIL(pRExC_state, br, ender)) {
12016                         REQUIRE_BRANCHJ(flagp, 0);
12017                     }
12018                     if (lastbr) {
12019                         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12020                             REQUIRE_BRANCHJ(flagp, 0);
12021                         }
12022                         if (! REGTAIL(pRExC_state,
12023                                       REGNODE_OFFSET(
12024                                                  NEXTOPER(
12025                                                  NEXTOPER(REGNODE_p(lastbr)))),
12026                                       ender))
12027                         {
12028                             REQUIRE_BRANCHJ(flagp, 0);
12029                         }
12030                     }
12031                     else
12032                         if (! REGTAIL(pRExC_state, ret, ender)) {
12033                             REQUIRE_BRANCHJ(flagp, 0);
12034                         }
12035 #if 0  /* Removing this doesn't cause failures in the test suite -- khw */
12036                     RExC_size++; /* XXX WHY do we need this?!!
12037                                     For large programs it seems to be required
12038                                     but I can't figure out why. -- dmq*/
12039 #endif
12040                     return ret;
12041                 }
12042                 RExC_parse += UTF
12043                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
12044                               : 1;
12045                 vFAIL("Unknown switch condition (?(...))");
12046             }
12047             case '[':           /* (?[ ... ]) */
12048                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
12049                                          oregcomp_parse);
12050             case 0: /* A NUL */
12051                 RExC_parse--; /* for vFAIL to print correctly */
12052                 vFAIL("Sequence (? incomplete");
12053                 break;
12054
12055             case ')':
12056                 if (RExC_strict) {  /* [perl #132851] */
12057                     ckWARNreg(RExC_parse, "Empty (?) without any modifiers");
12058                 }
12059                 /* FALLTHROUGH */
12060             default: /* e.g., (?i) */
12061                 RExC_parse = (char *) seqstart + 1;
12062               parse_flags:
12063                 parse_lparen_question_flags(pRExC_state);
12064                 if (UCHARAT(RExC_parse) != ':') {
12065                     if (RExC_parse < RExC_end)
12066                         nextchar(pRExC_state);
12067                     *flagp = TRYAGAIN;
12068                     return 0;
12069                 }
12070                 paren = ':';
12071                 nextchar(pRExC_state);
12072                 ret = 0;
12073                 goto parse_rest;
12074             } /* end switch */
12075         }
12076         else {
12077             if (*RExC_parse == '{') {
12078                 ckWARNregdep(RExC_parse + 1,
12079                             "Unescaped left brace in regex is "
12080                             "deprecated here (and will be fatal "
12081                             "in Perl 5.32), passed through");
12082             }
12083             /* Not bothering to indent here, as the above 'else' is temporary
12084              * */
12085         if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
12086           capturing_parens:
12087             parno = RExC_npar;
12088             RExC_npar++;
12089             if (! ALL_PARENS_COUNTED) {
12090                 /* If we are in our first pass through (and maybe only pass),
12091                  * we  need to allocate memory for the capturing parentheses
12092                  * data structures.
12093                  */
12094
12095                 if (!RExC_parens_buf_size) {
12096                     /* first guess at number of parens we might encounter */
12097                     RExC_parens_buf_size = 10;
12098
12099                     /* setup RExC_open_parens, which holds the address of each
12100                      * OPEN tag, and to make things simpler for the 0 index the
12101                      * start of the program - this is used later for offsets */
12102                     Newxz(RExC_open_parens, RExC_parens_buf_size,
12103                             regnode_offset);
12104                     RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
12105
12106                     /* setup RExC_close_parens, which holds the address of each
12107                      * CLOSE tag, and to make things simpler for the 0 index
12108                      * the end of the program - this is used later for offsets
12109                      * */
12110                     Newxz(RExC_close_parens, RExC_parens_buf_size,
12111                             regnode_offset);
12112                     /* we dont know where end op starts yet, so we dont need to
12113                      * set RExC_close_parens[0] like we do RExC_open_parens[0]
12114                      * above */
12115                 }
12116                 else if (RExC_npar > RExC_parens_buf_size) {
12117                     I32 old_size = RExC_parens_buf_size;
12118
12119                     RExC_parens_buf_size *= 2;
12120
12121                     Renew(RExC_open_parens, RExC_parens_buf_size,
12122                             regnode_offset);
12123                     Zero(RExC_open_parens + old_size,
12124                             RExC_parens_buf_size - old_size, regnode_offset);
12125
12126                     Renew(RExC_close_parens, RExC_parens_buf_size,
12127                             regnode_offset);
12128                     Zero(RExC_close_parens + old_size,
12129                             RExC_parens_buf_size - old_size, regnode_offset);
12130                 }
12131             }
12132
12133             ret = reganode(pRExC_state, OPEN, parno);
12134             if (!RExC_nestroot)
12135                 RExC_nestroot = parno;
12136             if (RExC_open_parens && !RExC_open_parens[parno])
12137             {
12138                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12139                     "%*s%*s Setting open paren #%" IVdf " to %d\n",
12140                     22, "|    |", (int)(depth * 2 + 1), "",
12141                     (IV)parno, ret));
12142                 RExC_open_parens[parno]= ret;
12143             }
12144
12145             Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
12146             Set_Node_Offset(REGNODE_p(ret), RExC_parse); /* MJD */
12147             is_open = 1;
12148         } else {
12149             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
12150             paren = ':';
12151             ret = 0;
12152         }
12153         }
12154     }
12155     else                        /* ! paren */
12156         ret = 0;
12157
12158    parse_rest:
12159     /* Pick up the branches, linking them together. */
12160     parse_start = RExC_parse;   /* MJD */
12161     br = regbranch(pRExC_state, &flags, 1, depth+1);
12162
12163     /*     branch_len = (paren != 0); */
12164
12165     if (br == 0) {
12166         RETURN_FAIL_ON_RESTART(flags, flagp);
12167         FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12168     }
12169     if (*RExC_parse == '|') {
12170         if (RExC_use_BRANCHJ) {
12171             reginsert(pRExC_state, BRANCHJ, br, depth+1);
12172         }
12173         else {                  /* MJD */
12174             reginsert(pRExC_state, BRANCH, br, depth+1);
12175             Set_Node_Length(REGNODE_p(br), paren != 0);
12176             Set_Node_Offset_To_R(br, parse_start-RExC_start);
12177         }
12178         have_branch = 1;
12179     }
12180     else if (paren == ':') {
12181         *flagp |= flags&SIMPLE;
12182     }
12183     if (is_open) {                              /* Starts with OPEN. */
12184         if (! REGTAIL(pRExC_state, ret, br)) {  /* OPEN -> first. */
12185             REQUIRE_BRANCHJ(flagp, 0);
12186         }
12187     }
12188     else if (paren != '?')              /* Not Conditional */
12189         ret = br;
12190     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
12191     lastbr = br;
12192     while (*RExC_parse == '|') {
12193         if (RExC_use_BRANCHJ) {
12194             bool shut_gcc_up;
12195
12196             ender = reganode(pRExC_state, LONGJMP, 0);
12197
12198             /* Append to the previous. */
12199             shut_gcc_up = REGTAIL(pRExC_state,
12200                          REGNODE_OFFSET(NEXTOPER(NEXTOPER(REGNODE_p(lastbr)))),
12201                          ender);
12202             PERL_UNUSED_VAR(shut_gcc_up);
12203         }
12204         nextchar(pRExC_state);
12205         if (freeze_paren) {
12206             if (RExC_npar > after_freeze)
12207                 after_freeze = RExC_npar;
12208             RExC_npar = freeze_paren;
12209         }
12210         br = regbranch(pRExC_state, &flags, 0, depth+1);
12211
12212         if (br == 0) {
12213             RETURN_FAIL_ON_RESTART(flags, flagp);
12214             FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12215         }
12216         if (!  REGTAIL(pRExC_state, lastbr, br)) {  /* BRANCH -> BRANCH. */
12217             REQUIRE_BRANCHJ(flagp, 0);
12218         }
12219         lastbr = br;
12220         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
12221     }
12222
12223     if (have_branch || paren != ':') {
12224         regnode * br;
12225
12226         /* Make a closing node, and hook it on the end. */
12227         switch (paren) {
12228         case ':':
12229             ender = reg_node(pRExC_state, TAIL);
12230             break;
12231         case 1: case 2:
12232             ender = reganode(pRExC_state, CLOSE, parno);
12233             if ( RExC_close_parens ) {
12234                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12235                         "%*s%*s Setting close paren #%" IVdf " to %d\n",
12236                         22, "|    |", (int)(depth * 2 + 1), "",
12237                         (IV)parno, ender));
12238                 RExC_close_parens[parno]= ender;
12239                 if (RExC_nestroot == parno)
12240                     RExC_nestroot = 0;
12241             }
12242             Set_Node_Offset(REGNODE_p(ender), RExC_parse+1); /* MJD */
12243             Set_Node_Length(REGNODE_p(ender), 1); /* MJD */
12244             break;
12245         case 's':
12246             ender = reg_node(pRExC_state, SRCLOSE);
12247             RExC_in_script_run = 0;
12248             break;
12249         case '<':
12250         case 'a':
12251         case 'A':
12252         case 'b':
12253         case 'B':
12254         case ',':
12255         case '=':
12256         case '!':
12257             *flagp &= ~HASWIDTH;
12258             /* FALLTHROUGH */
12259         case 't':   /* aTomic */
12260         case '>':
12261             ender = reg_node(pRExC_state, SUCCEED);
12262             break;
12263         case 0:
12264             ender = reg_node(pRExC_state, END);
12265             assert(!RExC_end_op); /* there can only be one! */
12266             RExC_end_op = REGNODE_p(ender);
12267             if (RExC_close_parens) {
12268                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12269                     "%*s%*s Setting close paren #0 (END) to %d\n",
12270                     22, "|    |", (int)(depth * 2 + 1), "",
12271                     ender));
12272
12273                 RExC_close_parens[0]= ender;
12274             }
12275             break;
12276         }
12277         DEBUG_PARSE_r(
12278             DEBUG_PARSE_MSG("lsbr");
12279             regprop(RExC_rx, RExC_mysv1, REGNODE_p(lastbr), NULL, pRExC_state);
12280             regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender), NULL, pRExC_state);
12281             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12282                           SvPV_nolen_const(RExC_mysv1),
12283                           (IV)lastbr,
12284                           SvPV_nolen_const(RExC_mysv2),
12285                           (IV)ender,
12286                           (IV)(ender - lastbr)
12287             );
12288         );
12289         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12290             REQUIRE_BRANCHJ(flagp, 0);
12291         }
12292
12293         if (have_branch) {
12294             char is_nothing= 1;
12295             if (depth==1)
12296                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
12297
12298             /* Hook the tails of the branches to the closing node. */
12299             for (br = REGNODE_p(ret); br; br = regnext(br)) {
12300                 const U8 op = PL_regkind[OP(br)];
12301                 if (op == BRANCH) {
12302                     if (! REGTAIL_STUDY(pRExC_state,
12303                                         REGNODE_OFFSET(NEXTOPER(br)),
12304                                         ender))
12305                     {
12306                         REQUIRE_BRANCHJ(flagp, 0);
12307                     }
12308                     if ( OP(NEXTOPER(br)) != NOTHING
12309                          || regnext(NEXTOPER(br)) != REGNODE_p(ender))
12310                         is_nothing= 0;
12311                 }
12312                 else if (op == BRANCHJ) {
12313                     bool shut_gcc_up = REGTAIL_STUDY(pRExC_state,
12314                                         REGNODE_OFFSET(NEXTOPER(NEXTOPER(br))),
12315                                         ender);
12316                     PERL_UNUSED_VAR(shut_gcc_up);
12317                     /* for now we always disable this optimisation * /
12318                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
12319                          || regnext(NEXTOPER(NEXTOPER(br))) != REGNODE_p(ender))
12320                     */
12321                         is_nothing= 0;
12322                 }
12323             }
12324             if (is_nothing) {
12325                 regnode * ret_as_regnode = REGNODE_p(ret);
12326                 br= PL_regkind[OP(ret_as_regnode)] != BRANCH
12327                                ? regnext(ret_as_regnode)
12328                                : ret_as_regnode;
12329                 DEBUG_PARSE_r(
12330                     DEBUG_PARSE_MSG("NADA");
12331                     regprop(RExC_rx, RExC_mysv1, ret_as_regnode,
12332                                      NULL, pRExC_state);
12333                     regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender),
12334                                      NULL, pRExC_state);
12335                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12336                                   SvPV_nolen_const(RExC_mysv1),
12337                                   (IV)REG_NODE_NUM(ret_as_regnode),
12338                                   SvPV_nolen_const(RExC_mysv2),
12339                                   (IV)ender,
12340                                   (IV)(ender - ret)
12341                     );
12342                 );
12343                 OP(br)= NOTHING;
12344                 if (OP(REGNODE_p(ender)) == TAIL) {
12345                     NEXT_OFF(br)= 0;
12346                     RExC_emit= REGNODE_OFFSET(br) + 1;
12347                 } else {
12348                     regnode *opt;
12349                     for ( opt= br + 1; opt < REGNODE_p(ender) ; opt++ )
12350                         OP(opt)= OPTIMIZED;
12351                     NEXT_OFF(br)= REGNODE_p(ender) - br;
12352                 }
12353             }
12354         }
12355     }
12356
12357     {
12358         const char *p;
12359          /* Even/odd or x=don't care: 010101x10x */
12360         static const char parens[] = "=!aA<,>Bbt";
12361          /* flag below is set to 0 up through 'A'; 1 for larger */
12362
12363         if (paren && (p = strchr(parens, paren))) {
12364             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
12365             int flag = (p - parens) > 3;
12366
12367             if (paren == '>' || paren == 't') {
12368                 node = SUSPEND, flag = 0;
12369             }
12370
12371             reginsert(pRExC_state, node, ret, depth+1);
12372             Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12373             Set_Node_Offset(REGNODE_p(ret), parse_start + 1);
12374             FLAGS(REGNODE_p(ret)) = flag;
12375             if (! REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL)))
12376             {
12377                 REQUIRE_BRANCHJ(flagp, 0);
12378             }
12379         }
12380     }
12381
12382     /* Check for proper termination. */
12383     if (paren) {
12384         /* restore original flags, but keep (?p) and, if we've encountered
12385          * something in the parse that changes /d rules into /u, keep the /u */
12386         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
12387         if (DEPENDS_SEMANTICS && RExC_uni_semantics) {
12388             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
12389         }
12390         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
12391             RExC_parse = oregcomp_parse;
12392             vFAIL("Unmatched (");
12393         }
12394         nextchar(pRExC_state);
12395     }
12396     else if (!paren && RExC_parse < RExC_end) {
12397         if (*RExC_parse == ')') {
12398             RExC_parse++;
12399             vFAIL("Unmatched )");
12400         }
12401         else
12402             FAIL("Junk on end of regexp");      /* "Can't happen". */
12403         NOT_REACHED; /* NOTREACHED */
12404     }
12405
12406     if (RExC_in_lookbehind) {
12407         RExC_in_lookbehind--;
12408     }
12409     if (RExC_in_lookahead) {
12410         RExC_in_lookahead--;
12411     }
12412     if (after_freeze > RExC_npar)
12413         RExC_npar = after_freeze;
12414     return(ret);
12415 }
12416
12417 /*
12418  - regbranch - one alternative of an | operator
12419  *
12420  * Implements the concatenation operator.
12421  *
12422  * On success, returns the offset at which any next node should be placed into
12423  * the regex engine program being compiled.
12424  *
12425  * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
12426  * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
12427  * UTF-8
12428  */
12429 STATIC regnode_offset
12430 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
12431 {
12432     regnode_offset ret;
12433     regnode_offset chain = 0;
12434     regnode_offset latest;
12435     I32 flags = 0, c = 0;
12436     GET_RE_DEBUG_FLAGS_DECL;
12437
12438     PERL_ARGS_ASSERT_REGBRANCH;
12439
12440     DEBUG_PARSE("brnc");
12441
12442     if (first)
12443         ret = 0;
12444     else {
12445         if (RExC_use_BRANCHJ)
12446             ret = reganode(pRExC_state, BRANCHJ, 0);
12447         else {
12448             ret = reg_node(pRExC_state, BRANCH);
12449             Set_Node_Length(REGNODE_p(ret), 1);
12450         }
12451     }
12452
12453     *flagp = WORST;                     /* Tentatively. */
12454
12455     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
12456                             FALSE /* Don't force to /x */ );
12457     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
12458         flags &= ~TRYAGAIN;
12459         latest = regpiece(pRExC_state, &flags, depth+1);
12460         if (latest == 0) {
12461             if (flags & TRYAGAIN)
12462                 continue;
12463             RETURN_FAIL_ON_RESTART(flags, flagp);
12464             FAIL2("panic: regpiece returned failure, flags=%#" UVxf, (UV) flags);
12465         }
12466         else if (ret == 0)
12467             ret = latest;
12468         *flagp |= flags&(HASWIDTH|POSTPONED);
12469         if (chain == 0)         /* First piece. */
12470             *flagp |= flags&SPSTART;
12471         else {
12472             /* FIXME adding one for every branch after the first is probably
12473              * excessive now we have TRIE support. (hv) */
12474             MARK_NAUGHTY(1);
12475             if (! REGTAIL(pRExC_state, chain, latest)) {
12476                 /* XXX We could just redo this branch, but figuring out what
12477                  * bookkeeping needs to be reset is a pain, and it's likely
12478                  * that other branches that goto END will also be too large */
12479                 REQUIRE_BRANCHJ(flagp, 0);
12480             }
12481         }
12482         chain = latest;
12483         c++;
12484     }
12485     if (chain == 0) {   /* Loop ran zero times. */
12486         chain = reg_node(pRExC_state, NOTHING);
12487         if (ret == 0)
12488             ret = chain;
12489     }
12490     if (c == 1) {
12491         *flagp |= flags&SIMPLE;
12492     }
12493
12494     return ret;
12495 }
12496
12497 /*
12498  - regpiece - something followed by possible quantifier * + ? {n,m}
12499  *
12500  * Note that the branching code sequences used for ? and the general cases
12501  * of * and + are somewhat optimized:  they use the same NOTHING node as
12502  * both the endmarker for their branch list and the body of the last branch.
12503  * It might seem that this node could be dispensed with entirely, but the
12504  * endmarker role is not redundant.
12505  *
12506  * On success, returns the offset at which any next node should be placed into
12507  * the regex engine program being compiled.
12508  *
12509  * Returns 0 otherwise, with *flagp set to indicate why:
12510  *  TRYAGAIN        if regatom() returns 0 with TRYAGAIN.
12511  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
12512  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
12513  */
12514 STATIC regnode_offset
12515 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12516 {
12517     regnode_offset ret;
12518     char op;
12519     char *next;
12520     I32 flags;
12521     const char * const origparse = RExC_parse;
12522     I32 min;
12523     I32 max = REG_INFTY;
12524 #ifdef RE_TRACK_PATTERN_OFFSETS
12525     char *parse_start;
12526 #endif
12527     const char *maxpos = NULL;
12528     UV uv;
12529
12530     /* Save the original in case we change the emitted regop to a FAIL. */
12531     const regnode_offset orig_emit = RExC_emit;
12532
12533     GET_RE_DEBUG_FLAGS_DECL;
12534
12535     PERL_ARGS_ASSERT_REGPIECE;
12536
12537     DEBUG_PARSE("piec");
12538
12539     ret = regatom(pRExC_state, &flags, depth+1);
12540     if (ret == 0) {
12541         RETURN_FAIL_ON_RESTART_OR_FLAGS(flags, flagp, TRYAGAIN);
12542         FAIL2("panic: regatom returned failure, flags=%#" UVxf, (UV) flags);
12543     }
12544
12545     op = *RExC_parse;
12546
12547     if (op == '{' && regcurly(RExC_parse)) {
12548         maxpos = NULL;
12549 #ifdef RE_TRACK_PATTERN_OFFSETS
12550         parse_start = RExC_parse; /* MJD */
12551 #endif
12552         next = RExC_parse + 1;
12553         while (isDIGIT(*next) || *next == ',') {
12554             if (*next == ',') {
12555                 if (maxpos)
12556                     break;
12557                 else
12558                     maxpos = next;
12559             }
12560             next++;
12561         }
12562         if (*next == '}') {             /* got one */
12563             const char* endptr;
12564             if (!maxpos)
12565                 maxpos = next;
12566             RExC_parse++;
12567             if (isDIGIT(*RExC_parse)) {
12568                 endptr = RExC_end;
12569                 if (!grok_atoUV(RExC_parse, &uv, &endptr))
12570                     vFAIL("Invalid quantifier in {,}");
12571                 if (uv >= REG_INFTY)
12572                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12573                 min = (I32)uv;
12574             } else {
12575                 min = 0;
12576             }
12577             if (*maxpos == ',')
12578                 maxpos++;
12579             else
12580                 maxpos = RExC_parse;
12581             if (isDIGIT(*maxpos)) {
12582                 endptr = RExC_end;
12583                 if (!grok_atoUV(maxpos, &uv, &endptr))
12584                     vFAIL("Invalid quantifier in {,}");
12585                 if (uv >= REG_INFTY)
12586                     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12587                 max = (I32)uv;
12588             } else {
12589                 max = REG_INFTY;                /* meaning "infinity" */
12590             }
12591             RExC_parse = next;
12592             nextchar(pRExC_state);
12593             if (max < min) {    /* If can't match, warn and optimize to fail
12594                                    unconditionally */
12595                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
12596                 ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
12597                 NEXT_OFF(REGNODE_p(orig_emit)) =
12598                                     regarglen[OPFAIL] + NODE_STEP_REGNODE;
12599                 return ret;
12600             }
12601             else if (min == max && *RExC_parse == '?')
12602             {
12603                 ckWARN2reg(RExC_parse + 1,
12604                            "Useless use of greediness modifier '%c'",
12605                            *RExC_parse);
12606             }
12607
12608           do_curly:
12609             if ((flags&SIMPLE)) {
12610                 if (min == 0 && max == REG_INFTY) {
12611                     reginsert(pRExC_state, STAR, ret, depth+1);
12612                     MARK_NAUGHTY(4);
12613                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12614                     goto nest_check;
12615                 }
12616                 if (min == 1 && max == REG_INFTY) {
12617                     reginsert(pRExC_state, PLUS, ret, depth+1);
12618                     MARK_NAUGHTY(3);
12619                     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12620                     goto nest_check;
12621                 }
12622                 MARK_NAUGHTY_EXP(2, 2);
12623                 reginsert(pRExC_state, CURLY, ret, depth+1);
12624                 Set_Node_Offset(REGNODE_p(ret), parse_start+1); /* MJD */
12625                 Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12626             }
12627             else {
12628                 const regnode_offset w = reg_node(pRExC_state, WHILEM);
12629
12630                 FLAGS(REGNODE_p(w)) = 0;
12631                 if (!  REGTAIL(pRExC_state, ret, w)) {
12632                     REQUIRE_BRANCHJ(flagp, 0);
12633                 }
12634                 if (RExC_use_BRANCHJ) {
12635                     reginsert(pRExC_state, LONGJMP, ret, depth+1);
12636                     reginsert(pRExC_state, NOTHING, ret, depth+1);
12637                     NEXT_OFF(REGNODE_p(ret)) = 3;       /* Go over LONGJMP. */
12638                 }
12639                 reginsert(pRExC_state, CURLYX, ret, depth+1);
12640                                 /* MJD hk */
12641                 Set_Node_Offset(REGNODE_p(ret), parse_start+1);
12642                 Set_Node_Length(REGNODE_p(ret),
12643                                 op == '{' ? (RExC_parse - parse_start) : 1);
12644
12645                 if (RExC_use_BRANCHJ)
12646                     NEXT_OFF(REGNODE_p(ret)) = 3;   /* Go over NOTHING to
12647                                                        LONGJMP. */
12648                 if (! REGTAIL(pRExC_state, ret, reg_node(pRExC_state,
12649                                                           NOTHING)))
12650                 {
12651                     REQUIRE_BRANCHJ(flagp, 0);
12652                 }
12653                 RExC_whilem_seen++;
12654                 MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
12655             }
12656             FLAGS(REGNODE_p(ret)) = 0;
12657
12658             if (min > 0)
12659                 *flagp = WORST;
12660             if (max > 0)
12661                 *flagp |= HASWIDTH;
12662             ARG1_SET(REGNODE_p(ret), (U16)min);
12663             ARG2_SET(REGNODE_p(ret), (U16)max);
12664             if (max == REG_INFTY)
12665                 RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12666
12667             goto nest_check;
12668         }
12669     }
12670
12671     if (!ISMULT1(op)) {
12672         *flagp = flags;
12673         return(ret);
12674     }
12675
12676 #if 0                           /* Now runtime fix should be reliable. */
12677
12678     /* if this is reinstated, don't forget to put this back into perldiag:
12679
12680             =item Regexp *+ operand could be empty at {#} in regex m/%s/
12681
12682            (F) The part of the regexp subject to either the * or + quantifier
12683            could match an empty string. The {#} shows in the regular
12684            expression about where the problem was discovered.
12685
12686     */
12687
12688     if (!(flags&HASWIDTH) && op != '?')
12689       vFAIL("Regexp *+ operand could be empty");
12690 #endif
12691
12692 #ifdef RE_TRACK_PATTERN_OFFSETS
12693     parse_start = RExC_parse;
12694 #endif
12695     nextchar(pRExC_state);
12696
12697     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
12698
12699     if (op == '*') {
12700         min = 0;
12701         goto do_curly;
12702     }
12703     else if (op == '+') {
12704         min = 1;
12705         goto do_curly;
12706     }
12707     else if (op == '?') {
12708         min = 0; max = 1;
12709         goto do_curly;
12710     }
12711   nest_check:
12712     if (!(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
12713         ckWARN2reg(RExC_parse,
12714                    "%" UTF8f " matches null string many times",
12715                    UTF8fARG(UTF, (RExC_parse >= origparse
12716                                  ? RExC_parse - origparse
12717                                  : 0),
12718                    origparse));
12719     }
12720
12721     if (*RExC_parse == '?') {
12722         nextchar(pRExC_state);
12723         reginsert(pRExC_state, MINMOD, ret, depth+1);
12724         if (! REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE)) {
12725             REQUIRE_BRANCHJ(flagp, 0);
12726         }
12727     }
12728     else if (*RExC_parse == '+') {
12729         regnode_offset ender;
12730         nextchar(pRExC_state);
12731         ender = reg_node(pRExC_state, SUCCEED);
12732         if (! REGTAIL(pRExC_state, ret, ender)) {
12733             REQUIRE_BRANCHJ(flagp, 0);
12734         }
12735         reginsert(pRExC_state, SUSPEND, ret, depth+1);
12736         ender = reg_node(pRExC_state, TAIL);
12737         if (! REGTAIL(pRExC_state, ret, ender)) {
12738             REQUIRE_BRANCHJ(flagp, 0);
12739         }
12740     }
12741
12742     if (ISMULT2(RExC_parse)) {
12743         RExC_parse++;
12744         vFAIL("Nested quantifiers");
12745     }
12746
12747     return(ret);
12748 }
12749
12750 STATIC bool
12751 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
12752                 regnode_offset * node_p,
12753                 UV * code_point_p,
12754                 int * cp_count,
12755                 I32 * flagp,
12756                 const bool strict,
12757                 const U32 depth
12758     )
12759 {
12760  /* This routine teases apart the various meanings of \N and returns
12761   * accordingly.  The input parameters constrain which meaning(s) is/are valid
12762   * in the current context.
12763   *
12764   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
12765   *
12766   * If <code_point_p> is not NULL, the context is expecting the result to be a
12767   * single code point.  If this \N instance turns out to a single code point,
12768   * the function returns TRUE and sets *code_point_p to that code point.
12769   *
12770   * If <node_p> is not NULL, the context is expecting the result to be one of
12771   * the things representable by a regnode.  If this \N instance turns out to be
12772   * one such, the function generates the regnode, returns TRUE and sets *node_p
12773   * to point to the offset of that regnode into the regex engine program being
12774   * compiled.
12775   *
12776   * If this instance of \N isn't legal in any context, this function will
12777   * generate a fatal error and not return.
12778   *
12779   * On input, RExC_parse should point to the first char following the \N at the
12780   * time of the call.  On successful return, RExC_parse will have been updated
12781   * to point to just after the sequence identified by this routine.  Also
12782   * *flagp has been updated as needed.
12783   *
12784   * When there is some problem with the current context and this \N instance,
12785   * the function returns FALSE, without advancing RExC_parse, nor setting
12786   * *node_p, nor *code_point_p, nor *flagp.
12787   *
12788   * If <cp_count> is not NULL, the caller wants to know the length (in code
12789   * points) that this \N sequence matches.  This is set, and the input is
12790   * parsed for errors, even if the function returns FALSE, as detailed below.
12791   *
12792   * There are 6 possibilities here, as detailed in the next 6 paragraphs.
12793   *
12794   * Probably the most common case is for the \N to specify a single code point.
12795   * *cp_count will be set to 1, and *code_point_p will be set to that code
12796   * point.
12797   *
12798   * Another possibility is for the input to be an empty \N{}.  This is no
12799   * longer accepted, and will generate a fatal error.
12800   *
12801   * Another possibility is for a custom charnames handler to be in effect which
12802   * translates the input name to an empty string.  *cp_count will be set to 0.
12803   * *node_p will be set to a generated NOTHING node.
12804   *
12805   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
12806   * set to 0. *node_p will be set to a generated REG_ANY node.
12807   *
12808   * The fifth possibility is that \N resolves to a sequence of more than one
12809   * code points.  *cp_count will be set to the number of code points in the
12810   * sequence. *node_p will be set to a generated node returned by this
12811   * function calling S_reg().
12812   *
12813   * The final possibility is that it is premature to be calling this function;
12814   * the parse needs to be restarted.  This can happen when this changes from
12815   * /d to /u rules, or when the pattern needs to be upgraded to UTF-8.  The
12816   * latter occurs only when the fifth possibility would otherwise be in
12817   * effect, and is because one of those code points requires the pattern to be
12818   * recompiled as UTF-8.  The function returns FALSE, and sets the
12819   * RESTART_PARSE and NEED_UTF8 flags in *flagp, as appropriate.  When this
12820   * happens, the caller needs to desist from continuing parsing, and return
12821   * this information to its caller.  This is not set for when there is only one
12822   * code point, as this can be called as part of an ANYOF node, and they can
12823   * store above-Latin1 code points without the pattern having to be in UTF-8.
12824   *
12825   * For non-single-quoted regexes, the tokenizer has resolved character and
12826   * sequence names inside \N{...} into their Unicode values, normalizing the
12827   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
12828   * hex-represented code points in the sequence.  This is done there because
12829   * the names can vary based on what charnames pragma is in scope at the time,
12830   * so we need a way to take a snapshot of what they resolve to at the time of
12831   * the original parse. [perl #56444].
12832   *
12833   * That parsing is skipped for single-quoted regexes, so here we may get
12834   * '\N{NAME}', which is parsed now.  If the single-quoted regex is something
12835   * like '\N{U+41}', that code point is Unicode, and has to be translated into
12836   * the native character set for non-ASCII platforms.  The other possibilities
12837   * are already native, so no translation is done. */
12838
12839     char * endbrace;    /* points to '}' following the name */
12840     char* p = RExC_parse; /* Temporary */
12841
12842     SV * substitute_parse = NULL;
12843     char *orig_end;
12844     char *save_start;
12845     I32 flags;
12846
12847     GET_RE_DEBUG_FLAGS_DECL;
12848
12849     PERL_ARGS_ASSERT_GROK_BSLASH_N;
12850
12851     GET_RE_DEBUG_FLAGS;
12852
12853     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
12854     assert(! (node_p && cp_count));               /* At most 1 should be set */
12855
12856     if (cp_count) {     /* Initialize return for the most common case */
12857         *cp_count = 1;
12858     }
12859
12860     /* The [^\n] meaning of \N ignores spaces and comments under the /x
12861      * modifier.  The other meanings do not, so use a temporary until we find
12862      * out which we are being called with */
12863     skip_to_be_ignored_text(pRExC_state, &p,
12864                             FALSE /* Don't force to /x */ );
12865
12866     /* Disambiguate between \N meaning a named character versus \N meaning
12867      * [^\n].  The latter is assumed when the {...} following the \N is a legal
12868      * quantifier, or if there is no '{' at all */
12869     if (*p != '{' || regcurly(p)) {
12870         RExC_parse = p;
12871         if (cp_count) {
12872             *cp_count = -1;
12873         }
12874
12875         if (! node_p) {
12876             return FALSE;
12877         }
12878
12879         *node_p = reg_node(pRExC_state, REG_ANY);
12880         *flagp |= HASWIDTH|SIMPLE;
12881         MARK_NAUGHTY(1);
12882         Set_Node_Length(REGNODE_p(*(node_p)), 1); /* MJD */
12883         return TRUE;
12884     }
12885
12886     /* The test above made sure that the next real character is a '{', but
12887      * under the /x modifier, it could be separated by space (or a comment and
12888      * \n) and this is not allowed (for consistency with \x{...} and the
12889      * tokenizer handling of \N{NAME}). */
12890     if (*RExC_parse != '{') {
12891         vFAIL("Missing braces on \\N{}");
12892     }
12893
12894     RExC_parse++;       /* Skip past the '{' */
12895
12896     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
12897     if (! endbrace) { /* no trailing brace */
12898         vFAIL2("Missing right brace on \\%c{}", 'N');
12899     }
12900
12901     /* Here, we have decided it should be a named character or sequence.  These
12902      * imply Unicode semantics */
12903     REQUIRE_UNI_RULES(flagp, FALSE);
12904
12905     /* \N{_} is what toke.c returns to us to indicate a name that evaluates to
12906      * nothing at all (not allowed under strict) */
12907     if (endbrace - RExC_parse == 1 && *RExC_parse == '_') {
12908         RExC_parse = endbrace;
12909         if (strict) {
12910             RExC_parse++;   /* Position after the "}" */
12911             vFAIL("Zero length \\N{}");
12912         }
12913
12914         if (cp_count) {
12915             *cp_count = 0;
12916         }
12917         nextchar(pRExC_state);
12918         if (! node_p) {
12919             return FALSE;
12920         }
12921
12922         *node_p = reg_node(pRExC_state, NOTHING);
12923         return TRUE;
12924     }
12925
12926     if (endbrace - RExC_parse < 2 || ! strBEGINs(RExC_parse, "U+")) {
12927
12928         /* Here, the name isn't of the form  U+....  This can happen if the
12929          * pattern is single-quoted, so didn't get evaluated in toke.c.  Now
12930          * is the time to find out what the name means */
12931
12932         const STRLEN name_len = endbrace - RExC_parse;
12933         SV *  value_sv;     /* What does this name evaluate to */
12934         SV ** value_svp;
12935         const U8 * value;   /* string of name's value */
12936         STRLEN value_len;   /* and its length */
12937
12938         /*  RExC_unlexed_names is a hash of names that weren't evaluated by
12939          *  toke.c, and their values. Make sure is initialized */
12940         if (! RExC_unlexed_names) {
12941             RExC_unlexed_names = newHV();
12942         }
12943
12944         /* If we have already seen this name in this pattern, use that.  This
12945          * allows us to only call the charnames handler once per name per
12946          * pattern.  A broken or malicious handler could return something
12947          * different each time, which could cause the results to vary depending
12948          * on if something gets added or subtracted from the pattern that
12949          * causes the number of passes to change, for example */
12950         if ((value_svp = hv_fetch(RExC_unlexed_names, RExC_parse,
12951                                                       name_len, 0)))
12952         {
12953             value_sv = *value_svp;
12954         }
12955         else { /* Otherwise we have to go out and get the name */
12956             const char * error_msg = NULL;
12957             value_sv = get_and_check_backslash_N_name(RExC_parse, endbrace,
12958                                                       UTF,
12959                                                       &error_msg);
12960             if (error_msg) {
12961                 RExC_parse = endbrace;
12962                 vFAIL(error_msg);
12963             }
12964
12965             /* If no error message, should have gotten a valid return */
12966             assert (value_sv);
12967
12968             /* Save the name's meaning for later use */
12969             if (! hv_store(RExC_unlexed_names, RExC_parse, name_len,
12970                            value_sv, 0))
12971             {
12972                 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
12973             }
12974         }
12975
12976         /* Here, we have the value the name evaluates to in 'value_sv' */
12977         value = (U8 *) SvPV(value_sv, value_len);
12978
12979         /* See if the result is one code point vs 0 or multiple */
12980         if (value_len > 0 && value_len <= (UV) ((SvUTF8(value_sv))
12981                                                ? UTF8SKIP(value)
12982                                                : 1))
12983         {
12984             /* Here, exactly one code point.  If that isn't what is wanted,
12985              * fail */
12986             if (! code_point_p) {
12987                 RExC_parse = p;
12988                 return FALSE;
12989             }
12990
12991             /* Convert from string to numeric code point */
12992             *code_point_p = (SvUTF8(value_sv))
12993                             ? valid_utf8_to_uvchr(value, NULL)
12994                             : *value;
12995
12996             /* Have parsed this entire single code point \N{...}.  *cp_count
12997              * has already been set to 1, so don't do it again. */
12998             RExC_parse = endbrace;
12999             nextchar(pRExC_state);
13000             return TRUE;
13001         } /* End of is a single code point */
13002
13003         /* Count the code points, if caller desires.  The API says to do this
13004          * even if we will later return FALSE */
13005         if (cp_count) {
13006             *cp_count = 0;
13007
13008             *cp_count = (SvUTF8(value_sv))
13009                         ? utf8_length(value, value + value_len)
13010                         : value_len;
13011         }
13012
13013         /* Fail if caller doesn't want to handle a multi-code-point sequence.
13014          * But don't back the pointer up if the caller wants to know how many
13015          * code points there are (they need to handle it themselves in this
13016          * case).  */
13017         if (! node_p) {
13018             if (! cp_count) {
13019                 RExC_parse = p;
13020             }
13021             return FALSE;
13022         }
13023
13024         /* Convert this to a sub-pattern of the form "(?: ... )", and then call
13025          * reg recursively to parse it.  That way, it retains its atomicness,
13026          * while not having to worry about any special handling that some code
13027          * points may have. */
13028
13029         substitute_parse = newSVpvs("?:");
13030         sv_catsv(substitute_parse, value_sv);
13031         sv_catpv(substitute_parse, ")");
13032
13033         /* The value should already be native, so no need to convert on EBCDIC
13034          * platforms.*/
13035         assert(! RExC_recode_x_to_native);
13036
13037     }
13038     else {   /* \N{U+...} */
13039         Size_t count = 0;   /* code point count kept internally */
13040
13041         /* We can get to here when the input is \N{U+...} or when toke.c has
13042          * converted a name to the \N{U+...} form.  This include changing a
13043          * name that evaluates to multiple code points to \N{U+c1.c2.c3 ...} */
13044
13045         RExC_parse += 2;    /* Skip past the 'U+' */
13046
13047         /* Code points are separated by dots.  The '}' terminates the whole
13048          * thing. */
13049
13050         do {    /* Loop until the ending brace */
13051             UV cp = 0;
13052             char * start_digit;     /* The first of the current code point */
13053             if (! isXDIGIT(*RExC_parse)) {
13054                 RExC_parse++;
13055                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
13056             }
13057
13058             start_digit = RExC_parse;
13059             count++;
13060
13061             /* Loop through the hex digits of the current code point */
13062             do {
13063                 /* Adding this digit will shift the result 4 bits.  If that
13064                  * result would be above the legal max, it's overflow */
13065                 if (cp > MAX_LEGAL_CP >> 4) {
13066
13067                     /* Find the end of the code point */
13068                     do {
13069                         RExC_parse ++;
13070                     } while (isXDIGIT(*RExC_parse) || *RExC_parse == '_');
13071
13072                     /* Be sure to synchronize this message with the similar one
13073                      * in utf8.c */
13074                     vFAIL4("Use of code point 0x%.*s is not allowed; the"
13075                         " permissible max is 0x%" UVxf,
13076                         (int) (RExC_parse - start_digit), start_digit,
13077                         MAX_LEGAL_CP);
13078                 }
13079
13080                 /* Accumulate this (valid) digit into the running total */
13081                 cp  = (cp << 4) + READ_XDIGIT(RExC_parse);
13082
13083                 /* READ_XDIGIT advanced the input pointer.  Ignore a single
13084                  * underscore separator */
13085                 if (*RExC_parse == '_' && isXDIGIT(RExC_parse[1])) {
13086                     RExC_parse++;
13087                 }
13088             } while (isXDIGIT(*RExC_parse));
13089
13090             /* Here, have accumulated the next code point */
13091             if (RExC_parse >= endbrace) {   /* If done ... */
13092                 if (count != 1) {
13093                     goto do_concat;
13094                 }
13095
13096                 /* Here, is a single code point; fail if doesn't want that */
13097                 if (! code_point_p) {
13098                     RExC_parse = p;
13099                     return FALSE;
13100                 }
13101
13102                 /* A single code point is easy to handle; just return it */
13103                 *code_point_p = UNI_TO_NATIVE(cp);
13104                 RExC_parse = endbrace;
13105                 nextchar(pRExC_state);
13106                 return TRUE;
13107             }
13108
13109             /* Here, the only legal thing would be a multiple character
13110              * sequence (of the form "\N{U+c1.c2. ... }".   So the next
13111              * character must be a dot (and the one after that can't be the
13112              * endbrace, or we'd have something like \N{U+100.} ) */
13113             if (*RExC_parse != '.' || RExC_parse + 1 >= endbrace) {
13114                 RExC_parse += (RExC_orig_utf8)  /* point to after 1st invalid */
13115                                 ? UTF8SKIP(RExC_parse)
13116                                 : 1;
13117                 if (RExC_parse >= endbrace) { /* Guard against malformed utf8 */
13118                     RExC_parse = endbrace;
13119                 }
13120                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
13121             }
13122
13123             /* Here, looks like its really a multiple character sequence.  Fail
13124              * if that's not what the caller wants.  But continue with counting
13125              * and error checking if they still want a count */
13126             if (! node_p && ! cp_count) {
13127                 return FALSE;
13128             }
13129
13130             /* What is done here is to convert this to a sub-pattern of the
13131              * form \x{char1}\x{char2}...  and then call reg recursively to
13132              * parse it (enclosing in "(?: ... )" ).  That way, it retains its
13133              * atomicness, while not having to worry about special handling
13134              * that some code points may have.  We don't create a subpattern,
13135              * but go through the motions of code point counting and error
13136              * checking, if the caller doesn't want a node returned. */
13137
13138             if (node_p && count == 1) {
13139                 substitute_parse = newSVpvs("?:");
13140             }
13141
13142           do_concat:
13143
13144             if (node_p) {
13145                 /* Convert to notation the rest of the code understands */
13146                 sv_catpvs(substitute_parse, "\\x{");
13147                 sv_catpvn(substitute_parse, start_digit,
13148                                             RExC_parse - start_digit);
13149                 sv_catpvs(substitute_parse, "}");
13150             }
13151
13152             /* Move to after the dot (or ending brace the final time through.)
13153              * */
13154             RExC_parse++;
13155             count++;
13156
13157         } while (RExC_parse < endbrace);
13158
13159         if (! node_p) { /* Doesn't want the node */
13160             assert (cp_count);
13161
13162             *cp_count = count;
13163             return FALSE;
13164         }
13165
13166         sv_catpvs(substitute_parse, ")");
13167
13168         /* The values are Unicode, and therefore have to be converted to native
13169          * on a non-Unicode (meaning non-ASCII) platform. */
13170         SET_recode_x_to_native(1);
13171     }
13172
13173     /* Here, we have the string the name evaluates to, ready to be parsed,
13174      * stored in 'substitute_parse' as a series of valid "\x{...}\x{...}"
13175      * constructs.  This can be called from within a substitute parse already.
13176      * The error reporting mechanism doesn't work for 2 levels of this, but the
13177      * code above has validated this new construct, so there should be no
13178      * errors generated by the below.  And this isn' an exact copy, so the
13179      * mechanism to seamlessly deal with this won't work, so turn off warnings
13180      * during it */
13181     save_start = RExC_start;
13182     orig_end = RExC_end;
13183
13184     RExC_parse = RExC_start = SvPVX(substitute_parse);
13185     RExC_end = RExC_parse + SvCUR(substitute_parse);
13186     TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
13187
13188     *node_p = reg(pRExC_state, 1, &flags, depth+1);
13189
13190     /* Restore the saved values */
13191     RESTORE_WARNINGS;
13192     RExC_start = save_start;
13193     RExC_parse = endbrace;
13194     RExC_end = orig_end;
13195     SET_recode_x_to_native(0);
13196
13197     SvREFCNT_dec_NN(substitute_parse);
13198
13199     if (! *node_p) {
13200         RETURN_FAIL_ON_RESTART(flags, flagp);
13201         FAIL2("panic: reg returned failure to grok_bslash_N, flags=%#" UVxf,
13202             (UV) flags);
13203     }
13204     *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
13205
13206     nextchar(pRExC_state);
13207
13208     return TRUE;
13209 }
13210
13211
13212 PERL_STATIC_INLINE U8
13213 S_compute_EXACTish(RExC_state_t *pRExC_state)
13214 {
13215     U8 op;
13216
13217     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
13218
13219     if (! FOLD) {
13220         return (LOC)
13221                 ? EXACTL
13222                 : EXACT;
13223     }
13224
13225     op = get_regex_charset(RExC_flags);
13226     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
13227         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
13228                  been, so there is no hole */
13229     }
13230
13231     return op + EXACTF;
13232 }
13233
13234 STATIC bool
13235 S_new_regcurly(const char *s, const char *e)
13236 {
13237     /* This is a temporary function designed to match the most lenient form of
13238      * a {m,n} quantifier we ever envision, with either number omitted, and
13239      * spaces anywhere between/before/after them.
13240      *
13241      * If this function fails, then the string it matches is very unlikely to
13242      * ever be considered a valid quantifier, so we can allow the '{' that
13243      * begins it to be considered as a literal */
13244
13245     bool has_min = FALSE;
13246     bool has_max = FALSE;
13247
13248     PERL_ARGS_ASSERT_NEW_REGCURLY;
13249
13250     if (s >= e || *s++ != '{')
13251         return FALSE;
13252
13253     while (s < e && isSPACE(*s)) {
13254         s++;
13255     }
13256     while (s < e && isDIGIT(*s)) {
13257         has_min = TRUE;
13258         s++;
13259     }
13260     while (s < e && isSPACE(*s)) {
13261         s++;
13262     }
13263
13264     if (*s == ',') {
13265         s++;
13266         while (s < e && isSPACE(*s)) {
13267             s++;
13268         }
13269         while (s < e && isDIGIT(*s)) {
13270             has_max = TRUE;
13271             s++;
13272         }
13273         while (s < e && isSPACE(*s)) {
13274             s++;
13275         }
13276     }
13277
13278     return s < e && *s == '}' && (has_min || has_max);
13279 }
13280
13281 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
13282  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
13283
13284 static I32
13285 S_backref_value(char *p, char *e)
13286 {
13287     const char* endptr = e;
13288     UV val;
13289     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
13290         return (I32)val;
13291     return I32_MAX;
13292 }
13293
13294
13295 /*
13296  - regatom - the lowest level
13297
13298    Try to identify anything special at the start of the current parse position.
13299    If there is, then handle it as required. This may involve generating a
13300    single regop, such as for an assertion; or it may involve recursing, such as
13301    to handle a () structure.
13302
13303    If the string doesn't start with something special then we gobble up
13304    as much literal text as we can.  If we encounter a quantifier, we have to
13305    back off the final literal character, as that quantifier applies to just it
13306    and not to the whole string of literals.
13307
13308    Once we have been able to handle whatever type of thing started the
13309    sequence, we return the offset into the regex engine program being compiled
13310    at which any  next regnode should be placed.
13311
13312    Returns 0, setting *flagp to TRYAGAIN if reg() returns 0 with TRYAGAIN.
13313    Returns 0, setting *flagp to RESTART_PARSE if the parse needs to be
13314    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
13315    Otherwise does not return 0.
13316
13317    Note: we have to be careful with escapes, as they can be both literal
13318    and special, and in the case of \10 and friends, context determines which.
13319
13320    A summary of the code structure is:
13321
13322    switch (first_byte) {
13323         cases for each special:
13324             handle this special;
13325             break;
13326         case '\\':
13327             switch (2nd byte) {
13328                 cases for each unambiguous special:
13329                     handle this special;
13330                     break;
13331                 cases for each ambigous special/literal:
13332                     disambiguate;
13333                     if (special)  handle here
13334                     else goto defchar;
13335                 default: // unambiguously literal:
13336                     goto defchar;
13337             }
13338         default:  // is a literal char
13339             // FALL THROUGH
13340         defchar:
13341             create EXACTish node for literal;
13342             while (more input and node isn't full) {
13343                 switch (input_byte) {
13344                    cases for each special;
13345                        make sure parse pointer is set so that the next call to
13346                            regatom will see this special first
13347                        goto loopdone; // EXACTish node terminated by prev. char
13348                    default:
13349                        append char to EXACTISH node;
13350                 }
13351                 get next input byte;
13352             }
13353         loopdone:
13354    }
13355    return the generated node;
13356
13357    Specifically there are two separate switches for handling
13358    escape sequences, with the one for handling literal escapes requiring
13359    a dummy entry for all of the special escapes that are actually handled
13360    by the other.
13361
13362 */
13363
13364 STATIC regnode_offset
13365 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
13366 {
13367     dVAR;
13368     regnode_offset ret = 0;
13369     I32 flags = 0;
13370     char *parse_start;
13371     U8 op;
13372     int invert = 0;
13373
13374     GET_RE_DEBUG_FLAGS_DECL;
13375
13376     *flagp = WORST;             /* Tentatively. */
13377
13378     DEBUG_PARSE("atom");
13379
13380     PERL_ARGS_ASSERT_REGATOM;
13381
13382   tryagain:
13383     parse_start = RExC_parse;
13384     assert(RExC_parse < RExC_end);
13385     switch ((U8)*RExC_parse) {
13386     case '^':
13387         RExC_seen_zerolen++;
13388         nextchar(pRExC_state);
13389         if (RExC_flags & RXf_PMf_MULTILINE)
13390             ret = reg_node(pRExC_state, MBOL);
13391         else
13392             ret = reg_node(pRExC_state, SBOL);
13393         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13394         break;
13395     case '$':
13396         nextchar(pRExC_state);
13397         if (*RExC_parse)
13398             RExC_seen_zerolen++;
13399         if (RExC_flags & RXf_PMf_MULTILINE)
13400             ret = reg_node(pRExC_state, MEOL);
13401         else
13402             ret = reg_node(pRExC_state, SEOL);
13403         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13404         break;
13405     case '.':
13406         nextchar(pRExC_state);
13407         if (RExC_flags & RXf_PMf_SINGLELINE)
13408             ret = reg_node(pRExC_state, SANY);
13409         else
13410             ret = reg_node(pRExC_state, REG_ANY);
13411         *flagp |= HASWIDTH|SIMPLE;
13412         MARK_NAUGHTY(1);
13413         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13414         break;
13415     case '[':
13416     {
13417         char * const oregcomp_parse = ++RExC_parse;
13418         ret = regclass(pRExC_state, flagp, depth+1,
13419                        FALSE, /* means parse the whole char class */
13420                        TRUE, /* allow multi-char folds */
13421                        FALSE, /* don't silence non-portable warnings. */
13422                        (bool) RExC_strict,
13423                        TRUE, /* Allow an optimized regnode result */
13424                        NULL);
13425         if (ret == 0) {
13426             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13427             FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13428                   (UV) *flagp);
13429         }
13430         if (*RExC_parse != ']') {
13431             RExC_parse = oregcomp_parse;
13432             vFAIL("Unmatched [");
13433         }
13434         nextchar(pRExC_state);
13435         Set_Node_Length(REGNODE_p(ret), RExC_parse - oregcomp_parse + 1); /* MJD */
13436         break;
13437     }
13438     case '(':
13439         nextchar(pRExC_state);
13440         ret = reg(pRExC_state, 2, &flags, depth+1);
13441         if (ret == 0) {
13442                 if (flags & TRYAGAIN) {
13443                     if (RExC_parse >= RExC_end) {
13444                          /* Make parent create an empty node if needed. */
13445                         *flagp |= TRYAGAIN;
13446                         return(0);
13447                     }
13448                     goto tryagain;
13449                 }
13450                 RETURN_FAIL_ON_RESTART(flags, flagp);
13451                 FAIL2("panic: reg returned failure to regatom, flags=%#" UVxf,
13452                                                                  (UV) flags);
13453         }
13454         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
13455         break;
13456     case '|':
13457     case ')':
13458         if (flags & TRYAGAIN) {
13459             *flagp |= TRYAGAIN;
13460             return 0;
13461         }
13462         vFAIL("Internal urp");
13463                                 /* Supposed to be caught earlier. */
13464         break;
13465     case '?':
13466     case '+':
13467     case '*':
13468         RExC_parse++;
13469         vFAIL("Quantifier follows nothing");
13470         break;
13471     case '\\':
13472         /* Special Escapes
13473
13474            This switch handles escape sequences that resolve to some kind
13475            of special regop and not to literal text. Escape sequences that
13476            resolve to literal text are handled below in the switch marked
13477            "Literal Escapes".
13478
13479            Every entry in this switch *must* have a corresponding entry
13480            in the literal escape switch. However, the opposite is not
13481            required, as the default for this switch is to jump to the
13482            literal text handling code.
13483         */
13484         RExC_parse++;
13485         switch ((U8)*RExC_parse) {
13486         /* Special Escapes */
13487         case 'A':
13488             RExC_seen_zerolen++;
13489             ret = reg_node(pRExC_state, SBOL);
13490             /* SBOL is shared with /^/ so we set the flags so we can tell
13491              * /\A/ from /^/ in split. */
13492             FLAGS(REGNODE_p(ret)) = 1;
13493             *flagp |= SIMPLE;
13494             goto finish_meta_pat;
13495         case 'G':
13496             ret = reg_node(pRExC_state, GPOS);
13497             RExC_seen |= REG_GPOS_SEEN;
13498             *flagp |= SIMPLE;
13499             goto finish_meta_pat;
13500         case 'K':
13501             if (!RExC_in_lookbehind && !RExC_in_lookahead) {
13502                 RExC_seen_zerolen++;
13503                 ret = reg_node(pRExC_state, KEEPS);
13504                 *flagp |= SIMPLE;
13505                 /* XXX:dmq : disabling in-place substitution seems to
13506                  * be necessary here to avoid cases of memory corruption, as
13507                  * with: C<$_="x" x 80; s/x\K/y/> -- rgs
13508                  */
13509                 RExC_seen |= REG_LOOKBEHIND_SEEN;
13510                 goto finish_meta_pat;
13511             }
13512             else {
13513                 ++RExC_parse; /* advance past the 'K' */
13514                 vFAIL("\\K not permitted in lookahead/lookbehind");
13515             }
13516         case 'Z':
13517             ret = reg_node(pRExC_state, SEOL);
13518             *flagp |= SIMPLE;
13519             RExC_seen_zerolen++;                /* Do not optimize RE away */
13520             goto finish_meta_pat;
13521         case 'z':
13522             ret = reg_node(pRExC_state, EOS);
13523             *flagp |= SIMPLE;
13524             RExC_seen_zerolen++;                /* Do not optimize RE away */
13525             goto finish_meta_pat;
13526         case 'C':
13527             vFAIL("\\C no longer supported");
13528         case 'X':
13529             ret = reg_node(pRExC_state, CLUMP);
13530             *flagp |= HASWIDTH;
13531             goto finish_meta_pat;
13532
13533         case 'B':
13534             invert = 1;
13535             /* FALLTHROUGH */
13536         case 'b':
13537           {
13538             U8 flags = 0;
13539             regex_charset charset = get_regex_charset(RExC_flags);
13540
13541             RExC_seen_zerolen++;
13542             RExC_seen |= REG_LOOKBEHIND_SEEN;
13543             op = BOUND + charset;
13544
13545             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
13546                 flags = TRADITIONAL_BOUND;
13547                 if (op > BOUNDA) {  /* /aa is same as /a */
13548                     op = BOUNDA;
13549                 }
13550             }
13551             else {
13552                 STRLEN length;
13553                 char name = *RExC_parse;
13554                 char * endbrace = NULL;
13555                 RExC_parse += 2;
13556                 endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
13557
13558                 if (! endbrace) {
13559                     vFAIL2("Missing right brace on \\%c{}", name);
13560                 }
13561                 /* XXX Need to decide whether to take spaces or not.  Should be
13562                  * consistent with \p{}, but that currently is SPACE, which
13563                  * means vertical too, which seems wrong
13564                  * while (isBLANK(*RExC_parse)) {
13565                     RExC_parse++;
13566                 }*/
13567                 if (endbrace == RExC_parse) {
13568                     RExC_parse++;  /* After the '}' */
13569                     vFAIL2("Empty \\%c{}", name);
13570                 }
13571                 length = endbrace - RExC_parse;
13572                 /*while (isBLANK(*(RExC_parse + length - 1))) {
13573                     length--;
13574                 }*/
13575                 switch (*RExC_parse) {
13576                     case 'g':
13577                         if (    length != 1
13578                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
13579                         {
13580                             goto bad_bound_type;
13581                         }
13582                         flags = GCB_BOUND;
13583                         break;
13584                     case 'l':
13585                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13586                             goto bad_bound_type;
13587                         }
13588                         flags = LB_BOUND;
13589                         break;
13590                     case 's':
13591                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13592                             goto bad_bound_type;
13593                         }
13594                         flags = SB_BOUND;
13595                         break;
13596                     case 'w':
13597                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13598                             goto bad_bound_type;
13599                         }
13600                         flags = WB_BOUND;
13601                         break;
13602                     default:
13603                       bad_bound_type:
13604                         RExC_parse = endbrace;
13605                         vFAIL2utf8f(
13606                             "'%" UTF8f "' is an unknown bound type",
13607                             UTF8fARG(UTF, length, endbrace - length));
13608                         NOT_REACHED; /*NOTREACHED*/
13609                 }
13610                 RExC_parse = endbrace;
13611                 REQUIRE_UNI_RULES(flagp, 0);
13612
13613                 if (op == BOUND) {
13614                     op = BOUNDU;
13615                 }
13616                 else if (op >= BOUNDA) {  /* /aa is same as /a */
13617                     op = BOUNDU;
13618                     length += 4;
13619
13620                     /* Don't have to worry about UTF-8, in this message because
13621                      * to get here the contents of the \b must be ASCII */
13622                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
13623                               "Using /u for '%.*s' instead of /%s",
13624                               (unsigned) length,
13625                               endbrace - length + 1,
13626                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
13627                               ? ASCII_RESTRICT_PAT_MODS
13628                               : ASCII_MORE_RESTRICT_PAT_MODS);
13629                 }
13630             }
13631
13632             if (op == BOUND) {
13633                 RExC_seen_d_op = TRUE;
13634             }
13635             else if (op == BOUNDL) {
13636                 RExC_contains_locale = 1;
13637             }
13638
13639             if (invert) {
13640                 op += NBOUND - BOUND;
13641             }
13642
13643             ret = reg_node(pRExC_state, op);
13644             FLAGS(REGNODE_p(ret)) = flags;
13645
13646             *flagp |= SIMPLE;
13647
13648             goto finish_meta_pat;
13649           }
13650
13651         case 'R':
13652             ret = reg_node(pRExC_state, LNBREAK);
13653             *flagp |= HASWIDTH|SIMPLE;
13654             goto finish_meta_pat;
13655
13656         case 'd':
13657         case 'D':
13658         case 'h':
13659         case 'H':
13660         case 'p':
13661         case 'P':
13662         case 's':
13663         case 'S':
13664         case 'v':
13665         case 'V':
13666         case 'w':
13667         case 'W':
13668             /* These all have the same meaning inside [brackets], and it knows
13669              * how to do the best optimizations for them.  So, pretend we found
13670              * these within brackets, and let it do the work */
13671             RExC_parse--;
13672
13673             ret = regclass(pRExC_state, flagp, depth+1,
13674                            TRUE, /* means just parse this element */
13675                            FALSE, /* don't allow multi-char folds */
13676                            FALSE, /* don't silence non-portable warnings.  It
13677                                      would be a bug if these returned
13678                                      non-portables */
13679                            (bool) RExC_strict,
13680                            TRUE, /* Allow an optimized regnode result */
13681                            NULL);
13682             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13683             /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
13684              * multi-char folds are allowed.  */
13685             if (!ret)
13686                 FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13687                       (UV) *flagp);
13688
13689             RExC_parse--;   /* regclass() leaves this one too far ahead */
13690
13691           finish_meta_pat:
13692                    /* The escapes above that don't take a parameter can't be
13693                     * followed by a '{'.  But 'pX', 'p{foo}' and
13694                     * correspondingly 'P' can be */
13695             if (   RExC_parse - parse_start == 1
13696                 && UCHARAT(RExC_parse + 1) == '{'
13697                 && UNLIKELY(! new_regcurly(RExC_parse + 1, RExC_end)))
13698             {
13699                 RExC_parse += 2;
13700                 vFAIL("Unescaped left brace in regex is illegal here");
13701             }
13702             Set_Node_Offset(REGNODE_p(ret), parse_start);
13703             Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1); /* MJD */
13704             nextchar(pRExC_state);
13705             break;
13706         case 'N':
13707             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
13708              * \N{...} evaluates to a sequence of more than one code points).
13709              * The function call below returns a regnode, which is our result.
13710              * The parameters cause it to fail if the \N{} evaluates to a
13711              * single code point; we handle those like any other literal.  The
13712              * reason that the multicharacter case is handled here and not as
13713              * part of the EXACtish code is because of quantifiers.  In
13714              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
13715              * this way makes that Just Happen. dmq.
13716              * join_exact() will join this up with adjacent EXACTish nodes
13717              * later on, if appropriate. */
13718             ++RExC_parse;
13719             if (grok_bslash_N(pRExC_state,
13720                               &ret,     /* Want a regnode returned */
13721                               NULL,     /* Fail if evaluates to a single code
13722                                            point */
13723                               NULL,     /* Don't need a count of how many code
13724                                            points */
13725                               flagp,
13726                               RExC_strict,
13727                               depth)
13728             ) {
13729                 break;
13730             }
13731
13732             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13733
13734             /* Here, evaluates to a single code point.  Go get that */
13735             RExC_parse = parse_start;
13736             goto defchar;
13737
13738         case 'k':    /* Handle \k<NAME> and \k'NAME' */
13739       parse_named_seq:
13740         {
13741             char ch;
13742             if (   RExC_parse >= RExC_end - 1
13743                 || ((   ch = RExC_parse[1]) != '<'
13744                                       && ch != '\''
13745                                       && ch != '{'))
13746             {
13747                 RExC_parse++;
13748                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13749                 vFAIL2("Sequence %.2s... not terminated", parse_start);
13750             } else {
13751                 RExC_parse += 2;
13752                 ret = handle_named_backref(pRExC_state,
13753                                            flagp,
13754                                            parse_start,
13755                                            (ch == '<')
13756                                            ? '>'
13757                                            : (ch == '{')
13758                                              ? '}'
13759                                              : '\'');
13760             }
13761             break;
13762         }
13763         case 'g':
13764         case '1': case '2': case '3': case '4':
13765         case '5': case '6': case '7': case '8': case '9':
13766             {
13767                 I32 num;
13768                 bool hasbrace = 0;
13769
13770                 if (*RExC_parse == 'g') {
13771                     bool isrel = 0;
13772
13773                     RExC_parse++;
13774                     if (*RExC_parse == '{') {
13775                         RExC_parse++;
13776                         hasbrace = 1;
13777                     }
13778                     if (*RExC_parse == '-') {
13779                         RExC_parse++;
13780                         isrel = 1;
13781                     }
13782                     if (hasbrace && !isDIGIT(*RExC_parse)) {
13783                         if (isrel) RExC_parse--;
13784                         RExC_parse -= 2;
13785                         goto parse_named_seq;
13786                     }
13787
13788                     if (RExC_parse >= RExC_end) {
13789                         goto unterminated_g;
13790                     }
13791                     num = S_backref_value(RExC_parse, RExC_end);
13792                     if (num == 0)
13793                         vFAIL("Reference to invalid group 0");
13794                     else if (num == I32_MAX) {
13795                          if (isDIGIT(*RExC_parse))
13796                             vFAIL("Reference to nonexistent group");
13797                         else
13798                           unterminated_g:
13799                             vFAIL("Unterminated \\g... pattern");
13800                     }
13801
13802                     if (isrel) {
13803                         num = RExC_npar - num;
13804                         if (num < 1)
13805                             vFAIL("Reference to nonexistent or unclosed group");
13806                     }
13807                 }
13808                 else {
13809                     num = S_backref_value(RExC_parse, RExC_end);
13810                     /* bare \NNN might be backref or octal - if it is larger
13811                      * than or equal RExC_npar then it is assumed to be an
13812                      * octal escape. Note RExC_npar is +1 from the actual
13813                      * number of parens. */
13814                     /* Note we do NOT check if num == I32_MAX here, as that is
13815                      * handled by the RExC_npar check */
13816
13817                     if (
13818                         /* any numeric escape < 10 is always a backref */
13819                         num > 9
13820                         /* any numeric escape < RExC_npar is a backref */
13821                         && num >= RExC_npar
13822                         /* cannot be an octal escape if it starts with 8 */
13823                         && *RExC_parse != '8'
13824                         /* cannot be an octal escape if it starts with 9 */
13825                         && *RExC_parse != '9'
13826                     ) {
13827                         /* Probably not meant to be a backref, instead likely
13828                          * to be an octal character escape, e.g. \35 or \777.
13829                          * The above logic should make it obvious why using
13830                          * octal escapes in patterns is problematic. - Yves */
13831                         RExC_parse = parse_start;
13832                         goto defchar;
13833                     }
13834                 }
13835
13836                 /* At this point RExC_parse points at a numeric escape like
13837                  * \12 or \88 or something similar, which we should NOT treat
13838                  * as an octal escape. It may or may not be a valid backref
13839                  * escape. For instance \88888888 is unlikely to be a valid
13840                  * backref. */
13841                 while (isDIGIT(*RExC_parse))
13842                     RExC_parse++;
13843                 if (hasbrace) {
13844                     if (*RExC_parse != '}')
13845                         vFAIL("Unterminated \\g{...} pattern");
13846                     RExC_parse++;
13847                 }
13848                 if (num >= (I32)RExC_npar) {
13849
13850                     /* It might be a forward reference; we can't fail until we
13851                      * know, by completing the parse to get all the groups, and
13852                      * then reparsing */
13853                     if (ALL_PARENS_COUNTED)  {
13854                         if (num >= RExC_total_parens)  {
13855                             vFAIL("Reference to nonexistent group");
13856                         }
13857                     }
13858                     else {
13859                         REQUIRE_PARENS_PASS;
13860                     }
13861                 }
13862                 RExC_sawback = 1;
13863                 ret = reganode(pRExC_state,
13864                                ((! FOLD)
13865                                  ? REF
13866                                  : (ASCII_FOLD_RESTRICTED)
13867                                    ? REFFA
13868                                    : (AT_LEAST_UNI_SEMANTICS)
13869                                      ? REFFU
13870                                      : (LOC)
13871                                        ? REFFL
13872                                        : REFF),
13873                                 num);
13874                 if (OP(REGNODE_p(ret)) == REFF) {
13875                     RExC_seen_d_op = TRUE;
13876                 }
13877                 *flagp |= HASWIDTH;
13878
13879                 /* override incorrect value set in reganode MJD */
13880                 Set_Node_Offset(REGNODE_p(ret), parse_start);
13881                 Set_Node_Cur_Length(REGNODE_p(ret), parse_start-1);
13882                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
13883                                         FALSE /* Don't force to /x */ );
13884             }
13885             break;
13886         case '\0':
13887             if (RExC_parse >= RExC_end)
13888                 FAIL("Trailing \\");
13889             /* FALLTHROUGH */
13890         default:
13891             /* Do not generate "unrecognized" warnings here, we fall
13892                back into the quick-grab loop below */
13893             RExC_parse = parse_start;
13894             goto defchar;
13895         } /* end of switch on a \foo sequence */
13896         break;
13897
13898     case '#':
13899
13900         /* '#' comments should have been spaced over before this function was
13901          * called */
13902         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
13903         /*
13904         if (RExC_flags & RXf_PMf_EXTENDED) {
13905             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
13906             if (RExC_parse < RExC_end)
13907                 goto tryagain;
13908         }
13909         */
13910
13911         /* FALLTHROUGH */
13912
13913     default:
13914           defchar: {
13915
13916             /* Here, we have determined that the next thing is probably a
13917              * literal character.  RExC_parse points to the first byte of its
13918              * definition.  (It still may be an escape sequence that evaluates
13919              * to a single character) */
13920
13921             STRLEN len = 0;
13922             UV ender = 0;
13923             char *p;
13924             char *s;
13925
13926 /* This allows us to fill a node with just enough spare so that if the final
13927  * character folds, its expansion is guaranteed to fit */
13928 #define MAX_NODE_STRING_SIZE (255-UTF8_MAXBYTES_CASE)
13929
13930             char *s0;
13931             U8 upper_parse = MAX_NODE_STRING_SIZE;
13932
13933             /* We start out as an EXACT node, even if under /i, until we find a
13934              * character which is in a fold.  The algorithm now segregates into
13935              * separate nodes, characters that fold from those that don't under
13936              * /i.  (This hopefully will create nodes that are fixed strings
13937              * even under /i, giving the optimizer something to grab on to.)
13938              * So, if a node has something in it and the next character is in
13939              * the opposite category, that node is closed up, and the function
13940              * returns.  Then regatom is called again, and a new node is
13941              * created for the new category. */
13942             U8 node_type = EXACT;
13943
13944             /* Assume the node will be fully used; the excess is given back at
13945              * the end.  We can't make any other length assumptions, as a byte
13946              * input sequence could shrink down. */
13947             Ptrdiff_t initial_size = STR_SZ(256);
13948
13949             bool next_is_quantifier;
13950             char * oldp = NULL;
13951
13952             /* We can convert EXACTF nodes to EXACTFU if they contain only
13953              * characters that match identically regardless of the target
13954              * string's UTF8ness.  The reason to do this is that EXACTF is not
13955              * trie-able, EXACTFU is, and EXACTFU requires fewer operations at
13956              * runtime.
13957              *
13958              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
13959              * contain only above-Latin1 characters (hence must be in UTF8),
13960              * which don't participate in folds with Latin1-range characters,
13961              * as the latter's folds aren't known until runtime. */
13962             bool maybe_exactfu = FOLD && (DEPENDS_SEMANTICS || LOC);
13963
13964             /* Single-character EXACTish nodes are almost always SIMPLE.  This
13965              * allows us to override this as encountered */
13966             U8 maybe_SIMPLE = SIMPLE;
13967
13968             /* Does this node contain something that can't match unless the
13969              * target string is (also) in UTF-8 */
13970             bool requires_utf8_target = FALSE;
13971
13972             /* The sequence 'ss' is problematic in non-UTF-8 patterns. */
13973             bool has_ss = FALSE;
13974
13975             /* So is the MICRO SIGN */
13976             bool has_micro_sign = FALSE;
13977
13978             /* Allocate an EXACT node.  The node_type may change below to
13979              * another EXACTish node, but since the size of the node doesn't
13980              * change, it works */
13981             ret = regnode_guts(pRExC_state, node_type, initial_size, "exact");
13982             FILL_NODE(ret, node_type);
13983             RExC_emit++;
13984
13985             s = STRING(REGNODE_p(ret));
13986
13987             s0 = s;
13988
13989           reparse:
13990
13991             /* This breaks under rare circumstances.  If folding, we do not
13992              * want to split a node at a character that is a non-final in a
13993              * multi-char fold, as an input string could just happen to want to
13994              * match across the node boundary.  The code at the end of the loop
13995              * looks for this, and backs off until it finds not such a
13996              * character, but it is possible (though extremely, extremely
13997              * unlikely) for all characters in the node to be non-final fold
13998              * ones, in which case we just leave the node fully filled, and
13999              * hope that it doesn't match the string in just the wrong place */
14000
14001             assert( ! UTF     /* Is at the beginning of a character */
14002                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
14003                    || UTF8_IS_START(UCHARAT(RExC_parse)));
14004
14005             /* Here, we have a literal character.  Find the maximal string of
14006              * them in the input that we can fit into a single EXACTish node.
14007              * We quit at the first non-literal or when the node gets full, or
14008              * under /i the categorization of folding/non-folding character
14009              * changes */
14010             for (p = RExC_parse; len < upper_parse && p < RExC_end; ) {
14011
14012                 /* In most cases each iteration adds one byte to the output.
14013                  * The exceptions override this */
14014                 Size_t added_len = 1;
14015
14016                 oldp = p;
14017
14018                 /* White space has already been ignored */
14019                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
14020                        || ! is_PATWS_safe((p), RExC_end, UTF));
14021
14022                 switch ((U8)*p) {
14023                 case '^':
14024                 case '$':
14025                 case '.':
14026                 case '[':
14027                 case '(':
14028                 case ')':
14029                 case '|':
14030                     goto loopdone;
14031                 case '\\':
14032                     /* Literal Escapes Switch
14033
14034                        This switch is meant to handle escape sequences that
14035                        resolve to a literal character.
14036
14037                        Every escape sequence that represents something
14038                        else, like an assertion or a char class, is handled
14039                        in the switch marked 'Special Escapes' above in this
14040                        routine, but also has an entry here as anything that
14041                        isn't explicitly mentioned here will be treated as
14042                        an unescaped equivalent literal.
14043                     */
14044
14045                     switch ((U8)*++p) {
14046
14047                     /* These are all the special escapes. */
14048                     case 'A':             /* Start assertion */
14049                     case 'b': case 'B':   /* Word-boundary assertion*/
14050                     case 'C':             /* Single char !DANGEROUS! */
14051                     case 'd': case 'D':   /* digit class */
14052                     case 'g': case 'G':   /* generic-backref, pos assertion */
14053                     case 'h': case 'H':   /* HORIZWS */
14054                     case 'k': case 'K':   /* named backref, keep marker */
14055                     case 'p': case 'P':   /* Unicode property */
14056                               case 'R':   /* LNBREAK */
14057                     case 's': case 'S':   /* space class */
14058                     case 'v': case 'V':   /* VERTWS */
14059                     case 'w': case 'W':   /* word class */
14060                     case 'X':             /* eXtended Unicode "combining
14061                                              character sequence" */
14062                     case 'z': case 'Z':   /* End of line/string assertion */
14063                         --p;
14064                         goto loopdone;
14065
14066                     /* Anything after here is an escape that resolves to a
14067                        literal. (Except digits, which may or may not)
14068                      */
14069                     case 'n':
14070                         ender = '\n';
14071                         p++;
14072                         break;
14073                     case 'N': /* Handle a single-code point named character. */
14074                         RExC_parse = p + 1;
14075                         if (! grok_bslash_N(pRExC_state,
14076                                             NULL,   /* Fail if evaluates to
14077                                                        anything other than a
14078                                                        single code point */
14079                                             &ender, /* The returned single code
14080                                                        point */
14081                                             NULL,   /* Don't need a count of
14082                                                        how many code points */
14083                                             flagp,
14084                                             RExC_strict,
14085                                             depth)
14086                         ) {
14087                             if (*flagp & NEED_UTF8)
14088                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
14089                             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
14090
14091                             /* Here, it wasn't a single code point.  Go close
14092                              * up this EXACTish node.  The switch() prior to
14093                              * this switch handles the other cases */
14094                             RExC_parse = p = oldp;
14095                             goto loopdone;
14096                         }
14097                         p = RExC_parse;
14098                         RExC_parse = parse_start;
14099
14100                         /* The \N{} means the pattern, if previously /d,
14101                          * becomes /u.  That means it can't be an EXACTF node,
14102                          * but an EXACTFU */
14103                         if (node_type == EXACTF) {
14104                             node_type = EXACTFU;
14105
14106                             /* If the node already contains something that
14107                              * differs between EXACTF and EXACTFU, reparse it
14108                              * as EXACTFU */
14109                             if (! maybe_exactfu) {
14110                                 len = 0;
14111                                 s = s0;
14112                                 goto reparse;
14113                             }
14114                         }
14115
14116                         break;
14117                     case 'r':
14118                         ender = '\r';
14119                         p++;
14120                         break;
14121                     case 't':
14122                         ender = '\t';
14123                         p++;
14124                         break;
14125                     case 'f':
14126                         ender = '\f';
14127                         p++;
14128                         break;
14129                     case 'e':
14130                         ender = ESC_NATIVE;
14131                         p++;
14132                         break;
14133                     case 'a':
14134                         ender = '\a';
14135                         p++;
14136                         break;
14137                     case 'o':
14138                         {
14139                             UV result;
14140                             const char* error_msg;
14141
14142                             bool valid = grok_bslash_o(&p,
14143                                                        RExC_end,
14144                                                        &result,
14145                                                        &error_msg,
14146                                                        TO_OUTPUT_WARNINGS(p),
14147                                                        (bool) RExC_strict,
14148                                                        TRUE, /* Output warnings
14149                                                                 for non-
14150                                                                 portables */
14151                                                        UTF);
14152                             if (! valid) {
14153                                 RExC_parse = p; /* going to die anyway; point
14154                                                    to exact spot of failure */
14155                                 vFAIL(error_msg);
14156                             }
14157                             UPDATE_WARNINGS_LOC(p - 1);
14158                             ender = result;
14159                             break;
14160                         }
14161                     case 'x':
14162                         {
14163                             UV result = UV_MAX; /* initialize to erroneous
14164                                                    value */
14165                             const char* error_msg;
14166
14167                             bool valid = grok_bslash_x(&p,
14168                                                        RExC_end,
14169                                                        &result,
14170                                                        &error_msg,
14171                                                        TO_OUTPUT_WARNINGS(p),
14172                                                        (bool) RExC_strict,
14173                                                        TRUE, /* Silence warnings
14174                                                                 for non-
14175                                                                 portables */
14176                                                        UTF);
14177                             if (! valid) {
14178                                 RExC_parse = p; /* going to die anyway; point
14179                                                    to exact spot of failure */
14180                                 vFAIL(error_msg);
14181                             }
14182                             UPDATE_WARNINGS_LOC(p - 1);
14183                             ender = result;
14184
14185 #ifdef EBCDIC
14186                             if (ender < 0x100) {
14187                                 if (RExC_recode_x_to_native) {
14188                                     ender = LATIN1_TO_NATIVE(ender);
14189                                 }
14190                             }
14191 #endif
14192                             break;
14193                         }
14194                     case 'c':
14195                         p++;
14196                         ender = grok_bslash_c(*p, TO_OUTPUT_WARNINGS(p));
14197                         UPDATE_WARNINGS_LOC(p);
14198                         p++;
14199                         break;
14200                     case '8': case '9': /* must be a backreference */
14201                         --p;
14202                         /* we have an escape like \8 which cannot be an octal escape
14203                          * so we exit the loop, and let the outer loop handle this
14204                          * escape which may or may not be a legitimate backref. */
14205                         goto loopdone;
14206                     case '1': case '2': case '3':case '4':
14207                     case '5': case '6': case '7':
14208                         /* When we parse backslash escapes there is ambiguity
14209                          * between backreferences and octal escapes. Any escape
14210                          * from \1 - \9 is a backreference, any multi-digit
14211                          * escape which does not start with 0 and which when
14212                          * evaluated as decimal could refer to an already
14213                          * parsed capture buffer is a back reference. Anything
14214                          * else is octal.
14215                          *
14216                          * Note this implies that \118 could be interpreted as
14217                          * 118 OR as "\11" . "8" depending on whether there
14218                          * were 118 capture buffers defined already in the
14219                          * pattern.  */
14220
14221                         /* NOTE, RExC_npar is 1 more than the actual number of
14222                          * parens we have seen so far, hence the "<" as opposed
14223                          * to "<=" */
14224                         if ( !isDIGIT(p[1]) || S_backref_value(p, RExC_end) < RExC_npar)
14225                         {  /* Not to be treated as an octal constant, go
14226                                    find backref */
14227                             --p;
14228                             goto loopdone;
14229                         }
14230                         /* FALLTHROUGH */
14231                     case '0':
14232                         {
14233                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
14234                             STRLEN numlen = 3;
14235                             ender = grok_oct(p, &numlen, &flags, NULL);
14236                             p += numlen;
14237                             if (   isDIGIT(*p)  /* like \08, \178 */
14238                                 && ckWARN(WARN_REGEXP)
14239                                 && numlen < 3)
14240                             {
14241                                 reg_warn_non_literal_string(
14242                                          p + 1,
14243                                          form_short_octal_warning(p, numlen));
14244                             }
14245                         }
14246                         break;
14247                     case '\0':
14248                         if (p >= RExC_end)
14249                             FAIL("Trailing \\");
14250                         /* FALLTHROUGH */
14251                     default:
14252                         if (isALPHANUMERIC(*p)) {
14253                             /* An alpha followed by '{' is going to fail next
14254                              * iteration, so don't output this warning in that
14255                              * case */
14256                             if (! isALPHA(*p) || *(p + 1) != '{') {
14257                                 ckWARN2reg(p + 1, "Unrecognized escape \\%.1s"
14258                                                   " passed through", p);
14259                             }
14260                         }
14261                         goto normal_default;
14262                     } /* End of switch on '\' */
14263                     break;
14264                 case '{':
14265                     /* Trying to gain new uses for '{' without breaking too
14266                      * much existing code is hard.  The solution currently
14267                      * adopted is:
14268                      *  1)  If there is no ambiguity that a '{' should always
14269                      *      be taken literally, at the start of a construct, we
14270                      *      just do so.
14271                      *  2)  If the literal '{' conflicts with our desired use
14272                      *      of it as a metacharacter, we die.  The deprecation
14273                      *      cycles for this have come and gone.
14274                      *  3)  If there is ambiguity, we raise a simple warning.
14275                      *      This could happen, for example, if the user
14276                      *      intended it to introduce a quantifier, but slightly
14277                      *      misspelled the quantifier.  Without this warning,
14278                      *      the quantifier would silently be taken as a literal
14279                      *      string of characters instead of a meta construct */
14280                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
14281                         if (      RExC_strict
14282                             || (  p > parse_start + 1
14283                                 && isALPHA_A(*(p - 1))
14284                                 && *(p - 2) == '\\')
14285                             || new_regcurly(p, RExC_end))
14286                         {
14287                             RExC_parse = p + 1;
14288                             vFAIL("Unescaped left brace in regex is "
14289                                   "illegal here");
14290                         }
14291                         ckWARNreg(p + 1, "Unescaped left brace in regex is"
14292                                          " passed through");
14293                     }
14294                     goto normal_default;
14295                 case '}':
14296                 case ']':
14297                     if (p > RExC_parse && RExC_strict) {
14298                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
14299                     }
14300                     /*FALLTHROUGH*/
14301                 default:    /* A literal character */
14302                   normal_default:
14303                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
14304                         STRLEN numlen;
14305                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
14306                                                &numlen, UTF8_ALLOW_DEFAULT);
14307                         p += numlen;
14308                     }
14309                     else
14310                         ender = (U8) *p++;
14311                     break;
14312                 } /* End of switch on the literal */
14313
14314                 /* Here, have looked at the literal character, and <ender>
14315                  * contains its ordinal; <p> points to the character after it.
14316                  * */
14317
14318                 if (ender > 255) {
14319                     REQUIRE_UTF8(flagp);
14320                 }
14321
14322                 /* We need to check if the next non-ignored thing is a
14323                  * quantifier.  Move <p> to after anything that should be
14324                  * ignored, which, as a side effect, positions <p> for the next
14325                  * loop iteration */
14326                 skip_to_be_ignored_text(pRExC_state, &p,
14327                                         FALSE /* Don't force to /x */ );
14328
14329                 /* If the next thing is a quantifier, it applies to this
14330                  * character only, which means that this character has to be in
14331                  * its own node and can't just be appended to the string in an
14332                  * existing node, so if there are already other characters in
14333                  * the node, close the node with just them, and set up to do
14334                  * this character again next time through, when it will be the
14335                  * only thing in its new node */
14336
14337                 next_is_quantifier =    LIKELY(p < RExC_end)
14338                                      && UNLIKELY(ISMULT2(p));
14339
14340                 if (next_is_quantifier && LIKELY(len)) {
14341                     p = oldp;
14342                     goto loopdone;
14343                 }
14344
14345                 /* Ready to add 'ender' to the node */
14346
14347                 if (! FOLD) {  /* The simple case, just append the literal */
14348
14349                       not_fold_common:
14350                         if (UVCHR_IS_INVARIANT(ender) || ! UTF) {
14351                             *(s++) = (char) ender;
14352                         }
14353                         else {
14354                             U8 * new_s = uvchr_to_utf8((U8*)s, ender);
14355                             added_len = (char *) new_s - s;
14356                             s = (char *) new_s;
14357
14358                             if (ender > 255)  {
14359                                 requires_utf8_target = TRUE;
14360                             }
14361                         }
14362                 }
14363                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
14364
14365                     /* Here are folding under /l, and the code point is
14366                      * problematic.  If this is the first character in the
14367                      * node, change the node type to folding.   Otherwise, if
14368                      * this is the first problematic character, close up the
14369                      * existing node, so can start a new node with this one */
14370                     if (! len) {
14371                         node_type = EXACTFL;
14372                         RExC_contains_locale = 1;
14373                     }
14374                     else if (node_type == EXACT) {
14375                         p = oldp;
14376                         goto loopdone;
14377                     }
14378
14379                     /* This problematic code point means we can't simplify
14380                      * things */
14381                     maybe_exactfu = FALSE;
14382
14383                     /* Here, we are adding a problematic fold character.
14384                      * "Problematic" in this context means that its fold isn't
14385                      * known until runtime.  (The non-problematic code points
14386                      * are the above-Latin1 ones that fold to also all
14387                      * above-Latin1.  Their folds don't vary no matter what the
14388                      * locale is.) But here we have characters whose fold
14389                      * depends on the locale.  We just add in the unfolded
14390                      * character, and wait until runtime to fold it */
14391                     goto not_fold_common;
14392                 }
14393                 else /* regular fold; see if actually is in a fold */
14394                      if (   (ender < 256 && ! IS_IN_SOME_FOLD_L1(ender))
14395                          || (ender > 255
14396                             && ! _invlist_contains_cp(PL_in_some_fold, ender)))
14397                 {
14398                     /* Here, folding, but the character isn't in a fold.
14399                      *
14400                      * Start a new node if previous characters in the node were
14401                      * folded */
14402                     if (len && node_type != EXACT) {
14403                         p = oldp;
14404                         goto loopdone;
14405                     }
14406
14407                     /* Here, continuing a node with non-folded characters.  Add
14408                      * this one */
14409                     goto not_fold_common;
14410                 }
14411                 else {  /* Here, does participate in some fold */
14412
14413                     /* If this is the first character in the node, change its
14414                      * type to folding.  Otherwise, if this is the first
14415                      * folding character in the node, close up the existing
14416                      * node, so can start a new node with this one.  */
14417                     if (! len) {
14418                         node_type = compute_EXACTish(pRExC_state);
14419                     }
14420                     else if (node_type == EXACT) {
14421                         p = oldp;
14422                         goto loopdone;
14423                     }
14424
14425                     if (UTF) {  /* Use the folded value */
14426                         if (UVCHR_IS_INVARIANT(ender)) {
14427                             *(s)++ = (U8) toFOLD(ender);
14428                         }
14429                         else {
14430                             ender = _to_uni_fold_flags(
14431                                     ender,
14432                                     (U8 *) s,
14433                                     &added_len,
14434                                     FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
14435                                                     ? FOLD_FLAGS_NOMIX_ASCII
14436                                                     : 0));
14437                             s += added_len;
14438
14439                             if (   ender > 255
14440                                 && LIKELY(ender != GREEK_SMALL_LETTER_MU))
14441                             {
14442                                 /* U+B5 folds to the MU, so its possible for a
14443                                  * non-UTF-8 target to match it */
14444                                 requires_utf8_target = TRUE;
14445                             }
14446                         }
14447                     }
14448                     else {
14449
14450                         /* Here is non-UTF8.  First, see if the character's
14451                          * fold differs between /d and /u. */
14452                         if (PL_fold[ender] != PL_fold_latin1[ender]) {
14453                             maybe_exactfu = FALSE;
14454                         }
14455
14456 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
14457    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
14458                                       || UNICODE_DOT_DOT_VERSION > 0)
14459
14460                         /* On non-ancient Unicode versions, this includes the
14461                          * multi-char fold SHARP S to 'ss' */
14462
14463                         if (   UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)
14464                                  || (   isALPHA_FOLD_EQ(ender, 's')
14465                                      && len > 0
14466                                      && isALPHA_FOLD_EQ(*(s-1), 's')))
14467                         {
14468                             /* Here, we have one of the following:
14469                              *  a)  a SHARP S.  This folds to 'ss' only under
14470                              *      /u rules.  If we are in that situation,
14471                              *      fold the SHARP S to 'ss'.  See the comments
14472                              *      for join_exact() as to why we fold this
14473                              *      non-UTF at compile time, and no others.
14474                              *  b)  'ss'.  When under /u, there's nothing
14475                              *      special needed to be done here.  The
14476                              *      previous iteration handled the first 's',
14477                              *      and this iteration will handle the second.
14478                              *      If, on the otherhand it's not /u, we have
14479                              *      to exclude the possibility of moving to /u,
14480                              *      so that we won't generate an unwanted
14481                              *      match, unless, at runtime, the target
14482                              *      string is in UTF-8.
14483                              * */
14484
14485                             has_ss = TRUE;
14486                             maybe_exactfu = FALSE;  /* Can't generate an
14487                                                        EXACTFU node (unless we
14488                                                        already are in one) */
14489                             if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
14490                                 maybe_SIMPLE = 0;
14491                                 if (node_type == EXACTFU) {
14492                                     *(s++) = 's';
14493
14494                                     /* Let the code below add in the extra 's' */
14495                                     ender = 's';
14496                                     added_len = 2;
14497                                 }
14498                             }
14499                         }
14500 #endif
14501
14502                         else if (UNLIKELY(ender == MICRO_SIGN)) {
14503                             has_micro_sign = TRUE;
14504                         }
14505
14506                         *(s++) = (DEPENDS_SEMANTICS)
14507                                  ? (char) toFOLD(ender)
14508
14509                                    /* Under /u, the fold of any character in
14510                                     * the 0-255 range happens to be its
14511                                     * lowercase equivalent, except for LATIN
14512                                     * SMALL LETTER SHARP S, which was handled
14513                                     * above, and the MICRO SIGN, whose fold
14514                                     * requires UTF-8 to represent.  */
14515                                  : (char) toLOWER_L1(ender);
14516                     }
14517                 } /* End of adding current character to the node */
14518
14519                 len += added_len;
14520
14521                 if (next_is_quantifier) {
14522
14523                     /* Here, the next input is a quantifier, and to get here,
14524                      * the current character is the only one in the node. */
14525                     goto loopdone;
14526                 }
14527
14528             } /* End of loop through literal characters */
14529
14530             /* Here we have either exhausted the input or ran out of room in
14531              * the node.  (If we encountered a character that can't be in the
14532              * node, transfer is made directly to <loopdone>, and so we
14533              * wouldn't have fallen off the end of the loop.)  In the latter
14534              * case, we artificially have to split the node into two, because
14535              * we just don't have enough space to hold everything.  This
14536              * creates a problem if the final character participates in a
14537              * multi-character fold in the non-final position, as a match that
14538              * should have occurred won't, due to the way nodes are matched,
14539              * and our artificial boundary.  So back off until we find a non-
14540              * problematic character -- one that isn't at the beginning or
14541              * middle of such a fold.  (Either it doesn't participate in any
14542              * folds, or appears only in the final position of all the folds it
14543              * does participate in.)  A better solution with far fewer false
14544              * positives, and that would fill the nodes more completely, would
14545              * be to actually have available all the multi-character folds to
14546              * test against, and to back-off only far enough to be sure that
14547              * this node isn't ending with a partial one.  <upper_parse> is set
14548              * further below (if we need to reparse the node) to include just
14549              * up through that final non-problematic character that this code
14550              * identifies, so when it is set to less than the full node, we can
14551              * skip the rest of this */
14552             if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
14553                 PERL_UINT_FAST8_T backup_count = 0;
14554
14555                 const STRLEN full_len = len;
14556
14557                 assert(len >= MAX_NODE_STRING_SIZE);
14558
14559                 /* Here, <s> points to just beyond where we have output the
14560                  * final character of the node.  Look backwards through the
14561                  * string until find a non- problematic character */
14562
14563                 if (! UTF) {
14564
14565                     /* This has no multi-char folds to non-UTF characters */
14566                     if (ASCII_FOLD_RESTRICTED) {
14567                         goto loopdone;
14568                     }
14569
14570                     while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) {
14571                         backup_count++;
14572                     }
14573                     len = s - s0 + 1;
14574                 }
14575                 else {
14576
14577                     /* Point to the first byte of the final character */
14578                     s = (char *) utf8_hop_back((U8 *) s, -1, (U8 *) s0);
14579
14580                     while (s >= s0) {   /* Search backwards until find
14581                                            a non-problematic char */
14582                         if (UTF8_IS_INVARIANT(*s)) {
14583
14584                             /* There are no ascii characters that participate
14585                              * in multi-char folds under /aa.  In EBCDIC, the
14586                              * non-ascii invariants are all control characters,
14587                              * so don't ever participate in any folds. */
14588                             if (ASCII_FOLD_RESTRICTED
14589                                 || ! IS_NON_FINAL_FOLD(*s))
14590                             {
14591                                 break;
14592                             }
14593                         }
14594                         else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
14595                             if (! IS_NON_FINAL_FOLD(EIGHT_BIT_UTF8_TO_NATIVE(
14596                                                                   *s, *(s+1))))
14597                             {
14598                                 break;
14599                             }
14600                         }
14601                         else if (! _invlist_contains_cp(
14602                                         PL_NonFinalFold,
14603                                         valid_utf8_to_uvchr((U8 *) s, NULL)))
14604                         {
14605                             break;
14606                         }
14607
14608                         /* Here, the current character is problematic in that
14609                          * it does occur in the non-final position of some
14610                          * fold, so try the character before it, but have to
14611                          * special case the very first byte in the string, so
14612                          * we don't read outside the string */
14613                         s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
14614                         backup_count++;
14615                     } /* End of loop backwards through the string */
14616
14617                     /* If there were only problematic characters in the string,
14618                      * <s> will point to before s0, in which case the length
14619                      * should be 0, otherwise include the length of the
14620                      * non-problematic character just found */
14621                     len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
14622                 }
14623
14624                 /* Here, have found the final character, if any, that is
14625                  * non-problematic as far as ending the node without splitting
14626                  * it across a potential multi-char fold.  <len> contains the
14627                  * number of bytes in the node up-to and including that
14628                  * character, or is 0 if there is no such character, meaning
14629                  * the whole node contains only problematic characters.  In
14630                  * this case, give up and just take the node as-is.  We can't
14631                  * do any better */
14632                 if (len == 0) {
14633                     len = full_len;
14634
14635                 } else {
14636
14637                     /* Here, the node does contain some characters that aren't
14638                      * problematic.  If we didn't have to backup any, then the
14639                      * final character in the node is non-problematic, and we
14640                      * can take the node as-is */
14641                     if (backup_count == 0) {
14642                         goto loopdone;
14643                     }
14644                     else if (backup_count == 1) {
14645
14646                         /* If the final character is problematic, but the
14647                          * penultimate is not, back-off that last character to
14648                          * later start a new node with it */
14649                         p = oldp;
14650                         goto loopdone;
14651                     }
14652
14653                     /* Here, the final non-problematic character is earlier
14654                      * in the input than the penultimate character.  What we do
14655                      * is reparse from the beginning, going up only as far as
14656                      * this final ok one, thus guaranteeing that the node ends
14657                      * in an acceptable character.  The reason we reparse is
14658                      * that we know how far in the character is, but we don't
14659                      * know how to correlate its position with the input parse.
14660                      * An alternate implementation would be to build that
14661                      * correlation as we go along during the original parse,
14662                      * but that would entail extra work for every node, whereas
14663                      * this code gets executed only when the string is too
14664                      * large for the node, and the final two characters are
14665                      * problematic, an infrequent occurrence.  Yet another
14666                      * possible strategy would be to save the tail of the
14667                      * string, and the next time regatom is called, initialize
14668                      * with that.  The problem with this is that unless you
14669                      * back off one more character, you won't be guaranteed
14670                      * regatom will get called again, unless regbranch,
14671                      * regpiece ... are also changed.  If you do back off that
14672                      * extra character, so that there is input guaranteed to
14673                      * force calling regatom, you can't handle the case where
14674                      * just the first character in the node is acceptable.  I
14675                      * (khw) decided to try this method which doesn't have that
14676                      * pitfall; if performance issues are found, we can do a
14677                      * combination of the current approach plus that one */
14678                     upper_parse = len;
14679                     len = 0;
14680                     s = s0;
14681                     goto reparse;
14682                 }
14683             }   /* End of verifying node ends with an appropriate char */
14684
14685           loopdone:   /* Jumped to when encounters something that shouldn't be
14686                          in the node */
14687
14688             /* Free up any over-allocated space; cast is to silence bogus
14689              * warning in MS VC */
14690             change_engine_size(pRExC_state,
14691                                 - (Ptrdiff_t) (initial_size - STR_SZ(len)));
14692
14693             /* I (khw) don't know if you can get here with zero length, but the
14694              * old code handled this situation by creating a zero-length EXACT
14695              * node.  Might as well be NOTHING instead */
14696             if (len == 0) {
14697                 OP(REGNODE_p(ret)) = NOTHING;
14698             }
14699             else {
14700
14701                 /* If the node type is EXACT here, check to see if it
14702                  * should be EXACTL, or EXACT_ONLY8. */
14703                 if (node_type == EXACT) {
14704                     if (LOC) {
14705                         node_type = EXACTL;
14706                     }
14707                     else if (requires_utf8_target) {
14708                         node_type = EXACT_ONLY8;
14709                     }
14710                 } else if (FOLD) {
14711                     if (    UNLIKELY(has_micro_sign || has_ss)
14712                         && (node_type == EXACTFU || (   node_type == EXACTF
14713                                                      && maybe_exactfu)))
14714                     {   /* These two conditions are problematic in non-UTF-8
14715                            EXACTFU nodes. */
14716                         assert(! UTF);
14717                         node_type = EXACTFUP;
14718                     }
14719                     else if (node_type == EXACTFL) {
14720
14721                         /* 'maybe_exactfu' is deliberately set above to
14722                          * indicate this node type, where all code points in it
14723                          * are above 255 */
14724                         if (maybe_exactfu) {
14725                             node_type = EXACTFLU8;
14726                         }
14727                     }
14728                     else if (node_type == EXACTF) {  /* Means is /di */
14729
14730                         /* If 'maybe_exactfu' is clear, then we need to stay
14731                          * /di.  If it is set, it means there are no code
14732                          * points that match differently depending on UTF8ness
14733                          * of the target string, so it can become an EXACTFU
14734                          * node */
14735                         if (! maybe_exactfu) {
14736                             RExC_seen_d_op = TRUE;
14737                         }
14738                         else if (   isALPHA_FOLD_EQ(* STRING(REGNODE_p(ret)), 's')
14739                                  || isALPHA_FOLD_EQ(ender, 's'))
14740                         {
14741                             /* But, if the node begins or ends in an 's' we
14742                              * have to defer changing it into an EXACTFU, as
14743                              * the node could later get joined with another one
14744                              * that ends or begins with 's' creating an 'ss'
14745                              * sequence which would then wrongly match the
14746                              * sharp s without the target being UTF-8.  We
14747                              * create a special node that we resolve later when
14748                              * we join nodes together */
14749
14750                             node_type = EXACTFU_S_EDGE;
14751                         }
14752                         else {
14753                             node_type = EXACTFU;
14754                         }
14755                     }
14756
14757                     if (requires_utf8_target && node_type == EXACTFU) {
14758                         node_type = EXACTFU_ONLY8;
14759                     }
14760                 }
14761
14762                 OP(REGNODE_p(ret)) = node_type;
14763                 STR_LEN(REGNODE_p(ret)) = len;
14764                 RExC_emit += STR_SZ(len);
14765
14766                 /* If the node isn't a single character, it can't be SIMPLE */
14767                 if (len > (Size_t) ((UTF) ? UVCHR_SKIP(ender) : 1)) {
14768                     maybe_SIMPLE = 0;
14769                 }
14770
14771                 *flagp |= HASWIDTH | maybe_SIMPLE;
14772             }
14773
14774             Set_Node_Length(REGNODE_p(ret), p - parse_start - 1);
14775             RExC_parse = p;
14776
14777             {
14778                 /* len is STRLEN which is unsigned, need to copy to signed */
14779                 IV iv = len;
14780                 if (iv < 0)
14781                     vFAIL("Internal disaster");
14782             }
14783
14784         } /* End of label 'defchar:' */
14785         break;
14786     } /* End of giant switch on input character */
14787
14788     /* Position parse to next real character */
14789     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14790                                             FALSE /* Don't force to /x */ );
14791     if (   *RExC_parse == '{'
14792         && OP(REGNODE_p(ret)) != SBOL && ! regcurly(RExC_parse))
14793     {
14794         if (RExC_strict || new_regcurly(RExC_parse, RExC_end)) {
14795             RExC_parse++;
14796             vFAIL("Unescaped left brace in regex is illegal here");
14797         }
14798         ckWARNreg(RExC_parse + 1, "Unescaped left brace in regex is"
14799                                   " passed through");
14800     }
14801
14802     return(ret);
14803 }
14804
14805
14806 STATIC void
14807 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
14808 {
14809     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
14810      * sets up the bitmap and any flags, removing those code points from the
14811      * inversion list, setting it to NULL should it become completely empty */
14812
14813     dVAR;
14814
14815     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
14816     assert(PL_regkind[OP(node)] == ANYOF);
14817
14818     /* There is no bitmap for this node type */
14819     if (inRANGE(OP(node), ANYOFH, ANYOFHr)) {
14820         return;
14821     }
14822
14823     ANYOF_BITMAP_ZERO(node);
14824     if (*invlist_ptr) {
14825
14826         /* This gets set if we actually need to modify things */
14827         bool change_invlist = FALSE;
14828
14829         UV start, end;
14830
14831         /* Start looking through *invlist_ptr */
14832         invlist_iterinit(*invlist_ptr);
14833         while (invlist_iternext(*invlist_ptr, &start, &end)) {
14834             UV high;
14835             int i;
14836
14837             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
14838                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
14839             }
14840
14841             /* Quit if are above what we should change */
14842             if (start >= NUM_ANYOF_CODE_POINTS) {
14843                 break;
14844             }
14845
14846             change_invlist = TRUE;
14847
14848             /* Set all the bits in the range, up to the max that we are doing */
14849             high = (end < NUM_ANYOF_CODE_POINTS - 1)
14850                    ? end
14851                    : NUM_ANYOF_CODE_POINTS - 1;
14852             for (i = start; i <= (int) high; i++) {
14853                 if (! ANYOF_BITMAP_TEST(node, i)) {
14854                     ANYOF_BITMAP_SET(node, i);
14855                 }
14856             }
14857         }
14858         invlist_iterfinish(*invlist_ptr);
14859
14860         /* Done with loop; remove any code points that are in the bitmap from
14861          * *invlist_ptr; similarly for code points above the bitmap if we have
14862          * a flag to match all of them anyways */
14863         if (change_invlist) {
14864             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
14865         }
14866         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
14867             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
14868         }
14869
14870         /* If have completely emptied it, remove it completely */
14871         if (_invlist_len(*invlist_ptr) == 0) {
14872             SvREFCNT_dec_NN(*invlist_ptr);
14873             *invlist_ptr = NULL;
14874         }
14875     }
14876 }
14877
14878 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
14879    Character classes ([:foo:]) can also be negated ([:^foo:]).
14880    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
14881    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
14882    but trigger failures because they are currently unimplemented. */
14883
14884 #define POSIXCC_DONE(c)   ((c) == ':')
14885 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
14886 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
14887 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
14888
14889 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
14890 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
14891 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
14892
14893 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
14894
14895 /* 'posix_warnings' and 'warn_text' are names of variables in the following
14896  * routine. q.v. */
14897 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
14898         if (posix_warnings) {                                               \
14899             if (! RExC_warn_text ) RExC_warn_text =                         \
14900                                          (AV *) sv_2mortal((SV *) newAV()); \
14901             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                     \
14902                                              WARNING_PREFIX                 \
14903                                              text                           \
14904                                              REPORT_LOCATION,               \
14905                                              REPORT_LOCATION_ARGS(p)));     \
14906         }                                                                   \
14907     } STMT_END
14908 #define CLEAR_POSIX_WARNINGS()                                              \
14909     STMT_START {                                                            \
14910         if (posix_warnings && RExC_warn_text)                               \
14911             av_clear(RExC_warn_text);                                       \
14912     } STMT_END
14913
14914 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
14915     STMT_START {                                                            \
14916         CLEAR_POSIX_WARNINGS();                                             \
14917         return ret;                                                         \
14918     } STMT_END
14919
14920 STATIC int
14921 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
14922
14923     const char * const s,      /* Where the putative posix class begins.
14924                                   Normally, this is one past the '['.  This
14925                                   parameter exists so it can be somewhere
14926                                   besides RExC_parse. */
14927     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
14928                                   NULL */
14929     AV ** posix_warnings,      /* Where to place any generated warnings, or
14930                                   NULL */
14931     const bool check_only      /* Don't die if error */
14932 )
14933 {
14934     /* This parses what the caller thinks may be one of the three POSIX
14935      * constructs:
14936      *  1) a character class, like [:blank:]
14937      *  2) a collating symbol, like [. .]
14938      *  3) an equivalence class, like [= =]
14939      * In the latter two cases, it croaks if it finds a syntactically legal
14940      * one, as these are not handled by Perl.
14941      *
14942      * The main purpose is to look for a POSIX character class.  It returns:
14943      *  a) the class number
14944      *      if it is a completely syntactically and semantically legal class.
14945      *      'updated_parse_ptr', if not NULL, is set to point to just after the
14946      *      closing ']' of the class
14947      *  b) OOB_NAMEDCLASS
14948      *      if it appears that one of the three POSIX constructs was meant, but
14949      *      its specification was somehow defective.  'updated_parse_ptr', if
14950      *      not NULL, is set to point to the character just after the end
14951      *      character of the class.  See below for handling of warnings.
14952      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
14953      *      if it  doesn't appear that a POSIX construct was intended.
14954      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
14955      *      raised.
14956      *
14957      * In b) there may be errors or warnings generated.  If 'check_only' is
14958      * TRUE, then any errors are discarded.  Warnings are returned to the
14959      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
14960      * instead it is NULL, warnings are suppressed.
14961      *
14962      * The reason for this function, and its complexity is that a bracketed
14963      * character class can contain just about anything.  But it's easy to
14964      * mistype the very specific posix class syntax but yielding a valid
14965      * regular bracketed class, so it silently gets compiled into something
14966      * quite unintended.
14967      *
14968      * The solution adopted here maintains backward compatibility except that
14969      * it adds a warning if it looks like a posix class was intended but
14970      * improperly specified.  The warning is not raised unless what is input
14971      * very closely resembles one of the 14 legal posix classes.  To do this,
14972      * it uses fuzzy parsing.  It calculates how many single-character edits it
14973      * would take to transform what was input into a legal posix class.  Only
14974      * if that number is quite small does it think that the intention was a
14975      * posix class.  Obviously these are heuristics, and there will be cases
14976      * where it errs on one side or another, and they can be tweaked as
14977      * experience informs.
14978      *
14979      * The syntax for a legal posix class is:
14980      *
14981      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
14982      *
14983      * What this routine considers syntactically to be an intended posix class
14984      * is this (the comments indicate some restrictions that the pattern
14985      * doesn't show):
14986      *
14987      *  qr/(?x: \[?                         # The left bracket, possibly
14988      *                                      # omitted
14989      *          \h*                         # possibly followed by blanks
14990      *          (?: \^ \h* )?               # possibly a misplaced caret
14991      *          [:;]?                       # The opening class character,
14992      *                                      # possibly omitted.  A typo
14993      *                                      # semi-colon can also be used.
14994      *          \h*
14995      *          \^?                         # possibly a correctly placed
14996      *                                      # caret, but not if there was also
14997      *                                      # a misplaced one
14998      *          \h*
14999      *          .{3,15}                     # The class name.  If there are
15000      *                                      # deviations from the legal syntax,
15001      *                                      # its edit distance must be close
15002      *                                      # to a real class name in order
15003      *                                      # for it to be considered to be
15004      *                                      # an intended posix class.
15005      *          \h*
15006      *          [[:punct:]]?                # The closing class character,
15007      *                                      # possibly omitted.  If not a colon
15008      *                                      # nor semi colon, the class name
15009      *                                      # must be even closer to a valid
15010      *                                      # one
15011      *          \h*
15012      *          \]?                         # The right bracket, possibly
15013      *                                      # omitted.
15014      *     )/
15015      *
15016      * In the above, \h must be ASCII-only.
15017      *
15018      * These are heuristics, and can be tweaked as field experience dictates.
15019      * There will be cases when someone didn't intend to specify a posix class
15020      * that this warns as being so.  The goal is to minimize these, while
15021      * maximizing the catching of things intended to be a posix class that
15022      * aren't parsed as such.
15023      */
15024
15025     const char* p             = s;
15026     const char * const e      = RExC_end;
15027     unsigned complement       = 0;      /* If to complement the class */
15028     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
15029     bool has_opening_bracket  = FALSE;
15030     bool has_opening_colon    = FALSE;
15031     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
15032                                                    valid class */
15033     const char * possible_end = NULL;   /* used for a 2nd parse pass */
15034     const char* name_start;             /* ptr to class name first char */
15035
15036     /* If the number of single-character typos the input name is away from a
15037      * legal name is no more than this number, it is considered to have meant
15038      * the legal name */
15039     int max_distance          = 2;
15040
15041     /* to store the name.  The size determines the maximum length before we
15042      * decide that no posix class was intended.  Should be at least
15043      * sizeof("alphanumeric") */
15044     UV input_text[15];
15045     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
15046
15047     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
15048
15049     CLEAR_POSIX_WARNINGS();
15050
15051     if (p >= e) {
15052         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
15053     }
15054
15055     if (*(p - 1) != '[') {
15056         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
15057         found_problem = TRUE;
15058     }
15059     else {
15060         has_opening_bracket = TRUE;
15061     }
15062
15063     /* They could be confused and think you can put spaces between the
15064      * components */
15065     if (isBLANK(*p)) {
15066         found_problem = TRUE;
15067
15068         do {
15069             p++;
15070         } while (p < e && isBLANK(*p));
15071
15072         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15073     }
15074
15075     /* For [. .] and [= =].  These are quite different internally from [: :],
15076      * so they are handled separately.  */
15077     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
15078                                             and 1 for at least one char in it
15079                                           */
15080     {
15081         const char open_char  = *p;
15082         const char * temp_ptr = p + 1;
15083
15084         /* These two constructs are not handled by perl, and if we find a
15085          * syntactically valid one, we croak.  khw, who wrote this code, finds
15086          * this explanation of them very unclear:
15087          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
15088          * And searching the rest of the internet wasn't very helpful either.
15089          * It looks like just about any byte can be in these constructs,
15090          * depending on the locale.  But unless the pattern is being compiled
15091          * under /l, which is very rare, Perl runs under the C or POSIX locale.
15092          * In that case, it looks like [= =] isn't allowed at all, and that
15093          * [. .] could be any single code point, but for longer strings the
15094          * constituent characters would have to be the ASCII alphabetics plus
15095          * the minus-hyphen.  Any sensible locale definition would limit itself
15096          * to these.  And any portable one definitely should.  Trying to parse
15097          * the general case is a nightmare (see [perl #127604]).  So, this code
15098          * looks only for interiors of these constructs that match:
15099          *      qr/.|[-\w]{2,}/
15100          * Using \w relaxes the apparent rules a little, without adding much
15101          * danger of mistaking something else for one of these constructs.
15102          *
15103          * [. .] in some implementations described on the internet is usable to
15104          * escape a character that otherwise is special in bracketed character
15105          * classes.  For example [.].] means a literal right bracket instead of
15106          * the ending of the class
15107          *
15108          * [= =] can legitimately contain a [. .] construct, but we don't
15109          * handle this case, as that [. .] construct will later get parsed
15110          * itself and croak then.  And [= =] is checked for even when not under
15111          * /l, as Perl has long done so.
15112          *
15113          * The code below relies on there being a trailing NUL, so it doesn't
15114          * have to keep checking if the parse ptr < e.
15115          */
15116         if (temp_ptr[1] == open_char) {
15117             temp_ptr++;
15118         }
15119         else while (    temp_ptr < e
15120                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
15121         {
15122             temp_ptr++;
15123         }
15124
15125         if (*temp_ptr == open_char) {
15126             temp_ptr++;
15127             if (*temp_ptr == ']') {
15128                 temp_ptr++;
15129                 if (! found_problem && ! check_only) {
15130                     RExC_parse = (char *) temp_ptr;
15131                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
15132                             "extensions", open_char, open_char);
15133                 }
15134
15135                 /* Here, the syntax wasn't completely valid, or else the call
15136                  * is to check-only */
15137                 if (updated_parse_ptr) {
15138                     *updated_parse_ptr = (char *) temp_ptr;
15139                 }
15140
15141                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
15142             }
15143         }
15144
15145         /* If we find something that started out to look like one of these
15146          * constructs, but isn't, we continue below so that it can be checked
15147          * for being a class name with a typo of '.' or '=' instead of a colon.
15148          * */
15149     }
15150
15151     /* Here, we think there is a possibility that a [: :] class was meant, and
15152      * we have the first real character.  It could be they think the '^' comes
15153      * first */
15154     if (*p == '^') {
15155         found_problem = TRUE;
15156         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
15157         complement = 1;
15158         p++;
15159
15160         if (isBLANK(*p)) {
15161             found_problem = TRUE;
15162
15163             do {
15164                 p++;
15165             } while (p < e && isBLANK(*p));
15166
15167             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15168         }
15169     }
15170
15171     /* But the first character should be a colon, which they could have easily
15172      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
15173      * distinguish from a colon, so treat that as a colon).  */
15174     if (*p == ':') {
15175         p++;
15176         has_opening_colon = TRUE;
15177     }
15178     else if (*p == ';') {
15179         found_problem = TRUE;
15180         p++;
15181         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15182         has_opening_colon = TRUE;
15183     }
15184     else {
15185         found_problem = TRUE;
15186         ADD_POSIX_WARNING(p, "there must be a starting ':'");
15187
15188         /* Consider an initial punctuation (not one of the recognized ones) to
15189          * be a left terminator */
15190         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
15191             p++;
15192         }
15193     }
15194
15195     /* They may think that you can put spaces between the components */
15196     if (isBLANK(*p)) {
15197         found_problem = TRUE;
15198
15199         do {
15200             p++;
15201         } while (p < e && isBLANK(*p));
15202
15203         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15204     }
15205
15206     if (*p == '^') {
15207
15208         /* We consider something like [^:^alnum:]] to not have been intended to
15209          * be a posix class, but XXX maybe we should */
15210         if (complement) {
15211             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15212         }
15213
15214         complement = 1;
15215         p++;
15216     }
15217
15218     /* Again, they may think that you can put spaces between the components */
15219     if (isBLANK(*p)) {
15220         found_problem = TRUE;
15221
15222         do {
15223             p++;
15224         } while (p < e && isBLANK(*p));
15225
15226         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15227     }
15228
15229     if (*p == ']') {
15230
15231         /* XXX This ']' may be a typo, and something else was meant.  But
15232          * treating it as such creates enough complications, that that
15233          * possibility isn't currently considered here.  So we assume that the
15234          * ']' is what is intended, and if we've already found an initial '[',
15235          * this leaves this construct looking like [:] or [:^], which almost
15236          * certainly weren't intended to be posix classes */
15237         if (has_opening_bracket) {
15238             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15239         }
15240
15241         /* But this function can be called when we parse the colon for
15242          * something like qr/[alpha:]]/, so we back up to look for the
15243          * beginning */
15244         p--;
15245
15246         if (*p == ';') {
15247             found_problem = TRUE;
15248             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15249         }
15250         else if (*p != ':') {
15251
15252             /* XXX We are currently very restrictive here, so this code doesn't
15253              * consider the possibility that, say, /[alpha.]]/ was intended to
15254              * be a posix class. */
15255             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15256         }
15257
15258         /* Here we have something like 'foo:]'.  There was no initial colon,
15259          * and we back up over 'foo.  XXX Unlike the going forward case, we
15260          * don't handle typos of non-word chars in the middle */
15261         has_opening_colon = FALSE;
15262         p--;
15263
15264         while (p > RExC_start && isWORDCHAR(*p)) {
15265             p--;
15266         }
15267         p++;
15268
15269         /* Here, we have positioned ourselves to where we think the first
15270          * character in the potential class is */
15271     }
15272
15273     /* Now the interior really starts.  There are certain key characters that
15274      * can end the interior, or these could just be typos.  To catch both
15275      * cases, we may have to do two passes.  In the first pass, we keep on
15276      * going unless we come to a sequence that matches
15277      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
15278      * This means it takes a sequence to end the pass, so two typos in a row if
15279      * that wasn't what was intended.  If the class is perfectly formed, just
15280      * this one pass is needed.  We also stop if there are too many characters
15281      * being accumulated, but this number is deliberately set higher than any
15282      * real class.  It is set high enough so that someone who thinks that
15283      * 'alphanumeric' is a correct name would get warned that it wasn't.
15284      * While doing the pass, we keep track of where the key characters were in
15285      * it.  If we don't find an end to the class, and one of the key characters
15286      * was found, we redo the pass, but stop when we get to that character.
15287      * Thus the key character was considered a typo in the first pass, but a
15288      * terminator in the second.  If two key characters are found, we stop at
15289      * the second one in the first pass.  Again this can miss two typos, but
15290      * catches a single one
15291      *
15292      * In the first pass, 'possible_end' starts as NULL, and then gets set to
15293      * point to the first key character.  For the second pass, it starts as -1.
15294      * */
15295
15296     name_start = p;
15297   parse_name:
15298     {
15299         bool has_blank               = FALSE;
15300         bool has_upper               = FALSE;
15301         bool has_terminating_colon   = FALSE;
15302         bool has_terminating_bracket = FALSE;
15303         bool has_semi_colon          = FALSE;
15304         unsigned int name_len        = 0;
15305         int punct_count              = 0;
15306
15307         while (p < e) {
15308
15309             /* Squeeze out blanks when looking up the class name below */
15310             if (isBLANK(*p) ) {
15311                 has_blank = TRUE;
15312                 found_problem = TRUE;
15313                 p++;
15314                 continue;
15315             }
15316
15317             /* The name will end with a punctuation */
15318             if (isPUNCT(*p)) {
15319                 const char * peek = p + 1;
15320
15321                 /* Treat any non-']' punctuation followed by a ']' (possibly
15322                  * with intervening blanks) as trying to terminate the class.
15323                  * ']]' is very likely to mean a class was intended (but
15324                  * missing the colon), but the warning message that gets
15325                  * generated shows the error position better if we exit the
15326                  * loop at the bottom (eventually), so skip it here. */
15327                 if (*p != ']') {
15328                     if (peek < e && isBLANK(*peek)) {
15329                         has_blank = TRUE;
15330                         found_problem = TRUE;
15331                         do {
15332                             peek++;
15333                         } while (peek < e && isBLANK(*peek));
15334                     }
15335
15336                     if (peek < e && *peek == ']') {
15337                         has_terminating_bracket = TRUE;
15338                         if (*p == ':') {
15339                             has_terminating_colon = TRUE;
15340                         }
15341                         else if (*p == ';') {
15342                             has_semi_colon = TRUE;
15343                             has_terminating_colon = TRUE;
15344                         }
15345                         else {
15346                             found_problem = TRUE;
15347                         }
15348                         p = peek + 1;
15349                         goto try_posix;
15350                     }
15351                 }
15352
15353                 /* Here we have punctuation we thought didn't end the class.
15354                  * Keep track of the position of the key characters that are
15355                  * more likely to have been class-enders */
15356                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
15357
15358                     /* Allow just one such possible class-ender not actually
15359                      * ending the class. */
15360                     if (possible_end) {
15361                         break;
15362                     }
15363                     possible_end = p;
15364                 }
15365
15366                 /* If we have too many punctuation characters, no use in
15367                  * keeping going */
15368                 if (++punct_count > max_distance) {
15369                     break;
15370                 }
15371
15372                 /* Treat the punctuation as a typo. */
15373                 input_text[name_len++] = *p;
15374                 p++;
15375             }
15376             else if (isUPPER(*p)) { /* Use lowercase for lookup */
15377                 input_text[name_len++] = toLOWER(*p);
15378                 has_upper = TRUE;
15379                 found_problem = TRUE;
15380                 p++;
15381             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
15382                 input_text[name_len++] = *p;
15383                 p++;
15384             }
15385             else {
15386                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
15387                 p+= UTF8SKIP(p);
15388             }
15389
15390             /* The declaration of 'input_text' is how long we allow a potential
15391              * class name to be, before saying they didn't mean a class name at
15392              * all */
15393             if (name_len >= C_ARRAY_LENGTH(input_text)) {
15394                 break;
15395             }
15396         }
15397
15398         /* We get to here when the possible class name hasn't been properly
15399          * terminated before:
15400          *   1) we ran off the end of the pattern; or
15401          *   2) found two characters, each of which might have been intended to
15402          *      be the name's terminator
15403          *   3) found so many punctuation characters in the purported name,
15404          *      that the edit distance to a valid one is exceeded
15405          *   4) we decided it was more characters than anyone could have
15406          *      intended to be one. */
15407
15408         found_problem = TRUE;
15409
15410         /* In the final two cases, we know that looking up what we've
15411          * accumulated won't lead to a match, even a fuzzy one. */
15412         if (   name_len >= C_ARRAY_LENGTH(input_text)
15413             || punct_count > max_distance)
15414         {
15415             /* If there was an intermediate key character that could have been
15416              * an intended end, redo the parse, but stop there */
15417             if (possible_end && possible_end != (char *) -1) {
15418                 possible_end = (char *) -1; /* Special signal value to say
15419                                                we've done a first pass */
15420                 p = name_start;
15421                 goto parse_name;
15422             }
15423
15424             /* Otherwise, it can't have meant to have been a class */
15425             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15426         }
15427
15428         /* If we ran off the end, and the final character was a punctuation
15429          * one, back up one, to look at that final one just below.  Later, we
15430          * will restore the parse pointer if appropriate */
15431         if (name_len && p == e && isPUNCT(*(p-1))) {
15432             p--;
15433             name_len--;
15434         }
15435
15436         if (p < e && isPUNCT(*p)) {
15437             if (*p == ']') {
15438                 has_terminating_bracket = TRUE;
15439
15440                 /* If this is a 2nd ']', and the first one is just below this
15441                  * one, consider that to be the real terminator.  This gives a
15442                  * uniform and better positioning for the warning message  */
15443                 if (   possible_end
15444                     && possible_end != (char *) -1
15445                     && *possible_end == ']'
15446                     && name_len && input_text[name_len - 1] == ']')
15447                 {
15448                     name_len--;
15449                     p = possible_end;
15450
15451                     /* And this is actually equivalent to having done the 2nd
15452                      * pass now, so set it to not try again */
15453                     possible_end = (char *) -1;
15454                 }
15455             }
15456             else {
15457                 if (*p == ':') {
15458                     has_terminating_colon = TRUE;
15459                 }
15460                 else if (*p == ';') {
15461                     has_semi_colon = TRUE;
15462                     has_terminating_colon = TRUE;
15463                 }
15464                 p++;
15465             }
15466         }
15467
15468     try_posix:
15469
15470         /* Here, we have a class name to look up.  We can short circuit the
15471          * stuff below for short names that can't possibly be meant to be a
15472          * class name.  (We can do this on the first pass, as any second pass
15473          * will yield an even shorter name) */
15474         if (name_len < 3) {
15475             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15476         }
15477
15478         /* Find which class it is.  Initially switch on the length of the name.
15479          * */
15480         switch (name_len) {
15481             case 4:
15482                 if (memEQs(name_start, 4, "word")) {
15483                     /* this is not POSIX, this is the Perl \w */
15484                     class_number = ANYOF_WORDCHAR;
15485                 }
15486                 break;
15487             case 5:
15488                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
15489                  *                        graph lower print punct space upper
15490                  * Offset 4 gives the best switch position.  */
15491                 switch (name_start[4]) {
15492                     case 'a':
15493                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
15494                             class_number = ANYOF_ALPHA;
15495                         break;
15496                     case 'e':
15497                         if (memBEGINs(name_start, 5, "spac")) /* space */
15498                             class_number = ANYOF_SPACE;
15499                         break;
15500                     case 'h':
15501                         if (memBEGINs(name_start, 5, "grap")) /* graph */
15502                             class_number = ANYOF_GRAPH;
15503                         break;
15504                     case 'i':
15505                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
15506                             class_number = ANYOF_ASCII;
15507                         break;
15508                     case 'k':
15509                         if (memBEGINs(name_start, 5, "blan")) /* blank */
15510                             class_number = ANYOF_BLANK;
15511                         break;
15512                     case 'l':
15513                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
15514                             class_number = ANYOF_CNTRL;
15515                         break;
15516                     case 'm':
15517                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
15518                             class_number = ANYOF_ALPHANUMERIC;
15519                         break;
15520                     case 'r':
15521                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
15522                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
15523                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
15524                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
15525                         break;
15526                     case 't':
15527                         if (memBEGINs(name_start, 5, "digi")) /* digit */
15528                             class_number = ANYOF_DIGIT;
15529                         else if (memBEGINs(name_start, 5, "prin")) /* print */
15530                             class_number = ANYOF_PRINT;
15531                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
15532                             class_number = ANYOF_PUNCT;
15533                         break;
15534                 }
15535                 break;
15536             case 6:
15537                 if (memEQs(name_start, 6, "xdigit"))
15538                     class_number = ANYOF_XDIGIT;
15539                 break;
15540         }
15541
15542         /* If the name exactly matches a posix class name the class number will
15543          * here be set to it, and the input almost certainly was meant to be a
15544          * posix class, so we can skip further checking.  If instead the syntax
15545          * is exactly correct, but the name isn't one of the legal ones, we
15546          * will return that as an error below.  But if neither of these apply,
15547          * it could be that no posix class was intended at all, or that one
15548          * was, but there was a typo.  We tease these apart by doing fuzzy
15549          * matching on the name */
15550         if (class_number == OOB_NAMEDCLASS && found_problem) {
15551             const UV posix_names[][6] = {
15552                                                 { 'a', 'l', 'n', 'u', 'm' },
15553                                                 { 'a', 'l', 'p', 'h', 'a' },
15554                                                 { 'a', 's', 'c', 'i', 'i' },
15555                                                 { 'b', 'l', 'a', 'n', 'k' },
15556                                                 { 'c', 'n', 't', 'r', 'l' },
15557                                                 { 'd', 'i', 'g', 'i', 't' },
15558                                                 { 'g', 'r', 'a', 'p', 'h' },
15559                                                 { 'l', 'o', 'w', 'e', 'r' },
15560                                                 { 'p', 'r', 'i', 'n', 't' },
15561                                                 { 'p', 'u', 'n', 'c', 't' },
15562                                                 { 's', 'p', 'a', 'c', 'e' },
15563                                                 { 'u', 'p', 'p', 'e', 'r' },
15564                                                 { 'w', 'o', 'r', 'd' },
15565                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
15566                                             };
15567             /* The names of the above all have added NULs to make them the same
15568              * size, so we need to also have the real lengths */
15569             const UV posix_name_lengths[] = {
15570                                                 sizeof("alnum") - 1,
15571                                                 sizeof("alpha") - 1,
15572                                                 sizeof("ascii") - 1,
15573                                                 sizeof("blank") - 1,
15574                                                 sizeof("cntrl") - 1,
15575                                                 sizeof("digit") - 1,
15576                                                 sizeof("graph") - 1,
15577                                                 sizeof("lower") - 1,
15578                                                 sizeof("print") - 1,
15579                                                 sizeof("punct") - 1,
15580                                                 sizeof("space") - 1,
15581                                                 sizeof("upper") - 1,
15582                                                 sizeof("word")  - 1,
15583                                                 sizeof("xdigit")- 1
15584                                             };
15585             unsigned int i;
15586             int temp_max = max_distance;    /* Use a temporary, so if we
15587                                                reparse, we haven't changed the
15588                                                outer one */
15589
15590             /* Use a smaller max edit distance if we are missing one of the
15591              * delimiters */
15592             if (   has_opening_bracket + has_opening_colon < 2
15593                 || has_terminating_bracket + has_terminating_colon < 2)
15594             {
15595                 temp_max--;
15596             }
15597
15598             /* See if the input name is close to a legal one */
15599             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
15600
15601                 /* Short circuit call if the lengths are too far apart to be
15602                  * able to match */
15603                 if (abs( (int) (name_len - posix_name_lengths[i]))
15604                     > temp_max)
15605                 {
15606                     continue;
15607                 }
15608
15609                 if (edit_distance(input_text,
15610                                   posix_names[i],
15611                                   name_len,
15612                                   posix_name_lengths[i],
15613                                   temp_max
15614                                  )
15615                     > -1)
15616                 { /* If it is close, it probably was intended to be a class */
15617                     goto probably_meant_to_be;
15618                 }
15619             }
15620
15621             /* Here the input name is not close enough to a valid class name
15622              * for us to consider it to be intended to be a posix class.  If
15623              * we haven't already done so, and the parse found a character that
15624              * could have been terminators for the name, but which we absorbed
15625              * as typos during the first pass, repeat the parse, signalling it
15626              * to stop at that character */
15627             if (possible_end && possible_end != (char *) -1) {
15628                 possible_end = (char *) -1;
15629                 p = name_start;
15630                 goto parse_name;
15631             }
15632
15633             /* Here neither pass found a close-enough class name */
15634             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15635         }
15636
15637     probably_meant_to_be:
15638
15639         /* Here we think that a posix specification was intended.  Update any
15640          * parse pointer */
15641         if (updated_parse_ptr) {
15642             *updated_parse_ptr = (char *) p;
15643         }
15644
15645         /* If a posix class name was intended but incorrectly specified, we
15646          * output or return the warnings */
15647         if (found_problem) {
15648
15649             /* We set flags for these issues in the parse loop above instead of
15650              * adding them to the list of warnings, because we can parse it
15651              * twice, and we only want one warning instance */
15652             if (has_upper) {
15653                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
15654             }
15655             if (has_blank) {
15656                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15657             }
15658             if (has_semi_colon) {
15659                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15660             }
15661             else if (! has_terminating_colon) {
15662                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
15663             }
15664             if (! has_terminating_bracket) {
15665                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
15666             }
15667
15668             if (   posix_warnings
15669                 && RExC_warn_text
15670                 && av_top_index(RExC_warn_text) > -1)
15671             {
15672                 *posix_warnings = RExC_warn_text;
15673             }
15674         }
15675         else if (class_number != OOB_NAMEDCLASS) {
15676             /* If it is a known class, return the class.  The class number
15677              * #defines are structured so each complement is +1 to the normal
15678              * one */
15679             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
15680         }
15681         else if (! check_only) {
15682
15683             /* Here, it is an unrecognized class.  This is an error (unless the
15684             * call is to check only, which we've already handled above) */
15685             const char * const complement_string = (complement)
15686                                                    ? "^"
15687                                                    : "";
15688             RExC_parse = (char *) p;
15689             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
15690                         complement_string,
15691                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
15692         }
15693     }
15694
15695     return OOB_NAMEDCLASS;
15696 }
15697 #undef ADD_POSIX_WARNING
15698
15699 STATIC unsigned  int
15700 S_regex_set_precedence(const U8 my_operator) {
15701
15702     /* Returns the precedence in the (?[...]) construct of the input operator,
15703      * specified by its character representation.  The precedence follows
15704      * general Perl rules, but it extends this so that ')' and ']' have (low)
15705      * precedence even though they aren't really operators */
15706
15707     switch (my_operator) {
15708         case '!':
15709             return 5;
15710         case '&':
15711             return 4;
15712         case '^':
15713         case '|':
15714         case '+':
15715         case '-':
15716             return 3;
15717         case ')':
15718             return 2;
15719         case ']':
15720             return 1;
15721     }
15722
15723     NOT_REACHED; /* NOTREACHED */
15724     return 0;   /* Silence compiler warning */
15725 }
15726
15727 STATIC regnode_offset
15728 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
15729                     I32 *flagp, U32 depth,
15730                     char * const oregcomp_parse)
15731 {
15732     /* Handle the (?[...]) construct to do set operations */
15733
15734     U8 curchar;                     /* Current character being parsed */
15735     UV start, end;                  /* End points of code point ranges */
15736     SV* final = NULL;               /* The end result inversion list */
15737     SV* result_string;              /* 'final' stringified */
15738     AV* stack;                      /* stack of operators and operands not yet
15739                                        resolved */
15740     AV* fence_stack = NULL;         /* A stack containing the positions in
15741                                        'stack' of where the undealt-with left
15742                                        parens would be if they were actually
15743                                        put there */
15744     /* The 'volatile' is a workaround for an optimiser bug
15745      * in Solaris Studio 12.3. See RT #127455 */
15746     volatile IV fence = 0;          /* Position of where most recent undealt-
15747                                        with left paren in stack is; -1 if none.
15748                                      */
15749     STRLEN len;                     /* Temporary */
15750     regnode_offset node;                  /* Temporary, and final regnode returned by
15751                                        this function */
15752     const bool save_fold = FOLD;    /* Temporary */
15753     char *save_end, *save_parse;    /* Temporaries */
15754     const bool in_locale = LOC;     /* we turn off /l during processing */
15755
15756     GET_RE_DEBUG_FLAGS_DECL;
15757
15758     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
15759
15760     DEBUG_PARSE("xcls");
15761
15762     if (in_locale) {
15763         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
15764     }
15765
15766     /* The use of this operator implies /u.  This is required so that the
15767      * compile time values are valid in all runtime cases */
15768     REQUIRE_UNI_RULES(flagp, 0);
15769
15770     ckWARNexperimental(RExC_parse,
15771                        WARN_EXPERIMENTAL__REGEX_SETS,
15772                        "The regex_sets feature is experimental");
15773
15774     /* Everything in this construct is a metacharacter.  Operands begin with
15775      * either a '\' (for an escape sequence), or a '[' for a bracketed
15776      * character class.  Any other character should be an operator, or
15777      * parenthesis for grouping.  Both types of operands are handled by calling
15778      * regclass() to parse them.  It is called with a parameter to indicate to
15779      * return the computed inversion list.  The parsing here is implemented via
15780      * a stack.  Each entry on the stack is a single character representing one
15781      * of the operators; or else a pointer to an operand inversion list. */
15782
15783 #define IS_OPERATOR(a) SvIOK(a)
15784 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
15785
15786     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
15787      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
15788      * with pronouncing it called it Reverse Polish instead, but now that YOU
15789      * know how to pronounce it you can use the correct term, thus giving due
15790      * credit to the person who invented it, and impressing your geek friends.
15791      * Wikipedia says that the pronounciation of "Ł" has been changing so that
15792      * it is now more like an English initial W (as in wonk) than an L.)
15793      *
15794      * This means that, for example, 'a | b & c' is stored on the stack as
15795      *
15796      * c  [4]
15797      * b  [3]
15798      * &  [2]
15799      * a  [1]
15800      * |  [0]
15801      *
15802      * where the numbers in brackets give the stack [array] element number.
15803      * In this implementation, parentheses are not stored on the stack.
15804      * Instead a '(' creates a "fence" so that the part of the stack below the
15805      * fence is invisible except to the corresponding ')' (this allows us to
15806      * replace testing for parens, by using instead subtraction of the fence
15807      * position).  As new operands are processed they are pushed onto the stack
15808      * (except as noted in the next paragraph).  New operators of higher
15809      * precedence than the current final one are inserted on the stack before
15810      * the lhs operand (so that when the rhs is pushed next, everything will be
15811      * in the correct positions shown above.  When an operator of equal or
15812      * lower precedence is encountered in parsing, all the stacked operations
15813      * of equal or higher precedence are evaluated, leaving the result as the
15814      * top entry on the stack.  This makes higher precedence operations
15815      * evaluate before lower precedence ones, and causes operations of equal
15816      * precedence to left associate.
15817      *
15818      * The only unary operator '!' is immediately pushed onto the stack when
15819      * encountered.  When an operand is encountered, if the top of the stack is
15820      * a '!", the complement is immediately performed, and the '!' popped.  The
15821      * resulting value is treated as a new operand, and the logic in the
15822      * previous paragraph is executed.  Thus in the expression
15823      *      [a] + ! [b]
15824      * the stack looks like
15825      *
15826      * !
15827      * a
15828      * +
15829      *
15830      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
15831      * becomes
15832      *
15833      * !b
15834      * a
15835      * +
15836      *
15837      * A ')' is treated as an operator with lower precedence than all the
15838      * aforementioned ones, which causes all operations on the stack above the
15839      * corresponding '(' to be evaluated down to a single resultant operand.
15840      * Then the fence for the '(' is removed, and the operand goes through the
15841      * algorithm above, without the fence.
15842      *
15843      * A separate stack is kept of the fence positions, so that the position of
15844      * the latest so-far unbalanced '(' is at the top of it.
15845      *
15846      * The ']' ending the construct is treated as the lowest operator of all,
15847      * so that everything gets evaluated down to a single operand, which is the
15848      * result */
15849
15850     sv_2mortal((SV *)(stack = newAV()));
15851     sv_2mortal((SV *)(fence_stack = newAV()));
15852
15853     while (RExC_parse < RExC_end) {
15854         I32 top_index;              /* Index of top-most element in 'stack' */
15855         SV** top_ptr;               /* Pointer to top 'stack' element */
15856         SV* current = NULL;         /* To contain the current inversion list
15857                                        operand */
15858         SV* only_to_avoid_leaks;
15859
15860         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15861                                 TRUE /* Force /x */ );
15862         if (RExC_parse >= RExC_end) {   /* Fail */
15863             break;
15864         }
15865
15866         curchar = UCHARAT(RExC_parse);
15867
15868 redo_curchar:
15869
15870 #ifdef ENABLE_REGEX_SETS_DEBUGGING
15871                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
15872         DEBUG_U(dump_regex_sets_structures(pRExC_state,
15873                                            stack, fence, fence_stack));
15874 #endif
15875
15876         top_index = av_tindex_skip_len_mg(stack);
15877
15878         switch (curchar) {
15879             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
15880             char stacked_operator;  /* The topmost operator on the 'stack'. */
15881             SV* lhs;                /* Operand to the left of the operator */
15882             SV* rhs;                /* Operand to the right of the operator */
15883             SV* fence_ptr;          /* Pointer to top element of the fence
15884                                        stack */
15885
15886             case '(':
15887
15888                 if (   RExC_parse < RExC_end - 2
15889                     && UCHARAT(RExC_parse + 1) == '?'
15890                     && UCHARAT(RExC_parse + 2) == '^')
15891                 {
15892                     /* If is a '(?', could be an embedded '(?^flags:(?[...])'.
15893                      * This happens when we have some thing like
15894                      *
15895                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
15896                      *   ...
15897                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
15898                      *
15899                      * Here we would be handling the interpolated
15900                      * '$thai_or_lao'.  We handle this by a recursive call to
15901                      * ourselves which returns the inversion list the
15902                      * interpolated expression evaluates to.  We use the flags
15903                      * from the interpolated pattern. */
15904                     U32 save_flags = RExC_flags;
15905                     const char * save_parse;
15906
15907                     RExC_parse += 2;        /* Skip past the '(?' */
15908                     save_parse = RExC_parse;
15909
15910                     /* Parse the flags for the '(?'.  We already know the first
15911                      * flag to parse is a '^' */
15912                     parse_lparen_question_flags(pRExC_state);
15913
15914                     if (   RExC_parse >= RExC_end - 4
15915                         || UCHARAT(RExC_parse) != ':'
15916                         || UCHARAT(++RExC_parse) != '('
15917                         || UCHARAT(++RExC_parse) != '?'
15918                         || UCHARAT(++RExC_parse) != '[')
15919                     {
15920
15921                         /* In combination with the above, this moves the
15922                          * pointer to the point just after the first erroneous
15923                          * character. */
15924                         if (RExC_parse >= RExC_end - 4) {
15925                             RExC_parse = RExC_end;
15926                         }
15927                         else if (RExC_parse != save_parse) {
15928                             RExC_parse += (UTF)
15929                                           ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
15930                                           : 1;
15931                         }
15932                         vFAIL("Expecting '(?flags:(?[...'");
15933                     }
15934
15935                     /* Recurse, with the meat of the embedded expression */
15936                     RExC_parse++;
15937                     (void) handle_regex_sets(pRExC_state, &current, flagp,
15938                                                     depth+1, oregcomp_parse);
15939
15940                     /* Here, 'current' contains the embedded expression's
15941                      * inversion list, and RExC_parse points to the trailing
15942                      * ']'; the next character should be the ')' */
15943                     RExC_parse++;
15944                     if (UCHARAT(RExC_parse) != ')')
15945                         vFAIL("Expecting close paren for nested extended charclass");
15946
15947                     /* Then the ')' matching the original '(' handled by this
15948                      * case: statement */
15949                     RExC_parse++;
15950                     if (UCHARAT(RExC_parse) != ')')
15951                         vFAIL("Expecting close paren for wrapper for nested extended charclass");
15952
15953                     RExC_flags = save_flags;
15954                     goto handle_operand;
15955                 }
15956
15957                 /* A regular '('.  Look behind for illegal syntax */
15958                 if (top_index - fence >= 0) {
15959                     /* If the top entry on the stack is an operator, it had
15960                      * better be a '!', otherwise the entry below the top
15961                      * operand should be an operator */
15962                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
15963                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
15964                         || (   IS_OPERAND(*top_ptr)
15965                             && (   top_index - fence < 1
15966                                 || ! (stacked_ptr = av_fetch(stack,
15967                                                              top_index - 1,
15968                                                              FALSE))
15969                                 || ! IS_OPERATOR(*stacked_ptr))))
15970                     {
15971                         RExC_parse++;
15972                         vFAIL("Unexpected '(' with no preceding operator");
15973                     }
15974                 }
15975
15976                 /* Stack the position of this undealt-with left paren */
15977                 av_push(fence_stack, newSViv(fence));
15978                 fence = top_index + 1;
15979                 break;
15980
15981             case '\\':
15982                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
15983                  * multi-char folds are allowed.  */
15984                 if (!regclass(pRExC_state, flagp, depth+1,
15985                               TRUE, /* means parse just the next thing */
15986                               FALSE, /* don't allow multi-char folds */
15987                               FALSE, /* don't silence non-portable warnings.  */
15988                               TRUE,  /* strict */
15989                               FALSE, /* Require return to be an ANYOF */
15990                               &current))
15991                 {
15992                     goto regclass_failed;
15993                 }
15994
15995                 /* regclass() will return with parsing just the \ sequence,
15996                  * leaving the parse pointer at the next thing to parse */
15997                 RExC_parse--;
15998                 goto handle_operand;
15999
16000             case '[':   /* Is a bracketed character class */
16001             {
16002                 /* See if this is a [:posix:] class. */
16003                 bool is_posix_class = (OOB_NAMEDCLASS
16004                             < handle_possible_posix(pRExC_state,
16005                                                 RExC_parse + 1,
16006                                                 NULL,
16007                                                 NULL,
16008                                                 TRUE /* checking only */));
16009                 /* If it is a posix class, leave the parse pointer at the '['
16010                  * to fool regclass() into thinking it is part of a
16011                  * '[[:posix:]]'. */
16012                 if (! is_posix_class) {
16013                     RExC_parse++;
16014                 }
16015
16016                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
16017                  * multi-char folds are allowed.  */
16018                 if (!regclass(pRExC_state, flagp, depth+1,
16019                                 is_posix_class, /* parse the whole char
16020                                                     class only if not a
16021                                                     posix class */
16022                                 FALSE, /* don't allow multi-char folds */
16023                                 TRUE, /* silence non-portable warnings. */
16024                                 TRUE, /* strict */
16025                                 FALSE, /* Require return to be an ANYOF */
16026                                 &current))
16027                 {
16028                     goto regclass_failed;
16029                 }
16030
16031                 if (! current) {
16032                     break;
16033                 }
16034
16035                 /* function call leaves parse pointing to the ']', except if we
16036                  * faked it */
16037                 if (is_posix_class) {
16038                     RExC_parse--;
16039                 }
16040
16041                 goto handle_operand;
16042             }
16043
16044             case ']':
16045                 if (top_index >= 1) {
16046                     goto join_operators;
16047                 }
16048
16049                 /* Only a single operand on the stack: are done */
16050                 goto done;
16051
16052             case ')':
16053                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
16054                     if (UCHARAT(RExC_parse - 1) == ']')  {
16055                         break;
16056                     }
16057                     RExC_parse++;
16058                     vFAIL("Unexpected ')'");
16059                 }
16060
16061                 /* If nothing after the fence, is missing an operand */
16062                 if (top_index - fence < 0) {
16063                     RExC_parse++;
16064                     goto bad_syntax;
16065                 }
16066                 /* If at least two things on the stack, treat this as an
16067                   * operator */
16068                 if (top_index - fence >= 1) {
16069                     goto join_operators;
16070                 }
16071
16072                 /* Here only a single thing on the fenced stack, and there is a
16073                  * fence.  Get rid of it */
16074                 fence_ptr = av_pop(fence_stack);
16075                 assert(fence_ptr);
16076                 fence = SvIV(fence_ptr);
16077                 SvREFCNT_dec_NN(fence_ptr);
16078                 fence_ptr = NULL;
16079
16080                 if (fence < 0) {
16081                     fence = 0;
16082                 }
16083
16084                 /* Having gotten rid of the fence, we pop the operand at the
16085                  * stack top and process it as a newly encountered operand */
16086                 current = av_pop(stack);
16087                 if (IS_OPERAND(current)) {
16088                     goto handle_operand;
16089                 }
16090
16091                 RExC_parse++;
16092                 goto bad_syntax;
16093
16094             case '&':
16095             case '|':
16096             case '+':
16097             case '-':
16098             case '^':
16099
16100                 /* These binary operators should have a left operand already
16101                  * parsed */
16102                 if (   top_index - fence < 0
16103                     || top_index - fence == 1
16104                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
16105                     || ! IS_OPERAND(*top_ptr))
16106                 {
16107                     goto unexpected_binary;
16108                 }
16109
16110                 /* If only the one operand is on the part of the stack visible
16111                  * to us, we just place this operator in the proper position */
16112                 if (top_index - fence < 2) {
16113
16114                     /* Place the operator before the operand */
16115
16116                     SV* lhs = av_pop(stack);
16117                     av_push(stack, newSVuv(curchar));
16118                     av_push(stack, lhs);
16119                     break;
16120                 }
16121
16122                 /* But if there is something else on the stack, we need to
16123                  * process it before this new operator if and only if the
16124                  * stacked operation has equal or higher precedence than the
16125                  * new one */
16126
16127              join_operators:
16128
16129                 /* The operator on the stack is supposed to be below both its
16130                  * operands */
16131                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
16132                     || IS_OPERAND(*stacked_ptr))
16133                 {
16134                     /* But if not, it's legal and indicates we are completely
16135                      * done if and only if we're currently processing a ']',
16136                      * which should be the final thing in the expression */
16137                     if (curchar == ']') {
16138                         goto done;
16139                     }
16140
16141                   unexpected_binary:
16142                     RExC_parse++;
16143                     vFAIL2("Unexpected binary operator '%c' with no "
16144                            "preceding operand", curchar);
16145                 }
16146                 stacked_operator = (char) SvUV(*stacked_ptr);
16147
16148                 if (regex_set_precedence(curchar)
16149                     > regex_set_precedence(stacked_operator))
16150                 {
16151                     /* Here, the new operator has higher precedence than the
16152                      * stacked one.  This means we need to add the new one to
16153                      * the stack to await its rhs operand (and maybe more
16154                      * stuff).  We put it before the lhs operand, leaving
16155                      * untouched the stacked operator and everything below it
16156                      * */
16157                     lhs = av_pop(stack);
16158                     assert(IS_OPERAND(lhs));
16159
16160                     av_push(stack, newSVuv(curchar));
16161                     av_push(stack, lhs);
16162                     break;
16163                 }
16164
16165                 /* Here, the new operator has equal or lower precedence than
16166                  * what's already there.  This means the operation already
16167                  * there should be performed now, before the new one. */
16168
16169                 rhs = av_pop(stack);
16170                 if (! IS_OPERAND(rhs)) {
16171
16172                     /* This can happen when a ! is not followed by an operand,
16173                      * like in /(?[\t &!])/ */
16174                     goto bad_syntax;
16175                 }
16176
16177                 lhs = av_pop(stack);
16178
16179                 if (! IS_OPERAND(lhs)) {
16180
16181                     /* This can happen when there is an empty (), like in
16182                      * /(?[[0]+()+])/ */
16183                     goto bad_syntax;
16184                 }
16185
16186                 switch (stacked_operator) {
16187                     case '&':
16188                         _invlist_intersection(lhs, rhs, &rhs);
16189                         break;
16190
16191                     case '|':
16192                     case '+':
16193                         _invlist_union(lhs, rhs, &rhs);
16194                         break;
16195
16196                     case '-':
16197                         _invlist_subtract(lhs, rhs, &rhs);
16198                         break;
16199
16200                     case '^':   /* The union minus the intersection */
16201                     {
16202                         SV* i = NULL;
16203                         SV* u = NULL;
16204
16205                         _invlist_union(lhs, rhs, &u);
16206                         _invlist_intersection(lhs, rhs, &i);
16207                         _invlist_subtract(u, i, &rhs);
16208                         SvREFCNT_dec_NN(i);
16209                         SvREFCNT_dec_NN(u);
16210                         break;
16211                     }
16212                 }
16213                 SvREFCNT_dec(lhs);
16214
16215                 /* Here, the higher precedence operation has been done, and the
16216                  * result is in 'rhs'.  We overwrite the stacked operator with
16217                  * the result.  Then we redo this code to either push the new
16218                  * operator onto the stack or perform any higher precedence
16219                  * stacked operation */
16220                 only_to_avoid_leaks = av_pop(stack);
16221                 SvREFCNT_dec(only_to_avoid_leaks);
16222                 av_push(stack, rhs);
16223                 goto redo_curchar;
16224
16225             case '!':   /* Highest priority, right associative */
16226
16227                 /* If what's already at the top of the stack is another '!",
16228                  * they just cancel each other out */
16229                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
16230                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
16231                 {
16232                     only_to_avoid_leaks = av_pop(stack);
16233                     SvREFCNT_dec(only_to_avoid_leaks);
16234                 }
16235                 else { /* Otherwise, since it's right associative, just push
16236                           onto the stack */
16237                     av_push(stack, newSVuv(curchar));
16238                 }
16239                 break;
16240
16241             default:
16242                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16243                 if (RExC_parse >= RExC_end) {
16244                     break;
16245                 }
16246                 vFAIL("Unexpected character");
16247
16248           handle_operand:
16249
16250             /* Here 'current' is the operand.  If something is already on the
16251              * stack, we have to check if it is a !.  But first, the code above
16252              * may have altered the stack in the time since we earlier set
16253              * 'top_index'.  */
16254
16255             top_index = av_tindex_skip_len_mg(stack);
16256             if (top_index - fence >= 0) {
16257                 /* If the top entry on the stack is an operator, it had better
16258                  * be a '!', otherwise the entry below the top operand should
16259                  * be an operator */
16260                 top_ptr = av_fetch(stack, top_index, FALSE);
16261                 assert(top_ptr);
16262                 if (IS_OPERATOR(*top_ptr)) {
16263
16264                     /* The only permissible operator at the top of the stack is
16265                      * '!', which is applied immediately to this operand. */
16266                     curchar = (char) SvUV(*top_ptr);
16267                     if (curchar != '!') {
16268                         SvREFCNT_dec(current);
16269                         vFAIL2("Unexpected binary operator '%c' with no "
16270                                 "preceding operand", curchar);
16271                     }
16272
16273                     _invlist_invert(current);
16274
16275                     only_to_avoid_leaks = av_pop(stack);
16276                     SvREFCNT_dec(only_to_avoid_leaks);
16277
16278                     /* And we redo with the inverted operand.  This allows
16279                      * handling multiple ! in a row */
16280                     goto handle_operand;
16281                 }
16282                           /* Single operand is ok only for the non-binary ')'
16283                            * operator */
16284                 else if ((top_index - fence == 0 && curchar != ')')
16285                          || (top_index - fence > 0
16286                              && (! (stacked_ptr = av_fetch(stack,
16287                                                            top_index - 1,
16288                                                            FALSE))
16289                                  || IS_OPERAND(*stacked_ptr))))
16290                 {
16291                     SvREFCNT_dec(current);
16292                     vFAIL("Operand with no preceding operator");
16293                 }
16294             }
16295
16296             /* Here there was nothing on the stack or the top element was
16297              * another operand.  Just add this new one */
16298             av_push(stack, current);
16299
16300         } /* End of switch on next parse token */
16301
16302         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16303     } /* End of loop parsing through the construct */
16304
16305     vFAIL("Syntax error in (?[...])");
16306
16307   done:
16308
16309     if (RExC_parse >= RExC_end || RExC_parse[1] != ')') {
16310         if (RExC_parse < RExC_end) {
16311             RExC_parse++;
16312         }
16313
16314         vFAIL("Unexpected ']' with no following ')' in (?[...");
16315     }
16316
16317     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
16318         vFAIL("Unmatched (");
16319     }
16320
16321     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
16322         || ((final = av_pop(stack)) == NULL)
16323         || ! IS_OPERAND(final)
16324         || ! is_invlist(final)
16325         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
16326     {
16327       bad_syntax:
16328         SvREFCNT_dec(final);
16329         vFAIL("Incomplete expression within '(?[ ])'");
16330     }
16331
16332     /* Here, 'final' is the resultant inversion list from evaluating the
16333      * expression.  Return it if so requested */
16334     if (return_invlist) {
16335         *return_invlist = final;
16336         return END;
16337     }
16338
16339     /* Otherwise generate a resultant node, based on 'final'.  regclass() is
16340      * expecting a string of ranges and individual code points */
16341     invlist_iterinit(final);
16342     result_string = newSVpvs("");
16343     while (invlist_iternext(final, &start, &end)) {
16344         if (start == end) {
16345             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
16346         }
16347         else {
16348             Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%" UVXf "}",
16349                                                      start,          end);
16350         }
16351     }
16352
16353     /* About to generate an ANYOF (or similar) node from the inversion list we
16354      * have calculated */
16355     save_parse = RExC_parse;
16356     RExC_parse = SvPV(result_string, len);
16357     save_end = RExC_end;
16358     RExC_end = RExC_parse + len;
16359     TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
16360
16361     /* We turn off folding around the call, as the class we have constructed
16362      * already has all folding taken into consideration, and we don't want
16363      * regclass() to add to that */
16364     RExC_flags &= ~RXf_PMf_FOLD;
16365     /* regclass() can only return RESTART_PARSE and NEED_UTF8 if multi-char
16366      * folds are allowed.  */
16367     node = regclass(pRExC_state, flagp, depth+1,
16368                     FALSE, /* means parse the whole char class */
16369                     FALSE, /* don't allow multi-char folds */
16370                     TRUE, /* silence non-portable warnings.  The above may very
16371                              well have generated non-portable code points, but
16372                              they're valid on this machine */
16373                     FALSE, /* similarly, no need for strict */
16374                     FALSE, /* Require return to be an ANYOF */
16375                     NULL
16376                 );
16377
16378     RESTORE_WARNINGS;
16379     RExC_parse = save_parse + 1;
16380     RExC_end = save_end;
16381     SvREFCNT_dec_NN(final);
16382     SvREFCNT_dec_NN(result_string);
16383
16384     if (save_fold) {
16385         RExC_flags |= RXf_PMf_FOLD;
16386     }
16387
16388     if (!node)
16389         goto regclass_failed;
16390
16391     /* Fix up the node type if we are in locale.  (We have pretended we are
16392      * under /u for the purposes of regclass(), as this construct will only
16393      * work under UTF-8 locales.  But now we change the opcode to be ANYOFL (so
16394      * as to cause any warnings about bad locales to be output in regexec.c),
16395      * and add the flag that indicates to check if not in a UTF-8 locale.  The
16396      * reason we above forbid optimization into something other than an ANYOF
16397      * node is simply to minimize the number of code changes in regexec.c.
16398      * Otherwise we would have to create new EXACTish node types and deal with
16399      * them.  This decision could be revisited should this construct become
16400      * popular.
16401      *
16402      * (One might think we could look at the resulting ANYOF node and suppress
16403      * the flag if everything is above 255, as those would be UTF-8 only,
16404      * but this isn't true, as the components that led to that result could
16405      * have been locale-affected, and just happen to cancel each other out
16406      * under UTF-8 locales.) */
16407     if (in_locale) {
16408         set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
16409
16410         assert(OP(REGNODE_p(node)) == ANYOF);
16411
16412         OP(REGNODE_p(node)) = ANYOFL;
16413         ANYOF_FLAGS(REGNODE_p(node))
16414                 |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
16415     }
16416
16417     nextchar(pRExC_state);
16418     Set_Node_Length(REGNODE_p(node), RExC_parse - oregcomp_parse + 1); /* MJD */
16419     return node;
16420
16421   regclass_failed:
16422     FAIL2("panic: regclass returned failure to handle_sets, " "flags=%#" UVxf,
16423                                                                 (UV) *flagp);
16424 }
16425
16426 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16427
16428 STATIC void
16429 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
16430                              AV * stack, const IV fence, AV * fence_stack)
16431 {   /* Dumps the stacks in handle_regex_sets() */
16432
16433     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
16434     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
16435     SSize_t i;
16436
16437     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
16438
16439     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
16440
16441     if (stack_top < 0) {
16442         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
16443     }
16444     else {
16445         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
16446         for (i = stack_top; i >= 0; i--) {
16447             SV ** element_ptr = av_fetch(stack, i, FALSE);
16448             if (! element_ptr) {
16449             }
16450
16451             if (IS_OPERATOR(*element_ptr)) {
16452                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
16453                                             (int) i, (int) SvIV(*element_ptr));
16454             }
16455             else {
16456                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
16457                 sv_dump(*element_ptr);
16458             }
16459         }
16460     }
16461
16462     if (fence_stack_top < 0) {
16463         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
16464     }
16465     else {
16466         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
16467         for (i = fence_stack_top; i >= 0; i--) {
16468             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
16469             if (! element_ptr) {
16470             }
16471
16472             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
16473                                             (int) i, (int) SvIV(*element_ptr));
16474         }
16475     }
16476 }
16477
16478 #endif
16479
16480 #undef IS_OPERATOR
16481 #undef IS_OPERAND
16482
16483 STATIC void
16484 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
16485 {
16486     /* This adds the Latin1/above-Latin1 folding rules.
16487      *
16488      * This should be called only for a Latin1-range code points, cp, which is
16489      * known to be involved in a simple fold with other code points above
16490      * Latin1.  It would give false results if /aa has been specified.
16491      * Multi-char folds are outside the scope of this, and must be handled
16492      * specially. */
16493
16494     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
16495
16496     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
16497
16498     /* The rules that are valid for all Unicode versions are hard-coded in */
16499     switch (cp) {
16500         case 'k':
16501         case 'K':
16502           *invlist =
16503              add_cp_to_invlist(*invlist, KELVIN_SIGN);
16504             break;
16505         case 's':
16506         case 'S':
16507           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
16508             break;
16509         case MICRO_SIGN:
16510           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
16511           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
16512             break;
16513         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
16514         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
16515           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
16516             break;
16517         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
16518           *invlist = add_cp_to_invlist(*invlist,
16519                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
16520             break;
16521
16522         default:    /* Other code points are checked against the data for the
16523                        current Unicode version */
16524           {
16525             Size_t folds_count;
16526             unsigned int first_fold;
16527             const unsigned int * remaining_folds;
16528             UV folded_cp;
16529
16530             if (isASCII(cp)) {
16531                 folded_cp = toFOLD(cp);
16532             }
16533             else {
16534                 U8 dummy_fold[UTF8_MAXBYTES_CASE+1];
16535                 Size_t dummy_len;
16536                 folded_cp = _to_fold_latin1(cp, dummy_fold, &dummy_len, 0);
16537             }
16538
16539             if (folded_cp > 255) {
16540                 *invlist = add_cp_to_invlist(*invlist, folded_cp);
16541             }
16542
16543             folds_count = _inverse_folds(folded_cp, &first_fold,
16544                                                     &remaining_folds);
16545             if (folds_count == 0) {
16546
16547                 /* Use deprecated warning to increase the chances of this being
16548                  * output */
16549                 ckWARN2reg_d(RExC_parse,
16550                         "Perl folding rules are not up-to-date for 0x%02X;"
16551                         " please use the perlbug utility to report;", cp);
16552             }
16553             else {
16554                 unsigned int i;
16555
16556                 if (first_fold > 255) {
16557                     *invlist = add_cp_to_invlist(*invlist, first_fold);
16558                 }
16559                 for (i = 0; i < folds_count - 1; i++) {
16560                     if (remaining_folds[i] > 255) {
16561                         *invlist = add_cp_to_invlist(*invlist,
16562                                                     remaining_folds[i]);
16563                     }
16564                 }
16565             }
16566             break;
16567          }
16568     }
16569 }
16570
16571 STATIC void
16572 S_output_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings)
16573 {
16574     /* Output the elements of the array given by '*posix_warnings' as REGEXP
16575      * warnings. */
16576
16577     SV * msg;
16578     const bool first_is_fatal = ckDEAD(packWARN(WARN_REGEXP));
16579
16580     PERL_ARGS_ASSERT_OUTPUT_POSIX_WARNINGS;
16581
16582     if (! TO_OUTPUT_WARNINGS(RExC_parse)) {
16583         return;
16584     }
16585
16586     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
16587         if (first_is_fatal) {           /* Avoid leaking this */
16588             av_undef(posix_warnings);   /* This isn't necessary if the
16589                                             array is mortal, but is a
16590                                             fail-safe */
16591             (void) sv_2mortal(msg);
16592             PREPARE_TO_DIE;
16593         }
16594         Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
16595         SvREFCNT_dec_NN(msg);
16596     }
16597
16598     UPDATE_WARNINGS_LOC(RExC_parse);
16599 }
16600
16601 STATIC AV *
16602 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
16603 {
16604     /* This adds the string scalar <multi_string> to the array
16605      * <multi_char_matches>.  <multi_string> is known to have exactly
16606      * <cp_count> code points in it.  This is used when constructing a
16607      * bracketed character class and we find something that needs to match more
16608      * than a single character.
16609      *
16610      * <multi_char_matches> is actually an array of arrays.  Each top-level
16611      * element is an array that contains all the strings known so far that are
16612      * the same length.  And that length (in number of code points) is the same
16613      * as the index of the top-level array.  Hence, the [2] element is an
16614      * array, each element thereof is a string containing TWO code points;
16615      * while element [3] is for strings of THREE characters, and so on.  Since
16616      * this is for multi-char strings there can never be a [0] nor [1] element.
16617      *
16618      * When we rewrite the character class below, we will do so such that the
16619      * longest strings are written first, so that it prefers the longest
16620      * matching strings first.  This is done even if it turns out that any
16621      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
16622      * Christiansen has agreed that this is ok.  This makes the test for the
16623      * ligature 'ffi' come before the test for 'ff', for example */
16624
16625     AV* this_array;
16626     AV** this_array_ptr;
16627
16628     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
16629
16630     if (! multi_char_matches) {
16631         multi_char_matches = newAV();
16632     }
16633
16634     if (av_exists(multi_char_matches, cp_count)) {
16635         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
16636         this_array = *this_array_ptr;
16637     }
16638     else {
16639         this_array = newAV();
16640         av_store(multi_char_matches, cp_count,
16641                  (SV*) this_array);
16642     }
16643     av_push(this_array, multi_string);
16644
16645     return multi_char_matches;
16646 }
16647
16648 /* The names of properties whose definitions are not known at compile time are
16649  * stored in this SV, after a constant heading.  So if the length has been
16650  * changed since initialization, then there is a run-time definition. */
16651 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
16652                                         (SvCUR(listsv) != initial_listsv_len)
16653
16654 /* There is a restricted set of white space characters that are legal when
16655  * ignoring white space in a bracketed character class.  This generates the
16656  * code to skip them.
16657  *
16658  * There is a line below that uses the same white space criteria but is outside
16659  * this macro.  Both here and there must use the same definition */
16660 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p)                          \
16661     STMT_START {                                                        \
16662         if (do_skip) {                                                  \
16663             while (isBLANK_A(UCHARAT(p)))                               \
16664             {                                                           \
16665                 p++;                                                    \
16666             }                                                           \
16667         }                                                               \
16668     } STMT_END
16669
16670 STATIC regnode_offset
16671 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
16672                  const bool stop_at_1,  /* Just parse the next thing, don't
16673                                            look for a full character class */
16674                  bool allow_mutiple_chars,
16675                  const bool silence_non_portable,   /* Don't output warnings
16676                                                        about too large
16677                                                        characters */
16678                  const bool strict,
16679                  bool optimizable,                  /* ? Allow a non-ANYOF return
16680                                                        node */
16681                  SV** ret_invlist  /* Return an inversion list, not a node */
16682           )
16683 {
16684     /* parse a bracketed class specification.  Most of these will produce an
16685      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
16686      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
16687      * under /i with multi-character folds: it will be rewritten following the
16688      * paradigm of this example, where the <multi-fold>s are characters which
16689      * fold to multiple character sequences:
16690      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
16691      * gets effectively rewritten as:
16692      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
16693      * reg() gets called (recursively) on the rewritten version, and this
16694      * function will return what it constructs.  (Actually the <multi-fold>s
16695      * aren't physically removed from the [abcdefghi], it's just that they are
16696      * ignored in the recursion by means of a flag:
16697      * <RExC_in_multi_char_class>.)
16698      *
16699      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
16700      * characters, with the corresponding bit set if that character is in the
16701      * list.  For characters above this, an inversion list is used.  There
16702      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
16703      * determinable at compile time
16704      *
16705      * On success, returns the offset at which any next node should be placed
16706      * into the regex engine program being compiled.
16707      *
16708      * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
16709      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
16710      * UTF-8
16711      */
16712
16713     dVAR;
16714     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
16715     IV range = 0;
16716     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
16717     regnode_offset ret = -1;    /* Initialized to an illegal value */
16718     STRLEN numlen;
16719     int namedclass = OOB_NAMEDCLASS;
16720     char *rangebegin = NULL;
16721     SV *listsv = NULL;      /* List of \p{user-defined} whose definitions
16722                                aren't available at the time this was called */
16723     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
16724                                       than just initialized.  */
16725     SV* properties = NULL;    /* Code points that match \p{} \P{} */
16726     SV* posixes = NULL;     /* Code points that match classes like [:word:],
16727                                extended beyond the Latin1 range.  These have to
16728                                be kept separate from other code points for much
16729                                of this function because their handling  is
16730                                different under /i, and for most classes under
16731                                /d as well */
16732     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
16733                                separate for a while from the non-complemented
16734                                versions because of complications with /d
16735                                matching */
16736     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
16737                                   treated more simply than the general case,
16738                                   leading to less compilation and execution
16739                                   work */
16740     UV element_count = 0;   /* Number of distinct elements in the class.
16741                                Optimizations may be possible if this is tiny */
16742     AV * multi_char_matches = NULL; /* Code points that fold to more than one
16743                                        character; used under /i */
16744     UV n;
16745     char * stop_ptr = RExC_end;    /* where to stop parsing */
16746
16747     /* ignore unescaped whitespace? */
16748     const bool skip_white = cBOOL(   ret_invlist
16749                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
16750
16751     /* inversion list of code points this node matches only when the target
16752      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
16753      * /d) */
16754     SV* upper_latin1_only_utf8_matches = NULL;
16755
16756     /* Inversion list of code points this node matches regardless of things
16757      * like locale, folding, utf8ness of the target string */
16758     SV* cp_list = NULL;
16759
16760     /* Like cp_list, but code points on this list need to be checked for things
16761      * that fold to/from them under /i */
16762     SV* cp_foldable_list = NULL;
16763
16764     /* Like cp_list, but code points on this list are valid only when the
16765      * runtime locale is UTF-8 */
16766     SV* only_utf8_locale_list = NULL;
16767
16768     /* In a range, if one of the endpoints is non-character-set portable,
16769      * meaning that it hard-codes a code point that may mean a different
16770      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
16771      * mnemonic '\t' which each mean the same character no matter which
16772      * character set the platform is on. */
16773     unsigned int non_portable_endpoint = 0;
16774
16775     /* Is the range unicode? which means on a platform that isn't 1-1 native
16776      * to Unicode (i.e. non-ASCII), each code point in it should be considered
16777      * to be a Unicode value.  */
16778     bool unicode_range = FALSE;
16779     bool invert = FALSE;    /* Is this class to be complemented */
16780
16781     bool warn_super = ALWAYS_WARN_SUPER;
16782
16783     const char * orig_parse = RExC_parse;
16784
16785     /* This variable is used to mark where the end in the input is of something
16786      * that looks like a POSIX construct but isn't.  During the parse, when
16787      * something looks like it could be such a construct is encountered, it is
16788      * checked for being one, but not if we've already checked this area of the
16789      * input.  Only after this position is reached do we check again */
16790     char *not_posix_region_end = RExC_parse - 1;
16791
16792     AV* posix_warnings = NULL;
16793     const bool do_posix_warnings = ckWARN(WARN_REGEXP);
16794     U8 op = END;    /* The returned node-type, initialized to an impossible
16795                        one.  */
16796     U8 anyof_flags = 0;   /* flag bits if the node is an ANYOF-type */
16797     U32 posixl = 0;       /* bit field of posix classes matched under /l */
16798
16799
16800 /* Flags as to what things aren't knowable until runtime.  (Note that these are
16801  * mutually exclusive.) */
16802 #define HAS_USER_DEFINED_PROPERTY 0x01   /* /u any user-defined properties that
16803                                             haven't been defined as of yet */
16804 #define HAS_D_RUNTIME_DEPENDENCY  0x02   /* /d if the target being matched is
16805                                             UTF-8 or not */
16806 #define HAS_L_RUNTIME_DEPENDENCY   0x04 /* /l what the posix classes match and
16807                                             what gets folded */
16808     U32 has_runtime_dependency = 0;     /* OR of the above flags */
16809
16810     GET_RE_DEBUG_FLAGS_DECL;
16811
16812     PERL_ARGS_ASSERT_REGCLASS;
16813 #ifndef DEBUGGING
16814     PERL_UNUSED_ARG(depth);
16815 #endif
16816
16817
16818     /* If wants an inversion list returned, we can't optimize to something
16819      * else. */
16820     if (ret_invlist) {
16821         optimizable = FALSE;
16822     }
16823
16824     DEBUG_PARSE("clas");
16825
16826 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
16827     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
16828                                    && UNICODE_DOT_DOT_VERSION == 0)
16829     allow_mutiple_chars = FALSE;
16830 #endif
16831
16832     /* We include the /i status at the beginning of this so that we can
16833      * know it at runtime */
16834     listsv = sv_2mortal(Perl_newSVpvf(aTHX_ "#%d\n", cBOOL(FOLD)));
16835     initial_listsv_len = SvCUR(listsv);
16836     SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
16837
16838     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16839
16840     assert(RExC_parse <= RExC_end);
16841
16842     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
16843         RExC_parse++;
16844         invert = TRUE;
16845         allow_mutiple_chars = FALSE;
16846         MARK_NAUGHTY(1);
16847         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16848     }
16849
16850     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
16851     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
16852         int maybe_class = handle_possible_posix(pRExC_state,
16853                                                 RExC_parse,
16854                                                 &not_posix_region_end,
16855                                                 NULL,
16856                                                 TRUE /* checking only */);
16857         if (maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
16858             ckWARN4reg(not_posix_region_end,
16859                     "POSIX syntax [%c %c] belongs inside character classes%s",
16860                     *RExC_parse, *RExC_parse,
16861                     (maybe_class == OOB_NAMEDCLASS)
16862                     ? ((POSIXCC_NOTYET(*RExC_parse))
16863                         ? " (but this one isn't implemented)"
16864                         : " (but this one isn't fully valid)")
16865                     : ""
16866                     );
16867         }
16868     }
16869
16870     /* If the caller wants us to just parse a single element, accomplish this
16871      * by faking the loop ending condition */
16872     if (stop_at_1 && RExC_end > RExC_parse) {
16873         stop_ptr = RExC_parse + 1;
16874     }
16875
16876     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
16877     if (UCHARAT(RExC_parse) == ']')
16878         goto charclassloop;
16879
16880     while (1) {
16881
16882         if (   posix_warnings
16883             && av_tindex_skip_len_mg(posix_warnings) >= 0
16884             && RExC_parse > not_posix_region_end)
16885         {
16886             /* Warnings about posix class issues are considered tentative until
16887              * we are far enough along in the parse that we can no longer
16888              * change our mind, at which point we output them.  This is done
16889              * each time through the loop so that a later class won't zap them
16890              * before they have been dealt with. */
16891             output_posix_warnings(pRExC_state, posix_warnings);
16892         }
16893
16894         if  (RExC_parse >= stop_ptr) {
16895             break;
16896         }
16897
16898         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
16899
16900         if  (UCHARAT(RExC_parse) == ']') {
16901             break;
16902         }
16903
16904       charclassloop:
16905
16906         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
16907         save_value = value;
16908         save_prevvalue = prevvalue;
16909
16910         if (!range) {
16911             rangebegin = RExC_parse;
16912             element_count++;
16913             non_portable_endpoint = 0;
16914         }
16915         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
16916             value = utf8n_to_uvchr((U8*)RExC_parse,
16917                                    RExC_end - RExC_parse,
16918                                    &numlen, UTF8_ALLOW_DEFAULT);
16919             RExC_parse += numlen;
16920         }
16921         else
16922             value = UCHARAT(RExC_parse++);
16923
16924         if (value == '[') {
16925             char * posix_class_end;
16926             namedclass = handle_possible_posix(pRExC_state,
16927                                                RExC_parse,
16928                                                &posix_class_end,
16929                                                do_posix_warnings ? &posix_warnings : NULL,
16930                                                FALSE    /* die if error */);
16931             if (namedclass > OOB_NAMEDCLASS) {
16932
16933                 /* If there was an earlier attempt to parse this particular
16934                  * posix class, and it failed, it was a false alarm, as this
16935                  * successful one proves */
16936                 if (   posix_warnings
16937                     && av_tindex_skip_len_mg(posix_warnings) >= 0
16938                     && not_posix_region_end >= RExC_parse
16939                     && not_posix_region_end <= posix_class_end)
16940                 {
16941                     av_undef(posix_warnings);
16942                 }
16943
16944                 RExC_parse = posix_class_end;
16945             }
16946             else if (namedclass == OOB_NAMEDCLASS) {
16947                 not_posix_region_end = posix_class_end;
16948             }
16949             else {
16950                 namedclass = OOB_NAMEDCLASS;
16951             }
16952         }
16953         else if (   RExC_parse - 1 > not_posix_region_end
16954                  && MAYBE_POSIXCC(value))
16955         {
16956             (void) handle_possible_posix(
16957                         pRExC_state,
16958                         RExC_parse - 1,  /* -1 because parse has already been
16959                                             advanced */
16960                         &not_posix_region_end,
16961                         do_posix_warnings ? &posix_warnings : NULL,
16962                         TRUE /* checking only */);
16963         }
16964         else if (  strict && ! skip_white
16965                  && (   _generic_isCC(value, _CC_VERTSPACE)
16966                      || is_VERTWS_cp_high(value)))
16967         {
16968             vFAIL("Literal vertical space in [] is illegal except under /x");
16969         }
16970         else if (value == '\\') {
16971             /* Is a backslash; get the code point of the char after it */
16972
16973             if (RExC_parse >= RExC_end) {
16974                 vFAIL("Unmatched [");
16975             }
16976
16977             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
16978                 value = utf8n_to_uvchr((U8*)RExC_parse,
16979                                    RExC_end - RExC_parse,
16980                                    &numlen, UTF8_ALLOW_DEFAULT);
16981                 RExC_parse += numlen;
16982             }
16983             else
16984                 value = UCHARAT(RExC_parse++);
16985
16986             /* Some compilers cannot handle switching on 64-bit integer
16987              * values, therefore value cannot be an UV.  Yes, this will
16988              * be a problem later if we want switch on Unicode.
16989              * A similar issue a little bit later when switching on
16990              * namedclass. --jhi */
16991
16992             /* If the \ is escaping white space when white space is being
16993              * skipped, it means that that white space is wanted literally, and
16994              * is already in 'value'.  Otherwise, need to translate the escape
16995              * into what it signifies. */
16996             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
16997
16998             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
16999             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
17000             case 's':   namedclass = ANYOF_SPACE;       break;
17001             case 'S':   namedclass = ANYOF_NSPACE;      break;
17002             case 'd':   namedclass = ANYOF_DIGIT;       break;
17003             case 'D':   namedclass = ANYOF_NDIGIT;      break;
17004             case 'v':   namedclass = ANYOF_VERTWS;      break;
17005             case 'V':   namedclass = ANYOF_NVERTWS;     break;
17006             case 'h':   namedclass = ANYOF_HORIZWS;     break;
17007             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
17008             case 'N':  /* Handle \N{NAME} in class */
17009                 {
17010                     const char * const backslash_N_beg = RExC_parse - 2;
17011                     int cp_count;
17012
17013                     if (! grok_bslash_N(pRExC_state,
17014                                         NULL,      /* No regnode */
17015                                         &value,    /* Yes single value */
17016                                         &cp_count, /* Multiple code pt count */
17017                                         flagp,
17018                                         strict,
17019                                         depth)
17020                     ) {
17021
17022                         if (*flagp & NEED_UTF8)
17023                             FAIL("panic: grok_bslash_N set NEED_UTF8");
17024
17025                         RETURN_FAIL_ON_RESTART_FLAGP(flagp);
17026
17027                         if (cp_count < 0) {
17028                             vFAIL("\\N in a character class must be a named character: \\N{...}");
17029                         }
17030                         else if (cp_count == 0) {
17031                             ckWARNreg(RExC_parse,
17032                               "Ignoring zero length \\N{} in character class");
17033                         }
17034                         else { /* cp_count > 1 */
17035                             assert(cp_count > 1);
17036                             if (! RExC_in_multi_char_class) {
17037                                 if ( ! allow_mutiple_chars
17038                                     || invert
17039                                     || range
17040                                     || *RExC_parse == '-')
17041                                 {
17042                                     if (strict) {
17043                                         RExC_parse--;
17044                                         vFAIL("\\N{} here is restricted to one character");
17045                                     }
17046                                     ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
17047                                     break; /* <value> contains the first code
17048                                               point. Drop out of the switch to
17049                                               process it */
17050                                 }
17051                                 else {
17052                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
17053                                                  RExC_parse - backslash_N_beg);
17054                                     multi_char_matches
17055                                         = add_multi_match(multi_char_matches,
17056                                                           multi_char_N,
17057                                                           cp_count);
17058                                 }
17059                             }
17060                         } /* End of cp_count != 1 */
17061
17062                         /* This element should not be processed further in this
17063                          * class */
17064                         element_count--;
17065                         value = save_value;
17066                         prevvalue = save_prevvalue;
17067                         continue;   /* Back to top of loop to get next char */
17068                     }
17069
17070                     /* Here, is a single code point, and <value> contains it */
17071                     unicode_range = TRUE;   /* \N{} are Unicode */
17072                 }
17073                 break;
17074             case 'p':
17075             case 'P':
17076                 {
17077                 char *e;
17078
17079                 /* \p means they want Unicode semantics */
17080                 REQUIRE_UNI_RULES(flagp, 0);
17081
17082                 if (RExC_parse >= RExC_end)
17083                     vFAIL2("Empty \\%c", (U8)value);
17084                 if (*RExC_parse == '{') {
17085                     const U8 c = (U8)value;
17086                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
17087                     if (!e) {
17088                         RExC_parse++;
17089                         vFAIL2("Missing right brace on \\%c{}", c);
17090                     }
17091
17092                     RExC_parse++;
17093
17094                     /* White space is allowed adjacent to the braces and after
17095                      * any '^', even when not under /x */
17096                     while (isSPACE(*RExC_parse)) {
17097                          RExC_parse++;
17098                     }
17099
17100                     if (UCHARAT(RExC_parse) == '^') {
17101
17102                         /* toggle.  (The rhs xor gets the single bit that
17103                          * differs between P and p; the other xor inverts just
17104                          * that bit) */
17105                         value ^= 'P' ^ 'p';
17106
17107                         RExC_parse++;
17108                         while (isSPACE(*RExC_parse)) {
17109                             RExC_parse++;
17110                         }
17111                     }
17112
17113                     if (e == RExC_parse)
17114                         vFAIL2("Empty \\%c{}", c);
17115
17116                     n = e - RExC_parse;
17117                     while (isSPACE(*(RExC_parse + n - 1)))
17118                         n--;
17119
17120                 }   /* The \p isn't immediately followed by a '{' */
17121                 else if (! isALPHA(*RExC_parse)) {
17122                     RExC_parse += (UTF)
17123                                   ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
17124                                   : 1;
17125                     vFAIL2("Character following \\%c must be '{' or a "
17126                            "single-character Unicode property name",
17127                            (U8) value);
17128                 }
17129                 else {
17130                     e = RExC_parse;
17131                     n = 1;
17132                 }
17133                 {
17134                     char* name = RExC_parse;
17135
17136                     /* Any message returned about expanding the definition */
17137                     SV* msg = newSVpvs_flags("", SVs_TEMP);
17138
17139                     /* If set TRUE, the property is user-defined as opposed to
17140                      * official Unicode */
17141                     bool user_defined = FALSE;
17142
17143                     SV * prop_definition = parse_uniprop_string(
17144                                             name, n, UTF, FOLD,
17145                                             FALSE, /* This is compile-time */
17146
17147                                             /* We can't defer this defn when
17148                                              * the full result is required in
17149                                              * this call */
17150                                             ! cBOOL(ret_invlist),
17151
17152                                             &user_defined,
17153                                             msg,
17154                                             0 /* Base level */
17155                                            );
17156                     if (SvCUR(msg)) {   /* Assumes any error causes a msg */
17157                         assert(prop_definition == NULL);
17158                         RExC_parse = e + 1;
17159                         if (SvUTF8(msg)) {  /* msg being UTF-8 makes the whole
17160                                                thing so, or else the display is
17161                                                mojibake */
17162                             RExC_utf8 = TRUE;
17163                         }
17164                         /* diag_listed_as: Can't find Unicode property definition "%s" in regex; marked by <-- HERE in m/%s/ */
17165                         vFAIL2utf8f("%" UTF8f, UTF8fARG(SvUTF8(msg),
17166                                     SvCUR(msg), SvPVX(msg)));
17167                     }
17168
17169                     if (! is_invlist(prop_definition)) {
17170
17171                         /* Here, the definition isn't known, so we have gotten
17172                          * returned a string that will be evaluated if and when
17173                          * encountered at runtime.  We add it to the list of
17174                          * such properties, along with whether it should be
17175                          * complemented or not */
17176                         if (value == 'P') {
17177                             sv_catpvs(listsv, "!");
17178                         }
17179                         else {
17180                             sv_catpvs(listsv, "+");
17181                         }
17182                         sv_catsv(listsv, prop_definition);
17183
17184                         has_runtime_dependency |= HAS_USER_DEFINED_PROPERTY;
17185
17186                         /* We don't know yet what this matches, so have to flag
17187                          * it */
17188                         anyof_flags |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
17189                     }
17190                     else {
17191                         assert (prop_definition && is_invlist(prop_definition));
17192
17193                         /* Here we do have the complete property definition
17194                          *
17195                          * Temporary workaround for [perl #133136].  For this
17196                          * precise input that is in the .t that is failing,
17197                          * load utf8.pm, which is what the test wants, so that
17198                          * that .t passes */
17199                         if (     memEQs(RExC_start, e + 1 - RExC_start,
17200                                         "foo\\p{Alnum}")
17201                             && ! hv_common(GvHVn(PL_incgv),
17202                                            NULL,
17203                                            "utf8.pm", sizeof("utf8.pm") - 1,
17204                                            0, HV_FETCH_ISEXISTS, NULL, 0))
17205                         {
17206                             require_pv("utf8.pm");
17207                         }
17208
17209                         if (! user_defined &&
17210                             /* We warn on matching an above-Unicode code point
17211                              * if the match would return true, except don't
17212                              * warn for \p{All}, which has exactly one element
17213                              * = 0 */
17214                             (_invlist_contains_cp(prop_definition, 0x110000)
17215                                 && (! (_invlist_len(prop_definition) == 1
17216                                        && *invlist_array(prop_definition) == 0))))
17217                         {
17218                             warn_super = TRUE;
17219                         }
17220
17221                         /* Invert if asking for the complement */
17222                         if (value == 'P') {
17223                             _invlist_union_complement_2nd(properties,
17224                                                           prop_definition,
17225                                                           &properties);
17226                         }
17227                         else {
17228                             _invlist_union(properties, prop_definition, &properties);
17229                         }
17230                     }
17231                 }
17232
17233                 RExC_parse = e + 1;
17234                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
17235                                                 named */
17236                 }
17237                 break;
17238             case 'n':   value = '\n';                   break;
17239             case 'r':   value = '\r';                   break;
17240             case 't':   value = '\t';                   break;
17241             case 'f':   value = '\f';                   break;
17242             case 'b':   value = '\b';                   break;
17243             case 'e':   value = ESC_NATIVE;             break;
17244             case 'a':   value = '\a';                   break;
17245             case 'o':
17246                 RExC_parse--;   /* function expects to be pointed at the 'o' */
17247                 {
17248                     const char* error_msg;
17249                     bool valid = grok_bslash_o(&RExC_parse,
17250                                                RExC_end,
17251                                                &value,
17252                                                &error_msg,
17253                                                TO_OUTPUT_WARNINGS(RExC_parse),
17254                                                strict,
17255                                                silence_non_portable,
17256                                                UTF);
17257                     if (! valid) {
17258                         vFAIL(error_msg);
17259                     }
17260                     UPDATE_WARNINGS_LOC(RExC_parse - 1);
17261                 }
17262                 non_portable_endpoint++;
17263                 break;
17264             case 'x':
17265                 RExC_parse--;   /* function expects to be pointed at the 'x' */
17266                 {
17267                     const char* error_msg;
17268                     bool valid = grok_bslash_x(&RExC_parse,
17269                                                RExC_end,
17270                                                &value,
17271                                                &error_msg,
17272                                                TO_OUTPUT_WARNINGS(RExC_parse),
17273                                                strict,
17274                                                silence_non_portable,
17275                                                UTF);
17276                     if (! valid) {
17277                         vFAIL(error_msg);
17278                     }
17279                     UPDATE_WARNINGS_LOC(RExC_parse - 1);
17280                 }
17281                 non_portable_endpoint++;
17282                 break;
17283             case 'c':
17284                 value = grok_bslash_c(*RExC_parse, TO_OUTPUT_WARNINGS(RExC_parse));
17285                 UPDATE_WARNINGS_LOC(RExC_parse);
17286                 RExC_parse++;
17287                 non_portable_endpoint++;
17288                 break;
17289             case '0': case '1': case '2': case '3': case '4':
17290             case '5': case '6': case '7':
17291                 {
17292                     /* Take 1-3 octal digits */
17293                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
17294                     numlen = (strict) ? 4 : 3;
17295                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
17296                     RExC_parse += numlen;
17297                     if (numlen != 3) {
17298                         if (strict) {
17299                             RExC_parse += (UTF)
17300                                           ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
17301                                           : 1;
17302                             vFAIL("Need exactly 3 octal digits");
17303                         }
17304                         else if (   numlen < 3 /* like \08, \178 */
17305                                  && RExC_parse < RExC_end
17306                                  && isDIGIT(*RExC_parse)
17307                                  && ckWARN(WARN_REGEXP))
17308                         {
17309                             reg_warn_non_literal_string(
17310                                  RExC_parse + 1,
17311                                  form_short_octal_warning(RExC_parse, numlen));
17312                         }
17313                     }
17314                     non_portable_endpoint++;
17315                     break;
17316                 }
17317             default:
17318                 /* Allow \_ to not give an error */
17319                 if (isWORDCHAR(value) && value != '_') {
17320                     if (strict) {
17321                         vFAIL2("Unrecognized escape \\%c in character class",
17322                                (int)value);
17323                     }
17324                     else {
17325                         ckWARN2reg(RExC_parse,
17326                             "Unrecognized escape \\%c in character class passed through",
17327                             (int)value);
17328                     }
17329                 }
17330                 break;
17331             }   /* End of switch on char following backslash */
17332         } /* end of handling backslash escape sequences */
17333
17334         /* Here, we have the current token in 'value' */
17335
17336         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
17337             U8 classnum;
17338
17339             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
17340              * literal, as is the character that began the false range, i.e.
17341              * the 'a' in the examples */
17342             if (range) {
17343                 const int w = (RExC_parse >= rangebegin)
17344                                 ? RExC_parse - rangebegin
17345                                 : 0;
17346                 if (strict) {
17347                     vFAIL2utf8f(
17348                         "False [] range \"%" UTF8f "\"",
17349                         UTF8fARG(UTF, w, rangebegin));
17350                 }
17351                 else {
17352                     ckWARN2reg(RExC_parse,
17353                         "False [] range \"%" UTF8f "\"",
17354                         UTF8fARG(UTF, w, rangebegin));
17355                     cp_list = add_cp_to_invlist(cp_list, '-');
17356                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
17357                                                             prevvalue);
17358                 }
17359
17360                 range = 0; /* this was not a true range */
17361                 element_count += 2; /* So counts for three values */
17362             }
17363
17364             classnum = namedclass_to_classnum(namedclass);
17365
17366             if (LOC && namedclass < ANYOF_POSIXL_MAX
17367 #ifndef HAS_ISASCII
17368                 && classnum != _CC_ASCII
17369 #endif
17370             ) {
17371                 SV* scratch_list = NULL;
17372
17373                 /* What the Posix classes (like \w, [:space:]) match isn't
17374                  * generally knowable under locale until actual match time.  A
17375                  * special node is used for these which has extra space for a
17376                  * bitmap, with a bit reserved for each named class that is to
17377                  * be matched against.  (This isn't needed for \p{} and
17378                  * pseudo-classes, as they are not affected by locale, and
17379                  * hence are dealt with separately.)  However, if a named class
17380                  * and its complement are both present, then it matches
17381                  * everything, and there is no runtime dependency.  Odd numbers
17382                  * are the complements of the next lower number, so xor works.
17383                  * (Note that something like [\w\D] should match everything,
17384                  * because \d should be a proper subset of \w.  But rather than
17385                  * trust that the locale is well behaved, we leave this to
17386                  * runtime to sort out) */
17387                 if (POSIXL_TEST(posixl, namedclass ^ 1)) {
17388                     cp_list = _add_range_to_invlist(cp_list, 0, UV_MAX);
17389                     POSIXL_ZERO(posixl);
17390                     has_runtime_dependency &= ~HAS_L_RUNTIME_DEPENDENCY;
17391                     anyof_flags &= ~ANYOF_MATCHES_POSIXL;
17392                     continue;   /* We could ignore the rest of the class, but
17393                                    best to parse it for any errors */
17394                 }
17395                 else { /* Here, isn't the complement of any already parsed
17396                           class */
17397                     POSIXL_SET(posixl, namedclass);
17398                     has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
17399                     anyof_flags |= ANYOF_MATCHES_POSIXL;
17400
17401                     /* The above-Latin1 characters are not subject to locale
17402                      * rules.  Just add them to the unconditionally-matched
17403                      * list */
17404
17405                     /* Get the list of the above-Latin1 code points this
17406                      * matches */
17407                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
17408                                             PL_XPosix_ptrs[classnum],
17409
17410                                             /* Odd numbers are complements,
17411                                              * like NDIGIT, NASCII, ... */
17412                                             namedclass % 2 != 0,
17413                                             &scratch_list);
17414                     /* Checking if 'cp_list' is NULL first saves an extra
17415                      * clone.  Its reference count will be decremented at the
17416                      * next union, etc, or if this is the only instance, at the
17417                      * end of the routine */
17418                     if (! cp_list) {
17419                         cp_list = scratch_list;
17420                     }
17421                     else {
17422                         _invlist_union(cp_list, scratch_list, &cp_list);
17423                         SvREFCNT_dec_NN(scratch_list);
17424                     }
17425                     continue;   /* Go get next character */
17426                 }
17427             }
17428             else {
17429
17430                 /* Here, is not /l, or is a POSIX class for which /l doesn't
17431                  * matter (or is a Unicode property, which is skipped here). */
17432                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
17433                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
17434
17435                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
17436                          * nor /l make a difference in what these match,
17437                          * therefore we just add what they match to cp_list. */
17438                         if (classnum != _CC_VERTSPACE) {
17439                             assert(   namedclass == ANYOF_HORIZWS
17440                                    || namedclass == ANYOF_NHORIZWS);
17441
17442                             /* It turns out that \h is just a synonym for
17443                              * XPosixBlank */
17444                             classnum = _CC_BLANK;
17445                         }
17446
17447                         _invlist_union_maybe_complement_2nd(
17448                                 cp_list,
17449                                 PL_XPosix_ptrs[classnum],
17450                                 namedclass % 2 != 0,    /* Complement if odd
17451                                                           (NHORIZWS, NVERTWS)
17452                                                         */
17453                                 &cp_list);
17454                     }
17455                 }
17456                 else if (   AT_LEAST_UNI_SEMANTICS
17457                          || classnum == _CC_ASCII
17458                          || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
17459                                                    || classnum == _CC_XDIGIT)))
17460                 {
17461                     /* We usually have to worry about /d affecting what POSIX
17462                      * classes match, with special code needed because we won't
17463                      * know until runtime what all matches.  But there is no
17464                      * extra work needed under /u and /a; and [:ascii:] is
17465                      * unaffected by /d; and :digit: and :xdigit: don't have
17466                      * runtime differences under /d.  So we can special case
17467                      * these, and avoid some extra work below, and at runtime.
17468                      * */
17469                     _invlist_union_maybe_complement_2nd(
17470                                                      simple_posixes,
17471                                                       ((AT_LEAST_ASCII_RESTRICTED)
17472                                                        ? PL_Posix_ptrs[classnum]
17473                                                        : PL_XPosix_ptrs[classnum]),
17474                                                      namedclass % 2 != 0,
17475                                                      &simple_posixes);
17476                 }
17477                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
17478                            complement and use nposixes */
17479                     SV** posixes_ptr = namedclass % 2 == 0
17480                                        ? &posixes
17481                                        : &nposixes;
17482                     _invlist_union_maybe_complement_2nd(
17483                                                      *posixes_ptr,
17484                                                      PL_XPosix_ptrs[classnum],
17485                                                      namedclass % 2 != 0,
17486                                                      posixes_ptr);
17487                 }
17488             }
17489         } /* end of namedclass \blah */
17490
17491         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse);
17492
17493         /* If 'range' is set, 'value' is the ending of a range--check its
17494          * validity.  (If value isn't a single code point in the case of a
17495          * range, we should have figured that out above in the code that
17496          * catches false ranges).  Later, we will handle each individual code
17497          * point in the range.  If 'range' isn't set, this could be the
17498          * beginning of a range, so check for that by looking ahead to see if
17499          * the next real character to be processed is the range indicator--the
17500          * minus sign */
17501
17502         if (range) {
17503 #ifdef EBCDIC
17504             /* For unicode ranges, we have to test that the Unicode as opposed
17505              * to the native values are not decreasing.  (Above 255, there is
17506              * no difference between native and Unicode) */
17507             if (unicode_range && prevvalue < 255 && value < 255) {
17508                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
17509                     goto backwards_range;
17510                 }
17511             }
17512             else
17513 #endif
17514             if (prevvalue > value) /* b-a */ {
17515                 int w;
17516 #ifdef EBCDIC
17517               backwards_range:
17518 #endif
17519                 w = RExC_parse - rangebegin;
17520                 vFAIL2utf8f(
17521                     "Invalid [] range \"%" UTF8f "\"",
17522                     UTF8fARG(UTF, w, rangebegin));
17523                 NOT_REACHED; /* NOTREACHED */
17524             }
17525         }
17526         else {
17527             prevvalue = value; /* save the beginning of the potential range */
17528             if (! stop_at_1     /* Can't be a range if parsing just one thing */
17529                 && *RExC_parse == '-')
17530             {
17531                 char* next_char_ptr = RExC_parse + 1;
17532
17533                 /* Get the next real char after the '-' */
17534                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr);
17535
17536                 /* If the '-' is at the end of the class (just before the ']',
17537                  * it is a literal minus; otherwise it is a range */
17538                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
17539                     RExC_parse = next_char_ptr;
17540
17541                     /* a bad range like \w-, [:word:]- ? */
17542                     if (namedclass > OOB_NAMEDCLASS) {
17543                         if (strict || ckWARN(WARN_REGEXP)) {
17544                             const int w = RExC_parse >= rangebegin
17545                                           ?  RExC_parse - rangebegin
17546                                           : 0;
17547                             if (strict) {
17548                                 vFAIL4("False [] range \"%*.*s\"",
17549                                     w, w, rangebegin);
17550                             }
17551                             else {
17552                                 vWARN4(RExC_parse,
17553                                     "False [] range \"%*.*s\"",
17554                                     w, w, rangebegin);
17555                             }
17556                         }
17557                         cp_list = add_cp_to_invlist(cp_list, '-');
17558                         element_count++;
17559                     } else
17560                         range = 1;      /* yeah, it's a range! */
17561                     continue;   /* but do it the next time */
17562                 }
17563             }
17564         }
17565
17566         if (namedclass > OOB_NAMEDCLASS) {
17567             continue;
17568         }
17569
17570         /* Here, we have a single value this time through the loop, and
17571          * <prevvalue> is the beginning of the range, if any; or <value> if
17572          * not. */
17573
17574         /* non-Latin1 code point implies unicode semantics. */
17575         if (value > 255) {
17576             REQUIRE_UNI_RULES(flagp, 0);
17577         }
17578
17579         /* Ready to process either the single value, or the completed range.
17580          * For single-valued non-inverted ranges, we consider the possibility
17581          * of multi-char folds.  (We made a conscious decision to not do this
17582          * for the other cases because it can often lead to non-intuitive
17583          * results.  For example, you have the peculiar case that:
17584          *  "s s" =~ /^[^\xDF]+$/i => Y
17585          *  "ss"  =~ /^[^\xDF]+$/i => N
17586          *
17587          * See [perl #89750] */
17588         if (FOLD && allow_mutiple_chars && value == prevvalue) {
17589             if (    value == LATIN_SMALL_LETTER_SHARP_S
17590                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
17591                                                         value)))
17592             {
17593                 /* Here <value> is indeed a multi-char fold.  Get what it is */
17594
17595                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17596                 STRLEN foldlen;
17597
17598                 UV folded = _to_uni_fold_flags(
17599                                 value,
17600                                 foldbuf,
17601                                 &foldlen,
17602                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
17603                                                    ? FOLD_FLAGS_NOMIX_ASCII
17604                                                    : 0)
17605                                 );
17606
17607                 /* Here, <folded> should be the first character of the
17608                  * multi-char fold of <value>, with <foldbuf> containing the
17609                  * whole thing.  But, if this fold is not allowed (because of
17610                  * the flags), <fold> will be the same as <value>, and should
17611                  * be processed like any other character, so skip the special
17612                  * handling */
17613                 if (folded != value) {
17614
17615                     /* Skip if we are recursed, currently parsing the class
17616                      * again.  Otherwise add this character to the list of
17617                      * multi-char folds. */
17618                     if (! RExC_in_multi_char_class) {
17619                         STRLEN cp_count = utf8_length(foldbuf,
17620                                                       foldbuf + foldlen);
17621                         SV* multi_fold = sv_2mortal(newSVpvs(""));
17622
17623                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
17624
17625                         multi_char_matches
17626                                         = add_multi_match(multi_char_matches,
17627                                                           multi_fold,
17628                                                           cp_count);
17629
17630                     }
17631
17632                     /* This element should not be processed further in this
17633                      * class */
17634                     element_count--;
17635                     value = save_value;
17636                     prevvalue = save_prevvalue;
17637                     continue;
17638                 }
17639             }
17640         }
17641
17642         if (strict && ckWARN(WARN_REGEXP)) {
17643             if (range) {
17644
17645                 /* If the range starts above 255, everything is portable and
17646                  * likely to be so for any forseeable character set, so don't
17647                  * warn. */
17648                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
17649                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
17650                 }
17651                 else if (prevvalue != value) {
17652
17653                     /* Under strict, ranges that stop and/or end in an ASCII
17654                      * printable should have each end point be a portable value
17655                      * for it (preferably like 'A', but we don't warn if it is
17656                      * a (portable) Unicode name or code point), and the range
17657                      * must be be all digits or all letters of the same case.
17658                      * Otherwise, the range is non-portable and unclear as to
17659                      * what it contains */
17660                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
17661                         && (          non_portable_endpoint
17662                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
17663                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
17664                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
17665                     ))) {
17666                         vWARN(RExC_parse, "Ranges of ASCII printables should"
17667                                           " be some subset of \"0-9\","
17668                                           " \"A-Z\", or \"a-z\"");
17669                     }
17670                     else if (prevvalue >= FIRST_NON_ASCII_DECIMAL_DIGIT) {
17671                         SSize_t index_start;
17672                         SSize_t index_final;
17673
17674                         /* But the nature of Unicode and languages mean we
17675                          * can't do the same checks for above-ASCII ranges,
17676                          * except in the case of digit ones.  These should
17677                          * contain only digits from the same group of 10.  The
17678                          * ASCII case is handled just above.  Hence here, the
17679                          * range could be a range of digits.  First some
17680                          * unlikely special cases.  Grandfather in that a range
17681                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
17682                          * if its starting value is one of the 10 digits prior
17683                          * to it.  This is because it is an alternate way of
17684                          * writing 19D1, and some people may expect it to be in
17685                          * that group.  But it is bad, because it won't give
17686                          * the expected results.  In Unicode 5.2 it was
17687                          * considered to be in that group (of 11, hence), but
17688                          * this was fixed in the next version */
17689
17690                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
17691                             goto warn_bad_digit_range;
17692                         }
17693                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
17694                                           &&     value <= 0x1D7FF))
17695                         {
17696                             /* This is the only other case currently in Unicode
17697                              * where the algorithm below fails.  The code
17698                              * points just above are the end points of a single
17699                              * range containing only decimal digits.  It is 5
17700                              * different series of 0-9.  All other ranges of
17701                              * digits currently in Unicode are just a single
17702                              * series.  (And mktables will notify us if a later
17703                              * Unicode version breaks this.)
17704                              *
17705                              * If the range being checked is at most 9 long,
17706                              * and the digit values represented are in
17707                              * numerical order, they are from the same series.
17708                              * */
17709                             if (         value - prevvalue > 9
17710                                 ||    (((    value - 0x1D7CE) % 10)
17711                                      <= (prevvalue - 0x1D7CE) % 10))
17712                             {
17713                                 goto warn_bad_digit_range;
17714                             }
17715                         }
17716                         else {
17717
17718                             /* For all other ranges of digits in Unicode, the
17719                              * algorithm is just to check if both end points
17720                              * are in the same series, which is the same range.
17721                              * */
17722                             index_start = _invlist_search(
17723                                                     PL_XPosix_ptrs[_CC_DIGIT],
17724                                                     prevvalue);
17725
17726                             /* Warn if the range starts and ends with a digit,
17727                              * and they are not in the same group of 10. */
17728                             if (   index_start >= 0
17729                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
17730                                 && (index_final =
17731                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
17732                                                     value)) != index_start
17733                                 && index_final >= 0
17734                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
17735                             {
17736                               warn_bad_digit_range:
17737                                 vWARN(RExC_parse, "Ranges of digits should be"
17738                                                   " from the same group of"
17739                                                   " 10");
17740                             }
17741                         }
17742                     }
17743                 }
17744             }
17745             if ((! range || prevvalue == value) && non_portable_endpoint) {
17746                 if (isPRINT_A(value)) {
17747                     char literal[3];
17748                     unsigned d = 0;
17749                     if (isBACKSLASHED_PUNCT(value)) {
17750                         literal[d++] = '\\';
17751                     }
17752                     literal[d++] = (char) value;
17753                     literal[d++] = '\0';
17754
17755                     vWARN4(RExC_parse,
17756                            "\"%.*s\" is more clearly written simply as \"%s\"",
17757                            (int) (RExC_parse - rangebegin),
17758                            rangebegin,
17759                            literal
17760                         );
17761                 }
17762                 else if (isMNEMONIC_CNTRL(value)) {
17763                     vWARN4(RExC_parse,
17764                            "\"%.*s\" is more clearly written simply as \"%s\"",
17765                            (int) (RExC_parse - rangebegin),
17766                            rangebegin,
17767                            cntrl_to_mnemonic((U8) value)
17768                         );
17769                 }
17770             }
17771         }
17772
17773         /* Deal with this element of the class */
17774
17775 #ifndef EBCDIC
17776         cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17777                                                     prevvalue, value);
17778 #else
17779         /* On non-ASCII platforms, for ranges that span all of 0..255, and ones
17780          * that don't require special handling, we can just add the range like
17781          * we do for ASCII platforms */
17782         if ((UNLIKELY(prevvalue == 0) && value >= 255)
17783             || ! (prevvalue < 256
17784                     && (unicode_range
17785                         || (! non_portable_endpoint
17786                             && ((isLOWER_A(prevvalue) && isLOWER_A(value))
17787                                 || (isUPPER_A(prevvalue)
17788                                     && isUPPER_A(value)))))))
17789         {
17790             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17791                                                         prevvalue, value);
17792         }
17793         else {
17794             /* Here, requires special handling.  This can be because it is a
17795              * range whose code points are considered to be Unicode, and so
17796              * must be individually translated into native, or because its a
17797              * subrange of 'A-Z' or 'a-z' which each aren't contiguous in
17798              * EBCDIC, but we have defined them to include only the "expected"
17799              * upper or lower case ASCII alphabetics.  Subranges above 255 are
17800              * the same in native and Unicode, so can be added as a range */
17801             U8 start = NATIVE_TO_LATIN1(prevvalue);
17802             unsigned j;
17803             U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
17804             for (j = start; j <= end; j++) {
17805                 cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
17806             }
17807             if (value > 255) {
17808                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
17809                                                             256, value);
17810             }
17811         }
17812 #endif
17813
17814         range = 0; /* this range (if it was one) is done now */
17815     } /* End of loop through all the text within the brackets */
17816
17817     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
17818         output_posix_warnings(pRExC_state, posix_warnings);
17819     }
17820
17821     /* If anything in the class expands to more than one character, we have to
17822      * deal with them by building up a substitute parse string, and recursively
17823      * calling reg() on it, instead of proceeding */
17824     if (multi_char_matches) {
17825         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
17826         I32 cp_count;
17827         STRLEN len;
17828         char *save_end = RExC_end;
17829         char *save_parse = RExC_parse;
17830         char *save_start = RExC_start;
17831         Size_t constructed_prefix_len = 0; /* This gives the length of the
17832                                               constructed portion of the
17833                                               substitute parse. */
17834         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
17835                                        a "|" */
17836         I32 reg_flags;
17837
17838         assert(! invert);
17839         /* Only one level of recursion allowed */
17840         assert(RExC_copy_start_in_constructed == RExC_precomp);
17841
17842 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
17843            because too confusing */
17844         if (invert) {
17845             sv_catpvs(substitute_parse, "(?:");
17846         }
17847 #endif
17848
17849         /* Look at the longest folds first */
17850         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
17851                         cp_count > 0;
17852                         cp_count--)
17853         {
17854
17855             if (av_exists(multi_char_matches, cp_count)) {
17856                 AV** this_array_ptr;
17857                 SV* this_sequence;
17858
17859                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
17860                                                  cp_count, FALSE);
17861                 while ((this_sequence = av_pop(*this_array_ptr)) !=
17862                                                                 &PL_sv_undef)
17863                 {
17864                     if (! first_time) {
17865                         sv_catpvs(substitute_parse, "|");
17866                     }
17867                     first_time = FALSE;
17868
17869                     sv_catpv(substitute_parse, SvPVX(this_sequence));
17870                 }
17871             }
17872         }
17873
17874         /* If the character class contains anything else besides these
17875          * multi-character folds, have to include it in recursive parsing */
17876         if (element_count) {
17877             sv_catpvs(substitute_parse, "|[");
17878             constructed_prefix_len = SvCUR(substitute_parse);
17879             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
17880
17881             /* Put in a closing ']' only if not going off the end, as otherwise
17882              * we are adding something that really isn't there */
17883             if (RExC_parse < RExC_end) {
17884                 sv_catpvs(substitute_parse, "]");
17885             }
17886         }
17887
17888         sv_catpvs(substitute_parse, ")");
17889 #if 0
17890         if (invert) {
17891             /* This is a way to get the parse to skip forward a whole named
17892              * sequence instead of matching the 2nd character when it fails the
17893              * first */
17894             sv_catpvs(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
17895         }
17896 #endif
17897
17898         /* Set up the data structure so that any errors will be properly
17899          * reported.  See the comments at the definition of
17900          * REPORT_LOCATION_ARGS for details */
17901         RExC_copy_start_in_input = (char *) orig_parse;
17902         RExC_start = RExC_parse = SvPV(substitute_parse, len);
17903         RExC_copy_start_in_constructed = RExC_start + constructed_prefix_len;
17904         RExC_end = RExC_parse + len;
17905         RExC_in_multi_char_class = 1;
17906
17907         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
17908
17909         *flagp |= reg_flags & (HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_PARSE|NEED_UTF8);
17910
17911         /* And restore so can parse the rest of the pattern */
17912         RExC_parse = save_parse;
17913         RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = save_start;
17914         RExC_end = save_end;
17915         RExC_in_multi_char_class = 0;
17916         SvREFCNT_dec_NN(multi_char_matches);
17917         return ret;
17918     }
17919
17920     /* If folding, we calculate all characters that could fold to or from the
17921      * ones already on the list */
17922     if (cp_foldable_list) {
17923         if (FOLD) {
17924             UV start, end;      /* End points of code point ranges */
17925
17926             SV* fold_intersection = NULL;
17927             SV** use_list;
17928
17929             /* Our calculated list will be for Unicode rules.  For locale
17930              * matching, we have to keep a separate list that is consulted at
17931              * runtime only when the locale indicates Unicode rules (and we
17932              * don't include potential matches in the ASCII/Latin1 range, as
17933              * any code point could fold to any other, based on the run-time
17934              * locale).   For non-locale, we just use the general list */
17935             if (LOC) {
17936                 use_list = &only_utf8_locale_list;
17937             }
17938             else {
17939                 use_list = &cp_list;
17940             }
17941
17942             /* Only the characters in this class that participate in folds need
17943              * be checked.  Get the intersection of this class and all the
17944              * possible characters that are foldable.  This can quickly narrow
17945              * down a large class */
17946             _invlist_intersection(PL_in_some_fold, cp_foldable_list,
17947                                   &fold_intersection);
17948
17949             /* Now look at the foldable characters in this class individually */
17950             invlist_iterinit(fold_intersection);
17951             while (invlist_iternext(fold_intersection, &start, &end)) {
17952                 UV j;
17953                 UV folded;
17954
17955                 /* Look at every character in the range */
17956                 for (j = start; j <= end; j++) {
17957                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
17958                     STRLEN foldlen;
17959                     unsigned int k;
17960                     Size_t folds_count;
17961                     unsigned int first_fold;
17962                     const unsigned int * remaining_folds;
17963
17964                     if (j < 256) {
17965
17966                         /* Under /l, we don't know what code points below 256
17967                          * fold to, except we do know the MICRO SIGN folds to
17968                          * an above-255 character if the locale is UTF-8, so we
17969                          * add it to the special list (in *use_list)  Otherwise
17970                          * we know now what things can match, though some folds
17971                          * are valid under /d only if the target is UTF-8.
17972                          * Those go in a separate list */
17973                         if (      IS_IN_SOME_FOLD_L1(j)
17974                             && ! (LOC && j != MICRO_SIGN))
17975                         {
17976
17977                             /* ASCII is always matched; non-ASCII is matched
17978                              * only under Unicode rules (which could happen
17979                              * under /l if the locale is a UTF-8 one */
17980                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
17981                                 *use_list = add_cp_to_invlist(*use_list,
17982                                                             PL_fold_latin1[j]);
17983                             }
17984                             else if (j != PL_fold_latin1[j]) {
17985                                 upper_latin1_only_utf8_matches
17986                                         = add_cp_to_invlist(
17987                                                 upper_latin1_only_utf8_matches,
17988                                                 PL_fold_latin1[j]);
17989                             }
17990                         }
17991
17992                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
17993                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
17994                         {
17995                             add_above_Latin1_folds(pRExC_state,
17996                                                    (U8) j,
17997                                                    use_list);
17998                         }
17999                         continue;
18000                     }
18001
18002                     /* Here is an above Latin1 character.  We don't have the
18003                      * rules hard-coded for it.  First, get its fold.  This is
18004                      * the simple fold, as the multi-character folds have been
18005                      * handled earlier and separated out */
18006                     folded = _to_uni_fold_flags(j, foldbuf, &foldlen,
18007                                                         (ASCII_FOLD_RESTRICTED)
18008                                                         ? FOLD_FLAGS_NOMIX_ASCII
18009                                                         : 0);
18010
18011                     /* Single character fold of above Latin1.  Add everything
18012                      * in its fold closure to the list that this node should
18013                      * match. */
18014                     folds_count = _inverse_folds(folded, &first_fold,
18015                                                     &remaining_folds);
18016                     for (k = 0; k <= folds_count; k++) {
18017                         UV c = (k == 0)     /* First time through use itself */
18018                                 ? folded
18019                                 : (k == 1)  /* 2nd time use, the first fold */
18020                                    ? first_fold
18021
18022                                      /* Then the remaining ones */
18023                                    : remaining_folds[k-2];
18024
18025                         /* /aa doesn't allow folds between ASCII and non- */
18026                         if ((   ASCII_FOLD_RESTRICTED
18027                             && (isASCII(c) != isASCII(j))))
18028                         {
18029                             continue;
18030                         }
18031
18032                         /* Folds under /l which cross the 255/256 boundary are
18033                          * added to a separate list.  (These are valid only
18034                          * when the locale is UTF-8.) */
18035                         if (c < 256 && LOC) {
18036                             *use_list = add_cp_to_invlist(*use_list, c);
18037                             continue;
18038                         }
18039
18040                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
18041                         {
18042                             cp_list = add_cp_to_invlist(cp_list, c);
18043                         }
18044                         else {
18045                             /* Similarly folds involving non-ascii Latin1
18046                              * characters under /d are added to their list */
18047                             upper_latin1_only_utf8_matches
18048                                     = add_cp_to_invlist(
18049                                                 upper_latin1_only_utf8_matches,
18050                                                 c);
18051                         }
18052                     }
18053                 }
18054             }
18055             SvREFCNT_dec_NN(fold_intersection);
18056         }
18057
18058         /* Now that we have finished adding all the folds, there is no reason
18059          * to keep the foldable list separate */
18060         _invlist_union(cp_list, cp_foldable_list, &cp_list);
18061         SvREFCNT_dec_NN(cp_foldable_list);
18062     }
18063
18064     /* And combine the result (if any) with any inversion lists from posix
18065      * classes.  The lists are kept separate up to now because we don't want to
18066      * fold the classes */
18067     if (simple_posixes) {   /* These are the classes known to be unaffected by
18068                                /a, /aa, and /d */
18069         if (cp_list) {
18070             _invlist_union(cp_list, simple_posixes, &cp_list);
18071             SvREFCNT_dec_NN(simple_posixes);
18072         }
18073         else {
18074             cp_list = simple_posixes;
18075         }
18076     }
18077     if (posixes || nposixes) {
18078         if (! DEPENDS_SEMANTICS) {
18079
18080             /* For everything but /d, we can just add the current 'posixes' and
18081              * 'nposixes' to the main list */
18082             if (posixes) {
18083                 if (cp_list) {
18084                     _invlist_union(cp_list, posixes, &cp_list);
18085                     SvREFCNT_dec_NN(posixes);
18086                 }
18087                 else {
18088                     cp_list = posixes;
18089                 }
18090             }
18091             if (nposixes) {
18092                 if (cp_list) {
18093                     _invlist_union(cp_list, nposixes, &cp_list);
18094                     SvREFCNT_dec_NN(nposixes);
18095                 }
18096                 else {
18097                     cp_list = nposixes;
18098                 }
18099             }
18100         }
18101         else {
18102             /* Under /d, things like \w match upper Latin1 characters only if
18103              * the target string is in UTF-8.  But things like \W match all the
18104              * upper Latin1 characters if the target string is not in UTF-8.
18105              *
18106              * Handle the case with something like \W separately */
18107             if (nposixes) {
18108                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1, NULL);
18109
18110                 /* A complemented posix class matches all upper Latin1
18111                  * characters if not in UTF-8.  And it matches just certain
18112                  * ones when in UTF-8.  That means those certain ones are
18113                  * matched regardless, so can just be added to the
18114                  * unconditional list */
18115                 if (cp_list) {
18116                     _invlist_union(cp_list, nposixes, &cp_list);
18117                     SvREFCNT_dec_NN(nposixes);
18118                     nposixes = NULL;
18119                 }
18120                 else {
18121                     cp_list = nposixes;
18122                 }
18123
18124                 /* Likewise for 'posixes' */
18125                 _invlist_union(posixes, cp_list, &cp_list);
18126
18127                 /* Likewise for anything else in the range that matched only
18128                  * under UTF-8 */
18129                 if (upper_latin1_only_utf8_matches) {
18130                     _invlist_union(cp_list,
18131                                    upper_latin1_only_utf8_matches,
18132                                    &cp_list);
18133                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
18134                     upper_latin1_only_utf8_matches = NULL;
18135                 }
18136
18137                 /* If we don't match all the upper Latin1 characters regardless
18138                  * of UTF-8ness, we have to set a flag to match the rest when
18139                  * not in UTF-8 */
18140                 _invlist_subtract(only_non_utf8_list, cp_list,
18141                                   &only_non_utf8_list);
18142                 if (_invlist_len(only_non_utf8_list) != 0) {
18143                     anyof_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18144                 }
18145                 SvREFCNT_dec_NN(only_non_utf8_list);
18146             }
18147             else {
18148                 /* Here there were no complemented posix classes.  That means
18149                  * the upper Latin1 characters in 'posixes' match only when the
18150                  * target string is in UTF-8.  So we have to add them to the
18151                  * list of those types of code points, while adding the
18152                  * remainder to the unconditional list.
18153                  *
18154                  * First calculate what they are */
18155                 SV* nonascii_but_latin1_properties = NULL;
18156                 _invlist_intersection(posixes, PL_UpperLatin1,
18157                                       &nonascii_but_latin1_properties);
18158
18159                 /* And add them to the final list of such characters. */
18160                 _invlist_union(upper_latin1_only_utf8_matches,
18161                                nonascii_but_latin1_properties,
18162                                &upper_latin1_only_utf8_matches);
18163
18164                 /* Remove them from what now becomes the unconditional list */
18165                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
18166                                   &posixes);
18167
18168                 /* And add those unconditional ones to the final list */
18169                 if (cp_list) {
18170                     _invlist_union(cp_list, posixes, &cp_list);
18171                     SvREFCNT_dec_NN(posixes);
18172                     posixes = NULL;
18173                 }
18174                 else {
18175                     cp_list = posixes;
18176                 }
18177
18178                 SvREFCNT_dec(nonascii_but_latin1_properties);
18179
18180                 /* Get rid of any characters from the conditional list that we
18181                  * now know are matched unconditionally, which may make that
18182                  * list empty */
18183                 _invlist_subtract(upper_latin1_only_utf8_matches,
18184                                   cp_list,
18185                                   &upper_latin1_only_utf8_matches);
18186                 if (_invlist_len(upper_latin1_only_utf8_matches) == 0) {
18187                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
18188                     upper_latin1_only_utf8_matches = NULL;
18189                 }
18190             }
18191         }
18192     }
18193
18194     /* And combine the result (if any) with any inversion list from properties.
18195      * The lists are kept separate up to now so that we can distinguish the two
18196      * in regards to matching above-Unicode.  A run-time warning is generated
18197      * if a Unicode property is matched against a non-Unicode code point. But,
18198      * we allow user-defined properties to match anything, without any warning,
18199      * and we also suppress the warning if there is a portion of the character
18200      * class that isn't a Unicode property, and which matches above Unicode, \W
18201      * or [\x{110000}] for example.
18202      * (Note that in this case, unlike the Posix one above, there is no
18203      * <upper_latin1_only_utf8_matches>, because having a Unicode property
18204      * forces Unicode semantics */
18205     if (properties) {
18206         if (cp_list) {
18207
18208             /* If it matters to the final outcome, see if a non-property
18209              * component of the class matches above Unicode.  If so, the
18210              * warning gets suppressed.  This is true even if just a single
18211              * such code point is specified, as, though not strictly correct if
18212              * another such code point is matched against, the fact that they
18213              * are using above-Unicode code points indicates they should know
18214              * the issues involved */
18215             if (warn_super) {
18216                 warn_super = ! (invert
18217                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
18218             }
18219
18220             _invlist_union(properties, cp_list, &cp_list);
18221             SvREFCNT_dec_NN(properties);
18222         }
18223         else {
18224             cp_list = properties;
18225         }
18226
18227         if (warn_super) {
18228             anyof_flags
18229              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
18230
18231             /* Because an ANYOF node is the only one that warns, this node
18232              * can't be optimized into something else */
18233             optimizable = FALSE;
18234         }
18235     }
18236
18237     /* Here, we have calculated what code points should be in the character
18238      * class.
18239      *
18240      * Now we can see about various optimizations.  Fold calculation (which we
18241      * did above) needs to take place before inversion.  Otherwise /[^k]/i
18242      * would invert to include K, which under /i would match k, which it
18243      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
18244      * folded until runtime */
18245
18246     /* If we didn't do folding, it's because some information isn't available
18247      * until runtime; set the run-time fold flag for these  We know to set the
18248      * flag if we have a non-NULL list for UTF-8 locales, or the class matches
18249      * at least one 0-255 range code point */
18250     if (LOC && FOLD) {
18251
18252         /* Some things on the list might be unconditionally included because of
18253          * other components.  Remove them, and clean up the list if it goes to
18254          * 0 elements */
18255         if (only_utf8_locale_list && cp_list) {
18256             _invlist_subtract(only_utf8_locale_list, cp_list,
18257                               &only_utf8_locale_list);
18258
18259             if (_invlist_len(only_utf8_locale_list) == 0) {
18260                 SvREFCNT_dec_NN(only_utf8_locale_list);
18261                 only_utf8_locale_list = NULL;
18262             }
18263         }
18264         if (    only_utf8_locale_list
18265             || (cp_list && (   _invlist_contains_cp(cp_list, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE)
18266                             || _invlist_contains_cp(cp_list, LATIN_SMALL_LETTER_DOTLESS_I))))
18267         {
18268             has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
18269             anyof_flags
18270                  |= ANYOFL_FOLD
18271                  |  ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
18272         }
18273         else if (cp_list) { /* Look to see if a 0-255 code point is in list */
18274             UV start, end;
18275             invlist_iterinit(cp_list);
18276             if (invlist_iternext(cp_list, &start, &end) && start < 256) {
18277                 anyof_flags |= ANYOFL_FOLD;
18278                 has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
18279             }
18280             invlist_iterfinish(cp_list);
18281         }
18282     }
18283     else if (   DEPENDS_SEMANTICS
18284              && (    upper_latin1_only_utf8_matches
18285                  || (anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
18286     {
18287         RExC_seen_d_op = TRUE;
18288         has_runtime_dependency |= HAS_D_RUNTIME_DEPENDENCY;
18289     }
18290
18291     /* Optimize inverted patterns (e.g. [^a-z]) when everything is known at
18292      * compile time. */
18293     if (     cp_list
18294         &&   invert
18295         && ! has_runtime_dependency)
18296     {
18297         _invlist_invert(cp_list);
18298
18299         /* Clear the invert flag since have just done it here */
18300         invert = FALSE;
18301     }
18302
18303     if (ret_invlist) {
18304         *ret_invlist = cp_list;
18305
18306         return RExC_emit;
18307     }
18308
18309     /* All possible optimizations below still have these characteristics.
18310      * (Multi-char folds aren't SIMPLE, but they don't get this far in this
18311      * routine) */
18312     *flagp |= HASWIDTH|SIMPLE;
18313
18314     if (anyof_flags & ANYOF_LOCALE_FLAGS) {
18315         RExC_contains_locale = 1;
18316     }
18317
18318     /* Some character classes are equivalent to other nodes.  Such nodes take
18319      * up less room, and some nodes require fewer operations to execute, than
18320      * ANYOF nodes.  EXACTish nodes may be joinable with adjacent nodes to
18321      * improve efficiency. */
18322
18323     if (optimizable) {
18324         PERL_UINT_FAST8_T i;
18325         Size_t partial_cp_count = 0;
18326         UV start[MAX_FOLD_FROMS+1] = { 0 }; /* +1 for the folded-to char */
18327         UV   end[MAX_FOLD_FROMS+1] = { 0 };
18328
18329         if (cp_list) { /* Count the code points in enough ranges that we would
18330                           see all the ones possible in any fold in this version
18331                           of Unicode */
18332
18333             invlist_iterinit(cp_list);
18334             for (i = 0; i <= MAX_FOLD_FROMS; i++) {
18335                 if (! invlist_iternext(cp_list, &start[i], &end[i])) {
18336                     break;
18337                 }
18338                 partial_cp_count += end[i] - start[i] + 1;
18339             }
18340
18341             invlist_iterfinish(cp_list);
18342         }
18343
18344         /* If we know at compile time that this matches every possible code
18345          * point, any run-time dependencies don't matter */
18346         if (start[0] == 0 && end[0] == UV_MAX) {
18347             if (invert) {
18348                 ret = reganode(pRExC_state, OPFAIL, 0);
18349             }
18350             else {
18351                 ret = reg_node(pRExC_state, SANY);
18352                 MARK_NAUGHTY(1);
18353             }
18354             goto not_anyof;
18355         }
18356
18357         /* Similarly, for /l posix classes, if both a class and its
18358          * complement match, any run-time dependencies don't matter */
18359         if (posixl) {
18360             for (namedclass = 0; namedclass < ANYOF_POSIXL_MAX;
18361                                                         namedclass += 2)
18362             {
18363                 if (   POSIXL_TEST(posixl, namedclass)      /* class */
18364                     && POSIXL_TEST(posixl, namedclass + 1)) /* its complement */
18365                 {
18366                     if (invert) {
18367                         ret = reganode(pRExC_state, OPFAIL, 0);
18368                     }
18369                     else {
18370                         ret = reg_node(pRExC_state, SANY);
18371                         MARK_NAUGHTY(1);
18372                     }
18373                     goto not_anyof;
18374                 }
18375             }
18376             /* For well-behaved locales, some classes are subsets of others,
18377              * so complementing the subset and including the non-complemented
18378              * superset should match everything, like [\D[:alnum:]], and
18379              * [[:^alpha:][:alnum:]], but some implementations of locales are
18380              * buggy, and khw thinks its a bad idea to have optimization change
18381              * behavior, even if it avoids an OS bug in a given case */
18382
18383 #define isSINGLE_BIT_SET(n) isPOWER_OF_2(n)
18384
18385             /* If is a single posix /l class, can optimize to just that op.
18386              * Such a node will not match anything in the Latin1 range, as that
18387              * is not determinable until runtime, but will match whatever the
18388              * class does outside that range.  (Note that some classes won't
18389              * match anything outside the range, like [:ascii:]) */
18390             if (    isSINGLE_BIT_SET(posixl)
18391                 && (partial_cp_count == 0 || start[0] > 255))
18392             {
18393                 U8 classnum;
18394                 SV * class_above_latin1 = NULL;
18395                 bool already_inverted;
18396                 bool are_equivalent;
18397
18398                 /* Compute which bit is set, which is the same thing as, e.g.,
18399                  * ANYOF_CNTRL.  From
18400                  * https://graphics.stanford.edu/~seander/bithacks.html#IntegerLogDeBruijn
18401                  * */
18402                 static const int MultiplyDeBruijnBitPosition2[32] =
18403                     {
18404                     0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8,
18405                     31, 27, 13, 23, 21, 19, 16, 7, 26, 12, 18, 6, 11, 5, 10, 9
18406                     };
18407
18408                 namedclass = MultiplyDeBruijnBitPosition2[(posixl
18409                                                           * 0x077CB531U) >> 27];
18410                 classnum = namedclass_to_classnum(namedclass);
18411
18412                 /* The named classes are such that the inverted number is one
18413                  * larger than the non-inverted one */
18414                 already_inverted = namedclass
18415                                  - classnum_to_namedclass(classnum);
18416
18417                 /* Create an inversion list of the official property, inverted
18418                  * if the constructed node list is inverted, and restricted to
18419                  * only the above latin1 code points, which are the only ones
18420                  * known at compile time */
18421                 _invlist_intersection_maybe_complement_2nd(
18422                                                     PL_AboveLatin1,
18423                                                     PL_XPosix_ptrs[classnum],
18424                                                     already_inverted,
18425                                                     &class_above_latin1);
18426                 are_equivalent = _invlistEQ(class_above_latin1, cp_list,
18427                                                                         FALSE);
18428                 SvREFCNT_dec_NN(class_above_latin1);
18429
18430                 if (are_equivalent) {
18431
18432                     /* Resolve the run-time inversion flag with this possibly
18433                      * inverted class */
18434                     invert = invert ^ already_inverted;
18435
18436                     ret = reg_node(pRExC_state,
18437                                    POSIXL + invert * (NPOSIXL - POSIXL));
18438                     FLAGS(REGNODE_p(ret)) = classnum;
18439                     goto not_anyof;
18440                 }
18441             }
18442         }
18443
18444         /* khw can't think of any other possible transformation involving
18445          * these. */
18446         if (has_runtime_dependency & HAS_USER_DEFINED_PROPERTY) {
18447             goto is_anyof;
18448         }
18449
18450         if (! has_runtime_dependency) {
18451
18452             /* If the list is empty, nothing matches.  This happens, for
18453              * example, when a Unicode property that doesn't match anything is
18454              * the only element in the character class (perluniprops.pod notes
18455              * such properties). */
18456             if (partial_cp_count == 0) {
18457                 if (invert) {
18458                     ret = reg_node(pRExC_state, SANY);
18459                 }
18460                 else {
18461                     ret = reganode(pRExC_state, OPFAIL, 0);
18462                 }
18463
18464                 goto not_anyof;
18465             }
18466
18467             /* If matches everything but \n */
18468             if (   start[0] == 0 && end[0] == '\n' - 1
18469                 && start[1] == '\n' + 1 && end[1] == UV_MAX)
18470             {
18471                 assert (! invert);
18472                 ret = reg_node(pRExC_state, REG_ANY);
18473                 MARK_NAUGHTY(1);
18474                 goto not_anyof;
18475             }
18476         }
18477
18478         /* Next see if can optimize classes that contain just a few code points
18479          * into an EXACTish node.  The reason to do this is to let the
18480          * optimizer join this node with adjacent EXACTish ones.
18481          *
18482          * An EXACTFish node can be generated even if not under /i, and vice
18483          * versa.  But care must be taken.  An EXACTFish node has to be such
18484          * that it only matches precisely the code points in the class, but we
18485          * want to generate the least restrictive one that does that, to
18486          * increase the odds of being able to join with an adjacent node.  For
18487          * example, if the class contains [kK], we have to make it an EXACTFAA
18488          * node to prevent the KELVIN SIGN from matching.  Whether we are under
18489          * /i or not is irrelevant in this case.  Less obvious is the pattern
18490          * qr/[\x{02BC}]n/i.  U+02BC is MODIFIER LETTER APOSTROPHE. That is
18491          * supposed to match the single character U+0149 LATIN SMALL LETTER N
18492          * PRECEDED BY APOSTROPHE.  And so even though there is no simple fold
18493          * that includes \X{02BC}, there is a multi-char fold that does, and so
18494          * the node generated for it must be an EXACTFish one.  On the other
18495          * hand qr/:/i should generate a plain EXACT node since the colon
18496          * participates in no fold whatsoever, and having it EXACT tells the
18497          * optimizer the target string cannot match unless it has a colon in
18498          * it.
18499          *
18500          * We don't typically generate an EXACTish node if doing so would
18501          * require changing the pattern to UTF-8, as that affects /d and
18502          * otherwise is slower.  However, under /i, not changing to UTF-8 can
18503          * miss some potential multi-character folds.  We calculate the
18504          * EXACTish node, and then decide if something would be missed if we
18505          * don't upgrade */
18506         if (   ! posixl
18507             && ! invert
18508
18509                 /* Only try if there are no more code points in the class than
18510                  * in the max possible fold */
18511             &&   partial_cp_count > 0 && partial_cp_count <= MAX_FOLD_FROMS + 1
18512
18513             && (start[0] < 256 || UTF || FOLD))
18514         {
18515             if (partial_cp_count == 1 && ! upper_latin1_only_utf8_matches)
18516             {
18517                 /* We can always make a single code point class into an
18518                  * EXACTish node. */
18519
18520                 if (LOC) {
18521
18522                     /* Here is /l:  Use EXACTL, except /li indicates EXACTFL,
18523                      * as that means there is a fold not known until runtime so
18524                      * shows as only a single code point here. */
18525                     op = (FOLD) ? EXACTFL : EXACTL;
18526                 }
18527                 else if (! FOLD) { /* Not /l and not /i */
18528                     op = (start[0] < 256) ? EXACT : EXACT_ONLY8;
18529                 }
18530                 else if (start[0] < 256) { /* /i, not /l, and the code point is
18531                                               small */
18532
18533                     /* Under /i, it gets a little tricky.  A code point that
18534                      * doesn't participate in a fold should be an EXACT node.
18535                      * We know this one isn't the result of a simple fold, or
18536                      * there'd be more than one code point in the list, but it
18537                      * could be part of a multi- character fold.  In that case
18538                      * we better not create an EXACT node, as we would wrongly
18539                      * be telling the optimizer that this code point must be in
18540                      * the target string, and that is wrong.  This is because
18541                      * if the sequence around this code point forms a
18542                      * multi-char fold, what needs to be in the string could be
18543                      * the code point that folds to the sequence.
18544                      *
18545                      * This handles the case of below-255 code points, as we
18546                      * have an easy look up for those.  The next clause handles
18547                      * the above-256 one */
18548                     op = IS_IN_SOME_FOLD_L1(start[0])
18549                          ? EXACTFU
18550                          : EXACT;
18551                 }
18552                 else {  /* /i, larger code point.  Since we are under /i, and
18553                            have just this code point, we know that it can't
18554                            fold to something else, so PL_InMultiCharFold
18555                            applies to it */
18556                     op = _invlist_contains_cp(PL_InMultiCharFold,
18557                                               start[0])
18558                          ? EXACTFU_ONLY8
18559                          : EXACT_ONLY8;
18560                 }
18561
18562                 value = start[0];
18563             }
18564             else if (  ! (has_runtime_dependency & ~HAS_D_RUNTIME_DEPENDENCY)
18565                      && _invlist_contains_cp(PL_in_some_fold, start[0]))
18566             {
18567                 /* Here, the only runtime dependency, if any, is from /d, and
18568                  * the class matches more than one code point, and the lowest
18569                  * code point participates in some fold.  It might be that the
18570                  * other code points are /i equivalent to this one, and hence
18571                  * they would representable by an EXACTFish node.  Above, we
18572                  * eliminated classes that contain too many code points to be
18573                  * EXACTFish, with the test for MAX_FOLD_FROMS
18574                  *
18575                  * First, special case the ASCII fold pairs, like 'B' and 'b'.
18576                  * We do this because we have EXACTFAA at our disposal for the
18577                  * ASCII range */
18578                 if (partial_cp_count == 2 && isASCII(start[0])) {
18579
18580                     /* The only ASCII characters that participate in folds are
18581                      * alphabetics */
18582                     assert(isALPHA(start[0]));
18583                     if (   end[0] == start[0]   /* First range is a single
18584                                                    character, so 2nd exists */
18585                         && isALPHA_FOLD_EQ(start[0], start[1]))
18586                     {
18587
18588                         /* Here, is part of an ASCII fold pair */
18589
18590                         if (   ASCII_FOLD_RESTRICTED
18591                             || HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(start[0]))
18592                         {
18593                             /* If the second clause just above was true, it
18594                              * means we can't be under /i, or else the list
18595                              * would have included more than this fold pair.
18596                              * Therefore we have to exclude the possibility of
18597                              * whatever else it is that folds to these, by
18598                              * using EXACTFAA */
18599                             op = EXACTFAA;
18600                         }
18601                         else if (HAS_NONLATIN1_FOLD_CLOSURE(start[0])) {
18602
18603                             /* Here, there's no simple fold that start[0] is part
18604                              * of, but there is a multi-character one.  If we
18605                              * are not under /i, we want to exclude that
18606                              * possibility; if under /i, we want to include it
18607                              * */
18608                             op = (FOLD) ? EXACTFU : EXACTFAA;
18609                         }
18610                         else {
18611
18612                             /* Here, the only possible fold start[0] particpates in
18613                              * is with start[1].  /i or not isn't relevant */
18614                             op = EXACTFU;
18615                         }
18616
18617                         value = toFOLD(start[0]);
18618                     }
18619                 }
18620                 else if (  ! upper_latin1_only_utf8_matches
18621                          || (   _invlist_len(upper_latin1_only_utf8_matches)
18622                                                                           == 2
18623                              && PL_fold_latin1[
18624                                invlist_highest(upper_latin1_only_utf8_matches)]
18625                              == start[0]))
18626                 {
18627                     /* Here, the smallest character is non-ascii or there are
18628                      * more than 2 code points matched by this node.  Also, we
18629                      * either don't have /d UTF-8 dependent matches, or if we
18630                      * do, they look like they could be a single character that
18631                      * is the fold of the lowest one in the always-match list.
18632                      * This test quickly excludes most of the false positives
18633                      * when there are /d UTF-8 depdendent matches.  These are
18634                      * like LATIN CAPITAL LETTER A WITH GRAVE matching LATIN
18635                      * SMALL LETTER A WITH GRAVE iff the target string is
18636                      * UTF-8.  (We don't have to worry above about exceeding
18637                      * the array bounds of PL_fold_latin1[] because any code
18638                      * point in 'upper_latin1_only_utf8_matches' is below 256.)
18639                      *
18640                      * EXACTFAA would apply only to pairs (hence exactly 2 code
18641                      * points) in the ASCII range, so we can't use it here to
18642                      * artificially restrict the fold domain, so we check if
18643                      * the class does or does not match some EXACTFish node.
18644                      * Further, if we aren't under /i, and and the folded-to
18645                      * character is part of a multi-character fold, we can't do
18646                      * this optimization, as the sequence around it could be
18647                      * that multi-character fold, and we don't here know the
18648                      * context, so we have to assume it is that multi-char
18649                      * fold, to prevent potential bugs.
18650                      *
18651                      * To do the general case, we first find the fold of the
18652                      * lowest code point (which may be higher than the lowest
18653                      * one), then find everything that folds to it.  (The data
18654                      * structure we have only maps from the folded code points,
18655                      * so we have to do the earlier step.) */
18656
18657                     Size_t foldlen;
18658                     U8 foldbuf[UTF8_MAXBYTES_CASE];
18659                     UV folded = _to_uni_fold_flags(start[0],
18660                                                         foldbuf, &foldlen, 0);
18661                     unsigned int first_fold;
18662                     const unsigned int * remaining_folds;
18663                     Size_t folds_to_this_cp_count = _inverse_folds(
18664                                                             folded,
18665                                                             &first_fold,
18666                                                             &remaining_folds);
18667                     Size_t folds_count = folds_to_this_cp_count + 1;
18668                     SV * fold_list = _new_invlist(folds_count);
18669                     unsigned int i;
18670
18671                     /* If there are UTF-8 dependent matches, create a temporary
18672                      * list of what this node matches, including them. */
18673                     SV * all_cp_list = NULL;
18674                     SV ** use_this_list = &cp_list;
18675
18676                     if (upper_latin1_only_utf8_matches) {
18677                         all_cp_list = _new_invlist(0);
18678                         use_this_list = &all_cp_list;
18679                         _invlist_union(cp_list,
18680                                        upper_latin1_only_utf8_matches,
18681                                        use_this_list);
18682                     }
18683
18684                     /* Having gotten everything that participates in the fold
18685                      * containing the lowest code point, we turn that into an
18686                      * inversion list, making sure everything is included. */
18687                     fold_list = add_cp_to_invlist(fold_list, start[0]);
18688                     fold_list = add_cp_to_invlist(fold_list, folded);
18689                     if (folds_to_this_cp_count > 0) {
18690                         fold_list = add_cp_to_invlist(fold_list, first_fold);
18691                         for (i = 0; i + 1 < folds_to_this_cp_count; i++) {
18692                             fold_list = add_cp_to_invlist(fold_list,
18693                                                         remaining_folds[i]);
18694                         }
18695                     }
18696
18697                     /* If the fold list is identical to what's in this ANYOF
18698                      * node, the node can be represented by an EXACTFish one
18699                      * instead */
18700                     if (_invlistEQ(*use_this_list, fold_list,
18701                                    0 /* Don't complement */ )
18702                     ) {
18703
18704                         /* But, we have to be careful, as mentioned above.
18705                          * Just the right sequence of characters could match
18706                          * this if it is part of a multi-character fold.  That
18707                          * IS what we want if we are under /i.  But it ISN'T
18708                          * what we want if not under /i, as it could match when
18709                          * it shouldn't.  So, when we aren't under /i and this
18710                          * character participates in a multi-char fold, we
18711                          * don't optimize into an EXACTFish node.  So, for each
18712                          * case below we have to check if we are folding
18713                          * and if not, if it is not part of a multi-char fold.
18714                          * */
18715                         if (start[0] > 255) {    /* Highish code point */
18716                             if (FOLD || ! _invlist_contains_cp(
18717                                             PL_InMultiCharFold, folded))
18718                             {
18719                                 op = (LOC)
18720                                      ? EXACTFLU8
18721                                      : (ASCII_FOLD_RESTRICTED)
18722                                        ? EXACTFAA
18723                                        : EXACTFU_ONLY8;
18724                                 value = folded;
18725                             }
18726                         }   /* Below, the lowest code point < 256 */
18727                         else if (    FOLD
18728                                  &&  folded == 's'
18729                                  &&  DEPENDS_SEMANTICS)
18730                         {   /* An EXACTF node containing a single character
18731                                 's', can be an EXACTFU if it doesn't get
18732                                 joined with an adjacent 's' */
18733                             op = EXACTFU_S_EDGE;
18734                             value = folded;
18735                         }
18736                         else if (    FOLD
18737                                 || ! HAS_NONLATIN1_FOLD_CLOSURE(start[0]))
18738                         {
18739                             if (upper_latin1_only_utf8_matches) {
18740                                 op = EXACTF;
18741
18742                                 /* We can't use the fold, as that only matches
18743                                  * under UTF-8 */
18744                                 value = start[0];
18745                             }
18746                             else if (     UNLIKELY(start[0] == MICRO_SIGN)
18747                                      && ! UTF)
18748                             {   /* EXACTFUP is a special node for this
18749                                    character */
18750                                 op = (ASCII_FOLD_RESTRICTED)
18751                                      ? EXACTFAA
18752                                      : EXACTFUP;
18753                                 value = MICRO_SIGN;
18754                             }
18755                             else if (     ASCII_FOLD_RESTRICTED
18756                                      && ! isASCII(start[0]))
18757                             {   /* For ASCII under /iaa, we can use EXACTFU
18758                                    below */
18759                                 op = EXACTFAA;
18760                                 value = folded;
18761                             }
18762                             else {
18763                                 op = EXACTFU;
18764                                 value = folded;
18765                             }
18766                         }
18767                     }
18768
18769                     SvREFCNT_dec_NN(fold_list);
18770                     SvREFCNT_dec(all_cp_list);
18771                 }
18772             }
18773
18774             if (op != END) {
18775
18776                 /* Here, we have calculated what EXACTish node we would use.
18777                  * But we don't use it if it would require converting the
18778                  * pattern to UTF-8, unless not using it could cause us to miss
18779                  * some folds (hence be buggy) */
18780
18781                 if (! UTF && value > 255) {
18782                     SV * in_multis = NULL;
18783
18784                     assert(FOLD);
18785
18786                     /* If there is no code point that is part of a multi-char
18787                      * fold, then there aren't any matches, so we don't do this
18788                      * optimization.  Otherwise, it could match depending on
18789                      * the context around us, so we do upgrade */
18790                     _invlist_intersection(PL_InMultiCharFold, cp_list, &in_multis);
18791                     if (UNLIKELY(_invlist_len(in_multis) != 0)) {
18792                         REQUIRE_UTF8(flagp);
18793                     }
18794                     else {
18795                         op = END;
18796                     }
18797                 }
18798
18799                 if (op != END) {
18800                     U8 len = (UTF) ? UVCHR_SKIP(value) : 1;
18801
18802                     ret = regnode_guts(pRExC_state, op, len, "exact");
18803                     FILL_NODE(ret, op);
18804                     RExC_emit += 1 + STR_SZ(len);
18805                     STR_LEN(REGNODE_p(ret)) = len;
18806                     if (len == 1) {
18807                         *STRING(REGNODE_p(ret)) = (U8) value;
18808                     }
18809                     else {
18810                         uvchr_to_utf8((U8 *) STRING(REGNODE_p(ret)), value);
18811                     }
18812                     goto not_anyof;
18813                 }
18814             }
18815         }
18816
18817         if (! has_runtime_dependency) {
18818
18819             /* See if this can be turned into an ANYOFM node.  Think about the
18820              * bit patterns in two different bytes.  In some positions, the
18821              * bits in each will be 1; and in other positions both will be 0;
18822              * and in some positions the bit will be 1 in one byte, and 0 in
18823              * the other.  Let 'n' be the number of positions where the bits
18824              * differ.  We create a mask which has exactly 'n' 0 bits, each in
18825              * a position where the two bytes differ.  Now take the set of all
18826              * bytes that when ANDed with the mask yield the same result.  That
18827              * set has 2**n elements, and is representable by just two 8 bit
18828              * numbers: the result and the mask.  Importantly, matching the set
18829              * can be vectorized by creating a word full of the result bytes,
18830              * and a word full of the mask bytes, yielding a significant speed
18831              * up.  Here, see if this node matches such a set.  As a concrete
18832              * example consider [01], and the byte representing '0' which is
18833              * 0x30 on ASCII machines.  It has the bits 0011 0000.  Take the
18834              * mask 1111 1110.  If we AND 0x31 and 0x30 with that mask we get
18835              * 0x30.  Any other bytes ANDed yield something else.  So [01],
18836              * which is a common usage, is optimizable into ANYOFM, and can
18837              * benefit from the speed up.  We can only do this on UTF-8
18838              * invariant bytes, because they have the same bit patterns under
18839              * UTF-8 as not. */
18840             PERL_UINT_FAST8_T inverted = 0;
18841 #ifdef EBCDIC
18842             const PERL_UINT_FAST8_T max_permissible = 0xFF;
18843 #else
18844             const PERL_UINT_FAST8_T max_permissible = 0x7F;
18845 #endif
18846             /* If doesn't fit the criteria for ANYOFM, invert and try again.
18847              * If that works we will instead later generate an NANYOFM, and
18848              * invert back when through */
18849             if (invlist_highest(cp_list) > max_permissible) {
18850                 _invlist_invert(cp_list);
18851                 inverted = 1;
18852             }
18853
18854             if (invlist_highest(cp_list) <= max_permissible) {
18855                 UV this_start, this_end;
18856                 UV lowest_cp = UV_MAX;  /* inited to suppress compiler warn */
18857                 U8 bits_differing = 0;
18858                 Size_t full_cp_count = 0;
18859                 bool first_time = TRUE;
18860
18861                 /* Go through the bytes and find the bit positions that differ
18862                  * */
18863                 invlist_iterinit(cp_list);
18864                 while (invlist_iternext(cp_list, &this_start, &this_end)) {
18865                     unsigned int i = this_start;
18866
18867                     if (first_time) {
18868                         if (! UVCHR_IS_INVARIANT(i)) {
18869                             goto done_anyofm;
18870                         }
18871
18872                         first_time = FALSE;
18873                         lowest_cp = this_start;
18874
18875                         /* We have set up the code point to compare with.
18876                          * Don't compare it with itself */
18877                         i++;
18878                     }
18879
18880                     /* Find the bit positions that differ from the lowest code
18881                      * point in the node.  Keep track of all such positions by
18882                      * OR'ing */
18883                     for (; i <= this_end; i++) {
18884                         if (! UVCHR_IS_INVARIANT(i)) {
18885                             goto done_anyofm;
18886                         }
18887
18888                         bits_differing  |= i ^ lowest_cp;
18889                     }
18890
18891                     full_cp_count += this_end - this_start + 1;
18892                 }
18893
18894                 /* At the end of the loop, we count how many bits differ from
18895                  * the bits in lowest code point, call the count 'd'.  If the
18896                  * set we found contains 2**d elements, it is the closure of
18897                  * all code points that differ only in those bit positions.  To
18898                  * convince yourself of that, first note that the number in the
18899                  * closure must be a power of 2, which we test for.  The only
18900                  * way we could have that count and it be some differing set,
18901                  * is if we got some code points that don't differ from the
18902                  * lowest code point in any position, but do differ from each
18903                  * other in some other position.  That means one code point has
18904                  * a 1 in that position, and another has a 0.  But that would
18905                  * mean that one of them differs from the lowest code point in
18906                  * that position, which possibility we've already excluded.  */
18907                 if (  (inverted || full_cp_count > 1)
18908                     && full_cp_count == 1U << PL_bitcount[bits_differing])
18909                 {
18910                     U8 ANYOFM_mask;
18911
18912                     op = ANYOFM + inverted;;
18913
18914                     /* We need to make the bits that differ be 0's */
18915                     ANYOFM_mask = ~ bits_differing; /* This goes into FLAGS */
18916
18917                     /* The argument is the lowest code point */
18918                     ret = reganode(pRExC_state, op, lowest_cp);
18919                     FLAGS(REGNODE_p(ret)) = ANYOFM_mask;
18920                 }
18921
18922               done_anyofm:
18923                 invlist_iterfinish(cp_list);
18924             }
18925
18926             if (inverted) {
18927                 _invlist_invert(cp_list);
18928             }
18929
18930             if (op != END) {
18931                 goto not_anyof;
18932             }
18933         }
18934
18935         if (! (anyof_flags & ANYOF_LOCALE_FLAGS)) {
18936             PERL_UINT_FAST8_T type;
18937             SV * intersection = NULL;
18938             SV* d_invlist = NULL;
18939
18940             /* See if this matches any of the POSIX classes.  The POSIXA and
18941              * POSIXD ones are about the same speed as ANYOF ops, but take less
18942              * room; the ones that have above-Latin1 code point matches are
18943              * somewhat faster than ANYOF.  */
18944
18945             for (type = POSIXA; type >= POSIXD; type--) {
18946                 int posix_class;
18947
18948                 if (type == POSIXL) {   /* But not /l posix classes */
18949                     continue;
18950                 }
18951
18952                 for (posix_class = 0;
18953                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
18954                      posix_class++)
18955                 {
18956                     SV** our_code_points = &cp_list;
18957                     SV** official_code_points;
18958                     int try_inverted;
18959
18960                     if (type == POSIXA) {
18961                         official_code_points = &PL_Posix_ptrs[posix_class];
18962                     }
18963                     else {
18964                         official_code_points = &PL_XPosix_ptrs[posix_class];
18965                     }
18966
18967                     /* Skip non-existent classes of this type.  e.g. \v only
18968                      * has an entry in PL_XPosix_ptrs */
18969                     if (! *official_code_points) {
18970                         continue;
18971                     }
18972
18973                     /* Try both the regular class, and its inversion */
18974                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
18975                         bool this_inverted = invert ^ try_inverted;
18976
18977                         if (type != POSIXD) {
18978
18979                             /* This class that isn't /d can't match if we have
18980                              * /d dependencies */
18981                             if (has_runtime_dependency
18982                                                     & HAS_D_RUNTIME_DEPENDENCY)
18983                             {
18984                                 continue;
18985                             }
18986                         }
18987                         else /* is /d */ if (! this_inverted) {
18988
18989                             /* /d classes don't match anything non-ASCII below
18990                              * 256 unconditionally (which cp_list contains) */
18991                             _invlist_intersection(cp_list, PL_UpperLatin1,
18992                                                            &intersection);
18993                             if (_invlist_len(intersection) != 0) {
18994                                 continue;
18995                             }
18996
18997                             SvREFCNT_dec(d_invlist);
18998                             d_invlist = invlist_clone(cp_list, NULL);
18999
19000                             /* But under UTF-8 it turns into using /u rules.
19001                              * Add the things it matches under these conditions
19002                              * so that we check below that these are identical
19003                              * to what the tested class should match */
19004                             if (upper_latin1_only_utf8_matches) {
19005                                 _invlist_union(
19006                                             d_invlist,
19007                                             upper_latin1_only_utf8_matches,
19008                                             &d_invlist);
19009                             }
19010                             our_code_points = &d_invlist;
19011                         }
19012                         else {  /* POSIXD, inverted.  If this doesn't have this
19013                                    flag set, it isn't /d. */
19014                             if (! (anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
19015                             {
19016                                 continue;
19017                             }
19018                             our_code_points = &cp_list;
19019                         }
19020
19021                         /* Here, have weeded out some things.  We want to see
19022                          * if the list of characters this node contains
19023                          * ('*our_code_points') precisely matches those of the
19024                          * class we are currently checking against
19025                          * ('*official_code_points'). */
19026                         if (_invlistEQ(*our_code_points,
19027                                        *official_code_points,
19028                                        try_inverted))
19029                         {
19030                             /* Here, they precisely match.  Optimize this ANYOF
19031                              * node into its equivalent POSIX one of the
19032                              * correct type, possibly inverted */
19033                             ret = reg_node(pRExC_state, (try_inverted)
19034                                                         ? type + NPOSIXA
19035                                                                 - POSIXA
19036                                                         : type);
19037                             FLAGS(REGNODE_p(ret)) = posix_class;
19038                             SvREFCNT_dec(d_invlist);
19039                             SvREFCNT_dec(intersection);
19040                             goto not_anyof;
19041                         }
19042                     }
19043                 }
19044             }
19045             SvREFCNT_dec(d_invlist);
19046             SvREFCNT_dec(intersection);
19047         }
19048
19049         /* If didn't find an optimization and there is no need for a bitmap,
19050          * optimize to indicate that */
19051         if (     start[0] >= NUM_ANYOF_CODE_POINTS
19052             && ! LOC
19053             && ! upper_latin1_only_utf8_matches
19054             &&   anyof_flags == 0)
19055         {
19056             U8 low_utf8[UTF8_MAXBYTES+1];
19057             UV highest_cp = invlist_highest(cp_list);
19058
19059             op = ANYOFH;
19060
19061             /* Currently the maximum allowed code point by the system is
19062              * IV_MAX.  Higher ones are reserved for future internal use.  This
19063              * particular regnode can be used for higher ones, but we can't
19064              * calculate the code point of those.  IV_MAX suffices though, as
19065              * it will be a large first byte */
19066             (void) uvchr_to_utf8(low_utf8, MIN(start[0], IV_MAX));
19067
19068             /* We store the lowest possible first byte of the UTF-8
19069              * representation, using the flags field.  This allows for quick
19070              * ruling out of some inputs without having to convert from UTF-8
19071              * to code point.  For EBCDIC, this has to be I8. */
19072             anyof_flags = NATIVE_UTF8_TO_I8(low_utf8[0]);
19073
19074             /* If the first UTF-8 start byte for the highest code point in the
19075              * range is suitably small, we may be able to get an upper bound as
19076              * well */
19077             if (highest_cp <= IV_MAX) {
19078                 U8 high_utf8[UTF8_MAXBYTES+1];
19079
19080                 (void) uvchr_to_utf8(high_utf8, highest_cp);
19081
19082                 /* If the lowest and highest are the same, we can get an exact
19083                  * first byte instead of a just minimum.  We signal this with a
19084                  * different regnode */
19085                 if (low_utf8[0] == high_utf8[0]) {
19086
19087                     /* No need to convert to I8 for EBCDIC as this is an exact
19088                      * match */
19089                     anyof_flags = low_utf8[0];
19090                     op = ANYOFHb;
19091                 }
19092                 else if (NATIVE_UTF8_TO_I8(high_utf8[0]) <= MAX_ANYOF_HRx_BYTE)
19093                 {
19094
19095                     /* Here, the high byte is not the same as the low, but is
19096                      * small enough that its reasonable to have a loose upper
19097                      * bound, which is packed in with the strict lower bound.
19098                      * See comments at the definition of MAX_ANYOF_HRx_BYTE.
19099                      * On EBCDIC platforms, I8 is used.  On ASCII platforms I8
19100                      * is the same thing as UTF-8 */
19101
19102                     U8 bits = 0;
19103                     U8 max_range_diff = MAX_ANYOF_HRx_BYTE - anyof_flags;
19104                     U8 range_diff = NATIVE_UTF8_TO_I8(high_utf8[0])
19105                                   - anyof_flags;
19106
19107                     if (range_diff <= max_range_diff / 8) {
19108                         bits = 3;
19109                     }
19110                     else if (range_diff <= max_range_diff / 4) {
19111                         bits = 2;
19112                     }
19113                     else if (range_diff <= max_range_diff / 2) {
19114                         bits = 1;
19115                     }
19116                     anyof_flags = (anyof_flags - 0xC0) << 2 | bits;
19117                     op = ANYOFHr;
19118                 }
19119             }
19120
19121             goto done_finding_op;
19122         }
19123     }   /* End of seeing if can optimize it into a different node */
19124
19125   is_anyof: /* It's going to be an ANYOF node. */
19126     op = (has_runtime_dependency & HAS_D_RUNTIME_DEPENDENCY)
19127          ? ANYOFD
19128          : ((posixl)
19129             ? ANYOFPOSIXL
19130             : ((LOC)
19131                ? ANYOFL
19132                : ANYOF));
19133
19134   done_finding_op:
19135
19136     ret = regnode_guts(pRExC_state, op, regarglen[op], "anyof");
19137     FILL_NODE(ret, op);        /* We set the argument later */
19138     RExC_emit += 1 + regarglen[op];
19139     ANYOF_FLAGS(REGNODE_p(ret)) = anyof_flags;
19140
19141     /* Here, <cp_list> contains all the code points we can determine at
19142      * compile time that match under all conditions.  Go through it, and
19143      * for things that belong in the bitmap, put them there, and delete from
19144      * <cp_list>.  While we are at it, see if everything above 255 is in the
19145      * list, and if so, set a flag to speed up execution */
19146
19147     populate_ANYOF_from_invlist(REGNODE_p(ret), &cp_list);
19148
19149     if (posixl) {
19150         ANYOF_POSIXL_SET_TO_BITMAP(REGNODE_p(ret), posixl);
19151     }
19152
19153     if (invert) {
19154         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_INVERT;
19155     }
19156
19157     /* Here, the bitmap has been populated with all the Latin1 code points that
19158      * always match.  Can now add to the overall list those that match only
19159      * when the target string is UTF-8 (<upper_latin1_only_utf8_matches>).
19160      * */
19161     if (upper_latin1_only_utf8_matches) {
19162         if (cp_list) {
19163             _invlist_union(cp_list,
19164                            upper_latin1_only_utf8_matches,
19165                            &cp_list);
19166             SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
19167         }
19168         else {
19169             cp_list = upper_latin1_only_utf8_matches;
19170         }
19171         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
19172     }
19173
19174     set_ANYOF_arg(pRExC_state, REGNODE_p(ret), cp_list,
19175                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
19176                    ? listsv : NULL,
19177                   only_utf8_locale_list);
19178     return ret;
19179
19180   not_anyof:
19181
19182     /* Here, the node is getting optimized into something that's not an ANYOF
19183      * one.  Finish up. */
19184
19185     Set_Node_Offset_Length(REGNODE_p(ret), orig_parse - RExC_start,
19186                                            RExC_parse - orig_parse);;
19187     SvREFCNT_dec(cp_list);;
19188     return ret;
19189 }
19190
19191 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
19192
19193 STATIC void
19194 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
19195                 regnode* const node,
19196                 SV* const cp_list,
19197                 SV* const runtime_defns,
19198                 SV* const only_utf8_locale_list)
19199 {
19200     /* Sets the arg field of an ANYOF-type node 'node', using information about
19201      * the node passed-in.  If there is nothing outside the node's bitmap, the
19202      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
19203      * the count returned by add_data(), having allocated and stored an array,
19204      * av, as follows:
19205      *
19206      *  av[0] stores the inversion list defining this class as far as known at
19207      *        this time, or PL_sv_undef if nothing definite is now known.
19208      *  av[1] stores the inversion list of code points that match only if the
19209      *        current locale is UTF-8, or if none, PL_sv_undef if there is an
19210      *        av[2], or no entry otherwise.
19211      *  av[2] stores the list of user-defined properties whose subroutine
19212      *        definitions aren't known at this time, or no entry if none. */
19213
19214     UV n;
19215
19216     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
19217
19218     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
19219         assert(! (ANYOF_FLAGS(node)
19220                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
19221         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
19222     }
19223     else {
19224         AV * const av = newAV();
19225         SV *rv;
19226
19227         if (cp_list) {
19228             av_store(av, INVLIST_INDEX, cp_list);
19229         }
19230
19231         if (only_utf8_locale_list) {
19232             av_store(av, ONLY_LOCALE_MATCHES_INDEX, only_utf8_locale_list);
19233         }
19234
19235         if (runtime_defns) {
19236             av_store(av, DEFERRED_USER_DEFINED_INDEX, SvREFCNT_inc(runtime_defns));
19237         }
19238
19239         rv = newRV_noinc(MUTABLE_SV(av));
19240         n = add_data(pRExC_state, STR_WITH_LEN("s"));
19241         RExC_rxi->data->data[n] = (void*)rv;
19242         ARG_SET(node, n);
19243     }
19244 }
19245
19246 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
19247 SV *
19248 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
19249                                         const regnode* node,
19250                                         bool doinit,
19251                                         SV** listsvp,
19252                                         SV** only_utf8_locale_ptr,
19253                                         SV** output_invlist)
19254
19255 {
19256     /* For internal core use only.
19257      * Returns the inversion list for the input 'node' in the regex 'prog'.
19258      * If <doinit> is 'true', will attempt to create the inversion list if not
19259      *    already done.
19260      * If <listsvp> is non-null, will return the printable contents of the
19261      *    property definition.  This can be used to get debugging information
19262      *    even before the inversion list exists, by calling this function with
19263      *    'doinit' set to false, in which case the components that will be used
19264      *    to eventually create the inversion list are returned  (in a printable
19265      *    form).
19266      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
19267      *    store an inversion list of code points that should match only if the
19268      *    execution-time locale is a UTF-8 one.
19269      * If <output_invlist> is not NULL, it is where this routine is to store an
19270      *    inversion list of the code points that would be instead returned in
19271      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
19272      *    when this parameter is used, is just the non-code point data that
19273      *    will go into creating the inversion list.  This currently should be just
19274      *    user-defined properties whose definitions were not known at compile
19275      *    time.  Using this parameter allows for easier manipulation of the
19276      *    inversion list's data by the caller.  It is illegal to call this
19277      *    function with this parameter set, but not <listsvp>
19278      *
19279      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
19280      * that, in spite of this function's name, the inversion list it returns
19281      * may include the bitmap data as well */
19282
19283     SV *si  = NULL;         /* Input initialization string */
19284     SV* invlist = NULL;
19285
19286     RXi_GET_DECL(prog, progi);
19287     const struct reg_data * const data = prog ? progi->data : NULL;
19288
19289     PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
19290     assert(! output_invlist || listsvp);
19291
19292     if (data && data->count) {
19293         const U32 n = ARG(node);
19294
19295         if (data->what[n] == 's') {
19296             SV * const rv = MUTABLE_SV(data->data[n]);
19297             AV * const av = MUTABLE_AV(SvRV(rv));
19298             SV **const ary = AvARRAY(av);
19299
19300             invlist = ary[INVLIST_INDEX];
19301
19302             if (av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX) {
19303                 *only_utf8_locale_ptr = ary[ONLY_LOCALE_MATCHES_INDEX];
19304             }
19305
19306             if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
19307                 si = ary[DEFERRED_USER_DEFINED_INDEX];
19308             }
19309
19310             if (doinit && (si || invlist)) {
19311                 if (si) {
19312                     bool user_defined;
19313                     SV * msg = newSVpvs_flags("", SVs_TEMP);
19314
19315                     SV * prop_definition = handle_user_defined_property(
19316                             "", 0, FALSE,   /* There is no \p{}, \P{} */
19317                             SvPVX_const(si)[1] - '0',   /* /i or not has been
19318                                                            stored here for just
19319                                                            this occasion */
19320                             TRUE,           /* run time */
19321                             FALSE,          /* This call must find the defn */
19322                             si,             /* The property definition  */
19323                             &user_defined,
19324                             msg,
19325                             0               /* base level call */
19326                            );
19327
19328                     if (SvCUR(msg)) {
19329                         assert(prop_definition == NULL);
19330
19331                         Perl_croak(aTHX_ "%" UTF8f,
19332                                 UTF8fARG(SvUTF8(msg), SvCUR(msg), SvPVX(msg)));
19333                     }
19334
19335                     if (invlist) {
19336                         _invlist_union(invlist, prop_definition, &invlist);
19337                         SvREFCNT_dec_NN(prop_definition);
19338                     }
19339                     else {
19340                         invlist = prop_definition;
19341                     }
19342
19343                     STATIC_ASSERT_STMT(ONLY_LOCALE_MATCHES_INDEX == 1 + INVLIST_INDEX);
19344                     STATIC_ASSERT_STMT(DEFERRED_USER_DEFINED_INDEX == 1 + ONLY_LOCALE_MATCHES_INDEX);
19345
19346                     av_store(av, INVLIST_INDEX, invlist);
19347                     av_fill(av, (ary[ONLY_LOCALE_MATCHES_INDEX])
19348                                  ? ONLY_LOCALE_MATCHES_INDEX:
19349                                  INVLIST_INDEX);
19350                     si = NULL;
19351                 }
19352             }
19353         }
19354     }
19355
19356     /* If requested, return a printable version of what this ANYOF node matches
19357      * */
19358     if (listsvp) {
19359         SV* matches_string = NULL;
19360
19361         /* This function can be called at compile-time, before everything gets
19362          * resolved, in which case we return the currently best available
19363          * information, which is the string that will eventually be used to do
19364          * that resolving, 'si' */
19365         if (si) {
19366             /* Here, we only have 'si' (and possibly some passed-in data in
19367              * 'invlist', which is handled below)  If the caller only wants
19368              * 'si', use that.  */
19369             if (! output_invlist) {
19370                 matches_string = newSVsv(si);
19371             }
19372             else {
19373                 /* But if the caller wants an inversion list of the node, we
19374                  * need to parse 'si' and place as much as possible in the
19375                  * desired output inversion list, making 'matches_string' only
19376                  * contain the currently unresolvable things */
19377                 const char *si_string = SvPVX(si);
19378                 STRLEN remaining = SvCUR(si);
19379                 UV prev_cp = 0;
19380                 U8 count = 0;
19381
19382                 /* Ignore everything before the first new-line */
19383                 while (*si_string != '\n' && remaining > 0) {
19384                     si_string++;
19385                     remaining--;
19386                 }
19387                 assert(remaining > 0);
19388
19389                 si_string++;
19390                 remaining--;
19391
19392                 while (remaining > 0) {
19393
19394                     /* The data consists of just strings defining user-defined
19395                      * property names, but in prior incarnations, and perhaps
19396                      * somehow from pluggable regex engines, it could still
19397                      * hold hex code point definitions.  Each component of a
19398                      * range would be separated by a tab, and each range by a
19399                      * new-line.  If these are found, instead add them to the
19400                      * inversion list */
19401                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
19402                                      |PERL_SCAN_SILENT_NON_PORTABLE;
19403                     STRLEN len = remaining;
19404                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
19405
19406                     /* If the hex decode routine found something, it should go
19407                      * up to the next \n */
19408                     if (   *(si_string + len) == '\n') {
19409                         if (count) {    /* 2nd code point on line */
19410                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
19411                         }
19412                         else {
19413                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
19414                         }
19415                         count = 0;
19416                         goto prepare_for_next_iteration;
19417                     }
19418
19419                     /* If the hex decode was instead for the lower range limit,
19420                      * save it, and go parse the upper range limit */
19421                     if (*(si_string + len) == '\t') {
19422                         assert(count == 0);
19423
19424                         prev_cp = cp;
19425                         count = 1;
19426                       prepare_for_next_iteration:
19427                         si_string += len + 1;
19428                         remaining -= len + 1;
19429                         continue;
19430                     }
19431
19432                     /* Here, didn't find a legal hex number.  Just add it from
19433                      * here to the next \n */
19434
19435                     remaining -= len;
19436                     while (*(si_string + len) != '\n' && remaining > 0) {
19437                         remaining--;
19438                         len++;
19439                     }
19440                     if (*(si_string + len) == '\n') {
19441                         len++;
19442                         remaining--;
19443                     }
19444                     if (matches_string) {
19445                         sv_catpvn(matches_string, si_string, len - 1);
19446                     }
19447                     else {
19448                         matches_string = newSVpvn(si_string, len - 1);
19449                     }
19450                     si_string += len;
19451                     sv_catpvs(matches_string, " ");
19452                 } /* end of loop through the text */
19453
19454                 assert(matches_string);
19455                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
19456                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
19457                 }
19458             } /* end of has an 'si' */
19459         }
19460
19461         /* Add the stuff that's already known */
19462         if (invlist) {
19463
19464             /* Again, if the caller doesn't want the output inversion list, put
19465              * everything in 'matches-string' */
19466             if (! output_invlist) {
19467                 if ( ! matches_string) {
19468                     matches_string = newSVpvs("\n");
19469                 }
19470                 sv_catsv(matches_string, invlist_contents(invlist,
19471                                                   TRUE /* traditional style */
19472                                                   ));
19473             }
19474             else if (! *output_invlist) {
19475                 *output_invlist = invlist_clone(invlist, NULL);
19476             }
19477             else {
19478                 _invlist_union(*output_invlist, invlist, output_invlist);
19479             }
19480         }
19481
19482         *listsvp = matches_string;
19483     }
19484
19485     return invlist;
19486 }
19487 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
19488
19489 /* reg_skipcomment()
19490
19491    Absorbs an /x style # comment from the input stream,
19492    returning a pointer to the first character beyond the comment, or if the
19493    comment terminates the pattern without anything following it, this returns
19494    one past the final character of the pattern (in other words, RExC_end) and
19495    sets the REG_RUN_ON_COMMENT_SEEN flag.
19496
19497    Note it's the callers responsibility to ensure that we are
19498    actually in /x mode
19499
19500 */
19501
19502 PERL_STATIC_INLINE char*
19503 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
19504 {
19505     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
19506
19507     assert(*p == '#');
19508
19509     while (p < RExC_end) {
19510         if (*(++p) == '\n') {
19511             return p+1;
19512         }
19513     }
19514
19515     /* we ran off the end of the pattern without ending the comment, so we have
19516      * to add an \n when wrapping */
19517     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
19518     return p;
19519 }
19520
19521 STATIC void
19522 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
19523                                 char ** p,
19524                                 const bool force_to_xmod
19525                          )
19526 {
19527     /* If the text at the current parse position '*p' is a '(?#...)' comment,
19528      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
19529      * is /x whitespace, advance '*p' so that on exit it points to the first
19530      * byte past all such white space and comments */
19531
19532     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
19533
19534     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
19535
19536     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
19537
19538     for (;;) {
19539         if (RExC_end - (*p) >= 3
19540             && *(*p)     == '('
19541             && *(*p + 1) == '?'
19542             && *(*p + 2) == '#')
19543         {
19544             while (*(*p) != ')') {
19545                 if ((*p) == RExC_end)
19546                     FAIL("Sequence (?#... not terminated");
19547                 (*p)++;
19548             }
19549             (*p)++;
19550             continue;
19551         }
19552
19553         if (use_xmod) {
19554             const char * save_p = *p;
19555             while ((*p) < RExC_end) {
19556                 STRLEN len;
19557                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
19558                     (*p) += len;
19559                 }
19560                 else if (*(*p) == '#') {
19561                     (*p) = reg_skipcomment(pRExC_state, (*p));
19562                 }
19563                 else {
19564                     break;
19565                 }
19566             }
19567             if (*p != save_p) {
19568                 continue;
19569             }
19570         }
19571
19572         break;
19573     }
19574
19575     return;
19576 }
19577
19578 /* nextchar()
19579
19580    Advances the parse position by one byte, unless that byte is the beginning
19581    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
19582    those two cases, the parse position is advanced beyond all such comments and
19583    white space.
19584
19585    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
19586 */
19587
19588 STATIC void
19589 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
19590 {
19591     PERL_ARGS_ASSERT_NEXTCHAR;
19592
19593     if (RExC_parse < RExC_end) {
19594         assert(   ! UTF
19595                || UTF8_IS_INVARIANT(*RExC_parse)
19596                || UTF8_IS_START(*RExC_parse));
19597
19598         RExC_parse += (UTF)
19599                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
19600                       : 1;
19601
19602         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
19603                                 FALSE /* Don't force /x */ );
19604     }
19605 }
19606
19607 STATIC void
19608 S_change_engine_size(pTHX_ RExC_state_t *pRExC_state, const Ptrdiff_t size)
19609 {
19610     /* 'size' is the delta number of smallest regnode equivalents to add or
19611      * subtract from the current memory allocated to the regex engine being
19612      * constructed. */
19613
19614     PERL_ARGS_ASSERT_CHANGE_ENGINE_SIZE;
19615
19616     RExC_size += size;
19617
19618     Renewc(RExC_rxi,
19619            sizeof(regexp_internal) + (RExC_size + 1) * sizeof(regnode),
19620                                                 /* +1 for REG_MAGIC */
19621            char,
19622            regexp_internal);
19623     if ( RExC_rxi == NULL )
19624         FAIL("Regexp out of space");
19625     RXi_SET(RExC_rx, RExC_rxi);
19626
19627     RExC_emit_start = RExC_rxi->program;
19628     if (size > 0) {
19629         Zero(REGNODE_p(RExC_emit), size, regnode);
19630     }
19631
19632 #ifdef RE_TRACK_PATTERN_OFFSETS
19633     Renew(RExC_offsets, 2*RExC_size+1, U32);
19634     if (size > 0) {
19635         Zero(RExC_offsets + 2*(RExC_size - size) + 1, 2 * size, U32);
19636     }
19637     RExC_offsets[0] = RExC_size;
19638 #endif
19639 }
19640
19641 STATIC regnode_offset
19642 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
19643 {
19644     /* Allocate a regnode for 'op', with 'extra_size' extra (smallest) regnode
19645      * equivalents space.  It aligns and increments RExC_size and RExC_emit
19646      *
19647      * It returns the regnode's offset into the regex engine program */
19648
19649     const regnode_offset ret = RExC_emit;
19650
19651     GET_RE_DEBUG_FLAGS_DECL;
19652
19653     PERL_ARGS_ASSERT_REGNODE_GUTS;
19654
19655     SIZE_ALIGN(RExC_size);
19656     change_engine_size(pRExC_state, (Ptrdiff_t) 1 + extra_size);
19657     NODE_ALIGN_FILL(REGNODE_p(ret));
19658 #ifndef RE_TRACK_PATTERN_OFFSETS
19659     PERL_UNUSED_ARG(name);
19660     PERL_UNUSED_ARG(op);
19661 #else
19662     assert(extra_size >= regarglen[op] || PL_regkind[op] == ANYOF);
19663
19664     if (RExC_offsets) {         /* MJD */
19665         MJD_OFFSET_DEBUG(
19666               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
19667               name, __LINE__,
19668               PL_reg_name[op],
19669               (UV)(RExC_emit) > RExC_offsets[0]
19670                 ? "Overwriting end of array!\n" : "OK",
19671               (UV)(RExC_emit),
19672               (UV)(RExC_parse - RExC_start),
19673               (UV)RExC_offsets[0]));
19674         Set_Node_Offset(REGNODE_p(RExC_emit), RExC_parse + (op == END));
19675     }
19676 #endif
19677     return(ret);
19678 }
19679
19680 /*
19681 - reg_node - emit a node
19682 */
19683 STATIC regnode_offset /* Location. */
19684 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
19685 {
19686     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
19687     regnode_offset ptr = ret;
19688
19689     PERL_ARGS_ASSERT_REG_NODE;
19690
19691     assert(regarglen[op] == 0);
19692
19693     FILL_ADVANCE_NODE(ptr, op);
19694     RExC_emit = ptr;
19695     return(ret);
19696 }
19697
19698 /*
19699 - reganode - emit a node with an argument
19700 */
19701 STATIC regnode_offset /* Location. */
19702 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
19703 {
19704     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
19705     regnode_offset ptr = ret;
19706
19707     PERL_ARGS_ASSERT_REGANODE;
19708
19709     /* ANYOF are special cased to allow non-length 1 args */
19710     assert(regarglen[op] == 1);
19711
19712     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
19713     RExC_emit = ptr;
19714     return(ret);
19715 }
19716
19717 STATIC regnode_offset
19718 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
19719 {
19720     /* emit a node with U32 and I32 arguments */
19721
19722     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
19723     regnode_offset ptr = ret;
19724
19725     PERL_ARGS_ASSERT_REG2LANODE;
19726
19727     assert(regarglen[op] == 2);
19728
19729     FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
19730     RExC_emit = ptr;
19731     return(ret);
19732 }
19733
19734 /*
19735 - reginsert - insert an operator in front of already-emitted operand
19736 *
19737 * That means that on exit 'operand' is the offset of the newly inserted
19738 * operator, and the original operand has been relocated.
19739 *
19740 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
19741 * set up NEXT_OFF() of the inserted node if needed. Something like this:
19742 *
19743 *   reginsert(pRExC, OPFAIL, orig_emit, depth+1);
19744 *   NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
19745 *
19746 * ALSO NOTE - FLAGS(newly-inserted-operator) will be set to 0 as well.
19747 */
19748 STATIC void
19749 S_reginsert(pTHX_ RExC_state_t *pRExC_state, const U8 op,
19750                   const regnode_offset operand, const U32 depth)
19751 {
19752     regnode *src;
19753     regnode *dst;
19754     regnode *place;
19755     const int offset = regarglen[(U8)op];
19756     const int size = NODE_STEP_REGNODE + offset;
19757     GET_RE_DEBUG_FLAGS_DECL;
19758
19759     PERL_ARGS_ASSERT_REGINSERT;
19760     PERL_UNUSED_CONTEXT;
19761     PERL_UNUSED_ARG(depth);
19762 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
19763     DEBUG_PARSE_FMT("inst"," - %s", PL_reg_name[op]);
19764     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
19765                                     studying. If this is wrong then we need to adjust RExC_recurse
19766                                     below like we do with RExC_open_parens/RExC_close_parens. */
19767     change_engine_size(pRExC_state, (Ptrdiff_t) size);
19768     src = REGNODE_p(RExC_emit);
19769     RExC_emit += size;
19770     dst = REGNODE_p(RExC_emit);
19771
19772     /* If we are in a "count the parentheses" pass, the numbers are unreliable,
19773      * and [perl #133871] shows this can lead to problems, so skip this
19774      * realignment of parens until a later pass when they are reliable */
19775     if (! IN_PARENS_PASS && RExC_open_parens) {
19776         int paren;
19777         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
19778         /* remember that RExC_npar is rex->nparens + 1,
19779          * iow it is 1 more than the number of parens seen in
19780          * the pattern so far. */
19781         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
19782             /* note, RExC_open_parens[0] is the start of the
19783              * regex, it can't move. RExC_close_parens[0] is the end
19784              * of the regex, it *can* move. */
19785             if ( paren && RExC_open_parens[paren] >= operand ) {
19786                 /*DEBUG_PARSE_FMT("open"," - %d", size);*/
19787                 RExC_open_parens[paren] += size;
19788             } else {
19789                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
19790             }
19791             if ( RExC_close_parens[paren] >= operand ) {
19792                 /*DEBUG_PARSE_FMT("close"," - %d", size);*/
19793                 RExC_close_parens[paren] += size;
19794             } else {
19795                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
19796             }
19797         }
19798     }
19799     if (RExC_end_op)
19800         RExC_end_op += size;
19801
19802     while (src > REGNODE_p(operand)) {
19803         StructCopy(--src, --dst, regnode);
19804 #ifdef RE_TRACK_PATTERN_OFFSETS
19805         if (RExC_offsets) {     /* MJD 20010112 */
19806             MJD_OFFSET_DEBUG(
19807                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
19808                   "reginsert",
19809                   __LINE__,
19810                   PL_reg_name[op],
19811                   (UV)(REGNODE_OFFSET(dst)) > RExC_offsets[0]
19812                     ? "Overwriting end of array!\n" : "OK",
19813                   (UV)REGNODE_OFFSET(src),
19814                   (UV)REGNODE_OFFSET(dst),
19815                   (UV)RExC_offsets[0]));
19816             Set_Node_Offset_To_R(REGNODE_OFFSET(dst), Node_Offset(src));
19817             Set_Node_Length_To_R(REGNODE_OFFSET(dst), Node_Length(src));
19818         }
19819 #endif
19820     }
19821
19822     place = REGNODE_p(operand); /* Op node, where operand used to be. */
19823 #ifdef RE_TRACK_PATTERN_OFFSETS
19824     if (RExC_offsets) {         /* MJD */
19825         MJD_OFFSET_DEBUG(
19826               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
19827               "reginsert",
19828               __LINE__,
19829               PL_reg_name[op],
19830               (UV)REGNODE_OFFSET(place) > RExC_offsets[0]
19831               ? "Overwriting end of array!\n" : "OK",
19832               (UV)REGNODE_OFFSET(place),
19833               (UV)(RExC_parse - RExC_start),
19834               (UV)RExC_offsets[0]));
19835         Set_Node_Offset(place, RExC_parse);
19836         Set_Node_Length(place, 1);
19837     }
19838 #endif
19839     src = NEXTOPER(place);
19840     FLAGS(place) = 0;
19841     FILL_NODE(operand, op);
19842
19843     /* Zero out any arguments in the new node */
19844     Zero(src, offset, regnode);
19845 }
19846
19847 /*
19848 - regtail - set the next-pointer at the end of a node chain of p to val.  If
19849             that value won't fit in the space available, instead returns FALSE.
19850             (Except asserts if we can't fit in the largest space the regex
19851             engine is designed for.)
19852 - SEE ALSO: regtail_study
19853 */
19854 STATIC bool
19855 S_regtail(pTHX_ RExC_state_t * pRExC_state,
19856                 const regnode_offset p,
19857                 const regnode_offset val,
19858                 const U32 depth)
19859 {
19860     regnode_offset scan;
19861     GET_RE_DEBUG_FLAGS_DECL;
19862
19863     PERL_ARGS_ASSERT_REGTAIL;
19864 #ifndef DEBUGGING
19865     PERL_UNUSED_ARG(depth);
19866 #endif
19867
19868     /* Find last node. */
19869     scan = (regnode_offset) p;
19870     for (;;) {
19871         regnode * const temp = regnext(REGNODE_p(scan));
19872         DEBUG_PARSE_r({
19873             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
19874             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
19875             Perl_re_printf( aTHX_  "~ %s (%d) %s %s\n",
19876                 SvPV_nolen_const(RExC_mysv), scan,
19877                     (temp == NULL ? "->" : ""),
19878                     (temp == NULL ? PL_reg_name[OP(REGNODE_p(val))] : "")
19879             );
19880         });
19881         if (temp == NULL)
19882             break;
19883         scan = REGNODE_OFFSET(temp);
19884     }
19885
19886     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
19887         assert((UV) (val - scan) <= U32_MAX);
19888         ARG_SET(REGNODE_p(scan), val - scan);
19889     }
19890     else {
19891         if (val - scan > U16_MAX) {
19892             /* Populate this with something that won't loop and will likely
19893              * lead to a crash if the caller ignores the failure return, and
19894              * execution continues */
19895             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
19896             return FALSE;
19897         }
19898         NEXT_OFF(REGNODE_p(scan)) = val - scan;
19899     }
19900
19901     return TRUE;
19902 }
19903
19904 #ifdef DEBUGGING
19905 /*
19906 - regtail_study - set the next-pointer at the end of a node chain of p to val.
19907 - Look for optimizable sequences at the same time.
19908 - currently only looks for EXACT chains.
19909
19910 This is experimental code. The idea is to use this routine to perform
19911 in place optimizations on branches and groups as they are constructed,
19912 with the long term intention of removing optimization from study_chunk so
19913 that it is purely analytical.
19914
19915 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
19916 to control which is which.
19917
19918 This used to return a value that was ignored.  It was a problem that it is
19919 #ifdef'd to be another function that didn't return a value.  khw has changed it
19920 so both currently return a pass/fail return.
19921
19922 */
19923 /* TODO: All four parms should be const */
19924
19925 STATIC bool
19926 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode_offset p,
19927                       const regnode_offset val, U32 depth)
19928 {
19929     regnode_offset scan;
19930     U8 exact = PSEUDO;
19931 #ifdef EXPERIMENTAL_INPLACESCAN
19932     I32 min = 0;
19933 #endif
19934     GET_RE_DEBUG_FLAGS_DECL;
19935
19936     PERL_ARGS_ASSERT_REGTAIL_STUDY;
19937
19938
19939     /* Find last node. */
19940
19941     scan = p;
19942     for (;;) {
19943         regnode * const temp = regnext(REGNODE_p(scan));
19944 #ifdef EXPERIMENTAL_INPLACESCAN
19945         if (PL_regkind[OP(REGNODE_p(scan))] == EXACT) {
19946             bool unfolded_multi_char;   /* Unexamined in this routine */
19947             if (join_exact(pRExC_state, scan, &min,
19948                            &unfolded_multi_char, 1, REGNODE_p(val), depth+1))
19949                 return TRUE; /* Was return EXACT */
19950         }
19951 #endif
19952         if ( exact ) {
19953             switch (OP(REGNODE_p(scan))) {
19954                 case EXACT:
19955                 case EXACT_ONLY8:
19956                 case EXACTL:
19957                 case EXACTF:
19958                 case EXACTFU_S_EDGE:
19959                 case EXACTFAA_NO_TRIE:
19960                 case EXACTFAA:
19961                 case EXACTFU:
19962                 case EXACTFU_ONLY8:
19963                 case EXACTFLU8:
19964                 case EXACTFUP:
19965                 case EXACTFL:
19966                         if( exact == PSEUDO )
19967                             exact= OP(REGNODE_p(scan));
19968                         else if ( exact != OP(REGNODE_p(scan)) )
19969                             exact= 0;
19970                 case NOTHING:
19971                     break;
19972                 default:
19973                     exact= 0;
19974             }
19975         }
19976         DEBUG_PARSE_r({
19977             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
19978             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
19979             Perl_re_printf( aTHX_  "~ %s (%d) -> %s\n",
19980                 SvPV_nolen_const(RExC_mysv),
19981                 scan,
19982                 PL_reg_name[exact]);
19983         });
19984         if (temp == NULL)
19985             break;
19986         scan = REGNODE_OFFSET(temp);
19987     }
19988     DEBUG_PARSE_r({
19989         DEBUG_PARSE_MSG("");
19990         regprop(RExC_rx, RExC_mysv, REGNODE_p(val), NULL, pRExC_state);
19991         Perl_re_printf( aTHX_
19992                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
19993                       SvPV_nolen_const(RExC_mysv),
19994                       (IV)val,
19995                       (IV)(val - scan)
19996         );
19997     });
19998     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
19999         assert((UV) (val - scan) <= U32_MAX);
20000         ARG_SET(REGNODE_p(scan), val - scan);
20001     }
20002     else {
20003         if (val - scan > U16_MAX) {
20004             /* Populate this with something that won't loop and will likely
20005              * lead to a crash if the caller ignores the failure return, and
20006              * execution continues */
20007             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
20008             return FALSE;
20009         }
20010         NEXT_OFF(REGNODE_p(scan)) = val - scan;
20011     }
20012
20013     return TRUE; /* Was 'return exact' */
20014 }
20015 #endif
20016
20017 STATIC SV*
20018 S_get_ANYOFM_contents(pTHX_ const regnode * n) {
20019
20020     /* Returns an inversion list of all the code points matched by the
20021      * ANYOFM/NANYOFM node 'n' */
20022
20023     SV * cp_list = _new_invlist(-1);
20024     const U8 lowest = (U8) ARG(n);
20025     unsigned int i;
20026     U8 count = 0;
20027     U8 needed = 1U << PL_bitcount[ (U8) ~ FLAGS(n)];
20028
20029     PERL_ARGS_ASSERT_GET_ANYOFM_CONTENTS;
20030
20031     /* Starting with the lowest code point, any code point that ANDed with the
20032      * mask yields the lowest code point is in the set */
20033     for (i = lowest; i <= 0xFF; i++) {
20034         if ((i & FLAGS(n)) == ARG(n)) {
20035             cp_list = add_cp_to_invlist(cp_list, i);
20036             count++;
20037
20038             /* We know how many code points (a power of two) that are in the
20039              * set.  No use looking once we've got that number */
20040             if (count >= needed) break;
20041         }
20042     }
20043
20044     if (OP(n) == NANYOFM) {
20045         _invlist_invert(cp_list);
20046     }
20047     return cp_list;
20048 }
20049
20050 /*
20051  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
20052  */
20053 #ifdef DEBUGGING
20054
20055 static void
20056 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
20057 {
20058     int bit;
20059     int set=0;
20060
20061     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
20062
20063     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
20064         if (flags & (1<<bit)) {
20065             if (!set++ && lead)
20066                 Perl_re_printf( aTHX_  "%s", lead);
20067             Perl_re_printf( aTHX_  "%s ", PL_reg_intflags_name[bit]);
20068         }
20069     }
20070     if (lead)  {
20071         if (set)
20072             Perl_re_printf( aTHX_  "\n");
20073         else
20074             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
20075     }
20076 }
20077
20078 static void
20079 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
20080 {
20081     int bit;
20082     int set=0;
20083     regex_charset cs;
20084
20085     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
20086
20087     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
20088         if (flags & (1<<bit)) {
20089             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
20090                 continue;
20091             }
20092             if (!set++ && lead)
20093                 Perl_re_printf( aTHX_  "%s", lead);
20094             Perl_re_printf( aTHX_  "%s ", PL_reg_extflags_name[bit]);
20095         }
20096     }
20097     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
20098             if (!set++ && lead) {
20099                 Perl_re_printf( aTHX_  "%s", lead);
20100             }
20101             switch (cs) {
20102                 case REGEX_UNICODE_CHARSET:
20103                     Perl_re_printf( aTHX_  "UNICODE");
20104                     break;
20105                 case REGEX_LOCALE_CHARSET:
20106                     Perl_re_printf( aTHX_  "LOCALE");
20107                     break;
20108                 case REGEX_ASCII_RESTRICTED_CHARSET:
20109                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
20110                     break;
20111                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
20112                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
20113                     break;
20114                 default:
20115                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
20116                     break;
20117             }
20118     }
20119     if (lead)  {
20120         if (set)
20121             Perl_re_printf( aTHX_  "\n");
20122         else
20123             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
20124     }
20125 }
20126 #endif
20127
20128 void
20129 Perl_regdump(pTHX_ const regexp *r)
20130 {
20131 #ifdef DEBUGGING
20132     int i;
20133     SV * const sv = sv_newmortal();
20134     SV *dsv= sv_newmortal();
20135     RXi_GET_DECL(r, ri);
20136     GET_RE_DEBUG_FLAGS_DECL;
20137
20138     PERL_ARGS_ASSERT_REGDUMP;
20139
20140     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
20141
20142     /* Header fields of interest. */
20143     for (i = 0; i < 2; i++) {
20144         if (r->substrs->data[i].substr) {
20145             RE_PV_QUOTED_DECL(s, 0, dsv,
20146                             SvPVX_const(r->substrs->data[i].substr),
20147                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
20148                             PL_dump_re_max_len);
20149             Perl_re_printf( aTHX_
20150                           "%s %s%s at %" IVdf "..%" UVuf " ",
20151                           i ? "floating" : "anchored",
20152                           s,
20153                           RE_SV_TAIL(r->substrs->data[i].substr),
20154                           (IV)r->substrs->data[i].min_offset,
20155                           (UV)r->substrs->data[i].max_offset);
20156         }
20157         else if (r->substrs->data[i].utf8_substr) {
20158             RE_PV_QUOTED_DECL(s, 1, dsv,
20159                             SvPVX_const(r->substrs->data[i].utf8_substr),
20160                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
20161                             30);
20162             Perl_re_printf( aTHX_
20163                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
20164                           i ? "floating" : "anchored",
20165                           s,
20166                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
20167                           (IV)r->substrs->data[i].min_offset,
20168                           (UV)r->substrs->data[i].max_offset);
20169         }
20170     }
20171
20172     if (r->check_substr || r->check_utf8)
20173         Perl_re_printf( aTHX_
20174                       (const char *)
20175                       (   r->check_substr == r->substrs->data[1].substr
20176                        && r->check_utf8   == r->substrs->data[1].utf8_substr
20177                        ? "(checking floating" : "(checking anchored"));
20178     if (r->intflags & PREGf_NOSCAN)
20179         Perl_re_printf( aTHX_  " noscan");
20180     if (r->extflags & RXf_CHECK_ALL)
20181         Perl_re_printf( aTHX_  " isall");
20182     if (r->check_substr || r->check_utf8)
20183         Perl_re_printf( aTHX_  ") ");
20184
20185     if (ri->regstclass) {
20186         regprop(r, sv, ri->regstclass, NULL, NULL);
20187         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
20188     }
20189     if (r->intflags & PREGf_ANCH) {
20190         Perl_re_printf( aTHX_  "anchored");
20191         if (r->intflags & PREGf_ANCH_MBOL)
20192             Perl_re_printf( aTHX_  "(MBOL)");
20193         if (r->intflags & PREGf_ANCH_SBOL)
20194             Perl_re_printf( aTHX_  "(SBOL)");
20195         if (r->intflags & PREGf_ANCH_GPOS)
20196             Perl_re_printf( aTHX_  "(GPOS)");
20197         Perl_re_printf( aTHX_ " ");
20198     }
20199     if (r->intflags & PREGf_GPOS_SEEN)
20200         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
20201     if (r->intflags & PREGf_SKIP)
20202         Perl_re_printf( aTHX_  "plus ");
20203     if (r->intflags & PREGf_IMPLICIT)
20204         Perl_re_printf( aTHX_  "implicit ");
20205     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
20206     if (r->extflags & RXf_EVAL_SEEN)
20207         Perl_re_printf( aTHX_  "with eval ");
20208     Perl_re_printf( aTHX_  "\n");
20209     DEBUG_FLAGS_r({
20210         regdump_extflags("r->extflags: ", r->extflags);
20211         regdump_intflags("r->intflags: ", r->intflags);
20212     });
20213 #else
20214     PERL_ARGS_ASSERT_REGDUMP;
20215     PERL_UNUSED_CONTEXT;
20216     PERL_UNUSED_ARG(r);
20217 #endif  /* DEBUGGING */
20218 }
20219
20220 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
20221 #ifdef DEBUGGING
20222
20223 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
20224      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
20225      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
20226      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
20227      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
20228      || _CC_VERTSPACE != 15
20229 #   error Need to adjust order of anyofs[]
20230 #  endif
20231 static const char * const anyofs[] = {
20232     "\\w",
20233     "\\W",
20234     "\\d",
20235     "\\D",
20236     "[:alpha:]",
20237     "[:^alpha:]",
20238     "[:lower:]",
20239     "[:^lower:]",
20240     "[:upper:]",
20241     "[:^upper:]",
20242     "[:punct:]",
20243     "[:^punct:]",
20244     "[:print:]",
20245     "[:^print:]",
20246     "[:alnum:]",
20247     "[:^alnum:]",
20248     "[:graph:]",
20249     "[:^graph:]",
20250     "[:cased:]",
20251     "[:^cased:]",
20252     "\\s",
20253     "\\S",
20254     "[:blank:]",
20255     "[:^blank:]",
20256     "[:xdigit:]",
20257     "[:^xdigit:]",
20258     "[:cntrl:]",
20259     "[:^cntrl:]",
20260     "[:ascii:]",
20261     "[:^ascii:]",
20262     "\\v",
20263     "\\V"
20264 };
20265 #endif
20266
20267 /*
20268 - regprop - printable representation of opcode, with run time support
20269 */
20270
20271 void
20272 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
20273 {
20274 #ifdef DEBUGGING
20275     dVAR;
20276     int k;
20277     RXi_GET_DECL(prog, progi);
20278     GET_RE_DEBUG_FLAGS_DECL;
20279
20280     PERL_ARGS_ASSERT_REGPROP;
20281
20282     SvPVCLEAR(sv);
20283
20284     if (OP(o) > REGNODE_MAX) {          /* regnode.type is unsigned */
20285         if (pRExC_state) {  /* This gives more info, if we have it */
20286             FAIL3("panic: corrupted regexp opcode %d > %d",
20287                   (int)OP(o), (int)REGNODE_MAX);
20288         }
20289         else {
20290             Perl_croak(aTHX_ "panic: corrupted regexp opcode %d > %d",
20291                              (int)OP(o), (int)REGNODE_MAX);
20292         }
20293     }
20294     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
20295
20296     k = PL_regkind[OP(o)];
20297
20298     if (k == EXACT) {
20299         sv_catpvs(sv, " ");
20300         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
20301          * is a crude hack but it may be the best for now since
20302          * we have no flag "this EXACTish node was UTF-8"
20303          * --jhi */
20304         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
20305                   PL_colors[0], PL_colors[1],
20306                   PERL_PV_ESCAPE_UNI_DETECT |
20307                   PERL_PV_ESCAPE_NONASCII   |
20308                   PERL_PV_PRETTY_ELLIPSES   |
20309                   PERL_PV_PRETTY_LTGT       |
20310                   PERL_PV_PRETTY_NOCLEAR
20311                   );
20312     } else if (k == TRIE) {
20313         /* print the details of the trie in dumpuntil instead, as
20314          * progi->data isn't available here */
20315         const char op = OP(o);
20316         const U32 n = ARG(o);
20317         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
20318                (reg_ac_data *)progi->data->data[n] :
20319                NULL;
20320         const reg_trie_data * const trie
20321             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
20322
20323         Perl_sv_catpvf(aTHX_ sv, "-%s", PL_reg_name[o->flags]);
20324         DEBUG_TRIE_COMPILE_r({
20325           if (trie->jump)
20326             sv_catpvs(sv, "(JUMP)");
20327           Perl_sv_catpvf(aTHX_ sv,
20328             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
20329             (UV)trie->startstate,
20330             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
20331             (UV)trie->wordcount,
20332             (UV)trie->minlen,
20333             (UV)trie->maxlen,
20334             (UV)TRIE_CHARCOUNT(trie),
20335             (UV)trie->uniquecharcount
20336           );
20337         });
20338         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
20339             sv_catpvs(sv, "[");
20340             (void) put_charclass_bitmap_innards(sv,
20341                                                 ((IS_ANYOF_TRIE(op))
20342                                                  ? ANYOF_BITMAP(o)
20343                                                  : TRIE_BITMAP(trie)),
20344                                                 NULL,
20345                                                 NULL,
20346                                                 NULL,
20347                                                 FALSE
20348                                                );
20349             sv_catpvs(sv, "]");
20350         }
20351     } else if (k == CURLY) {
20352         U32 lo = ARG1(o), hi = ARG2(o);
20353         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
20354             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
20355         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
20356         if (hi == REG_INFTY)
20357             sv_catpvs(sv, "INFTY");
20358         else
20359             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
20360         sv_catpvs(sv, "}");
20361     }
20362     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
20363         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
20364     else if (k == REF || k == OPEN || k == CLOSE
20365              || k == GROUPP || OP(o)==ACCEPT)
20366     {
20367         AV *name_list= NULL;
20368         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
20369         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
20370         if ( RXp_PAREN_NAMES(prog) ) {
20371             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
20372         } else if ( pRExC_state ) {
20373             name_list= RExC_paren_name_list;
20374         }
20375         if (name_list) {
20376             if ( k != REF || (OP(o) < REFN)) {
20377                 SV **name= av_fetch(name_list, parno, 0 );
20378                 if (name)
20379                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20380             }
20381             else {
20382                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
20383                 I32 *nums=(I32*)SvPVX(sv_dat);
20384                 SV **name= av_fetch(name_list, nums[0], 0 );
20385                 I32 n;
20386                 if (name) {
20387                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
20388                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
20389                                     (n ? "," : ""), (IV)nums[n]);
20390                     }
20391                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20392                 }
20393             }
20394         }
20395         if ( k == REF && reginfo) {
20396             U32 n = ARG(o);  /* which paren pair */
20397             I32 ln = prog->offs[n].start;
20398             if (prog->lastparen < n || ln == -1 || prog->offs[n].end == -1)
20399                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
20400             else if (ln == prog->offs[n].end)
20401                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
20402             else {
20403                 const char *s = reginfo->strbeg + ln;
20404                 Perl_sv_catpvf(aTHX_ sv, ": ");
20405                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
20406                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
20407             }
20408         }
20409     } else if (k == GOSUB) {
20410         AV *name_list= NULL;
20411         if ( RXp_PAREN_NAMES(prog) ) {
20412             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
20413         } else if ( pRExC_state ) {
20414             name_list= RExC_paren_name_list;
20415         }
20416
20417         /* Paren and offset */
20418         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
20419                 (int)((o + (int)ARG2L(o)) - progi->program) );
20420         if (name_list) {
20421             SV **name= av_fetch(name_list, ARG(o), 0 );
20422             if (name)
20423                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
20424         }
20425     }
20426     else if (k == LOGICAL)
20427         /* 2: embedded, otherwise 1 */
20428         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
20429     else if (k == ANYOF) {
20430         const U8 flags = inRANGE(OP(o), ANYOFH, ANYOFHr)
20431                           ? 0
20432                           : ANYOF_FLAGS(o);
20433         bool do_sep = FALSE;    /* Do we need to separate various components of
20434                                    the output? */
20435         /* Set if there is still an unresolved user-defined property */
20436         SV *unresolved                = NULL;
20437
20438         /* Things that are ignored except when the runtime locale is UTF-8 */
20439         SV *only_utf8_locale_invlist = NULL;
20440
20441         /* Code points that don't fit in the bitmap */
20442         SV *nonbitmap_invlist = NULL;
20443
20444         /* And things that aren't in the bitmap, but are small enough to be */
20445         SV* bitmap_range_not_in_bitmap = NULL;
20446
20447         const bool inverted = flags & ANYOF_INVERT;
20448
20449         if (OP(o) == ANYOFL || OP(o) == ANYOFPOSIXL) {
20450             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
20451                 sv_catpvs(sv, "{utf8-locale-reqd}");
20452             }
20453             if (flags & ANYOFL_FOLD) {
20454                 sv_catpvs(sv, "{i}");
20455             }
20456         }
20457
20458         /* If there is stuff outside the bitmap, get it */
20459         if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
20460             (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
20461                                                 &unresolved,
20462                                                 &only_utf8_locale_invlist,
20463                                                 &nonbitmap_invlist);
20464             /* The non-bitmap data may contain stuff that could fit in the
20465              * bitmap.  This could come from a user-defined property being
20466              * finally resolved when this call was done; or much more likely
20467              * because there are matches that require UTF-8 to be valid, and so
20468              * aren't in the bitmap.  This is teased apart later */
20469             _invlist_intersection(nonbitmap_invlist,
20470                                   PL_InBitmap,
20471                                   &bitmap_range_not_in_bitmap);
20472             /* Leave just the things that don't fit into the bitmap */
20473             _invlist_subtract(nonbitmap_invlist,
20474                               PL_InBitmap,
20475                               &nonbitmap_invlist);
20476         }
20477
20478         /* Obey this flag to add all above-the-bitmap code points */
20479         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
20480             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
20481                                                       NUM_ANYOF_CODE_POINTS,
20482                                                       UV_MAX);
20483         }
20484
20485         /* Ready to start outputting.  First, the initial left bracket */
20486         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20487
20488         if (! inRANGE(OP(o), ANYOFH, ANYOFHr)) {
20489             /* Then all the things that could fit in the bitmap */
20490             do_sep = put_charclass_bitmap_innards(sv,
20491                                                   ANYOF_BITMAP(o),
20492                                                   bitmap_range_not_in_bitmap,
20493                                                   only_utf8_locale_invlist,
20494                                                   o,
20495
20496                                                   /* Can't try inverting for a
20497                                                    * better display if there
20498                                                    * are things that haven't
20499                                                    * been resolved */
20500                                                   unresolved != NULL);
20501             SvREFCNT_dec(bitmap_range_not_in_bitmap);
20502
20503             /* If there are user-defined properties which haven't been defined
20504              * yet, output them.  If the result is not to be inverted, it is
20505              * clearest to output them in a separate [] from the bitmap range
20506              * stuff.  If the result is to be complemented, we have to show
20507              * everything in one [], as the inversion applies to the whole
20508              * thing.  Use {braces} to separate them from anything in the
20509              * bitmap and anything above the bitmap. */
20510             if (unresolved) {
20511                 if (inverted) {
20512                     if (! do_sep) { /* If didn't output anything in the bitmap
20513                                      */
20514                         sv_catpvs(sv, "^");
20515                     }
20516                     sv_catpvs(sv, "{");
20517                 }
20518                 else if (do_sep) {
20519                     Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1],
20520                                                       PL_colors[0]);
20521                 }
20522                 sv_catsv(sv, unresolved);
20523                 if (inverted) {
20524                     sv_catpvs(sv, "}");
20525                 }
20526                 do_sep = ! inverted;
20527             }
20528         }
20529
20530         /* And, finally, add the above-the-bitmap stuff */
20531         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
20532             SV* contents;
20533
20534             /* See if truncation size is overridden */
20535             const STRLEN dump_len = (PL_dump_re_max_len > 256)
20536                                     ? PL_dump_re_max_len
20537                                     : 256;
20538
20539             /* This is output in a separate [] */
20540             if (do_sep) {
20541                 Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1], PL_colors[0]);
20542             }
20543
20544             /* And, for easy of understanding, it is shown in the
20545              * uncomplemented form if possible.  The one exception being if
20546              * there are unresolved items, where the inversion has to be
20547              * delayed until runtime */
20548             if (inverted && ! unresolved) {
20549                 _invlist_invert(nonbitmap_invlist);
20550                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
20551             }
20552
20553             contents = invlist_contents(nonbitmap_invlist,
20554                                         FALSE /* output suitable for catsv */
20555                                        );
20556
20557             /* If the output is shorter than the permissible maximum, just do it. */
20558             if (SvCUR(contents) <= dump_len) {
20559                 sv_catsv(sv, contents);
20560             }
20561             else {
20562                 const char * contents_string = SvPVX(contents);
20563                 STRLEN i = dump_len;
20564
20565                 /* Otherwise, start at the permissible max and work back to the
20566                  * first break possibility */
20567                 while (i > 0 && contents_string[i] != ' ') {
20568                     i--;
20569                 }
20570                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
20571                                        find a legal break */
20572                     i = dump_len;
20573                 }
20574
20575                 sv_catpvn(sv, contents_string, i);
20576                 sv_catpvs(sv, "...");
20577             }
20578
20579             SvREFCNT_dec_NN(contents);
20580             SvREFCNT_dec_NN(nonbitmap_invlist);
20581         }
20582
20583         /* And finally the matching, closing ']' */
20584         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20585
20586         if (inRANGE(OP(o), ANYOFH, ANYOFHr)) {
20587             U8 lowest = (OP(o) != ANYOFHr)
20588                          ? FLAGS(o)
20589                          : LOWEST_ANYOF_HRx_BYTE(FLAGS(o));
20590             U8 highest = (OP(o) == ANYOFHb)
20591                          ? lowest
20592                          : OP(o) == ANYOFH
20593                            ? 0xFF
20594                            : HIGHEST_ANYOF_HRx_BYTE(FLAGS(o));
20595             Perl_sv_catpvf(aTHX_ sv, " (First UTF-8 byte=%02X", lowest);
20596             if (lowest != highest) {
20597                 Perl_sv_catpvf(aTHX_ sv, "-%02X", highest);
20598             }
20599             Perl_sv_catpvf(aTHX_ sv, ")");
20600         }
20601
20602         SvREFCNT_dec(unresolved);
20603     }
20604     else if (k == ANYOFM) {
20605         SV * cp_list = get_ANYOFM_contents(o);
20606
20607         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
20608         if (OP(o) == NANYOFM) {
20609             _invlist_invert(cp_list);
20610         }
20611
20612         put_charclass_bitmap_innards(sv, NULL, cp_list, NULL, NULL, TRUE);
20613         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
20614
20615         SvREFCNT_dec(cp_list);
20616     }
20617     else if (k == POSIXD || k == NPOSIXD) {
20618         U8 index = FLAGS(o) * 2;
20619         if (index < C_ARRAY_LENGTH(anyofs)) {
20620             if (*anyofs[index] != '[')  {
20621                 sv_catpvs(sv, "[");
20622             }
20623             sv_catpv(sv, anyofs[index]);
20624             if (*anyofs[index] != '[')  {
20625                 sv_catpvs(sv, "]");
20626             }
20627         }
20628         else {
20629             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
20630         }
20631     }
20632     else if (k == BOUND || k == NBOUND) {
20633         /* Must be synced with order of 'bound_type' in regcomp.h */
20634         const char * const bounds[] = {
20635             "",      /* Traditional */
20636             "{gcb}",
20637             "{lb}",
20638             "{sb}",
20639             "{wb}"
20640         };
20641         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
20642         sv_catpv(sv, bounds[FLAGS(o)]);
20643     }
20644     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH)) {
20645         Perl_sv_catpvf(aTHX_ sv, "[%d", -(o->flags));
20646         if (o->next_off) {
20647             Perl_sv_catpvf(aTHX_ sv, "..-%d", o->flags - o->next_off);
20648         }
20649         Perl_sv_catpvf(aTHX_ sv, "]");
20650     }
20651     else if (OP(o) == SBOL)
20652         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
20653
20654     /* add on the verb argument if there is one */
20655     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
20656         if ( ARG(o) )
20657             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
20658                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
20659         else
20660             sv_catpvs(sv, ":NULL");
20661     }
20662 #else
20663     PERL_UNUSED_CONTEXT;
20664     PERL_UNUSED_ARG(sv);
20665     PERL_UNUSED_ARG(o);
20666     PERL_UNUSED_ARG(prog);
20667     PERL_UNUSED_ARG(reginfo);
20668     PERL_UNUSED_ARG(pRExC_state);
20669 #endif  /* DEBUGGING */
20670 }
20671
20672
20673
20674 SV *
20675 Perl_re_intuit_string(pTHX_ REGEXP * const r)
20676 {                               /* Assume that RE_INTUIT is set */
20677     struct regexp *const prog = ReANY(r);
20678     GET_RE_DEBUG_FLAGS_DECL;
20679
20680     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
20681     PERL_UNUSED_CONTEXT;
20682
20683     DEBUG_COMPILE_r(
20684         {
20685             const char * const s = SvPV_nolen_const(RX_UTF8(r)
20686                       ? prog->check_utf8 : prog->check_substr);
20687
20688             if (!PL_colorset) reginitcolors();
20689             Perl_re_printf( aTHX_
20690                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
20691                       PL_colors[4],
20692                       RX_UTF8(r) ? "utf8 " : "",
20693                       PL_colors[5], PL_colors[0],
20694                       s,
20695                       PL_colors[1],
20696                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
20697         } );
20698
20699     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
20700     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
20701 }
20702
20703 /*
20704    pregfree()
20705
20706    handles refcounting and freeing the perl core regexp structure. When
20707    it is necessary to actually free the structure the first thing it
20708    does is call the 'free' method of the regexp_engine associated to
20709    the regexp, allowing the handling of the void *pprivate; member
20710    first. (This routine is not overridable by extensions, which is why
20711    the extensions free is called first.)
20712
20713    See regdupe and regdupe_internal if you change anything here.
20714 */
20715 #ifndef PERL_IN_XSUB_RE
20716 void
20717 Perl_pregfree(pTHX_ REGEXP *r)
20718 {
20719     SvREFCNT_dec(r);
20720 }
20721
20722 void
20723 Perl_pregfree2(pTHX_ REGEXP *rx)
20724 {
20725     struct regexp *const r = ReANY(rx);
20726     GET_RE_DEBUG_FLAGS_DECL;
20727
20728     PERL_ARGS_ASSERT_PREGFREE2;
20729
20730     if (! r)
20731         return;
20732
20733     if (r->mother_re) {
20734         ReREFCNT_dec(r->mother_re);
20735     } else {
20736         CALLREGFREE_PVT(rx); /* free the private data */
20737         SvREFCNT_dec(RXp_PAREN_NAMES(r));
20738     }
20739     if (r->substrs) {
20740         int i;
20741         for (i = 0; i < 2; i++) {
20742             SvREFCNT_dec(r->substrs->data[i].substr);
20743             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
20744         }
20745         Safefree(r->substrs);
20746     }
20747     RX_MATCH_COPY_FREE(rx);
20748 #ifdef PERL_ANY_COW
20749     SvREFCNT_dec(r->saved_copy);
20750 #endif
20751     Safefree(r->offs);
20752     SvREFCNT_dec(r->qr_anoncv);
20753     if (r->recurse_locinput)
20754         Safefree(r->recurse_locinput);
20755 }
20756
20757
20758 /*  reg_temp_copy()
20759
20760     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
20761     except that dsv will be created if NULL.
20762
20763     This function is used in two main ways. First to implement
20764         $r = qr/....; $s = $$r;
20765
20766     Secondly, it is used as a hacky workaround to the structural issue of
20767     match results
20768     being stored in the regexp structure which is in turn stored in
20769     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
20770     could be PL_curpm in multiple contexts, and could require multiple
20771     result sets being associated with the pattern simultaneously, such
20772     as when doing a recursive match with (??{$qr})
20773
20774     The solution is to make a lightweight copy of the regexp structure
20775     when a qr// is returned from the code executed by (??{$qr}) this
20776     lightweight copy doesn't actually own any of its data except for
20777     the starp/end and the actual regexp structure itself.
20778
20779 */
20780
20781
20782 REGEXP *
20783 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
20784 {
20785     struct regexp *drx;
20786     struct regexp *const srx = ReANY(ssv);
20787     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
20788
20789     PERL_ARGS_ASSERT_REG_TEMP_COPY;
20790
20791     if (!dsv)
20792         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
20793     else {
20794         assert(SvTYPE(dsv) == SVt_REGEXP || (SvTYPE(dsv) == SVt_PVLV));
20795
20796         /* our only valid caller, sv_setsv_flags(), should have done
20797          * a SV_CHECK_THINKFIRST_COW_DROP() by now */
20798         assert(!SvOOK(dsv));
20799         assert(!SvIsCOW(dsv));
20800         assert(!SvROK(dsv));
20801
20802         if (SvPVX_const(dsv)) {
20803             if (SvLEN(dsv))
20804                 Safefree(SvPVX(dsv));
20805             SvPVX(dsv) = NULL;
20806         }
20807         SvLEN_set(dsv, 0);
20808         SvCUR_set(dsv, 0);
20809         SvOK_off((SV *)dsv);
20810
20811         if (islv) {
20812             /* For PVLVs, the head (sv_any) points to an XPVLV, while
20813              * the LV's xpvlenu_rx will point to a regexp body, which
20814              * we allocate here */
20815             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
20816             assert(!SvPVX(dsv));
20817             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
20818             temp->sv_any = NULL;
20819             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
20820             SvREFCNT_dec_NN(temp);
20821             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
20822                ing below will not set it. */
20823             SvCUR_set(dsv, SvCUR(ssv));
20824         }
20825     }
20826     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
20827        sv_force_normal(sv) is called.  */
20828     SvFAKE_on(dsv);
20829     drx = ReANY(dsv);
20830
20831     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
20832     SvPV_set(dsv, RX_WRAPPED(ssv));
20833     /* We share the same string buffer as the original regexp, on which we
20834        hold a reference count, incremented when mother_re is set below.
20835        The string pointer is copied here, being part of the regexp struct.
20836      */
20837     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
20838            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
20839     if (!islv)
20840         SvLEN_set(dsv, 0);
20841     if (srx->offs) {
20842         const I32 npar = srx->nparens+1;
20843         Newx(drx->offs, npar, regexp_paren_pair);
20844         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
20845     }
20846     if (srx->substrs) {
20847         int i;
20848         Newx(drx->substrs, 1, struct reg_substr_data);
20849         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
20850
20851         for (i = 0; i < 2; i++) {
20852             SvREFCNT_inc_void(drx->substrs->data[i].substr);
20853             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
20854         }
20855
20856         /* check_substr and check_utf8, if non-NULL, point to either their
20857            anchored or float namesakes, and don't hold a second reference.  */
20858     }
20859     RX_MATCH_COPIED_off(dsv);
20860 #ifdef PERL_ANY_COW
20861     drx->saved_copy = NULL;
20862 #endif
20863     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
20864     SvREFCNT_inc_void(drx->qr_anoncv);
20865     if (srx->recurse_locinput)
20866         Newx(drx->recurse_locinput, srx->nparens + 1, char *);
20867
20868     return dsv;
20869 }
20870 #endif
20871
20872
20873 /* regfree_internal()
20874
20875    Free the private data in a regexp. This is overloadable by
20876    extensions. Perl takes care of the regexp structure in pregfree(),
20877    this covers the *pprivate pointer which technically perl doesn't
20878    know about, however of course we have to handle the
20879    regexp_internal structure when no extension is in use.
20880
20881    Note this is called before freeing anything in the regexp
20882    structure.
20883  */
20884
20885 void
20886 Perl_regfree_internal(pTHX_ REGEXP * const rx)
20887 {
20888     struct regexp *const r = ReANY(rx);
20889     RXi_GET_DECL(r, ri);
20890     GET_RE_DEBUG_FLAGS_DECL;
20891
20892     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
20893
20894     if (! ri) {
20895         return;
20896     }
20897
20898     DEBUG_COMPILE_r({
20899         if (!PL_colorset)
20900             reginitcolors();
20901         {
20902             SV *dsv= sv_newmortal();
20903             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
20904                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
20905             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
20906                 PL_colors[4], PL_colors[5], s);
20907         }
20908     });
20909
20910 #ifdef RE_TRACK_PATTERN_OFFSETS
20911     if (ri->u.offsets)
20912         Safefree(ri->u.offsets);             /* 20010421 MJD */
20913 #endif
20914     if (ri->code_blocks)
20915         S_free_codeblocks(aTHX_ ri->code_blocks);
20916
20917     if (ri->data) {
20918         int n = ri->data->count;
20919
20920         while (--n >= 0) {
20921           /* If you add a ->what type here, update the comment in regcomp.h */
20922             switch (ri->data->what[n]) {
20923             case 'a':
20924             case 'r':
20925             case 's':
20926             case 'S':
20927             case 'u':
20928                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
20929                 break;
20930             case 'f':
20931                 Safefree(ri->data->data[n]);
20932                 break;
20933             case 'l':
20934             case 'L':
20935                 break;
20936             case 'T':
20937                 { /* Aho Corasick add-on structure for a trie node.
20938                      Used in stclass optimization only */
20939                     U32 refcount;
20940                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
20941 #ifdef USE_ITHREADS
20942                     dVAR;
20943 #endif
20944                     OP_REFCNT_LOCK;
20945                     refcount = --aho->refcount;
20946                     OP_REFCNT_UNLOCK;
20947                     if ( !refcount ) {
20948                         PerlMemShared_free(aho->states);
20949                         PerlMemShared_free(aho->fail);
20950                          /* do this last!!!! */
20951                         PerlMemShared_free(ri->data->data[n]);
20952                         /* we should only ever get called once, so
20953                          * assert as much, and also guard the free
20954                          * which /might/ happen twice. At the least
20955                          * it will make code anlyzers happy and it
20956                          * doesn't cost much. - Yves */
20957                         assert(ri->regstclass);
20958                         if (ri->regstclass) {
20959                             PerlMemShared_free(ri->regstclass);
20960                             ri->regstclass = 0;
20961                         }
20962                     }
20963                 }
20964                 break;
20965             case 't':
20966                 {
20967                     /* trie structure. */
20968                     U32 refcount;
20969                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
20970 #ifdef USE_ITHREADS
20971                     dVAR;
20972 #endif
20973                     OP_REFCNT_LOCK;
20974                     refcount = --trie->refcount;
20975                     OP_REFCNT_UNLOCK;
20976                     if ( !refcount ) {
20977                         PerlMemShared_free(trie->charmap);
20978                         PerlMemShared_free(trie->states);
20979                         PerlMemShared_free(trie->trans);
20980                         if (trie->bitmap)
20981                             PerlMemShared_free(trie->bitmap);
20982                         if (trie->jump)
20983                             PerlMemShared_free(trie->jump);
20984                         PerlMemShared_free(trie->wordinfo);
20985                         /* do this last!!!! */
20986                         PerlMemShared_free(ri->data->data[n]);
20987                     }
20988                 }
20989                 break;
20990             default:
20991                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
20992                                                     ri->data->what[n]);
20993             }
20994         }
20995         Safefree(ri->data->what);
20996         Safefree(ri->data);
20997     }
20998
20999     Safefree(ri);
21000 }
21001
21002 #define av_dup_inc(s, t)        MUTABLE_AV(sv_dup_inc((const SV *)s, t))
21003 #define hv_dup_inc(s, t)        MUTABLE_HV(sv_dup_inc((const SV *)s, t))
21004 #define SAVEPVN(p, n)   ((p) ? savepvn(p, n) : NULL)
21005
21006 /*
21007    re_dup_guts - duplicate a regexp.
21008
21009    This routine is expected to clone a given regexp structure. It is only
21010    compiled under USE_ITHREADS.
21011
21012    After all of the core data stored in struct regexp is duplicated
21013    the regexp_engine.dupe method is used to copy any private data
21014    stored in the *pprivate pointer. This allows extensions to handle
21015    any duplication it needs to do.
21016
21017    See pregfree() and regfree_internal() if you change anything here.
21018 */
21019 #if defined(USE_ITHREADS)
21020 #ifndef PERL_IN_XSUB_RE
21021 void
21022 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
21023 {
21024     dVAR;
21025     I32 npar;
21026     const struct regexp *r = ReANY(sstr);
21027     struct regexp *ret = ReANY(dstr);
21028
21029     PERL_ARGS_ASSERT_RE_DUP_GUTS;
21030
21031     npar = r->nparens+1;
21032     Newx(ret->offs, npar, regexp_paren_pair);
21033     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
21034
21035     if (ret->substrs) {
21036         /* Do it this way to avoid reading from *r after the StructCopy().
21037            That way, if any of the sv_dup_inc()s dislodge *r from the L1
21038            cache, it doesn't matter.  */
21039         int i;
21040         const bool anchored = r->check_substr
21041             ? r->check_substr == r->substrs->data[0].substr
21042             : r->check_utf8   == r->substrs->data[0].utf8_substr;
21043         Newx(ret->substrs, 1, struct reg_substr_data);
21044         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
21045
21046         for (i = 0; i < 2; i++) {
21047             ret->substrs->data[i].substr =
21048                         sv_dup_inc(ret->substrs->data[i].substr, param);
21049             ret->substrs->data[i].utf8_substr =
21050                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
21051         }
21052
21053         /* check_substr and check_utf8, if non-NULL, point to either their
21054            anchored or float namesakes, and don't hold a second reference.  */
21055
21056         if (ret->check_substr) {
21057             if (anchored) {
21058                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
21059
21060                 ret->check_substr = ret->substrs->data[0].substr;
21061                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
21062             } else {
21063                 assert(r->check_substr == r->substrs->data[1].substr);
21064                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
21065
21066                 ret->check_substr = ret->substrs->data[1].substr;
21067                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
21068             }
21069         } else if (ret->check_utf8) {
21070             if (anchored) {
21071                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
21072             } else {
21073                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
21074             }
21075         }
21076     }
21077
21078     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
21079     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
21080     if (r->recurse_locinput)
21081         Newx(ret->recurse_locinput, r->nparens + 1, char *);
21082
21083     if (ret->pprivate)
21084         RXi_SET(ret, CALLREGDUPE_PVT(dstr, param));
21085
21086     if (RX_MATCH_COPIED(dstr))
21087         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
21088     else
21089         ret->subbeg = NULL;
21090 #ifdef PERL_ANY_COW
21091     ret->saved_copy = NULL;
21092 #endif
21093
21094     /* Whether mother_re be set or no, we need to copy the string.  We
21095        cannot refrain from copying it when the storage points directly to
21096        our mother regexp, because that's
21097                1: a buffer in a different thread
21098                2: something we no longer hold a reference on
21099                so we need to copy it locally.  */
21100     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
21101     /* set malloced length to a non-zero value so it will be freed
21102      * (otherwise in combination with SVf_FAKE it looks like an alien
21103      * buffer). It doesn't have to be the actual malloced size, since it
21104      * should never be grown */
21105     SvLEN_set(dstr, SvCUR(sstr)+1);
21106     ret->mother_re   = NULL;
21107 }
21108 #endif /* PERL_IN_XSUB_RE */
21109
21110 /*
21111    regdupe_internal()
21112
21113    This is the internal complement to regdupe() which is used to copy
21114    the structure pointed to by the *pprivate pointer in the regexp.
21115    This is the core version of the extension overridable cloning hook.
21116    The regexp structure being duplicated will be copied by perl prior
21117    to this and will be provided as the regexp *r argument, however
21118    with the /old/ structures pprivate pointer value. Thus this routine
21119    may override any copying normally done by perl.
21120
21121    It returns a pointer to the new regexp_internal structure.
21122 */
21123
21124 void *
21125 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
21126 {
21127     dVAR;
21128     struct regexp *const r = ReANY(rx);
21129     regexp_internal *reti;
21130     int len;
21131     RXi_GET_DECL(r, ri);
21132
21133     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
21134
21135     len = ProgLen(ri);
21136
21137     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
21138           char, regexp_internal);
21139     Copy(ri->program, reti->program, len+1, regnode);
21140
21141
21142     if (ri->code_blocks) {
21143         int n;
21144         Newx(reti->code_blocks, 1, struct reg_code_blocks);
21145         Newx(reti->code_blocks->cb, ri->code_blocks->count,
21146                     struct reg_code_block);
21147         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
21148              ri->code_blocks->count, struct reg_code_block);
21149         for (n = 0; n < ri->code_blocks->count; n++)
21150              reti->code_blocks->cb[n].src_regex = (REGEXP*)
21151                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
21152         reti->code_blocks->count = ri->code_blocks->count;
21153         reti->code_blocks->refcnt = 1;
21154     }
21155     else
21156         reti->code_blocks = NULL;
21157
21158     reti->regstclass = NULL;
21159
21160     if (ri->data) {
21161         struct reg_data *d;
21162         const int count = ri->data->count;
21163         int i;
21164
21165         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
21166                 char, struct reg_data);
21167         Newx(d->what, count, U8);
21168
21169         d->count = count;
21170         for (i = 0; i < count; i++) {
21171             d->what[i] = ri->data->what[i];
21172             switch (d->what[i]) {
21173                 /* see also regcomp.h and regfree_internal() */
21174             case 'a': /* actually an AV, but the dup function is identical.
21175                          values seem to be "plain sv's" generally. */
21176             case 'r': /* a compiled regex (but still just another SV) */
21177             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
21178                          this use case should go away, the code could have used
21179                          'a' instead - see S_set_ANYOF_arg() for array contents. */
21180             case 'S': /* actually an SV, but the dup function is identical.  */
21181             case 'u': /* actually an HV, but the dup function is identical.
21182                          values are "plain sv's" */
21183                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
21184                 break;
21185             case 'f':
21186                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
21187                  * patterns which could start with several different things. Pre-TRIE
21188                  * this was more important than it is now, however this still helps
21189                  * in some places, for instance /x?a+/ might produce a SSC equivalent
21190                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
21191                  * in regexec.c
21192                  */
21193                 /* This is cheating. */
21194                 Newx(d->data[i], 1, regnode_ssc);
21195                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
21196                 reti->regstclass = (regnode*)d->data[i];
21197                 break;
21198             case 'T':
21199                 /* AHO-CORASICK fail table */
21200                 /* Trie stclasses are readonly and can thus be shared
21201                  * without duplication. We free the stclass in pregfree
21202                  * when the corresponding reg_ac_data struct is freed.
21203                  */
21204                 reti->regstclass= ri->regstclass;
21205                 /* FALLTHROUGH */
21206             case 't':
21207                 /* TRIE transition table */
21208                 OP_REFCNT_LOCK;
21209                 ((reg_trie_data*)ri->data->data[i])->refcount++;
21210                 OP_REFCNT_UNLOCK;
21211                 /* FALLTHROUGH */
21212             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
21213             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
21214                          is not from another regexp */
21215                 d->data[i] = ri->data->data[i];
21216                 break;
21217             default:
21218                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
21219                                                            ri->data->what[i]);
21220             }
21221         }
21222
21223         reti->data = d;
21224     }
21225     else
21226         reti->data = NULL;
21227
21228     reti->name_list_idx = ri->name_list_idx;
21229
21230 #ifdef RE_TRACK_PATTERN_OFFSETS
21231     if (ri->u.offsets) {
21232         Newx(reti->u.offsets, 2*len+1, U32);
21233         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
21234     }
21235 #else
21236     SetProgLen(reti, len);
21237 #endif
21238
21239     return (void*)reti;
21240 }
21241
21242 #endif    /* USE_ITHREADS */
21243
21244 #ifndef PERL_IN_XSUB_RE
21245
21246 /*
21247  - regnext - dig the "next" pointer out of a node
21248  */
21249 regnode *
21250 Perl_regnext(pTHX_ regnode *p)
21251 {
21252     I32 offset;
21253
21254     if (!p)
21255         return(NULL);
21256
21257     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
21258         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
21259                                                 (int)OP(p), (int)REGNODE_MAX);
21260     }
21261
21262     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
21263     if (offset == 0)
21264         return(NULL);
21265
21266     return(p+offset);
21267 }
21268
21269 #endif
21270
21271 STATIC void
21272 S_re_croak2(pTHX_ bool utf8, const char* pat1, const char* pat2,...)
21273 {
21274     va_list args;
21275     STRLEN l1 = strlen(pat1);
21276     STRLEN l2 = strlen(pat2);
21277     char buf[512];
21278     SV *msv;
21279     const char *message;
21280
21281     PERL_ARGS_ASSERT_RE_CROAK2;
21282
21283     if (l1 > 510)
21284         l1 = 510;
21285     if (l1 + l2 > 510)
21286         l2 = 510 - l1;
21287     Copy(pat1, buf, l1 , char);
21288     Copy(pat2, buf + l1, l2 , char);
21289     buf[l1 + l2] = '\n';
21290     buf[l1 + l2 + 1] = '\0';
21291     va_start(args, pat2);
21292     msv = vmess(buf, &args);
21293     va_end(args);
21294     message = SvPV_const(msv, l1);
21295     if (l1 > 512)
21296         l1 = 512;
21297     Copy(message, buf, l1 , char);
21298     /* l1-1 to avoid \n */
21299     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, l1-1, buf));
21300 }
21301
21302 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
21303
21304 #ifndef PERL_IN_XSUB_RE
21305 void
21306 Perl_save_re_context(pTHX)
21307 {
21308     I32 nparens = -1;
21309     I32 i;
21310
21311     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
21312
21313     if (PL_curpm) {
21314         const REGEXP * const rx = PM_GETRE(PL_curpm);
21315         if (rx)
21316             nparens = RX_NPARENS(rx);
21317     }
21318
21319     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
21320      * that PL_curpm will be null, but that utf8.pm and the modules it
21321      * loads will only use $1..$3.
21322      * The t/porting/re_context.t test file checks this assumption.
21323      */
21324     if (nparens == -1)
21325         nparens = 3;
21326
21327     for (i = 1; i <= nparens; i++) {
21328         char digits[TYPE_CHARS(long)];
21329         const STRLEN len = my_snprintf(digits, sizeof(digits),
21330                                        "%lu", (long)i);
21331         GV *const *const gvp
21332             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
21333
21334         if (gvp) {
21335             GV * const gv = *gvp;
21336             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
21337                 save_scalar(gv);
21338         }
21339     }
21340 }
21341 #endif
21342
21343 #ifdef DEBUGGING
21344
21345 STATIC void
21346 S_put_code_point(pTHX_ SV *sv, UV c)
21347 {
21348     PERL_ARGS_ASSERT_PUT_CODE_POINT;
21349
21350     if (c > 255) {
21351         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
21352     }
21353     else if (isPRINT(c)) {
21354         const char string = (char) c;
21355
21356         /* We use {phrase} as metanotation in the class, so also escape literal
21357          * braces */
21358         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
21359             sv_catpvs(sv, "\\");
21360         sv_catpvn(sv, &string, 1);
21361     }
21362     else if (isMNEMONIC_CNTRL(c)) {
21363         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
21364     }
21365     else {
21366         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
21367     }
21368 }
21369
21370 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
21371
21372 STATIC void
21373 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
21374 {
21375     /* Appends to 'sv' a displayable version of the range of code points from
21376      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
21377      * that have them, when they occur at the beginning or end of the range.
21378      * It uses hex to output the remaining code points, unless 'allow_literals'
21379      * is true, in which case the printable ASCII ones are output as-is (though
21380      * some of these will be escaped by put_code_point()).
21381      *
21382      * NOTE:  This is designed only for printing ranges of code points that fit
21383      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
21384      */
21385
21386     const unsigned int min_range_count = 3;
21387
21388     assert(start <= end);
21389
21390     PERL_ARGS_ASSERT_PUT_RANGE;
21391
21392     while (start <= end) {
21393         UV this_end;
21394         const char * format;
21395
21396         if (end - start < min_range_count) {
21397
21398             /* Output chars individually when they occur in short ranges */
21399             for (; start <= end; start++) {
21400                 put_code_point(sv, start);
21401             }
21402             break;
21403         }
21404
21405         /* If permitted by the input options, and there is a possibility that
21406          * this range contains a printable literal, look to see if there is
21407          * one. */
21408         if (allow_literals && start <= MAX_PRINT_A) {
21409
21410             /* If the character at the beginning of the range isn't an ASCII
21411              * printable, effectively split the range into two parts:
21412              *  1) the portion before the first such printable,
21413              *  2) the rest
21414              * and output them separately. */
21415             if (! isPRINT_A(start)) {
21416                 UV temp_end = start + 1;
21417
21418                 /* There is no point looking beyond the final possible
21419                  * printable, in MAX_PRINT_A */
21420                 UV max = MIN(end, MAX_PRINT_A);
21421
21422                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
21423                     temp_end++;
21424                 }
21425
21426                 /* Here, temp_end points to one beyond the first printable if
21427                  * found, or to one beyond 'max' if not.  If none found, make
21428                  * sure that we use the entire range */
21429                 if (temp_end > MAX_PRINT_A) {
21430                     temp_end = end + 1;
21431                 }
21432
21433                 /* Output the first part of the split range: the part that
21434                  * doesn't have printables, with the parameter set to not look
21435                  * for literals (otherwise we would infinitely recurse) */
21436                 put_range(sv, start, temp_end - 1, FALSE);
21437
21438                 /* The 2nd part of the range (if any) starts here. */
21439                 start = temp_end;
21440
21441                 /* We do a continue, instead of dropping down, because even if
21442                  * the 2nd part is non-empty, it could be so short that we want
21443                  * to output it as individual characters, as tested for at the
21444                  * top of this loop.  */
21445                 continue;
21446             }
21447
21448             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
21449              * output a sub-range of just the digits or letters, then process
21450              * the remaining portion as usual. */
21451             if (isALPHANUMERIC_A(start)) {
21452                 UV mask = (isDIGIT_A(start))
21453                            ? _CC_DIGIT
21454                              : isUPPER_A(start)
21455                                ? _CC_UPPER
21456                                : _CC_LOWER;
21457                 UV temp_end = start + 1;
21458
21459                 /* Find the end of the sub-range that includes just the
21460                  * characters in the same class as the first character in it */
21461                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
21462                     temp_end++;
21463                 }
21464                 temp_end--;
21465
21466                 /* For short ranges, don't duplicate the code above to output
21467                  * them; just call recursively */
21468                 if (temp_end - start < min_range_count) {
21469                     put_range(sv, start, temp_end, FALSE);
21470                 }
21471                 else {  /* Output as a range */
21472                     put_code_point(sv, start);
21473                     sv_catpvs(sv, "-");
21474                     put_code_point(sv, temp_end);
21475                 }
21476                 start = temp_end + 1;
21477                 continue;
21478             }
21479
21480             /* We output any other printables as individual characters */
21481             if (isPUNCT_A(start) || isSPACE_A(start)) {
21482                 while (start <= end && (isPUNCT_A(start)
21483                                         || isSPACE_A(start)))
21484                 {
21485                     put_code_point(sv, start);
21486                     start++;
21487                 }
21488                 continue;
21489             }
21490         } /* End of looking for literals */
21491
21492         /* Here is not to output as a literal.  Some control characters have
21493          * mnemonic names.  Split off any of those at the beginning and end of
21494          * the range to print mnemonically.  It isn't possible for many of
21495          * these to be in a row, so this won't overwhelm with output */
21496         if (   start <= end
21497             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
21498         {
21499             while (isMNEMONIC_CNTRL(start) && start <= end) {
21500                 put_code_point(sv, start);
21501                 start++;
21502             }
21503
21504             /* If this didn't take care of the whole range ... */
21505             if (start <= end) {
21506
21507                 /* Look backwards from the end to find the final non-mnemonic
21508                  * */
21509                 UV temp_end = end;
21510                 while (isMNEMONIC_CNTRL(temp_end)) {
21511                     temp_end--;
21512                 }
21513
21514                 /* And separately output the interior range that doesn't start
21515                  * or end with mnemonics */
21516                 put_range(sv, start, temp_end, FALSE);
21517
21518                 /* Then output the mnemonic trailing controls */
21519                 start = temp_end + 1;
21520                 while (start <= end) {
21521                     put_code_point(sv, start);
21522                     start++;
21523                 }
21524                 break;
21525             }
21526         }
21527
21528         /* As a final resort, output the range or subrange as hex. */
21529
21530         if (start >= NUM_ANYOF_CODE_POINTS) {
21531             this_end = end;
21532         }
21533         else {
21534             this_end = (end < NUM_ANYOF_CODE_POINTS)
21535                         ? end
21536                         : NUM_ANYOF_CODE_POINTS - 1;
21537         }
21538 #if NUM_ANYOF_CODE_POINTS > 256
21539         format = (this_end < 256)
21540                  ? "\\x%02" UVXf "-\\x%02" UVXf
21541                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
21542 #else
21543         format = "\\x%02" UVXf "-\\x%02" UVXf;
21544 #endif
21545         GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral);
21546         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
21547         GCC_DIAG_RESTORE_STMT;
21548         break;
21549     }
21550 }
21551
21552 STATIC void
21553 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
21554 {
21555     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
21556      * 'invlist' */
21557
21558     UV start, end;
21559     bool allow_literals = TRUE;
21560
21561     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
21562
21563     /* Generally, it is more readable if printable characters are output as
21564      * literals, but if a range (nearly) spans all of them, it's best to output
21565      * it as a single range.  This code will use a single range if all but 2
21566      * ASCII printables are in it */
21567     invlist_iterinit(invlist);
21568     while (invlist_iternext(invlist, &start, &end)) {
21569
21570         /* If the range starts beyond the final printable, it doesn't have any
21571          * in it */
21572         if (start > MAX_PRINT_A) {
21573             break;
21574         }
21575
21576         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
21577          * all but two, the range must start and end no later than 2 from
21578          * either end */
21579         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
21580             if (end > MAX_PRINT_A) {
21581                 end = MAX_PRINT_A;
21582             }
21583             if (start < ' ') {
21584                 start = ' ';
21585             }
21586             if (end - start >= MAX_PRINT_A - ' ' - 2) {
21587                 allow_literals = FALSE;
21588             }
21589             break;
21590         }
21591     }
21592     invlist_iterfinish(invlist);
21593
21594     /* Here we have figured things out.  Output each range */
21595     invlist_iterinit(invlist);
21596     while (invlist_iternext(invlist, &start, &end)) {
21597         if (start >= NUM_ANYOF_CODE_POINTS) {
21598             break;
21599         }
21600         put_range(sv, start, end, allow_literals);
21601     }
21602     invlist_iterfinish(invlist);
21603
21604     return;
21605 }
21606
21607 STATIC SV*
21608 S_put_charclass_bitmap_innards_common(pTHX_
21609         SV* invlist,            /* The bitmap */
21610         SV* posixes,            /* Under /l, things like [:word:], \S */
21611         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
21612         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
21613         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
21614         const bool invert       /* Is the result to be inverted? */
21615 )
21616 {
21617     /* Create and return an SV containing a displayable version of the bitmap
21618      * and associated information determined by the input parameters.  If the
21619      * output would have been only the inversion indicator '^', NULL is instead
21620      * returned. */
21621
21622     dVAR;
21623     SV * output;
21624
21625     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
21626
21627     if (invert) {
21628         output = newSVpvs("^");
21629     }
21630     else {
21631         output = newSVpvs("");
21632     }
21633
21634     /* First, the code points in the bitmap that are unconditionally there */
21635     put_charclass_bitmap_innards_invlist(output, invlist);
21636
21637     /* Traditionally, these have been placed after the main code points */
21638     if (posixes) {
21639         sv_catsv(output, posixes);
21640     }
21641
21642     if (only_utf8 && _invlist_len(only_utf8)) {
21643         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
21644         put_charclass_bitmap_innards_invlist(output, only_utf8);
21645     }
21646
21647     if (not_utf8 && _invlist_len(not_utf8)) {
21648         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
21649         put_charclass_bitmap_innards_invlist(output, not_utf8);
21650     }
21651
21652     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
21653         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
21654         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
21655
21656         /* This is the only list in this routine that can legally contain code
21657          * points outside the bitmap range.  The call just above to
21658          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
21659          * output them here.  There's about a half-dozen possible, and none in
21660          * contiguous ranges longer than 2 */
21661         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21662             UV start, end;
21663             SV* above_bitmap = NULL;
21664
21665             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
21666
21667             invlist_iterinit(above_bitmap);
21668             while (invlist_iternext(above_bitmap, &start, &end)) {
21669                 UV i;
21670
21671                 for (i = start; i <= end; i++) {
21672                     put_code_point(output, i);
21673                 }
21674             }
21675             invlist_iterfinish(above_bitmap);
21676             SvREFCNT_dec_NN(above_bitmap);
21677         }
21678     }
21679
21680     if (invert && SvCUR(output) == 1) {
21681         return NULL;
21682     }
21683
21684     return output;
21685 }
21686
21687 STATIC bool
21688 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
21689                                      char *bitmap,
21690                                      SV *nonbitmap_invlist,
21691                                      SV *only_utf8_locale_invlist,
21692                                      const regnode * const node,
21693                                      const bool force_as_is_display)
21694 {
21695     /* Appends to 'sv' a displayable version of the innards of the bracketed
21696      * character class defined by the other arguments:
21697      *  'bitmap' points to the bitmap, or NULL if to ignore that.
21698      *  'nonbitmap_invlist' is an inversion list of the code points that are in
21699      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
21700      *      none.  The reasons for this could be that they require some
21701      *      condition such as the target string being or not being in UTF-8
21702      *      (under /d), or because they came from a user-defined property that
21703      *      was not resolved at the time of the regex compilation (under /u)
21704      *  'only_utf8_locale_invlist' is an inversion list of the code points that
21705      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
21706      *  'node' is the regex pattern ANYOF node.  It is needed only when the
21707      *      above two parameters are not null, and is passed so that this
21708      *      routine can tease apart the various reasons for them.
21709      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
21710      *      to invert things to see if that leads to a cleaner display.  If
21711      *      FALSE, this routine is free to use its judgment about doing this.
21712      *
21713      * It returns TRUE if there was actually something output.  (It may be that
21714      * the bitmap, etc is empty.)
21715      *
21716      * When called for outputting the bitmap of a non-ANYOF node, just pass the
21717      * bitmap, with the succeeding parameters set to NULL, and the final one to
21718      * FALSE.
21719      */
21720
21721     /* In general, it tries to display the 'cleanest' representation of the
21722      * innards, choosing whether to display them inverted or not, regardless of
21723      * whether the class itself is to be inverted.  However,  there are some
21724      * cases where it can't try inverting, as what actually matches isn't known
21725      * until runtime, and hence the inversion isn't either. */
21726
21727     dVAR;
21728     bool inverting_allowed = ! force_as_is_display;
21729
21730     int i;
21731     STRLEN orig_sv_cur = SvCUR(sv);
21732
21733     SV* invlist;            /* Inversion list we accumulate of code points that
21734                                are unconditionally matched */
21735     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
21736                                UTF-8 */
21737     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
21738                              */
21739     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
21740     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
21741                                        is UTF-8 */
21742
21743     SV* as_is_display;      /* The output string when we take the inputs
21744                                literally */
21745     SV* inverted_display;   /* The output string when we invert the inputs */
21746
21747     U8 flags = (node) ? ANYOF_FLAGS(node) : 0;
21748
21749     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
21750                                                    to match? */
21751     /* We are biased in favor of displaying things without them being inverted,
21752      * as that is generally easier to understand */
21753     const int bias = 5;
21754
21755     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
21756
21757     /* Start off with whatever code points are passed in.  (We clone, so we
21758      * don't change the caller's list) */
21759     if (nonbitmap_invlist) {
21760         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
21761         invlist = invlist_clone(nonbitmap_invlist, NULL);
21762     }
21763     else {  /* Worst case size is every other code point is matched */
21764         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
21765     }
21766
21767     if (flags) {
21768         if (OP(node) == ANYOFD) {
21769
21770             /* This flag indicates that the code points below 0x100 in the
21771              * nonbitmap list are precisely the ones that match only when the
21772              * target is UTF-8 (they should all be non-ASCII). */
21773             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
21774             {
21775                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
21776                 _invlist_subtract(invlist, only_utf8, &invlist);
21777             }
21778
21779             /* And this flag for matching all non-ASCII 0xFF and below */
21780             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
21781             {
21782                 not_utf8 = invlist_clone(PL_UpperLatin1, NULL);
21783             }
21784         }
21785         else if (OP(node) == ANYOFL || OP(node) == ANYOFPOSIXL) {
21786
21787             /* If either of these flags are set, what matches isn't
21788              * determinable except during execution, so don't know enough here
21789              * to invert */
21790             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
21791                 inverting_allowed = FALSE;
21792             }
21793
21794             /* What the posix classes match also varies at runtime, so these
21795              * will be output symbolically. */
21796             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
21797                 int i;
21798
21799                 posixes = newSVpvs("");
21800                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
21801                     if (ANYOF_POSIXL_TEST(node, i)) {
21802                         sv_catpv(posixes, anyofs[i]);
21803                     }
21804                 }
21805             }
21806         }
21807     }
21808
21809     /* Accumulate the bit map into the unconditional match list */
21810     if (bitmap) {
21811         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
21812             if (BITMAP_TEST(bitmap, i)) {
21813                 int start = i++;
21814                 for (;
21815                      i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i);
21816                      i++)
21817                 { /* empty */ }
21818                 invlist = _add_range_to_invlist(invlist, start, i-1);
21819             }
21820         }
21821     }
21822
21823     /* Make sure that the conditional match lists don't have anything in them
21824      * that match unconditionally; otherwise the output is quite confusing.
21825      * This could happen if the code that populates these misses some
21826      * duplication. */
21827     if (only_utf8) {
21828         _invlist_subtract(only_utf8, invlist, &only_utf8);
21829     }
21830     if (not_utf8) {
21831         _invlist_subtract(not_utf8, invlist, &not_utf8);
21832     }
21833
21834     if (only_utf8_locale_invlist) {
21835
21836         /* Since this list is passed in, we have to make a copy before
21837          * modifying it */
21838         only_utf8_locale = invlist_clone(only_utf8_locale_invlist, NULL);
21839
21840         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
21841
21842         /* And, it can get really weird for us to try outputting an inverted
21843          * form of this list when it has things above the bitmap, so don't even
21844          * try */
21845         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
21846             inverting_allowed = FALSE;
21847         }
21848     }
21849
21850     /* Calculate what the output would be if we take the input as-is */
21851     as_is_display = put_charclass_bitmap_innards_common(invlist,
21852                                                     posixes,
21853                                                     only_utf8,
21854                                                     not_utf8,
21855                                                     only_utf8_locale,
21856                                                     invert);
21857
21858     /* If have to take the output as-is, just do that */
21859     if (! inverting_allowed) {
21860         if (as_is_display) {
21861             sv_catsv(sv, as_is_display);
21862             SvREFCNT_dec_NN(as_is_display);
21863         }
21864     }
21865     else { /* But otherwise, create the output again on the inverted input, and
21866               use whichever version is shorter */
21867
21868         int inverted_bias, as_is_bias;
21869
21870         /* We will apply our bias to whichever of the the results doesn't have
21871          * the '^' */
21872         if (invert) {
21873             invert = FALSE;
21874             as_is_bias = bias;
21875             inverted_bias = 0;
21876         }
21877         else {
21878             invert = TRUE;
21879             as_is_bias = 0;
21880             inverted_bias = bias;
21881         }
21882
21883         /* Now invert each of the lists that contribute to the output,
21884          * excluding from the result things outside the possible range */
21885
21886         /* For the unconditional inversion list, we have to add in all the
21887          * conditional code points, so that when inverted, they will be gone
21888          * from it */
21889         _invlist_union(only_utf8, invlist, &invlist);
21890         _invlist_union(not_utf8, invlist, &invlist);
21891         _invlist_union(only_utf8_locale, invlist, &invlist);
21892         _invlist_invert(invlist);
21893         _invlist_intersection(invlist, PL_InBitmap, &invlist);
21894
21895         if (only_utf8) {
21896             _invlist_invert(only_utf8);
21897             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
21898         }
21899         else if (not_utf8) {
21900
21901             /* If a code point matches iff the target string is not in UTF-8,
21902              * then complementing the result has it not match iff not in UTF-8,
21903              * which is the same thing as matching iff it is UTF-8. */
21904             only_utf8 = not_utf8;
21905             not_utf8 = NULL;
21906         }
21907
21908         if (only_utf8_locale) {
21909             _invlist_invert(only_utf8_locale);
21910             _invlist_intersection(only_utf8_locale,
21911                                   PL_InBitmap,
21912                                   &only_utf8_locale);
21913         }
21914
21915         inverted_display = put_charclass_bitmap_innards_common(
21916                                             invlist,
21917                                             posixes,
21918                                             only_utf8,
21919                                             not_utf8,
21920                                             only_utf8_locale, invert);
21921
21922         /* Use the shortest representation, taking into account our bias
21923          * against showing it inverted */
21924         if (   inverted_display
21925             && (   ! as_is_display
21926                 || (  SvCUR(inverted_display) + inverted_bias
21927                     < SvCUR(as_is_display)    + as_is_bias)))
21928         {
21929             sv_catsv(sv, inverted_display);
21930         }
21931         else if (as_is_display) {
21932             sv_catsv(sv, as_is_display);
21933         }
21934
21935         SvREFCNT_dec(as_is_display);
21936         SvREFCNT_dec(inverted_display);
21937     }
21938
21939     SvREFCNT_dec_NN(invlist);
21940     SvREFCNT_dec(only_utf8);
21941     SvREFCNT_dec(not_utf8);
21942     SvREFCNT_dec(posixes);
21943     SvREFCNT_dec(only_utf8_locale);
21944
21945     return SvCUR(sv) > orig_sv_cur;
21946 }
21947
21948 #define CLEAR_OPTSTART                                                       \
21949     if (optstart) STMT_START {                                               \
21950         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
21951                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
21952         optstart=NULL;                                                       \
21953     } STMT_END
21954
21955 #define DUMPUNTIL(b,e)                                                       \
21956                     CLEAR_OPTSTART;                                          \
21957                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
21958
21959 STATIC const regnode *
21960 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
21961             const regnode *last, const regnode *plast,
21962             SV* sv, I32 indent, U32 depth)
21963 {
21964     U8 op = PSEUDO;     /* Arbitrary non-END op. */
21965     const regnode *next;
21966     const regnode *optstart= NULL;
21967
21968     RXi_GET_DECL(r, ri);
21969     GET_RE_DEBUG_FLAGS_DECL;
21970
21971     PERL_ARGS_ASSERT_DUMPUNTIL;
21972
21973 #ifdef DEBUG_DUMPUNTIL
21974     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n", indent, node-start,
21975         last ? last-start : 0, plast ? plast-start : 0);
21976 #endif
21977
21978     if (plast && plast < last)
21979         last= plast;
21980
21981     while (PL_regkind[op] != END && (!last || node < last)) {
21982         assert(node);
21983         /* While that wasn't END last time... */
21984         NODE_ALIGN(node);
21985         op = OP(node);
21986         if (op == CLOSE || op == SRCLOSE || op == WHILEM)
21987             indent--;
21988         next = regnext((regnode *)node);
21989
21990         /* Where, what. */
21991         if (OP(node) == OPTIMIZED) {
21992             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
21993                 optstart = node;
21994             else
21995                 goto after_print;
21996         } else
21997             CLEAR_OPTSTART;
21998
21999         regprop(r, sv, node, NULL, NULL);
22000         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
22001                       (int)(2*indent + 1), "", SvPVX_const(sv));
22002
22003         if (OP(node) != OPTIMIZED) {
22004             if (next == NULL)           /* Next ptr. */
22005                 Perl_re_printf( aTHX_  " (0)");
22006             else if (PL_regkind[(U8)op] == BRANCH
22007                      && PL_regkind[OP(next)] != BRANCH )
22008                 Perl_re_printf( aTHX_  " (FAIL)");
22009             else
22010                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
22011             Perl_re_printf( aTHX_ "\n");
22012         }
22013
22014       after_print:
22015         if (PL_regkind[(U8)op] == BRANCHJ) {
22016             assert(next);
22017             {
22018                 const regnode *nnode = (OP(next) == LONGJMP
22019                                        ? regnext((regnode *)next)
22020                                        : next);
22021                 if (last && nnode > last)
22022                     nnode = last;
22023                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
22024             }
22025         }
22026         else if (PL_regkind[(U8)op] == BRANCH) {
22027             assert(next);
22028             DUMPUNTIL(NEXTOPER(node), next);
22029         }
22030         else if ( PL_regkind[(U8)op]  == TRIE ) {
22031             const regnode *this_trie = node;
22032             const char op = OP(node);
22033             const U32 n = ARG(node);
22034             const reg_ac_data * const ac = op>=AHOCORASICK ?
22035                (reg_ac_data *)ri->data->data[n] :
22036                NULL;
22037             const reg_trie_data * const trie =
22038                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
22039 #ifdef DEBUGGING
22040             AV *const trie_words
22041                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
22042 #endif
22043             const regnode *nextbranch= NULL;
22044             I32 word_idx;
22045             SvPVCLEAR(sv);
22046             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
22047                 SV ** const elem_ptr = av_fetch(trie_words, word_idx, 0);
22048
22049                 Perl_re_indentf( aTHX_  "%s ",
22050                     indent+3,
22051                     elem_ptr
22052                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
22053                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
22054                                 PL_colors[0], PL_colors[1],
22055                                 (SvUTF8(*elem_ptr)
22056                                  ? PERL_PV_ESCAPE_UNI
22057                                  : 0)
22058                                 | PERL_PV_PRETTY_ELLIPSES
22059                                 | PERL_PV_PRETTY_LTGT
22060                             )
22061                     : "???"
22062                 );
22063                 if (trie->jump) {
22064                     U16 dist= trie->jump[word_idx+1];
22065                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
22066                                (UV)((dist ? this_trie + dist : next) - start));
22067                     if (dist) {
22068                         if (!nextbranch)
22069                             nextbranch= this_trie + trie->jump[0];
22070                         DUMPUNTIL(this_trie + dist, nextbranch);
22071                     }
22072                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
22073                         nextbranch= regnext((regnode *)nextbranch);
22074                 } else {
22075                     Perl_re_printf( aTHX_  "\n");
22076                 }
22077             }
22078             if (last && next > last)
22079                 node= last;
22080             else
22081                 node= next;
22082         }
22083         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
22084             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
22085                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
22086         }
22087         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
22088             assert(next);
22089             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
22090         }
22091         else if ( op == PLUS || op == STAR) {
22092             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
22093         }
22094         else if (PL_regkind[(U8)op] == EXACT) {
22095             /* Literal string, where present. */
22096             node += NODE_SZ_STR(node) - 1;
22097             node = NEXTOPER(node);
22098         }
22099         else {
22100             node = NEXTOPER(node);
22101             node += regarglen[(U8)op];
22102         }
22103         if (op == CURLYX || op == OPEN || op == SROPEN)
22104             indent++;
22105     }
22106     CLEAR_OPTSTART;
22107 #ifdef DEBUG_DUMPUNTIL
22108     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
22109 #endif
22110     return node;
22111 }
22112
22113 #endif  /* DEBUGGING */
22114
22115 #ifndef PERL_IN_XSUB_RE
22116
22117 #include "uni_keywords.h"
22118
22119 void
22120 Perl_init_uniprops(pTHX)
22121 {
22122     dVAR;
22123
22124     PL_user_def_props = newHV();
22125
22126 #ifdef USE_ITHREADS
22127
22128     HvSHAREKEYS_off(PL_user_def_props);
22129     PL_user_def_props_aTHX = aTHX;
22130
22131 #endif
22132
22133     /* Set up the inversion list global variables */
22134
22135     PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
22136     PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALNUM]);
22137     PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALPHA]);
22138     PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXBLANK]);
22139     PL_XPosix_ptrs[_CC_CASED] =  _new_invlist_C_array(uni_prop_ptrs[UNI_CASED]);
22140     PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXCNTRL]);
22141     PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXDIGIT]);
22142     PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXGRAPH]);
22143     PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXLOWER]);
22144     PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPRINT]);
22145     PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPUNCT]);
22146     PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXSPACE]);
22147     PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXUPPER]);
22148     PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_VERTSPACE]);
22149     PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXWORD]);
22150     PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXXDIGIT]);
22151
22152     PL_Posix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
22153     PL_Posix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALNUM]);
22154     PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALPHA]);
22155     PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXBLANK]);
22156     PL_Posix_ptrs[_CC_CASED] = PL_Posix_ptrs[_CC_ALPHA];
22157     PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXCNTRL]);
22158     PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXDIGIT]);
22159     PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXGRAPH]);
22160     PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXLOWER]);
22161     PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPRINT]);
22162     PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPUNCT]);
22163     PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXSPACE]);
22164     PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXUPPER]);
22165     PL_Posix_ptrs[_CC_VERTSPACE] = NULL;
22166     PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXWORD]);
22167     PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXXDIGIT]);
22168
22169     PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
22170     PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
22171     PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
22172     PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
22173     PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
22174
22175     PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
22176     PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
22177     PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
22178
22179     PL_Assigned_invlist = _new_invlist_C_array(uni_prop_ptrs[UNI_ASSIGNED]);
22180
22181     PL_utf8_perl_idstart = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDSTART]);
22182     PL_utf8_perl_idcont = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDCONT]);
22183
22184     PL_utf8_charname_begin = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_BEGIN]);
22185     PL_utf8_charname_continue = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_CONTINUE]);
22186
22187     PL_in_some_fold = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_ANY_FOLDS]);
22188     PL_HasMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
22189                                             UNI__PERL_FOLDS_TO_MULTI_CHAR]);
22190     PL_InMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
22191                                             UNI__PERL_IS_IN_MULTI_CHAR_FOLD]);
22192     PL_NonFinalFold = _new_invlist_C_array(uni_prop_ptrs[
22193                                             UNI__PERL_NON_FINAL_FOLDS]);
22194
22195     PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
22196     PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
22197     PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
22198     PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
22199     PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
22200     PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
22201     PL_utf8_mark = _new_invlist_C_array(uni_prop_ptrs[UNI_M]);
22202     PL_CCC_non0_non230 = _new_invlist_C_array(_Perl_CCC_non0_non230_invlist);
22203     PL_Private_Use = _new_invlist_C_array(uni_prop_ptrs[UNI_CO]);
22204
22205 #ifdef UNI_XIDC
22206     /* The below are used only by deprecated functions.  They could be removed */
22207     PL_utf8_xidcont  = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDC]);
22208     PL_utf8_idcont   = _new_invlist_C_array(uni_prop_ptrs[UNI_IDC]);
22209     PL_utf8_xidstart = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDS]);
22210 #endif
22211 }
22212
22213 #if 0
22214
22215 This code was mainly added for backcompat to give a warning for non-portable
22216 code points in user-defined properties.  But experiments showed that the
22217 warning in earlier perls were only omitted on overflow, which should be an
22218 error, so there really isnt a backcompat issue, and actually adding the
22219 warning when none was present before might cause breakage, for little gain.  So
22220 khw left this code in, but not enabled.  Tests were never added.
22221
22222 embed.fnc entry:
22223 Ei      |const char *|get_extended_utf8_msg|const UV cp
22224
22225 PERL_STATIC_INLINE const char *
22226 S_get_extended_utf8_msg(pTHX_ const UV cp)
22227 {
22228     U8 dummy[UTF8_MAXBYTES + 1];
22229     HV *msgs;
22230     SV **msg;
22231
22232     uvchr_to_utf8_flags_msgs(dummy, cp, UNICODE_WARN_PERL_EXTENDED,
22233                              &msgs);
22234
22235     msg = hv_fetchs(msgs, "text", 0);
22236     assert(msg);
22237
22238     (void) sv_2mortal((SV *) msgs);
22239
22240     return SvPVX(*msg);
22241 }
22242
22243 #endif
22244
22245 SV *
22246 Perl_handle_user_defined_property(pTHX_
22247
22248     /* Parses the contents of a user-defined property definition; returning the
22249      * expanded definition if possible.  If so, the return is an inversion
22250      * list.
22251      *
22252      * If there are subroutines that are part of the expansion and which aren't
22253      * known at the time of the call to this function, this returns what
22254      * parse_uniprop_string() returned for the first one encountered.
22255      *
22256      * If an error was found, NULL is returned, and 'msg' gets a suitable
22257      * message appended to it.  (Appending allows the back trace of how we got
22258      * to the faulty definition to be displayed through nested calls of
22259      * user-defined subs.)
22260      *
22261      * The caller IS responsible for freeing any returned SV.
22262      *
22263      * The syntax of the contents is pretty much described in perlunicode.pod,
22264      * but we also allow comments on each line */
22265
22266     const char * name,          /* Name of property */
22267     const STRLEN name_len,      /* The name's length in bytes */
22268     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22269     const bool to_fold,         /* ? Is this under /i */
22270     const bool runtime,         /* ? Are we in compile- or run-time */
22271     const bool deferrable,      /* Is it ok for this property's full definition
22272                                    to be deferred until later? */
22273     SV* contents,               /* The property's definition */
22274     bool *user_defined_ptr,     /* This will be set TRUE as we wouldn't be
22275                                    getting called unless this is thought to be
22276                                    a user-defined property */
22277     SV * msg,                   /* Any error or warning msg(s) are appended to
22278                                    this */
22279     const STRLEN level)         /* Recursion level of this call */
22280 {
22281     STRLEN len;
22282     const char * string         = SvPV_const(contents, len);
22283     const char * const e        = string + len;
22284     const bool is_contents_utf8 = cBOOL(SvUTF8(contents));
22285     const STRLEN msgs_length_on_entry = SvCUR(msg);
22286
22287     const char * s0 = string;   /* Points to first byte in the current line
22288                                    being parsed in 'string' */
22289     const char overflow_msg[] = "Code point too large in \"";
22290     SV* running_definition = NULL;
22291
22292     PERL_ARGS_ASSERT_HANDLE_USER_DEFINED_PROPERTY;
22293
22294     *user_defined_ptr = TRUE;
22295
22296     /* Look at each line */
22297     while (s0 < e) {
22298         const char * s;     /* Current byte */
22299         char op = '+';      /* Default operation is 'union' */
22300         IV   min = 0;       /* range begin code point */
22301         IV   max = -1;      /* and range end */
22302         SV* this_definition;
22303
22304         /* Skip comment lines */
22305         if (*s0 == '#') {
22306             s0 = strchr(s0, '\n');
22307             if (s0 == NULL) {
22308                 break;
22309             }
22310             s0++;
22311             continue;
22312         }
22313
22314         /* For backcompat, allow an empty first line */
22315         if (*s0 == '\n') {
22316             s0++;
22317             continue;
22318         }
22319
22320         /* First character in the line may optionally be the operation */
22321         if (   *s0 == '+'
22322             || *s0 == '!'
22323             || *s0 == '-'
22324             || *s0 == '&')
22325         {
22326             op = *s0++;
22327         }
22328
22329         /* If the line is one or two hex digits separated by blank space, its
22330          * a range; otherwise it is either another user-defined property or an
22331          * error */
22332
22333         s = s0;
22334
22335         if (! isXDIGIT(*s)) {
22336             goto check_if_property;
22337         }
22338
22339         do { /* Each new hex digit will add 4 bits. */
22340             if (min > ( (IV) MAX_LEGAL_CP >> 4)) {
22341                 s = strchr(s, '\n');
22342                 if (s == NULL) {
22343                     s = e;
22344                 }
22345                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22346                 sv_catpv(msg, overflow_msg);
22347                 Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22348                                      UTF8fARG(is_contents_utf8, s - s0, s0));
22349                 sv_catpvs(msg, "\"");
22350                 goto return_failure;
22351             }
22352
22353             /* Accumulate this digit into the value */
22354             min = (min << 4) + READ_XDIGIT(s);
22355         } while (isXDIGIT(*s));
22356
22357         while (isBLANK(*s)) { s++; }
22358
22359         /* We allow comments at the end of the line */
22360         if (*s == '#') {
22361             s = strchr(s, '\n');
22362             if (s == NULL) {
22363                 s = e;
22364             }
22365             s++;
22366         }
22367         else if (s < e && *s != '\n') {
22368             if (! isXDIGIT(*s)) {
22369                 goto check_if_property;
22370             }
22371
22372             /* Look for the high point of the range */
22373             max = 0;
22374             do {
22375                 if (max > ( (IV) MAX_LEGAL_CP >> 4)) {
22376                     s = strchr(s, '\n');
22377                     if (s == NULL) {
22378                         s = e;
22379                     }
22380                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22381                     sv_catpv(msg, overflow_msg);
22382                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22383                                       UTF8fARG(is_contents_utf8, s - s0, s0));
22384                     sv_catpvs(msg, "\"");
22385                     goto return_failure;
22386                 }
22387
22388                 max = (max << 4) + READ_XDIGIT(s);
22389             } while (isXDIGIT(*s));
22390
22391             while (isBLANK(*s)) { s++; }
22392
22393             if (*s == '#') {
22394                 s = strchr(s, '\n');
22395                 if (s == NULL) {
22396                     s = e;
22397                 }
22398             }
22399             else if (s < e && *s != '\n') {
22400                 goto check_if_property;
22401             }
22402         }
22403
22404         if (max == -1) {    /* The line only had one entry */
22405             max = min;
22406         }
22407         else if (max < min) {
22408             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22409             sv_catpvs(msg, "Illegal range in \"");
22410             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22411                                 UTF8fARG(is_contents_utf8, s - s0, s0));
22412             sv_catpvs(msg, "\"");
22413             goto return_failure;
22414         }
22415
22416 #if 0   /* See explanation at definition above of get_extended_utf8_msg() */
22417
22418         if (   UNICODE_IS_PERL_EXTENDED(min)
22419             || UNICODE_IS_PERL_EXTENDED(max))
22420         {
22421             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
22422
22423             /* If both code points are non-portable, warn only on the lower
22424              * one. */
22425             sv_catpv(msg, get_extended_utf8_msg(
22426                                             (UNICODE_IS_PERL_EXTENDED(min))
22427                                             ? min : max));
22428             sv_catpvs(msg, " in \"");
22429             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
22430                                  UTF8fARG(is_contents_utf8, s - s0, s0));
22431             sv_catpvs(msg, "\"");
22432         }
22433
22434 #endif
22435
22436         /* Here, this line contains a legal range */
22437         this_definition = sv_2mortal(_new_invlist(2));
22438         this_definition = _add_range_to_invlist(this_definition, min, max);
22439         goto calculate;
22440
22441       check_if_property:
22442
22443         /* Here it isn't a legal range line.  See if it is a legal property
22444          * line.  First find the end of the meat of the line */
22445         s = strpbrk(s, "#\n");
22446         if (s == NULL) {
22447             s = e;
22448         }
22449
22450         /* Ignore trailing blanks in keeping with the requirements of
22451          * parse_uniprop_string() */
22452         s--;
22453         while (s > s0 && isBLANK_A(*s)) {
22454             s--;
22455         }
22456         s++;
22457
22458         this_definition = parse_uniprop_string(s0, s - s0,
22459                                                is_utf8, to_fold, runtime,
22460                                                deferrable,
22461                                                user_defined_ptr, msg,
22462                                                (name_len == 0)
22463                                                 ? level /* Don't increase level
22464                                                            if input is empty */
22465                                                 : level + 1
22466                                               );
22467         if (this_definition == NULL) {
22468             goto return_failure;    /* 'msg' should have had the reason
22469                                        appended to it by the above call */
22470         }
22471
22472         if (! is_invlist(this_definition)) {    /* Unknown at this time */
22473             return newSVsv(this_definition);
22474         }
22475
22476         if (*s != '\n') {
22477             s = strchr(s, '\n');
22478             if (s == NULL) {
22479                 s = e;
22480             }
22481         }
22482
22483       calculate:
22484
22485         switch (op) {
22486             case '+':
22487                 _invlist_union(running_definition, this_definition,
22488                                                         &running_definition);
22489                 break;
22490             case '-':
22491                 _invlist_subtract(running_definition, this_definition,
22492                                                         &running_definition);
22493                 break;
22494             case '&':
22495                 _invlist_intersection(running_definition, this_definition,
22496                                                         &running_definition);
22497                 break;
22498             case '!':
22499                 _invlist_union_complement_2nd(running_definition,
22500                                         this_definition, &running_definition);
22501                 break;
22502             default:
22503                 Perl_croak(aTHX_ "panic: %s: %d: Unexpected operation %d",
22504                                  __FILE__, __LINE__, op);
22505                 break;
22506         }
22507
22508         /* Position past the '\n' */
22509         s0 = s + 1;
22510     }   /* End of loop through the lines of 'contents' */
22511
22512     /* Here, we processed all the lines in 'contents' without error.  If we
22513      * didn't add any warnings, simply return success */
22514     if (msgs_length_on_entry == SvCUR(msg)) {
22515
22516         /* If the expansion was empty, the answer isn't nothing: its an empty
22517          * inversion list */
22518         if (running_definition == NULL) {
22519             running_definition = _new_invlist(1);
22520         }
22521
22522         return running_definition;
22523     }
22524
22525     /* Otherwise, add some explanatory text, but we will return success */
22526     goto return_msg;
22527
22528   return_failure:
22529     running_definition = NULL;
22530
22531   return_msg:
22532
22533     if (name_len > 0) {
22534         sv_catpvs(msg, " in expansion of ");
22535         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
22536     }
22537
22538     return running_definition;
22539 }
22540
22541 /* As explained below, certain operations need to take place in the first
22542  * thread created.  These macros switch contexts */
22543 #ifdef USE_ITHREADS
22544 #  define DECLARATION_FOR_GLOBAL_CONTEXT                                    \
22545                                         PerlInterpreter * save_aTHX = aTHX;
22546 #  define SWITCH_TO_GLOBAL_CONTEXT                                          \
22547                            PERL_SET_CONTEXT((aTHX = PL_user_def_props_aTHX))
22548 #  define RESTORE_CONTEXT  PERL_SET_CONTEXT((aTHX = save_aTHX));
22549 #  define CUR_CONTEXT      aTHX
22550 #  define ORIGINAL_CONTEXT save_aTHX
22551 #else
22552 #  define DECLARATION_FOR_GLOBAL_CONTEXT
22553 #  define SWITCH_TO_GLOBAL_CONTEXT          NOOP
22554 #  define RESTORE_CONTEXT                   NOOP
22555 #  define CUR_CONTEXT                       NULL
22556 #  define ORIGINAL_CONTEXT                  NULL
22557 #endif
22558
22559 STATIC void
22560 S_delete_recursion_entry(pTHX_ void *key)
22561 {
22562     /* Deletes the entry used to detect recursion when expanding user-defined
22563      * properties.  This is a function so it can be set up to be called even if
22564      * the program unexpectedly quits */
22565
22566     dVAR;
22567     SV ** current_entry;
22568     const STRLEN key_len = strlen((const char *) key);
22569     DECLARATION_FOR_GLOBAL_CONTEXT;
22570
22571     SWITCH_TO_GLOBAL_CONTEXT;
22572
22573     /* If the entry is one of these types, it is a permanent entry, and not the
22574      * one used to detect recursions.  This function should delete only the
22575      * recursion entry */
22576     current_entry = hv_fetch(PL_user_def_props, (const char *) key, key_len, 0);
22577     if (     current_entry
22578         && ! is_invlist(*current_entry)
22579         && ! SvPOK(*current_entry))
22580     {
22581         (void) hv_delete(PL_user_def_props, (const char *) key, key_len,
22582                                                                     G_DISCARD);
22583     }
22584
22585     RESTORE_CONTEXT;
22586 }
22587
22588 STATIC SV *
22589 S_get_fq_name(pTHX_
22590               const char * const name,    /* The first non-blank in the \p{}, \P{} */
22591               const Size_t name_len,      /* Its length in bytes, not including any trailing space */
22592               const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22593               const bool has_colon_colon
22594              )
22595 {
22596     /* Returns a mortal SV containing the fully qualified version of the input
22597      * name */
22598
22599     SV * fq_name;
22600
22601     fq_name = newSVpvs_flags("", SVs_TEMP);
22602
22603     /* Use the current package if it wasn't included in our input */
22604     if (! has_colon_colon) {
22605         const HV * pkg = (IN_PERL_COMPILETIME)
22606                          ? PL_curstash
22607                          : CopSTASH(PL_curcop);
22608         const char* pkgname = HvNAME(pkg);
22609
22610         Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
22611                       UTF8fARG(is_utf8, strlen(pkgname), pkgname));
22612         sv_catpvs(fq_name, "::");
22613     }
22614
22615     Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
22616                          UTF8fARG(is_utf8, name_len, name));
22617     return fq_name;
22618 }
22619
22620 SV *
22621 Perl_parse_uniprop_string(pTHX_
22622
22623     /* Parse the interior of a \p{}, \P{}.  Returns its definition if knowable
22624      * now.  If so, the return is an inversion list.
22625      *
22626      * If the property is user-defined, it is a subroutine, which in turn
22627      * may call other subroutines.  This function will call the whole nest of
22628      * them to get the definition they return; if some aren't known at the time
22629      * of the call to this function, the fully qualified name of the highest
22630      * level sub is returned.  It is an error to call this function at runtime
22631      * without every sub defined.
22632      *
22633      * If an error was found, NULL is returned, and 'msg' gets a suitable
22634      * message appended to it.  (Appending allows the back trace of how we got
22635      * to the faulty definition to be displayed through nested calls of
22636      * user-defined subs.)
22637      *
22638      * The caller should NOT try to free any returned inversion list.
22639      *
22640      * Other parameters will be set on return as described below */
22641
22642     const char * const name,    /* The first non-blank in the \p{}, \P{} */
22643     const Size_t name_len,      /* Its length in bytes, not including any
22644                                    trailing space */
22645     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
22646     const bool to_fold,         /* ? Is this under /i */
22647     const bool runtime,         /* TRUE if this is being called at run time */
22648     const bool deferrable,      /* TRUE if it's ok for the definition to not be
22649                                    known at this call */
22650     bool *user_defined_ptr,     /* Upon return from this function it will be
22651                                    set to TRUE if any component is a
22652                                    user-defined property */
22653     SV * msg,                   /* Any error or warning msg(s) are appended to
22654                                    this */
22655    const STRLEN level)          /* Recursion level of this call */
22656 {
22657     dVAR;
22658     char* lookup_name;          /* normalized name for lookup in our tables */
22659     unsigned lookup_len;        /* Its length */
22660     bool stricter = FALSE;      /* Some properties have stricter name
22661                                    normalization rules, which we decide upon
22662                                    based on parsing */
22663
22664     /* nv= or numeric_value=, or possibly one of the cjk numeric properties
22665      * (though it requires extra effort to download them from Unicode and
22666      * compile perl to know about them) */
22667     bool is_nv_type = FALSE;
22668
22669     unsigned int i, j = 0;
22670     int equals_pos = -1;    /* Where the '=' is found, or negative if none */
22671     int slash_pos  = -1;    /* Where the '/' is found, or negative if none */
22672     int table_index = 0;    /* The entry number for this property in the table
22673                                of all Unicode property names */
22674     bool starts_with_Is = FALSE;  /* ? Does the name start with 'Is' */
22675     Size_t lookup_offset = 0;   /* Used to ignore the first few characters of
22676                                    the normalized name in certain situations */
22677     Size_t non_pkg_begin = 0;   /* Offset of first byte in 'name' that isn't
22678                                    part of a package name */
22679     bool could_be_user_defined = TRUE;  /* ? Could this be a user-defined
22680                                              property rather than a Unicode
22681                                              one. */
22682     SV * prop_definition = NULL;  /* The returned definition of 'name' or NULL
22683                                      if an error.  If it is an inversion list,
22684                                      it is the definition.  Otherwise it is a
22685                                      string containing the fully qualified sub
22686                                      name of 'name' */
22687     SV * fq_name = NULL;        /* For user-defined properties, the fully
22688                                    qualified name */
22689     bool invert_return = FALSE; /* ? Do we need to complement the result before
22690                                      returning it */
22691
22692     PERL_ARGS_ASSERT_PARSE_UNIPROP_STRING;
22693
22694     /* The input will be normalized into 'lookup_name' */
22695     Newx(lookup_name, name_len, char);
22696     SAVEFREEPV(lookup_name);
22697
22698     /* Parse the input. */
22699     for (i = 0; i < name_len; i++) {
22700         char cur = name[i];
22701
22702         /* Most of the characters in the input will be of this ilk, being parts
22703          * of a name */
22704         if (isIDCONT_A(cur)) {
22705
22706             /* Case differences are ignored.  Our lookup routine assumes
22707              * everything is lowercase, so normalize to that */
22708             if (isUPPER_A(cur)) {
22709                 lookup_name[j++] = toLOWER_A(cur);
22710                 continue;
22711             }
22712
22713             if (cur == '_') { /* Don't include these in the normalized name */
22714                 continue;
22715             }
22716
22717             lookup_name[j++] = cur;
22718
22719             /* The first character in a user-defined name must be of this type.
22720              * */
22721             if (i - non_pkg_begin == 0 && ! isIDFIRST_A(cur)) {
22722                 could_be_user_defined = FALSE;
22723             }
22724
22725             continue;
22726         }
22727
22728         /* Here, the character is not something typically in a name,  But these
22729          * two types of characters (and the '_' above) can be freely ignored in
22730          * most situations.  Later it may turn out we shouldn't have ignored
22731          * them, and we have to reparse, but we don't have enough information
22732          * yet to make that decision */
22733         if (cur == '-' || isSPACE_A(cur)) {
22734             could_be_user_defined = FALSE;
22735             continue;
22736         }
22737
22738         /* An equals sign or single colon mark the end of the first part of
22739          * the property name */
22740         if (    cur == '='
22741             || (cur == ':' && (i >= name_len - 1 || name[i+1] != ':')))
22742         {
22743             lookup_name[j++] = '='; /* Treat the colon as an '=' */
22744             equals_pos = j; /* Note where it occurred in the input */
22745             could_be_user_defined = FALSE;
22746             break;
22747         }
22748
22749         /* Otherwise, this character is part of the name. */
22750         lookup_name[j++] = cur;
22751
22752         /* Here it isn't a single colon, so if it is a colon, it must be a
22753          * double colon */
22754         if (cur == ':') {
22755
22756             /* A double colon should be a package qualifier.  We note its
22757              * position and continue.  Note that one could have
22758              *      pkg1::pkg2::...::foo
22759              * so that the position at the end of the loop will be just after
22760              * the final qualifier */
22761
22762             i++;
22763             non_pkg_begin = i + 1;
22764             lookup_name[j++] = ':';
22765         }
22766         else { /* Only word chars (and '::') can be in a user-defined name */
22767             could_be_user_defined = FALSE;
22768         }
22769     } /* End of parsing through the lhs of the property name (or all of it if
22770          no rhs) */
22771
22772 #define STRLENs(s)  (sizeof("" s "") - 1)
22773
22774     /* If there is a single package name 'utf8::', it is ambiguous.  It could
22775      * be for a user-defined property, or it could be a Unicode property, as
22776      * all of them are considered to be for that package.  For the purposes of
22777      * parsing the rest of the property, strip it off */
22778     if (non_pkg_begin == STRLENs("utf8::") && memBEGINPs(name, name_len, "utf8::")) {
22779         lookup_name +=  STRLENs("utf8::");
22780         j -=  STRLENs("utf8::");
22781         equals_pos -=  STRLENs("utf8::");
22782     }
22783
22784     /* Here, we are either done with the whole property name, if it was simple;
22785      * or are positioned just after the '=' if it is compound. */
22786
22787     if (equals_pos >= 0) {
22788         assert(! stricter); /* We shouldn't have set this yet */
22789
22790         /* Space immediately after the '=' is ignored */
22791         i++;
22792         for (; i < name_len; i++) {
22793             if (! isSPACE_A(name[i])) {
22794                 break;
22795             }
22796         }
22797
22798         /* Most punctuation after the equals indicates a subpattern, like
22799          * \p{foo=/bar/} */
22800         if (   isPUNCT_A(name[i])
22801             && name[i] != '-'
22802             && name[i] != '+'
22803             && name[i] != '_'
22804             && name[i] != '{')
22805         {
22806             /* Find the property.  The table includes the equals sign, so we
22807              * use 'j' as-is */
22808             table_index = match_uniprop((U8 *) lookup_name, j);
22809             if (table_index) {
22810                 const char * const * prop_values
22811                                             = UNI_prop_value_ptrs[table_index];
22812                 SV * subpattern;
22813                 Size_t subpattern_len;
22814                 REGEXP * subpattern_re;
22815                 char open = name[i++];
22816                 char close;
22817                 const char * pos_in_brackets;
22818                 bool escaped = 0;
22819
22820                 /* A backslash means the real delimitter is the next character.
22821                  * */
22822                 if (open == '\\') {
22823                     open = name[i++];
22824                     escaped = 1;
22825                 }
22826
22827                 /* This data structure is constructed so that the matching
22828                  * closing bracket is 3 past its matching opening.  The second
22829                  * set of closing is so that if the opening is something like
22830                  * ']', the closing will be that as well.  Something similar is
22831                  * done in toke.c */
22832                 pos_in_brackets = strchr("([<)]>)]>", open);
22833                 close = (pos_in_brackets) ? pos_in_brackets[3] : open;
22834
22835                 if (    i >= name_len
22836                     ||  name[name_len-1] != close
22837                     || (escaped && name[name_len-2] != '\\'))
22838                 {
22839                     sv_catpvs(msg, "Unicode property wildcard not terminated");
22840                     goto append_name_to_msg;
22841                 }
22842
22843                 Perl_ck_warner_d(aTHX_
22844                     packWARN(WARN_EXPERIMENTAL__UNIPROP_WILDCARDS),
22845                     "The Unicode property wildcards feature is experimental");
22846
22847                 /* Now create and compile the wildcard subpattern.  Use /iaa
22848                  * because nothing outside of ASCII will match, and it the
22849                  * property values should all match /i.  Note that when the
22850                  * pattern fails to compile, our added text to the user's
22851                  * pattern will be displayed to the user, which is not so
22852                  * desirable. */
22853                 subpattern_len = name_len - i - 1 - escaped;
22854                 subpattern = Perl_newSVpvf(aTHX_ "(?iaa:%.*s)",
22855                                               (unsigned) subpattern_len,
22856                                               name + i);
22857                 subpattern = sv_2mortal(subpattern);
22858                 subpattern_re = re_compile(subpattern, 0);
22859                 assert(subpattern_re);  /* Should have died if didn't compile
22860                                          successfully */
22861
22862                 /* For each legal property value, see if the supplied pattern
22863                  * matches it. */
22864                 while (*prop_values) {
22865                     const char * const entry = *prop_values;
22866                     const Size_t len = strlen(entry);
22867                     SV* entry_sv = newSVpvn_flags(entry, len, SVs_TEMP);
22868
22869                     if (pregexec(subpattern_re,
22870                                  (char *) entry,
22871                                  (char *) entry + len,
22872                                  (char *) entry, 0,
22873                                  entry_sv,
22874                                  0))
22875                     { /* Here, matched.  Add to the returned list */
22876                         Size_t total_len = j + len;
22877                         SV * sub_invlist = NULL;
22878                         char * this_string;
22879
22880                         /* We know this is a legal \p{property=value}.  Call
22881                          * the function to return the list of code points that
22882                          * match it */
22883                         Newxz(this_string, total_len + 1, char);
22884                         Copy(lookup_name, this_string, j, char);
22885                         my_strlcat(this_string, entry, total_len + 1);
22886                         SAVEFREEPV(this_string);
22887                         sub_invlist = parse_uniprop_string(this_string,
22888                                                            total_len,
22889                                                            is_utf8,
22890                                                            to_fold,
22891                                                            runtime,
22892                                                            deferrable,
22893                                                            user_defined_ptr,
22894                                                            msg,
22895                                                            level + 1);
22896                         _invlist_union(prop_definition, sub_invlist,
22897                                        &prop_definition);
22898                     }
22899
22900                     prop_values++;  /* Next iteration, look at next propvalue */
22901                 } /* End of looking through property values; (the data
22902                      structure is terminated by a NULL ptr) */
22903
22904                 SvREFCNT_dec_NN(subpattern_re);
22905
22906                 if (prop_definition) {
22907                     return prop_definition;
22908                 }
22909
22910                 sv_catpvs(msg, "No Unicode property value wildcard matches:");
22911                 goto append_name_to_msg;
22912             }
22913
22914             /* Here's how khw thinks we should proceed to handle the properties
22915              * not yet done:    Bidi Mirroring Glyph
22916                                 Bidi Paired Bracket
22917                                 Case Folding  (both full and simple)
22918                                 Decomposition Mapping
22919                                 Equivalent Unified Ideograph
22920                                 Name
22921                                 Name Alias
22922                                 Lowercase Mapping  (both full and simple)
22923                                 NFKC Case Fold
22924                                 Titlecase Mapping  (both full and simple)
22925                                 Uppercase Mapping  (both full and simple)
22926              * Move the part that looks at the property values into a perl
22927              * script, like utf8_heavy.pl is done.  This makes things somewhat
22928              * easier, but most importantly, it avoids always adding all these
22929              * strings to the memory usage when the feature is little-used.
22930              *
22931              * The property values would all be concatenated into a single
22932              * string per property with each value on a separate line, and the
22933              * code point it's for on alternating lines.  Then we match the
22934              * user's input pattern m//mg, without having to worry about their
22935              * uses of '^' and '$'.  Only the values that aren't the default
22936              * would be in the strings.  Code points would be in UTF-8.  The
22937              * search pattern that we would construct would look like
22938              * (?: \n (code-point_re) \n (?aam: user-re ) \n )
22939              * And so $1 would contain the code point that matched the user-re.
22940              * For properties where the default is the code point itself, such
22941              * as any of the case changing mappings, the string would otherwise
22942              * consist of all Unicode code points in UTF-8 strung together.
22943              * This would be impractical.  So instead, examine their compiled
22944              * pattern, looking at the ssc.  If none, reject the pattern as an
22945              * error.  Otherwise run the pattern against every code point in
22946              * the ssc.  The ssc is kind of like tr18's 3.9 Possible Match Sets
22947              * And it might be good to create an API to return the ssc.
22948              *
22949              * For the name properties, a new function could be created in
22950              * charnames which essentially does the same thing as above,
22951              * sharing Name.pl with the other charname functions.  Don't know
22952              * about loose name matching, or algorithmically determined names.
22953              * Decomposition.pl similarly.
22954              *
22955              * It might be that a new pattern modifier would have to be
22956              * created, like /t for resTricTed, which changed the behavior of
22957              * some constructs in their subpattern, like \A. */
22958         } /* End of is a wildcard subppattern */
22959
22960
22961         /* Certain properties whose values are numeric need special handling.
22962          * They may optionally be prefixed by 'is'.  Ignore that prefix for the
22963          * purposes of checking if this is one of those properties */
22964         if (memBEGINPs(lookup_name, j, "is")) {
22965             lookup_offset = 2;
22966         }
22967
22968         /* Then check if it is one of these specially-handled properties.  The
22969          * possibilities are hard-coded because easier this way, and the list
22970          * is unlikely to change.
22971          *
22972          * All numeric value type properties are of this ilk, and are also
22973          * special in a different way later on.  So find those first.  There
22974          * are several numeric value type properties in the Unihan DB (which is
22975          * unlikely to be compiled with perl, but we handle it here in case it
22976          * does get compiled).  They all end with 'numeric'.  The interiors
22977          * aren't checked for the precise property.  This would stop working if
22978          * a cjk property were to be created that ended with 'numeric' and
22979          * wasn't a numeric type */
22980         is_nv_type = memEQs(lookup_name + lookup_offset,
22981                        j - 1 - lookup_offset, "numericvalue")
22982                   || memEQs(lookup_name + lookup_offset,
22983                       j - 1 - lookup_offset, "nv")
22984                   || (   memENDPs(lookup_name + lookup_offset,
22985                             j - 1 - lookup_offset, "numeric")
22986                       && (   memBEGINPs(lookup_name + lookup_offset,
22987                                       j - 1 - lookup_offset, "cjk")
22988                           || memBEGINPs(lookup_name + lookup_offset,
22989                                       j - 1 - lookup_offset, "k")));
22990         if (   is_nv_type
22991             || memEQs(lookup_name + lookup_offset,
22992                       j - 1 - lookup_offset, "canonicalcombiningclass")
22993             || memEQs(lookup_name + lookup_offset,
22994                       j - 1 - lookup_offset, "ccc")
22995             || memEQs(lookup_name + lookup_offset,
22996                       j - 1 - lookup_offset, "age")
22997             || memEQs(lookup_name + lookup_offset,
22998                       j - 1 - lookup_offset, "in")
22999             || memEQs(lookup_name + lookup_offset,
23000                       j - 1 - lookup_offset, "presentin"))
23001         {
23002             unsigned int k;
23003
23004             /* Since the stuff after the '=' is a number, we can't throw away
23005              * '-' willy-nilly, as those could be a minus sign.  Other stricter
23006              * rules also apply.  However, these properties all can have the
23007              * rhs not be a number, in which case they contain at least one
23008              * alphabetic.  In those cases, the stricter rules don't apply.
23009              * But the numeric type properties can have the alphas [Ee] to
23010              * signify an exponent, and it is still a number with stricter
23011              * rules.  So look for an alpha that signifies not-strict */
23012             stricter = TRUE;
23013             for (k = i; k < name_len; k++) {
23014                 if (   isALPHA_A(name[k])
23015                     && (! is_nv_type || ! isALPHA_FOLD_EQ(name[k], 'E')))
23016                 {
23017                     stricter = FALSE;
23018                     break;
23019                 }
23020             }
23021         }
23022
23023         if (stricter) {
23024
23025             /* A number may have a leading '+' or '-'.  The latter is retained
23026              * */
23027             if (name[i] == '+') {
23028                 i++;
23029             }
23030             else if (name[i] == '-') {
23031                 lookup_name[j++] = '-';
23032                 i++;
23033             }
23034
23035             /* Skip leading zeros including single underscores separating the
23036              * zeros, or between the final leading zero and the first other
23037              * digit */
23038             for (; i < name_len - 1; i++) {
23039                 if (    name[i] != '0'
23040                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
23041                 {
23042                     break;
23043                 }
23044             }
23045         }
23046     }
23047     else {  /* No '=' */
23048
23049        /* Only a few properties without an '=' should be parsed with stricter
23050         * rules.  The list is unlikely to change. */
23051         if (   memBEGINPs(lookup_name, j, "perl")
23052             && memNEs(lookup_name + 4, j - 4, "space")
23053             && memNEs(lookup_name + 4, j - 4, "word"))
23054         {
23055             stricter = TRUE;
23056
23057             /* We set the inputs back to 0 and the code below will reparse,
23058              * using strict */
23059             i = j = 0;
23060         }
23061     }
23062
23063     /* Here, we have either finished the property, or are positioned to parse
23064      * the remainder, and we know if stricter rules apply.  Finish out, if not
23065      * already done */
23066     for (; i < name_len; i++) {
23067         char cur = name[i];
23068
23069         /* In all instances, case differences are ignored, and we normalize to
23070          * lowercase */
23071         if (isUPPER_A(cur)) {
23072             lookup_name[j++] = toLOWER(cur);
23073             continue;
23074         }
23075
23076         /* An underscore is skipped, but not under strict rules unless it
23077          * separates two digits */
23078         if (cur == '_') {
23079             if (    stricter
23080                 && (     i == 0 || (int) i == equals_pos || i == name_len- 1
23081                     || ! isDIGIT_A(name[i-1]) || ! isDIGIT_A(name[i+1])))
23082             {
23083                 lookup_name[j++] = '_';
23084             }
23085             continue;
23086         }
23087
23088         /* Hyphens are skipped except under strict */
23089         if (cur == '-' && ! stricter) {
23090             continue;
23091         }
23092
23093         /* XXX Bug in documentation.  It says white space skipped adjacent to
23094          * non-word char.  Maybe we should, but shouldn't skip it next to a dot
23095          * in a number */
23096         if (isSPACE_A(cur) && ! stricter) {
23097             continue;
23098         }
23099
23100         lookup_name[j++] = cur;
23101
23102         /* Unless this is a non-trailing slash, we are done with it */
23103         if (i >= name_len - 1 || cur != '/') {
23104             continue;
23105         }
23106
23107         slash_pos = j;
23108
23109         /* A slash in the 'numeric value' property indicates that what follows
23110          * is a denominator.  It can have a leading '+' and '0's that should be
23111          * skipped.  But we have never allowed a negative denominator, so treat
23112          * a minus like every other character.  (No need to rule out a second
23113          * '/', as that won't match anything anyway */
23114         if (is_nv_type) {
23115             i++;
23116             if (i < name_len && name[i] == '+') {
23117                 i++;
23118             }
23119
23120             /* Skip leading zeros including underscores separating digits */
23121             for (; i < name_len - 1; i++) {
23122                 if (   name[i] != '0'
23123                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
23124                 {
23125                     break;
23126                 }
23127             }
23128
23129             /* Store the first real character in the denominator */
23130             if (i < name_len) {
23131                 lookup_name[j++] = name[i];
23132             }
23133         }
23134     }
23135
23136     /* Here are completely done parsing the input 'name', and 'lookup_name'
23137      * contains a copy, normalized.
23138      *
23139      * This special case is grandfathered in: 'L_' and 'GC=L_' are accepted and
23140      * different from without the underscores.  */
23141     if (  (   UNLIKELY(memEQs(lookup_name, j, "l"))
23142            || UNLIKELY(memEQs(lookup_name, j, "gc=l")))
23143         && UNLIKELY(name[name_len-1] == '_'))
23144     {
23145         lookup_name[j++] = '&';
23146     }
23147
23148     /* If the original input began with 'In' or 'Is', it could be a subroutine
23149      * call to a user-defined property instead of a Unicode property name. */
23150     if (    name_len - non_pkg_begin > 2
23151         &&  name[non_pkg_begin+0] == 'I'
23152         && (name[non_pkg_begin+1] == 'n' || name[non_pkg_begin+1] == 's'))
23153     {
23154         /* Names that start with In have different characterstics than those
23155          * that start with Is */
23156         if (name[non_pkg_begin+1] == 's') {
23157             starts_with_Is = TRUE;
23158         }
23159     }
23160     else {
23161         could_be_user_defined = FALSE;
23162     }
23163
23164     if (could_be_user_defined) {
23165         CV* user_sub;
23166
23167         /* If the user defined property returns the empty string, it could
23168          * easily be because the pattern is being compiled before the data it
23169          * actually needs to compile is available.  This could be argued to be
23170          * a bug in the perl code, but this is a change of behavior for Perl,
23171          * so we handle it.  This means that intentionally returning nothing
23172          * will not be resolved until runtime */
23173         bool empty_return = FALSE;
23174
23175         /* Here, the name could be for a user defined property, which are
23176          * implemented as subs. */
23177         user_sub = get_cvn_flags(name, name_len, 0);
23178         if (user_sub) {
23179             const char insecure[] = "Insecure user-defined property";
23180
23181             /* Here, there is a sub by the correct name.  Normally we call it
23182              * to get the property definition */
23183             dSP;
23184             SV * user_sub_sv = MUTABLE_SV(user_sub);
23185             SV * error;     /* Any error returned by calling 'user_sub' */
23186             SV * key;       /* The key into the hash of user defined sub names
23187                              */
23188             SV * placeholder;
23189             SV ** saved_user_prop_ptr;      /* Hash entry for this property */
23190
23191             /* How many times to retry when another thread is in the middle of
23192              * expanding the same definition we want */
23193             PERL_INT_FAST8_T retry_countdown = 10;
23194
23195             DECLARATION_FOR_GLOBAL_CONTEXT;
23196
23197             /* If we get here, we know this property is user-defined */
23198             *user_defined_ptr = TRUE;
23199
23200             /* We refuse to call a potentially tainted subroutine; returning an
23201              * error instead */
23202             if (TAINT_get) {
23203                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23204                 sv_catpvn(msg, insecure, sizeof(insecure) - 1);
23205                 goto append_name_to_msg;
23206             }
23207
23208             /* In principal, we only call each subroutine property definition
23209              * once during the life of the program.  This guarantees that the
23210              * property definition never changes.  The results of the single
23211              * sub call are stored in a hash, which is used instead for future
23212              * references to this property.  The property definition is thus
23213              * immutable.  But, to allow the user to have a /i-dependent
23214              * definition, we call the sub once for non-/i, and once for /i,
23215              * should the need arise, passing the /i status as a parameter.
23216              *
23217              * We start by constructing the hash key name, consisting of the
23218              * fully qualified subroutine name, preceded by the /i status, so
23219              * that there is a key for /i and a different key for non-/i */
23220             key = newSVpvn(((to_fold) ? "1" : "0"), 1);
23221             fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
23222                                           non_pkg_begin != 0);
23223             sv_catsv(key, fq_name);
23224             sv_2mortal(key);
23225
23226             /* We only call the sub once throughout the life of the program
23227              * (with the /i, non-/i exception noted above).  That means the
23228              * hash must be global and accessible to all threads.  It is
23229              * created at program start-up, before any threads are created, so
23230              * is accessible to all children.  But this creates some
23231              * complications.
23232              *
23233              * 1) The keys can't be shared, or else problems arise; sharing is
23234              *    turned off at hash creation time
23235              * 2) All SVs in it are there for the remainder of the life of the
23236              *    program, and must be created in the same interpreter context
23237              *    as the hash, or else they will be freed from the wrong pool
23238              *    at global destruction time.  This is handled by switching to
23239              *    the hash's context to create each SV going into it, and then
23240              *    immediately switching back
23241              * 3) All accesses to the hash must be controlled by a mutex, to
23242              *    prevent two threads from getting an unstable state should
23243              *    they simultaneously be accessing it.  The code below is
23244              *    crafted so that the mutex is locked whenever there is an
23245              *    access and unlocked only when the next stable state is
23246              *    achieved.
23247              *
23248              * The hash stores either the definition of the property if it was
23249              * valid, or, if invalid, the error message that was raised.  We
23250              * use the type of SV to distinguish.
23251              *
23252              * There's also the need to guard against the definition expansion
23253              * from infinitely recursing.  This is handled by storing the aTHX
23254              * of the expanding thread during the expansion.  Again the SV type
23255              * is used to distinguish this from the other two cases.  If we
23256              * come to here and the hash entry for this property is our aTHX,
23257              * it means we have recursed, and the code assumes that we would
23258              * infinitely recurse, so instead stops and raises an error.
23259              * (Any recursion has always been treated as infinite recursion in
23260              * this feature.)
23261              *
23262              * If instead, the entry is for a different aTHX, it means that
23263              * that thread has gotten here first, and hasn't finished expanding
23264              * the definition yet.  We just have to wait until it is done.  We
23265              * sleep and retry a few times, returning an error if the other
23266              * thread doesn't complete. */
23267
23268           re_fetch:
23269             USER_PROP_MUTEX_LOCK;
23270
23271             /* If we have an entry for this key, the subroutine has already
23272              * been called once with this /i status. */
23273             saved_user_prop_ptr = hv_fetch(PL_user_def_props,
23274                                                    SvPVX(key), SvCUR(key), 0);
23275             if (saved_user_prop_ptr) {
23276
23277                 /* If the saved result is an inversion list, it is the valid
23278                  * definition of this property */
23279                 if (is_invlist(*saved_user_prop_ptr)) {
23280                     prop_definition = *saved_user_prop_ptr;
23281
23282                     /* The SV in the hash won't be removed until global
23283                      * destruction, so it is stable and we can unlock */
23284                     USER_PROP_MUTEX_UNLOCK;
23285
23286                     /* The caller shouldn't try to free this SV */
23287                     return prop_definition;
23288                 }
23289
23290                 /* Otherwise, if it is a string, it is the error message
23291                  * that was returned when we first tried to evaluate this
23292                  * property.  Fail, and append the message */
23293                 if (SvPOK(*saved_user_prop_ptr)) {
23294                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23295                     sv_catsv(msg, *saved_user_prop_ptr);
23296
23297                     /* The SV in the hash won't be removed until global
23298                      * destruction, so it is stable and we can unlock */
23299                     USER_PROP_MUTEX_UNLOCK;
23300
23301                     return NULL;
23302                 }
23303
23304                 assert(SvIOK(*saved_user_prop_ptr));
23305
23306                 /* Here, we have an unstable entry in the hash.  Either another
23307                  * thread is in the middle of expanding the property's
23308                  * definition, or we are ourselves recursing.  We use the aTHX
23309                  * in it to distinguish */
23310                 if (SvIV(*saved_user_prop_ptr) != PTR2IV(CUR_CONTEXT)) {
23311
23312                     /* Here, it's another thread doing the expanding.  We've
23313                      * looked as much as we are going to at the contents of the
23314                      * hash entry.  It's safe to unlock. */
23315                     USER_PROP_MUTEX_UNLOCK;
23316
23317                     /* Retry a few times */
23318                     if (retry_countdown-- > 0) {
23319                         PerlProc_sleep(1);
23320                         goto re_fetch;
23321                     }
23322
23323                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23324                     sv_catpvs(msg, "Timeout waiting for another thread to "
23325                                    "define");
23326                     goto append_name_to_msg;
23327                 }
23328
23329                 /* Here, we are recursing; don't dig any deeper */
23330                 USER_PROP_MUTEX_UNLOCK;
23331
23332                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23333                 sv_catpvs(msg,
23334                           "Infinite recursion in user-defined property");
23335                 goto append_name_to_msg;
23336             }
23337
23338             /* Here, this thread has exclusive control, and there is no entry
23339              * for this property in the hash.  So we have the go ahead to
23340              * expand the definition ourselves. */
23341
23342             PUSHSTACKi(PERLSI_MAGIC);
23343             ENTER;
23344
23345             /* Create a temporary placeholder in the hash to detect recursion
23346              * */
23347             SWITCH_TO_GLOBAL_CONTEXT;
23348             placeholder= newSVuv(PTR2IV(ORIGINAL_CONTEXT));
23349             (void) hv_store_ent(PL_user_def_props, key, placeholder, 0);
23350             RESTORE_CONTEXT;
23351
23352             /* Now that we have a placeholder, we can let other threads
23353              * continue */
23354             USER_PROP_MUTEX_UNLOCK;
23355
23356             /* Make sure the placeholder always gets destroyed */
23357             SAVEDESTRUCTOR_X(S_delete_recursion_entry, SvPVX(key));
23358
23359             PUSHMARK(SP);
23360             SAVETMPS;
23361
23362             /* Call the user's function, with the /i status as a parameter.
23363              * Note that we have gone to a lot of trouble to keep this call
23364              * from being within the locked mutex region. */
23365             XPUSHs(boolSV(to_fold));
23366             PUTBACK;
23367
23368             /* The following block was taken from swash_init().  Presumably
23369              * they apply to here as well, though we no longer use a swash --
23370              * khw */
23371             SAVEHINTS();
23372             save_re_context();
23373             /* We might get here via a subroutine signature which uses a utf8
23374              * parameter name, at which point PL_subname will have been set
23375              * but not yet used. */
23376             save_item(PL_subname);
23377
23378             (void) call_sv(user_sub_sv, G_EVAL|G_SCALAR);
23379
23380             SPAGAIN;
23381
23382             error = ERRSV;
23383             if (TAINT_get || SvTRUE(error)) {
23384                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23385                 if (SvTRUE(error)) {
23386                     sv_catpvs(msg, "Error \"");
23387                     sv_catsv(msg, error);
23388                     sv_catpvs(msg, "\"");
23389                 }
23390                 if (TAINT_get) {
23391                     if (SvTRUE(error)) sv_catpvs(msg, "; ");
23392                     sv_catpvn(msg, insecure, sizeof(insecure) - 1);
23393                 }
23394
23395                 if (name_len > 0) {
23396                     sv_catpvs(msg, " in expansion of ");
23397                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8,
23398                                                                   name_len,
23399                                                                   name));
23400                 }
23401
23402                 (void) POPs;
23403                 prop_definition = NULL;
23404             }
23405             else {  /* G_SCALAR guarantees a single return value */
23406                 SV * contents = POPs;
23407
23408                 /* The contents is supposed to be the expansion of the property
23409                  * definition.  If the definition is deferrable, and we got an
23410                  * empty string back, set a flag to later defer it (after clean
23411                  * up below). */
23412                 if (      deferrable
23413                     && (! SvPOK(contents) || SvCUR(contents) == 0))
23414                 {
23415                         empty_return = TRUE;
23416                 }
23417                 else { /* Otherwise, call a function to check for valid syntax,
23418                           and handle it */
23419
23420                     prop_definition = handle_user_defined_property(
23421                                                     name, name_len,
23422                                                     is_utf8, to_fold, runtime,
23423                                                     deferrable,
23424                                                     contents, user_defined_ptr,
23425                                                     msg,
23426                                                     level);
23427                 }
23428             }
23429
23430             /* Here, we have the results of the expansion.  Delete the
23431              * placeholder, and if the definition is now known, replace it with
23432              * that definition.  We need exclusive access to the hash, and we
23433              * can't let anyone else in, between when we delete the placeholder
23434              * and add the permanent entry */
23435             USER_PROP_MUTEX_LOCK;
23436
23437             S_delete_recursion_entry(aTHX_ SvPVX(key));
23438
23439             if (    ! empty_return
23440                 && (! prop_definition || is_invlist(prop_definition)))
23441             {
23442                 /* If we got success we use the inversion list defining the
23443                  * property; otherwise use the error message */
23444                 SWITCH_TO_GLOBAL_CONTEXT;
23445                 (void) hv_store_ent(PL_user_def_props,
23446                                     key,
23447                                     ((prop_definition)
23448                                      ? newSVsv(prop_definition)
23449                                      : newSVsv(msg)),
23450                                     0);
23451                 RESTORE_CONTEXT;
23452             }
23453
23454             /* All done, and the hash now has a permanent entry for this
23455              * property.  Give up exclusive control */
23456             USER_PROP_MUTEX_UNLOCK;
23457
23458             FREETMPS;
23459             LEAVE;
23460             POPSTACK;
23461
23462             if (empty_return) {
23463                 goto definition_deferred;
23464             }
23465
23466             if (prop_definition) {
23467
23468                 /* If the definition is for something not known at this time,
23469                  * we toss it, and go return the main property name, as that's
23470                  * the one the user will be aware of */
23471                 if (! is_invlist(prop_definition)) {
23472                     SvREFCNT_dec_NN(prop_definition);
23473                     goto definition_deferred;
23474                 }
23475
23476                 sv_2mortal(prop_definition);
23477             }
23478
23479             /* And return */
23480             return prop_definition;
23481
23482         }   /* End of calling the subroutine for the user-defined property */
23483     }       /* End of it could be a user-defined property */
23484
23485     /* Here it wasn't a user-defined property that is known at this time.  See
23486      * if it is a Unicode property */
23487
23488     lookup_len = j;     /* This is a more mnemonic name than 'j' */
23489
23490     /* Get the index into our pointer table of the inversion list corresponding
23491      * to the property */
23492     table_index = match_uniprop((U8 *) lookup_name, lookup_len);
23493
23494     /* If it didn't find the property ... */
23495     if (table_index == 0) {
23496
23497         /* Try again stripping off any initial 'Is'.  This is because we
23498          * promise that an initial Is is optional.  The same isn't true of
23499          * names that start with 'In'.  Those can match only blocks, and the
23500          * lookup table already has those accounted for. */
23501         if (starts_with_Is) {
23502             lookup_name += 2;
23503             lookup_len -= 2;
23504             equals_pos -= 2;
23505             slash_pos -= 2;
23506
23507             table_index = match_uniprop((U8 *) lookup_name, lookup_len);
23508         }
23509
23510         if (table_index == 0) {
23511             char * canonical;
23512
23513             /* Here, we didn't find it.  If not a numeric type property, and
23514              * can't be a user-defined one, it isn't a legal property */
23515             if (! is_nv_type) {
23516                 if (! could_be_user_defined) {
23517                     goto failed;
23518                 }
23519
23520                 /* Here, the property name is legal as a user-defined one.   At
23521                  * compile time, it might just be that the subroutine for that
23522                  * property hasn't been encountered yet, but at runtime, it's
23523                  * an error to try to use an undefined one */
23524                 if (! deferrable) {
23525                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23526                     sv_catpvs(msg, "Unknown user-defined property name");
23527                     goto append_name_to_msg;
23528                 }
23529
23530                 goto definition_deferred;
23531             } /* End of isn't a numeric type property */
23532
23533             /* The numeric type properties need more work to decide.  What we
23534              * do is make sure we have the number in canonical form and look
23535              * that up. */
23536
23537             if (slash_pos < 0) {    /* No slash */
23538
23539                 /* When it isn't a rational, take the input, convert it to a
23540                  * NV, then create a canonical string representation of that
23541                  * NV. */
23542
23543                 NV value;
23544                 SSize_t value_len = lookup_len - equals_pos;
23545
23546                 /* Get the value */
23547                 if (   value_len <= 0
23548                     || my_atof3(lookup_name + equals_pos, &value,
23549                                 value_len)
23550                           != lookup_name + lookup_len)
23551                 {
23552                     goto failed;
23553                 }
23554
23555                 /* If the value is an integer, the canonical value is integral
23556                  * */
23557                 if (Perl_ceil(value) == value) {
23558                     canonical = Perl_form(aTHX_ "%.*s%.0" NVff,
23559                                             equals_pos, lookup_name, value);
23560                 }
23561                 else {  /* Otherwise, it is %e with a known precision */
23562                     char * exp_ptr;
23563
23564                     canonical = Perl_form(aTHX_ "%.*s%.*" NVef,
23565                                                 equals_pos, lookup_name,
23566                                                 PL_E_FORMAT_PRECISION, value);
23567
23568                     /* The exponent generated is expecting two digits, whereas
23569                      * %e on some systems will generate three.  Remove leading
23570                      * zeros in excess of 2 from the exponent.  We start
23571                      * looking for them after the '=' */
23572                     exp_ptr = strchr(canonical + equals_pos, 'e');
23573                     if (exp_ptr) {
23574                         char * cur_ptr = exp_ptr + 2; /* past the 'e[+-]' */
23575                         SSize_t excess_exponent_len = strlen(cur_ptr) - 2;
23576
23577                         assert(*(cur_ptr - 1) == '-' || *(cur_ptr - 1) == '+');
23578
23579                         if (excess_exponent_len > 0) {
23580                             SSize_t leading_zeros = strspn(cur_ptr, "0");
23581                             SSize_t excess_leading_zeros
23582                                     = MIN(leading_zeros, excess_exponent_len);
23583                             if (excess_leading_zeros > 0) {
23584                                 Move(cur_ptr + excess_leading_zeros,
23585                                      cur_ptr,
23586                                      strlen(cur_ptr) - excess_leading_zeros
23587                                        + 1,  /* Copy the NUL as well */
23588                                      char);
23589                             }
23590                         }
23591                     }
23592                 }
23593             }
23594             else {  /* Has a slash.  Create a rational in canonical form  */
23595                 UV numerator, denominator, gcd, trial;
23596                 const char * end_ptr;
23597                 const char * sign = "";
23598
23599                 /* We can't just find the numerator, denominator, and do the
23600                  * division, then use the method above, because that is
23601                  * inexact.  And the input could be a rational that is within
23602                  * epsilon (given our precision) of a valid rational, and would
23603                  * then incorrectly compare valid.
23604                  *
23605                  * We're only interested in the part after the '=' */
23606                 const char * this_lookup_name = lookup_name + equals_pos;
23607                 lookup_len -= equals_pos;
23608                 slash_pos -= equals_pos;
23609
23610                 /* Handle any leading minus */
23611                 if (this_lookup_name[0] == '-') {
23612                     sign = "-";
23613                     this_lookup_name++;
23614                     lookup_len--;
23615                     slash_pos--;
23616                 }
23617
23618                 /* Convert the numerator to numeric */
23619                 end_ptr = this_lookup_name + slash_pos;
23620                 if (! grok_atoUV(this_lookup_name, &numerator, &end_ptr)) {
23621                     goto failed;
23622                 }
23623
23624                 /* It better have included all characters before the slash */
23625                 if (*end_ptr != '/') {
23626                     goto failed;
23627                 }
23628
23629                 /* Set to look at just the denominator */
23630                 this_lookup_name += slash_pos;
23631                 lookup_len -= slash_pos;
23632                 end_ptr = this_lookup_name + lookup_len;
23633
23634                 /* Convert the denominator to numeric */
23635                 if (! grok_atoUV(this_lookup_name, &denominator, &end_ptr)) {
23636                     goto failed;
23637                 }
23638
23639                 /* It better be the rest of the characters, and don't divide by
23640                  * 0 */
23641                 if (   end_ptr != this_lookup_name + lookup_len
23642                     || denominator == 0)
23643                 {
23644                     goto failed;
23645                 }
23646
23647                 /* Get the greatest common denominator using
23648                    http://en.wikipedia.org/wiki/Euclidean_algorithm */
23649                 gcd = numerator;
23650                 trial = denominator;
23651                 while (trial != 0) {
23652                     UV temp = trial;
23653                     trial = gcd % trial;
23654                     gcd = temp;
23655                 }
23656
23657                 /* If already in lowest possible terms, we have already tried
23658                  * looking this up */
23659                 if (gcd == 1) {
23660                     goto failed;
23661                 }
23662
23663                 /* Reduce the rational, which should put it in canonical form
23664                  * */
23665                 numerator /= gcd;
23666                 denominator /= gcd;
23667
23668                 canonical = Perl_form(aTHX_ "%.*s%s%" UVuf "/%" UVuf,
23669                         equals_pos, lookup_name, sign, numerator, denominator);
23670             }
23671
23672             /* Here, we have the number in canonical form.  Try that */
23673             table_index = match_uniprop((U8 *) canonical, strlen(canonical));
23674             if (table_index == 0) {
23675                 goto failed;
23676             }
23677         }   /* End of still didn't find the property in our table */
23678     }       /* End of       didn't find the property in our table */
23679
23680     /* Here, we have a non-zero return, which is an index into a table of ptrs.
23681      * A negative return signifies that the real index is the absolute value,
23682      * but the result needs to be inverted */
23683     if (table_index < 0) {
23684         invert_return = TRUE;
23685         table_index = -table_index;
23686     }
23687
23688     /* Out-of band indices indicate a deprecated property.  The proper index is
23689      * modulo it with the table size.  And dividing by the table size yields
23690      * an offset into a table constructed by regen/mk_invlists.pl to contain
23691      * the corresponding warning message */
23692     if (table_index > MAX_UNI_KEYWORD_INDEX) {
23693         Size_t warning_offset = table_index / MAX_UNI_KEYWORD_INDEX;
23694         table_index %= MAX_UNI_KEYWORD_INDEX;
23695         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
23696                 "Use of '%.*s' in \\p{} or \\P{} is deprecated because: %s",
23697                 (int) name_len, name, deprecated_property_msgs[warning_offset]);
23698     }
23699
23700     /* In a few properties, a different property is used under /i.  These are
23701      * unlikely to change, so are hard-coded here. */
23702     if (to_fold) {
23703         if (   table_index == UNI_XPOSIXUPPER
23704             || table_index == UNI_XPOSIXLOWER
23705             || table_index == UNI_TITLE)
23706         {
23707             table_index = UNI_CASED;
23708         }
23709         else if (   table_index == UNI_UPPERCASELETTER
23710                  || table_index == UNI_LOWERCASELETTER
23711 #  ifdef UNI_TITLECASELETTER   /* Missing from early Unicodes */
23712                  || table_index == UNI_TITLECASELETTER
23713 #  endif
23714         ) {
23715             table_index = UNI_CASEDLETTER;
23716         }
23717         else if (  table_index == UNI_POSIXUPPER
23718                 || table_index == UNI_POSIXLOWER)
23719         {
23720             table_index = UNI_POSIXALPHA;
23721         }
23722     }
23723
23724     /* Create and return the inversion list */
23725     prop_definition =_new_invlist_C_array(uni_prop_ptrs[table_index]);
23726     sv_2mortal(prop_definition);
23727
23728
23729     /* See if there is a private use override to add to this definition */
23730     {
23731         COPHH * hinthash = (IN_PERL_COMPILETIME)
23732                            ? CopHINTHASH_get(&PL_compiling)
23733                            : CopHINTHASH_get(PL_curcop);
23734         SV * pu_overrides = cophh_fetch_pv(hinthash, "private_use", 0, 0);
23735
23736         if (UNLIKELY(pu_overrides && SvPOK(pu_overrides))) {
23737
23738             /* See if there is an element in the hints hash for this table */
23739             SV * pu_lookup = Perl_newSVpvf(aTHX_ "%d=", table_index);
23740             const char * pos = strstr(SvPVX(pu_overrides), SvPVX(pu_lookup));
23741
23742             if (pos) {
23743                 bool dummy;
23744                 SV * pu_definition;
23745                 SV * pu_invlist;
23746                 SV * expanded_prop_definition =
23747                             sv_2mortal(invlist_clone(prop_definition, NULL));
23748
23749                 /* If so, it's definition is the string from here to the next
23750                  * \a character.  And its format is the same as a user-defined
23751                  * property */
23752                 pos += SvCUR(pu_lookup);
23753                 pu_definition = newSVpvn(pos, strchr(pos, '\a') - pos);
23754                 pu_invlist = handle_user_defined_property(lookup_name,
23755                                                           lookup_len,
23756                                                           0, /* Not UTF-8 */
23757                                                           0, /* Not folded */
23758                                                           runtime,
23759                                                           deferrable,
23760                                                           pu_definition,
23761                                                           &dummy,
23762                                                           msg,
23763                                                           level);
23764                 if (TAINT_get) {
23765                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23766                     sv_catpvs(msg, "Insecure private-use override");
23767                     goto append_name_to_msg;
23768                 }
23769
23770                 /* For now, as a safety measure, make sure that it doesn't
23771                  * override non-private use code points */
23772                 _invlist_intersection(pu_invlist, PL_Private_Use, &pu_invlist);
23773
23774                 /* Add it to the list to be returned */
23775                 _invlist_union(prop_definition, pu_invlist,
23776                                &expanded_prop_definition);
23777                 prop_definition = expanded_prop_definition;
23778                 Perl_ck_warner_d(aTHX_ packWARN(WARN_EXPERIMENTAL__PRIVATE_USE), "The private_use feature is experimental");
23779             }
23780         }
23781     }
23782
23783     if (invert_return) {
23784         _invlist_invert(prop_definition);
23785     }
23786     return prop_definition;
23787
23788
23789   failed:
23790     if (non_pkg_begin != 0) {
23791         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23792         sv_catpvs(msg, "Illegal user-defined property name");
23793     }
23794     else {
23795         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23796         sv_catpvs(msg, "Can't find Unicode property definition");
23797     }
23798     /* FALLTHROUGH */
23799
23800   append_name_to_msg:
23801     {
23802         const char * prefix = (runtime && level == 0) ?  " \\p{" : " \"";
23803         const char * suffix = (runtime && level == 0) ?  "}" : "\"";
23804
23805         sv_catpv(msg, prefix);
23806         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
23807         sv_catpv(msg, suffix);
23808     }
23809
23810     return NULL;
23811
23812   definition_deferred:
23813
23814     /* Here it could yet to be defined, so defer evaluation of this
23815      * until its needed at runtime.  We need the fully qualified property name
23816      * to avoid ambiguity, and a trailing newline */
23817     if (! fq_name) {
23818         fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
23819                                       non_pkg_begin != 0 /* If has "::" */
23820                                );
23821     }
23822     sv_catpvs(fq_name, "\n");
23823
23824     *user_defined_ptr = TRUE;
23825     return fq_name;
23826 }
23827
23828 #endif
23829
23830 /*
23831  * ex: set ts=8 sts=4 sw=4 et:
23832  */