This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
regcomp.c: Extract code from a too-large-function
[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
74 /* Note on debug output:
75  *
76  * This is set up so that -Dr turns on debugging like all other flags that are
77  * enabled by -DDEBUGGING.  -Drv gives more verbose output.  This applies to
78  * all regular expressions encountered in a program, and gives a huge amount of
79  * output for all but the shortest programs.
80  *
81  * The ability to output pattern debugging information lexically, and with much
82  * finer grained control was added, with 'use re qw(Debug ....);' available even
83  * in non-DEBUGGING builds.  This is accomplished by copying the contents of
84  * regcomp.c to ext/re/re_comp.c, and regexec.c is copied to ext/re/re_exec.c.
85  * Those files are compiled and linked into the perl executable, and they are
86  * compiled essentially as if DEBUGGING were enabled, and controlled by calls
87  * to re.pm.
88  *
89  * That would normally mean linking errors when two functions of the same name
90  * are attempted to be placed into the same executable.  That is solved in one
91  * of four ways:
92  *  1)  Static functions aren't known outside the file they are in, so for the
93  *      many functions of that type in this file, it just isn't a problem.
94  *  2)  Most externally known functions are enclosed in
95  *          #ifndef PERL_IN_XSUB_RE
96  *          ...
97  *          #endif
98  *      blocks, so there is only one defintion for them in the whole
99  *      executable, the one in regcomp.c (or regexec.c).  The implication of
100  *      that is any debugging info that comes from them is controlled only by
101  *      -Dr.  Further, any static function they call will also be the version
102  *      in regcomp.c (or regexec.c), so its debugging will also be by -Dr.
103  *  3)  About a dozen external functions are re-#defined in ext/re/re_top.h, to
104  *      have different names, so that what gets loaded in the executable is
105  *      'Perl_foo' from regcomp.c (and regexec.c), and the identical function
106  *      from re_comp.c (and re_exec.c), but with the name 'my_foo'  Debugging
107  *      in the 'Perl_foo' versions is controlled by -Dr, but the 'my_foo'
108  *      versions and their callees are under control of re.pm.   The catch is
109  *      that references to all these go through the regexp_engine structure,
110  *      which is initialized in regcomp.h to the Perl_foo versions, and
111  *      substituted out in lexical scopes where 'use re' is in effect to the
112  *      'my_foo' ones.   That structure is public API, so it would be a hard
113  *      sell to add any additional members.
114  *  4)  For functions in regcomp.c and re_comp.c that are called only from,
115  *      respectively, regexec.c and re_exec.c, they can have two different
116  *      names, depending on #ifdef'ing PERL_IN_XSUB_RE, in both regexec.c and
117  *      embed.fnc.
118  *
119  * The bottom line is that if you add code to one of the public functions
120  * listed in ext/re/re_top.h, debugging automagically works.  But if you write
121  * a new function that needs to do debugging or there is a chain of calls from
122  * it that need to do debugging, all functions in the chain should use options
123  * 2) or 4) above.
124  *
125  * A function may have to be split so that debugging stuff is static, but it
126  * calls out to some other function that only gets compiled in regcomp.c to
127  * access data that we don't want to duplicate.
128  */
129
130 #include "EXTERN.h"
131 #define PERL_IN_REGCOMP_C
132 #include "perl.h"
133
134 #define REG_COMP_C
135 #ifdef PERL_IN_XSUB_RE
136 #  include "re_comp.h"
137 EXTERN_C const struct regexp_engine my_reg_engine;
138 EXTERN_C const struct regexp_engine wild_reg_engine;
139 #else
140 #  include "regcomp.h"
141 #endif
142
143 #include "invlist_inline.h"
144 #include "unicode_constants.h"
145
146 #ifndef STATIC
147 #define STATIC  static
148 #endif
149
150 /* this is a chain of data about sub patterns we are processing that
151    need to be handled separately/specially in study_chunk. Its so
152    we can simulate recursion without losing state.  */
153 struct scan_frame;
154 typedef struct scan_frame {
155     regnode *last_regnode;      /* last node to process in this frame */
156     regnode *next_regnode;      /* next node to process when last is reached */
157     U32 prev_recursed_depth;
158     I32 stopparen;              /* what stopparen do we use */
159     bool in_gosub;              /* this or an outer frame is for GOSUB */
160
161     struct scan_frame *this_prev_frame; /* this previous frame */
162     struct scan_frame *prev_frame;      /* previous frame */
163     struct scan_frame *next_frame;      /* next frame */
164 } scan_frame;
165
166 /* Certain characters are output as a sequence with the first being a
167  * backslash. */
168 #define isBACKSLASHED_PUNCT(c)  memCHRs("-[]\\^", c)
169
170
171 struct RExC_state_t {
172     U32         flags;                  /* RXf_* are we folding, multilining? */
173     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
174     char        *precomp;               /* uncompiled string. */
175     char        *precomp_end;           /* pointer to end of uncompiled string. */
176     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
177     regexp      *rx;                    /* perl core regexp structure */
178     regexp_internal     *rxi;           /* internal data for regexp object
179                                            pprivate field */
180     char        *start;                 /* Start of input for compile */
181     char        *end;                   /* End of input for compile */
182     char        *parse;                 /* Input-scan pointer. */
183     char        *copy_start;            /* start of copy of input within
184                                            constructed parse string */
185     char        *save_copy_start;       /* Provides one level of saving
186                                            and restoring 'copy_start' */
187     char        *copy_start_in_input;   /* Position in input string
188                                            corresponding to copy_start */
189     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
190     regnode     *emit_start;            /* Start of emitted-code area */
191     regnode_offset emit;                /* Code-emit pointer */
192     I32         naughty;                /* How bad is this pattern? */
193     I32         sawback;                /* Did we see \1, ...? */
194     SSize_t     size;                   /* Number of regnode equivalents in
195                                            pattern */
196     Size_t      sets_depth;              /* Counts recursion depth of already-
197                                            compiled regex set patterns */
198     U32         seen;
199
200     I32      parens_buf_size;           /* #slots malloced open/close_parens */
201     regnode_offset *open_parens;        /* offsets to open parens */
202     regnode_offset *close_parens;       /* offsets to close parens */
203     HV          *paren_names;           /* Paren names */
204
205     /* position beyond 'precomp' of the warning message furthest away from
206      * 'precomp'.  During the parse, no warnings are raised for any problems
207      * earlier in the parse than this position.  This works if warnings are
208      * raised the first time a given spot is parsed, and if only one
209      * independent warning is raised for any given spot */
210     Size_t      latest_warn_offset;
211
212     I32         npar;                   /* Capture buffer count so far in the
213                                            parse, (OPEN) plus one. ("par" 0 is
214                                            the whole pattern)*/
215     I32         total_par;              /* During initial parse, is either 0,
216                                            or -1; the latter indicating a
217                                            reparse is needed.  After that pass,
218                                            it is what 'npar' became after the
219                                            pass.  Hence, it being > 0 indicates
220                                            we are in a reparse situation */
221     I32         nestroot;               /* root parens we are in - used by
222                                            accept */
223     I32         seen_zerolen;
224     regnode     *end_op;                /* END node in program */
225     I32         utf8;           /* whether the pattern is utf8 or not */
226     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
227                                 /* XXX use this for future optimisation of case
228                                  * where pattern must be upgraded to utf8. */
229     I32         uni_semantics;  /* If a d charset modifier should use unicode
230                                    rules, even if the pattern is not in
231                                    utf8 */
232
233     I32         recurse_count;          /* Number of recurse regops we have generated */
234     regnode     **recurse;              /* Recurse regops */
235     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
236                                            through */
237     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
238     I32         in_lookaround;
239     I32         contains_locale;
240     I32         override_recoding;
241     I32         recode_x_to_native;
242     I32         in_multi_char_class;
243     int         code_index;             /* next code_blocks[] slot */
244     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
245                                             within pattern */
246     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
247     scan_frame *frame_head;
248     scan_frame *frame_last;
249     U32         frame_count;
250     AV         *warn_text;
251     HV         *unlexed_names;
252     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
253 #ifdef DEBUGGING
254     const char  *lastparse;
255     I32         lastnum;
256     U32         study_chunk_recursed_count;
257     AV          *paren_name_list;       /* idx -> name */
258     SV          *mysv1;
259     SV          *mysv2;
260
261 #define RExC_lastparse  (pRExC_state->lastparse)
262 #define RExC_lastnum    (pRExC_state->lastnum)
263 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
264 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
265 #define RExC_mysv       (pRExC_state->mysv1)
266 #define RExC_mysv1      (pRExC_state->mysv1)
267 #define RExC_mysv2      (pRExC_state->mysv2)
268
269 #endif
270     bool        seen_d_op;
271     bool        strict;
272     bool        study_started;
273     bool        in_script_run;
274     bool        use_BRANCHJ;
275     bool        sWARN_EXPERIMENTAL__VLB;
276     bool        sWARN_EXPERIMENTAL__REGEX_SETS;
277 };
278
279 #define RExC_flags      (pRExC_state->flags)
280 #define RExC_pm_flags   (pRExC_state->pm_flags)
281 #define RExC_precomp    (pRExC_state->precomp)
282 #define RExC_copy_start_in_input (pRExC_state->copy_start_in_input)
283 #define RExC_copy_start_in_constructed  (pRExC_state->copy_start)
284 #define RExC_save_copy_start_in_constructed  (pRExC_state->save_copy_start)
285 #define RExC_precomp_end (pRExC_state->precomp_end)
286 #define RExC_rx_sv      (pRExC_state->rx_sv)
287 #define RExC_rx         (pRExC_state->rx)
288 #define RExC_rxi        (pRExC_state->rxi)
289 #define RExC_start      (pRExC_state->start)
290 #define RExC_end        (pRExC_state->end)
291 #define RExC_parse      (pRExC_state->parse)
292 #define RExC_latest_warn_offset (pRExC_state->latest_warn_offset )
293 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
294 #define RExC_seen_d_op (pRExC_state->seen_d_op) /* Seen something that differs
295                                                    under /d from /u ? */
296
297 #ifdef RE_TRACK_PATTERN_OFFSETS
298 #  define RExC_offsets  (RExC_rxi->u.offsets) /* I am not like the
299                                                          others */
300 #endif
301 #define RExC_emit       (pRExC_state->emit)
302 #define RExC_emit_start (pRExC_state->emit_start)
303 #define RExC_sawback    (pRExC_state->sawback)
304 #define RExC_seen       (pRExC_state->seen)
305 #define RExC_size       (pRExC_state->size)
306 #define RExC_maxlen        (pRExC_state->maxlen)
307 #define RExC_npar       (pRExC_state->npar)
308 #define RExC_total_parens       (pRExC_state->total_par)
309 #define RExC_parens_buf_size    (pRExC_state->parens_buf_size)
310 #define RExC_nestroot   (pRExC_state->nestroot)
311 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
312 #define RExC_utf8       (pRExC_state->utf8)
313 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
314 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
315 #define RExC_open_parens        (pRExC_state->open_parens)
316 #define RExC_close_parens       (pRExC_state->close_parens)
317 #define RExC_end_op     (pRExC_state->end_op)
318 #define RExC_paren_names        (pRExC_state->paren_names)
319 #define RExC_recurse    (pRExC_state->recurse)
320 #define RExC_recurse_count      (pRExC_state->recurse_count)
321 #define RExC_sets_depth         (pRExC_state->sets_depth)
322 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
323 #define RExC_study_chunk_recursed_bytes  \
324                                    (pRExC_state->study_chunk_recursed_bytes)
325 #define RExC_in_lookaround      (pRExC_state->in_lookaround)
326 #define RExC_contains_locale    (pRExC_state->contains_locale)
327 #define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
328
329 #ifdef EBCDIC
330 #  define SET_recode_x_to_native(x)                                         \
331                     STMT_START { RExC_recode_x_to_native = (x); } STMT_END
332 #else
333 #  define SET_recode_x_to_native(x) NOOP
334 #endif
335
336 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
337 #define RExC_frame_head (pRExC_state->frame_head)
338 #define RExC_frame_last (pRExC_state->frame_last)
339 #define RExC_frame_count (pRExC_state->frame_count)
340 #define RExC_strict (pRExC_state->strict)
341 #define RExC_study_started      (pRExC_state->study_started)
342 #define RExC_warn_text (pRExC_state->warn_text)
343 #define RExC_in_script_run      (pRExC_state->in_script_run)
344 #define RExC_use_BRANCHJ        (pRExC_state->use_BRANCHJ)
345 #define RExC_warned_WARN_EXPERIMENTAL__VLB (pRExC_state->sWARN_EXPERIMENTAL__VLB)
346 #define RExC_warned_WARN_EXPERIMENTAL__REGEX_SETS (pRExC_state->sWARN_EXPERIMENTAL__REGEX_SETS)
347 #define RExC_unlexed_names (pRExC_state->unlexed_names)
348
349 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
350  * a flag to disable back-off on the fixed/floating substrings - if it's
351  * a high complexity pattern we assume the benefit of avoiding a full match
352  * is worth the cost of checking for the substrings even if they rarely help.
353  */
354 #define RExC_naughty    (pRExC_state->naughty)
355 #define TOO_NAUGHTY (10)
356 #define MARK_NAUGHTY(add) \
357     if (RExC_naughty < TOO_NAUGHTY) \
358         RExC_naughty += (add)
359 #define MARK_NAUGHTY_EXP(exp, add) \
360     if (RExC_naughty < TOO_NAUGHTY) \
361         RExC_naughty += RExC_naughty / (exp) + (add)
362
363 #define isNON_BRACE_QUANTIFIER(c)   ((c) == '*' || (c) == '+' || (c) == '?')
364 #define isQUANTIFIER(s,e)  (   isNON_BRACE_QUANTIFIER(*s)                      \
365                             || ((*s) == '{' && regcurly(s, e, NULL)))
366
367 /*
368  * Flags to be passed up and down.
369  */
370 #define HASWIDTH        0x01    /* Known to not match null strings, could match
371                                    non-null ones. */
372 #define SIMPLE          0x02    /* Exactly one character wide */
373                                 /* (or LNBREAK as a special case) */
374 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
375 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
376 #define RESTART_PARSE   0x20    /* Need to redo the parse */
377 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PARSE, need to
378                                    calcuate sizes as UTF-8 */
379
380 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
381
382 /* whether trie related optimizations are enabled */
383 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
384 #define TRIE_STUDY_OPT
385 #define FULL_TRIE_STUDY
386 #define TRIE_STCLASS
387 #endif
388
389
390
391 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
392 #define PBITVAL(paren) (1 << ((paren) & 7))
393 #define PAREN_OFFSET(depth) \
394     (RExC_study_chunk_recursed + (depth) * RExC_study_chunk_recursed_bytes)
395 #define PAREN_TEST(depth, paren) \
396     (PBYTE(PAREN_OFFSET(depth), paren) & PBITVAL(paren))
397 #define PAREN_SET(depth, paren) \
398     (PBYTE(PAREN_OFFSET(depth), paren) |= PBITVAL(paren))
399 #define PAREN_UNSET(depth, paren) \
400     (PBYTE(PAREN_OFFSET(depth), paren) &= ~PBITVAL(paren))
401
402 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
403                                      if (!UTF) {                           \
404                                          *flagp = RESTART_PARSE|NEED_UTF8; \
405                                          return 0;                         \
406                                      }                                     \
407                              } STMT_END
408
409 /* /u is to be chosen if we are supposed to use Unicode rules, or if the
410  * pattern is in UTF-8.  This latter condition is in case the outermost rules
411  * are locale.  See GH #17278 */
412 #define toUSE_UNI_CHARSET_NOT_DEPENDS (RExC_uni_semantics || UTF)
413
414 /* Change from /d into /u rules, and restart the parse.  RExC_uni_semantics is
415  * a flag that indicates we need to override /d with /u as a result of
416  * something in the pattern.  It should only be used in regards to calling
417  * set_regex_charset() or get_regex_charset() */
418 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
419     STMT_START {                                                            \
420             if (DEPENDS_SEMANTICS) {                                        \
421                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
422                 RExC_uni_semantics = 1;                                     \
423                 if (RExC_seen_d_op && LIKELY(! IN_PARENS_PASS)) {           \
424                     /* No need to restart the parse if we haven't seen      \
425                      * anything that differs between /u and /d, and no need \
426                      * to restart immediately if we're going to reparse     \
427                      * anyway to count parens */                            \
428                     *flagp |= RESTART_PARSE;                                \
429                     return restart_retval;                                  \
430                 }                                                           \
431             }                                                               \
432     } STMT_END
433
434 #define REQUIRE_BRANCHJ(flagp, restart_retval)                              \
435     STMT_START {                                                            \
436                 RExC_use_BRANCHJ = 1;                                       \
437                 *flagp |= RESTART_PARSE;                                    \
438                 return restart_retval;                                      \
439     } STMT_END
440
441 /* Until we have completed the parse, we leave RExC_total_parens at 0 or
442  * less.  After that, it must always be positive, because the whole re is
443  * considered to be surrounded by virtual parens.  Setting it to negative
444  * indicates there is some construct that needs to know the actual number of
445  * parens to be properly handled.  And that means an extra pass will be
446  * required after we've counted them all */
447 #define ALL_PARENS_COUNTED (RExC_total_parens > 0)
448 #define REQUIRE_PARENS_PASS                                                 \
449     STMT_START {  /* No-op if have completed a pass */                      \
450                     if (! ALL_PARENS_COUNTED) RExC_total_parens = -1;       \
451     } STMT_END
452 #define IN_PARENS_PASS (RExC_total_parens < 0)
453
454
455 /* This is used to return failure (zero) early from the calling function if
456  * various flags in 'flags' are set.  Two flags always cause a return:
457  * 'RESTART_PARSE' and 'NEED_UTF8'.   'extra' can be used to specify any
458  * additional flags that should cause a return; 0 if none.  If the return will
459  * be done, '*flagp' is first set to be all of the flags that caused the
460  * return. */
461 #define RETURN_FAIL_ON_RESTART_OR_FLAGS(flags,flagp,extra)                  \
462     STMT_START {                                                            \
463             if ((flags) & (RESTART_PARSE|NEED_UTF8|(extra))) {              \
464                 *(flagp) = (flags) & (RESTART_PARSE|NEED_UTF8|(extra));     \
465                 return 0;                                                   \
466             }                                                               \
467     } STMT_END
468
469 #define MUST_RESTART(flags) ((flags) & (RESTART_PARSE))
470
471 #define RETURN_FAIL_ON_RESTART(flags,flagp)                                 \
472                         RETURN_FAIL_ON_RESTART_OR_FLAGS( flags, flagp, 0)
473 #define RETURN_FAIL_ON_RESTART_FLAGP(flagp)                                 \
474                                     if (MUST_RESTART(*(flagp))) return 0
475
476 /* This converts the named class defined in regcomp.h to its equivalent class
477  * number defined in handy.h. */
478 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
479 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
480
481 #define _invlist_union_complement_2nd(a, b, output) \
482                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
483 #define _invlist_intersection_complement_2nd(a, b, output) \
484                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
485
486 /* We add a marker if we are deferring expansion of a property that is both
487  * 1) potentiallly user-defined; and
488  * 2) could also be an official Unicode property.
489  *
490  * Without this marker, any deferred expansion can only be for a user-defined
491  * one.  This marker shouldn't conflict with any that could be in a legal name,
492  * and is appended to its name to indicate this.  There is a string and
493  * character form */
494 #define DEFERRED_COULD_BE_OFFICIAL_MARKERs  "~"
495 #define DEFERRED_COULD_BE_OFFICIAL_MARKERc  '~'
496
497 /* What is infinity for optimization purposes */
498 #define OPTIMIZE_INFTY  SSize_t_MAX
499
500 /* About scan_data_t.
501
502   During optimisation we recurse through the regexp program performing
503   various inplace (keyhole style) optimisations. In addition study_chunk
504   and scan_commit populate this data structure with information about
505   what strings MUST appear in the pattern. We look for the longest
506   string that must appear at a fixed location, and we look for the
507   longest string that may appear at a floating location. So for instance
508   in the pattern:
509
510     /FOO[xX]A.*B[xX]BAR/
511
512   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
513   strings (because they follow a .* construct). study_chunk will identify
514   both FOO and BAR as being the longest fixed and floating strings respectively.
515
516   The strings can be composites, for instance
517
518      /(f)(o)(o)/
519
520   will result in a composite fixed substring 'foo'.
521
522   For each string some basic information is maintained:
523
524   - min_offset
525     This is the position the string must appear at, or not before.
526     It also implicitly (when combined with minlenp) tells us how many
527     characters must match before the string we are searching for.
528     Likewise when combined with minlenp and the length of the string it
529     tells us how many characters must appear after the string we have
530     found.
531
532   - max_offset
533     Only used for floating strings. This is the rightmost point that
534     the string can appear at. If set to OPTIMIZE_INFTY it indicates that the
535     string can occur infinitely far to the right.
536     For fixed strings, it is equal to min_offset.
537
538   - minlenp
539     A pointer to the minimum number of characters of the pattern that the
540     string was found inside. This is important as in the case of positive
541     lookahead or positive lookbehind we can have multiple patterns
542     involved. Consider
543
544     /(?=FOO).*F/
545
546     The minimum length of the pattern overall is 3, the minimum length
547     of the lookahead part is 3, but the minimum length of the part that
548     will actually match is 1. So 'FOO's minimum length is 3, but the
549     minimum length for the F is 1. This is important as the minimum length
550     is used to determine offsets in front of and behind the string being
551     looked for.  Since strings can be composites this is the length of the
552     pattern at the time it was committed with a scan_commit. Note that
553     the length is calculated by study_chunk, so that the minimum lengths
554     are not known until the full pattern has been compiled, thus the
555     pointer to the value.
556
557   - lookbehind
558
559     In the case of lookbehind the string being searched for can be
560     offset past the start point of the final matching string.
561     If this value was just blithely removed from the min_offset it would
562     invalidate some of the calculations for how many chars must match
563     before or after (as they are derived from min_offset and minlen and
564     the length of the string being searched for).
565     When the final pattern is compiled and the data is moved from the
566     scan_data_t structure into the regexp structure the information
567     about lookbehind is factored in, with the information that would
568     have been lost precalculated in the end_shift field for the
569     associated string.
570
571   The fields pos_min and pos_delta are used to store the minimum offset
572   and the delta to the maximum offset at the current point in the pattern.
573
574 */
575
576 struct scan_data_substrs {
577     SV      *str;       /* longest substring found in pattern */
578     SSize_t min_offset; /* earliest point in string it can appear */
579     SSize_t max_offset; /* latest point in string it can appear */
580     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
581     SSize_t lookbehind; /* is the pos of the string modified by LB */
582     I32 flags;          /* per substring SF_* and SCF_* flags */
583 };
584
585 typedef struct scan_data_t {
586     /*I32 len_min;      unused */
587     /*I32 len_delta;    unused */
588     SSize_t pos_min;
589     SSize_t pos_delta;
590     SV *last_found;
591     SSize_t last_end;       /* min value, <0 unless valid. */
592     SSize_t last_start_min;
593     SSize_t last_start_max;
594     U8      cur_is_floating; /* whether the last_* values should be set as
595                               * the next fixed (0) or floating (1)
596                               * substring */
597
598     /* [0] is longest fixed substring so far, [1] is longest float so far */
599     struct scan_data_substrs  substrs[2];
600
601     I32 flags;             /* common SF_* and SCF_* flags */
602     I32 whilem_c;
603     SSize_t *last_closep;
604     regnode_ssc *start_class;
605 } scan_data_t;
606
607 /*
608  * Forward declarations for pregcomp()'s friends.
609  */
610
611 static const scan_data_t zero_scan_data = {
612     0, 0, NULL, 0, 0, 0, 0,
613     {
614         { NULL, 0, 0, 0, 0, 0 },
615         { NULL, 0, 0, 0, 0, 0 },
616     },
617     0, 0, NULL, NULL
618 };
619
620 /* study flags */
621
622 #define SF_BEFORE_SEOL          0x0001
623 #define SF_BEFORE_MEOL          0x0002
624 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
625
626 #define SF_IS_INF               0x0040
627 #define SF_HAS_PAR              0x0080
628 #define SF_IN_PAR               0x0100
629 #define SF_HAS_EVAL             0x0200
630
631
632 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
633  * longest substring in the pattern. When it is not set the optimiser keeps
634  * track of position, but does not keep track of the actual strings seen,
635  *
636  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
637  * /foo/i will not.
638  *
639  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
640  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
641  * turned off because of the alternation (BRANCH). */
642 #define SCF_DO_SUBSTR           0x0400
643
644 #define SCF_DO_STCLASS_AND      0x0800
645 #define SCF_DO_STCLASS_OR       0x1000
646 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
647 #define SCF_WHILEM_VISITED_POS  0x2000
648
649 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
650 #define SCF_SEEN_ACCEPT         0x8000
651 #define SCF_TRIE_DOING_RESTUDY 0x10000
652 #define SCF_IN_DEFINE          0x20000
653
654
655
656
657 #define UTF cBOOL(RExC_utf8)
658
659 /* The enums for all these are ordered so things work out correctly */
660 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
661 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
662                                                      == REGEX_DEPENDS_CHARSET)
663 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
664 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
665                                                      >= REGEX_UNICODE_CHARSET)
666 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
667                                             == REGEX_ASCII_RESTRICTED_CHARSET)
668 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
669                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
670 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
671                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
672
673 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
674
675 /* For programs that want to be strictly Unicode compatible by dying if any
676  * attempt is made to match a non-Unicode code point against a Unicode
677  * property.  */
678 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
679
680 #define OOB_NAMEDCLASS          -1
681
682 /* There is no code point that is out-of-bounds, so this is problematic.  But
683  * its only current use is to initialize a variable that is always set before
684  * looked at. */
685 #define OOB_UNICODE             0xDEADBEEF
686
687 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
688
689
690 /* length of regex to show in messages that don't mark a position within */
691 #define RegexLengthToShowInErrorMessages 127
692
693 /*
694  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
695  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
696  * op/pragma/warn/regcomp.
697  */
698 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
699 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
700
701 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
702                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
703
704 /* The code in this file in places uses one level of recursion with parsing
705  * rebased to an alternate string constructed by us in memory.  This can take
706  * the form of something that is completely different from the input, or
707  * something that uses the input as part of the alternate.  In the first case,
708  * there should be no possibility of an error, as we are in complete control of
709  * the alternate string.  But in the second case we don't completely control
710  * the input portion, so there may be errors in that.  Here's an example:
711  *      /[abc\x{DF}def]/ui
712  * is handled specially because \x{df} folds to a sequence of more than one
713  * character: 'ss'.  What is done is to create and parse an alternate string,
714  * which looks like this:
715  *      /(?:\x{DF}|[abc\x{DF}def])/ui
716  * where it uses the input unchanged in the middle of something it constructs,
717  * which is a branch for the DF outside the character class, and clustering
718  * parens around the whole thing. (It knows enough to skip the DF inside the
719  * class while in this substitute parse.) 'abc' and 'def' may have errors that
720  * need to be reported.  The general situation looks like this:
721  *
722  *                                       |<------- identical ------>|
723  *              sI                       tI               xI       eI
724  * Input:       ---------------------------------------------------------------
725  * Constructed:         ---------------------------------------------------
726  *                      sC               tC               xC       eC     EC
727  *                                       |<------- identical ------>|
728  *
729  * sI..eI   is the portion of the input pattern we are concerned with here.
730  * sC..EC   is the constructed substitute parse string.
731  *  sC..tC  is constructed by us
732  *  tC..eC  is an exact duplicate of the portion of the input pattern tI..eI.
733  *          In the diagram, these are vertically aligned.
734  *  eC..EC  is also constructed by us.
735  * xC       is the position in the substitute parse string where we found a
736  *          problem.
737  * xI       is the position in the original pattern corresponding to xC.
738  *
739  * We want to display a message showing the real input string.  Thus we need to
740  * translate from xC to xI.  We know that xC >= tC, since the portion of the
741  * string sC..tC has been constructed by us, and so shouldn't have errors.  We
742  * get:
743  *      xI = tI + (xC - tC)
744  *
745  * When the substitute parse is constructed, the code needs to set:
746  *      RExC_start (sC)
747  *      RExC_end (eC)
748  *      RExC_copy_start_in_input  (tI)
749  *      RExC_copy_start_in_constructed (tC)
750  * and restore them when done.
751  *
752  * During normal processing of the input pattern, both
753  * 'RExC_copy_start_in_input' and 'RExC_copy_start_in_constructed' are set to
754  * sI, so that xC equals xI.
755  */
756
757 #define sI              RExC_precomp
758 #define eI              RExC_precomp_end
759 #define sC              RExC_start
760 #define eC              RExC_end
761 #define tI              RExC_copy_start_in_input
762 #define tC              RExC_copy_start_in_constructed
763 #define xI(xC)          (tI + (xC - tC))
764 #define xI_offset(xC)   (xI(xC) - sI)
765
766 #define REPORT_LOCATION_ARGS(xC)                                            \
767     UTF8fARG(UTF,                                                           \
768              (xI(xC) > eI) /* Don't run off end */                          \
769               ? eI - sI   /* Length before the <--HERE */                   \
770               : ((xI_offset(xC) >= 0)                                       \
771                  ? xI_offset(xC)                                            \
772                  : (Perl_croak(aTHX_ "panic: %s: %d: negative offset: %"    \
773                                     IVdf " trying to output message for "   \
774                                     " pattern %.*s",                        \
775                                     __FILE__, __LINE__, (IV) xI_offset(xC), \
776                                     ((int) (eC - sC)), sC), 0)),            \
777              sI),         /* The input pattern printed up to the <--HERE */ \
778     UTF8fARG(UTF,                                                           \
779              (xI(xC) > eI) ? 0 : eI - xI(xC), /* Length after <--HERE */    \
780              (xI(xC) > eI) ? eI : xI(xC))     /* pattern after <--HERE */
781
782 /* Used to point after bad bytes for an error message, but avoid skipping
783  * past a nul byte. */
784 #define SKIP_IF_CHAR(s, e) (!*(s) ? 0 : UTF ? UTF8_SAFE_SKIP(s, e) : 1)
785
786 /* Set up to clean up after our imminent demise */
787 #define PREPARE_TO_DIE                                                      \
788     STMT_START {                                                            \
789         if (RExC_rx_sv)                                                     \
790             SAVEFREESV(RExC_rx_sv);                                         \
791         if (RExC_open_parens)                                               \
792             SAVEFREEPV(RExC_open_parens);                                   \
793         if (RExC_close_parens)                                              \
794             SAVEFREEPV(RExC_close_parens);                                  \
795     } STMT_END
796
797 /*
798  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
799  * arg. Show regex, up to a maximum length. If it's too long, chop and add
800  * "...".
801  */
802 #define _FAIL(code) STMT_START {                                        \
803     const char *ellipses = "";                                          \
804     IV len = RExC_precomp_end - RExC_precomp;                           \
805                                                                         \
806     PREPARE_TO_DIE;                                                     \
807     if (len > RegexLengthToShowInErrorMessages) {                       \
808         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
809         len = RegexLengthToShowInErrorMessages - 10;                    \
810         ellipses = "...";                                               \
811     }                                                                   \
812     code;                                                               \
813 } STMT_END
814
815 #define FAIL(msg) _FAIL(                            \
816     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
817             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
818
819 #define FAIL2(msg,arg) _FAIL(                       \
820     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
821             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
822
823 #define FAIL3(msg,arg1,arg2) _FAIL(                         \
824     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
825      arg1, arg2, UTF8fARG(UTF, len, RExC_precomp), ellipses))
826
827 /*
828  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
829  */
830 #define Simple_vFAIL(m) STMT_START {                                    \
831     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
832             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
833 } STMT_END
834
835 /*
836  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
837  */
838 #define vFAIL(m) STMT_START {                           \
839     PREPARE_TO_DIE;                                     \
840     Simple_vFAIL(m);                                    \
841 } STMT_END
842
843 /*
844  * Like Simple_vFAIL(), but accepts two arguments.
845  */
846 #define Simple_vFAIL2(m,a1) STMT_START {                        \
847     S_re_croak(aTHX_ UTF, m REPORT_LOCATION, a1,                \
848                       REPORT_LOCATION_ARGS(RExC_parse));        \
849 } STMT_END
850
851 /*
852  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
853  */
854 #define vFAIL2(m,a1) STMT_START {                       \
855     PREPARE_TO_DIE;                                     \
856     Simple_vFAIL2(m, a1);                               \
857 } STMT_END
858
859
860 /*
861  * Like Simple_vFAIL(), but accepts three arguments.
862  */
863 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
864     S_re_croak(aTHX_ UTF, m REPORT_LOCATION, a1, a2,            \
865             REPORT_LOCATION_ARGS(RExC_parse));                  \
866 } STMT_END
867
868 /*
869  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
870  */
871 #define vFAIL3(m,a1,a2) STMT_START {                    \
872     PREPARE_TO_DIE;                                     \
873     Simple_vFAIL3(m, a1, a2);                           \
874 } STMT_END
875
876 /*
877  * Like Simple_vFAIL(), but accepts four arguments.
878  */
879 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
880     S_re_croak(aTHX_ UTF, m REPORT_LOCATION, a1, a2, a3,        \
881             REPORT_LOCATION_ARGS(RExC_parse));                  \
882 } STMT_END
883
884 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
885     PREPARE_TO_DIE;                                     \
886     Simple_vFAIL4(m, a1, a2, a3);                       \
887 } STMT_END
888
889 /* A specialized version of vFAIL2 that works with UTF8f */
890 #define vFAIL2utf8f(m, a1) STMT_START {             \
891     PREPARE_TO_DIE;                                 \
892     S_re_croak(aTHX_ UTF, m REPORT_LOCATION, a1,  \
893             REPORT_LOCATION_ARGS(RExC_parse));      \
894 } STMT_END
895
896 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
897     PREPARE_TO_DIE;                                     \
898     S_re_croak(aTHX_ UTF, m REPORT_LOCATION, a1, a2,  \
899             REPORT_LOCATION_ARGS(RExC_parse));          \
900 } STMT_END
901
902 /* Setting this to NULL is a signal to not output warnings */
903 #define TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE                               \
904     STMT_START {                                                            \
905       RExC_save_copy_start_in_constructed  = RExC_copy_start_in_constructed;\
906       RExC_copy_start_in_constructed = NULL;                                \
907     } STMT_END
908 #define RESTORE_WARNINGS                                                    \
909     RExC_copy_start_in_constructed = RExC_save_copy_start_in_constructed
910
911 /* Since a warning can be generated multiple times as the input is reparsed, we
912  * output it the first time we come to that point in the parse, but suppress it
913  * otherwise.  'RExC_copy_start_in_constructed' being NULL is a flag to not
914  * generate any warnings */
915 #define TO_OUTPUT_WARNINGS(loc)                                         \
916   (   RExC_copy_start_in_constructed                                    \
917    && ((xI(loc)) - RExC_precomp) > (Ptrdiff_t) RExC_latest_warn_offset)
918
919 /* After we've emitted a warning, we save the position in the input so we don't
920  * output it again */
921 #define UPDATE_WARNINGS_LOC(loc)                                        \
922     STMT_START {                                                        \
923         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
924             RExC_latest_warn_offset = MAX(sI, MIN(eI, xI(loc)))         \
925                                                        - RExC_precomp;  \
926         }                                                               \
927     } STMT_END
928
929 /* 'warns' is the output of the packWARNx macro used in 'code' */
930 #define _WARN_HELPER(loc, warns, code)                                  \
931     STMT_START {                                                        \
932         if (! RExC_copy_start_in_constructed) {                         \
933             Perl_croak( aTHX_ "panic! %s: %d: Tried to warn when none"  \
934                               " expected at '%s'",                      \
935                               __FILE__, __LINE__, loc);                 \
936         }                                                               \
937         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
938             if (ckDEAD(warns))                                          \
939                 PREPARE_TO_DIE;                                         \
940             code;                                                       \
941             UPDATE_WARNINGS_LOC(loc);                                   \
942         }                                                               \
943     } STMT_END
944
945 /* m is not necessarily a "literal string", in this macro */
946 #define warn_non_literal_string(loc, packed_warn, m)                    \
947     _WARN_HELPER(loc, packed_warn,                                      \
948                       Perl_warner(aTHX_ packed_warn,                    \
949                                        "%s" REPORT_LOCATION,            \
950                                   m, REPORT_LOCATION_ARGS(loc)))
951 #define reg_warn_non_literal_string(loc, m)                             \
952                 warn_non_literal_string(loc, packWARN(WARN_REGEXP), m)
953
954 #define ckWARN2_non_literal_string(loc, packwarn, m, a1)                    \
955     STMT_START {                                                            \
956                 char * format;                                              \
957                 Size_t format_size = strlen(m) + strlen(REPORT_LOCATION)+ 1;\
958                 Newx(format, format_size, char);                            \
959                 my_strlcpy(format, m, format_size);                         \
960                 my_strlcat(format, REPORT_LOCATION, format_size);           \
961                 SAVEFREEPV(format);                                         \
962                 _WARN_HELPER(loc, packwarn,                                 \
963                       Perl_ck_warner(aTHX_ packwarn,                        \
964                                         format,                             \
965                                         a1, REPORT_LOCATION_ARGS(loc)));    \
966     } STMT_END
967
968 #define ckWARNreg(loc,m)                                                \
969     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
970                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
971                                           m REPORT_LOCATION,            \
972                                           REPORT_LOCATION_ARGS(loc)))
973
974 #define vWARN(loc, m)                                                   \
975     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
976                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
977                                        m REPORT_LOCATION,               \
978                                        REPORT_LOCATION_ARGS(loc)))      \
979
980 #define vWARN_dep(loc, m)                                               \
981     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
982                       Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),      \
983                                        m REPORT_LOCATION,               \
984                                        REPORT_LOCATION_ARGS(loc)))
985
986 #define ckWARNdep(loc,m)                                                \
987     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
988                       Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
989                                             m REPORT_LOCATION,          \
990                                             REPORT_LOCATION_ARGS(loc)))
991
992 #define ckWARNregdep(loc,m)                                                 \
993     _WARN_HELPER(loc, packWARN2(WARN_DEPRECATED, WARN_REGEXP),              \
994                       Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,     \
995                                                       WARN_REGEXP),         \
996                                              m REPORT_LOCATION,             \
997                                              REPORT_LOCATION_ARGS(loc)))
998
999 #define ckWARN2reg_d(loc,m, a1)                                             \
1000     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
1001                       Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),         \
1002                                             m REPORT_LOCATION,              \
1003                                             a1, REPORT_LOCATION_ARGS(loc)))
1004
1005 #define ckWARN2reg(loc, m, a1)                                              \
1006     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
1007                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
1008                                           m REPORT_LOCATION,                \
1009                                           a1, REPORT_LOCATION_ARGS(loc)))
1010
1011 #define vWARN3(loc, m, a1, a2)                                              \
1012     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
1013                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),              \
1014                                        m REPORT_LOCATION,                   \
1015                                        a1, a2, REPORT_LOCATION_ARGS(loc)))
1016
1017 #define ckWARN3reg(loc, m, a1, a2)                                          \
1018     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
1019                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
1020                                           m REPORT_LOCATION,                \
1021                                           a1, a2,                           \
1022                                           REPORT_LOCATION_ARGS(loc)))
1023
1024 #define vWARN4(loc, m, a1, a2, a3)                                      \
1025     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
1026                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
1027                                        m REPORT_LOCATION,               \
1028                                        a1, a2, a3,                      \
1029                                        REPORT_LOCATION_ARGS(loc)))
1030
1031 #define ckWARN4reg(loc, m, a1, a2, a3)                                  \
1032     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
1033                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
1034                                           m REPORT_LOCATION,            \
1035                                           a1, a2, a3,                   \
1036                                           REPORT_LOCATION_ARGS(loc)))
1037
1038 #define vWARN5(loc, m, a1, a2, a3, a4)                                  \
1039     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
1040                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
1041                                        m REPORT_LOCATION,               \
1042                                        a1, a2, a3, a4,                  \
1043                                        REPORT_LOCATION_ARGS(loc)))
1044
1045 #define ckWARNexperimental(loc, class, m)                               \
1046     STMT_START {                                                        \
1047         if (! RExC_warned_ ## class) { /* warn once per compilation */  \
1048             RExC_warned_ ## class = 1;                                  \
1049             _WARN_HELPER(loc, packWARN(class),                          \
1050                       Perl_ck_warner_d(aTHX_ packWARN(class),           \
1051                                             m REPORT_LOCATION,          \
1052                                             REPORT_LOCATION_ARGS(loc)));\
1053         }                                                               \
1054     } STMT_END
1055
1056 /* Convert between a pointer to a node and its offset from the beginning of the
1057  * program */
1058 #define REGNODE_p(offset)    (RExC_emit_start + (offset))
1059 #define REGNODE_OFFSET(node) ((node) - RExC_emit_start)
1060
1061 /* Macros for recording node offsets.   20001227 mjd@plover.com
1062  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
1063  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
1064  * Element 0 holds the number n.
1065  * Position is 1 indexed.
1066  */
1067 #ifndef RE_TRACK_PATTERN_OFFSETS
1068 #define Set_Node_Offset_To_R(offset,byte)
1069 #define Set_Node_Offset(node,byte)
1070 #define Set_Cur_Node_Offset
1071 #define Set_Node_Length_To_R(node,len)
1072 #define Set_Node_Length(node,len)
1073 #define Set_Node_Cur_Length(node,start)
1074 #define Node_Offset(n)
1075 #define Node_Length(n)
1076 #define Set_Node_Offset_Length(node,offset,len)
1077 #define ProgLen(ri) ri->u.proglen
1078 #define SetProgLen(ri,x) ri->u.proglen = x
1079 #define Track_Code(code)
1080 #else
1081 #define ProgLen(ri) ri->u.offsets[0]
1082 #define SetProgLen(ri,x) ri->u.offsets[0] = x
1083 #define Set_Node_Offset_To_R(offset,byte) STMT_START {                  \
1084         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
1085                     __LINE__, (int)(offset), (int)(byte)));             \
1086         if((offset) < 0) {                                              \
1087             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
1088                                          (int)(offset));                \
1089         } else {                                                        \
1090             RExC_offsets[2*(offset)-1] = (byte);                        \
1091         }                                                               \
1092 } STMT_END
1093
1094 #define Set_Node_Offset(node,byte)                                      \
1095     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (byte)-RExC_start)
1096 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
1097
1098 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
1099         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
1100                 __LINE__, (int)(node), (int)(len)));                    \
1101         if((node) < 0) {                                                \
1102             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
1103                                          (int)(node));                  \
1104         } else {                                                        \
1105             RExC_offsets[2*(node)] = (len);                             \
1106         }                                                               \
1107 } STMT_END
1108
1109 #define Set_Node_Length(node,len) \
1110     Set_Node_Length_To_R(REGNODE_OFFSET(node), len)
1111 #define Set_Node_Cur_Length(node, start)                \
1112     Set_Node_Length(node, RExC_parse - start)
1113
1114 /* Get offsets and lengths */
1115 #define Node_Offset(n) (RExC_offsets[2*(REGNODE_OFFSET(n))-1])
1116 #define Node_Length(n) (RExC_offsets[2*(REGNODE_OFFSET(n))])
1117
1118 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
1119     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (offset));       \
1120     Set_Node_Length_To_R(REGNODE_OFFSET(node), (len));  \
1121 } STMT_END
1122
1123 #define Track_Code(code) STMT_START { code } STMT_END
1124 #endif
1125
1126 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
1127 #define EXPERIMENTAL_INPLACESCAN
1128 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
1129
1130 #ifdef DEBUGGING
1131 int
1132 Perl_re_printf(pTHX_ const char *fmt, ...)
1133 {
1134     va_list ap;
1135     int result;
1136     PerlIO *f= Perl_debug_log;
1137     PERL_ARGS_ASSERT_RE_PRINTF;
1138     va_start(ap, fmt);
1139     result = PerlIO_vprintf(f, fmt, ap);
1140     va_end(ap);
1141     return result;
1142 }
1143
1144 int
1145 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
1146 {
1147     va_list ap;
1148     int result;
1149     PerlIO *f= Perl_debug_log;
1150     PERL_ARGS_ASSERT_RE_INDENTF;
1151     va_start(ap, depth);
1152     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
1153     result = PerlIO_vprintf(f, fmt, ap);
1154     va_end(ap);
1155     return result;
1156 }
1157 #endif /* DEBUGGING */
1158
1159 #define DEBUG_RExC_seen()                                                   \
1160         DEBUG_OPTIMISE_MORE_r({                                             \
1161             Perl_re_printf( aTHX_ "RExC_seen: ");                           \
1162                                                                             \
1163             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
1164                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                \
1165                                                                             \
1166             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
1167                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");              \
1168                                                                             \
1169             if (RExC_seen & REG_GPOS_SEEN)                                  \
1170                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                    \
1171                                                                             \
1172             if (RExC_seen & REG_RECURSE_SEEN)                               \
1173                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                 \
1174                                                                             \
1175             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
1176                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");      \
1177                                                                             \
1178             if (RExC_seen & REG_VERBARG_SEEN)                               \
1179                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                 \
1180                                                                             \
1181             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
1182                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                \
1183                                                                             \
1184             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
1185                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");          \
1186                                                                             \
1187             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
1188                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");          \
1189                                                                             \
1190             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
1191                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");    \
1192                                                                             \
1193             Perl_re_printf( aTHX_ "\n");                                    \
1194         });
1195
1196 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
1197   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
1198
1199
1200 #ifdef DEBUGGING
1201 static void
1202 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
1203                                     const char *close_str)
1204 {
1205     if (!flags)
1206         return;
1207
1208     Perl_re_printf( aTHX_  "%s", open_str);
1209     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
1210     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
1211     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
1212     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
1213     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
1214     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
1215     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
1216     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
1217     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
1218     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
1219     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
1220     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
1221     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1222     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1223     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1224     Perl_re_printf( aTHX_  "%s", close_str);
1225 }
1226
1227
1228 static void
1229 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1230                     U32 depth, int is_inf)
1231 {
1232     DECLARE_AND_GET_RE_DEBUG_FLAGS;
1233
1234     DEBUG_OPTIMISE_MORE_r({
1235         if (!data)
1236             return;
1237         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1238             depth,
1239             where,
1240             (IV)data->pos_min,
1241             (IV)data->pos_delta,
1242             (UV)data->flags
1243         );
1244
1245         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1246
1247         Perl_re_printf( aTHX_
1248             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1249             (IV)data->whilem_c,
1250             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1251             is_inf ? "INF " : ""
1252         );
1253
1254         if (data->last_found) {
1255             int i;
1256             Perl_re_printf(aTHX_
1257                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1258                     SvPVX_const(data->last_found),
1259                     (IV)data->last_end,
1260                     (IV)data->last_start_min,
1261                     (IV)data->last_start_max
1262             );
1263
1264             for (i = 0; i < 2; i++) {
1265                 Perl_re_printf(aTHX_
1266                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1267                     data->cur_is_floating == i ? "*" : "",
1268                     i ? "Float" : "Fixed",
1269                     SvPVX_const(data->substrs[i].str),
1270                     (IV)data->substrs[i].min_offset,
1271                     (IV)data->substrs[i].max_offset
1272                 );
1273                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1274             }
1275         }
1276
1277         Perl_re_printf( aTHX_ "\n");
1278     });
1279 }
1280
1281
1282 static void
1283 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1284                 regnode *scan, U32 depth, U32 flags)
1285 {
1286     DECLARE_AND_GET_RE_DEBUG_FLAGS;
1287
1288     DEBUG_OPTIMISE_r({
1289         regnode *Next;
1290
1291         if (!scan)
1292             return;
1293         Next = regnext(scan);
1294         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1295         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1296             depth,
1297             str,
1298             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1299             Next ? (REG_NODE_NUM(Next)) : 0 );
1300         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1301         Perl_re_printf( aTHX_  "\n");
1302    });
1303 }
1304
1305
1306 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1307                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1308
1309 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1310                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1311
1312 #else
1313 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1314 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1315 #endif
1316
1317
1318 /* =========================================================
1319  * BEGIN edit_distance stuff.
1320  *
1321  * This calculates how many single character changes of any type are needed to
1322  * transform a string into another one.  It is taken from version 3.1 of
1323  *
1324  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1325  */
1326
1327 /* Our unsorted dictionary linked list.   */
1328 /* Note we use UVs, not chars. */
1329
1330 struct dictionary{
1331   UV key;
1332   UV value;
1333   struct dictionary* next;
1334 };
1335 typedef struct dictionary item;
1336
1337
1338 PERL_STATIC_INLINE item*
1339 push(UV key, item* curr)
1340 {
1341     item* head;
1342     Newx(head, 1, item);
1343     head->key = key;
1344     head->value = 0;
1345     head->next = curr;
1346     return head;
1347 }
1348
1349
1350 PERL_STATIC_INLINE item*
1351 find(item* head, UV key)
1352 {
1353     item* iterator = head;
1354     while (iterator){
1355         if (iterator->key == key){
1356             return iterator;
1357         }
1358         iterator = iterator->next;
1359     }
1360
1361     return NULL;
1362 }
1363
1364 PERL_STATIC_INLINE item*
1365 uniquePush(item* head, UV key)
1366 {
1367     item* iterator = head;
1368
1369     while (iterator){
1370         if (iterator->key == key) {
1371             return head;
1372         }
1373         iterator = iterator->next;
1374     }
1375
1376     return push(key, head);
1377 }
1378
1379 PERL_STATIC_INLINE void
1380 dict_free(item* head)
1381 {
1382     item* iterator = head;
1383
1384     while (iterator) {
1385         item* temp = iterator;
1386         iterator = iterator->next;
1387         Safefree(temp);
1388     }
1389
1390     head = NULL;
1391 }
1392
1393 /* End of Dictionary Stuff */
1394
1395 /* All calculations/work are done here */
1396 STATIC int
1397 S_edit_distance(const UV* src,
1398                 const UV* tgt,
1399                 const STRLEN x,             /* length of src[] */
1400                 const STRLEN y,             /* length of tgt[] */
1401                 const SSize_t maxDistance
1402 )
1403 {
1404     item *head = NULL;
1405     UV swapCount, swapScore, targetCharCount, i, j;
1406     UV *scores;
1407     UV score_ceil = x + y;
1408
1409     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1410
1411     /* intialize matrix start values */
1412     Newx(scores, ( (x + 2) * (y + 2)), UV);
1413     scores[0] = score_ceil;
1414     scores[1 * (y + 2) + 0] = score_ceil;
1415     scores[0 * (y + 2) + 1] = score_ceil;
1416     scores[1 * (y + 2) + 1] = 0;
1417     head = uniquePush(uniquePush(head, src[0]), tgt[0]);
1418
1419     /* work loops    */
1420     /* i = src index */
1421     /* j = tgt index */
1422     for (i=1;i<=x;i++) {
1423         if (i < x)
1424             head = uniquePush(head, src[i]);
1425         scores[(i+1) * (y + 2) + 1] = i;
1426         scores[(i+1) * (y + 2) + 0] = score_ceil;
1427         swapCount = 0;
1428
1429         for (j=1;j<=y;j++) {
1430             if (i == 1) {
1431                 if(j < y)
1432                 head = uniquePush(head, tgt[j]);
1433                 scores[1 * (y + 2) + (j + 1)] = j;
1434                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1435             }
1436
1437             targetCharCount = find(head, tgt[j-1])->value;
1438             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1439
1440             if (src[i-1] != tgt[j-1]){
1441                 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));
1442             }
1443             else {
1444                 swapCount = j;
1445                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1446             }
1447         }
1448
1449         find(head, src[i-1])->value = i;
1450     }
1451
1452     {
1453         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1454         dict_free(head);
1455         Safefree(scores);
1456         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1457     }
1458 }
1459
1460 /* END of edit_distance() stuff
1461  * ========================================================= */
1462
1463 /* Mark that we cannot extend a found fixed substring at this point.
1464    Update the longest found anchored substring or the longest found
1465    floating substrings if needed. */
1466
1467 STATIC void
1468 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1469                     SSize_t *minlenp, int is_inf)
1470 {
1471     const STRLEN l = CHR_SVLEN(data->last_found);
1472     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1473     const STRLEN old_l = CHR_SVLEN(longest_sv);
1474     DECLARE_AND_GET_RE_DEBUG_FLAGS;
1475
1476     PERL_ARGS_ASSERT_SCAN_COMMIT;
1477
1478     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1479         const U8 i = data->cur_is_floating;
1480         SvSetMagicSV(longest_sv, data->last_found);
1481         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1482
1483         if (!i) /* fixed */
1484             data->substrs[0].max_offset = data->substrs[0].min_offset;
1485         else { /* float */
1486             data->substrs[1].max_offset =
1487                       (is_inf)
1488                        ? OPTIMIZE_INFTY
1489                        : (l
1490                           ? data->last_start_max
1491                           /* temporary underflow guard for 5.32 */
1492                           : data->pos_delta < 0 ? OPTIMIZE_INFTY
1493                           : (data->pos_delta > OPTIMIZE_INFTY - data->pos_min
1494                                          ? OPTIMIZE_INFTY
1495                                          : data->pos_min + data->pos_delta));
1496         }
1497
1498         data->substrs[i].flags &= ~SF_BEFORE_EOL;
1499         data->substrs[i].flags |= data->flags & SF_BEFORE_EOL;
1500         data->substrs[i].minlenp = minlenp;
1501         data->substrs[i].lookbehind = 0;
1502     }
1503
1504     SvCUR_set(data->last_found, 0);
1505     {
1506         SV * const sv = data->last_found;
1507         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1508             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1509             if (mg)
1510                 mg->mg_len = 0;
1511         }
1512     }
1513     data->last_end = -1;
1514     data->flags &= ~SF_BEFORE_EOL;
1515     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1516 }
1517
1518 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1519  * list that describes which code points it matches */
1520
1521 STATIC void
1522 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1523 {
1524     /* Set the SSC 'ssc' to match an empty string or any code point */
1525
1526     PERL_ARGS_ASSERT_SSC_ANYTHING;
1527
1528     assert(is_ANYOF_SYNTHETIC(ssc));
1529
1530     /* mortalize so won't leak */
1531     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1532     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1533 }
1534
1535 STATIC int
1536 S_ssc_is_anything(const regnode_ssc *ssc)
1537 {
1538     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1539      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1540      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1541      * in any way, so there's no point in using it */
1542
1543     UV start, end;
1544     bool ret;
1545
1546     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1547
1548     assert(is_ANYOF_SYNTHETIC(ssc));
1549
1550     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1551         return FALSE;
1552     }
1553
1554     /* See if the list consists solely of the range 0 - Infinity */
1555     invlist_iterinit(ssc->invlist);
1556     ret = invlist_iternext(ssc->invlist, &start, &end)
1557           && start == 0
1558           && end == UV_MAX;
1559
1560     invlist_iterfinish(ssc->invlist);
1561
1562     if (ret) {
1563         return TRUE;
1564     }
1565
1566     /* If e.g., both \w and \W are set, matches everything */
1567     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1568         int i;
1569         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1570             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1571                 return TRUE;
1572             }
1573         }
1574     }
1575
1576     return FALSE;
1577 }
1578
1579 STATIC void
1580 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1581 {
1582     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1583      * string, any code point, or any posix class under locale */
1584
1585     PERL_ARGS_ASSERT_SSC_INIT;
1586
1587     Zero(ssc, 1, regnode_ssc);
1588     set_ANYOF_SYNTHETIC(ssc);
1589     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1590     ssc_anything(ssc);
1591
1592     /* If any portion of the regex is to operate under locale rules that aren't
1593      * fully known at compile time, initialization includes it.  The reason
1594      * this isn't done for all regexes is that the optimizer was written under
1595      * the assumption that locale was all-or-nothing.  Given the complexity and
1596      * lack of documentation in the optimizer, and that there are inadequate
1597      * test cases for locale, many parts of it may not work properly, it is
1598      * safest to avoid locale unless necessary. */
1599     if (RExC_contains_locale) {
1600         ANYOF_POSIXL_SETALL(ssc);
1601     }
1602     else {
1603         ANYOF_POSIXL_ZERO(ssc);
1604     }
1605 }
1606
1607 STATIC int
1608 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1609                         const regnode_ssc *ssc)
1610 {
1611     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1612      * to the list of code points matched, and locale posix classes; hence does
1613      * not check its flags) */
1614
1615     UV start, end;
1616     bool ret;
1617
1618     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1619
1620     assert(is_ANYOF_SYNTHETIC(ssc));
1621
1622     invlist_iterinit(ssc->invlist);
1623     ret = invlist_iternext(ssc->invlist, &start, &end)
1624           && start == 0
1625           && end == UV_MAX;
1626
1627     invlist_iterfinish(ssc->invlist);
1628
1629     if (! ret) {
1630         return FALSE;
1631     }
1632
1633     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1634         return FALSE;
1635     }
1636
1637     return TRUE;
1638 }
1639
1640 #define INVLIST_INDEX 0
1641 #define ONLY_LOCALE_MATCHES_INDEX 1
1642 #define DEFERRED_USER_DEFINED_INDEX 2
1643
1644 STATIC SV*
1645 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1646                                const regnode_charclass* const node)
1647 {
1648     /* Returns a mortal inversion list defining which code points are matched
1649      * by 'node', which is of type ANYOF.  Handles complementing the result if
1650      * appropriate.  If some code points aren't knowable at this time, the
1651      * returned list must, and will, contain every code point that is a
1652      * possibility. */
1653
1654     SV* invlist = NULL;
1655     SV* only_utf8_locale_invlist = NULL;
1656     unsigned int i;
1657     const U32 n = ARG(node);
1658     bool new_node_has_latin1 = FALSE;
1659     const U8 flags = (inRANGE(OP(node), ANYOFH, ANYOFRb))
1660                       ? 0
1661                       : ANYOF_FLAGS(node);
1662
1663     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1664
1665     /* Look at the data structure created by S_set_ANYOF_arg() */
1666     if (n != ANYOF_ONLY_HAS_BITMAP) {
1667         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1668         AV * const av = MUTABLE_AV(SvRV(rv));
1669         SV **const ary = AvARRAY(av);
1670         assert(RExC_rxi->data->what[n] == 's');
1671
1672         if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
1673
1674             /* Here there are things that won't be known until runtime -- we
1675              * have to assume it could be anything */
1676             invlist = sv_2mortal(_new_invlist(1));
1677             return _add_range_to_invlist(invlist, 0, UV_MAX);
1678         }
1679         else if (ary[INVLIST_INDEX]) {
1680
1681             /* Use the node's inversion list */
1682             invlist = sv_2mortal(invlist_clone(ary[INVLIST_INDEX], NULL));
1683         }
1684
1685         /* Get the code points valid only under UTF-8 locales */
1686         if (   (flags & ANYOFL_FOLD)
1687             &&  av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX)
1688         {
1689             only_utf8_locale_invlist = ary[ONLY_LOCALE_MATCHES_INDEX];
1690         }
1691     }
1692
1693     if (! invlist) {
1694         invlist = sv_2mortal(_new_invlist(0));
1695     }
1696
1697     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1698      * code points, and an inversion list for the others, but if there are code
1699      * points that should match only conditionally on the target string being
1700      * UTF-8, those are placed in the inversion list, and not the bitmap.
1701      * Since there are circumstances under which they could match, they are
1702      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1703      * to exclude them here, so that when we invert below, the end result
1704      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1705      * have to do this here before we add the unconditionally matched code
1706      * points */
1707     if (flags & ANYOF_INVERT) {
1708         _invlist_intersection_complement_2nd(invlist,
1709                                              PL_UpperLatin1,
1710                                              &invlist);
1711     }
1712
1713     /* Add in the points from the bit map */
1714     if (! inRANGE(OP(node), ANYOFH, ANYOFRb)) {
1715         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1716             if (ANYOF_BITMAP_TEST(node, i)) {
1717                 unsigned int start = i++;
1718
1719                 for (;    i < NUM_ANYOF_CODE_POINTS
1720                        && ANYOF_BITMAP_TEST(node, i); ++i)
1721                 {
1722                     /* empty */
1723                 }
1724                 invlist = _add_range_to_invlist(invlist, start, i-1);
1725                 new_node_has_latin1 = TRUE;
1726             }
1727         }
1728     }
1729
1730     /* If this can match all upper Latin1 code points, have to add them
1731      * as well.  But don't add them if inverting, as when that gets done below,
1732      * it would exclude all these characters, including the ones it shouldn't
1733      * that were added just above */
1734     if (! (flags & ANYOF_INVERT) && OP(node) == ANYOFD
1735         && (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1736     {
1737         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1738     }
1739
1740     /* Similarly for these */
1741     if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1742         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1743     }
1744
1745     if (flags & ANYOF_INVERT) {
1746         _invlist_invert(invlist);
1747     }
1748     else if (flags & ANYOFL_FOLD) {
1749         if (new_node_has_latin1) {
1750
1751             /* Under /li, any 0-255 could fold to any other 0-255, depending on
1752              * the locale.  We can skip this if there are no 0-255 at all. */
1753             _invlist_union(invlist, PL_Latin1, &invlist);
1754
1755             invlist = add_cp_to_invlist(invlist, LATIN_SMALL_LETTER_DOTLESS_I);
1756             invlist = add_cp_to_invlist(invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
1757         }
1758         else {
1759             if (_invlist_contains_cp(invlist, LATIN_SMALL_LETTER_DOTLESS_I)) {
1760                 invlist = add_cp_to_invlist(invlist, 'I');
1761             }
1762             if (_invlist_contains_cp(invlist,
1763                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE))
1764             {
1765                 invlist = add_cp_to_invlist(invlist, 'i');
1766             }
1767         }
1768     }
1769
1770     /* Similarly add the UTF-8 locale possible matches.  These have to be
1771      * deferred until after the non-UTF-8 locale ones are taken care of just
1772      * above, or it leads to wrong results under ANYOF_INVERT */
1773     if (only_utf8_locale_invlist) {
1774         _invlist_union_maybe_complement_2nd(invlist,
1775                                             only_utf8_locale_invlist,
1776                                             flags & ANYOF_INVERT,
1777                                             &invlist);
1778     }
1779
1780     return invlist;
1781 }
1782
1783 /* These two functions currently do the exact same thing */
1784 #define ssc_init_zero           ssc_init
1785
1786 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1787 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1788
1789 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1790  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1791  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1792
1793 STATIC void
1794 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1795                 const regnode_charclass *and_with)
1796 {
1797     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1798      * another SSC or a regular ANYOF class.  Can create false positives. */
1799
1800     SV* anded_cp_list;
1801     U8  and_with_flags = inRANGE(OP(and_with), ANYOFH, ANYOFRb)
1802                           ? 0
1803                           : ANYOF_FLAGS(and_with);
1804     U8  anded_flags;
1805
1806     PERL_ARGS_ASSERT_SSC_AND;
1807
1808     assert(is_ANYOF_SYNTHETIC(ssc));
1809
1810     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1811      * the code point inversion list and just the relevant flags */
1812     if (is_ANYOF_SYNTHETIC(and_with)) {
1813         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1814         anded_flags = and_with_flags;
1815
1816         /* XXX This is a kludge around what appears to be deficiencies in the
1817          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1818          * there are paths through the optimizer where it doesn't get weeded
1819          * out when it should.  And if we don't make some extra provision for
1820          * it like the code just below, it doesn't get added when it should.
1821          * This solution is to add it only when AND'ing, which is here, and
1822          * only when what is being AND'ed is the pristine, original node
1823          * matching anything.  Thus it is like adding it to ssc_anything() but
1824          * only when the result is to be AND'ed.  Probably the same solution
1825          * could be adopted for the same problem we have with /l matching,
1826          * which is solved differently in S_ssc_init(), and that would lead to
1827          * fewer false positives than that solution has.  But if this solution
1828          * creates bugs, the consequences are only that a warning isn't raised
1829          * that should be; while the consequences for having /l bugs is
1830          * incorrect matches */
1831         if (ssc_is_anything((regnode_ssc *)and_with)) {
1832             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1833         }
1834     }
1835     else {
1836         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1837         if (OP(and_with) == ANYOFD) {
1838             anded_flags = and_with_flags & ANYOF_COMMON_FLAGS;
1839         }
1840         else {
1841             anded_flags = and_with_flags
1842             &( ANYOF_COMMON_FLAGS
1843               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1844               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1845             if (ANYOFL_UTF8_LOCALE_REQD(and_with_flags)) {
1846                 anded_flags &=
1847                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1848             }
1849         }
1850     }
1851
1852     ANYOF_FLAGS(ssc) &= anded_flags;
1853
1854     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1855      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1856      * 'and_with' may be inverted.  When not inverted, we have the situation of
1857      * computing:
1858      *  (C1 | P1) & (C2 | P2)
1859      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1860      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1861      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1862      *                    <=  ((C1 & C2) | P1 | P2)
1863      * Alternatively, the last few steps could be:
1864      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1865      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1866      *                    <=  (C1 | C2 | (P1 & P2))
1867      * We favor the second approach if either P1 or P2 is non-empty.  This is
1868      * because these components are a barrier to doing optimizations, as what
1869      * they match cannot be known until the moment of matching as they are
1870      * dependent on the current locale, 'AND"ing them likely will reduce or
1871      * eliminate them.
1872      * But we can do better if we know that C1,P1 are in their initial state (a
1873      * frequent occurrence), each matching everything:
1874      *  (<everything>) & (C2 | P2) =  C2 | P2
1875      * Similarly, if C2,P2 are in their initial state (again a frequent
1876      * occurrence), the result is a no-op
1877      *  (C1 | P1) & (<everything>) =  C1 | P1
1878      *
1879      * Inverted, we have
1880      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1881      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1882      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1883      * */
1884
1885     if ((and_with_flags & ANYOF_INVERT)
1886         && ! is_ANYOF_SYNTHETIC(and_with))
1887     {
1888         unsigned int i;
1889
1890         ssc_intersection(ssc,
1891                          anded_cp_list,
1892                          FALSE /* Has already been inverted */
1893                          );
1894
1895         /* If either P1 or P2 is empty, the intersection will be also; can skip
1896          * the loop */
1897         if (! (and_with_flags & ANYOF_MATCHES_POSIXL)) {
1898             ANYOF_POSIXL_ZERO(ssc);
1899         }
1900         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1901
1902             /* Note that the Posix class component P from 'and_with' actually
1903              * looks like:
1904              *      P = Pa | Pb | ... | Pn
1905              * where each component is one posix class, such as in [\w\s].
1906              * Thus
1907              *      ~P = ~(Pa | Pb | ... | Pn)
1908              *         = ~Pa & ~Pb & ... & ~Pn
1909              *        <= ~Pa | ~Pb | ... | ~Pn
1910              * The last is something we can easily calculate, but unfortunately
1911              * is likely to have many false positives.  We could do better
1912              * in some (but certainly not all) instances if two classes in
1913              * P have known relationships.  For example
1914              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1915              * So
1916              *      :lower: & :print: = :lower:
1917              * And similarly for classes that must be disjoint.  For example,
1918              * since \s and \w can have no elements in common based on rules in
1919              * the POSIX standard,
1920              *      \w & ^\S = nothing
1921              * Unfortunately, some vendor locales do not meet the Posix
1922              * standard, in particular almost everything by Microsoft.
1923              * The loop below just changes e.g., \w into \W and vice versa */
1924
1925             regnode_charclass_posixl temp;
1926             int add = 1;    /* To calculate the index of the complement */
1927
1928             Zero(&temp, 1, regnode_charclass_posixl);
1929             ANYOF_POSIXL_ZERO(&temp);
1930             for (i = 0; i < ANYOF_MAX; i++) {
1931                 assert(i % 2 != 0
1932                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1933                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1934
1935                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1936                     ANYOF_POSIXL_SET(&temp, i + add);
1937                 }
1938                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1939             }
1940             ANYOF_POSIXL_AND(&temp, ssc);
1941
1942         } /* else ssc already has no posixes */
1943     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1944          in its initial state */
1945     else if (! is_ANYOF_SYNTHETIC(and_with)
1946              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1947     {
1948         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1949          * copy it over 'ssc' */
1950         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1951             if (is_ANYOF_SYNTHETIC(and_with)) {
1952                 StructCopy(and_with, ssc, regnode_ssc);
1953             }
1954             else {
1955                 ssc->invlist = anded_cp_list;
1956                 ANYOF_POSIXL_ZERO(ssc);
1957                 if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1958                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1959                 }
1960             }
1961         }
1962         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1963                  || (and_with_flags & ANYOF_MATCHES_POSIXL))
1964         {
1965             /* One or the other of P1, P2 is non-empty. */
1966             if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1967                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1968             }
1969             ssc_union(ssc, anded_cp_list, FALSE);
1970         }
1971         else { /* P1 = P2 = empty */
1972             ssc_intersection(ssc, anded_cp_list, FALSE);
1973         }
1974     }
1975 }
1976
1977 STATIC void
1978 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1979                const regnode_charclass *or_with)
1980 {
1981     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1982      * another SSC or a regular ANYOF class.  Can create false positives if
1983      * 'or_with' is to be inverted. */
1984
1985     SV* ored_cp_list;
1986     U8 ored_flags;
1987     U8  or_with_flags = inRANGE(OP(or_with), ANYOFH, ANYOFRb)
1988                          ? 0
1989                          : ANYOF_FLAGS(or_with);
1990
1991     PERL_ARGS_ASSERT_SSC_OR;
1992
1993     assert(is_ANYOF_SYNTHETIC(ssc));
1994
1995     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1996      * the code point inversion list and just the relevant flags */
1997     if (is_ANYOF_SYNTHETIC(or_with)) {
1998         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1999         ored_flags = or_with_flags;
2000     }
2001     else {
2002         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
2003         ored_flags = or_with_flags & ANYOF_COMMON_FLAGS;
2004         if (OP(or_with) != ANYOFD) {
2005             ored_flags
2006             |= or_with_flags
2007              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
2008                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
2009             if (ANYOFL_UTF8_LOCALE_REQD(or_with_flags)) {
2010                 ored_flags |=
2011                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
2012             }
2013         }
2014     }
2015
2016     ANYOF_FLAGS(ssc) |= ored_flags;
2017
2018     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
2019      * C2 is the list of code points in 'or-with'; P2, its posix classes.
2020      * 'or_with' may be inverted.  When not inverted, we have the simple
2021      * situation of computing:
2022      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
2023      * If P1|P2 yields a situation with both a class and its complement are
2024      * set, like having both \w and \W, this matches all code points, and we
2025      * can delete these from the P component of the ssc going forward.  XXX We
2026      * might be able to delete all the P components, but I (khw) am not certain
2027      * about this, and it is better to be safe.
2028      *
2029      * Inverted, we have
2030      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
2031      *                         <=  (C1 | P1) | ~C2
2032      *                         <=  (C1 | ~C2) | P1
2033      * (which results in actually simpler code than the non-inverted case)
2034      * */
2035
2036     if ((or_with_flags & ANYOF_INVERT)
2037         && ! is_ANYOF_SYNTHETIC(or_with))
2038     {
2039         /* We ignore P2, leaving P1 going forward */
2040     }   /* else  Not inverted */
2041     else if (or_with_flags & ANYOF_MATCHES_POSIXL) {
2042         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
2043         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
2044             unsigned int i;
2045             for (i = 0; i < ANYOF_MAX; i += 2) {
2046                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
2047                 {
2048                     ssc_match_all_cp(ssc);
2049                     ANYOF_POSIXL_CLEAR(ssc, i);
2050                     ANYOF_POSIXL_CLEAR(ssc, i+1);
2051                 }
2052             }
2053         }
2054     }
2055
2056     ssc_union(ssc,
2057               ored_cp_list,
2058               FALSE /* Already has been inverted */
2059               );
2060 }
2061
2062 STATIC void
2063 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
2064 {
2065     PERL_ARGS_ASSERT_SSC_UNION;
2066
2067     assert(is_ANYOF_SYNTHETIC(ssc));
2068
2069     _invlist_union_maybe_complement_2nd(ssc->invlist,
2070                                         invlist,
2071                                         invert2nd,
2072                                         &ssc->invlist);
2073 }
2074
2075 STATIC void
2076 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
2077                          SV* const invlist,
2078                          const bool invert2nd)
2079 {
2080     PERL_ARGS_ASSERT_SSC_INTERSECTION;
2081
2082     assert(is_ANYOF_SYNTHETIC(ssc));
2083
2084     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
2085                                                invlist,
2086                                                invert2nd,
2087                                                &ssc->invlist);
2088 }
2089
2090 STATIC void
2091 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
2092 {
2093     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
2094
2095     assert(is_ANYOF_SYNTHETIC(ssc));
2096
2097     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
2098 }
2099
2100 STATIC void
2101 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
2102 {
2103     /* AND just the single code point 'cp' into the SSC 'ssc' */
2104
2105     SV* cp_list = _new_invlist(2);
2106
2107     PERL_ARGS_ASSERT_SSC_CP_AND;
2108
2109     assert(is_ANYOF_SYNTHETIC(ssc));
2110
2111     cp_list = add_cp_to_invlist(cp_list, cp);
2112     ssc_intersection(ssc, cp_list,
2113                      FALSE /* Not inverted */
2114                      );
2115     SvREFCNT_dec_NN(cp_list);
2116 }
2117
2118 STATIC void
2119 S_ssc_clear_locale(regnode_ssc *ssc)
2120 {
2121     /* Set the SSC 'ssc' to not match any locale things */
2122     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
2123
2124     assert(is_ANYOF_SYNTHETIC(ssc));
2125
2126     ANYOF_POSIXL_ZERO(ssc);
2127     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
2128 }
2129
2130 STATIC bool
2131 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
2132 {
2133     /* The synthetic start class is used to hopefully quickly winnow down
2134      * places where a pattern could start a match in the target string.  If it
2135      * doesn't really narrow things down that much, there isn't much point to
2136      * having the overhead of using it.  This function uses some very crude
2137      * heuristics to decide if to use the ssc or not.
2138      *
2139      * It returns TRUE if 'ssc' rules out more than half what it considers to
2140      * be the "likely" possible matches, but of course it doesn't know what the
2141      * actual things being matched are going to be; these are only guesses
2142      *
2143      * For /l matches, it assumes that the only likely matches are going to be
2144      *      in the 0-255 range, uniformly distributed, so half of that is 127
2145      * For /a and /d matches, it assumes that the likely matches will be just
2146      *      the ASCII range, so half of that is 63
2147      * For /u and there isn't anything matching above the Latin1 range, it
2148      *      assumes that that is the only range likely to be matched, and uses
2149      *      half that as the cut-off: 127.  If anything matches above Latin1,
2150      *      it assumes that all of Unicode could match (uniformly), except for
2151      *      non-Unicode code points and things in the General Category "Other"
2152      *      (unassigned, private use, surrogates, controls and formats).  This
2153      *      is a much large number. */
2154
2155     U32 count = 0;      /* Running total of number of code points matched by
2156                            'ssc' */
2157     UV start, end;      /* Start and end points of current range in inversion
2158                            XXX outdated.  UTF-8 locales are common, what about invert? list */
2159     const U32 max_code_points = (LOC)
2160                                 ?  256
2161                                 : ((  ! UNI_SEMANTICS
2162                                     ||  invlist_highest(ssc->invlist) < 256)
2163                                   ? 128
2164                                   : NON_OTHER_COUNT);
2165     const U32 max_match = max_code_points / 2;
2166
2167     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
2168
2169     invlist_iterinit(ssc->invlist);
2170     while (invlist_iternext(ssc->invlist, &start, &end)) {
2171         if (start >= max_code_points) {
2172             break;
2173         }
2174         end = MIN(end, max_code_points - 1);
2175         count += end - start + 1;
2176         if (count >= max_match) {
2177             invlist_iterfinish(ssc->invlist);
2178             return FALSE;
2179         }
2180     }
2181
2182     return TRUE;
2183 }
2184
2185
2186 STATIC void
2187 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
2188 {
2189     /* The inversion list in the SSC is marked mortal; now we need a more
2190      * permanent copy, which is stored the same way that is done in a regular
2191      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
2192      * map */
2193
2194     SV* invlist = invlist_clone(ssc->invlist, NULL);
2195
2196     PERL_ARGS_ASSERT_SSC_FINALIZE;
2197
2198     assert(is_ANYOF_SYNTHETIC(ssc));
2199
2200     /* The code in this file assumes that all but these flags aren't relevant
2201      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
2202      * by the time we reach here */
2203     assert(! (ANYOF_FLAGS(ssc)
2204         & ~( ANYOF_COMMON_FLAGS
2205             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
2206             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
2207
2208     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
2209
2210     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist, NULL, NULL);
2211     SvREFCNT_dec(invlist);
2212
2213     /* Make sure is clone-safe */
2214     ssc->invlist = NULL;
2215
2216     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
2217         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
2218         OP(ssc) = ANYOFPOSIXL;
2219     }
2220     else if (RExC_contains_locale) {
2221         OP(ssc) = ANYOFL;
2222     }
2223
2224     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
2225 }
2226
2227 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
2228 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
2229 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
2230 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
2231                                ? (TRIE_LIST_CUR( idx ) - 1)           \
2232                                : 0 )
2233
2234
2235 #ifdef DEBUGGING
2236 /*
2237    dump_trie(trie,widecharmap,revcharmap)
2238    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
2239    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
2240
2241    These routines dump out a trie in a somewhat readable format.
2242    The _interim_ variants are used for debugging the interim
2243    tables that are used to generate the final compressed
2244    representation which is what dump_trie expects.
2245
2246    Part of the reason for their existence is to provide a form
2247    of documentation as to how the different representations function.
2248
2249 */
2250
2251 /*
2252   Dumps the final compressed table form of the trie to Perl_debug_log.
2253   Used for debugging make_trie().
2254 */
2255
2256 STATIC void
2257 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
2258             AV *revcharmap, U32 depth)
2259 {
2260     U32 state;
2261     SV *sv=sv_newmortal();
2262     int colwidth= widecharmap ? 6 : 4;
2263     U16 word;
2264     DECLARE_AND_GET_RE_DEBUG_FLAGS;
2265
2266     PERL_ARGS_ASSERT_DUMP_TRIE;
2267
2268     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
2269         depth+1, "Match","Base","Ofs" );
2270
2271     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2272         SV ** const tmp = av_fetch( revcharmap, state, 0);
2273         if ( tmp ) {
2274             Perl_re_printf( aTHX_  "%*s",
2275                 colwidth,
2276                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2277                             PL_colors[0], PL_colors[1],
2278                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2279                             PERL_PV_ESCAPE_FIRSTCHAR
2280                 )
2281             );
2282         }
2283     }
2284     Perl_re_printf( aTHX_  "\n");
2285     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2286
2287     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2288         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2289     Perl_re_printf( aTHX_  "\n");
2290
2291     for( state = 1 ; state < trie->statecount ; state++ ) {
2292         const U32 base = trie->states[ state ].trans.base;
2293
2294         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2295
2296         if ( trie->states[ state ].wordnum ) {
2297             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2298         } else {
2299             Perl_re_printf( aTHX_  "%6s", "" );
2300         }
2301
2302         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2303
2304         if ( base ) {
2305             U32 ofs = 0;
2306
2307             while( ( base + ofs  < trie->uniquecharcount ) ||
2308                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2309                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2310                                                                     != state))
2311                     ofs++;
2312
2313             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2314
2315             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2316                 if ( ( base + ofs >= trie->uniquecharcount )
2317                         && ( base + ofs - trie->uniquecharcount
2318                                                         < trie->lasttrans )
2319                         && trie->trans[ base + ofs
2320                                     - trie->uniquecharcount ].check == state )
2321                 {
2322                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2323                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2324                    );
2325                 } else {
2326                     Perl_re_printf( aTHX_  "%*s", colwidth,"   ." );
2327                 }
2328             }
2329
2330             Perl_re_printf( aTHX_  "]");
2331
2332         }
2333         Perl_re_printf( aTHX_  "\n" );
2334     }
2335     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2336                                 depth);
2337     for (word=1; word <= trie->wordcount; word++) {
2338         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2339             (int)word, (int)(trie->wordinfo[word].prev),
2340             (int)(trie->wordinfo[word].len));
2341     }
2342     Perl_re_printf( aTHX_  "\n" );
2343 }
2344 /*
2345   Dumps a fully constructed but uncompressed trie in list form.
2346   List tries normally only are used for construction when the number of
2347   possible chars (trie->uniquecharcount) is very high.
2348   Used for debugging make_trie().
2349 */
2350 STATIC void
2351 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2352                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2353                          U32 depth)
2354 {
2355     U32 state;
2356     SV *sv=sv_newmortal();
2357     int colwidth= widecharmap ? 6 : 4;
2358     DECLARE_AND_GET_RE_DEBUG_FLAGS;
2359
2360     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2361
2362     /* print out the table precompression.  */
2363     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2364             depth+1 );
2365     Perl_re_indentf( aTHX_  "%s",
2366             depth+1, "------:-----+-----------------\n" );
2367
2368     for( state=1 ; state < next_alloc ; state ++ ) {
2369         U16 charid;
2370
2371         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2372             depth+1, (UV)state  );
2373         if ( ! trie->states[ state ].wordnum ) {
2374             Perl_re_printf( aTHX_  "%5s| ","");
2375         } else {
2376             Perl_re_printf( aTHX_  "W%4x| ",
2377                 trie->states[ state ].wordnum
2378             );
2379         }
2380         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2381             SV ** const tmp = av_fetch( revcharmap,
2382                                         TRIE_LIST_ITEM(state, charid).forid, 0);
2383             if ( tmp ) {
2384                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2385                     colwidth,
2386                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2387                               colwidth,
2388                               PL_colors[0], PL_colors[1],
2389                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2390                               | PERL_PV_ESCAPE_FIRSTCHAR
2391                     ) ,
2392                     TRIE_LIST_ITEM(state, charid).forid,
2393                     (UV)TRIE_LIST_ITEM(state, charid).newstate
2394                 );
2395                 if (!(charid % 10))
2396                     Perl_re_printf( aTHX_  "\n%*s| ",
2397                         (int)((depth * 2) + 14), "");
2398             }
2399         }
2400         Perl_re_printf( aTHX_  "\n");
2401     }
2402 }
2403
2404 /*
2405   Dumps a fully constructed but uncompressed trie in table form.
2406   This is the normal DFA style state transition table, with a few
2407   twists to facilitate compression later.
2408   Used for debugging make_trie().
2409 */
2410 STATIC void
2411 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2412                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2413                           U32 depth)
2414 {
2415     U32 state;
2416     U16 charid;
2417     SV *sv=sv_newmortal();
2418     int colwidth= widecharmap ? 6 : 4;
2419     DECLARE_AND_GET_RE_DEBUG_FLAGS;
2420
2421     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2422
2423     /*
2424        print out the table precompression so that we can do a visual check
2425        that they are identical.
2426      */
2427
2428     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2429
2430     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2431         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2432         if ( tmp ) {
2433             Perl_re_printf( aTHX_  "%*s",
2434                 colwidth,
2435                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2436                             PL_colors[0], PL_colors[1],
2437                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2438                             PERL_PV_ESCAPE_FIRSTCHAR
2439                 )
2440             );
2441         }
2442     }
2443
2444     Perl_re_printf( aTHX_ "\n");
2445     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2446
2447     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2448         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2449     }
2450
2451     Perl_re_printf( aTHX_  "\n" );
2452
2453     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2454
2455         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2456             depth+1,
2457             (UV)TRIE_NODENUM( state ) );
2458
2459         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2460             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2461             if (v)
2462                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2463             else
2464                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2465         }
2466         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2467             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2468                                             (UV)trie->trans[ state ].check );
2469         } else {
2470             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2471                                             (UV)trie->trans[ state ].check,
2472             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2473         }
2474     }
2475 }
2476
2477 #endif
2478
2479
2480 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2481   startbranch: the first branch in the whole branch sequence
2482   first      : start branch of sequence of branch-exact nodes.
2483                May be the same as startbranch
2484   last       : Thing following the last branch.
2485                May be the same as tail.
2486   tail       : item following the branch sequence
2487   count      : words in the sequence
2488   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2489   depth      : indent depth
2490
2491 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2492
2493 A trie is an N'ary tree where the branches are determined by digital
2494 decomposition of the key. IE, at the root node you look up the 1st character and
2495 follow that branch repeat until you find the end of the branches. Nodes can be
2496 marked as "accepting" meaning they represent a complete word. Eg:
2497
2498   /he|she|his|hers/
2499
2500 would convert into the following structure. Numbers represent states, letters
2501 following numbers represent valid transitions on the letter from that state, if
2502 the number is in square brackets it represents an accepting state, otherwise it
2503 will be in parenthesis.
2504
2505       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2506       |    |
2507       |   (2)
2508       |    |
2509      (1)   +-i->(6)-+-s->[7]
2510       |
2511       +-s->(3)-+-h->(4)-+-e->[5]
2512
2513       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2514
2515 This shows that when matching against the string 'hers' we will begin at state 1
2516 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2517 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2518 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2519 single traverse. We store a mapping from accepting to state to which word was
2520 matched, and then when we have multiple possibilities we try to complete the
2521 rest of the regex in the order in which they occurred in the alternation.
2522
2523 The only prior NFA like behaviour that would be changed by the TRIE support is
2524 the silent ignoring of duplicate alternations which are of the form:
2525
2526  / (DUPE|DUPE) X? (?{ ... }) Y /x
2527
2528 Thus EVAL blocks following a trie may be called a different number of times with
2529 and without the optimisation. With the optimisations dupes will be silently
2530 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2531 the following demonstrates:
2532
2533  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2534
2535 which prints out 'word' three times, but
2536
2537  'words'=~/(word|word|word)(?{ print $1 })S/
2538
2539 which doesnt print it out at all. This is due to other optimisations kicking in.
2540
2541 Example of what happens on a structural level:
2542
2543 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2544
2545    1: CURLYM[1] {1,32767}(18)
2546    5:   BRANCH(8)
2547    6:     EXACT <ac>(16)
2548    8:   BRANCH(11)
2549    9:     EXACT <ad>(16)
2550   11:   BRANCH(14)
2551   12:     EXACT <ab>(16)
2552   16:   SUCCEED(0)
2553   17:   NOTHING(18)
2554   18: END(0)
2555
2556 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2557 and should turn into:
2558
2559    1: CURLYM[1] {1,32767}(18)
2560    5:   TRIE(16)
2561         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2562           <ac>
2563           <ad>
2564           <ab>
2565   16:   SUCCEED(0)
2566   17:   NOTHING(18)
2567   18: END(0)
2568
2569 Cases where tail != last would be like /(?foo|bar)baz/:
2570
2571    1: BRANCH(4)
2572    2:   EXACT <foo>(8)
2573    4: BRANCH(7)
2574    5:   EXACT <bar>(8)
2575    7: TAIL(8)
2576    8: EXACT <baz>(10)
2577   10: END(0)
2578
2579 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2580 and would end up looking like:
2581
2582     1: TRIE(8)
2583       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2584         <foo>
2585         <bar>
2586    7: TAIL(8)
2587    8: EXACT <baz>(10)
2588   10: END(0)
2589
2590     d = uvchr_to_utf8_flags(d, uv, 0);
2591
2592 is the recommended Unicode-aware way of saying
2593
2594     *(d++) = uv;
2595 */
2596
2597 #define TRIE_STORE_REVCHAR(val)                                            \
2598     STMT_START {                                                           \
2599         if (UTF) {                                                         \
2600             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2601             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2602             unsigned char *const kapow = uvchr_to_utf8(flrbbbbb, val);     \
2603             *kapow = '\0';                                                 \
2604             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2605             SvPOK_on(zlopp);                                               \
2606             SvUTF8_on(zlopp);                                              \
2607             av_push(revcharmap, zlopp);                                    \
2608         } else {                                                           \
2609             char ooooff = (char)val;                                           \
2610             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2611         }                                                                  \
2612         } STMT_END
2613
2614 /* This gets the next character from the input, folding it if not already
2615  * folded. */
2616 #define TRIE_READ_CHAR STMT_START {                                           \
2617     wordlen++;                                                                \
2618     if ( UTF ) {                                                              \
2619         /* if it is UTF then it is either already folded, or does not need    \
2620          * folding */                                                         \
2621         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2622     }                                                                         \
2623     else if (folder == PL_fold_latin1) {                                      \
2624         /* This folder implies Unicode rules, which in the range expressible  \
2625          *  by not UTF is the lower case, with the two exceptions, one of     \
2626          *  which should have been taken care of before calling this */       \
2627         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2628         uvc = toLOWER_L1(*uc);                                                \
2629         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2630         len = 1;                                                              \
2631     } else {                                                                  \
2632         /* raw data, will be folded later if needed */                        \
2633         uvc = (U32)*uc;                                                       \
2634         len = 1;                                                              \
2635     }                                                                         \
2636 } STMT_END
2637
2638
2639
2640 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2641     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2642         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2643         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2644         TRIE_LIST_LEN( state ) = ging;                          \
2645     }                                                           \
2646     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2647     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2648     TRIE_LIST_CUR( state )++;                                   \
2649 } STMT_END
2650
2651 #define TRIE_LIST_NEW(state) STMT_START {                       \
2652     Newx( trie->states[ state ].trans.list,                     \
2653         4, reg_trie_trans_le );                                 \
2654      TRIE_LIST_CUR( state ) = 1;                                \
2655      TRIE_LIST_LEN( state ) = 4;                                \
2656 } STMT_END
2657
2658 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2659     U16 dupe= trie->states[ state ].wordnum;                    \
2660     regnode * const noper_next = regnext( noper );              \
2661                                                                 \
2662     DEBUG_r({                                                   \
2663         /* store the word for dumping */                        \
2664         SV* tmp;                                                \
2665         if (OP(noper) != NOTHING)                               \
2666             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2667         else                                                    \
2668             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2669         av_push( trie_words, tmp );                             \
2670     });                                                         \
2671                                                                 \
2672     curword++;                                                  \
2673     trie->wordinfo[curword].prev   = 0;                         \
2674     trie->wordinfo[curword].len    = wordlen;                   \
2675     trie->wordinfo[curword].accept = state;                     \
2676                                                                 \
2677     if ( noper_next < tail ) {                                  \
2678         if (!trie->jump)                                        \
2679             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2680                                                  sizeof(U16) ); \
2681         trie->jump[curword] = (U16)(noper_next - convert);      \
2682         if (!jumper)                                            \
2683             jumper = noper_next;                                \
2684         if (!nextbranch)                                        \
2685             nextbranch= regnext(cur);                           \
2686     }                                                           \
2687                                                                 \
2688     if ( dupe ) {                                               \
2689         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2690         /* chain, so that when the bits of chain are later    */\
2691         /* linked together, the dups appear in the chain      */\
2692         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2693         trie->wordinfo[dupe].prev = curword;                    \
2694     } else {                                                    \
2695         /* we haven't inserted this word yet.                */ \
2696         trie->states[ state ].wordnum = curword;                \
2697     }                                                           \
2698 } STMT_END
2699
2700
2701 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2702      ( ( base + charid >=  ucharcount                                   \
2703          && base + charid < ubound                                      \
2704          && state == trie->trans[ base - ucharcount + charid ].check    \
2705          && trie->trans[ base - ucharcount + charid ].next )            \
2706            ? trie->trans[ base - ucharcount + charid ].next             \
2707            : ( state==1 ? special : 0 )                                 \
2708       )
2709
2710 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2711 STMT_START {                                                \
2712     TRIE_BITMAP_SET(trie, uvc);                             \
2713     /* store the folded codepoint */                        \
2714     if ( folder )                                           \
2715         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2716                                                             \
2717     if ( !UTF ) {                                           \
2718         /* store first byte of utf8 representation of */    \
2719         /* variant codepoints */                            \
2720         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2721             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2722         }                                                   \
2723     }                                                       \
2724 } STMT_END
2725 #define MADE_TRIE       1
2726 #define MADE_JUMP_TRIE  2
2727 #define MADE_EXACT_TRIE 4
2728
2729 STATIC I32
2730 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2731                   regnode *first, regnode *last, regnode *tail,
2732                   U32 word_count, U32 flags, U32 depth)
2733 {
2734     /* first pass, loop through and scan words */
2735     reg_trie_data *trie;
2736     HV *widecharmap = NULL;
2737     AV *revcharmap = newAV();
2738     regnode *cur;
2739     STRLEN len = 0;
2740     UV uvc = 0;
2741     U16 curword = 0;
2742     U32 next_alloc = 0;
2743     regnode *jumper = NULL;
2744     regnode *nextbranch = NULL;
2745     regnode *convert = NULL;
2746     U32 *prev_states; /* temp array mapping each state to previous one */
2747     /* we just use folder as a flag in utf8 */
2748     const U8 * folder = NULL;
2749
2750     /* in the below add_data call we are storing either 'tu' or 'tuaa'
2751      * which stands for one trie structure, one hash, optionally followed
2752      * by two arrays */
2753 #ifdef DEBUGGING
2754     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuaa"));
2755     AV *trie_words = NULL;
2756     /* along with revcharmap, this only used during construction but both are
2757      * useful during debugging so we store them in the struct when debugging.
2758      */
2759 #else
2760     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2761     STRLEN trie_charcount=0;
2762 #endif
2763     SV *re_trie_maxbuff;
2764     DECLARE_AND_GET_RE_DEBUG_FLAGS;
2765
2766     PERL_ARGS_ASSERT_MAKE_TRIE;
2767 #ifndef DEBUGGING
2768     PERL_UNUSED_ARG(depth);
2769 #endif
2770
2771     switch (flags) {
2772         case EXACT: case EXACT_REQ8: case EXACTL: break;
2773         case EXACTFAA:
2774         case EXACTFUP:
2775         case EXACTFU:
2776         case EXACTFLU8: folder = PL_fold_latin1; break;
2777         case EXACTF:  folder = PL_fold; break;
2778         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2779     }
2780
2781     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2782     trie->refcount = 1;
2783     trie->startstate = 1;
2784     trie->wordcount = word_count;
2785     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2786     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2787     if (flags == EXACT || flags == EXACT_REQ8 || flags == EXACTL)
2788         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2789     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2790                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2791
2792     DEBUG_r({
2793         trie_words = newAV();
2794     });
2795
2796     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, GV_ADD);
2797     assert(re_trie_maxbuff);
2798     if (!SvIOK(re_trie_maxbuff)) {
2799         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2800     }
2801     DEBUG_TRIE_COMPILE_r({
2802         Perl_re_indentf( aTHX_
2803           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2804           depth+1,
2805           REG_NODE_NUM(startbranch), REG_NODE_NUM(first),
2806           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2807     });
2808
2809    /* Find the node we are going to overwrite */
2810     if ( first == startbranch && OP( last ) != BRANCH ) {
2811         /* whole branch chain */
2812         convert = first;
2813     } else {
2814         /* branch sub-chain */
2815         convert = NEXTOPER( first );
2816     }
2817
2818     /*  -- First loop and Setup --
2819
2820        We first traverse the branches and scan each word to determine if it
2821        contains widechars, and how many unique chars there are, this is
2822        important as we have to build a table with at least as many columns as we
2823        have unique chars.
2824
2825        We use an array of integers to represent the character codes 0..255
2826        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2827        the native representation of the character value as the key and IV's for
2828        the coded index.
2829
2830        *TODO* If we keep track of how many times each character is used we can
2831        remap the columns so that the table compression later on is more
2832        efficient in terms of memory by ensuring the most common value is in the
2833        middle and the least common are on the outside.  IMO this would be better
2834        than a most to least common mapping as theres a decent chance the most
2835        common letter will share a node with the least common, meaning the node
2836        will not be compressible. With a middle is most common approach the worst
2837        case is when we have the least common nodes twice.
2838
2839      */
2840
2841     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2842         regnode *noper = NEXTOPER( cur );
2843         const U8 *uc;
2844         const U8 *e;
2845         int foldlen = 0;
2846         U32 wordlen      = 0;         /* required init */
2847         STRLEN minchars = 0;
2848         STRLEN maxchars = 0;
2849         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2850                                                bitmap?*/
2851
2852         if (OP(noper) == NOTHING) {
2853             /* skip past a NOTHING at the start of an alternation
2854              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2855              *
2856              * If the next node is not something we are supposed to process
2857              * we will just ignore it due to the condition guarding the
2858              * next block.
2859              */
2860
2861             regnode *noper_next= regnext(noper);
2862             if (noper_next < tail)
2863                 noper= noper_next;
2864         }
2865
2866         if (    noper < tail
2867             && (    OP(noper) == flags
2868                 || (flags == EXACT && OP(noper) == EXACT_REQ8)
2869                 || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
2870                                          || OP(noper) == EXACTFUP))))
2871         {
2872             uc= (U8*)STRING(noper);
2873             e= uc + STR_LEN(noper);
2874         } else {
2875             trie->minlen= 0;
2876             continue;
2877         }
2878
2879
2880         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2881             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2882                                           regardless of encoding */
2883             if (OP( noper ) == EXACTFUP) {
2884                 /* false positives are ok, so just set this */
2885                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2886             }
2887         }
2888
2889         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2890                                            branch */
2891             TRIE_CHARCOUNT(trie)++;
2892             TRIE_READ_CHAR;
2893
2894             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2895              * is in effect.  Under /i, this character can match itself, or
2896              * anything that folds to it.  If not under /i, it can match just
2897              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2898              * all fold to k, and all are single characters.   But some folds
2899              * expand to more than one character, so for example LATIN SMALL
2900              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2901              * the string beginning at 'uc' is 'ffi', it could be matched by
2902              * three characters, or just by the one ligature character. (It
2903              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2904              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2905              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2906              * match.)  The trie needs to know the minimum and maximum number
2907              * of characters that could match so that it can use size alone to
2908              * quickly reject many match attempts.  The max is simple: it is
2909              * the number of folded characters in this branch (since a fold is
2910              * never shorter than what folds to it. */
2911
2912             maxchars++;
2913
2914             /* And the min is equal to the max if not under /i (indicated by
2915              * 'folder' being NULL), or there are no multi-character folds.  If
2916              * there is a multi-character fold, the min is incremented just
2917              * once, for the character that folds to the sequence.  Each
2918              * character in the sequence needs to be added to the list below of
2919              * characters in the trie, but we count only the first towards the
2920              * min number of characters needed.  This is done through the
2921              * variable 'foldlen', which is returned by the macros that look
2922              * for these sequences as the number of bytes the sequence
2923              * occupies.  Each time through the loop, we decrement 'foldlen' by
2924              * how many bytes the current char occupies.  Only when it reaches
2925              * 0 do we increment 'minchars' or look for another multi-character
2926              * sequence. */
2927             if (folder == NULL) {
2928                 minchars++;
2929             }
2930             else if (foldlen > 0) {
2931                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2932             }
2933             else {
2934                 minchars++;
2935
2936                 /* See if *uc is the beginning of a multi-character fold.  If
2937                  * so, we decrement the length remaining to look at, to account
2938                  * for the current character this iteration.  (We can use 'uc'
2939                  * instead of the fold returned by TRIE_READ_CHAR because the
2940                  * macro is smart enough to account for any unfolded
2941                  * characters. */
2942                 if (UTF) {
2943                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2944                         foldlen -= UTF8SKIP(uc);
2945                     }
2946                 }
2947                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2948                     foldlen--;
2949                 }
2950             }
2951
2952             /* The current character (and any potential folds) should be added
2953              * to the possible matching characters for this position in this
2954              * branch */
2955             if ( uvc < 256 ) {
2956                 if ( folder ) {
2957                     U8 folded= folder[ (U8) uvc ];
2958                     if ( !trie->charmap[ folded ] ) {
2959                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2960                         TRIE_STORE_REVCHAR( folded );
2961                     }
2962                 }
2963                 if ( !trie->charmap[ uvc ] ) {
2964                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2965                     TRIE_STORE_REVCHAR( uvc );
2966                 }
2967                 if ( set_bit ) {
2968                     /* store the codepoint in the bitmap, and its folded
2969                      * equivalent. */
2970                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2971                     set_bit = 0; /* We've done our bit :-) */
2972                 }
2973             } else {
2974
2975                 /* XXX We could come up with the list of code points that fold
2976                  * to this using PL_utf8_foldclosures, except not for
2977                  * multi-char folds, as there may be multiple combinations
2978                  * there that could work, which needs to wait until runtime to
2979                  * resolve (The comment about LIGATURE FFI above is such an
2980                  * example */
2981
2982                 SV** svpp;
2983                 if ( !widecharmap )
2984                     widecharmap = newHV();
2985
2986                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2987
2988                 if ( !svpp )
2989                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2990
2991                 if ( !SvTRUE( *svpp ) ) {
2992                     sv_setiv( *svpp, ++trie->uniquecharcount );
2993                     TRIE_STORE_REVCHAR(uvc);
2994                 }
2995             }
2996         } /* end loop through characters in this branch of the trie */
2997
2998         /* We take the min and max for this branch and combine to find the min
2999          * and max for all branches processed so far */
3000         if( cur == first ) {
3001             trie->minlen = minchars;
3002             trie->maxlen = maxchars;
3003         } else if (minchars < trie->minlen) {
3004             trie->minlen = minchars;
3005         } else if (maxchars > trie->maxlen) {
3006             trie->maxlen = maxchars;
3007         }
3008     } /* end first pass */
3009     DEBUG_TRIE_COMPILE_r(
3010         Perl_re_indentf( aTHX_
3011                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
3012                 depth+1,
3013                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
3014                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
3015                 (int)trie->minlen, (int)trie->maxlen )
3016     );
3017
3018     /*
3019         We now know what we are dealing with in terms of unique chars and
3020         string sizes so we can calculate how much memory a naive
3021         representation using a flat table  will take. If it's over a reasonable
3022         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
3023         conservative but potentially much slower representation using an array
3024         of lists.
3025
3026         At the end we convert both representations into the same compressed
3027         form that will be used in regexec.c for matching with. The latter
3028         is a form that cannot be used to construct with but has memory
3029         properties similar to the list form and access properties similar
3030         to the table form making it both suitable for fast searches and
3031         small enough that its feasable to store for the duration of a program.
3032
3033         See the comment in the code where the compressed table is produced
3034         inplace from the flat tabe representation for an explanation of how
3035         the compression works.
3036
3037     */
3038
3039
3040     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
3041     prev_states[1] = 0;
3042
3043     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
3044                                                     > SvIV(re_trie_maxbuff) )
3045     {
3046         /*
3047             Second Pass -- Array Of Lists Representation
3048
3049             Each state will be represented by a list of charid:state records
3050             (reg_trie_trans_le) the first such element holds the CUR and LEN
3051             points of the allocated array. (See defines above).
3052
3053             We build the initial structure using the lists, and then convert
3054             it into the compressed table form which allows faster lookups
3055             (but cant be modified once converted).
3056         */
3057
3058         STRLEN transcount = 1;
3059
3060         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
3061             depth+1));
3062
3063         trie->states = (reg_trie_state *)
3064             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3065                                   sizeof(reg_trie_state) );
3066         TRIE_LIST_NEW(1);
3067         next_alloc = 2;
3068
3069         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3070
3071             regnode *noper   = NEXTOPER( cur );
3072             U32 state        = 1;         /* required init */
3073             U16 charid       = 0;         /* sanity init */
3074             U32 wordlen      = 0;         /* required init */
3075
3076             if (OP(noper) == NOTHING) {
3077                 regnode *noper_next= regnext(noper);
3078                 if (noper_next < tail)
3079                     noper= noper_next;
3080                 /* we will undo this assignment if noper does not
3081                  * point at a trieable type in the else clause of
3082                  * the following statement. */
3083             }
3084
3085             if (    noper < tail
3086                 && (    OP(noper) == flags
3087                     || (flags == EXACT && OP(noper) == EXACT_REQ8)
3088                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
3089                                              || OP(noper) == EXACTFUP))))
3090             {
3091                 const U8 *uc= (U8*)STRING(noper);
3092                 const U8 *e= uc + STR_LEN(noper);
3093
3094                 for ( ; uc < e ; uc += len ) {
3095
3096                     TRIE_READ_CHAR;
3097
3098                     if ( uvc < 256 ) {
3099                         charid = trie->charmap[ uvc ];
3100                     } else {
3101                         SV** const svpp = hv_fetch( widecharmap,
3102                                                     (char*)&uvc,
3103                                                     sizeof( UV ),
3104                                                     0);
3105                         if ( !svpp ) {
3106                             charid = 0;
3107                         } else {
3108                             charid=(U16)SvIV( *svpp );
3109                         }
3110                     }
3111                     /* charid is now 0 if we dont know the char read, or
3112                      * nonzero if we do */
3113                     if ( charid ) {
3114
3115                         U16 check;
3116                         U32 newstate = 0;
3117
3118                         charid--;
3119                         if ( !trie->states[ state ].trans.list ) {
3120                             TRIE_LIST_NEW( state );
3121                         }
3122                         for ( check = 1;
3123                               check <= TRIE_LIST_USED( state );
3124                               check++ )
3125                         {
3126                             if ( TRIE_LIST_ITEM( state, check ).forid
3127                                                                     == charid )
3128                             {
3129                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
3130                                 break;
3131                             }
3132                         }
3133                         if ( ! newstate ) {
3134                             newstate = next_alloc++;
3135                             prev_states[newstate] = state;
3136                             TRIE_LIST_PUSH( state, charid, newstate );
3137                             transcount++;
3138                         }
3139                         state = newstate;
3140                     } else {
3141                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3142                     }
3143                 }
3144             } else {
3145                 /* If we end up here it is because we skipped past a NOTHING, but did not end up
3146                  * on a trieable type. So we need to reset noper back to point at the first regop
3147                  * in the branch before we call TRIE_HANDLE_WORD()
3148                 */
3149                 noper= NEXTOPER(cur);
3150             }
3151             TRIE_HANDLE_WORD(state);
3152
3153         } /* end second pass */
3154
3155         /* next alloc is the NEXT state to be allocated */
3156         trie->statecount = next_alloc;
3157         trie->states = (reg_trie_state *)
3158             PerlMemShared_realloc( trie->states,
3159                                    next_alloc
3160                                    * sizeof(reg_trie_state) );
3161
3162         /* and now dump it out before we compress it */
3163         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
3164                                                          revcharmap, next_alloc,
3165                                                          depth+1)
3166         );
3167
3168         trie->trans = (reg_trie_trans *)
3169             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
3170         {
3171             U32 state;
3172             U32 tp = 0;
3173             U32 zp = 0;
3174
3175
3176             for( state=1 ; state < next_alloc ; state ++ ) {
3177                 U32 base=0;
3178
3179                 /*
3180                 DEBUG_TRIE_COMPILE_MORE_r(
3181                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
3182                 );
3183                 */
3184
3185                 if (trie->states[state].trans.list) {
3186                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
3187                     U16 maxid=minid;
3188                     U16 idx;
3189
3190                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3191                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
3192                         if ( forid < minid ) {
3193                             minid=forid;
3194                         } else if ( forid > maxid ) {
3195                             maxid=forid;
3196                         }
3197                     }
3198                     if ( transcount < tp + maxid - minid + 1) {
3199                         transcount *= 2;
3200                         trie->trans = (reg_trie_trans *)
3201                             PerlMemShared_realloc( trie->trans,
3202                                                      transcount
3203                                                      * sizeof(reg_trie_trans) );
3204                         Zero( trie->trans + (transcount / 2),
3205                               transcount / 2,
3206                               reg_trie_trans );
3207                     }
3208                     base = trie->uniquecharcount + tp - minid;
3209                     if ( maxid == minid ) {
3210                         U32 set = 0;
3211                         for ( ; zp < tp ; zp++ ) {
3212                             if ( ! trie->trans[ zp ].next ) {
3213                                 base = trie->uniquecharcount + zp - minid;
3214                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
3215                                                                    1).newstate;
3216                                 trie->trans[ zp ].check = state;
3217                                 set = 1;
3218                                 break;
3219                             }
3220                         }
3221                         if ( !set ) {
3222                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
3223                                                                    1).newstate;
3224                             trie->trans[ tp ].check = state;
3225                             tp++;
3226                             zp = tp;
3227                         }
3228                     } else {
3229                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3230                             const U32 tid = base
3231                                            - trie->uniquecharcount
3232                                            + TRIE_LIST_ITEM( state, idx ).forid;
3233                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
3234                                                                 idx ).newstate;
3235                             trie->trans[ tid ].check = state;
3236                         }
3237                         tp += ( maxid - minid + 1 );
3238                     }
3239                     Safefree(trie->states[ state ].trans.list);
3240                 }
3241                 /*
3242                 DEBUG_TRIE_COMPILE_MORE_r(
3243                     Perl_re_printf( aTHX_  " base: %d\n",base);
3244                 );
3245                 */
3246                 trie->states[ state ].trans.base=base;
3247             }
3248             trie->lasttrans = tp + 1;
3249         }
3250     } else {
3251         /*
3252            Second Pass -- Flat Table Representation.
3253
3254            we dont use the 0 slot of either trans[] or states[] so we add 1 to
3255            each.  We know that we will need Charcount+1 trans at most to store
3256            the data (one row per char at worst case) So we preallocate both
3257            structures assuming worst case.
3258
3259            We then construct the trie using only the .next slots of the entry
3260            structs.
3261
3262            We use the .check field of the first entry of the node temporarily
3263            to make compression both faster and easier by keeping track of how
3264            many non zero fields are in the node.
3265
3266            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
3267            transition.
3268
3269            There are two terms at use here: state as a TRIE_NODEIDX() which is
3270            a number representing the first entry of the node, and state as a
3271            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
3272            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
3273            if there are 2 entrys per node. eg:
3274
3275              A B       A B
3276           1. 2 4    1. 3 7
3277           2. 0 3    3. 0 5
3278           3. 0 0    5. 0 0
3279           4. 0 0    7. 0 0
3280
3281            The table is internally in the right hand, idx form. However as we
3282            also have to deal with the states array which is indexed by nodenum
3283            we have to use TRIE_NODENUM() to convert.
3284
3285         */
3286         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
3287             depth+1));
3288
3289         trie->trans = (reg_trie_trans *)
3290             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
3291                                   * trie->uniquecharcount + 1,
3292                                   sizeof(reg_trie_trans) );
3293         trie->states = (reg_trie_state *)
3294             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3295                                   sizeof(reg_trie_state) );
3296         next_alloc = trie->uniquecharcount + 1;
3297
3298
3299         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3300
3301             regnode *noper   = NEXTOPER( cur );
3302
3303             U32 state        = 1;         /* required init */
3304
3305             U16 charid       = 0;         /* sanity init */
3306             U32 accept_state = 0;         /* sanity init */
3307
3308             U32 wordlen      = 0;         /* required init */
3309
3310             if (OP(noper) == NOTHING) {
3311                 regnode *noper_next= regnext(noper);
3312                 if (noper_next < tail)
3313                     noper= noper_next;
3314                 /* we will undo this assignment if noper does not
3315                  * point at a trieable type in the else clause of
3316                  * the following statement. */
3317             }
3318
3319             if (    noper < tail
3320                 && (    OP(noper) == flags
3321                     || (flags == EXACT && OP(noper) == EXACT_REQ8)
3322                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
3323                                              || OP(noper) == EXACTFUP))))
3324             {
3325                 const U8 *uc= (U8*)STRING(noper);
3326                 const U8 *e= uc + STR_LEN(noper);
3327
3328                 for ( ; uc < e ; uc += len ) {
3329
3330                     TRIE_READ_CHAR;
3331
3332                     if ( uvc < 256 ) {
3333                         charid = trie->charmap[ uvc ];
3334                     } else {
3335                         SV* const * const svpp = hv_fetch( widecharmap,
3336                                                            (char*)&uvc,
3337                                                            sizeof( UV ),
3338                                                            0);
3339                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3340                     }
3341                     if ( charid ) {
3342                         charid--;
3343                         if ( !trie->trans[ state + charid ].next ) {
3344                             trie->trans[ state + charid ].next = next_alloc;
3345                             trie->trans[ state ].check++;
3346                             prev_states[TRIE_NODENUM(next_alloc)]
3347                                     = TRIE_NODENUM(state);
3348                             next_alloc += trie->uniquecharcount;
3349                         }
3350                         state = trie->trans[ state + charid ].next;
3351                     } else {
3352                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3353                     }
3354                     /* charid is now 0 if we dont know the char read, or
3355                      * nonzero if we do */
3356                 }
3357             } else {
3358                 /* If we end up here it is because we skipped past a NOTHING, but did not end up
3359                  * on a trieable type. So we need to reset noper back to point at the first regop
3360                  * in the branch before we call TRIE_HANDLE_WORD().
3361                 */
3362                 noper= NEXTOPER(cur);
3363             }
3364             accept_state = TRIE_NODENUM( state );
3365             TRIE_HANDLE_WORD(accept_state);
3366
3367         } /* end second pass */
3368
3369         /* and now dump it out before we compress it */
3370         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3371                                                           revcharmap,
3372                                                           next_alloc, depth+1));
3373
3374         {
3375         /*
3376            * Inplace compress the table.*
3377
3378            For sparse data sets the table constructed by the trie algorithm will
3379            be mostly 0/FAIL transitions or to put it another way mostly empty.
3380            (Note that leaf nodes will not contain any transitions.)
3381
3382            This algorithm compresses the tables by eliminating most such
3383            transitions, at the cost of a modest bit of extra work during lookup:
3384
3385            - Each states[] entry contains a .base field which indicates the
3386            index in the state[] array wheres its transition data is stored.
3387
3388            - If .base is 0 there are no valid transitions from that node.
3389
3390            - If .base is nonzero then charid is added to it to find an entry in
3391            the trans array.
3392
3393            -If trans[states[state].base+charid].check!=state then the
3394            transition is taken to be a 0/Fail transition. Thus if there are fail
3395            transitions at the front of the node then the .base offset will point
3396            somewhere inside the previous nodes data (or maybe even into a node
3397            even earlier), but the .check field determines if the transition is
3398            valid.
3399
3400            XXX - wrong maybe?
3401            The following process inplace converts the table to the compressed
3402            table: We first do not compress the root node 1,and mark all its
3403            .check pointers as 1 and set its .base pointer as 1 as well. This
3404            allows us to do a DFA construction from the compressed table later,
3405            and ensures that any .base pointers we calculate later are greater
3406            than 0.
3407
3408            - We set 'pos' to indicate the first entry of the second node.
3409
3410            - We then iterate over the columns of the node, finding the first and
3411            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3412            and set the .check pointers accordingly, and advance pos
3413            appropriately and repreat for the next node. Note that when we copy
3414            the next pointers we have to convert them from the original
3415            NODEIDX form to NODENUM form as the former is not valid post
3416            compression.
3417
3418            - If a node has no transitions used we mark its base as 0 and do not
3419            advance the pos pointer.
3420
3421            - If a node only has one transition we use a second pointer into the
3422            structure to fill in allocated fail transitions from other states.
3423            This pointer is independent of the main pointer and scans forward
3424            looking for null transitions that are allocated to a state. When it
3425            finds one it writes the single transition into the "hole".  If the
3426            pointer doesnt find one the single transition is appended as normal.
3427
3428            - Once compressed we can Renew/realloc the structures to release the
3429            excess space.
3430
3431            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3432            specifically Fig 3.47 and the associated pseudocode.
3433
3434            demq
3435         */
3436         const U32 laststate = TRIE_NODENUM( next_alloc );
3437         U32 state, charid;
3438         U32 pos = 0, zp=0;
3439         trie->statecount = laststate;
3440
3441         for ( state = 1 ; state < laststate ; state++ ) {
3442             U8 flag = 0;
3443             const U32 stateidx = TRIE_NODEIDX( state );
3444             const U32 o_used = trie->trans[ stateidx ].check;
3445             U32 used = trie->trans[ stateidx ].check;
3446             trie->trans[ stateidx ].check = 0;
3447
3448             for ( charid = 0;
3449                   used && charid < trie->uniquecharcount;
3450                   charid++ )
3451             {
3452                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3453                     if ( trie->trans[ stateidx + charid ].next ) {
3454                         if (o_used == 1) {
3455                             for ( ; zp < pos ; zp++ ) {
3456                                 if ( ! trie->trans[ zp ].next ) {
3457                                     break;
3458                                 }
3459                             }
3460                             trie->states[ state ].trans.base
3461                                                     = zp
3462                                                       + trie->uniquecharcount
3463                                                       - charid ;
3464                             trie->trans[ zp ].next
3465                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3466                                                              + charid ].next );
3467                             trie->trans[ zp ].check = state;
3468                             if ( ++zp > pos ) pos = zp;
3469                             break;
3470                         }
3471                         used--;
3472                     }
3473                     if ( !flag ) {
3474                         flag = 1;
3475                         trie->states[ state ].trans.base
3476                                        = pos + trie->uniquecharcount - charid ;
3477                     }
3478                     trie->trans[ pos ].next
3479                         = SAFE_TRIE_NODENUM(
3480                                        trie->trans[ stateidx + charid ].next );
3481                     trie->trans[ pos ].check = state;
3482                     pos++;
3483                 }
3484             }
3485         }
3486         trie->lasttrans = pos + 1;
3487         trie->states = (reg_trie_state *)
3488             PerlMemShared_realloc( trie->states, laststate
3489                                    * sizeof(reg_trie_state) );
3490         DEBUG_TRIE_COMPILE_MORE_r(
3491             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3492                 depth+1,
3493                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3494                        + 1 ),
3495                 (IV)next_alloc,
3496                 (IV)pos,
3497                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3498             );
3499
3500         } /* end table compress */
3501     }
3502     DEBUG_TRIE_COMPILE_MORE_r(
3503             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3504                 depth+1,
3505                 (UV)trie->statecount,
3506                 (UV)trie->lasttrans)
3507     );
3508     /* resize the trans array to remove unused space */
3509     trie->trans = (reg_trie_trans *)
3510         PerlMemShared_realloc( trie->trans, trie->lasttrans
3511                                * sizeof(reg_trie_trans) );
3512
3513     {   /* Modify the program and insert the new TRIE node */
3514         U8 nodetype =(U8)(flags & 0xFF);
3515         char *str=NULL;
3516
3517 #ifdef DEBUGGING
3518         regnode *optimize = NULL;
3519 #ifdef RE_TRACK_PATTERN_OFFSETS
3520
3521         U32 mjd_offset = 0;
3522         U32 mjd_nodelen = 0;
3523 #endif /* RE_TRACK_PATTERN_OFFSETS */
3524 #endif /* DEBUGGING */
3525         /*
3526            This means we convert either the first branch or the first Exact,
3527            depending on whether the thing following (in 'last') is a branch
3528            or not and whther first is the startbranch (ie is it a sub part of
3529            the alternation or is it the whole thing.)
3530            Assuming its a sub part we convert the EXACT otherwise we convert
3531            the whole branch sequence, including the first.
3532          */
3533         /* Find the node we are going to overwrite */
3534         if ( first != startbranch || OP( last ) == BRANCH ) {
3535             /* branch sub-chain */
3536             NEXT_OFF( first ) = (U16)(last - first);
3537 #ifdef RE_TRACK_PATTERN_OFFSETS
3538             DEBUG_r({
3539                 mjd_offset= Node_Offset((convert));
3540                 mjd_nodelen= Node_Length((convert));
3541             });
3542 #endif
3543             /* whole branch chain */
3544         }
3545 #ifdef RE_TRACK_PATTERN_OFFSETS
3546         else {
3547             DEBUG_r({
3548                 const  regnode *nop = NEXTOPER( convert );
3549                 mjd_offset= Node_Offset((nop));
3550                 mjd_nodelen= Node_Length((nop));
3551             });
3552         }
3553         DEBUG_OPTIMISE_r(
3554             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3555                 depth+1,
3556                 (UV)mjd_offset, (UV)mjd_nodelen)
3557         );
3558 #endif
3559         /* But first we check to see if there is a common prefix we can
3560            split out as an EXACT and put in front of the TRIE node.  */
3561         trie->startstate= 1;
3562         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3563             /* we want to find the first state that has more than
3564              * one transition, if that state is not the first state
3565              * then we have a common prefix which we can remove.
3566              */
3567             U32 state;
3568             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3569                 U32 ofs = 0;
3570                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3571                                        transition, -1 means none */
3572                 U32 count = 0;
3573                 const U32 base = trie->states[ state ].trans.base;
3574
3575                 /* does this state terminate an alternation? */
3576                 if ( trie->states[state].wordnum )
3577                         count = 1;
3578
3579                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3580                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3581                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3582                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3583                     {
3584                         if ( ++count > 1 ) {
3585                             /* we have more than one transition */
3586                             SV **tmp;
3587                             U8 *ch;
3588                             /* if this is the first state there is no common prefix
3589                              * to extract, so we can exit */
3590                             if ( state == 1 ) break;
3591                             tmp = av_fetch( revcharmap, ofs, 0);
3592                             ch = (U8*)SvPV_nolen_const( *tmp );
3593
3594                             /* if we are on count 2 then we need to initialize the
3595                              * bitmap, and store the previous char if there was one
3596                              * in it*/
3597                             if ( count == 2 ) {
3598                                 /* clear the bitmap */
3599                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3600                                 DEBUG_OPTIMISE_r(
3601                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3602                                         depth+1,
3603                                         (UV)state));
3604                                 if (first_ofs >= 0) {
3605                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3606                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3607
3608                                     TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3609                                     DEBUG_OPTIMISE_r(
3610                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3611                                     );
3612                                 }
3613                             }
3614                             /* store the current firstchar in the bitmap */
3615                             TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3616                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3617                         }
3618                         first_ofs = ofs;
3619                     }
3620                 }
3621                 if ( count == 1 ) {
3622                     /* This state has only one transition, its transition is part
3623                      * of a common prefix - we need to concatenate the char it
3624                      * represents to what we have so far. */
3625                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3626                     STRLEN len;
3627                     char *ch = SvPV( *tmp, len );
3628                     DEBUG_OPTIMISE_r({
3629                         SV *sv=sv_newmortal();
3630                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3631                             depth+1,
3632                             (UV)state, (UV)first_ofs,
3633                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3634                                 PL_colors[0], PL_colors[1],
3635                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3636                                 PERL_PV_ESCAPE_FIRSTCHAR
3637                             )
3638                         );
3639                     });
3640                     if ( state==1 ) {
3641                         OP( convert ) = nodetype;
3642                         str=STRING(convert);
3643                         setSTR_LEN(convert, 0);
3644                     }
3645                     assert( ( STR_LEN(convert) + len ) < 256 );
3646                     setSTR_LEN(convert, (U8)(STR_LEN(convert) + len));
3647                     while (len--)
3648                         *str++ = *ch++;
3649                 } else {
3650 #ifdef DEBUGGING
3651                     if (state>1)
3652                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3653 #endif
3654                     break;
3655                 }
3656             }
3657             trie->prefixlen = (state-1);
3658             if (str) {
3659                 regnode *n = convert+NODE_SZ_STR(convert);
3660                 assert( NODE_SZ_STR(convert) <= U16_MAX );
3661                 NEXT_OFF(convert) = (U16)(NODE_SZ_STR(convert));
3662                 trie->startstate = state;
3663                 trie->minlen -= (state - 1);
3664                 trie->maxlen -= (state - 1);
3665 #ifdef DEBUGGING
3666                /* At least the UNICOS C compiler choked on this
3667                 * being argument to DEBUG_r(), so let's just have
3668                 * it right here. */
3669                if (
3670 #ifdef PERL_EXT_RE_BUILD
3671                    1
3672 #else
3673                    DEBUG_r_TEST
3674 #endif
3675                    ) {
3676                    regnode *fix = convert;
3677                    U32 word = trie->wordcount;
3678 #ifdef RE_TRACK_PATTERN_OFFSETS
3679                    mjd_nodelen++;
3680 #endif
3681                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3682                    while( ++fix < n ) {
3683                        Set_Node_Offset_Length(fix, 0, 0);
3684                    }
3685                    while (word--) {
3686                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3687                        if (tmp) {
3688                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3689                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3690                            else
3691                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3692                        }
3693                    }
3694                }
3695 #endif
3696                 if (trie->maxlen) {
3697                     convert = n;
3698                 } else {
3699                     NEXT_OFF(convert) = (U16)(tail - convert);
3700                     DEBUG_r(optimize= n);
3701                 }
3702             }
3703         }
3704         if (!jumper)
3705             jumper = last;
3706         if ( trie->maxlen ) {
3707             NEXT_OFF( convert ) = (U16)(tail - convert);
3708             ARG_SET( convert, data_slot );
3709             /* Store the offset to the first unabsorbed branch in
3710                jump[0], which is otherwise unused by the jump logic.
3711                We use this when dumping a trie and during optimisation. */
3712             if (trie->jump)
3713                 trie->jump[0] = (U16)(nextbranch - convert);
3714
3715             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3716              *   and there is a bitmap
3717              *   and the first "jump target" node we found leaves enough room
3718              * then convert the TRIE node into a TRIEC node, with the bitmap
3719              * embedded inline in the opcode - this is hypothetically faster.
3720              */
3721             if ( !trie->states[trie->startstate].wordnum
3722                  && trie->bitmap
3723                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3724             {
3725                 OP( convert ) = TRIEC;
3726                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3727                 PerlMemShared_free(trie->bitmap);
3728                 trie->bitmap= NULL;
3729             } else
3730                 OP( convert ) = TRIE;
3731
3732             /* store the type in the flags */
3733             convert->flags = nodetype;
3734             DEBUG_r({
3735             optimize = convert
3736                       + NODE_STEP_REGNODE
3737                       + regarglen[ OP( convert ) ];
3738             });
3739             /* XXX We really should free up the resource in trie now,
3740                    as we won't use them - (which resources?) dmq */
3741         }
3742         /* needed for dumping*/
3743         DEBUG_r(if (optimize) {
3744             regnode *opt = convert;
3745
3746             while ( ++opt < optimize) {
3747                 Set_Node_Offset_Length(opt, 0, 0);
3748             }
3749             /*
3750                 Try to clean up some of the debris left after the
3751                 optimisation.
3752              */
3753             while( optimize < jumper ) {
3754                 Track_Code( mjd_nodelen += Node_Length((optimize)); );
3755                 OP( optimize ) = OPTIMIZED;
3756                 Set_Node_Offset_Length(optimize, 0, 0);
3757                 optimize++;
3758             }
3759             Set_Node_Offset_Length(convert, mjd_offset, mjd_nodelen);
3760         });
3761     } /* end node insert */
3762
3763     /*  Finish populating the prev field of the wordinfo array.  Walk back
3764      *  from each accept state until we find another accept state, and if
3765      *  so, point the first word's .prev field at the second word. If the
3766      *  second already has a .prev field set, stop now. This will be the
3767      *  case either if we've already processed that word's accept state,
3768      *  or that state had multiple words, and the overspill words were
3769      *  already linked up earlier.
3770      */
3771     {
3772         U16 word;
3773         U32 state;
3774         U16 prev;
3775
3776         for (word=1; word <= trie->wordcount; word++) {
3777             prev = 0;
3778             if (trie->wordinfo[word].prev)
3779                 continue;
3780             state = trie->wordinfo[word].accept;
3781             while (state) {
3782                 state = prev_states[state];
3783                 if (!state)
3784                     break;
3785                 prev = trie->states[state].wordnum;
3786                 if (prev)
3787                     break;
3788             }
3789             trie->wordinfo[word].prev = prev;
3790         }
3791         Safefree(prev_states);
3792     }
3793
3794
3795     /* and now dump out the compressed format */
3796     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3797
3798     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3799 #ifdef DEBUGGING
3800     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3801     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3802 #else
3803     SvREFCNT_dec_NN(revcharmap);
3804 #endif
3805     return trie->jump
3806            ? MADE_JUMP_TRIE
3807            : trie->startstate>1
3808              ? MADE_EXACT_TRIE
3809              : MADE_TRIE;
3810 }
3811
3812 STATIC regnode *
3813 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3814 {
3815 /* The Trie is constructed and compressed now so we can build a fail array if
3816  * it's needed
3817
3818    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3819    3.32 in the
3820    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3821    Ullman 1985/88
3822    ISBN 0-201-10088-6
3823
3824    We find the fail state for each state in the trie, this state is the longest
3825    proper suffix of the current state's 'word' that is also a proper prefix of
3826    another word in our trie. State 1 represents the word '' and is thus the
3827    default fail state. This allows the DFA not to have to restart after its
3828    tried and failed a word at a given point, it simply continues as though it
3829    had been matching the other word in the first place.
3830    Consider
3831       'abcdgu'=~/abcdefg|cdgu/
3832    When we get to 'd' we are still matching the first word, we would encounter
3833    'g' which would fail, which would bring us to the state representing 'd' in
3834    the second word where we would try 'g' and succeed, proceeding to match
3835    'cdgu'.
3836  */
3837  /* add a fail transition */
3838     const U32 trie_offset = ARG(source);
3839     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3840     U32 *q;
3841     const U32 ucharcount = trie->uniquecharcount;
3842     const U32 numstates = trie->statecount;
3843     const U32 ubound = trie->lasttrans + ucharcount;
3844     U32 q_read = 0;
3845     U32 q_write = 0;
3846     U32 charid;
3847     U32 base = trie->states[ 1 ].trans.base;
3848     U32 *fail;
3849     reg_ac_data *aho;
3850     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3851     regnode *stclass;
3852     DECLARE_AND_GET_RE_DEBUG_FLAGS;
3853
3854     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3855     PERL_UNUSED_CONTEXT;
3856 #ifndef DEBUGGING
3857     PERL_UNUSED_ARG(depth);
3858 #endif
3859
3860     if ( OP(source) == TRIE ) {
3861         struct regnode_1 *op = (struct regnode_1 *)
3862             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3863         StructCopy(source, op, struct regnode_1);
3864         stclass = (regnode *)op;
3865     } else {
3866         struct regnode_charclass *op = (struct regnode_charclass *)
3867             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3868         StructCopy(source, op, struct regnode_charclass);
3869         stclass = (regnode *)op;
3870     }
3871     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3872
3873     ARG_SET( stclass, data_slot );
3874     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3875     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3876     aho->trie=trie_offset;
3877     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3878     Copy( trie->states, aho->states, numstates, reg_trie_state );
3879     Newx( q, numstates, U32);
3880     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3881     aho->refcount = 1;
3882     fail = aho->fail;
3883     /* initialize fail[0..1] to be 1 so that we always have
3884        a valid final fail state */
3885     fail[ 0 ] = fail[ 1 ] = 1;
3886
3887     for ( charid = 0; charid < ucharcount ; charid++ ) {
3888         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3889         if ( newstate ) {
3890             q[ q_write ] = newstate;
3891             /* set to point at the root */
3892             fail[ q[ q_write++ ] ]=1;
3893         }
3894     }
3895     while ( q_read < q_write) {
3896         const U32 cur = q[ q_read++ % numstates ];
3897         base = trie->states[ cur ].trans.base;
3898
3899         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3900             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3901             if (ch_state) {
3902                 U32 fail_state = cur;
3903                 U32 fail_base;
3904                 do {
3905                     fail_state = fail[ fail_state ];
3906                     fail_base = aho->states[ fail_state ].trans.base;
3907                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3908
3909                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3910                 fail[ ch_state ] = fail_state;
3911                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3912                 {
3913                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3914                 }
3915                 q[ q_write++ % numstates] = ch_state;
3916             }
3917         }
3918     }
3919     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3920        when we fail in state 1, this allows us to use the
3921        charclass scan to find a valid start char. This is based on the principle
3922        that theres a good chance the string being searched contains lots of stuff
3923        that cant be a start char.
3924      */
3925     fail[ 0 ] = fail[ 1 ] = 0;
3926     DEBUG_TRIE_COMPILE_r({
3927         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3928                       depth, (UV)numstates
3929         );
3930         for( q_read=1; q_read<numstates; q_read++ ) {
3931             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3932         }
3933         Perl_re_printf( aTHX_  "\n");
3934     });
3935     Safefree(q);
3936     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3937     return stclass;
3938 }
3939
3940
3941 /* The below joins as many adjacent EXACTish nodes as possible into a single
3942  * one.  The regop may be changed if the node(s) contain certain sequences that
3943  * require special handling.  The joining is only done if:
3944  * 1) there is room in the current conglomerated node to entirely contain the
3945  *    next one.
3946  * 2) they are compatible node types
3947  *
3948  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3949  * these get optimized out
3950  *
3951  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3952  * as possible, even if that means splitting an existing node so that its first
3953  * part is moved to the preceeding node.  This would maximise the efficiency of
3954  * memEQ during matching.
3955  *
3956  * If a node is to match under /i (folded), the number of characters it matches
3957  * can be different than its character length if it contains a multi-character
3958  * fold.  *min_subtract is set to the total delta number of characters of the
3959  * input nodes.
3960  *
3961  * And *unfolded_multi_char is set to indicate whether or not the node contains
3962  * an unfolded multi-char fold.  This happens when it won't be known until
3963  * runtime whether the fold is valid or not; namely
3964  *  1) for EXACTF nodes that contain LATIN SMALL LETTER SHARP S, as only if the
3965  *      target string being matched against turns out to be UTF-8 is that fold
3966  *      valid; or
3967  *  2) for EXACTFL nodes whose folding rules depend on the locale in force at
3968  *      runtime.
3969  * (Multi-char folds whose components are all above the Latin1 range are not
3970  * run-time locale dependent, and have already been folded by the time this
3971  * function is called.)
3972  *
3973  * This is as good a place as any to discuss the design of handling these
3974  * multi-character fold sequences.  It's been wrong in Perl for a very long
3975  * time.  There are three code points in Unicode whose multi-character folds
3976  * were long ago discovered to mess things up.  The previous designs for
3977  * dealing with these involved assigning a special node for them.  This
3978  * approach doesn't always work, as evidenced by this example:
3979  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3980  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3981  * would match just the \xDF, it won't be able to handle the case where a
3982  * successful match would have to cross the node's boundary.  The new approach
3983  * that hopefully generally solves the problem generates an EXACTFUP node
3984  * that is "sss" in this case.
3985  *
3986  * It turns out that there are problems with all multi-character folds, and not
3987  * just these three.  Now the code is general, for all such cases.  The
3988  * approach taken is:
3989  * 1)   This routine examines each EXACTFish node that could contain multi-
3990  *      character folded sequences.  Since a single character can fold into
3991  *      such a sequence, the minimum match length for this node is less than
3992  *      the number of characters in the node.  This routine returns in
3993  *      *min_subtract how many characters to subtract from the actual
3994  *      length of the string to get a real minimum match length; it is 0 if
3995  *      there are no multi-char foldeds.  This delta is used by the caller to
3996  *      adjust the min length of the match, and the delta between min and max,
3997  *      so that the optimizer doesn't reject these possibilities based on size
3998  *      constraints.
3999  *
4000  * 2)   For the sequence involving the LATIN SMALL LETTER SHARP S (U+00DF)
4001  *      under /u, we fold it to 'ss' in regatom(), and in this routine, after
4002  *      joining, we scan for occurrences of the sequence 'ss' in non-UTF-8
4003  *      EXACTFU nodes.  The node type of such nodes is then changed to
4004  *      EXACTFUP, indicating it is problematic, and needs careful handling.
4005  *      (The procedures in step 1) above are sufficient to handle this case in
4006  *      UTF-8 encoded nodes.)  The reason this is problematic is that this is
4007  *      the only case where there is a possible fold length change in non-UTF-8
4008  *      patterns.  By reserving a special node type for problematic cases, the
4009  *      far more common regular EXACTFU nodes can be processed faster.
4010  *      regexec.c takes advantage of this.
4011  *
4012  *      EXACTFUP has been created as a grab-bag for (hopefully uncommon)
4013  *      problematic cases.   These all only occur when the pattern is not
4014  *      UTF-8.  In addition to the 'ss' sequence where there is a possible fold
4015  *      length change, it handles the situation where the string cannot be
4016  *      entirely folded.  The strings in an EXACTFish node are folded as much
4017  *      as possible during compilation in regcomp.c.  This saves effort in
4018  *      regex matching.  By using an EXACTFUP node when it is not possible to
4019  *      fully fold at compile time, regexec.c can know that everything in an
4020  *      EXACTFU node is folded, so folding can be skipped at runtime.  The only
4021  *      case where folding in EXACTFU nodes can't be done at compile time is
4022  *      the presumably uncommon MICRO SIGN, when the pattern isn't UTF-8.  This
4023  *      is because its fold requires UTF-8 to represent.  Thus EXACTFUP nodes
4024  *      handle two very different cases.  Alternatively, there could have been
4025  *      a node type where there are length changes, one for unfolded, and one
4026  *      for both.  If yet another special case needed to be created, the number
4027  *      of required node types would have to go to 7.  khw figures that even
4028  *      though there are plenty of node types to spare, that the maintenance
4029  *      cost wasn't worth the small speedup of doing it that way, especially
4030  *      since he thinks the MICRO SIGN is rarely encountered in practice.
4031  *
4032  *      There are other cases where folding isn't done at compile time, but
4033  *      none of them are under /u, and hence not for EXACTFU nodes.  The folds
4034  *      in EXACTFL nodes aren't known until runtime, and vary as the locale
4035  *      changes.  Some folds in EXACTF depend on if the runtime target string
4036  *      is UTF-8 or not.  (regatom() will create an EXACTFU node even under /di
4037  *      when no fold in it depends on the UTF-8ness of the target string.)
4038  *
4039  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
4040  *      validity of the fold won't be known until runtime, and so must remain
4041  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFAA
4042  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
4043  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
4044  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
4045  *      The reason this is a problem is that the optimizer part of regexec.c
4046  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
4047  *      that a character in the pattern corresponds to at most a single
4048  *      character in the target string.  (And I do mean character, and not byte
4049  *      here, unlike other parts of the documentation that have never been
4050  *      updated to account for multibyte Unicode.)  Sharp s in EXACTF and
4051  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFAA
4052  *      nodes it can match "\x{17F}\x{17F}".  These, along with other ones in
4053  *      EXACTFL nodes, violate the assumption, and they are the only instances
4054  *      where it is violated.  I'm reluctant to try to change the assumption,
4055  *      as the code involved is impenetrable to me (khw), so instead the code
4056  *      here punts.  This routine examines EXACTFL nodes, and (when the pattern
4057  *      isn't UTF-8) EXACTF and EXACTFAA for such unfolded folds, and returns a
4058  *      boolean indicating whether or not the node contains such a fold.  When
4059  *      it is true, the caller sets a flag that later causes the optimizer in
4060  *      this file to not set values for the floating and fixed string lengths,
4061  *      and thus avoids the optimizer code in regexec.c that makes the invalid
4062  *      assumption.  Thus, there is no optimization based on string lengths for
4063  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
4064  *      EXACTF and EXACTFAA nodes that contain the sharp s.  (The reason the
4065  *      assumption is wrong only in these cases is that all other non-UTF-8
4066  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
4067  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
4068  *      EXACTF nodes because we don't know at compile time if it actually
4069  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
4070  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
4071  *      always matches; and EXACTFAA where it never does.  In an EXACTFAA node
4072  *      in a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
4073  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
4074  *      string would require the pattern to be forced into UTF-8, the overhead
4075  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
4076  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
4077  *      locale.)
4078  *
4079  *      Similarly, the code that generates tries doesn't currently handle
4080  *      not-already-folded multi-char folds, and it looks like a pain to change
4081  *      that.  Therefore, trie generation of EXACTFAA nodes with the sharp s
4082  *      doesn't work.  Instead, such an EXACTFAA is turned into a new regnode,
4083  *      EXACTFAA_NO_TRIE, which the trie code knows not to handle.  Most people
4084  *      using /iaa matching will be doing so almost entirely with ASCII
4085  *      strings, so this should rarely be encountered in practice */
4086
4087 STATIC U32
4088 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
4089                    UV *min_subtract, bool *unfolded_multi_char,
4090                    U32 flags, regnode *val, U32 depth)
4091 {
4092     /* Merge several consecutive EXACTish nodes into one. */
4093
4094     regnode *n = regnext(scan);
4095     U32 stringok = 1;
4096     regnode *next = scan + NODE_SZ_STR(scan);
4097     U32 merged = 0;
4098     U32 stopnow = 0;
4099 #ifdef DEBUGGING
4100     regnode *stop = scan;
4101     DECLARE_AND_GET_RE_DEBUG_FLAGS;
4102 #else
4103     PERL_UNUSED_ARG(depth);
4104 #endif
4105
4106     PERL_ARGS_ASSERT_JOIN_EXACT;
4107 #ifndef EXPERIMENTAL_INPLACESCAN
4108     PERL_UNUSED_ARG(flags);
4109     PERL_UNUSED_ARG(val);
4110 #endif
4111     DEBUG_PEEP("join", scan, depth, 0);
4112
4113     assert(PL_regkind[OP(scan)] == EXACT);
4114
4115     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
4116      * EXACT ones that are mergeable to the current one. */
4117     while (    n
4118            && (    PL_regkind[OP(n)] == NOTHING
4119                || (stringok && PL_regkind[OP(n)] == EXACT))
4120            && NEXT_OFF(n)
4121            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
4122     {
4123
4124         if (OP(n) == TAIL || n > next)
4125             stringok = 0;
4126         if (PL_regkind[OP(n)] == NOTHING) {
4127             DEBUG_PEEP("skip:", n, depth, 0);
4128             NEXT_OFF(scan) += NEXT_OFF(n);
4129             next = n + NODE_STEP_REGNODE;
4130 #ifdef DEBUGGING
4131             if (stringok)
4132                 stop = n;
4133 #endif
4134             n = regnext(n);
4135         }
4136         else if (stringok) {
4137             const unsigned int oldl = STR_LEN(scan);
4138             regnode * const nnext = regnext(n);
4139
4140             /* XXX I (khw) kind of doubt that this works on platforms (should
4141              * Perl ever run on one) where U8_MAX is above 255 because of lots
4142              * of other assumptions */
4143             /* Don't join if the sum can't fit into a single node */
4144             if (oldl + STR_LEN(n) > U8_MAX)
4145                 break;
4146
4147             /* Joining something that requires UTF-8 with something that
4148              * doesn't, means the result requires UTF-8. */
4149             if (OP(scan) == EXACT && (OP(n) == EXACT_REQ8)) {
4150                 OP(scan) = EXACT_REQ8;
4151             }
4152             else if (OP(scan) == EXACT_REQ8 && (OP(n) == EXACT)) {
4153                 ;   /* join is compatible, no need to change OP */
4154             }
4155             else if ((OP(scan) == EXACTFU) && (OP(n) == EXACTFU_REQ8)) {
4156                 OP(scan) = EXACTFU_REQ8;
4157             }
4158             else if ((OP(scan) == EXACTFU_REQ8) && (OP(n) == EXACTFU)) {
4159                 ;   /* join is compatible, no need to change OP */
4160             }
4161             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU) {
4162                 ;   /* join is compatible, no need to change OP */
4163             }
4164             else if (OP(scan) == EXACTFU && OP(n) == EXACTFU_S_EDGE) {
4165
4166                  /* Under /di, temporary EXACTFU_S_EDGE nodes are generated,
4167                   * which can join with EXACTFU ones.  We check for this case
4168                   * here.  These need to be resolved to either EXACTFU or
4169                   * EXACTF at joining time.  They have nothing in them that
4170                   * would forbid them from being the more desirable EXACTFU
4171                   * nodes except that they begin and/or end with a single [Ss].
4172                   * The reason this is problematic is because they could be
4173                   * joined in this loop with an adjacent node that ends and/or
4174                   * begins with [Ss] which would then form the sequence 'ss',
4175                   * which matches differently under /di than /ui, in which case
4176                   * EXACTFU can't be used.  If the 'ss' sequence doesn't get
4177                   * formed, the nodes get absorbed into any adjacent EXACTFU
4178                   * node.  And if the only adjacent node is EXACTF, they get
4179                   * absorbed into that, under the theory that a longer node is
4180                   * better than two shorter ones, even if one is EXACTFU.  Note
4181                   * that EXACTFU_REQ8 is generated only for UTF-8 patterns,
4182                   * and the EXACTFU_S_EDGE ones only for non-UTF-8.  */
4183
4184                 if (STRING(n)[STR_LEN(n)-1] == 's') {
4185
4186                     /* Here the joined node would end with 's'.  If the node
4187                      * following the combination is an EXACTF one, it's better to
4188                      * join this trailing edge 's' node with that one, leaving the
4189                      * current one in 'scan' be the more desirable EXACTFU */
4190                     if (OP(nnext) == EXACTF) {
4191                         break;
4192                     }
4193
4194                     OP(scan) = EXACTFU_S_EDGE;
4195
4196                 }   /* Otherwise, the beginning 's' of the 2nd node just
4197                        becomes an interior 's' in 'scan' */
4198             }
4199             else if (OP(scan) == EXACTF && OP(n) == EXACTF) {
4200                 ;   /* join is compatible, no need to change OP */
4201             }
4202             else if (OP(scan) == EXACTF && OP(n) == EXACTFU_S_EDGE) {
4203
4204                 /* EXACTF nodes are compatible for joining with EXACTFU_S_EDGE
4205                  * nodes.  But the latter nodes can be also joined with EXACTFU
4206                  * ones, and that is a better outcome, so if the node following
4207                  * 'n' is EXACTFU, quit now so that those two can be joined
4208                  * later */
4209                 if (OP(nnext) == EXACTFU) {
4210                     break;
4211                 }
4212
4213                 /* The join is compatible, and the combined node will be
4214                  * EXACTF.  (These don't care if they begin or end with 's' */
4215             }
4216             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU_S_EDGE) {
4217                 if (   STRING(scan)[STR_LEN(scan)-1] == 's'
4218                     && STRING(n)[0] == 's')
4219                 {
4220                     /* When combined, we have the sequence 'ss', which means we
4221                      * have to remain /di */
4222                     OP(scan) = EXACTF;
4223                 }
4224             }
4225             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTFU) {
4226                 if (STRING(n)[0] == 's') {
4227                     ;   /* Here the join is compatible and the combined node
4228                            starts with 's', no need to change OP */
4229                 }
4230                 else {  /* Now the trailing 's' is in the interior */
4231                     OP(scan) = EXACTFU;
4232                 }
4233             }
4234             else if (OP(scan) == EXACTFU_S_EDGE && OP(n) == EXACTF) {
4235
4236                 /* The join is compatible, and the combined node will be
4237                  * EXACTF.  (These don't care if they begin or end with 's' */
4238                 OP(scan) = EXACTF;
4239             }
4240             else if (OP(scan) != OP(n)) {
4241
4242                 /* The only other compatible joinings are the same node type */
4243                 break;
4244             }
4245
4246             DEBUG_PEEP("merg", n, depth, 0);
4247             merged++;
4248
4249             NEXT_OFF(scan) += NEXT_OFF(n);
4250             assert( ( STR_LEN(scan) + STR_LEN(n) ) < 256 );
4251             setSTR_LEN(scan, (U8)(STR_LEN(scan) + STR_LEN(n)));
4252             next = n + NODE_SZ_STR(n);
4253             /* Now we can overwrite *n : */
4254             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
4255 #ifdef DEBUGGING
4256             stop = next - 1;
4257 #endif
4258             n = nnext;
4259             if (stopnow) break;
4260         }
4261
4262 #ifdef EXPERIMENTAL_INPLACESCAN
4263         if (flags && !NEXT_OFF(n)) {
4264             DEBUG_PEEP("atch", val, depth, 0);
4265             if (reg_off_by_arg[OP(n)]) {
4266                 ARG_SET(n, val - n);
4267             }
4268             else {
4269                 NEXT_OFF(n) = val - n;
4270             }
4271             stopnow = 1;
4272         }
4273 #endif
4274     }
4275
4276     /* This temporary node can now be turned into EXACTFU, and must, as
4277      * regexec.c doesn't handle it */
4278     if (OP(scan) == EXACTFU_S_EDGE) {
4279         OP(scan) = EXACTFU;
4280     }
4281
4282     *min_subtract = 0;
4283     *unfolded_multi_char = FALSE;
4284
4285     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
4286      * can now analyze for sequences of problematic code points.  (Prior to
4287      * this final joining, sequences could have been split over boundaries, and
4288      * hence missed).  The sequences only happen in folding, hence for any
4289      * non-EXACT EXACTish node */
4290     if (OP(scan) != EXACT && OP(scan) != EXACT_REQ8 && OP(scan) != EXACTL) {
4291         U8* s0 = (U8*) STRING(scan);
4292         U8* s = s0;
4293         U8* s_end = s0 + STR_LEN(scan);
4294
4295         int total_count_delta = 0;  /* Total delta number of characters that
4296                                        multi-char folds expand to */
4297
4298         /* One pass is made over the node's string looking for all the
4299          * possibilities.  To avoid some tests in the loop, there are two main
4300          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
4301          * non-UTF-8 */
4302         if (UTF) {
4303             U8* folded = NULL;
4304
4305             if (OP(scan) == EXACTFL) {
4306                 U8 *d;
4307
4308                 /* An EXACTFL node would already have been changed to another
4309                  * node type unless there is at least one character in it that
4310                  * is problematic; likely a character whose fold definition
4311                  * won't be known until runtime, and so has yet to be folded.
4312                  * For all but the UTF-8 locale, folds are 1-1 in length, but
4313                  * to handle the UTF-8 case, we need to create a temporary
4314                  * folded copy using UTF-8 locale rules in order to analyze it.
4315                  * This is because our macros that look to see if a sequence is
4316                  * a multi-char fold assume everything is folded (otherwise the
4317                  * tests in those macros would be too complicated and slow).
4318                  * Note that here, the non-problematic folds will have already
4319                  * been done, so we can just copy such characters.  We actually
4320                  * don't completely fold the EXACTFL string.  We skip the
4321                  * unfolded multi-char folds, as that would just create work
4322                  * below to figure out the size they already are */
4323
4324                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
4325                 d = folded;
4326                 while (s < s_end) {
4327                     STRLEN s_len = UTF8SKIP(s);
4328                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
4329                         Copy(s, d, s_len, U8);
4330                         d += s_len;
4331                     }
4332                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
4333                         *unfolded_multi_char = TRUE;
4334                         Copy(s, d, s_len, U8);
4335                         d += s_len;
4336                     }
4337                     else if (isASCII(*s)) {
4338                         *(d++) = toFOLD(*s);
4339                     }
4340                     else {
4341                         STRLEN len;
4342                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
4343                         d += len;
4344                     }
4345                     s += s_len;
4346                 }
4347
4348                 /* Point the remainder of the routine to look at our temporary
4349                  * folded copy */
4350                 s = folded;
4351                 s_end = d;
4352             } /* End of creating folded copy of EXACTFL string */
4353
4354             /* Examine the string for a multi-character fold sequence.  UTF-8
4355              * patterns have all characters pre-folded by the time this code is
4356              * executed */
4357             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
4358                                      length sequence we are looking for is 2 */
4359             {
4360                 int count = 0;  /* How many characters in a multi-char fold */
4361                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
4362                 if (! len) {    /* Not a multi-char fold: get next char */
4363                     s += UTF8SKIP(s);
4364                     continue;
4365                 }
4366
4367                 { /* Here is a generic multi-char fold. */
4368                     U8* multi_end  = s + len;
4369
4370                     /* Count how many characters are in it.  In the case of
4371                      * /aa, no folds which contain ASCII code points are
4372                      * allowed, so check for those, and skip if found. */
4373                     if (OP(scan) != EXACTFAA && OP(scan) != EXACTFAA_NO_TRIE) {
4374                         count = utf8_length(s, multi_end);
4375                         s = multi_end;
4376                     }
4377                     else {
4378                         while (s < multi_end) {
4379                             if (isASCII(*s)) {
4380                                 s++;
4381                                 goto next_iteration;
4382                             }
4383                             else {
4384                                 s += UTF8SKIP(s);
4385                             }
4386                             count++;
4387                         }
4388                     }
4389                 }
4390
4391                 /* The delta is how long the sequence is minus 1 (1 is how long
4392                  * the character that folds to the sequence is) */
4393                 total_count_delta += count - 1;
4394               next_iteration: ;
4395             }
4396
4397             /* We created a temporary folded copy of the string in EXACTFL
4398              * nodes.  Therefore we need to be sure it doesn't go below zero,
4399              * as the real string could be shorter */
4400             if (OP(scan) == EXACTFL) {
4401                 int total_chars = utf8_length((U8*) STRING(scan),
4402                                            (U8*) STRING(scan) + STR_LEN(scan));
4403                 if (total_count_delta > total_chars) {
4404                     total_count_delta = total_chars;
4405                 }
4406             }
4407
4408             *min_subtract += total_count_delta;
4409             Safefree(folded);
4410         }
4411         else if (OP(scan) == EXACTFAA) {
4412
4413             /* Non-UTF-8 pattern, EXACTFAA node.  There can't be a multi-char
4414              * fold to the ASCII range (and there are no existing ones in the
4415              * upper latin1 range).  But, as outlined in the comments preceding
4416              * this function, we need to flag any occurrences of the sharp s.
4417              * This character forbids trie formation (because of added
4418              * complexity) */
4419 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
4420    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
4421                                       || UNICODE_DOT_DOT_VERSION > 0)
4422             while (s < s_end) {
4423                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
4424                     OP(scan) = EXACTFAA_NO_TRIE;
4425                     *unfolded_multi_char = TRUE;
4426                     break;
4427                 }
4428                 s++;
4429             }
4430         }
4431         else if (OP(scan) != EXACTFAA_NO_TRIE) {
4432
4433             /* Non-UTF-8 pattern, not EXACTFAA node.  Look for the multi-char
4434              * folds that are all Latin1.  As explained in the comments
4435              * preceding this function, we look also for the sharp s in EXACTF
4436              * and EXACTFL nodes; it can be in the final position.  Otherwise
4437              * we can stop looking 1 byte earlier because have to find at least
4438              * two characters for a multi-fold */
4439             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
4440                               ? s_end
4441                               : s_end -1;
4442
4443             while (s < upper) {
4444                 int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
4445                 if (! len) {    /* Not a multi-char fold. */
4446                     if (*s == LATIN_SMALL_LETTER_SHARP_S
4447                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
4448                     {
4449                         *unfolded_multi_char = TRUE;
4450                     }
4451                     s++;
4452                     continue;
4453                 }
4454
4455                 if (len == 2
4456                     && isALPHA_FOLD_EQ(*s, 's')
4457                     && isALPHA_FOLD_EQ(*(s+1), 's'))
4458                 {
4459
4460                     /* EXACTF nodes need to know that the minimum length
4461                      * changed so that a sharp s in the string can match this
4462                      * ss in the pattern, but they remain EXACTF nodes, as they
4463                      * won't match this unless the target string is in UTF-8,
4464                      * which we don't know until runtime.  EXACTFL nodes can't
4465                      * transform into EXACTFU nodes */
4466                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
4467                         OP(scan) = EXACTFUP;
4468                     }
4469                 }
4470
4471                 *min_subtract += len - 1;
4472                 s += len;
4473             }
4474 #endif
4475         }
4476     }
4477
4478 #ifdef DEBUGGING
4479     /* Allow dumping but overwriting the collection of skipped
4480      * ops and/or strings with fake optimized ops */
4481     n = scan + NODE_SZ_STR(scan);
4482     while (n <= stop) {
4483         OP(n) = OPTIMIZED;
4484         FLAGS(n) = 0;
4485         NEXT_OFF(n) = 0;
4486         n++;
4487     }
4488 #endif
4489     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl", scan, depth, 0);});
4490     return stopnow;
4491 }
4492
4493 /* REx optimizer.  Converts nodes into quicker variants "in place".
4494    Finds fixed substrings.  */
4495
4496 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
4497    to the position after last scanned or to NULL. */
4498
4499 #define INIT_AND_WITHP \
4500     assert(!and_withp); \
4501     Newx(and_withp, 1, regnode_ssc); \
4502     SAVEFREEPV(and_withp)
4503
4504
4505 static void
4506 S_unwind_scan_frames(pTHX_ const void *p)
4507 {
4508     scan_frame *f= (scan_frame *)p;
4509     do {
4510         scan_frame *n= f->next_frame;
4511         Safefree(f);
4512         f= n;
4513     } while (f);
4514 }
4515
4516 /* Follow the next-chain of the current node and optimize away
4517    all the NOTHINGs from it.
4518  */
4519 STATIC void
4520 S_rck_elide_nothing(pTHX_ regnode *node)
4521 {
4522     PERL_ARGS_ASSERT_RCK_ELIDE_NOTHING;
4523
4524     if (OP(node) != CURLYX) {
4525         const int max = (reg_off_by_arg[OP(node)]
4526                         ? I32_MAX
4527                           /* I32 may be smaller than U16 on CRAYs! */
4528                         : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
4529         int off = (reg_off_by_arg[OP(node)] ? ARG(node) : NEXT_OFF(node));
4530         int noff;
4531         regnode *n = node;
4532
4533         /* Skip NOTHING and LONGJMP. */
4534         while (
4535             (n = regnext(n))
4536             && (
4537                 (PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
4538                 || ((OP(n) == LONGJMP) && (noff = ARG(n)))
4539             )
4540             && off + noff < max
4541         ) {
4542             off += noff;
4543         }
4544         if (reg_off_by_arg[OP(node)])
4545             ARG(node) = off;
4546         else
4547             NEXT_OFF(node) = off;
4548     }
4549     return;
4550 }
4551
4552 /* the return from this sub is the minimum length that could possibly match */
4553 STATIC SSize_t
4554 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
4555                         SSize_t *minlenp, SSize_t *deltap,
4556                         regnode *last,
4557                         scan_data_t *data,
4558                         I32 stopparen,
4559                         U32 recursed_depth,
4560                         regnode_ssc *and_withp,
4561                         U32 flags, U32 depth, bool was_mutate_ok)
4562                         /* scanp: Start here (read-write). */
4563                         /* deltap: Write maxlen-minlen here. */
4564                         /* last: Stop before this one. */
4565                         /* data: string data about the pattern */
4566                         /* stopparen: treat close N as END */
4567                         /* recursed: which subroutines have we recursed into */
4568                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
4569 {
4570     SSize_t final_minlen;
4571     /* There must be at least this number of characters to match */
4572     SSize_t min = 0;
4573     I32 pars = 0, code;
4574     regnode *scan = *scanp, *next;
4575     SSize_t delta = 0;
4576     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
4577     int is_inf_internal = 0;            /* The studied chunk is infinite */
4578     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
4579     scan_data_t data_fake;
4580     SV *re_trie_maxbuff = NULL;
4581     regnode *first_non_open = scan;
4582     SSize_t stopmin = OPTIMIZE_INFTY;
4583     scan_frame *frame = NULL;
4584     DECLARE_AND_GET_RE_DEBUG_FLAGS;
4585
4586     PERL_ARGS_ASSERT_STUDY_CHUNK;
4587     RExC_study_started= 1;
4588
4589     Zero(&data_fake, 1, scan_data_t);
4590
4591     if ( depth == 0 ) {
4592         while (first_non_open && OP(first_non_open) == OPEN)
4593             first_non_open=regnext(first_non_open);
4594     }
4595
4596
4597   fake_study_recurse:
4598     DEBUG_r(
4599         RExC_study_chunk_recursed_count++;
4600     );
4601     DEBUG_OPTIMISE_MORE_r(
4602     {
4603         Perl_re_indentf( aTHX_  "study_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
4604             depth, (long)stopparen,
4605             (unsigned long)RExC_study_chunk_recursed_count,
4606             (unsigned long)depth, (unsigned long)recursed_depth,
4607             scan,
4608             last);
4609         if (recursed_depth) {
4610             U32 i;
4611             U32 j;
4612             for ( j = 0 ; j < recursed_depth ; j++ ) {
4613                 for ( i = 0 ; i < (U32)RExC_total_parens ; i++ ) {
4614                     if (PAREN_TEST(j, i) && (!j || !PAREN_TEST(j - 1, i))) {
4615                         Perl_re_printf( aTHX_ " %d",(int)i);
4616                         break;
4617                     }
4618                 }
4619                 if ( j + 1 < recursed_depth ) {
4620                     Perl_re_printf( aTHX_  ",");
4621                 }
4622             }
4623         }
4624         Perl_re_printf( aTHX_ "\n");
4625     }
4626     );
4627     while ( scan && OP(scan) != END && scan < last ){
4628         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
4629                                    node length to get a real minimum (because
4630                                    the folded version may be shorter) */
4631         bool unfolded_multi_char = FALSE;
4632         /* avoid mutating ops if we are anywhere within the recursed or
4633          * enframed handling for a GOSUB: the outermost level will handle it.
4634          */
4635         bool mutate_ok = was_mutate_ok && !(frame && frame->in_gosub);
4636         /* Peephole optimizer: */
4637         DEBUG_STUDYDATA("Peep", data, depth, is_inf);
4638         DEBUG_PEEP("Peep", scan, depth, flags);
4639
4640
4641         /* The reason we do this here is that we need to deal with things like
4642          * /(?:f)(?:o)(?:o)/ which cant be dealt with by the normal EXACT
4643          * parsing code, as each (?:..) is handled by a different invocation of
4644          * reg() -- Yves
4645          */
4646         if (PL_regkind[OP(scan)] == EXACT
4647             && OP(scan) != LEXACT
4648             && OP(scan) != LEXACT_REQ8
4649             && mutate_ok
4650         ) {
4651             join_exact(pRExC_state, scan, &min_subtract, &unfolded_multi_char,
4652                     0, NULL, depth + 1);
4653         }
4654
4655         /* Follow the next-chain of the current node and optimize
4656            away all the NOTHINGs from it.
4657          */
4658         rck_elide_nothing(scan);
4659
4660         /* The principal pseudo-switch.  Cannot be a switch, since we look into
4661          * several different things.  */
4662         if ( OP(scan) == DEFINEP ) {
4663             SSize_t minlen = 0;
4664             SSize_t deltanext = 0;
4665             SSize_t fake_last_close = 0;
4666             I32 f = SCF_IN_DEFINE;
4667
4668             StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4669             scan = regnext(scan);
4670             assert( OP(scan) == IFTHEN );
4671             DEBUG_PEEP("expect IFTHEN", scan, depth, flags);
4672
4673             data_fake.last_closep= &fake_last_close;
4674             minlen = *minlenp;
4675             next = regnext(scan);
4676             scan = NEXTOPER(NEXTOPER(scan));
4677             DEBUG_PEEP("scan", scan, depth, flags);
4678             DEBUG_PEEP("next", next, depth, flags);
4679
4680             /* we suppose the run is continuous, last=next...
4681              * NOTE we dont use the return here! */
4682             /* DEFINEP study_chunk() recursion */
4683             (void)study_chunk(pRExC_state, &scan, &minlen,
4684                               &deltanext, next, &data_fake, stopparen,
4685                               recursed_depth, NULL, f, depth+1, mutate_ok);
4686
4687             scan = next;
4688         } else
4689         if (
4690             OP(scan) == BRANCH  ||
4691             OP(scan) == BRANCHJ ||
4692             OP(scan) == IFTHEN
4693         ) {
4694             next = regnext(scan);
4695             code = OP(scan);
4696
4697             /* The op(next)==code check below is to see if we
4698              * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
4699              * IFTHEN is special as it might not appear in pairs.
4700              * Not sure whether BRANCH-BRANCHJ is possible, regardless
4701              * we dont handle it cleanly. */
4702             if (OP(next) == code || code == IFTHEN) {
4703                 /* NOTE - There is similar code to this block below for
4704                  * handling TRIE nodes on a re-study.  If you change stuff here
4705                  * check there too. */
4706                 SSize_t max1 = 0, min1 = OPTIMIZE_INFTY, num = 0;
4707                 regnode_ssc accum;
4708                 regnode * const startbranch=scan;
4709
4710                 if (flags & SCF_DO_SUBSTR) {
4711                     /* Cannot merge strings after this. */
4712                     scan_commit(pRExC_state, data, minlenp, is_inf);
4713                 }
4714
4715                 if (flags & SCF_DO_STCLASS)
4716                     ssc_init_zero(pRExC_state, &accum);
4717
4718                 while (OP(scan) == code) {
4719                     SSize_t deltanext, minnext, fake;
4720                     I32 f = 0;
4721                     regnode_ssc this_class;
4722
4723                     DEBUG_PEEP("Branch", scan, depth, flags);
4724
4725                     num++;
4726                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
4727                     if (data) {
4728                         data_fake.whilem_c = data->whilem_c;
4729                         data_fake.last_closep = data->last_closep;
4730                     }
4731                     else
4732                         data_fake.last_closep = &fake;
4733
4734                     data_fake.pos_delta = delta;
4735                     next = regnext(scan);
4736
4737                     scan = NEXTOPER(scan); /* everything */
4738                     if (code != BRANCH)    /* everything but BRANCH */
4739                         scan = NEXTOPER(scan);
4740
4741                     if (flags & SCF_DO_STCLASS) {
4742                         ssc_init(pRExC_state, &this_class);
4743                         data_fake.start_class = &this_class;
4744                         f = SCF_DO_STCLASS_AND;
4745                     }
4746                     if (flags & SCF_WHILEM_VISITED_POS)
4747                         f |= SCF_WHILEM_VISITED_POS;
4748
4749                     /* we suppose the run is continuous, last=next...*/
4750                     /* recurse study_chunk() for each BRANCH in an alternation */
4751                     minnext = study_chunk(pRExC_state, &scan, minlenp,
4752                                       &deltanext, next, &data_fake, stopparen,
4753                                       recursed_depth, NULL, f, depth+1,
4754                                       mutate_ok);
4755
4756                     if (min1 > minnext)
4757                         min1 = minnext;
4758                     if (deltanext == OPTIMIZE_INFTY) {
4759                         is_inf = is_inf_internal = 1;
4760                         max1 = OPTIMIZE_INFTY;
4761                     } else if (max1 < minnext + deltanext)
4762                         max1 = minnext + deltanext;
4763                     scan = next;
4764                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4765                         pars++;
4766                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4767                         if ( stopmin > minnext)
4768                             stopmin = min + min1;
4769                         flags &= ~SCF_DO_SUBSTR;
4770                         if (data)
4771                             data->flags |= SCF_SEEN_ACCEPT;
4772                     }
4773                     if (data) {
4774                         if (data_fake.flags & SF_HAS_EVAL)
4775                             data->flags |= SF_HAS_EVAL;
4776                         data->whilem_c = data_fake.whilem_c;
4777                     }
4778                     if (flags & SCF_DO_STCLASS)
4779                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
4780                 }
4781                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
4782                     min1 = 0;
4783                 if (flags & SCF_DO_SUBSTR) {
4784                     data->pos_min += min1;
4785                     if (data->pos_delta >= OPTIMIZE_INFTY - (max1 - min1))
4786                         data->pos_delta = OPTIMIZE_INFTY;
4787                     else
4788                         data->pos_delta += max1 - min1;
4789                     if (max1 != min1 || is_inf)
4790                         data->cur_is_floating = 1;
4791                 }
4792                 min += min1;
4793                 if (delta == OPTIMIZE_INFTY
4794                  || OPTIMIZE_INFTY - delta - (max1 - min1) < 0)
4795                     delta = OPTIMIZE_INFTY;
4796                 else
4797                     delta += max1 - min1;
4798                 if (flags & SCF_DO_STCLASS_OR) {
4799                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4800                     if (min1) {
4801                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4802                         flags &= ~SCF_DO_STCLASS;
4803                     }
4804                 }
4805                 else if (flags & SCF_DO_STCLASS_AND) {
4806                     if (min1) {
4807                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4808                         flags &= ~SCF_DO_STCLASS;
4809                     }
4810                     else {
4811                         /* Switch to OR mode: cache the old value of
4812                          * data->start_class */
4813                         INIT_AND_WITHP;
4814                         StructCopy(data->start_class, and_withp, regnode_ssc);
4815                         flags &= ~SCF_DO_STCLASS_AND;
4816                         StructCopy(&accum, data->start_class, regnode_ssc);
4817                         flags |= SCF_DO_STCLASS_OR;
4818                     }
4819                 }
4820
4821                 if (PERL_ENABLE_TRIE_OPTIMISATION
4822                     && OP(startbranch) == BRANCH
4823                     && mutate_ok
4824                 ) {
4825                 /* demq.
4826
4827                    Assuming this was/is a branch we are dealing with: 'scan'
4828                    now points at the item that follows the branch sequence,
4829                    whatever it is. We now start at the beginning of the
4830                    sequence and look for subsequences of
4831
4832                    BRANCH->EXACT=>x1
4833                    BRANCH->EXACT=>x2
4834                    tail
4835
4836                    which would be constructed from a pattern like
4837                    /A|LIST|OF|WORDS/
4838
4839                    If we can find such a subsequence we need to turn the first
4840                    element into a trie and then add the subsequent branch exact
4841                    strings to the trie.
4842
4843                    We have two cases
4844
4845                      1. patterns where the whole set of branches can be
4846                         converted.
4847
4848                      2. patterns where only a subset can be converted.
4849
4850                    In case 1 we can replace the whole set with a single regop
4851                    for the trie. In case 2 we need to keep the start and end
4852                    branches so
4853
4854                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4855                      becomes BRANCH TRIE; BRANCH X;
4856
4857                   There is an additional case, that being where there is a
4858                   common prefix, which gets split out into an EXACT like node
4859                   preceding the TRIE node.
4860
4861                   If x(1..n)==tail then we can do a simple trie, if not we make
4862                   a "jump" trie, such that when we match the appropriate word
4863                   we "jump" to the appropriate tail node. Essentially we turn
4864                   a nested if into a case structure of sorts.
4865
4866                 */
4867
4868                     int made=0;
4869                     if (!re_trie_maxbuff) {
4870                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4871                         if (!SvIOK(re_trie_maxbuff))
4872                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4873                     }
4874                     if ( SvIV(re_trie_maxbuff)>=0  ) {
4875                         regnode *cur;
4876                         regnode *first = (regnode *)NULL;
4877                         regnode *prev = (regnode *)NULL;
4878                         regnode *tail = scan;
4879                         U8 trietype = 0;
4880                         U32 count=0;
4881
4882                         /* var tail is used because there may be a TAIL
4883                            regop in the way. Ie, the exacts will point to the
4884                            thing following the TAIL, but the last branch will
4885                            point at the TAIL. So we advance tail. If we
4886                            have nested (?:) we may have to move through several
4887                            tails.
4888                          */
4889
4890                         while ( OP( tail ) == TAIL ) {
4891                             /* this is the TAIL generated by (?:) */
4892                             tail = regnext( tail );
4893                         }
4894
4895
4896                         DEBUG_TRIE_COMPILE_r({
4897                             regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4898                             Perl_re_indentf( aTHX_  "%s %" UVuf ":%s\n",
4899                               depth+1,
4900                               "Looking for TRIE'able sequences. Tail node is ",
4901                               (UV) REGNODE_OFFSET(tail),
4902                               SvPV_nolen_const( RExC_mysv )
4903                             );
4904                         });
4905
4906                         /*
4907
4908                             Step through the branches
4909                                 cur represents each branch,
4910                                 noper is the first thing to be matched as part
4911                                       of that branch
4912                                 noper_next is the regnext() of that node.
4913
4914                             We normally handle a case like this
4915                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4916                             support building with NOJUMPTRIE, which restricts
4917                             the trie logic to structures like /FOO|BAR/.
4918
4919                             If noper is a trieable nodetype then the branch is
4920                             a possible optimization target. If we are building
4921                             under NOJUMPTRIE then we require that noper_next is
4922                             the same as scan (our current position in the regex
4923                             program).
4924
4925                             Once we have two or more consecutive such branches
4926                             we can create a trie of the EXACT's contents and
4927                             stitch it in place into the program.
4928
4929                             If the sequence represents all of the branches in
4930                             the alternation we replace the entire thing with a
4931                             single TRIE node.
4932
4933                             Otherwise when it is a subsequence we need to
4934                             stitch it in place and replace only the relevant
4935                             branches. This means the first branch has to remain
4936                             as it is used by the alternation logic, and its
4937                             next pointer, and needs to be repointed at the item
4938                             on the branch chain following the last branch we
4939                             have optimized away.
4940
4941                             This could be either a BRANCH, in which case the
4942                             subsequence is internal, or it could be the item
4943                             following the branch sequence in which case the
4944                             subsequence is at the end (which does not
4945                             necessarily mean the first node is the start of the
4946                             alternation).
4947
4948                             TRIE_TYPE(X) is a define which maps the optype to a
4949                             trietype.
4950
4951                                 optype          |  trietype
4952                                 ----------------+-----------
4953                                 NOTHING         | NOTHING
4954                                 EXACT           | EXACT
4955                                 EXACT_REQ8     | EXACT
4956                                 EXACTFU         | EXACTFU
4957                                 EXACTFU_REQ8   | EXACTFU
4958                                 EXACTFUP        | EXACTFU
4959                                 EXACTFAA        | EXACTFAA
4960                                 EXACTL          | EXACTL
4961                                 EXACTFLU8       | EXACTFLU8
4962
4963
4964                         */
4965 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4966                        ? NOTHING                                            \
4967                        : ( EXACT == (X) || EXACT_REQ8 == (X) )             \
4968                          ? EXACT                                            \
4969                          : (     EXACTFU == (X)                             \
4970                               || EXACTFU_REQ8 == (X)                       \
4971                               || EXACTFUP == (X) )                          \
4972                            ? EXACTFU                                        \
4973                            : ( EXACTFAA == (X) )                            \
4974                              ? EXACTFAA                                     \
4975                              : ( EXACTL == (X) )                            \
4976                                ? EXACTL                                     \
4977                                : ( EXACTFLU8 == (X) )                       \
4978                                  ? EXACTFLU8                                \
4979                                  : 0 )
4980
4981                         /* dont use tail as the end marker for this traverse */
4982                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4983                             regnode * const noper = NEXTOPER( cur );
4984                             U8 noper_type = OP( noper );
4985                             U8 noper_trietype = TRIE_TYPE( noper_type );
4986 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4987                             regnode * const noper_next = regnext( noper );
4988                             U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
4989                             U8 noper_next_trietype = (noper_next && noper_next < tail) ? TRIE_TYPE( noper_next_type ) :0;
4990 #endif
4991
4992                             DEBUG_TRIE_COMPILE_r({
4993                                 regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4994                                 Perl_re_indentf( aTHX_  "- %d:%s (%d)",
4995                                    depth+1,
4996                                    REG_NODE_NUM(cur), SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4997
4998                                 regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4999                                 Perl_re_printf( aTHX_  " -> %d:%s",
5000                                     REG_NODE_NUM(noper), SvPV_nolen_const(RExC_mysv));
5001
5002                                 if ( noper_next ) {
5003                                   regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
5004                                   Perl_re_printf( aTHX_ "\t=> %d:%s\t",
5005                                     REG_NODE_NUM(noper_next), SvPV_nolen_const(RExC_mysv));
5006                                 }
5007                                 Perl_re_printf( aTHX_  "(First==%d,Last==%d,Cur==%d,tt==%s,ntt==%s,nntt==%s)\n",
5008                                    REG_NODE_NUM(first), REG_NODE_NUM(prev), REG_NODE_NUM(cur),
5009                                    PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
5010                                 );
5011                             });
5012
5013                             /* Is noper a trieable nodetype that can be merged
5014                              * with the current trie (if there is one)? */
5015                             if ( noper_trietype
5016                                   &&
5017                                   (
5018                                         ( noper_trietype == NOTHING )
5019                                         || ( trietype == NOTHING )
5020                                         || ( trietype == noper_trietype )
5021                                   )
5022 #ifdef NOJUMPTRIE
5023                                   && noper_next >= tail
5024 #endif
5025                                   && count < U16_MAX)
5026                             {
5027                                 /* Handle mergable triable node Either we are
5028                                  * the first node in a new trieable sequence,
5029                                  * in which case we do some bookkeeping,
5030                                  * otherwise we update the end pointer. */
5031                                 if ( !first ) {
5032                                     first = cur;
5033                                     if ( noper_trietype == NOTHING ) {
5034 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
5035                                         regnode * const noper_next = regnext( noper );
5036                                         U8 noper_next_type = (noper_next && noper_next < tail) ? OP(noper_next) : 0;
5037                                         U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
5038 #endif
5039
5040                                         if ( noper_next_trietype ) {
5041                                             trietype = noper_next_trietype;
5042                                         } else if (noper_next_type)  {
5043                                             /* a NOTHING regop is 1 regop wide.
5044                                              * We need at least two for a trie
5045                                              * so we can't merge this in */
5046                                             first = NULL;
5047                                         }
5048                                     } else {
5049                                         trietype = noper_trietype;
5050                                     }
5051                                 } else {
5052                                     if ( trietype == NOTHING )
5053                                         trietype = noper_trietype;
5054                                     prev = cur;
5055                                 }
5056                                 if (first)
5057                                     count++;
5058                             } /* end handle mergable triable node */
5059                             else {
5060                                 /* handle unmergable node -
5061                                  * noper may either be a triable node which can
5062                                  * not be tried together with the current trie,
5063                                  * or a non triable node */
5064                                 if ( prev ) {
5065                                     /* If last is set and trietype is not
5066                                      * NOTHING then we have found at least two
5067                                      * triable branch sequences in a row of a
5068                                      * similar trietype so we can turn them
5069                                      * into a trie. If/when we allow NOTHING to
5070                                      * start a trie sequence this condition
5071                                      * will be required, and it isn't expensive
5072                                      * so we leave it in for now. */
5073                                     if ( trietype && trietype != NOTHING )
5074                                         make_trie( pRExC_state,
5075                                                 startbranch, first, cur, tail,
5076                                                 count, trietype, depth+1 );
5077                                     prev = NULL; /* note: we clear/update
5078                                                     first, trietype etc below,
5079                                                     so we dont do it here */
5080                                 }
5081                                 if ( noper_trietype
5082 #ifdef NOJUMPTRIE
5083                                      && noper_next >= tail
5084 #endif
5085                                 ){
5086                                     /* noper is triable, so we can start a new
5087                                      * trie sequence */
5088                                     count = 1;
5089                                     first = cur;
5090                                     trietype = noper_trietype;
5091                                 } else if (first) {
5092                                     /* if we already saw a first but the
5093                                      * current node is not triable then we have
5094                                      * to reset the first information. */
5095                                     count = 0;
5096                                     first = NULL;
5097                                     trietype = 0;
5098                                 }
5099                             } /* end handle unmergable node */
5100                         } /* loop over branches */
5101                         DEBUG_TRIE_COMPILE_r({
5102                             regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5103                             Perl_re_indentf( aTHX_  "- %s (%d) <SCAN FINISHED> ",
5104                               depth+1, SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5105                             Perl_re_printf( aTHX_  "(First==%d, Last==%d, Cur==%d, tt==%s)\n",
5106                                REG_NODE_NUM(first), REG_NODE_NUM(prev), REG_NODE_NUM(cur),
5107                                PL_reg_name[trietype]
5108                             );
5109
5110                         });
5111                         if ( prev && trietype ) {
5112                             if ( trietype != NOTHING ) {
5113                                 /* the last branch of the sequence was part of
5114                                  * a trie, so we have to construct it here
5115                                  * outside of the loop */
5116                                 made= make_trie( pRExC_state, startbranch,
5117                                                  first, scan, tail, count,
5118                                                  trietype, depth+1 );
5119 #ifdef TRIE_STUDY_OPT
5120                                 if ( ((made == MADE_EXACT_TRIE &&
5121                                      startbranch == first)
5122                                      || ( first_non_open == first )) &&
5123                                      depth==0 ) {
5124                                     flags |= SCF_TRIE_RESTUDY;
5125                                     if ( startbranch == first
5126                                          && scan >= tail )
5127                                     {
5128                                         RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
5129                                     }
5130                                 }
5131 #endif
5132                             } else {
5133                                 /* at this point we know whatever we have is a
5134                                  * NOTHING sequence/branch AND if 'startbranch'
5135                                  * is 'first' then we can turn the whole thing
5136                                  * into a NOTHING
5137                                  */
5138                                 if ( startbranch == first ) {
5139                                     regnode *opt;
5140                                     /* the entire thing is a NOTHING sequence,
5141                                      * something like this: (?:|) So we can
5142                                      * turn it into a plain NOTHING op. */
5143                                     DEBUG_TRIE_COMPILE_r({
5144                                         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
5145                                         Perl_re_indentf( aTHX_  "- %s (%d) <NOTHING BRANCH SEQUENCE>\n",
5146                                           depth+1,
5147                                           SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur));
5148
5149                                     });
5150                                     OP(startbranch)= NOTHING;
5151                                     NEXT_OFF(startbranch)= tail - startbranch;
5152                                     for ( opt= startbranch + 1; opt < tail ; opt++ )
5153                                         OP(opt)= OPTIMIZED;
5154                                 }
5155                             }
5156                         } /* end if ( prev) */
5157                     } /* TRIE_MAXBUF is non zero */
5158                 } /* do trie */
5159
5160             }
5161             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
5162                 scan = NEXTOPER(NEXTOPER(scan));
5163             } else                      /* single branch is optimized. */
5164                 scan = NEXTOPER(scan);
5165             continue;
5166         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB) {
5167             I32 paren = 0;
5168             regnode *start = NULL;
5169             regnode *end = NULL;
5170             U32 my_recursed_depth= recursed_depth;
5171
5172             if (OP(scan) != SUSPEND) { /* GOSUB */
5173                 /* Do setup, note this code has side effects beyond
5174                  * the rest of this block. Specifically setting
5175                  * RExC_recurse[] must happen at least once during
5176                  * study_chunk(). */
5177                 paren = ARG(scan);
5178                 RExC_recurse[ARG2L(scan)] = scan;
5179                 start = REGNODE_p(RExC_open_parens[paren]);
5180                 end   = REGNODE_p(RExC_close_parens[paren]);
5181
5182                 /* NOTE we MUST always execute the above code, even
5183                  * if we do nothing with a GOSUB */
5184                 if (
5185                     ( flags & SCF_IN_DEFINE )
5186                     ||
5187                     (
5188                         (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
5189                         &&
5190                         ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
5191                     )
5192                 ) {
5193                     /* no need to do anything here if we are in a define. */
5194                     /* or we are after some kind of infinite construct
5195                      * so we can skip recursing into this item.
5196                      * Since it is infinite we will not change the maxlen
5197                      * or delta, and if we miss something that might raise
5198                      * the minlen it will merely pessimise a little.
5199                      *
5200                      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
5201                      * might result in a minlen of 1 and not of 4,
5202                      * but this doesn't make us mismatch, just try a bit
5203                      * harder than we should.
5204                      *
5205                      * However we must assume this GOSUB is infinite, to
5206                      * avoid wrongly applying other optimizations in the
5207                      * enclosing scope - see GH 18096, for example.
5208                      */
5209                     is_inf = is_inf_internal = 1;
5210                     scan= regnext(scan);
5211                     continue;
5212                 }
5213
5214                 if (
5215                     !recursed_depth
5216                     || !PAREN_TEST(recursed_depth - 1, paren)
5217                 ) {
5218                     /* it is quite possible that there are more efficient ways
5219                      * to do this. We maintain a bitmap per level of recursion
5220                      * of which patterns we have entered so we can detect if a
5221                      * pattern creates a possible infinite loop. When we
5222                      * recurse down a level we copy the previous levels bitmap
5223                      * down. When we are at recursion level 0 we zero the top
5224                      * level bitmap. It would be nice to implement a different
5225                      * more efficient way of doing this. In particular the top
5226                      * level bitmap may be unnecessary.
5227                      */
5228                     if (!recursed_depth) {
5229                         Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
5230                     } else {
5231                         Copy(PAREN_OFFSET(recursed_depth - 1),
5232                              PAREN_OFFSET(recursed_depth),
5233                              RExC_study_chunk_recursed_bytes, U8);
5234                     }
5235                     /* we havent recursed into this paren yet, so recurse into it */
5236                     DEBUG_STUDYDATA("gosub-set", data, depth, is_inf);
5237                     PAREN_SET(recursed_depth, paren);
5238                     my_recursed_depth= recursed_depth + 1;
5239                 } else {
5240                     DEBUG_STUDYDATA("gosub-inf", data, depth, is_inf);
5241                     /* some form of infinite recursion, assume infinite length
5242                      * */
5243                     if (flags & SCF_DO_SUBSTR) {
5244                         scan_commit(pRExC_state, data, minlenp, is_inf);
5245                         data->cur_is_floating = 1;
5246                     }
5247                     is_inf = is_inf_internal = 1;
5248                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5249                         ssc_anything(data->start_class);
5250                     flags &= ~SCF_DO_STCLASS;
5251
5252                     start= NULL; /* reset start so we dont recurse later on. */
5253                 }
5254             } else {
5255                 paren = stopparen;
5256                 start = scan + 2;
5257                 end = regnext(scan);
5258             }
5259             if (start) {
5260                 scan_frame *newframe;
5261                 assert(end);
5262                 if (!RExC_frame_last) {
5263                     Newxz(newframe, 1, scan_frame);
5264                     SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
5265                     RExC_frame_head= newframe;
5266                     RExC_frame_count++;
5267                 } else if (!RExC_frame_last->next_frame) {
5268                     Newxz(newframe, 1, scan_frame);
5269                     RExC_frame_last->next_frame= newframe;
5270                     newframe->prev_frame= RExC_frame_last;
5271                     RExC_frame_count++;
5272                 } else {
5273                     newframe= RExC_frame_last->next_frame;
5274                 }
5275                 RExC_frame_last= newframe;
5276
5277                 newframe->next_regnode = regnext(scan);
5278                 newframe->last_regnode = last;
5279                 newframe->stopparen = stopparen;
5280                 newframe->prev_recursed_depth = recursed_depth;
5281                 newframe->this_prev_frame= frame;
5282                 newframe->in_gosub = (
5283                     (frame && frame->in_gosub) || OP(scan) == GOSUB
5284                 );
5285
5286                 DEBUG_STUDYDATA("frame-new", data, depth, is_inf);
5287                 DEBUG_PEEP("fnew", scan, depth, flags);
5288
5289                 frame = newframe;
5290                 scan =  start;
5291                 stopparen = paren;
5292                 last = end;
5293                 depth = depth + 1;
5294                 recursed_depth= my_recursed_depth;
5295
5296                 continue;
5297             }
5298         }
5299         else if (PL_regkind[OP(scan)] == EXACT && ! isEXACTFish(OP(scan))) {
5300             SSize_t bytelen = STR_LEN(scan), charlen;
5301             UV uc;
5302             assert(bytelen);
5303             if (UTF) {
5304                 const U8 * const s = (U8*)STRING(scan);
5305                 uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
5306                 charlen = utf8_length(s, s + bytelen);
5307             } else {
5308                 uc = *((U8*)STRING(scan));
5309                 charlen = bytelen;
5310             }
5311             min += charlen;
5312             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
5313                 /* The code below prefers earlier match for fixed
5314                    offset, later match for variable offset.  */
5315                 if (data->last_end == -1) { /* Update the start info. */
5316                     data->last_start_min = data->pos_min;
5317                     data->last_start_max =
5318                         is_inf ? OPTIMIZE_INFTY
5319                         : (data->pos_delta > OPTIMIZE_INFTY - data->pos_min)
5320                             ? OPTIMIZE_INFTY : data->pos_min + data->pos_delta;
5321                 }
5322                 sv_catpvn(data->last_found, STRING(scan), bytelen);
5323                 if (UTF)
5324                     SvUTF8_on(data->last_found);
5325                 {
5326                     SV * const sv = data->last_found;
5327                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5328                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5329                     if (mg && mg->mg_len >= 0)
5330                         mg->mg_len += charlen;
5331                 }
5332                 data->last_end = data->pos_min + charlen;
5333                 data->pos_min += charlen; /* As in the first entry. */
5334                 data->flags &= ~SF_BEFORE_EOL;
5335             }
5336
5337             /* ANDing the code point leaves at most it, and not in locale, and
5338              * can't match null string */
5339             if (flags & SCF_DO_STCLASS_AND) {
5340                 ssc_cp_and(data->start_class, uc);
5341                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5342                 ssc_clear_locale(data->start_class);
5343             }
5344             else if (flags & SCF_DO_STCLASS_OR) {
5345                 ssc_add_cp(data->start_class, uc);
5346                 ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5347
5348                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5349                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5350             }
5351             flags &= ~SCF_DO_STCLASS;
5352         }
5353         else if (PL_regkind[OP(scan)] == EXACT) {
5354             /* But OP != EXACT!, so is EXACTFish */
5355             SSize_t bytelen = STR_LEN(scan), charlen;
5356             const U8 * s = (U8*)STRING(scan);
5357
5358             /* Replace a length 1 ASCII fold pair node with an ANYOFM node,
5359              * with the mask set to the complement of the bit that differs
5360              * between upper and lower case, and the lowest code point of the
5361              * pair (which the '&' forces) */
5362             if (     bytelen == 1
5363                 &&   isALPHA_A(*s)
5364                 &&  (         OP(scan) == EXACTFAA
5365                      || (     OP(scan) == EXACTFU
5366                          && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(*s)))
5367                 &&   mutate_ok
5368             ) {
5369                 U8 mask = ~ ('A' ^ 'a'); /* These differ in just one bit */
5370
5371                 OP(scan) = ANYOFM;
5372                 ARG_SET(scan, *s & mask);
5373                 FLAGS(scan) = mask;
5374                 /* we're not EXACTFish any more, so restudy */
5375                 continue;
5376             }
5377
5378             /* Search for fixed substrings supports EXACT only. */
5379             if (flags & SCF_DO_SUBSTR) {
5380                 assert(data);
5381                 scan_commit(pRExC_state, data, minlenp, is_inf);
5382             }
5383             charlen = UTF ? (SSize_t) utf8_length(s, s + bytelen) : bytelen;
5384             if (unfolded_multi_char) {
5385                 RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
5386             }
5387             min += charlen - min_subtract;
5388             assert (min >= 0);
5389             if ((SSize_t)min_subtract < OPTIMIZE_INFTY
5390                 && delta < OPTIMIZE_INFTY - (SSize_t)min_subtract
5391             ) {
5392                 delta += min_subtract;
5393             } else {
5394                 delta = OPTIMIZE_INFTY;
5395             }
5396             if (flags & SCF_DO_SUBSTR) {
5397                 data->pos_min += charlen - min_subtract;
5398                 if (data->pos_min < 0) {
5399                     data->pos_min = 0;
5400                 }
5401                 if ((SSize_t)min_subtract < OPTIMIZE_INFTY
5402                     && data->pos_delta < OPTIMIZE_INFTY - (SSize_t)min_subtract
5403                 ) {
5404                     data->pos_delta += min_subtract;
5405                 } else {
5406                     data->pos_delta = OPTIMIZE_INFTY;
5407                 }
5408                 if (min_subtract) {
5409                     data->cur_is_floating = 1; /* float */
5410                 }
5411             }
5412
5413             if (flags & SCF_DO_STCLASS) {
5414                 SV* EXACTF_invlist = make_exactf_invlist(pRExC_state, scan);
5415
5416                 assert(EXACTF_invlist);
5417                 if (flags & SCF_DO_STCLASS_AND) {
5418                     if (OP(scan) != EXACTFL)
5419                         ssc_clear_locale(data->start_class);
5420                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5421                     ANYOF_POSIXL_ZERO(data->start_class);
5422                     ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
5423                 }
5424                 else {  /* SCF_DO_STCLASS_OR */
5425                     ssc_union(data->start_class, EXACTF_invlist, FALSE);
5426                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5427
5428                     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5429                     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5430                 }
5431                 flags &= ~SCF_DO_STCLASS;
5432                 SvREFCNT_dec(EXACTF_invlist);
5433             }
5434         }
5435         else if (REGNODE_VARIES(OP(scan))) {
5436             SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
5437             I32 fl = 0, f = flags;
5438             regnode * const oscan = scan;
5439             regnode_ssc this_class;
5440             regnode_ssc *oclass = NULL;
5441             I32 next_is_eval = 0;
5442
5443             switch (PL_regkind[OP(scan)]) {
5444             case WHILEM:                /* End of (?:...)* . */
5445                 scan = NEXTOPER(scan);
5446                 goto finish;
5447             case PLUS:
5448                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
5449                     next = NEXTOPER(scan);
5450                     if (   (     PL_regkind[OP(next)] == EXACT
5451                             && ! isEXACTFish(OP(next)))
5452                         || (flags & SCF_DO_STCLASS))
5453                     {
5454                         mincount = 1;
5455                         maxcount = REG_INFTY;
5456                         next = regnext(scan);
5457                         scan = NEXTOPER(scan);
5458                         goto do_curly;
5459                     }
5460                 }
5461                 if (flags & SCF_DO_SUBSTR)
5462                     data->pos_min++;
5463                 /* This will bypass the formal 'min += minnext * mincount'
5464                  * calculation in the do_curly path, so assumes min width
5465                  * of the PLUS payload is exactly one. */
5466                 min++;
5467                 /* FALLTHROUGH */
5468             case STAR:
5469                 next = NEXTOPER(scan);
5470
5471                 /* This temporary node can now be turned into EXACTFU, and
5472                  * must, as regexec.c doesn't handle it */
5473                 if (OP(next) == EXACTFU_S_EDGE && mutate_ok) {
5474                     OP(next) = EXACTFU;
5475                 }
5476
5477                 if (     STR_LEN(next) == 1
5478                     &&   isALPHA_A(* STRING(next))
5479                     && (         OP(next) == EXACTFAA
5480                         || (     OP(next) == EXACTFU
5481                             && ! HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(* STRING(next))))
5482                     &&   mutate_ok
5483                 ) {
5484                     /* These differ in just one bit */
5485                     U8 mask = ~ ('A' ^ 'a');
5486
5487                     assert(isALPHA_A(* STRING(next)));
5488
5489                     /* Then replace it by an ANYOFM node, with
5490                     * the mask set to the complement of the
5491                     * bit that differs between upper and lower
5492                     * case, and the lowest code point of the
5493                     * pair (which the '&' forces) */
5494                     OP(next) = ANYOFM;
5495                     ARG_SET(next, *STRING(next) & mask);
5496                     FLAGS(next) = mask;
5497                 }
5498
5499                 if (flags & SCF_DO_STCLASS) {
5500                     mincount = 0;
5501                     maxcount = REG_INFTY;
5502                     next = regnext(scan);
5503                     scan = NEXTOPER(scan);
5504                     goto do_curly;
5505                 }
5506                 if (flags & SCF_DO_SUBSTR) {
5507                     scan_commit(pRExC_state, data, minlenp, is_inf);
5508                     /* Cannot extend fixed substrings */
5509                     data->cur_is_floating = 1; /* float */
5510                 }
5511                 is_inf = is_inf_internal = 1;
5512                 scan = regnext(scan);
5513                 goto optimize_curly_tail;
5514             case CURLY:
5515                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
5516                     && (scan->flags == stopparen))
5517                 {
5518                     mincount = 1;
5519                     maxcount = 1;
5520                 } else {
5521                     mincount = ARG1(scan);
5522                     maxcount = ARG2(scan);
5523                 }
5524                 next = regnext(scan);
5525                 if (OP(scan) == CURLYX) {
5526                     I32 lp = (data ? *(data->last_closep) : 0);
5527                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
5528                 }
5529                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
5530                 next_is_eval = (OP(scan) == EVAL);
5531               do_curly:
5532                 if (flags & SCF_DO_SUBSTR) {
5533                     if (mincount == 0)
5534                         scan_commit(pRExC_state, data, minlenp, is_inf);
5535                     /* Cannot extend fixed substrings */
5536                     pos_before = data->pos_min;
5537                 }
5538                 if (data) {
5539                     fl = data->flags;
5540                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
5541                     if (is_inf)
5542                         data->flags |= SF_IS_INF;
5543                 }
5544                 if (flags & SCF_DO_STCLASS) {
5545                     ssc_init(pRExC_state, &this_class);
5546                     oclass = data->start_class;
5547                     data->start_class = &this_class;
5548                     f |= SCF_DO_STCLASS_AND;
5549                     f &= ~SCF_DO_STCLASS_OR;
5550                 }
5551                 /* Exclude from super-linear cache processing any {n,m}
5552                    regops for which the combination of input pos and regex
5553                    pos is not enough information to determine if a match
5554                    will be possible.
5555
5556                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
5557                    regex pos at the \s*, the prospects for a match depend not
5558                    only on the input position but also on how many (bar\s*)
5559                    repeats into the {4,8} we are. */
5560                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
5561                     f &= ~SCF_WHILEM_VISITED_POS;
5562
5563                 /* This will finish on WHILEM, setting scan, or on NULL: */
5564                 /* recurse study_chunk() on loop bodies */
5565                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
5566                                   last, data, stopparen, recursed_depth, NULL,
5567                                   (mincount == 0
5568                                    ? (f & ~SCF_DO_SUBSTR)
5569                                    : f)
5570                                   , depth+1, mutate_ok);
5571
5572                 if (flags & SCF_DO_STCLASS)
5573                     data->start_class = oclass;
5574                 if (mincount == 0 || minnext == 0) {
5575                     if (flags & SCF_DO_STCLASS_OR) {
5576                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5577                     }
5578                     else if (flags & SCF_DO_STCLASS_AND) {
5579                         /* Switch to OR mode: cache the old value of
5580                          * data->start_class */
5581                         INIT_AND_WITHP;
5582                         StructCopy(data->start_class, and_withp, regnode_ssc);
5583                         flags &= ~SCF_DO_STCLASS_AND;
5584                         StructCopy(&this_class, data->start_class, regnode_ssc);
5585                         flags |= SCF_DO_STCLASS_OR;
5586                         ANYOF_FLAGS(data->start_class)
5587                                                 |= SSC_MATCHES_EMPTY_STRING;
5588                     }
5589                 } else {                /* Non-zero len */
5590                     if (flags & SCF_DO_STCLASS_OR) {
5591                         ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5592                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5593                     }
5594                     else if (flags & SCF_DO_STCLASS_AND)
5595                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
5596                     flags &= ~SCF_DO_STCLASS;
5597                 }
5598                 if (!scan)              /* It was not CURLYX, but CURLY. */
5599                     scan = next;
5600                 if (((flags & (SCF_TRIE_DOING_RESTUDY|SCF_DO_SUBSTR))==SCF_DO_SUBSTR)
5601                     /* ? quantifier ok, except for (?{ ... }) */
5602                     && (next_is_eval || !(mincount == 0 && maxcount == 1))
5603                     && (minnext == 0) && (deltanext == 0)
5604                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
5605                     && maxcount <= REG_INFTY/3) /* Complement check for big
5606                                                    count */
5607                 {
5608                     _WARN_HELPER(RExC_precomp_end, packWARN(WARN_REGEXP),
5609                         Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
5610                             "Quantifier unexpected on zero-length expression "
5611                             "in regex m/%" UTF8f "/",
5612                              UTF8fARG(UTF, RExC_precomp_end - RExC_precomp,
5613                                   RExC_precomp)));
5614                 }
5615
5616                 if ( ( minnext > 0 && mincount >= SSize_t_MAX / minnext )
5617                     || min >= SSize_t_MAX - minnext * mincount )
5618                 {
5619                     FAIL("Regexp out of space");
5620                 }
5621
5622                 min += minnext * mincount;
5623                 is_inf_internal |= deltanext == OPTIMIZE_INFTY
5624                          || (maxcount == REG_INFTY && minnext + deltanext > 0);
5625                 is_inf |= is_inf_internal;
5626                 if (is_inf) {
5627                     delta = OPTIMIZE_INFTY;
5628                 } else {
5629                     delta += (minnext + deltanext) * maxcount
5630                              - minnext * mincount;
5631                 }
5632                 /* Try powerful optimization CURLYX => CURLYN. */
5633                 if (  OP(oscan) == CURLYX && data
5634                       && data->flags & SF_IN_PAR
5635                       && !(data->flags & SF_HAS_EVAL)
5636                       && !deltanext && minnext == 1
5637                       && mutate_ok
5638                 ) {
5639                     /* Try to optimize to CURLYN.  */
5640                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
5641                     regnode * const nxt1 = nxt;
5642 #ifdef DEBUGGING
5643                     regnode *nxt2;
5644 #endif
5645
5646                     /* Skip open. */
5647                     nxt = regnext(nxt);
5648                     if (!REGNODE_SIMPLE(OP(nxt))
5649                         && !(PL_regkind[OP(nxt)] == EXACT
5650                              && STR_LEN(nxt) == 1))
5651                         goto nogo;
5652 #ifdef DEBUGGING
5653                     nxt2 = nxt;
5654 #endif
5655                     nxt = regnext(nxt);
5656                     if (OP(nxt) != CLOSE)
5657                         goto nogo;
5658                     if (RExC_open_parens) {
5659
5660                         /*open->CURLYM*/
5661                         RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5662
5663                         /*close->while*/
5664                         RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt) + 2;
5665                     }
5666                     /* Now we know that nxt2 is the only contents: */
5667                     oscan->flags = (U8)ARG(nxt);
5668                     OP(oscan) = CURLYN;
5669                     OP(nxt1) = NOTHING; /* was OPEN. */
5670
5671 #ifdef DEBUGGING
5672                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5673                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
5674                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
5675                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
5676                     OP(nxt + 1) = OPTIMIZED; /* was count. */
5677                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
5678 #endif
5679                 }
5680               nogo:
5681
5682                 /* Try optimization CURLYX => CURLYM. */
5683                 if (  OP(oscan) == CURLYX && data
5684                       && !(data->flags & SF_HAS_PAR)
5685                       && !(data->flags & SF_HAS_EVAL)
5686                       && !deltanext     /* atom is fixed width */
5687                       && minnext != 0   /* CURLYM can't handle zero width */
5688                          /* Nor characters whose fold at run-time may be
5689                           * multi-character */
5690                       && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
5691                       && mutate_ok
5692                 ) {
5693                     /* XXXX How to optimize if data == 0? */
5694                     /* Optimize to a simpler form.  */
5695                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
5696                     regnode *nxt2;
5697
5698                     OP(oscan) = CURLYM;
5699                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
5700                             && (OP(nxt2) != WHILEM))
5701                         nxt = nxt2;
5702                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
5703                     /* Need to optimize away parenths. */
5704                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
5705                         /* Set the parenth number.  */
5706                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
5707
5708                         oscan->flags = (U8)ARG(nxt);
5709                         if (RExC_open_parens) {
5710                              /*open->CURLYM*/
5711                             RExC_open_parens[ARG(nxt1)] = REGNODE_OFFSET(oscan);
5712
5713                             /*close->NOTHING*/
5714                             RExC_close_parens[ARG(nxt1)] = REGNODE_OFFSET(nxt2)
5715                                                          + 1;
5716                         }
5717                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
5718                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
5719
5720 #ifdef DEBUGGING
5721                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
5722                         OP(nxt + 1) = OPTIMIZED; /* was count. */
5723                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
5724                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
5725 #endif
5726 #if 0
5727                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
5728                             regnode *nnxt = regnext(nxt1);
5729                             if (nnxt == nxt) {
5730                                 if (reg_off_by_arg[OP(nxt1)])
5731                                     ARG_SET(nxt1, nxt2 - nxt1);
5732                                 else if (nxt2 - nxt1 < U16_MAX)
5733                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
5734                                 else
5735                                     OP(nxt) = NOTHING;  /* Cannot beautify */
5736                             }
5737                             nxt1 = nnxt;
5738                         }
5739 #endif
5740                         /* Optimize again: */
5741                         /* recurse study_chunk() on optimised CURLYX => CURLYM */
5742                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
5743                                     NULL, stopparen, recursed_depth, NULL, 0,
5744                                     depth+1, mutate_ok);
5745                     }
5746                     else
5747                         oscan->flags = 0;
5748                 }
5749                 else if ((OP(oscan) == CURLYX)
5750                          && (flags & SCF_WHILEM_VISITED_POS)
5751                          /* See the comment on a similar expression above.
5752                             However, this time it's not a subexpression
5753                             we care about, but the expression itself. */
5754                          && (maxcount == REG_INFTY)
5755                          && data) {
5756                     /* This stays as CURLYX, we can put the count/of pair. */
5757                     /* Find WHILEM (as in regexec.c) */
5758                     regnode *nxt = oscan + NEXT_OFF(oscan);
5759
5760                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
5761                         nxt += ARG(nxt);
5762                     nxt = PREVOPER(nxt);
5763                     if (nxt->flags & 0xf) {
5764                         /* we've already set whilem count on this node */
5765                     } else if (++data->whilem_c < 16) {
5766                         assert(data->whilem_c <= RExC_whilem_seen);
5767                         nxt->flags = (U8)(data->whilem_c
5768                             | (RExC_whilem_seen << 4)); /* On WHILEM */
5769                     }
5770                 }
5771                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
5772                     pars++;
5773                 if (flags & SCF_DO_SUBSTR) {
5774                     SV *last_str = NULL;
5775                     STRLEN last_chrs = 0;
5776                     int counted = mincount != 0;
5777
5778                     if (data->last_end > 0 && mincount != 0) { /* Ends with a
5779                                                                   string. */
5780                         SSize_t b = pos_before >= data->last_start_min
5781                             ? pos_before : data->last_start_min;
5782                         STRLEN l;
5783                         const char * const s = SvPV_const(data->last_found, l);
5784                         SSize_t old = b - data->last_start_min;
5785                         assert(old >= 0);
5786
5787                         if (UTF)
5788                             old = utf8_hop_forward((U8*)s, old,
5789                                                (U8 *) SvEND(data->last_found))
5790                                 - (U8*)s;
5791                         l -= old;
5792                         /* Get the added string: */
5793                         last_str = newSVpvn_utf8(s  + old, l, UTF);
5794                         last_chrs = UTF ? utf8_length((U8*)(s + old),
5795                                             (U8*)(s + old + l)) : l;
5796                         if (deltanext == 0 && pos_before == b) {
5797                             /* What was added is a constant string */
5798                             if (mincount > 1) {
5799
5800                                 SvGROW(last_str, (mincount * l) + 1);
5801                                 repeatcpy(SvPVX(last_str) + l,
5802                                           SvPVX_const(last_str), l,
5803                                           mincount - 1);
5804                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
5805                                 /* Add additional parts. */
5806                                 SvCUR_set(data->last_found,
5807                                           SvCUR(data->last_found) - l);
5808                                 sv_catsv(data->last_found, last_str);
5809                                 {
5810                                     SV * sv = data->last_found;
5811                                     MAGIC *mg =
5812                                         SvUTF8(sv) && SvMAGICAL(sv) ?
5813                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
5814                                     if (mg && mg->mg_len >= 0)
5815                                         mg->mg_len += last_chrs * (mincount-1);
5816                                 }
5817                                 last_chrs *= mincount;
5818                                 data->last_end += l * (mincount - 1);
5819                             }
5820                         } else {
5821                             /* start offset must point into the last copy */
5822                             data->last_start_min += minnext * (mincount - 1);
5823                             data->last_start_max =
5824                               is_inf
5825                                ? OPTIMIZE_INFTY
5826                                : data->last_start_max +
5827                                  (maxcount - 1) * (minnext + data->pos_delta);
5828                         }
5829                     }
5830                     /* It is counted once already... */
5831                     data->pos_min += minnext * (mincount - counted);
5832 #if 0
5833 Perl_re_printf( aTHX_  "counted=%" UVuf " deltanext=%" UVuf
5834                               " OPTIMIZE_INFTY=%" UVuf " minnext=%" UVuf
5835                               " maxcount=%" UVuf " mincount=%" UVuf
5836                               " data->pos_delta=%" UVuf "\n",
5837     (UV)counted, (UV)deltanext, (UV)OPTIMIZE_INFTY, (UV)minnext, (UV)maxcount,
5838     (UV)mincount, (UV)data->pos_delta);
5839 if (deltanext != OPTIMIZE_INFTY)
5840 Perl_re_printf( aTHX_  "LHS=%" UVuf " RHS=%" UVuf "\n",
5841     (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
5842           - minnext * mincount), (UV)(OPTIMIZE_INFTY - data->pos_delta));
5843 #endif
5844                     if (deltanext == OPTIMIZE_INFTY
5845                         || data->pos_delta == OPTIMIZE_INFTY
5846                         || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= OPTIMIZE_INFTY - data->pos_delta)
5847                         data->pos_delta = OPTIMIZE_INFTY;
5848                     else
5849                         data->pos_delta += - counted * deltanext +
5850                         (minnext + deltanext) * maxcount - minnext * mincount;
5851                     if (mincount != maxcount) {
5852                          /* Cannot extend fixed substrings found inside
5853                             the group.  */
5854                         scan_commit(pRExC_state, data, minlenp, is_inf);
5855                         if (mincount && last_str) {
5856                             SV * const sv = data->last_found;
5857                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
5858                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
5859
5860                             if (mg)
5861                                 mg->mg_len = -1;
5862                             sv_setsv(sv, last_str);
5863                             data->last_end = data->pos_min;
5864                             data->last_start_min = data->pos_min - last_chrs;
5865                             data->last_start_max = is_inf
5866                                 ? OPTIMIZE_INFTY
5867                                 : data->pos_min + data->pos_delta - last_chrs;
5868                         }
5869                         data->cur_is_floating = 1; /* float */
5870                     }
5871                     SvREFCNT_dec(last_str);
5872                 }
5873                 if (data && (fl & SF_HAS_EVAL))
5874                     data->flags |= SF_HAS_EVAL;
5875               optimize_curly_tail:
5876                 rck_elide_nothing(oscan);
5877                 continue;
5878
5879             default:
5880                 Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
5881                                                                     OP(scan));
5882             case REF:
5883             case CLUMP:
5884                 if (flags & SCF_DO_SUBSTR) {
5885                     /* Cannot expect anything... */
5886                     scan_commit(pRExC_state, data, minlenp, is_inf);
5887                     data->cur_is_floating = 1; /* float */
5888                 }
5889                 is_inf = is_inf_internal = 1;
5890                 if (flags & SCF_DO_STCLASS_OR) {
5891                     if (OP(scan) == CLUMP) {
5892                         /* Actually is any start char, but very few code points
5893                          * aren't start characters */
5894                         ssc_match_all_cp(data->start_class);
5895                     }
5896                     else {
5897                         ssc_anything(data->start_class);
5898                     }
5899                 }
5900                 flags &= ~SCF_DO_STCLASS;
5901                 break;
5902             }
5903         }
5904         else if (OP(scan) == LNBREAK) {
5905             if (flags & SCF_DO_STCLASS) {
5906                 if (flags & SCF_DO_STCLASS_AND) {
5907                     ssc_intersection(data->start_class,
5908                                     PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5909                     ssc_clear_locale(data->start_class);
5910                     ANYOF_FLAGS(data->start_class)
5911                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5912                 }
5913                 else if (flags & SCF_DO_STCLASS_OR) {
5914                     ssc_union(data->start_class,
5915                               PL_XPosix_ptrs[_CC_VERTSPACE],
5916                               FALSE);
5917                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5918
5919                     /* See commit msg for
5920                      * 749e076fceedeb708a624933726e7989f2302f6a */
5921                     ANYOF_FLAGS(data->start_class)
5922                                                 &= ~SSC_MATCHES_EMPTY_STRING;
5923                 }
5924                 flags &= ~SCF_DO_STCLASS;
5925             }
5926             min++;
5927             if (delta != OPTIMIZE_INFTY)
5928                 delta++;    /* Because of the 2 char string cr-lf */
5929             if (flags & SCF_DO_SUBSTR) {
5930                 /* Cannot expect anything... */
5931                 scan_commit(pRExC_state, data, minlenp, is_inf);
5932                 data->pos_min += 1;
5933                 if (data->pos_delta != OPTIMIZE_INFTY) {
5934                     data->pos_delta += 1;
5935                 }
5936                 data->cur_is_floating = 1; /* float */
5937             }
5938         }
5939         else if (REGNODE_SIMPLE(OP(scan))) {
5940
5941             if (flags & SCF_DO_SUBSTR) {
5942                 scan_commit(pRExC_state, data, minlenp, is_inf);
5943                 data->pos_min++;
5944             }
5945             min++;
5946             if (flags & SCF_DO_STCLASS) {
5947                 bool invert = 0;
5948                 SV* my_invlist = NULL;
5949                 U8 namedclass;
5950
5951                 /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5952                 ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5953
5954                 /* Some of the logic below assumes that switching
5955                    locale on will only add false positives. */
5956                 switch (OP(scan)) {
5957
5958                 default:
5959 #ifdef DEBUGGING
5960                    Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5961                                                                      OP(scan));
5962 #endif
5963                 case SANY:
5964                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5965                         ssc_match_all_cp(data->start_class);
5966                     break;
5967
5968                 case REG_ANY:
5969                     {
5970                         SV* REG_ANY_invlist = _new_invlist(2);
5971                         REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5972                                                             '\n');
5973                         if (flags & SCF_DO_STCLASS_OR) {
5974                             ssc_union(data->start_class,
5975                                       REG_ANY_invlist,
5976                                       TRUE /* TRUE => invert, hence all but \n
5977                                             */
5978                                       );
5979                         }
5980                         else if (flags & SCF_DO_STCLASS_AND) {
5981                             ssc_intersection(data->start_class,
5982                                              REG_ANY_invlist,
5983                                              TRUE  /* TRUE => invert */
5984                                              );
5985                             ssc_clear_locale(data->start_class);
5986                         }
5987                         SvREFCNT_dec_NN(REG_ANY_invlist);
5988                     }
5989                     break;
5990
5991                 case ANYOFD:
5992                 case ANYOFL:
5993                 case ANYOFPOSIXL:
5994                 case ANYOFH:
5995                 case ANYOFHb:
5996                 case ANYOFHr:
5997                 case ANYOFHs:
5998                 case ANYOF:
5999                     if (flags & SCF_DO_STCLASS_AND)
6000                         ssc_and(pRExC_state, data->start_class,
6001                                 (regnode_charclass *) scan);
6002                     else
6003                         ssc_or(pRExC_state, data->start_class,
6004                                                           (regnode_charclass *) scan);
6005                     break;
6006
6007                 case NANYOFM: /* NANYOFM already contains the inversion of the
6008                                  input ANYOF data, so, unlike things like
6009                                  NPOSIXA, don't change 'invert' to TRUE */
6010                     /* FALLTHROUGH */
6011                 case ANYOFM:
6012                   {
6013                     SV* cp_list = get_ANYOFM_contents(scan);
6014
6015                     if (flags & SCF_DO_STCLASS_OR) {
6016                         ssc_union(data->start_class, cp_list, invert);
6017                     }
6018                     else if (flags & SCF_DO_STCLASS_AND) {
6019                         ssc_intersection(data->start_class, cp_list, invert);
6020                     }
6021
6022                     SvREFCNT_dec_NN(cp_list);
6023                     break;
6024                   }
6025
6026                 case ANYOFR:
6027                 case ANYOFRb:
6028                   {
6029                     SV* cp_list = NULL;
6030
6031                     cp_list = _add_range_to_invlist(cp_list,
6032                                         ANYOFRbase(scan),
6033                                         ANYOFRbase(scan) + ANYOFRdelta(scan));
6034
6035                     if (flags & SCF_DO_STCLASS_OR) {
6036                         ssc_union(data->start_class, cp_list, invert);
6037                     }
6038                     else if (flags & SCF_DO_STCLASS_AND) {
6039                         ssc_intersection(data->start_class, cp_list, invert);
6040                     }
6041
6042                     SvREFCNT_dec_NN(cp_list);
6043                     break;
6044                   }
6045
6046                 case NPOSIXL:
6047                     invert = 1;
6048                     /* FALLTHROUGH */
6049
6050                 case POSIXL:
6051                     namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
6052                     if (flags & SCF_DO_STCLASS_AND) {
6053                         bool was_there = cBOOL(
6054                                           ANYOF_POSIXL_TEST(data->start_class,
6055                                                                  namedclass));
6056                         ANYOF_POSIXL_ZERO(data->start_class);
6057                         if (was_there) {    /* Do an AND */
6058                             ANYOF_POSIXL_SET(data->start_class, namedclass);
6059                         }
6060                         /* No individual code points can now match */
6061                         data->start_class->invlist
6062                                                 = sv_2mortal(_new_invlist(0));
6063                     }
6064                     else {
6065                         int complement = namedclass + ((invert) ? -1 : 1);
6066
6067                         assert(flags & SCF_DO_STCLASS_OR);
6068
6069                         /* If the complement of this class was already there,
6070                          * the result is that they match all code points,
6071                          * (\d + \D == everything).  Remove the classes from
6072                          * future consideration.  Locale is not relevant in
6073                          * this case */
6074                         if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
6075                             ssc_match_all_cp(data->start_class);
6076                             ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
6077                             ANYOF_POSIXL_CLEAR(data->start_class, complement);
6078                         }
6079                         else {  /* The usual case; just add this class to the
6080                                    existing set */
6081                             ANYOF_POSIXL_SET(data->start_class, namedclass);
6082                         }
6083                     }
6084                     break;
6085
6086                 case NPOSIXA:   /* For these, we always know the exact set of
6087                                    what's matched */
6088                     invert = 1;
6089                     /* FALLTHROUGH */
6090                 case POSIXA:
6091                     my_invlist = invlist_clone(PL_Posix_ptrs[FLAGS(scan)], NULL);
6092                     goto join_posix_and_ascii;
6093
6094                 case NPOSIXD:
6095                 case NPOSIXU:
6096                     invert = 1;
6097                     /* FALLTHROUGH */
6098                 case POSIXD:
6099                 case POSIXU:
6100                     my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)], NULL);
6101
6102                     /* NPOSIXD matches all upper Latin1 code points unless the
6103                      * target string being matched is UTF-8, which is
6104                      * unknowable until match time.  Since we are going to
6105                      * invert, we want to get rid of all of them so that the
6106                      * inversion will match all */
6107                     if (OP(scan) == NPOSIXD) {
6108                         _invlist_subtract(my_invlist, PL_UpperLatin1,
6109                                           &my_invlist);
6110                     }
6111
6112                   join_posix_and_ascii:
6113
6114                     if (flags & SCF_DO_STCLASS_AND) {
6115                         ssc_intersection(data->start_class, my_invlist, invert);
6116                         ssc_clear_locale(data->start_class);
6117                     }
6118                     else {
6119                         assert(flags & SCF_DO_STCLASS_OR);
6120                         ssc_union(data->start_class, my_invlist, invert);
6121                     }
6122                     SvREFCNT_dec(my_invlist);
6123                 }
6124                 if (flags & SCF_DO_STCLASS_OR)
6125                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6126                 flags &= ~SCF_DO_STCLASS;
6127             }
6128         }
6129         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
6130             data->flags |= (OP(scan) == MEOL
6131                             ? SF_BEFORE_MEOL
6132                             : SF_BEFORE_SEOL);
6133             scan_commit(pRExC_state, data, minlenp, is_inf);
6134
6135         }
6136         else if (  PL_regkind[OP(scan)] == BRANCHJ
6137                  /* Lookbehind, or need to calculate parens/evals/stclass: */
6138                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
6139                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
6140         {
6141             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
6142                 || OP(scan) == UNLESSM )
6143             {
6144                 /* Negative Lookahead/lookbehind
6145                    In this case we can't do fixed string optimisation.
6146                 */
6147
6148                 SSize_t deltanext, minnext, fake = 0;
6149                 regnode *nscan;
6150                 regnode_ssc intrnl;
6151                 int f = 0;
6152
6153                 StructCopy(&zero_scan_data, &data_fake, scan_data_t);
6154                 if (data) {
6155                     data_fake.whilem_c = data->whilem_c;
6156                     data_fake.last_closep = data->last_closep;
6157                 }
6158                 else
6159                     data_fake.last_closep = &fake;
6160                 data_fake.pos_delta = delta;
6161                 if ( flags & SCF_DO_STCLASS && !scan->flags
6162                      && OP(scan) == IFMATCH ) { /* Lookahead */
6163                     ssc_init(pRExC_state, &intrnl);
6164                     data_fake.start_class = &intrnl;
6165                     f |= SCF_DO_STCLASS_AND;
6166                 }
6167                 if (flags & SCF_WHILEM_VISITED_POS)
6168                     f |= SCF_WHILEM_VISITED_POS;
6169                 next = regnext(scan);
6170                 nscan = NEXTOPER(NEXTOPER(scan));
6171
6172                 /* recurse study_chunk() for lookahead body */
6173                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
6174                                       last, &data_fake, stopparen,
6175                                       recursed_depth, NULL, f, depth+1,
6176                                       mutate_ok);
6177                 if (scan->flags) {
6178                     if (   deltanext < 0
6179                         || deltanext > (I32) U8_MAX
6180                         || minnext > (I32)U8_MAX
6181                         || minnext + deltanext > (I32)U8_MAX)
6182                     {
6183                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6184                               (UV)U8_MAX);
6185                     }
6186
6187                     /* The 'next_off' field has been repurposed to count the
6188                      * additional starting positions to try beyond the initial
6189                      * one.  (This leaves it at 0 for non-variable length
6190                      * matches to avoid breakage for those not using this
6191                      * extension) */
6192                     if (deltanext) {
6193                         scan->next_off = deltanext;
6194                         ckWARNexperimental(RExC_parse,
6195                             WARN_EXPERIMENTAL__VLB,
6196                             "Variable length lookbehind is experimental");
6197                     }
6198                     scan->flags = (U8)minnext + deltanext;
6199                 }
6200                 if (data) {
6201                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6202                         pars++;
6203                     if (data_fake.flags & SF_HAS_EVAL)
6204                         data->flags |= SF_HAS_EVAL;
6205                     data->whilem_c = data_fake.whilem_c;
6206                 }
6207                 if (f & SCF_DO_STCLASS_AND) {
6208                     if (flags & SCF_DO_STCLASS_OR) {
6209                         /* OR before, AND after: ideally we would recurse with
6210                          * data_fake to get the AND applied by study of the
6211                          * remainder of the pattern, and then derecurse;
6212                          * *** HACK *** for now just treat as "no information".
6213                          * See [perl #56690].
6214                          */
6215                         ssc_init(pRExC_state, data->start_class);
6216                     }  else {
6217                         /* AND before and after: combine and continue.  These
6218                          * assertions are zero-length, so can match an EMPTY
6219                          * string */
6220                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6221                         ANYOF_FLAGS(data->start_class)
6222                                                    |= SSC_MATCHES_EMPTY_STRING;
6223                     }
6224                 }
6225             }
6226 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
6227             else {
6228                 /* Positive Lookahead/lookbehind
6229                    In this case we can do fixed string optimisation,
6230                    but we must be careful about it. Note in the case of
6231                    lookbehind the positions will be offset by the minimum
6232                    length of the pattern, something we won't know about
6233                    until after the recurse.
6234                 */
6235                 SSize_t deltanext, fake = 0;
6236                 regnode *nscan;
6237                 regnode_ssc intrnl;
6238                 int f = 0;
6239                 /* We use SAVEFREEPV so that when the full compile
6240                     is finished perl will clean up the allocated
6241                     minlens when it's all done. This way we don't
6242                     have to worry about freeing them when we know
6243                     they wont be used, which would be a pain.
6244                  */
6245                 SSize_t *minnextp;
6246                 Newx( minnextp, 1, SSize_t );
6247                 SAVEFREEPV(minnextp);
6248
6249                 if (data) {
6250                     StructCopy(data, &data_fake, scan_data_t);
6251                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
6252                         f |= SCF_DO_SUBSTR;
6253                         if (scan->flags)
6254                             scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
6255                         data_fake.last_found=newSVsv(data->last_found);
6256                     }
6257                 }
6258                 else
6259                     data_fake.last_closep = &fake;
6260                 data_fake.flags = 0;
6261                 data_fake.substrs[0].flags = 0;
6262                 data_fake.substrs[1].flags = 0;
6263                 data_fake.pos_delta = delta;
6264                 if (is_inf)
6265                     data_fake.flags |= SF_IS_INF;
6266                 if ( flags & SCF_DO_STCLASS && !scan->flags
6267                      && OP(scan) == IFMATCH ) { /* Lookahead */
6268                     ssc_init(pRExC_state, &intrnl);
6269                     data_fake.start_class = &intrnl;
6270                     f |= SCF_DO_STCLASS_AND;
6271                 }
6272                 if (flags & SCF_WHILEM_VISITED_POS)
6273                     f |= SCF_WHILEM_VISITED_POS;
6274                 next = regnext(scan);
6275                 nscan = NEXTOPER(NEXTOPER(scan));
6276
6277                 /* positive lookahead study_chunk() recursion */
6278                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
6279                                         &deltanext, last, &data_fake,
6280                                         stopparen, recursed_depth, NULL,
6281                                         f, depth+1, mutate_ok);
6282                 if (scan->flags) {
6283                     assert(0);  /* This code has never been tested since this
6284                                    is normally not compiled */
6285                     if (   deltanext < 0
6286                         || deltanext > (I32) U8_MAX
6287                         || *minnextp > (I32)U8_MAX
6288                         || *minnextp + deltanext > (I32)U8_MAX)
6289                     {
6290                         FAIL2("Lookbehind longer than %" UVuf " not implemented",
6291                               (UV)U8_MAX);
6292                     }
6293
6294                     if (deltanext) {
6295                         scan->next_off = deltanext;
6296                     }
6297                     scan->flags = (U8)*minnextp + deltanext;
6298                 }
6299
6300                 *minnextp += min;
6301
6302                 if (f & SCF_DO_STCLASS_AND) {
6303                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
6304                     ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
6305                 }
6306                 if (data) {
6307                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6308                         pars++;
6309                     if (data_fake.flags & SF_HAS_EVAL)
6310                         data->flags |= SF_HAS_EVAL;
6311                     data->whilem_c = data_fake.whilem_c;
6312                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
6313                         int i;
6314                         if (RExC_rx->minlen<*minnextp)
6315                             RExC_rx->minlen=*minnextp;
6316                         scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
6317                         SvREFCNT_dec_NN(data_fake.last_found);
6318
6319                         for (i = 0; i < 2; i++) {
6320                             if (data_fake.substrs[i].minlenp != minlenp) {
6321                                 data->substrs[i].min_offset =
6322                                             data_fake.substrs[i].min_offset;
6323                                 data->substrs[i].max_offset =
6324                                             data_fake.substrs[i].max_offset;
6325                                 data->substrs[i].minlenp =
6326                                             data_fake.substrs[i].minlenp;
6327                                 data->substrs[i].lookbehind += scan->flags;
6328                             }
6329                         }
6330                     }
6331                 }
6332             }
6333 #endif
6334         }
6335         else if (OP(scan) == OPEN) {
6336             if (stopparen != (I32)ARG(scan))
6337                 pars++;
6338         }
6339         else if (OP(scan) == CLOSE) {
6340             if (stopparen == (I32)ARG(scan)) {
6341                 break;
6342             }
6343             if ((I32)ARG(scan) == is_par) {
6344                 next = regnext(scan);
6345
6346                 if ( next && (OP(next) != WHILEM) && next < last)
6347                     is_par = 0;         /* Disable optimization */
6348             }
6349             if (data)
6350                 *(data->last_closep) = ARG(scan);
6351         }
6352         else if (OP(scan) == EVAL) {
6353                 if (data)
6354                     data->flags |= SF_HAS_EVAL;
6355         }
6356         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
6357             if (flags & SCF_DO_SUBSTR) {
6358                 scan_commit(pRExC_state, data, minlenp, is_inf);
6359                 flags &= ~SCF_DO_SUBSTR;
6360             }
6361             if (data && OP(scan)==ACCEPT) {
6362                 data->flags |= SCF_SEEN_ACCEPT;
6363                 if (stopmin > min)
6364                     stopmin = min;
6365             }
6366         }
6367         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
6368         {
6369                 if (flags & SCF_DO_SUBSTR) {
6370                     scan_commit(pRExC_state, data, minlenp, is_inf);
6371                     data->cur_is_floating = 1; /* float */
6372                 }
6373                 is_inf = is_inf_internal = 1;
6374                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
6375                     ssc_anything(data->start_class);
6376                 flags &= ~SCF_DO_STCLASS;
6377         }
6378         else if (OP(scan) == GPOS) {
6379             if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
6380                 !(delta || is_inf || (data && data->pos_delta)))
6381             {
6382                 if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
6383                     RExC_rx->intflags |= PREGf_ANCH_GPOS;
6384                 if (RExC_rx->gofs < (STRLEN)min)
6385                     RExC_rx->gofs = min;
6386             } else {
6387                 RExC_rx->intflags |= PREGf_GPOS_FLOAT;
6388                 RExC_rx->gofs = 0;
6389             }
6390         }
6391 #ifdef TRIE_STUDY_OPT
6392 #ifdef FULL_TRIE_STUDY
6393         else if (PL_regkind[OP(scan)] == TRIE) {
6394             /* NOTE - There is similar code to this block above for handling
6395                BRANCH nodes on the initial study.  If you change stuff here
6396                check there too. */
6397             regnode *trie_node= scan;
6398             regnode *tail= regnext(scan);
6399             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6400             SSize_t max1 = 0, min1 = OPTIMIZE_INFTY;
6401             regnode_ssc accum;
6402
6403             if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
6404                 /* Cannot merge strings after this. */
6405                 scan_commit(pRExC_state, data, minlenp, is_inf);
6406             }
6407             if (flags & SCF_DO_STCLASS)
6408                 ssc_init_zero(pRExC_state, &accum);
6409
6410             if (!trie->jump) {
6411                 min1= trie->minlen;
6412                 max1= trie->maxlen;
6413             } else {
6414                 const regnode *nextbranch= NULL;
6415                 U32 word;
6416
6417                 for ( word=1 ; word <= trie->wordcount ; word++)
6418                 {
6419                     SSize_t deltanext=0, minnext=0, f = 0, fake;
6420                     regnode_ssc this_class;
6421
6422                     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
6423                     if (data) {
6424                         data_fake.whilem_c = data->whilem_c;
6425                         data_fake.last_closep = data->last_closep;
6426                     }
6427                     else
6428                         data_fake.last_closep = &fake;
6429                     data_fake.pos_delta = delta;
6430                     if (flags & SCF_DO_STCLASS) {
6431                         ssc_init(pRExC_state, &this_class);
6432                         data_fake.start_class = &this_class;
6433                         f = SCF_DO_STCLASS_AND;
6434                     }
6435                     if (flags & SCF_WHILEM_VISITED_POS)
6436                         f |= SCF_WHILEM_VISITED_POS;
6437
6438                     if (trie->jump[word]) {
6439                         if (!nextbranch)
6440                             nextbranch = trie_node + trie->jump[0];
6441                         scan= trie_node + trie->jump[word];
6442                         /* We go from the jump point to the branch that follows
6443                            it. Note this means we need the vestigal unused
6444                            branches even though they arent otherwise used. */
6445                         /* optimise study_chunk() for TRIE */
6446                         minnext = study_chunk(pRExC_state, &scan, minlenp,
6447                             &deltanext, (regnode *)nextbranch, &data_fake,
6448                             stopparen, recursed_depth, NULL, f, depth+1,
6449                             mutate_ok);
6450                     }
6451                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
6452                         nextbranch= regnext((regnode*)nextbranch);
6453
6454                     if (min1 > (SSize_t)(minnext + trie->minlen))
6455                         min1 = minnext + trie->minlen;
6456                     if (deltanext == OPTIMIZE_INFTY) {
6457                         is_inf = is_inf_internal = 1;
6458                         max1 = OPTIMIZE_INFTY;
6459                     } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
6460                         max1 = minnext + deltanext + trie->maxlen;
6461
6462                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
6463                         pars++;
6464                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
6465                         if ( stopmin > min + min1)
6466                             stopmin = min + min1;
6467                         flags &= ~SCF_DO_SUBSTR;
6468                         if (data)
6469                             data->flags |= SCF_SEEN_ACCEPT;
6470                     }
6471                     if (data) {
6472                         if (data_fake.flags & SF_HAS_EVAL)
6473                             data->flags |= SF_HAS_EVAL;
6474                         data->whilem_c = data_fake.whilem_c;
6475                     }
6476                     if (flags & SCF_DO_STCLASS)
6477                         ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
6478                 }
6479             }
6480             if (flags & SCF_DO_SUBSTR) {
6481                 data->pos_min += min1;
6482                 data->pos_delta += max1 - min1;
6483                 if (max1 != min1 || is_inf)
6484                     data->cur_is_floating = 1; /* float */
6485             }
6486             min += min1;
6487             if (delta != OPTIMIZE_INFTY) {
6488                 if (OPTIMIZE_INFTY - (max1 - min1) >= delta)
6489                     delta += max1 - min1;
6490                 else
6491                     delta = OPTIMIZE_INFTY;
6492             }
6493             if (flags & SCF_DO_STCLASS_OR) {
6494                 ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6495                 if (min1) {
6496                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6497                     flags &= ~SCF_DO_STCLASS;
6498                 }
6499             }
6500             else if (flags & SCF_DO_STCLASS_AND) {
6501                 if (min1) {
6502                     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
6503                     flags &= ~SCF_DO_STCLASS;
6504                 }
6505                 else {
6506                     /* Switch to OR mode: cache the old value of
6507                      * data->start_class */
6508                     INIT_AND_WITHP;
6509                     StructCopy(data->start_class, and_withp, regnode_ssc);
6510                     flags &= ~SCF_DO_STCLASS_AND;
6511                     StructCopy(&accum, data->start_class, regnode_ssc);
6512                     flags |= SCF_DO_STCLASS_OR;
6513                 }
6514             }
6515             scan= tail;
6516             continue;
6517         }
6518 #else
6519         else if (PL_regkind[OP(scan)] == TRIE) {
6520             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
6521             U8*bang=NULL;
6522
6523             min += trie->minlen;
6524             delta += (trie->maxlen - trie->minlen);
6525             flags &= ~SCF_DO_STCLASS; /* xxx */
6526             if (flags & SCF_DO_SUBSTR) {
6527                 /* Cannot expect anything... */
6528                 scan_commit(pRExC_state, data, minlenp, is_inf);
6529                 data->pos_min += trie->minlen;
6530                 data->pos_delta += (trie->maxlen - trie->minlen);
6531                 if (trie->maxlen != trie->minlen)
6532                     data->cur_is_floating = 1; /* float */
6533             }
6534             if (trie->jump) /* no more substrings -- for now /grr*/
6535                flags &= ~SCF_DO_SUBSTR;
6536         }
6537         else if (OP(scan) == REGEX_SET) {
6538             Perl_croak(aTHX_ "panic: %s regnode should be resolved"
6539                              " before optimization", reg_name[REGEX_SET]);
6540         }
6541
6542 #endif /* old or new */
6543 #endif /* TRIE_STUDY_OPT */
6544
6545         /* Else: zero-length, ignore. */
6546         scan = regnext(scan);
6547     }
6548
6549   finish:
6550     if (frame) {
6551         /* we need to unwind recursion. */
6552         depth = depth - 1;
6553
6554         DEBUG_STUDYDATA("frame-end", data, depth, is_inf);
6555         DEBUG_PEEP("fend", scan, depth, flags);
6556
6557         /* restore previous context */
6558         last = frame->last_regnode;
6559         scan = frame->next_regnode;
6560         stopparen = frame->stopparen;
6561         recursed_depth = frame->prev_recursed_depth;
6562
6563         RExC_frame_last = frame->prev_frame;
6564         frame = frame->this_prev_frame;
6565         goto fake_study_recurse;
6566     }
6567
6568     assert(!frame);
6569     DEBUG_STUDYDATA("pre-fin", data, depth, is_inf);
6570
6571     *scanp = scan;
6572     *deltap = is_inf_internal ? OPTIMIZE_INFTY : delta;
6573
6574     if (flags & SCF_DO_SUBSTR && is_inf)
6575         data->pos_delta = OPTIMIZE_INFTY - data->pos_min;
6576     if (is_par > (I32)U8_MAX)
6577         is_par = 0;
6578     if (is_par && pars==1 && data) {
6579         data->flags |= SF_IN_PAR;
6580         data->flags &= ~SF_HAS_PAR;
6581     }
6582     else if (pars && data) {
6583         data->flags |= SF_HAS_PAR;
6584         data->flags &= ~SF_IN_PAR;
6585     }
6586     if (flags & SCF_DO_STCLASS_OR)
6587         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
6588     if (flags & SCF_TRIE_RESTUDY)
6589         data->flags |=  SCF_TRIE_RESTUDY;
6590
6591     DEBUG_STUDYDATA("post-fin", data, depth, is_inf);
6592
6593     final_minlen = min < stopmin
6594             ? min : stopmin;
6595
6596     if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
6597         if (final_minlen > OPTIMIZE_INFTY - delta)
6598             RExC_maxlen = OPTIMIZE_INFTY;
6599         else if (RExC_maxlen < final_minlen + delta)
6600             RExC_maxlen = final_minlen + delta;
6601     }
6602     return final_minlen;
6603 }
6604
6605 STATIC U32
6606 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
6607 {
6608     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
6609
6610     PERL_ARGS_ASSERT_ADD_DATA;
6611
6612     Renewc(RExC_rxi->data,
6613            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
6614            char, struct reg_data);
6615     if(count)
6616         Renew(RExC_rxi->data->what, count + n, U8);
6617     else
6618         Newx(RExC_rxi->data->what, n, U8);
6619     RExC_rxi->data->count = count + n;
6620     Copy(s, RExC_rxi->data->what + count, n, U8);
6621     return count;
6622 }
6623
6624 /*XXX: todo make this not included in a non debugging perl, but appears to be
6625  * used anyway there, in 'use re' */
6626 #ifndef PERL_IN_XSUB_RE
6627 void
6628 Perl_reginitcolors(pTHX)
6629 {
6630     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
6631     if (s) {
6632         char *t = savepv(s);
6633         int i = 0;
6634         PL_colors[0] = t;
6635         while (++i < 6) {
6636             t = strchr(t, '\t');
6637             if (t) {
6638                 *t = '\0';
6639                 PL_colors[i] = ++t;
6640             }
6641             else
6642                 PL_colors[i] = t = (char *)"";
6643         }
6644     } else {
6645         int i = 0;
6646         while (i < 6)
6647             PL_colors[i++] = (char *)"";
6648     }
6649     PL_colorset = 1;
6650 }
6651 #endif
6652
6653
6654 #ifdef TRIE_STUDY_OPT
6655 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
6656     STMT_START {                                            \
6657         if (                                                \
6658               (data.flags & SCF_TRIE_RESTUDY)               \
6659               && ! restudied++                              \
6660         ) {                                                 \
6661             dOsomething;                                    \
6662             goto reStudy;                                   \
6663         }                                                   \
6664     } STMT_END
6665 #else
6666 #define CHECK_RESTUDY_GOTO_butfirst
6667 #endif
6668
6669 /*
6670  * pregcomp - compile a regular expression into internal code
6671  *
6672  * Decides which engine's compiler to call based on the hint currently in
6673  * scope
6674  */
6675
6676 #ifndef PERL_IN_XSUB_RE
6677
6678 /* return the currently in-scope regex engine (or the default if none)  */
6679
6680 regexp_engine const *
6681 Perl_current_re_engine(pTHX)
6682 {
6683     if (IN_PERL_COMPILETIME) {
6684         HV * const table = GvHV(PL_hintgv);
6685         SV **ptr;
6686
6687         if (!table || !(PL_hints & HINT_LOCALIZE_HH))
6688             return &PL_core_reg_engine;
6689         ptr = hv_fetchs(table, "regcomp", FALSE);
6690         if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
6691             return &PL_core_reg_engine;
6692         return INT2PTR(regexp_engine*, SvIV(*ptr));
6693     }
6694     else {
6695         SV *ptr;
6696         if (!PL_curcop->cop_hints_hash)
6697             return &PL_core_reg_engine;
6698         ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
6699         if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
6700             return &PL_core_reg_engine;
6701         return INT2PTR(regexp_engine*, SvIV(ptr));
6702     }
6703 }
6704
6705
6706 REGEXP *
6707 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
6708 {
6709     regexp_engine const *eng = current_re_engine();
6710     DECLARE_AND_GET_RE_DEBUG_FLAGS;
6711
6712     PERL_ARGS_ASSERT_PREGCOMP;
6713
6714     /* Dispatch a request to compile a regexp to correct regexp engine. */
6715     DEBUG_COMPILE_r({
6716         Perl_re_printf( aTHX_  "Using engine %" UVxf "\n",
6717                         PTR2UV(eng));
6718     });
6719     return CALLREGCOMP_ENG(eng, pattern, flags);
6720 }
6721 #endif
6722
6723 /* public(ish) entry point for the perl core's own regex compiling code.
6724  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
6725  * pattern rather than a list of OPs, and uses the internal engine rather
6726  * than the current one */
6727
6728 REGEXP *
6729 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
6730 {
6731     SV *pat = pattern; /* defeat constness! */
6732
6733     PERL_ARGS_ASSERT_RE_COMPILE;
6734
6735     return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
6736 #ifdef PERL_IN_XSUB_RE
6737                                 &my_reg_engine,
6738 #else
6739                                 &PL_core_reg_engine,
6740 #endif
6741                                 NULL, NULL, rx_flags, 0);
6742 }
6743
6744 static void
6745 S_free_codeblocks(pTHX_ struct reg_code_blocks *cbs)
6746 {
6747     int n;
6748
6749     if (--cbs->refcnt > 0)
6750         return;
6751     for (n = 0; n < cbs->count; n++) {
6752         REGEXP *rx = cbs->cb[n].src_regex;
6753         if (rx) {
6754             cbs->cb[n].src_regex = NULL;
6755             SvREFCNT_dec_NN(rx);
6756         }
6757     }
6758     Safefree(cbs->cb);
6759     Safefree(cbs);
6760 }
6761
6762
6763 static struct reg_code_blocks *
6764 S_alloc_code_blocks(pTHX_  int ncode)
6765 {
6766      struct reg_code_blocks *cbs;
6767     Newx(cbs, 1, struct reg_code_blocks);
6768     cbs->count = ncode;
6769     cbs->refcnt = 1;
6770     SAVEDESTRUCTOR_X(S_free_codeblocks, cbs);
6771     if (ncode)
6772         Newx(cbs->cb, ncode, struct reg_code_block);
6773     else
6774         cbs->cb = NULL;
6775     return cbs;
6776 }
6777
6778
6779 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
6780  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
6781  * point to the realloced string and length.
6782  *
6783  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
6784  * stuff added */
6785
6786 static void
6787 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
6788                     char **pat_p, STRLEN *plen_p, int num_code_blocks)
6789 {
6790     U8 *const src = (U8*)*pat_p;
6791     U8 *dst, *d;
6792     int n=0;
6793     STRLEN s = 0;
6794     bool do_end = 0;
6795     DECLARE_AND_GET_RE_DEBUG_FLAGS;
6796
6797     DEBUG_PARSE_r(Perl_re_printf( aTHX_
6798         "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
6799
6800     /* 1 for each byte + 1 for each byte that expands to two, + trailing NUL */
6801     Newx(dst, *plen_p + variant_under_utf8_count(src, src + *plen_p) + 1, U8);
6802     d = dst;
6803
6804     while (s < *plen_p) {
6805         append_utf8_from_native_byte(src[s], &d);
6806
6807         if (n < num_code_blocks) {
6808             assert(pRExC_state->code_blocks);
6809             if (!do_end && pRExC_state->code_blocks->cb[n].start == s) {
6810                 pRExC_state->code_blocks->cb[n].start = d - dst - 1;
6811                 assert(*(d - 1) == '(');
6812                 do_end = 1;
6813             }
6814             else if (do_end && pRExC_state->code_blocks->cb[n].end == s) {
6815                 pRExC_state->code_blocks->cb[n].end = d - dst - 1;
6816                 assert(*(d - 1) == ')');
6817                 do_end = 0;
6818                 n++;
6819             }
6820         }
6821         s++;
6822     }
6823     *d = '\0';
6824     *plen_p = d - dst;
6825     *pat_p = (char*) dst;
6826     SAVEFREEPV(*pat_p);
6827     RExC_orig_utf8 = RExC_utf8 = 1;
6828 }
6829
6830
6831
6832 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
6833  * while recording any code block indices, and handling overloading,
6834  * nested qr// objects etc.  If pat is null, it will allocate a new
6835  * string, or just return the first arg, if there's only one.
6836  *
6837  * Returns the malloced/updated pat.
6838  * patternp and pat_count is the array of SVs to be concatted;
6839  * oplist is the optional list of ops that generated the SVs;
6840  * recompile_p is a pointer to a boolean that will be set if
6841  *   the regex will need to be recompiled.
6842  * delim, if non-null is an SV that will be inserted between each element
6843  */
6844
6845 static SV*
6846 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
6847                 SV *pat, SV ** const patternp, int pat_count,
6848                 OP *oplist, bool *recompile_p, SV *delim)
6849 {
6850     SV **svp;
6851     int n = 0;
6852     bool use_delim = FALSE;
6853     bool alloced = FALSE;
6854
6855     /* if we know we have at least two args, create an empty string,
6856      * then concatenate args to that. For no args, return an empty string */
6857     if (!pat && pat_count != 1) {
6858         pat = newSVpvs("");
6859         SAVEFREESV(pat);
6860         alloced = TRUE;
6861     }
6862
6863     for (svp = patternp; svp < patternp + pat_count; svp++) {
6864         SV *sv;
6865         SV *rx  = NULL;
6866         STRLEN orig_patlen = 0;
6867         bool code = 0;
6868         SV *msv = use_delim ? delim : *svp;
6869         if (!msv) msv = &PL_sv_undef;
6870
6871         /* if we've got a delimiter, we go round the loop twice for each
6872          * svp slot (except the last), using the delimiter the second
6873          * time round */
6874         if (use_delim) {
6875             svp--;
6876             use_delim = FALSE;
6877         }
6878         else if (delim)
6879             use_delim = TRUE;
6880
6881         if (SvTYPE(msv) == SVt_PVAV) {
6882             /* we've encountered an interpolated array within
6883              * the pattern, e.g. /...@a..../. Expand the list of elements,
6884              * then recursively append elements.
6885              * The code in this block is based on S_pushav() */
6886
6887             AV *const av = (AV*)msv;
6888             const SSize_t maxarg = AvFILL(av) + 1;
6889             SV **array;
6890
6891             if (oplist) {
6892                 assert(oplist->op_type == OP_PADAV
6893                     || oplist->op_type == OP_RV2AV);
6894                 oplist = OpSIBLING(oplist);
6895             }
6896
6897             if (SvRMAGICAL(av)) {
6898                 SSize_t i;
6899
6900                 Newx(array, maxarg, SV*);
6901                 SAVEFREEPV(array);
6902                 for (i=0; i < maxarg; i++) {
6903                     SV ** const svp = av_fetch(av, i, FALSE);
6904                     array[i] = svp ? *svp : &PL_sv_undef;
6905                 }
6906             }
6907             else
6908                 array = AvARRAY(av);
6909
6910             pat = S_concat_pat(aTHX_ pRExC_state, pat,
6911                                 array, maxarg, NULL, recompile_p,
6912                                 /* $" */
6913                                 GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
6914
6915             continue;
6916         }
6917
6918
6919         /* we make the assumption here that each op in the list of
6920          * op_siblings maps to one SV pushed onto the stack,
6921          * except for code blocks, with have both an OP_NULL and
6922          * an OP_CONST.
6923          * This allows us to match up the list of SVs against the
6924          * list of OPs to find the next code block.
6925          *
6926          * Note that       PUSHMARK PADSV PADSV ..
6927          * is optimised to
6928          *                 PADRANGE PADSV  PADSV  ..
6929          * so the alignment still works. */
6930
6931         if (oplist) {
6932             if (oplist->op_type == OP_NULL
6933                 && (oplist->op_flags & OPf_SPECIAL))
6934             {
6935                 assert(n < pRExC_state->code_blocks->count);
6936                 pRExC_state->code_blocks->cb[n].start = pat ? SvCUR(pat) : 0;
6937                 pRExC_state->code_blocks->cb[n].block = oplist;
6938                 pRExC_state->code_blocks->cb[n].src_regex = NULL;
6939                 n++;
6940                 code = 1;
6941                 oplist = OpSIBLING(oplist); /* skip CONST */
6942                 assert(oplist);
6943             }
6944             oplist = OpSIBLING(oplist);;
6945         }
6946
6947         /* apply magic and QR overloading to arg */
6948
6949         SvGETMAGIC(msv);
6950         if (SvROK(msv) && SvAMAGIC(msv)) {
6951             SV *sv = AMG_CALLunary(msv, regexp_amg);
6952             if (sv) {
6953                 if (SvROK(sv))
6954                     sv = SvRV(sv);
6955                 if (SvTYPE(sv) != SVt_REGEXP)
6956                     Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
6957                 msv = sv;
6958             }
6959         }
6960
6961         /* try concatenation overload ... */
6962         if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
6963                 (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
6964         {
6965             sv_setsv(pat, sv);
6966             /* overloading involved: all bets are off over literal
6967              * code. Pretend we haven't seen it */
6968             if (n)
6969                 pRExC_state->code_blocks->count -= n;
6970             n = 0;
6971         }
6972         else {
6973             /* ... or failing that, try "" overload */
6974             while (SvAMAGIC(msv)
6975                     && (sv = AMG_CALLunary(msv, string_amg))
6976                     && sv != msv
6977                     &&  !(   SvROK(msv)
6978                           && SvROK(sv)
6979                           && SvRV(msv) == SvRV(sv))
6980             ) {
6981                 msv = sv;
6982                 SvGETMAGIC(msv);
6983             }
6984             if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
6985                 msv = SvRV(msv);
6986
6987             if (pat) {
6988                 /* this is a partially unrolled
6989                  *     sv_catsv_nomg(pat, msv);
6990                  * that allows us to adjust code block indices if
6991                  * needed */
6992                 STRLEN dlen;
6993                 char *dst = SvPV_force_nomg(pat, dlen);
6994                 orig_patlen = dlen;
6995                 if (SvUTF8(msv) && !SvUTF8(pat)) {
6996                     S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6997                     sv_setpvn(pat, dst, dlen);
6998                     SvUTF8_on(pat);
6999                 }
7000                 sv_catsv_nomg(pat, msv);
7001                 rx = msv;
7002             }
7003             else {
7004                 /* We have only one SV to process, but we need to verify
7005                  * it is properly null terminated or we will fail asserts
7006                  * later. In theory we probably shouldn't get such SV's,
7007                  * but if we do we should handle it gracefully. */
7008                 if ( SvTYPE(msv) != SVt_PV || (SvLEN(msv) > SvCUR(msv) && *(SvEND(msv)) == 0) || SvIsCOW_shared_hash(msv) ) {
7009                     /* not a string, or a string with a trailing null */
7010                     pat = msv;
7011                 } else {
7012                     /* a string with no trailing null, we need to copy it
7013                      * so it has a trailing null */
7014                     pat = sv_2mortal(newSVsv(msv));
7015                 }
7016             }
7017
7018             if (code)
7019                 pRExC_state->code_blocks->cb[n-1].end = SvCUR(pat)-1;
7020         }
7021
7022         /* extract any code blocks within any embedded qr//'s */
7023         if (rx && SvTYPE(rx) == SVt_REGEXP
7024             && RX_ENGINE((REGEXP*)rx)->op_comp)
7025         {
7026
7027             RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
7028             if (ri->code_blocks && ri->code_blocks->count) {
7029                 int i;
7030                 /* the presence of an embedded qr// with code means
7031                  * we should always recompile: the text of the
7032                  * qr// may not have changed, but it may be a
7033                  * different closure than last time */
7034                 *recompile_p = 1;
7035                 if (pRExC_state->code_blocks) {
7036                     int new_count = pRExC_state->code_blocks->count
7037                             + ri->code_blocks->count;
7038                     Renew(pRExC_state->code_blocks->cb,
7039                             new_count, struct reg_code_block);
7040                     pRExC_state->code_blocks->count = new_count;
7041                 }
7042                 else
7043                     pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_
7044                                                     ri->code_blocks->count);
7045
7046                 for (i=0; i < ri->code_blocks->count; i++) {
7047                     struct reg_code_block *src, *dst;
7048                     STRLEN offset =  orig_patlen
7049                         + ReANY((REGEXP *)rx)->pre_prefix;
7050                     assert(n < pRExC_state->code_blocks->count);
7051                     src = &ri->code_blocks->cb[i];
7052                     dst = &pRExC_state->code_blocks->cb[n];
7053                     dst->start      = src->start + offset;
7054                     dst->end        = src->end   + offset;
7055                     dst->block      = src->block;
7056                     dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
7057                                             src->src_regex
7058                                                 ? src->src_regex
7059                                                 : (REGEXP*)rx);
7060                     n++;
7061                 }
7062             }
7063         }
7064     }
7065     /* avoid calling magic multiple times on a single element e.g. =~ $qr */
7066     if (alloced)
7067         SvSETMAGIC(pat);
7068
7069     return pat;
7070 }
7071
7072
7073
7074 /* see if there are any run-time code blocks in the pattern.
7075  * False positives are allowed */
7076
7077 static bool
7078 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
7079                     char *pat, STRLEN plen)
7080 {
7081     int n = 0;
7082     STRLEN s;
7083
7084     PERL_UNUSED_CONTEXT;
7085
7086     for (s = 0; s < plen; s++) {
7087         if (   pRExC_state->code_blocks
7088             && n < pRExC_state->code_blocks->count
7089             && s == pRExC_state->code_blocks->cb[n].start)
7090         {
7091             s = pRExC_state->code_blocks->cb[n].end;
7092             n++;
7093             continue;
7094         }
7095         /* TODO ideally should handle [..], (#..), /#.../x to reduce false
7096          * positives here */
7097         if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
7098             (pat[s+2] == '{'
7099                 || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
7100         )
7101             return 1;
7102     }
7103     return 0;
7104 }
7105
7106 /* Handle run-time code blocks. We will already have compiled any direct
7107  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
7108  * copy of it, but with any literal code blocks blanked out and
7109  * appropriate chars escaped; then feed it into
7110  *
7111  *    eval "qr'modified_pattern'"
7112  *
7113  * For example,
7114  *
7115  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
7116  *
7117  * becomes
7118  *
7119  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
7120  *
7121  * After eval_sv()-ing that, grab any new code blocks from the returned qr
7122  * and merge them with any code blocks of the original regexp.
7123  *
7124  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
7125  * instead, just save the qr and return FALSE; this tells our caller that
7126  * the original pattern needs upgrading to utf8.
7127  */
7128
7129 static bool
7130 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
7131     char *pat, STRLEN plen)
7132 {
7133     SV *qr;
7134
7135     DECLARE_AND_GET_RE_DEBUG_FLAGS;
7136
7137     if (pRExC_state->runtime_code_qr) {
7138         /* this is the second time we've been called; this should
7139          * only happen if the main pattern got upgraded to utf8
7140          * during compilation; re-use the qr we compiled first time
7141          * round (which should be utf8 too)
7142          */
7143         qr = pRExC_state->runtime_code_qr;
7144         pRExC_state->runtime_code_qr = NULL;
7145         assert(RExC_utf8 && SvUTF8(qr));
7146     }
7147     else {
7148         int n = 0;
7149         STRLEN s;
7150         char *p, *newpat;
7151         int newlen = plen + 7; /* allow for "qr''xx\0" extra chars */
7152         SV *sv, *qr_ref;
7153         dSP;
7154
7155         /* determine how many extra chars we need for ' and \ escaping */
7156         for (s = 0; s < plen; s++) {
7157             if (pat[s] == '\'' || pat[s] == '\\')
7158                 newlen++;
7159         }
7160
7161         Newx(newpat, newlen, char);
7162         p = newpat;
7163         *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
7164
7165         for (s = 0; s < plen; s++) {
7166             if (   pRExC_state->code_blocks
7167                 && n < pRExC_state->code_blocks->count
7168                 && s == pRExC_state->code_blocks->cb[n].start)
7169             {
7170                 /* blank out literal code block so that they aren't
7171                  * recompiled: eg change from/to:
7172                  *     /(?{xyz})/
7173                  *     /(?=====)/
7174                  * and
7175                  *     /(??{xyz})/
7176                  *     /(?======)/
7177                  * and
7178                  *     /(?(?{xyz}))/
7179                  *     /(?(?=====))/
7180                 */
7181                 assert(pat[s]   == '(');
7182                 assert(pat[s+1] == '?');
7183                 *p++ = '(';
7184                 *p++ = '?';
7185                 s += 2;
7186                 while (s < pRExC_state->code_blocks->cb[n].end) {
7187                     *p++ = '=';
7188                     s++;
7189                 }
7190                 *p++ = ')';
7191                 n++;
7192                 continue;
7193             }
7194             if (pat[s] == '\'' || pat[s] == '\\')
7195                 *p++ = '\\';
7196             *p++ = pat[s];
7197         }
7198         *p++ = '\'';
7199         if (pRExC_state->pm_flags & RXf_PMf_EXTENDED) {
7200             *p++ = 'x';
7201             if (pRExC_state->pm_flags & RXf_PMf_EXTENDED_MORE) {
7202                 *p++ = 'x';
7203             }
7204         }
7205         *p++ = '\0';
7206         DEBUG_COMPILE_r({
7207             Perl_re_printf( aTHX_
7208                 "%sre-parsing pattern for runtime code:%s %s\n",
7209                 PL_colors[4], PL_colors[5], newpat);
7210         });
7211
7212         sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
7213         Safefree(newpat);
7214
7215         ENTER;
7216         SAVETMPS;
7217         save_re_context();
7218         PUSHSTACKi(PERLSI_REQUIRE);
7219         /* G_RE_REPARSING causes the toker to collapse \\ into \ when
7220          * parsing qr''; normally only q'' does this. It also alters
7221          * hints handling */
7222         eval_sv(sv, G_SCALAR|G_RE_REPARSING);
7223         SvREFCNT_dec_NN(sv);
7224         SPAGAIN;
7225         qr_ref = POPs;
7226         PUTBACK;
7227         {
7228             SV * const errsv = ERRSV;
7229             if (SvTRUE_NN(errsv))
7230                 /* use croak_sv ? */
7231                 Perl_croak_nocontext("%" SVf, SVfARG(errsv));
7232         }
7233         assert(SvROK(qr_ref));
7234         qr = SvRV(qr_ref);
7235         assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
7236         /* the leaving below frees the tmp qr_ref.
7237          * Give qr a life of its own */
7238         SvREFCNT_inc(qr);
7239         POPSTACK;
7240         FREETMPS;
7241         LEAVE;
7242
7243     }
7244
7245     if (!RExC_utf8 && SvUTF8(qr)) {
7246         /* first time through; the pattern got upgraded; save the
7247          * qr for the next time through */
7248         assert(!pRExC_state->runtime_code_qr);
7249         pRExC_state->runtime_code_qr = qr;
7250         return 0;
7251     }
7252
7253
7254     /* extract any code blocks within the returned qr//  */
7255
7256
7257     /* merge the main (r1) and run-time (r2) code blocks into one */
7258     {
7259         RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
7260         struct reg_code_block *new_block, *dst;
7261         RExC_state_t * const r1 = pRExC_state; /* convenient alias */
7262         int i1 = 0, i2 = 0;
7263         int r1c, r2c;
7264
7265         if (!r2->code_blocks || !r2->code_blocks->count) /* we guessed wrong */
7266         {
7267             SvREFCNT_dec_NN(qr);
7268             return 1;
7269         }
7270
7271         if (!r1->code_blocks)
7272             r1->code_blocks = S_alloc_code_blocks(aTHX_ 0);
7273
7274         r1c = r1->code_blocks->count;
7275         r2c = r2->code_blocks->count;
7276
7277         Newx(new_block, r1c + r2c, struct reg_code_block);
7278
7279         dst = new_block;
7280
7281         while (i1 < r1c || i2 < r2c) {
7282             struct reg_code_block *src;
7283             bool is_qr = 0;
7284
7285             if (i1 == r1c) {
7286                 src = &r2->code_blocks->cb[i2++];
7287                 is_qr = 1;
7288             }
7289             else if (i2 == r2c)
7290                 src = &r1->code_blocks->cb[i1++];
7291             else if (  r1->code_blocks->cb[i1].start
7292                      < r2->code_blocks->cb[i2].start)
7293             {
7294                 src = &r1->code_blocks->cb[i1++];
7295                 assert(src->end < r2->code_blocks->cb[i2].start);
7296             }
7297             else {
7298                 assert(  r1->code_blocks->cb[i1].start
7299                        > r2->code_blocks->cb[i2].start);
7300                 src = &r2->code_blocks->cb[i2++];
7301                 is_qr = 1;
7302                 assert(src->end < r1->code_blocks->cb[i1].start);
7303             }
7304
7305             assert(pat[src->start] == '(');
7306             assert(pat[src->end]   == ')');
7307             dst->start      = src->start;
7308             dst->end        = src->end;
7309             dst->block      = src->block;
7310             dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
7311                                     : src->src_regex;
7312             dst++;
7313         }
7314         r1->code_blocks->count += r2c;
7315         Safefree(r1->code_blocks->cb);
7316         r1->code_blocks->cb = new_block;
7317     }
7318
7319     SvREFCNT_dec_NN(qr);
7320     return 1;
7321 }
7322
7323
7324 STATIC bool
7325 S_setup_longest(pTHX_ RExC_state_t *pRExC_state,
7326                       struct reg_substr_datum  *rsd,
7327                       struct scan_data_substrs *sub,
7328                       STRLEN longest_length)
7329 {
7330     /* This is the common code for setting up the floating and fixed length
7331      * string data extracted from Perl_re_op_compile() below.  Returns a boolean
7332      * as to whether succeeded or not */
7333
7334     I32 t;
7335     SSize_t ml;
7336     bool eol  = cBOOL(sub->flags & SF_BEFORE_EOL);
7337     bool meol = cBOOL(sub->flags & SF_BEFORE_MEOL);
7338
7339     if (! (longest_length
7340            || (eol /* Can't have SEOL and MULTI */
7341                && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
7342           )
7343             /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
7344         || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
7345     {
7346         return FALSE;
7347     }
7348
7349     /* copy the information about the longest from the reg_scan_data
7350         over to the program. */
7351     if (SvUTF8(sub->str)) {
7352         rsd->substr      = NULL;
7353         rsd->utf8_substr = sub->str;
7354     } else {
7355         rsd->substr      = sub->str;
7356         rsd->utf8_substr = NULL;
7357     }
7358     /* end_shift is how many chars that must be matched that
7359         follow this item. We calculate it ahead of time as once the
7360         lookbehind offset is added in we lose the ability to correctly
7361         calculate it.*/
7362     ml = sub->minlenp ? *(sub->minlenp) : (SSize_t)longest_length;
7363     rsd->end_shift = ml - sub->min_offset
7364         - longest_length
7365             /* XXX SvTAIL is always false here - did you mean FBMcf_TAIL
7366              * intead? - DAPM
7367             + (SvTAIL(sub->str) != 0)
7368             */
7369         + sub->lookbehind;
7370
7371     t = (eol/* Can't have SEOL and MULTI */
7372          && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
7373     fbm_compile(sub->str, t ? FBMcf_TAIL : 0);
7374
7375     return TRUE;
7376 }
7377
7378 STATIC void
7379 S_set_regex_pv(pTHX_ RExC_state_t *pRExC_state, REGEXP *Rx)
7380 {
7381     /* Calculates and sets in the compiled pattern 'Rx' the string to compile,
7382      * properly wrapped with the right modifiers */
7383
7384     bool has_p     = ((RExC_rx->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
7385     bool has_charset = RExC_utf8 || (get_regex_charset(RExC_rx->extflags)
7386                                                 != REGEX_DEPENDS_CHARSET);
7387
7388     /* The caret is output if there are any defaults: if not all the STD
7389         * flags are set, or if no character set specifier is needed */
7390     bool has_default =
7391                 (((RExC_rx->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
7392                 || ! has_charset);
7393     bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
7394                                                 == REG_RUN_ON_COMMENT_SEEN);
7395     U8 reganch = (U8)((RExC_rx->extflags & RXf_PMf_STD_PMMOD)
7396                         >> RXf_PMf_STD_PMMOD_SHIFT);
7397     const char *fptr = STD_PAT_MODS;        /*"msixxn"*/
7398     char *p;
7399     STRLEN pat_len = RExC_precomp_end - RExC_precomp;
7400
7401     /* We output all the necessary flags; we never output a minus, as all
7402         * those are defaults, so are
7403         * covered by the caret */
7404     const STRLEN wraplen = pat_len + has_p + has_runon
7405         + has_default       /* If needs a caret */
7406         + PL_bitcount[reganch] /* 1 char for each set standard flag */
7407
7408             /* If needs a character set specifier */
7409         + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
7410         + (sizeof("(?:)") - 1);
7411
7412     PERL_ARGS_ASSERT_SET_REGEX_PV;
7413
7414     /* make sure PL_bitcount bounds not exceeded */
7415     STATIC_ASSERT_STMT(sizeof(STD_PAT_MODS) <= 8);
7416
7417     p = sv_grow(MUTABLE_SV(Rx), wraplen + 1); /* +1 for the ending NUL */
7418     SvPOK_on(Rx);
7419     if (RExC_utf8)
7420         SvFLAGS(Rx) |= SVf_UTF8;
7421     *p++='('; *p++='?';
7422
7423     /* If a default, cover it using the caret */
7424     if (has_default) {
7425         *p++= DEFAULT_PAT_MOD;
7426     }
7427     if (has_charset) {
7428         STRLEN len;
7429         const char* name;
7430
7431         name = get_regex_charset_name(RExC_rx->extflags, &len);
7432         if (strEQ(name, DEPENDS_PAT_MODS)) {  /* /d under UTF-8 => /u */
7433             assert(RExC_utf8);
7434             name = UNICODE_PAT_MODS;
7435             len = sizeof(UNICODE_PAT_MODS) - 1;
7436         }
7437         Copy(name, p, len, char);
7438         p += len;
7439     }
7440     if (has_p)
7441         *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
7442     {
7443         char ch;
7444         while((ch = *fptr++)) {
7445             if(reganch & 1)
7446                 *p++ = ch;
7447             reganch >>= 1;
7448         }
7449     }
7450
7451     *p++ = ':';
7452     Copy(RExC_precomp, p, pat_len, char);
7453     assert ((RX_WRAPPED(Rx) - p) < 16);
7454     RExC_rx->pre_prefix = p - RX_WRAPPED(Rx);
7455     p += pat_len;
7456
7457     /* Adding a trailing \n causes this to compile properly:
7458             my $R = qr / A B C # D E/x; /($R)/
7459         Otherwise the parens are considered part of the comment */
7460     if (has_runon)
7461         *p++ = '\n';
7462     *p++ = ')';
7463     *p = 0;
7464     SvCUR_set(Rx, p - RX_WRAPPED(Rx));
7465 }
7466
7467 /*
7468  * Perl_re_op_compile - the perl internal RE engine's function to compile a
7469  * regular expression into internal code.
7470  * The pattern may be passed either as:
7471  *    a list of SVs (patternp plus pat_count)
7472  *    a list of OPs (expr)
7473  * If both are passed, the SV list is used, but the OP list indicates
7474  * which SVs are actually pre-compiled code blocks
7475  *
7476  * The SVs in the list have magic and qr overloading applied to them (and
7477  * the list may be modified in-place with replacement SVs in the latter
7478  * case).
7479  *
7480  * If the pattern hasn't changed from old_re, then old_re will be
7481  * returned.
7482  *
7483  * eng is the current engine. If that engine has an op_comp method, then
7484  * handle directly (i.e. we assume that op_comp was us); otherwise, just
7485  * do the initial concatenation of arguments and pass on to the external
7486  * engine.
7487  *
7488  * If is_bare_re is not null, set it to a boolean indicating whether the
7489  * arg list reduced (after overloading) to a single bare regex which has
7490  * been returned (i.e. /$qr/).
7491  *
7492  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
7493  *
7494  * pm_flags contains the PMf_* flags, typically based on those from the
7495  * pm_flags field of the related PMOP. Currently we're only interested in
7496  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL, PMf_WILDCARD.
7497  *
7498  * For many years this code had an initial sizing pass that calculated
7499  * (sometimes incorrectly, leading to security holes) the size needed for the
7500  * compiled pattern.  That was changed by commit
7501  * 7c932d07cab18751bfc7515b4320436273a459e2 in 5.29, which reallocs the size, a
7502  * node at a time, as parsing goes along.  Patches welcome to fix any obsolete
7503  * references to this sizing pass.
7504  *
7505  * Now, an initial crude guess as to the size needed is made, based on the
7506  * length of the pattern.  Patches welcome to improve that guess.  That amount
7507  * of space is malloc'd and then immediately freed, and then clawed back node
7508  * by node.  This design is to minimze, to the extent possible, memory churn
7509  * when doing the reallocs.
7510  *
7511  * A separate parentheses counting pass may be needed in some cases.
7512  * (Previously the sizing pass did this.)  Patches welcome to reduce the number
7513  * of these cases.
7514  *
7515  * The existence of a sizing pass necessitated design decisions that are no
7516  * longer needed.  There are potential areas of simplification.
7517  *
7518  * Beware that the optimization-preparation code in here knows about some
7519  * of the structure of the compiled regexp.  [I'll say.]
7520  */
7521
7522 REGEXP *
7523 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
7524                     OP *expr, const regexp_engine* eng, REGEXP *old_re,
7525                      bool *is_bare_re, const U32 orig_rx_flags, const U32 pm_flags)
7526 {
7527     REGEXP *Rx;         /* Capital 'R' means points to a REGEXP */
7528     STRLEN plen;
7529     char *exp;
7530     regnode *scan;
7531     I32 flags;
7532     SSize_t minlen = 0;
7533     U32 rx_flags;
7534     SV *pat;
7535     SV** new_patternp = patternp;
7536
7537     /* these are all flags - maybe they should be turned
7538      * into a single int with different bit masks */
7539     I32 sawlookahead = 0;
7540     I32 sawplus = 0;
7541     I32 sawopen = 0;
7542     I32 sawminmod = 0;
7543
7544     regex_charset initial_charset = get_regex_charset(orig_rx_flags);
7545     bool recompile = 0;
7546     bool runtime_code = 0;
7547     scan_data_t data;
7548     RExC_state_t RExC_state;
7549     RExC_state_t * const pRExC_state = &RExC_state;
7550 #ifdef TRIE_STUDY_OPT
7551     int restudied = 0;
7552     RExC_state_t copyRExC_state;
7553 #endif
7554     DECLARE_AND_GET_RE_DEBUG_FLAGS;
7555
7556     PERL_ARGS_ASSERT_RE_OP_COMPILE;
7557
7558     DEBUG_r(if (!PL_colorset) reginitcolors());
7559
7560
7561     pRExC_state->warn_text = NULL;
7562     pRExC_state->unlexed_names = NULL;
7563     pRExC_state->code_blocks = NULL;
7564
7565     if (is_bare_re)
7566         *is_bare_re = FALSE;
7567
7568     if (expr && (expr->op_type == OP_LIST ||
7569                 (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
7570         /* allocate code_blocks if needed */
7571         OP *o;
7572         int ncode = 0;
7573
7574         for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
7575             if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
7576                 ncode++; /* count of DO blocks */
7577
7578         if (ncode)
7579             pRExC_state->code_blocks = S_alloc_code_blocks(aTHX_ ncode);
7580     }
7581
7582     if (!pat_count) {
7583         /* compile-time pattern with just OP_CONSTs and DO blocks */
7584
7585         int n;
7586         OP *o;
7587
7588         /* find how many CONSTs there are */
7589         assert(expr);
7590         n = 0;
7591         if (expr->op_type == OP_CONST)
7592             n = 1;
7593         else
7594             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7595                 if (o->op_type == OP_CONST)
7596                     n++;
7597             }
7598
7599         /* fake up an SV array */
7600
7601         assert(!new_patternp);
7602         Newx(new_patternp, n, SV*);
7603         SAVEFREEPV(new_patternp);
7604         pat_count = n;
7605
7606         n = 0;
7607         if (expr->op_type == OP_CONST)
7608             new_patternp[n] = cSVOPx_sv(expr);
7609         else
7610             for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
7611                 if (o->op_type == OP_CONST)
7612                     new_patternp[n++] = cSVOPo_sv;
7613             }
7614
7615     }
7616
7617     DEBUG_PARSE_r(Perl_re_printf( aTHX_
7618         "Assembling pattern from %d elements%s\n", pat_count,
7619             orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7620
7621     /* set expr to the first arg op */
7622
7623     if (pRExC_state->code_blocks && pRExC_state->code_blocks->count
7624          && expr->op_type != OP_CONST)
7625     {
7626             expr = cLISTOPx(expr)->op_first;
7627             assert(   expr->op_type == OP_PUSHMARK
7628                    || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
7629                    || expr->op_type == OP_PADRANGE);
7630             expr = OpSIBLING(expr);
7631     }
7632
7633     pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
7634                         expr, &recompile, NULL);
7635
7636     /* handle bare (possibly after overloading) regex: foo =~ $re */
7637     {
7638         SV *re = pat;
7639         if (SvROK(re))
7640             re = SvRV(re);
7641         if (SvTYPE(re) == SVt_REGEXP) {
7642             if (is_bare_re)
7643                 *is_bare_re = TRUE;
7644             SvREFCNT_inc(re);
7645             DEBUG_PARSE_r(Perl_re_printf( aTHX_
7646                 "Precompiled pattern%s\n",
7647                     orig_rx_flags & RXf_SPLIT ? " for split" : ""));
7648
7649             return (REGEXP*)re;
7650         }
7651     }
7652
7653     exp = SvPV_nomg(pat, plen);
7654
7655     if (!eng->op_comp) {
7656         if ((SvUTF8(pat) && IN_BYTES)
7657                 || SvGMAGICAL(pat) || SvAMAGIC(pat))
7658         {
7659             /* make a temporary copy; either to convert to bytes,
7660              * or to avoid repeating get-magic / overloaded stringify */
7661             pat = newSVpvn_flags(exp, plen, SVs_TEMP |
7662                                         (IN_BYTES ? 0 : SvUTF8(pat)));
7663         }
7664         return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
7665     }
7666
7667     /* ignore the utf8ness if the pattern is 0 length */
7668     RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
7669     RExC_uni_semantics = 0;
7670     RExC_contains_locale = 0;
7671     RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
7672     RExC_in_script_run = 0;
7673     RExC_study_started = 0;
7674     pRExC_state->runtime_code_qr = NULL;
7675     RExC_frame_head= NULL;
7676     RExC_frame_last= NULL;
7677     RExC_frame_count= 0;
7678     RExC_latest_warn_offset = 0;
7679     RExC_use_BRANCHJ = 0;
7680     RExC_warned_WARN_EXPERIMENTAL__VLB = 0;
7681     RExC_warned_WARN_EXPERIMENTAL__REGEX_SETS = 0;
7682     RExC_total_parens = 0;
7683     RExC_open_parens = NULL;
7684     RExC_close_parens = NULL;
7685     RExC_paren_names = NULL;
7686     RExC_size = 0;
7687     RExC_seen_d_op = FALSE;
7688 #ifdef DEBUGGING
7689     RExC_paren_name_list = NULL;
7690 #endif
7691
7692     DEBUG_r({
7693         RExC_mysv1= sv_newmortal();
7694         RExC_mysv2= sv_newmortal();
7695     });
7696
7697     DEBUG_COMPILE_r({
7698             SV *dsv= sv_newmortal();
7699             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7700             Perl_re_printf( aTHX_  "%sCompiling REx%s %s\n",
7701                           PL_colors[4], PL_colors[5], s);
7702         });
7703
7704     /* we jump here if we have to recompile, e.g., from upgrading the pattern
7705      * to utf8 */
7706
7707     if ((pm_flags & PMf_USE_RE_EVAL)
7708                 /* this second condition covers the non-regex literal case,
7709                  * i.e.  $foo =~ '(?{})'. */
7710                 || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
7711     )
7712         runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
7713
7714   redo_parse:
7715     /* return old regex if pattern hasn't changed */
7716     /* XXX: note in the below we have to check the flags as well as the
7717      * pattern.
7718      *
7719      * Things get a touch tricky as we have to compare the utf8 flag
7720      * independently from the compile flags.  */
7721
7722     if (   old_re
7723         && !recompile
7724         && !!RX_UTF8(old_re) == !!RExC_utf8
7725         && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
7726         && RX_PRECOMP(old_re)
7727         && RX_PRELEN(old_re) == plen
7728         && memEQ(RX_PRECOMP(old_re), exp, plen)
7729         && !runtime_code /* with runtime code, always recompile */ )
7730     {
7731         DEBUG_COMPILE_r({
7732             SV *dsv= sv_newmortal();
7733             RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, PL_dump_re_max_len);
7734             Perl_re_printf( aTHX_  "%sSkipping recompilation of unchanged REx%s %s\n",
7735                           PL_colors[4], PL_colors[5], s);
7736         });
7737         return old_re;
7738     }
7739
7740     /* Allocate the pattern's SV */
7741     RExC_rx_sv = Rx = (REGEXP*) newSV_type(SVt_REGEXP);
7742     RExC_rx = ReANY(Rx);
7743     if ( RExC_rx == NULL )
7744         FAIL("Regexp out of space");
7745
7746     rx_flags = orig_rx_flags;
7747
7748     if (   toUSE_UNI_CHARSET_NOT_DEPENDS
7749         && initial_charset == REGEX_DEPENDS_CHARSET)
7750     {
7751
7752         /* Set to use unicode semantics if the pattern is in utf8 and has the
7753          * 'depends' charset specified, as it means unicode when utf8  */
7754         set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
7755         RExC_uni_semantics = 1;
7756     }
7757
7758     RExC_pm_flags = pm_flags;
7759
7760     if (runtime_code) {
7761         assert(TAINTING_get || !TAINT_get);
7762         if (TAINT_get)
7763             Perl_croak(aTHX_ "Eval-group in insecure regular expression");
7764
7765         if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
7766             /* whoops, we have a non-utf8 pattern, whilst run-time code
7767              * got compiled as utf8. Try again with a utf8 pattern */
7768             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7769                 pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7770             goto redo_parse;
7771         }
7772     }
7773     assert(!pRExC_state->runtime_code_qr);
7774
7775     RExC_sawback = 0;
7776
7777     RExC_seen = 0;
7778     RExC_maxlen = 0;
7779     RExC_in_lookaround = 0;
7780     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
7781     RExC_recode_x_to_native = 0;
7782     RExC_in_multi_char_class = 0;
7783
7784     RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = RExC_precomp = exp;
7785     RExC_precomp_end = RExC_end = exp + plen;
7786     RExC_nestroot = 0;
7787     RExC_whilem_seen = 0;
7788     RExC_end_op = NULL;
7789     RExC_recurse = NULL;
7790     RExC_study_chunk_recursed = NULL;
7791     RExC_study_chunk_recursed_bytes= 0;
7792     RExC_recurse_count = 0;
7793     RExC_sets_depth = 0;
7794     pRExC_state->code_index = 0;
7795
7796     /* Initialize the string in the compiled pattern.  This is so that there is
7797      * something to output if necessary */
7798     set_regex_pv(pRExC_state, Rx);
7799
7800     DEBUG_PARSE_r({
7801         Perl_re_printf( aTHX_
7802             "Starting parse and generation\n");
7803         RExC_lastnum=0;
7804         RExC_lastparse=NULL;
7805     });
7806
7807     /* Allocate space and zero-initialize. Note, the two step process
7808        of zeroing when in debug mode, thus anything assigned has to
7809        happen after that */
7810     if (!  RExC_size) {
7811
7812         /* On the first pass of the parse, we guess how big this will be.  Then
7813          * we grow in one operation to that amount and then give it back.  As
7814          * we go along, we re-allocate what we need.
7815          *
7816          * XXX Currently the guess is essentially that the pattern will be an
7817          * EXACT node with one byte input, one byte output.  This is crude, and
7818          * better heuristics are welcome.
7819          *
7820          * On any subsequent passes, we guess what we actually computed in the
7821          * latest earlier pass.  Such a pass probably didn't complete so is
7822          * missing stuff.  We could improve those guesses by knowing where the
7823          * parse stopped, and use the length so far plus apply the above
7824          * assumption to what's left. */
7825         RExC_size = STR_SZ(RExC_end - RExC_start);
7826     }
7827
7828     Newxc(RExC_rxi, sizeof(regexp_internal) + RExC_size, char, regexp_internal);
7829     if ( RExC_rxi == NULL )
7830         FAIL("Regexp out of space");
7831
7832     Zero(RExC_rxi, sizeof(regexp_internal) + RExC_size, char);
7833     RXi_SET( RExC_rx, RExC_rxi );
7834
7835     /* We start from 0 (over from 0 in the case this is a reparse.  The first
7836      * node parsed will give back any excess memory we have allocated so far).
7837      * */
7838     RExC_size = 0;
7839
7840     /* non-zero initialization begins here */
7841     RExC_rx->engine= eng;
7842     RExC_rx->extflags = rx_flags;
7843     RXp_COMPFLAGS(RExC_rx) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
7844
7845     if (pm_flags & PMf_IS_QR) {
7846         RExC_rxi->code_blocks = pRExC_state->code_blocks;
7847         if (RExC_rxi->code_blocks) {
7848             RExC_rxi->code_blocks->refcnt++;
7849         }
7850     }
7851
7852     RExC_rx->intflags = 0;
7853
7854     RExC_flags = rx_flags;      /* don't let top level (?i) bleed */
7855     RExC_parse = exp;
7856
7857     /* This NUL is guaranteed because the pattern comes from an SV*, and the sv
7858      * code makes sure the final byte is an uncounted NUL.  But should this
7859      * ever not be the case, lots of things could read beyond the end of the
7860      * buffer: loops like
7861      *      while(isFOO(*RExC_parse)) RExC_parse++;
7862      *      strchr(RExC_parse, "foo");
7863      * etc.  So it is worth noting. */
7864     assert(*RExC_end == '\0');
7865
7866     RExC_naughty = 0;
7867     RExC_npar = 1;
7868     RExC_parens_buf_size = 0;
7869     RExC_emit_start = RExC_rxi->program;
7870     pRExC_state->code_index = 0;
7871
7872     *((char*) RExC_emit_start) = (char) REG_MAGIC;
7873     RExC_emit = 1;
7874
7875     /* Do the parse */
7876     if (reg(pRExC_state, 0, &flags, 1)) {
7877
7878         /* Success!, But we may need to redo the parse knowing how many parens
7879          * there actually are */
7880         if (IN_PARENS_PASS) {
7881             flags |= RESTART_PARSE;
7882         }
7883
7884         /* We have that number in RExC_npar */
7885         RExC_total_parens = RExC_npar;
7886     }
7887     else if (! MUST_RESTART(flags)) {
7888         ReREFCNT_dec(Rx);
7889         Perl_croak(aTHX_ "panic: reg returned failure to re_op_compile, flags=%#" UVxf, (UV) flags);
7890     }
7891
7892     /* Here, we either have success, or we have to redo the parse for some reason */
7893     if (MUST_RESTART(flags)) {
7894
7895         /* It's possible to write a regexp in ascii that represents Unicode
7896         codepoints outside of the byte range, such as via \x{100}. If we
7897         detect such a sequence we have to convert the entire pattern to utf8
7898         and then recompile, as our sizing calculation will have been based
7899         on 1 byte == 1 character, but we will need to use utf8 to encode
7900         at least some part of the pattern, and therefore must convert the whole
7901         thing.
7902         -- dmq */
7903         if (flags & NEED_UTF8) {
7904
7905             /* We have stored the offset of the final warning output so far.
7906              * That must be adjusted.  Any variant characters between the start
7907              * of the pattern and this warning count for 2 bytes in the final,
7908              * so just add them again */
7909             if (UNLIKELY(RExC_latest_warn_offset > 0)) {
7910                 RExC_latest_warn_offset +=
7911                             variant_under_utf8_count((U8 *) exp, (U8 *) exp
7912                                                 + RExC_latest_warn_offset);
7913             }
7914             S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
7915             pRExC_state->code_blocks ? pRExC_state->code_blocks->count : 0);
7916             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse after upgrade\n"));
7917         }
7918         else {
7919             DEBUG_PARSE_r(Perl_re_printf( aTHX_ "Need to redo parse\n"));
7920         }
7921
7922         if (ALL_PARENS_COUNTED) {
7923             /* Make enough room for all the known parens, and zero it */
7924             Renew(RExC_open_parens, RExC_total_parens, regnode_offset);
7925             Zero(RExC_open_parens, RExC_total_parens, regnode_offset);
7926             RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
7927
7928             Renew(RExC_close_parens, RExC_total_parens, regnode_offset);
7929             Zero(RExC_close_parens, RExC_total_parens, regnode_offset);
7930         }
7931         else { /* Parse did not complete.  Reinitialize the parentheses
7932                   structures */
7933             RExC_total_parens = 0;
7934             if (RExC_open_parens) {
7935                 Safefree(RExC_open_parens);
7936                 RExC_open_parens = NULL;
7937             }
7938             if (RExC_close_parens) {
7939                 Safefree(RExC_close_parens);
7940                 RExC_close_parens = NULL;
7941             }
7942         }
7943
7944         /* Clean up what we did in this parse */
7945         SvREFCNT_dec_NN(RExC_rx_sv);
7946
7947         goto redo_parse;
7948     }
7949
7950     /* Here, we have successfully parsed and generated the pattern's program
7951      * for the regex engine.  We are ready to finish things up and look for
7952      * optimizations. */
7953
7954     /* Update the string to compile, with correct modifiers, etc */
7955     set_regex_pv(pRExC_state, Rx);
7956
7957     RExC_rx->nparens = RExC_total_parens - 1;
7958
7959     /* Uses the upper 4 bits of the FLAGS field, so keep within that size */
7960     if (RExC_whilem_seen > 15)
7961         RExC_whilem_seen = 15;
7962
7963     DEBUG_PARSE_r({
7964         Perl_re_printf( aTHX_
7965             "Required size %" IVdf " nodes\n", (IV)RExC_size);
7966         RExC_lastnum=0;
7967         RExC_lastparse=NULL;
7968     });
7969
7970 #ifdef RE_TRACK_PATTERN_OFFSETS
7971     DEBUG_OFFSETS_r(Perl_re_printf( aTHX_
7972                           "%s %" UVuf " bytes for offset annotations.\n",
7973                           RExC_offsets ? "Got" : "Couldn't get",
7974                           (UV)((RExC_offsets[0] * 2 + 1))));
7975     DEBUG_OFFSETS_r(if (RExC_offsets) {
7976         const STRLEN len = RExC_offsets[0];
7977         STRLEN i;
7978         DECLARE_AND_GET_RE_DEBUG_FLAGS;
7979         Perl_re_printf( aTHX_
7980                       "Offsets: [%" UVuf "]\n\t", (UV)RExC_offsets[0]);
7981         for (i = 1; i <= len; i++) {
7982             if (RExC_offsets[i*2-1] || RExC_offsets[i*2])
7983                 Perl_re_printf( aTHX_  "%" UVuf ":%" UVuf "[%" UVuf "] ",
7984                 (UV)i, (UV)RExC_offsets[i*2-1], (UV)RExC_offsets[i*2]);
7985         }
7986         Perl_re_printf( aTHX_  "\n");
7987     });
7988
7989 #else
7990     SetProgLen(RExC_rxi,RExC_size);
7991 #endif
7992
7993     DEBUG_DUMP_PRE_OPTIMIZE_r({
7994         SV * const sv = sv_newmortal();
7995         RXi_GET_DECL(RExC_rx, ri);
7996         DEBUG_RExC_seen();
7997         Perl_re_printf( aTHX_ "Program before optimization:\n");
7998
7999         (void)dumpuntil(RExC_rx, ri->program, ri->program + 1, NULL, NULL,
8000                         sv, 0, 0);
8001     });
8002
8003     DEBUG_OPTIMISE_r(
8004         Perl_re_printf( aTHX_  "Starting post parse optimization\n");
8005     );
8006
8007     /* XXXX To minimize changes to RE engine we always allocate
8008        3-units-long substrs field. */
8009     Newx(RExC_rx->substrs, 1, struct reg_substr_data);
8010     if (RExC_recurse_count) {
8011         Newx(RExC_recurse, RExC_recurse_count, regnode *);
8012         SAVEFREEPV(RExC_recurse);
8013     }
8014
8015     if (RExC_seen & REG_RECURSE_SEEN) {
8016         /* Note, RExC_total_parens is 1 + the number of parens in a pattern.
8017          * So its 1 if there are no parens. */
8018         RExC_study_chunk_recursed_bytes= (RExC_total_parens >> 3) +
8019                                          ((RExC_total_parens & 0x07) != 0);
8020         Newx(RExC_study_chunk_recursed,
8021              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
8022         SAVEFREEPV(RExC_study_chunk_recursed);
8023     }
8024
8025   reStudy:
8026     RExC_rx->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
8027     DEBUG_r(
8028         RExC_study_chunk_recursed_count= 0;
8029     );
8030     Zero(RExC_rx->substrs, 1, struct reg_substr_data);
8031     if (RExC_study_chunk_recursed) {
8032         Zero(RExC_study_chunk_recursed,
8033              RExC_study_chunk_recursed_bytes * RExC_total_parens, U8);
8034     }
8035
8036
8037 #ifdef TRIE_STUDY_OPT
8038     if (!restudied) {
8039         StructCopy(&zero_scan_data, &data, scan_data_t);
8040         copyRExC_state = RExC_state;
8041     } else {
8042         U32 seen=RExC_seen;
8043         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "Restudying\n"));
8044
8045         RExC_state = copyRExC_state;
8046         if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
8047             RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
8048         else
8049             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
8050         StructCopy(&zero_scan_data, &data, scan_data_t);
8051     }
8052 #else
8053     StructCopy(&zero_scan_data, &data, scan_data_t);
8054 #endif
8055
8056     /* Dig out information for optimizations. */
8057     RExC_rx->extflags = RExC_flags; /* was pm_op */
8058     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
8059
8060     if (UTF)
8061         SvUTF8_on(Rx);  /* Unicode in it? */
8062     RExC_rxi->regstclass = NULL;
8063     if (RExC_naughty >= TOO_NAUGHTY)    /* Probably an expensive pattern. */
8064         RExC_rx->intflags |= PREGf_NAUGHTY;
8065     scan = RExC_rxi->program + 1;               /* First BRANCH. */
8066
8067     /* testing for BRANCH here tells us whether there is "must appear"
8068        data in the pattern. If there is then we can use it for optimisations */
8069     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
8070                                                   */
8071         SSize_t fake;
8072         STRLEN longest_length[2];
8073         regnode_ssc ch_class; /* pointed to by data */
8074         int stclass_flag;
8075         SSize_t last_close = 0; /* pointed to by data */
8076         regnode *first= scan;
8077         regnode *first_next= regnext(first);
8078         int i;
8079
8080         /*
8081          * Skip introductions and multiplicators >= 1
8082          * so that we can extract the 'meat' of the pattern that must
8083          * match in the large if() sequence following.
8084          * NOTE that EXACT is NOT covered here, as it is normally
8085          * picked up by the optimiser separately.
8086          *
8087          * This is unfortunate as the optimiser isnt handling lookahead
8088          * properly currently.
8089          *
8090          */
8091         while ((OP(first) == OPEN && (sawopen = 1)) ||
8092                /* An OR of *one* alternative - should not happen now. */
8093             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
8094             /* for now we can't handle lookbehind IFMATCH*/
8095             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
8096             (OP(first) == PLUS) ||
8097             (OP(first) == MINMOD) ||
8098                /* An {n,m} with n>0 */
8099             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
8100             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
8101         {
8102                 /*
8103                  * the only op that could be a regnode is PLUS, all the rest
8104                  * will be regnode_1 or regnode_2.
8105                  *
8106                  * (yves doesn't think this is true)
8107                  */
8108                 if (OP(first) == PLUS)
8109                     sawplus = 1;
8110                 else {
8111                     if (OP(first) == MINMOD)
8112                         sawminmod = 1;
8113                     first += regarglen[OP(first)];
8114                 }
8115                 first = NEXTOPER(first);
8116                 first_next= regnext(first);
8117         }
8118
8119         /* Starting-point info. */
8120       again:
8121         DEBUG_PEEP("first:", first, 0, 0);
8122         /* Ignore EXACT as we deal with it later. */
8123         if (PL_regkind[OP(first)] == EXACT) {
8124             if (! isEXACTFish(OP(first))) {
8125                 NOOP;   /* Empty, get anchored substr later. */
8126             }
8127             else
8128                 RExC_rxi->regstclass = first;
8129         }
8130 #ifdef TRIE_STCLASS
8131         else if (PL_regkind[OP(first)] == TRIE &&
8132                 ((reg_trie_data *)RExC_rxi->data->data[ ARG(first) ])->minlen>0)
8133         {
8134             /* this can happen only on restudy */
8135             RExC_rxi->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
8136         }
8137 #endif
8138         else if (REGNODE_SIMPLE(OP(first)))
8139             RExC_rxi->regstclass = first;
8140         else if (PL_regkind[OP(first)] == BOUND ||
8141                  PL_regkind[OP(first)] == NBOUND)
8142             RExC_rxi->regstclass = first;
8143         else if (PL_regkind[OP(first)] == BOL) {
8144             RExC_rx->intflags |= (OP(first) == MBOL
8145                            ? PREGf_ANCH_MBOL
8146                            : PREGf_ANCH_SBOL);
8147             first = NEXTOPER(first);
8148             goto again;
8149         }
8150         else if (OP(first) == GPOS) {
8151             RExC_rx->intflags |= PREGf_ANCH_GPOS;
8152             first = NEXTOPER(first);
8153             goto again;
8154         }
8155         else if ((!sawopen || !RExC_sawback) &&
8156             !sawlookahead &&
8157             (OP(first) == STAR &&
8158             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
8159             !(RExC_rx->intflags & PREGf_ANCH) && !pRExC_state->code_blocks)
8160         {
8161             /* turn .* into ^.* with an implied $*=1 */
8162             const int type =
8163                 (OP(NEXTOPER(first)) == REG_ANY)
8164                     ? PREGf_ANCH_MBOL
8165                     : PREGf_ANCH_SBOL;
8166             RExC_rx->intflags |= (type | PREGf_IMPLICIT);
8167             first = NEXTOPER(first);
8168             goto again;
8169         }
8170         if (sawplus && !sawminmod && !sawlookahead
8171             && (!sawopen || !RExC_sawback)
8172             && !pRExC_state->code_blocks) /* May examine pos and $& */
8173             /* x+ must match at the 1st pos of run of x's */
8174             RExC_rx->intflags |= PREGf_SKIP;
8175
8176         /* Scan is after the zeroth branch, first is atomic matcher. */
8177 #ifdef TRIE_STUDY_OPT
8178         DEBUG_PARSE_r(
8179             if (!restudied)
8180                 Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8181                               (IV)(first - scan + 1))
8182         );
8183 #else
8184         DEBUG_PARSE_r(
8185             Perl_re_printf( aTHX_  "first at %" IVdf "\n",
8186                 (IV)(first - scan + 1))
8187         );
8188 #endif
8189
8190
8191         /*
8192         * If there's something expensive in the r.e., find the
8193         * longest literal string that must appear and make it the
8194         * regmust.  Resolve ties in favor of later strings, since
8195         * the regstart check works with the beginning of the r.e.
8196         * and avoiding duplication strengthens checking.  Not a
8197         * strong reason, but sufficient in the absence of others.
8198         * [Now we resolve ties in favor of the earlier string if
8199         * it happens that c_offset_min has been invalidated, since the
8200         * earlier string may buy us something the later one won't.]
8201         */
8202
8203         data.substrs[0].str = newSVpvs("");
8204         data.substrs[1].str = newSVpvs("");
8205         data.last_found = newSVpvs("");
8206         data.cur_is_floating = 0; /* initially any found substring is fixed */
8207         ENTER_with_name("study_chunk");
8208         SAVEFREESV(data.substrs[0].str);
8209         SAVEFREESV(data.substrs[1].str);
8210         SAVEFREESV(data.last_found);
8211         first = scan;
8212         if (!RExC_rxi->regstclass) {
8213             ssc_init(pRExC_state, &ch_class);
8214             data.start_class = &ch_class;
8215             stclass_flag = SCF_DO_STCLASS_AND;
8216         } else                          /* XXXX Check for BOUND? */
8217             stclass_flag = 0;
8218         data.last_closep = &last_close;
8219
8220         DEBUG_RExC_seen();
8221         /*
8222          * MAIN ENTRY FOR study_chunk() FOR m/PATTERN/
8223          * (NO top level branches)
8224          */
8225         minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
8226                              scan + RExC_size, /* Up to end */
8227             &data, -1, 0, NULL,
8228             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
8229                           | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
8230             0, TRUE);
8231
8232
8233         CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
8234
8235
8236         if ( RExC_total_parens == 1 && !data.cur_is_floating
8237              && data.last_start_min == 0 && data.last_end > 0
8238              && !RExC_seen_zerolen
8239              && !(RExC_seen & REG_VERBARG_SEEN)
8240              && !(RExC_seen & REG_GPOS_SEEN)
8241         ){
8242             RExC_rx->extflags |= RXf_CHECK_ALL;
8243         }
8244         scan_commit(pRExC_state, &data,&minlen, 0);
8245
8246
8247         /* XXX this is done in reverse order because that's the way the
8248          * code was before it was parameterised. Don't know whether it
8249          * actually needs doing in reverse order. DAPM */
8250         for (i = 1; i >= 0; i--) {
8251             longest_length[i] = CHR_SVLEN(data.substrs[i].str);
8252
8253             if (   !(   i
8254                      && SvCUR(data.substrs[0].str)  /* ok to leave SvCUR */
8255                      &&    data.substrs[0].min_offset
8256                         == data.substrs[1].min_offset
8257                      &&    SvCUR(data.substrs[0].str)
8258                         == SvCUR(data.substrs[1].str)
8259                     )
8260                 && S_setup_longest (aTHX_ pRExC_state,
8261                                         &(RExC_rx->substrs->data[i]),
8262                                         &(data.substrs[i]),
8263                                         longest_length[i]))
8264             {
8265                 RExC_rx->substrs->data[i].min_offset =
8266                         data.substrs[i].min_offset - data.substrs[i].lookbehind;
8267
8268                 RExC_rx->substrs->data[i].max_offset = data.substrs[i].max_offset;
8269                 /* Don't offset infinity */
8270                 if (data.substrs[i].max_offset < OPTIMIZE_INFTY)
8271                     RExC_rx->substrs->data[i].max_offset -= data.substrs[i].lookbehind;
8272                 SvREFCNT_inc_simple_void_NN(data.substrs[i].str);
8273             }
8274             else {
8275                 RExC_rx->substrs->data[i].substr      = NULL;
8276                 RExC_rx->substrs->data[i].utf8_substr = NULL;
8277                 longest_length[i] = 0;
8278             }
8279         }
8280
8281         LEAVE_with_name("study_chunk");
8282
8283         if (RExC_rxi->regstclass
8284             && (OP(RExC_rxi->regstclass) == REG_ANY || OP(RExC_rxi->regstclass) == SANY))
8285             RExC_rxi->regstclass = NULL;
8286
8287         if ((!(RExC_rx->substrs->data[0].substr || RExC_rx->substrs->data[0].utf8_substr)
8288               || RExC_rx->substrs->data[0].min_offset)
8289             && stclass_flag
8290             && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8291             && is_ssc_worth_it(pRExC_state, data.start_class))
8292         {
8293             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8294
8295             ssc_finalize(pRExC_state, data.start_class);
8296
8297             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8298             StructCopy(data.start_class,
8299                        (regnode_ssc*)RExC_rxi->data->data[n],
8300                        regnode_ssc);
8301             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8302             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8303             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
8304                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8305                       Perl_re_printf( aTHX_
8306                                     "synthetic stclass \"%s\".\n",
8307                                     SvPVX_const(sv));});
8308             data.start_class = NULL;
8309         }
8310
8311         /* A temporary algorithm prefers floated substr to fixed one of
8312          * same length to dig more info. */
8313         i = (longest_length[0] <= longest_length[1]);
8314         RExC_rx->substrs->check_ix = i;
8315         RExC_rx->check_end_shift  = RExC_rx->substrs->data[i].end_shift;
8316         RExC_rx->check_substr     = RExC_rx->substrs->data[i].substr;
8317         RExC_rx->check_utf8       = RExC_rx->substrs->data[i].utf8_substr;
8318         RExC_rx->check_offset_min = RExC_rx->substrs->data[i].min_offset;
8319         RExC_rx->check_offset_max = RExC_rx->substrs->data[i].max_offset;
8320         if (!i && (RExC_rx->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS)))
8321             RExC_rx->intflags |= PREGf_NOSCAN;
8322
8323         if ((RExC_rx->check_substr || RExC_rx->check_utf8) ) {
8324             RExC_rx->extflags |= RXf_USE_INTUIT;
8325             if (SvTAIL(RExC_rx->check_substr ? RExC_rx->check_substr : RExC_rx->check_utf8))
8326                 RExC_rx->extflags |= RXf_INTUIT_TAIL;
8327         }
8328
8329         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
8330         if ( (STRLEN)minlen < longest_length[1] )
8331             minlen= longest_length[1];
8332         if ( (STRLEN)minlen < longest_length[0] )
8333             minlen= longest_length[0];
8334         */
8335     }
8336     else {
8337         /* Several toplevels. Best we can is to set minlen. */
8338         SSize_t fake;
8339         regnode_ssc ch_class;
8340         SSize_t last_close = 0;
8341
8342         DEBUG_PARSE_r(Perl_re_printf( aTHX_  "\nMulti Top Level\n"));
8343
8344         scan = RExC_rxi->program + 1;
8345         ssc_init(pRExC_state, &ch_class);
8346         data.start_class = &ch_class;
8347         data.last_closep = &last_close;
8348
8349         DEBUG_RExC_seen();
8350         /*
8351          * MAIN ENTRY FOR study_chunk() FOR m/P1|P2|.../
8352          * (patterns WITH top level branches)
8353          */
8354         minlen = study_chunk(pRExC_state,
8355             &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
8356             SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
8357                                                       ? SCF_TRIE_DOING_RESTUDY
8358                                                       : 0),
8359             0, TRUE);
8360
8361         CHECK_RESTUDY_GOTO_butfirst(NOOP);
8362
8363         RExC_rx->check_substr = NULL;
8364         RExC_rx->check_utf8 = NULL;
8365         RExC_rx->substrs->data[0].substr      = NULL;
8366         RExC_rx->substrs->data[0].utf8_substr = NULL;
8367         RExC_rx->substrs->data[1].substr      = NULL;
8368         RExC_rx->substrs->data[1].utf8_substr = NULL;
8369
8370         if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
8371             && is_ssc_worth_it(pRExC_state, data.start_class))
8372         {
8373             const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
8374
8375             ssc_finalize(pRExC_state, data.start_class);
8376
8377             Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
8378             StructCopy(data.start_class,
8379                        (regnode_ssc*)RExC_rxi->data->data[n],
8380                        regnode_ssc);
8381             RExC_rxi->regstclass = (regnode*)RExC_rxi->data->data[n];
8382             RExC_rx->intflags &= ~PREGf_SKIP;   /* Used in find_byclass(). */
8383             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
8384                       regprop(RExC_rx, sv, (regnode*)data.start_class, NULL, pRExC_state);
8385                       Perl_re_printf( aTHX_
8386                                     "synthetic stclass \"%s\".\n",
8387                                     SvPVX_const(sv));});
8388             data.start_class = NULL;
8389         }
8390     }
8391
8392     if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
8393         RExC_rx->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
8394         RExC_rx->maxlen = REG_INFTY;
8395     }
8396     else {
8397         RExC_rx->maxlen = RExC_maxlen;
8398     }
8399
8400     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
8401        the "real" pattern. */
8402     DEBUG_OPTIMISE_r({
8403         Perl_re_printf( aTHX_ "minlen: %" IVdf " RExC_rx->minlen:%" IVdf " maxlen:%" IVdf "\n",
8404                       (IV)minlen, (IV)RExC_rx->minlen, (IV)RExC_maxlen);
8405     });
8406     RExC_rx->minlenret = minlen;
8407     if (RExC_rx->minlen < minlen)
8408         RExC_rx->minlen = minlen;
8409
8410     if (RExC_seen & REG_RECURSE_SEEN ) {
8411         RExC_rx->intflags |= PREGf_RECURSE_SEEN;
8412         Newx(RExC_rx->recurse_locinput, RExC_rx->nparens + 1, char *);
8413     }
8414     if (RExC_seen & REG_GPOS_SEEN)
8415         RExC_rx->intflags |= PREGf_GPOS_SEEN;
8416     if (RExC_seen & REG_LOOKBEHIND_SEEN)
8417         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
8418                                                 lookbehind */
8419     if (pRExC_state->code_blocks)
8420         RExC_rx->extflags |= RXf_EVAL_SEEN;
8421     if (RExC_seen & REG_VERBARG_SEEN)
8422     {
8423         RExC_rx->intflags |= PREGf_VERBARG_SEEN;
8424         RExC_rx->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
8425     }
8426     if (RExC_seen & REG_CUTGROUP_SEEN)
8427         RExC_rx->intflags |= PREGf_CUTGROUP_SEEN;
8428     if (pm_flags & PMf_USE_RE_EVAL)
8429         RExC_rx->intflags |= PREGf_USE_RE_EVAL;
8430     if (RExC_paren_names)
8431         RXp_PAREN_NAMES(RExC_rx) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
8432     else
8433         RXp_PAREN_NAMES(RExC_rx) = NULL;
8434
8435     /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
8436      * so it can be used in pp.c */
8437     if (RExC_rx->intflags & PREGf_ANCH)
8438         RExC_rx->extflags |= RXf_IS_ANCHORED;
8439
8440
8441     {
8442         /* this is used to identify "special" patterns that might result
8443          * in Perl NOT calling the regex engine and instead doing the match "itself",
8444          * particularly special cases in split//. By having the regex compiler
8445          * do this pattern matching at a regop level (instead of by inspecting the pattern)
8446          * we avoid weird issues with equivalent patterns resulting in different behavior,
8447          * AND we allow non Perl engines to get the same optimizations by the setting the
8448          * flags appropriately - Yves */
8449         regnode *first = RExC_rxi->program + 1;
8450         U8 fop = OP(first);
8451         regnode *next = NEXTOPER(first);
8452         /* It's safe to read through *next only if OP(first) is a regop of
8453          * the right type (not EXACT, for example).
8454          */
8455         U8 nop = (fop == NOTHING || fop == MBOL || fop == SBOL || fop == PLUS)
8456                 ? OP(next) : 0;
8457
8458         if (PL_regkind[fop] == NOTHING && nop == END)
8459             RExC_rx->extflags |= RXf_NULL;
8460         else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
8461             /* when fop is SBOL first->flags will be true only when it was
8462              * produced by parsing /\A/, and not when parsing /^/. This is
8463              * very important for the split code as there we want to
8464              * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
8465              * See rt #122761 for more details. -- Yves */
8466             RExC_rx->extflags |= RXf_START_ONLY;
8467         else if (fop == PLUS
8468                  && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
8469                  && OP(regnext(first)) == END)
8470             RExC_rx->extflags |= RXf_WHITE;
8471         else if ( RExC_rx->extflags & RXf_SPLIT
8472                   && (PL_regkind[fop] == EXACT && ! isEXACTFish(fop))
8473                   && STR_LEN(first) == 1
8474                   && *(STRING(first)) == ' '
8475                   && OP(regnext(first)) == END )
8476             RExC_rx->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
8477
8478     }
8479
8480     if (RExC_contains_locale) {
8481         RXp_EXTFLAGS(RExC_rx) |= RXf_TAINTED;
8482     }
8483
8484 #ifdef DEBUGGING
8485     if (RExC_paren_names) {
8486         RExC_rxi->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
8487         RExC_rxi->data->data[RExC_rxi->name_list_idx]
8488                                    = (void*)SvREFCNT_inc(RExC_paren_name_list);
8489     } else
8490 #endif
8491     RExC_rxi->name_list_idx = 0;
8492
8493     while ( RExC_recurse_count > 0 ) {
8494         const regnode *scan = RExC_recurse[ --RExC_recurse_count ];
8495         /*
8496          * This data structure is set up in study_chunk() and is used
8497          * to calculate the distance between a GOSUB regopcode and
8498          * the OPEN/CURLYM (CURLYM's are special and can act like OPEN's)
8499          * it refers to.
8500          *
8501          * If for some reason someone writes code that optimises
8502          * away a GOSUB opcode then the assert should be changed to
8503          * an if(scan) to guard the ARG2L_SET() - Yves
8504          *
8505          */
8506         assert(scan && OP(scan) == GOSUB);
8507         ARG2L_SET( scan, RExC_open_parens[ARG(scan)] - REGNODE_OFFSET(scan));
8508     }
8509
8510     Newxz(RExC_rx->offs, RExC_total_parens, regexp_paren_pair);
8511     /* assume we don't need to swap parens around before we match */
8512     DEBUG_TEST_r({
8513         Perl_re_printf( aTHX_ "study_chunk_recursed_count: %lu\n",
8514             (unsigned long)RExC_study_chunk_recursed_count);
8515     });
8516     DEBUG_DUMP_r({
8517         DEBUG_RExC_seen();
8518         Perl_re_printf( aTHX_ "Final program:\n");
8519         regdump(RExC_rx);
8520     });
8521
8522     if (RExC_open_parens) {
8523         Safefree(RExC_open_parens);
8524         RExC_open_parens = NULL;
8525     }
8526     if (RExC_close_parens) {
8527         Safefree(RExC_close_parens);
8528         RExC_close_parens = NULL;
8529     }
8530
8531 #ifdef USE_ITHREADS
8532     /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
8533      * by setting the regexp SV to readonly-only instead. If the
8534      * pattern's been recompiled, the USEDness should remain. */
8535     if (old_re && SvREADONLY(old_re))
8536         SvREADONLY_on(Rx);
8537 #endif
8538     return Rx;
8539 }
8540
8541
8542 SV*
8543 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
8544                     const U32 flags)
8545 {
8546     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
8547
8548     PERL_UNUSED_ARG(value);
8549
8550     if (flags & RXapif_FETCH) {
8551         return reg_named_buff_fetch(rx, key, flags);
8552     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
8553         Perl_croak_no_modify();
8554         return NULL;
8555     } else if (flags & RXapif_EXISTS) {
8556         return reg_named_buff_exists(rx, key, flags)
8557             ? &PL_sv_yes
8558             : &PL_sv_no;
8559     } else if (flags & RXapif_REGNAMES) {
8560         return reg_named_buff_all(rx, flags);
8561     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
8562         return reg_named_buff_scalar(rx, flags);
8563     } else {
8564         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
8565         return NULL;
8566     }
8567 }
8568
8569 SV*
8570 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
8571                          const U32 flags)
8572 {
8573     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
8574     PERL_UNUSED_ARG(lastkey);
8575
8576     if (flags & RXapif_FIRSTKEY)
8577         return reg_named_buff_firstkey(rx, flags);
8578     else if (flags & RXapif_NEXTKEY)
8579         return reg_named_buff_nextkey(rx, flags);
8580     else {
8581         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
8582                                             (int)flags);
8583         return NULL;
8584     }
8585 }
8586
8587 SV*
8588 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
8589                           const U32 flags)
8590 {
8591     SV *ret;
8592     struct regexp *const rx = ReANY(r);
8593
8594     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
8595
8596     if (rx && RXp_PAREN_NAMES(rx)) {
8597         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
8598         if (he_str) {
8599             IV i;
8600             SV* sv_dat=HeVAL(he_str);
8601             I32 *nums=(I32*)SvPVX(sv_dat);
8602             AV * const retarray = (flags & RXapif_ALL) ? newAV() : NULL;
8603             for ( i=0; i<SvIVX(sv_dat); i++ ) {
8604                 if ((I32)(rx->nparens) >= nums[i]
8605                     && rx->offs[nums[i]].start != -1
8606                     && rx->offs[nums[i]].end != -1)
8607                 {
8608                     ret = newSVpvs("");
8609                     CALLREG_NUMBUF_FETCH(r, nums[i], ret);
8610                     if (!retarray)
8611                         return ret;
8612                 } else {
8613                     if (retarray)
8614                         ret = newSVsv(&PL_sv_undef);
8615                 }
8616                 if (retarray)
8617                     av_push(retarray, ret);
8618             }
8619             if (retarray)
8620                 return newRV_noinc(MUTABLE_SV(retarray));
8621         }
8622     }
8623     return NULL;
8624 }
8625
8626 bool
8627 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
8628                            const U32 flags)
8629 {
8630     struct regexp *const rx = ReANY(r);
8631
8632     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
8633
8634     if (rx && RXp_PAREN_NAMES(rx)) {
8635         if (flags & RXapif_ALL) {
8636             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
8637         } else {
8638             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
8639             if (sv) {
8640                 SvREFCNT_dec_NN(sv);
8641                 return TRUE;
8642             } else {
8643                 return FALSE;
8644             }
8645         }
8646     } else {
8647         return FALSE;
8648     }
8649 }
8650
8651 SV*
8652 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
8653 {
8654     struct regexp *const rx = ReANY(r);
8655
8656     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
8657
8658     if ( rx && RXp_PAREN_NAMES(rx) ) {
8659         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
8660
8661         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
8662     } else {
8663         return FALSE;
8664     }
8665 }
8666
8667 SV*
8668 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
8669 {
8670     struct regexp *const rx = ReANY(r);
8671     DECLARE_AND_GET_RE_DEBUG_FLAGS;
8672
8673     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
8674
8675     if (rx && RXp_PAREN_NAMES(rx)) {
8676         HV *hv = RXp_PAREN_NAMES(rx);
8677         HE *temphe;
8678         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8679             IV i;
8680             IV parno = 0;
8681             SV* sv_dat = HeVAL(temphe);
8682             I32 *nums = (I32*)SvPVX(sv_dat);
8683             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8684                 if ((I32)(rx->lastparen) >= nums[i] &&
8685                     rx->offs[nums[i]].start != -1 &&
8686                     rx->offs[nums[i]].end != -1)
8687                 {
8688                     parno = nums[i];
8689                     break;
8690                 }
8691             }
8692             if (parno || flags & RXapif_ALL) {
8693                 return newSVhek(HeKEY_hek(temphe));
8694             }
8695         }
8696     }
8697     return NULL;
8698 }
8699
8700 SV*
8701 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
8702 {
8703     SV *ret;
8704     AV *av;
8705     SSize_t length;
8706     struct regexp *const rx = ReANY(r);
8707
8708     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
8709
8710     if (rx && RXp_PAREN_NAMES(rx)) {
8711         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
8712             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
8713         } else if (flags & RXapif_ONE) {
8714             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
8715             av = MUTABLE_AV(SvRV(ret));
8716             length = av_count(av);
8717             SvREFCNT_dec_NN(ret);
8718             return newSViv(length);
8719         } else {
8720             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
8721                                                 (int)flags);
8722             return NULL;
8723         }
8724     }
8725     return &PL_sv_undef;
8726 }
8727
8728 SV*
8729 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
8730 {
8731     struct regexp *const rx = ReANY(r);
8732     AV *av = newAV();
8733
8734     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
8735
8736     if (rx && RXp_PAREN_NAMES(rx)) {
8737         HV *hv= RXp_PAREN_NAMES(rx);
8738         HE *temphe;
8739         (void)hv_iterinit(hv);
8740         while ( (temphe = hv_iternext_flags(hv, 0)) ) {
8741             IV i;
8742             IV parno = 0;
8743             SV* sv_dat = HeVAL(temphe);
8744             I32 *nums = (I32*)SvPVX(sv_dat);
8745             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
8746                 if ((I32)(rx->lastparen) >= nums[i] &&
8747                     rx->offs[nums[i]].start != -1 &&
8748                     rx->offs[nums[i]].end != -1)
8749                 {
8750                     parno = nums[i];
8751                     break;
8752                 }
8753             }
8754             if (parno || flags & RXapif_ALL) {
8755                 av_push(av, newSVhek(HeKEY_hek(temphe)));
8756             }
8757         }
8758     }
8759
8760     return newRV_noinc(MUTABLE_SV(av));
8761 }
8762
8763 void
8764 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
8765                              SV * const sv)
8766 {
8767     struct regexp *const rx = ReANY(r);
8768     char *s = NULL;
8769     SSize_t i = 0;
8770     SSize_t s1, t1;
8771     I32 n = paren;
8772
8773     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
8774
8775     if (      n == RX_BUFF_IDX_CARET_PREMATCH
8776            || n == RX_BUFF_IDX_CARET_FULLMATCH
8777            || n == RX_BUFF_IDX_CARET_POSTMATCH
8778        )
8779     {
8780         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8781         if (!keepcopy) {
8782             /* on something like
8783              *    $r = qr/.../;
8784              *    /$qr/p;
8785              * the KEEPCOPY is set on the PMOP rather than the regex */
8786             if (PL_curpm && r == PM_GETRE(PL_curpm))
8787                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8788         }
8789         if (!keepcopy)
8790             goto ret_undef;
8791     }
8792
8793     if (!rx->subbeg)
8794         goto ret_undef;
8795
8796     if (n == RX_BUFF_IDX_CARET_FULLMATCH)
8797         /* no need to distinguish between them any more */
8798         n = RX_BUFF_IDX_FULLMATCH;
8799
8800     if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
8801         && rx->offs[0].start != -1)
8802     {
8803         /* $`, ${^PREMATCH} */
8804         i = rx->offs[0].start;
8805         s = rx->subbeg;
8806     }
8807     else
8808     if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
8809         && rx->offs[0].end != -1)
8810     {
8811         /* $', ${^POSTMATCH} */
8812         s = rx->subbeg - rx->suboffset + rx->offs[0].end;
8813         i = rx->sublen + rx->suboffset - rx->offs[0].end;
8814     }
8815     else
8816     if (inRANGE(n, 0, (I32)rx->nparens) &&
8817         (s1 = rx->offs[n].start) != -1  &&
8818         (t1 = rx->offs[n].end) != -1)
8819     {
8820         /* $&, ${^MATCH},  $1 ... */
8821         i = t1 - s1;
8822         s = rx->subbeg + s1 - rx->suboffset;
8823     } else {
8824         goto ret_undef;
8825     }
8826
8827     assert(s >= rx->subbeg);
8828     assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
8829     if (i >= 0) {
8830 #ifdef NO_TAINT_SUPPORT
8831         sv_setpvn(sv, s, i);
8832 #else
8833         const int oldtainted = TAINT_get;
8834         TAINT_NOT;
8835         sv_setpvn(sv, s, i);
8836         TAINT_set(oldtainted);
8837 #endif
8838         if (RXp_MATCH_UTF8(rx))
8839             SvUTF8_on(sv);
8840         else
8841             SvUTF8_off(sv);
8842         if (TAINTING_get) {
8843             if (RXp_MATCH_TAINTED(rx)) {
8844                 if (SvTYPE(sv) >= SVt_PVMG) {
8845                     MAGIC* const mg = SvMAGIC(sv);
8846                     MAGIC* mgt;
8847                     TAINT;
8848                     SvMAGIC_set(sv, mg->mg_moremagic);
8849                     SvTAINT(sv);
8850                     if ((mgt = SvMAGIC(sv))) {
8851                         mg->mg_moremagic = mgt;
8852                         SvMAGIC_set(sv, mg);
8853                     }
8854                 } else {
8855                     TAINT;
8856                     SvTAINT(sv);
8857                 }
8858             } else
8859                 SvTAINTED_off(sv);
8860         }
8861     } else {
8862       ret_undef:
8863         sv_set_undef(sv);
8864         return;
8865     }
8866 }
8867
8868 void
8869 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
8870                                                          SV const * const value)
8871 {
8872     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
8873
8874     PERL_UNUSED_ARG(rx);
8875     PERL_UNUSED_ARG(paren);
8876     PERL_UNUSED_ARG(value);
8877
8878     if (!PL_localizing)
8879         Perl_croak_no_modify();
8880 }
8881
8882 I32
8883 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
8884                               const I32 paren)
8885 {
8886     struct regexp *const rx = ReANY(r);
8887     I32 i;
8888     I32 s1, t1;
8889
8890     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
8891
8892     if (   paren == RX_BUFF_IDX_CARET_PREMATCH
8893         || paren == RX_BUFF_IDX_CARET_FULLMATCH
8894         || paren == RX_BUFF_IDX_CARET_POSTMATCH
8895     )
8896     {
8897         bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
8898         if (!keepcopy) {
8899             /* on something like
8900              *    $r = qr/.../;
8901              *    /$qr/p;
8902              * the KEEPCOPY is set on the PMOP rather than the regex */
8903             if (PL_curpm && r == PM_GETRE(PL_curpm))
8904                  keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
8905         }
8906         if (!keepcopy)
8907             goto warn_undef;
8908     }
8909
8910     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
8911     switch (paren) {
8912       case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
8913       case RX_BUFF_IDX_PREMATCH:       /* $` */
8914         if (rx->offs[0].start != -1) {
8915                         i = rx->offs[0].start;
8916                         if (i > 0) {
8917                                 s1 = 0;
8918                                 t1 = i;
8919                                 goto getlen;
8920                         }
8921             }
8922         return 0;
8923
8924       case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
8925       case RX_BUFF_IDX_POSTMATCH:       /* $' */
8926             if (rx->offs[0].end != -1) {
8927                         i = rx->sublen - rx->offs[0].end;
8928                         if (i > 0) {
8929                                 s1 = rx->offs[0].end;
8930                                 t1 = rx->sublen;
8931                                 goto getlen;
8932                         }
8933             }
8934         return 0;
8935
8936       default: /* $& / ${^MATCH}, $1, $2, ... */
8937             if (paren <= (I32)rx->nparens &&
8938             (s1 = rx->offs[paren].start) != -1 &&
8939             (t1 = rx->offs[paren].end) != -1)
8940             {
8941             i = t1 - s1;
8942             goto getlen;
8943         } else {
8944           warn_undef:
8945             if (ckWARN(WARN_UNINITIALIZED))
8946                 report_uninit((const SV *)sv);
8947             return 0;
8948         }
8949     }
8950   getlen:
8951     if (i > 0 && RXp_MATCH_UTF8(rx)) {
8952         const char * const s = rx->subbeg - rx->suboffset + s1;
8953         const U8 *ep;
8954         STRLEN el;
8955
8956         i = t1 - s1;
8957         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
8958             i = el;
8959     }
8960     return i;
8961 }
8962
8963 SV*
8964 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
8965 {
8966     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
8967         PERL_UNUSED_ARG(rx);
8968         if (0)
8969             return NULL;
8970         else
8971             return newSVpvs("Regexp");
8972 }
8973
8974 /* Scans the name of a named buffer from the pattern.
8975  * If flags is REG_RSN_RETURN_NULL returns null.
8976  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
8977  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
8978  * to the parsed name as looked up in the RExC_paren_names hash.
8979  * If there is an error throws a vFAIL().. type exception.
8980  */
8981
8982 #define REG_RSN_RETURN_NULL    0
8983 #define REG_RSN_RETURN_NAME    1
8984 #define REG_RSN_RETURN_DATA    2
8985
8986 STATIC SV*
8987 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
8988 {
8989     char *name_start = RExC_parse;
8990     SV* sv_name;
8991
8992     PERL_ARGS_ASSERT_REG_SCAN_NAME;
8993
8994     assert (RExC_parse <= RExC_end);
8995     if (RExC_parse == RExC_end) NOOP;
8996     else if (isIDFIRST_lazy_if_safe(RExC_parse, RExC_end, UTF)) {
8997          /* Note that the code here assumes well-formed UTF-8.  Skip IDFIRST by
8998           * using do...while */
8999         if (UTF)
9000             do {
9001                 RExC_parse += UTF8SKIP(RExC_parse);
9002             } while (   RExC_parse < RExC_end
9003                      && isWORDCHAR_utf8_safe((U8*)RExC_parse, (U8*) RExC_end));
9004         else
9005             do {
9006                 RExC_parse++;
9007             } while (RExC_parse < RExC_end && isWORDCHAR(*RExC_parse));
9008     } else {
9009         RExC_parse++; /* so the <- from the vFAIL is after the offending
9010                          character */
9011         vFAIL("Group name must start with a non-digit word character");
9012     }
9013     sv_name = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
9014                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
9015     if ( flags == REG_RSN_RETURN_NAME)
9016         return sv_name;
9017     else if (flags==REG_RSN_RETURN_DATA) {
9018         HE *he_str = NULL;
9019         SV *sv_dat = NULL;
9020         if ( ! sv_name )      /* should not happen*/
9021             Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
9022         if (RExC_paren_names)
9023             he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
9024         if ( he_str )
9025             sv_dat = HeVAL(he_str);
9026         if ( ! sv_dat ) {   /* Didn't find group */
9027
9028             /* It might be a forward reference; we can't fail until we
9029                 * know, by completing the parse to get all the groups, and
9030                 * then reparsing */
9031             if (ALL_PARENS_COUNTED)  {
9032                 vFAIL("Reference to nonexistent named group");
9033             }
9034             else {
9035                 REQUIRE_PARENS_PASS;
9036             }
9037         }
9038         return sv_dat;
9039     }
9040
9041     Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
9042                      (unsigned long) flags);
9043 }
9044
9045 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
9046     if (RExC_lastparse!=RExC_parse) {                           \
9047         Perl_re_printf( aTHX_  "%s",                            \
9048             Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
9049                 RExC_end - RExC_parse, 16,                      \
9050                 "", "",                                         \
9051                 PERL_PV_ESCAPE_UNI_DETECT |                     \
9052                 PERL_PV_PRETTY_ELLIPSES   |                     \
9053                 PERL_PV_PRETTY_LTGT       |                     \
9054                 PERL_PV_ESCAPE_RE         |                     \
9055                 PERL_PV_PRETTY_EXACTSIZE                        \
9056             )                                                   \
9057         );                                                      \
9058     } else                                                      \
9059         Perl_re_printf( aTHX_ "%16s","");                       \
9060                                                                 \
9061     if (RExC_lastnum!=RExC_emit)                                \
9062        Perl_re_printf( aTHX_ "|%4zu", RExC_emit);                \
9063     else                                                        \
9064        Perl_re_printf( aTHX_ "|%4s","");                        \
9065     Perl_re_printf( aTHX_ "|%*s%-4s",                           \
9066         (int)((depth*2)), "",                                   \
9067         (funcname)                                              \
9068     );                                                          \
9069     RExC_lastnum=RExC_emit;                                     \
9070     RExC_lastparse=RExC_parse;                                  \
9071 })
9072
9073
9074
9075 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
9076     DEBUG_PARSE_MSG((funcname));                            \
9077     Perl_re_printf( aTHX_ "%4s","\n");                                  \
9078 })
9079 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({\
9080     DEBUG_PARSE_MSG((funcname));                            \
9081     Perl_re_printf( aTHX_ fmt "\n",args);                               \
9082 })
9083
9084 /* This section of code defines the inversion list object and its methods.  The
9085  * interfaces are highly subject to change, so as much as possible is static to
9086  * this file.  An inversion list is here implemented as a malloc'd C UV array
9087  * as an SVt_INVLIST scalar.
9088  *
9089  * An inversion list for Unicode is an array of code points, sorted by ordinal
9090  * number.  Each element gives the code point that begins a range that extends
9091  * up-to but not including the code point given by the next element.  The final
9092  * element gives the first code point of a range that extends to the platform's
9093  * infinity.  The even-numbered elements (invlist[0], invlist[2], invlist[4],
9094  * ...) give ranges whose code points are all in the inversion list.  We say
9095  * that those ranges are in the set.  The odd-numbered elements give ranges
9096  * whose code points are not in the inversion list, and hence not in the set.
9097  * Thus, element [0] is the first code point in the list.  Element [1]
9098  * is the first code point beyond that not in the list; and element [2] is the
9099  * first code point beyond that that is in the list.  In other words, the first
9100  * range is invlist[0]..(invlist[1]-1), and all code points in that range are
9101  * in the inversion list.  The second range is invlist[1]..(invlist[2]-1), and
9102  * all code points in that range are not in the inversion list.  The third
9103  * range invlist[2]..(invlist[3]-1) gives code points that are in the inversion
9104  * list, and so forth.  Thus every element whose index is divisible by two
9105  * gives the beginning of a range that is in the list, and every element whose
9106  * index is not divisible by two gives the beginning of a range not in the
9107  * list.  If the final element's index is divisible by two, the inversion list
9108  * extends to the platform's infinity; otherwise the highest code point in the
9109  * inversion list is the contents of that element minus 1.
9110  *
9111  * A range that contains just a single code point N will look like
9112  *  invlist[i]   == N
9113  *  invlist[i+1] == N+1
9114  *
9115  * If N is UV_MAX (the highest representable code point on the machine), N+1 is
9116  * impossible to represent, so element [i+1] is omitted.  The single element
9117  * inversion list
9118  *  invlist[0] == UV_MAX
9119  * contains just UV_MAX, but is interpreted as matching to infinity.
9120  *
9121  * Taking the complement (inverting) an inversion list is quite simple, if the
9122  * first element is 0, remove it; otherwise add a 0 element at the beginning.
9123  * This implementation reserves an element at the beginning of each inversion
9124  * list to always contain 0; there is an additional flag in the header which
9125  * indicates if the list begins at the 0, or is offset to begin at the next
9126  * element.  This means that the inversion list can be inverted without any
9127  * copying; just flip the flag.
9128  *
9129  * More about inversion lists can be found in "Unicode Demystified"
9130  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
9131  *
9132  * The inversion list data structure is currently implemented as an SV pointing
9133  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
9134  * array of UV whose memory management is automatically handled by the existing
9135  * facilities for SV's.
9136  *
9137  * Some of the methods should always be private to the implementation, and some
9138  * should eventually be made public */
9139
9140 /* The header definitions are in F<invlist_inline.h> */
9141
9142 #ifndef PERL_IN_XSUB_RE
9143
9144 PERL_STATIC_INLINE UV*
9145 S__invlist_array_init(SV* const invlist, const bool will_have_0)
9146 {
9147     /* Returns a pointer to the first element in the inversion list's array.
9148      * This is called upon initialization of an inversion list.  Where the
9149      * array begins depends on whether the list has the code point U+0000 in it
9150      * or not.  The other parameter tells it whether the code that follows this
9151      * call is about to put a 0 in the inversion list or not.  The first
9152      * element is either the element reserved for 0, if TRUE, or the element
9153      * after it, if FALSE */
9154
9155     bool* offset = get_invlist_offset_addr(invlist);
9156     UV* zero_addr = (UV *) SvPVX(invlist);
9157
9158     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
9159
9160     /* Must be empty */
9161     assert(! _invlist_len(invlist));
9162
9163     *zero_addr = 0;
9164
9165     /* 1^1 = 0; 1^0 = 1 */
9166     *offset = 1 ^ will_have_0;
9167     return zero_addr + *offset;
9168 }
9169
9170 STATIC void
9171 S_invlist_replace_list_destroys_src(pTHX_ SV * dest, SV * src)
9172 {
9173     /* Replaces the inversion list in 'dest' with the one from 'src'.  It
9174      * steals the list from 'src', so 'src' is made to have a NULL list.  This
9175      * is similar to what SvSetMagicSV() would do, if it were implemented on
9176      * inversion lists, though this routine avoids a copy */
9177
9178     const UV src_len          = _invlist_len(src);
9179     const bool src_offset     = *get_invlist_offset_addr(src);
9180     const STRLEN src_byte_len = SvLEN(src);
9181     char * array              = SvPVX(src);
9182
9183     const int oldtainted = TAINT_get;
9184
9185     PERL_ARGS_ASSERT_INVLIST_REPLACE_LIST_DESTROYS_SRC;
9186
9187     assert(is_invlist(src));
9188     assert(is_invlist(dest));
9189     assert(! invlist_is_iterating(src));
9190     assert(SvCUR(src) == 0 || SvCUR(src) < SvLEN(src));
9191
9192     /* Make sure it ends in the right place with a NUL, as our inversion list
9193      * manipulations aren't careful to keep this true, but sv_usepvn_flags()
9194      * asserts it */
9195     array[src_byte_len - 1] = '\0';
9196
9197     TAINT_NOT;      /* Otherwise it breaks */
9198     sv_usepvn_flags(dest,
9199                     (char *) array,
9200                     src_byte_len - 1,
9201
9202                     /* This flag is documented to cause a copy to be avoided */
9203                     SV_HAS_TRAILING_NUL);
9204     TAINT_set(oldtainted);
9205     SvPV_set(src, 0);
9206     SvLEN_set(src, 0);
9207     SvCUR_set(src, 0);
9208
9209     /* Finish up copying over the other fields in an inversion list */
9210     *get_invlist_offset_addr(dest) = src_offset;
9211     invlist_set_len(dest, src_len, src_offset);
9212     *get_invlist_previous_index_addr(dest) = 0;
9213     invlist_iterfinish(dest);
9214 }
9215
9216 PERL_STATIC_INLINE IV*
9217 S_get_invlist_previous_index_addr(SV* invlist)
9218 {
9219     /* Return the address of the IV that is reserved to hold the cached index
9220      * */
9221     PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
9222
9223     assert(is_invlist(invlist));
9224
9225     return &(((XINVLIST*) SvANY(invlist))->prev_index);
9226 }
9227
9228 PERL_STATIC_INLINE IV
9229 S_invlist_previous_index(SV* const invlist)
9230 {
9231     /* Returns cached index of previous search */
9232
9233     PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
9234
9235     return *get_invlist_previous_index_addr(invlist);
9236 }
9237
9238 PERL_STATIC_INLINE void
9239 S_invlist_set_previous_index(SV* const invlist, const IV index)
9240 {
9241     /* Caches <index> for later retrieval */
9242
9243     PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
9244
9245     assert(index == 0 || index < (int) _invlist_len(invlist));
9246
9247     *get_invlist_previous_index_addr(invlist) = index;
9248 }
9249
9250 PERL_STATIC_INLINE void
9251 S_invlist_trim(SV* invlist)
9252 {
9253     /* Free the not currently-being-used space in an inversion list */
9254
9255     /* But don't free up the space needed for the 0 UV that is always at the
9256      * beginning of the list, nor the trailing NUL */
9257     const UV min_size = TO_INTERNAL_SIZE(1) + 1;
9258
9259     PERL_ARGS_ASSERT_INVLIST_TRIM;
9260
9261     assert(is_invlist(invlist));
9262
9263     SvPV_renew(invlist, MAX(min_size, SvCUR(invlist) + 1));
9264 }
9265
9266 PERL_STATIC_INLINE void
9267 S_invlist_clear(pTHX_ SV* invlist)    /* Empty the inversion list */
9268 {
9269     PERL_ARGS_ASSERT_INVLIST_CLEAR;
9270
9271     assert(is_invlist(invlist));
9272
9273     invlist_set_len(invlist, 0, 0);
9274     invlist_trim(invlist);
9275 }
9276
9277 #endif /* ifndef PERL_IN_XSUB_RE */
9278
9279 PERL_STATIC_INLINE bool
9280 S_invlist_is_iterating(SV* const invlist)
9281 {
9282     PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
9283
9284     return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
9285 }
9286
9287 #ifndef PERL_IN_XSUB_RE
9288
9289 PERL_STATIC_INLINE UV
9290 S_invlist_max(SV* const invlist)
9291 {
9292     /* Returns the maximum number of elements storable in the inversion list's
9293      * array, without having to realloc() */
9294
9295     PERL_ARGS_ASSERT_INVLIST_MAX;
9296
9297     assert(is_invlist(invlist));
9298
9299     /* Assumes worst case, in which the 0 element is not counted in the
9300      * inversion list, so subtracts 1 for that */
9301     return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
9302            ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
9303            : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
9304 }
9305
9306 STATIC void
9307 S_initialize_invlist_guts(pTHX_ SV* invlist, const Size_t initial_size)
9308 {
9309     PERL_ARGS_ASSERT_INITIALIZE_INVLIST_GUTS;
9310
9311     /* First 1 is in case the zero element isn't in the list; second 1 is for
9312      * trailing NUL */
9313     SvGROW(invlist, TO_INTERNAL_SIZE(initial_size + 1) + 1);
9314     invlist_set_len(invlist, 0, 0);
9315
9316     /* Force iterinit() to be used to get iteration to work */
9317     invlist_iterfinish(invlist);
9318
9319     *get_invlist_previous_index_addr(invlist) = 0;
9320     SvPOK_on(invlist);  /* This allows B to extract the PV */
9321 }
9322
9323 SV*
9324 Perl__new_invlist(pTHX_ IV initial_size)
9325 {
9326
9327     /* Return a pointer to a newly constructed inversion list, with enough
9328      * space to store 'initial_size' elements.  If that number is negative, a
9329      * system default is used instead */
9330
9331     SV* new_list;
9332
9333     if (initial_size < 0) {
9334         initial_size = 10;
9335     }
9336
9337     new_list = newSV_type(SVt_INVLIST);
9338     initialize_invlist_guts(new_list, initial_size);
9339
9340     return new_list;
9341 }
9342
9343 SV*
9344 Perl__new_invlist_C_array(pTHX_ const UV* const list)
9345 {
9346     /* Return a pointer to a newly constructed inversion list, initialized to
9347      * point to <list>, which has to be in the exact correct inversion list
9348      * form, including internal fields.  Thus this is a dangerous routine that
9349      * should not be used in the wrong hands.  The passed in 'list' contains
9350      * several header fields at the beginning that are not part of the
9351      * inversion list body proper */
9352
9353     const STRLEN length = (STRLEN) list[0];
9354     const UV version_id =          list[1];
9355     const bool offset   =    cBOOL(list[2]);
9356 #define HEADER_LENGTH 3
9357     /* If any of the above changes in any way, you must change HEADER_LENGTH
9358      * (if appropriate) and regenerate INVLIST_VERSION_ID by running
9359      *      perl -E 'say int(rand 2**31-1)'
9360      */
9361 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
9362                                         data structure type, so that one being
9363                                         passed in can be validated to be an
9364                                         inversion list of the correct vintage.
9365                                        */
9366
9367     SV* invlist = newSV_type(SVt_INVLIST);
9368
9369     PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
9370
9371     if (version_id != INVLIST_VERSION_ID) {
9372         Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
9373     }
9374
9375     /* The generated array passed in includes header elements that aren't part
9376      * of the list proper, so start it just after them */
9377     SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
9378
9379     SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
9380                                shouldn't touch it */
9381
9382     *(get_invlist_offset_addr(invlist)) = offset;
9383
9384     /* The 'length' passed to us is the physical number of elements in the
9385      * inversion list.  But if there is an offset the logical number is one
9386      * less than that */
9387     invlist_set_len(invlist, length  - offset, offset);
9388
9389     invlist_set_previous_index(invlist, 0);
9390
9391     /* Initialize the iteration pointer. */
9392     invlist_iterfinish(invlist);
9393
9394     SvREADONLY_on(invlist);
9395     SvPOK_on(invlist);
9396
9397     return invlist;
9398 }
9399
9400 STATIC void
9401 S__append_range_to_invlist(pTHX_ SV* const invlist,
9402                                  const UV start, const UV end)
9403 {
9404    /* Subject to change or removal.  Append the range from 'start' to 'end' at
9405     * the end of the inversion list.  The range must be above any existing
9406     * ones. */
9407
9408     UV* array;
9409     UV max = invlist_max(invlist);
9410     UV len = _invlist_len(invlist);
9411     bool offset;
9412
9413     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
9414
9415     if (len == 0) { /* Empty lists must be initialized */
9416         offset = start != 0;
9417         array = _invlist_array_init(invlist, ! offset);
9418     }
9419     else {
9420         /* Here, the existing list is non-empty. The current max entry in the
9421          * list is generally the first value not in the set, except when the
9422          * set extends to the end of permissible values, in which case it is
9423          * the first entry in that final set, and so this call is an attempt to
9424          * append out-of-order */
9425
9426         UV final_element = len - 1;
9427         array = invlist_array(invlist);
9428         if (   array[final_element] > start
9429             || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
9430         {
9431             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",
9432                      array[final_element], start,
9433                      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
9434         }
9435
9436         /* Here, it is a legal append.  If the new range begins 1 above the end
9437          * of the range below it, it is extending the range below it, so the
9438          * new first value not in the set is one greater than the newly
9439          * extended range.  */
9440         offset = *get_invlist_offset_addr(invlist);
9441         if (array[final_element] == start) {
9442             if (end != UV_MAX) {
9443                 array[final_element] = end + 1;
9444             }
9445             else {
9446                 /* But if the end is the maximum representable on the machine,
9447                  * assume that infinity was actually what was meant.  Just let
9448                  * the range that this would extend to have no end */
9449                 invlist_set_len(invlist, len - 1, offset);
9450             }
9451             return;
9452         }
9453     }
9454
9455     /* Here the new range doesn't extend any existing set.  Add it */
9456
9457     len += 2;   /* Includes an element each for the start and end of range */
9458
9459     /* If wll overflow the existing space, extend, which may cause the array to
9460      * be moved */
9461     if (max < len) {
9462         invlist_extend(invlist, len);
9463
9464         /* Have to set len here to avoid assert failure in invlist_array() */
9465         invlist_set_len(invlist, len, offset);
9466
9467         array = invlist_array(invlist);
9468     }
9469     else {
9470         invlist_set_len(invlist, len, offset);
9471     }
9472
9473     /* The next item on the list starts the range, the one after that is
9474      * one past the new range.  */
9475     array[len - 2] = start;
9476     if (end != UV_MAX) {
9477         array[len - 1] = end + 1;
9478     }
9479     else {
9480         /* But if the end is the maximum representable on the machine, just let
9481          * the range have no end */
9482         invlist_set_len(invlist, len - 1, offset);
9483     }
9484 }
9485
9486 SSize_t
9487 Perl__invlist_search(SV* const invlist, const UV cp)
9488 {
9489     /* Searches the inversion list for the entry that contains the input code
9490      * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
9491      * return value is the index into the list's array of the range that
9492      * contains <cp>, that is, 'i' such that
9493      *  array[i] <= cp < array[i+1]
9494      */
9495
9496     IV low = 0;
9497     IV mid;
9498     IV high = _invlist_len(invlist);
9499     const IV highest_element = high - 1;
9500     const UV* array;
9501
9502     PERL_ARGS_ASSERT__INVLIST_SEARCH;
9503
9504     /* If list is empty, return failure. */
9505     if (high == 0) {
9506         return -1;
9507     }
9508
9509     /* (We can't get the array unless we know the list is non-empty) */
9510     array = invlist_array(invlist);
9511
9512     mid = invlist_previous_index(invlist);
9513     assert(mid >=0);
9514     if (mid > highest_element) {
9515         mid = highest_element;
9516     }
9517
9518     /* <mid> contains the cache of the result of the previous call to this
9519      * function (0 the first time).  See if this call is for the same result,
9520      * or if it is for mid-1.  This is under the theory that calls to this
9521      * function will often be for related code points that are near each other.
9522      * And benchmarks show that caching gives better results.  We also test
9523      * here if the code point is within the bounds of the list.  These tests
9524      * replace others that would have had to be made anyway to make sure that
9525      * the array bounds were not exceeded, and these give us extra information
9526      * at the same time */
9527     if (cp >= array[mid]) {
9528         if (cp >= array[highest_element]) {
9529             return highest_element;
9530         }
9531
9532         /* Here, array[mid] <= cp < array[highest_element].  This means that
9533          * the final element is not the answer, so can exclude it; it also
9534          * means that <mid> is not the final element, so can refer to 'mid + 1'
9535          * safely */
9536         if (cp < array[mid + 1]) {
9537             return mid;
9538         }
9539         high--;
9540         low = mid + 1;
9541     }
9542     else { /* cp < aray[mid] */
9543         if (cp < array[0]) { /* Fail if outside the array */
9544             return -1;
9545         }
9546         high = mid;
9547         if (cp >= array[mid - 1]) {
9548             goto found_entry;
9549         }
9550     }
9551
9552     /* Binary search.  What we are looking for is <i> such that
9553      *  array[i] <= cp < array[i+1]
9554      * The loop below converges on the i+1.  Note that there may not be an
9555      * (i+1)th element in the array, and things work nonetheless */
9556     while (low < high) {
9557         mid = (low + high) / 2;
9558         assert(mid <= highest_element);
9559         if (array[mid] <= cp) { /* cp >= array[mid] */
9560             low = mid + 1;
9561
9562             /* We could do this extra test to exit the loop early.
9563             if (cp < array[low]) {
9564                 return mid;
9565             }
9566             */
9567         }
9568         else { /* cp < array[mid] */
9569             high = mid;
9570         }
9571     }
9572
9573   found_entry:
9574     high--;
9575     invlist_set_previous_index(invlist, high);
9576     return high;
9577 }
9578
9579 void
9580 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9581                                          const bool complement_b, SV** output)
9582 {
9583     /* Take the union of two inversion lists and point '*output' to it.  On
9584      * input, '*output' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9585      * even 'a' or 'b').  If to an inversion list, the contents of the original
9586      * list will be replaced by the union.  The first list, 'a', may be
9587      * NULL, in which case a copy of the second list is placed in '*output'.
9588      * If 'complement_b' is TRUE, the union is taken of the complement
9589      * (inversion) of 'b' instead of b itself.
9590      *
9591      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9592      * Richard Gillam, published by Addison-Wesley, and explained at some
9593      * length there.  The preface says to incorporate its examples into your
9594      * code at your own risk.
9595      *
9596      * The algorithm is like a merge sort. */
9597
9598     const UV* array_a;    /* a's array */
9599     const UV* array_b;
9600     UV len_a;       /* length of a's array */
9601     UV len_b;
9602
9603     SV* u;                      /* the resulting union */
9604     UV* array_u;
9605     UV len_u = 0;
9606
9607     UV i_a = 0;             /* current index into a's array */
9608     UV i_b = 0;
9609     UV i_u = 0;
9610
9611     /* running count, as explained in the algorithm source book; items are
9612      * stopped accumulating and are output when the count changes to/from 0.
9613      * The count is incremented when we start a range that's in an input's set,
9614      * and decremented when we start a range that's not in a set.  So this
9615      * variable can be 0, 1, or 2.  When it is 0 neither input is in their set,
9616      * and hence nothing goes into the union; 1, just one of the inputs is in
9617      * its set (and its current range gets added to the union); and 2 when both
9618      * inputs are in their sets.  */
9619     UV count = 0;
9620
9621     PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
9622     assert(a != b);
9623     assert(*output == NULL || is_invlist(*output));
9624
9625     len_b = _invlist_len(b);
9626     if (len_b == 0) {
9627
9628         /* Here, 'b' is empty, hence it's complement is all possible code
9629          * points.  So if the union includes the complement of 'b', it includes
9630          * everything, and we need not even look at 'a'.  It's easiest to
9631          * create a new inversion list that matches everything.  */
9632         if (complement_b) {
9633             SV* everything = _add_range_to_invlist(NULL, 0, UV_MAX);
9634
9635             if (*output == NULL) { /* If the output didn't exist, just point it
9636                                       at the new list */
9637                 *output = everything;
9638             }
9639             else { /* Otherwise, replace its contents with the new list */
9640                 invlist_replace_list_destroys_src(*output, everything);
9641                 SvREFCNT_dec_NN(everything);
9642             }
9643
9644             return;
9645         }
9646
9647         /* Here, we don't want the complement of 'b', and since 'b' is empty,
9648          * the union will come entirely from 'a'.  If 'a' is NULL or empty, the
9649          * output will be empty */
9650
9651         if (a == NULL || _invlist_len(a) == 0) {
9652             if (*output == NULL) {
9653                 *output = _new_invlist(0);
9654             }
9655             else {
9656                 invlist_clear(*output);
9657             }
9658             return;
9659         }
9660
9661         /* Here, 'a' is not empty, but 'b' is, so 'a' entirely determines the
9662          * union.  We can just return a copy of 'a' if '*output' doesn't point
9663          * to an existing list */
9664         if (*output == NULL) {
9665             *output = invlist_clone(a, NULL);
9666             return;
9667         }
9668
9669         /* If the output is to overwrite 'a', we have a no-op, as it's
9670          * already in 'a' */
9671         if (*output == a) {
9672             return;
9673         }
9674
9675         /* Here, '*output' is to be overwritten by 'a' */
9676         u = invlist_clone(a, NULL);
9677         invlist_replace_list_destroys_src(*output, u);
9678         SvREFCNT_dec_NN(u);
9679
9680         return;
9681     }
9682
9683     /* Here 'b' is not empty.  See about 'a' */
9684
9685     if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
9686
9687         /* Here, 'a' is empty (and b is not).  That means the union will come
9688          * entirely from 'b'.  If '*output' is NULL, we can directly return a
9689          * clone of 'b'.  Otherwise, we replace the contents of '*output' with
9690          * the clone */
9691
9692         SV ** dest = (*output == NULL) ? output : &u;
9693         *dest = invlist_clone(b, NULL);
9694         if (complement_b) {
9695             _invlist_invert(*dest);
9696         }
9697
9698         if (dest == &u) {
9699             invlist_replace_list_destroys_src(*output, u);
9700             SvREFCNT_dec_NN(u);
9701         }
9702
9703         return;
9704     }
9705
9706     /* Here both lists exist and are non-empty */
9707     array_a = invlist_array(a);
9708     array_b = invlist_array(b);
9709
9710     /* If are to take the union of 'a' with the complement of b, set it
9711      * up so are looking at b's complement. */
9712     if (complement_b) {
9713
9714         /* To complement, we invert: if the first element is 0, remove it.  To
9715          * do this, we just pretend the array starts one later */
9716         if (array_b[0] == 0) {
9717             array_b++;
9718             len_b--;
9719         }
9720         else {
9721
9722             /* But if the first element is not zero, we pretend the list starts
9723              * at the 0 that is always stored immediately before the array. */
9724             array_b--;
9725             len_b++;
9726         }
9727     }
9728
9729     /* Size the union for the worst case: that the sets are completely
9730      * disjoint */
9731     u = _new_invlist(len_a + len_b);
9732
9733     /* Will contain U+0000 if either component does */
9734     array_u = _invlist_array_init(u, (    len_a > 0 && array_a[0] == 0)
9735                                       || (len_b > 0 && array_b[0] == 0));
9736
9737     /* Go through each input list item by item, stopping when have exhausted
9738      * one of them */
9739     while (i_a < len_a && i_b < len_b) {
9740         UV cp;      /* The element to potentially add to the union's array */
9741         bool cp_in_set;   /* is it in the input list's set or not */
9742
9743         /* We need to take one or the other of the two inputs for the union.
9744          * Since we are merging two sorted lists, we take the smaller of the
9745          * next items.  In case of a tie, we take first the one that is in its
9746          * set.  If we first took the one not in its set, it would decrement
9747          * the count, possibly to 0 which would cause it to be output as ending
9748          * the range, and the next time through we would take the same number,
9749          * and output it again as beginning the next range.  By doing it the
9750          * opposite way, there is no possibility that the count will be
9751          * momentarily decremented to 0, and thus the two adjoining ranges will
9752          * be seamlessly merged.  (In a tie and both are in the set or both not
9753          * in the set, it doesn't matter which we take first.) */
9754         if (       array_a[i_a] < array_b[i_b]
9755             || (   array_a[i_a] == array_b[i_b]
9756                 && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9757         {
9758             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9759             cp = array_a[i_a++];
9760         }
9761         else {
9762             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9763             cp = array_b[i_b++];
9764         }
9765
9766         /* Here, have chosen which of the two inputs to look at.  Only output
9767          * if the running count changes to/from 0, which marks the
9768          * beginning/end of a range that's in the set */
9769         if (cp_in_set) {
9770             if (count == 0) {
9771                 array_u[i_u++] = cp;
9772             }
9773             count++;
9774         }
9775         else {
9776             count--;
9777             if (count == 0) {
9778                 array_u[i_u++] = cp;
9779             }
9780         }
9781     }
9782
9783
9784     /* The loop above increments the index into exactly one of the input lists
9785      * each iteration, and ends when either index gets to its list end.  That
9786      * means the other index is lower than its end, and so something is
9787      * remaining in that one.  We decrement 'count', as explained below, if
9788      * that list is in its set.  (i_a and i_b each currently index the element
9789      * beyond the one we care about.) */
9790     if (   (i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
9791         || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
9792     {
9793         count--;
9794     }
9795
9796     /* Above we decremented 'count' if the list that had unexamined elements in
9797      * it was in its set.  This has made it so that 'count' being non-zero
9798      * means there isn't anything left to output; and 'count' equal to 0 means
9799      * that what is left to output is precisely that which is left in the
9800      * non-exhausted input list.
9801      *
9802      * To see why, note first that the exhausted input obviously has nothing
9803      * left to add to the union.  If it was in its set at its end, that means
9804      * the set extends from here to the platform's infinity, and hence so does
9805      * the union and the non-exhausted set is irrelevant.  The exhausted set
9806      * also contributed 1 to 'count'.  If 'count' was 2, it got decremented to
9807      * 1, but if it was 1, the non-exhausted set wasn't in its set, and so
9808      * 'count' remains at 1.  This is consistent with the decremented 'count'
9809      * != 0 meaning there's nothing left to add to the union.
9810      *
9811      * But if the exhausted input wasn't in its set, it contributed 0 to
9812      * 'count', and the rest of the union will be whatever the other input is.
9813      * If 'count' was 0, neither list was in its set, and 'count' remains 0;
9814      * otherwise it gets decremented to 0.  This is consistent with 'count'
9815      * == 0 meaning the remainder of the union is whatever is left in the
9816      * non-exhausted list. */
9817     if (count != 0) {
9818         len_u = i_u;
9819     }
9820     else {
9821         IV copy_count = len_a - i_a;
9822         if (copy_count > 0) {   /* The non-exhausted input is 'a' */
9823             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
9824         }
9825         else { /* The non-exhausted input is b */
9826             copy_count = len_b - i_b;
9827             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
9828         }
9829         len_u = i_u + copy_count;
9830     }
9831
9832     /* Set the result to the final length, which can change the pointer to
9833      * array_u, so re-find it.  (Note that it is unlikely that this will
9834      * change, as we are shrinking the space, not enlarging it) */
9835     if (len_u != _invlist_len(u)) {
9836         invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
9837         invlist_trim(u);
9838         array_u = invlist_array(u);
9839     }
9840
9841     if (*output == NULL) {  /* Simply return the new inversion list */
9842         *output = u;
9843     }
9844     else {
9845         /* Otherwise, overwrite the inversion list that was in '*output'.  We
9846          * could instead free '*output', and then set it to 'u', but experience
9847          * has shown [perl #127392] that if the input is a mortal, we can get a
9848          * huge build-up of these during regex compilation before they get
9849          * freed. */
9850         invlist_replace_list_destroys_src(*output, u);
9851         SvREFCNT_dec_NN(u);
9852     }
9853
9854     return;
9855 }
9856
9857 void
9858 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
9859                                                const bool complement_b, SV** i)
9860 {
9861     /* Take the intersection of two inversion lists and point '*i' to it.  On
9862      * input, '*i' MUST POINT TO NULL OR TO AN SV* INVERSION LIST (possibly
9863      * even 'a' or 'b').  If to an inversion list, the contents of the original
9864      * list will be replaced by the intersection.  The first list, 'a', may be
9865      * NULL, in which case '*i' will be an empty list.  If 'complement_b' is
9866      * TRUE, the result will be the intersection of 'a' and the complement (or
9867      * inversion) of 'b' instead of 'b' directly.
9868      *
9869      * The basis for this comes from "Unicode Demystified" Chapter 13 by
9870      * Richard Gillam, published by Addison-Wesley, and explained at some
9871      * length there.  The preface says to incorporate its examples into your
9872      * code at your own risk.  In fact, it had bugs
9873      *
9874      * The algorithm is like a merge sort, and is essentially the same as the
9875      * union above
9876      */
9877
9878     const UV* array_a;          /* a's array */
9879     const UV* array_b;
9880     UV len_a;   /* length of a's array */
9881     UV len_b;
9882
9883     SV* r;                   /* the resulting intersection */
9884     UV* array_r;
9885     UV len_r = 0;
9886
9887     UV i_a = 0;             /* current index into a's array */
9888     UV i_b = 0;
9889     UV i_r = 0;
9890
9891     /* running count of how many of the two inputs are postitioned at ranges
9892      * that are in their sets.  As explained in the algorithm source book,
9893      * items are stopped accumulating and are output when the count changes
9894      * to/from 2.  The count is incremented when we start a range that's in an
9895      * input's set, and decremented when we start a range that's not in a set.
9896      * Only when it is 2 are we in the intersection. */
9897     UV count = 0;
9898
9899     PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
9900     assert(a != b);
9901     assert(*i == NULL || is_invlist(*i));
9902
9903     /* Special case if either one is empty */
9904     len_a = (a == NULL) ? 0 : _invlist_len(a);
9905     if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
9906         if (len_a != 0 && complement_b) {
9907
9908             /* Here, 'a' is not empty, therefore from the enclosing 'if', 'b'
9909              * must be empty.  Here, also we are using 'b's complement, which
9910              * hence must be every possible code point.  Thus the intersection
9911              * is simply 'a'. */
9912
9913             if (*i == a) {  /* No-op */
9914                 return;
9915             }
9916
9917             if (*i == NULL) {
9918                 *i = invlist_clone(a, NULL);
9919                 return;
9920             }
9921
9922             r = invlist_clone(a, NULL);
9923             invlist_replace_list_destroys_src(*i, r);
9924             SvREFCNT_dec_NN(r);
9925             return;
9926         }
9927
9928         /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
9929          * intersection must be empty */
9930         if (*i == NULL) {
9931             *i = _new_invlist(0);
9932             return;
9933         }
9934
9935         invlist_clear(*i);
9936         return;
9937     }
9938
9939     /* Here both lists exist and are non-empty */
9940     array_a = invlist_array(a);
9941     array_b = invlist_array(b);
9942
9943     /* If are to take the intersection of 'a' with the complement of b, set it
9944      * up so are looking at b's complement. */
9945     if (complement_b) {
9946
9947         /* To complement, we invert: if the first element is 0, remove it.  To
9948          * do this, we just pretend the array starts one later */
9949         if (array_b[0] == 0) {
9950             array_b++;
9951             len_b--;
9952         }
9953         else {
9954
9955             /* But if the first element is not zero, we pretend the list starts
9956              * at the 0 that is always stored immediately before the array. */
9957             array_b--;
9958             len_b++;
9959         }
9960     }
9961
9962     /* Size the intersection for the worst case: that the intersection ends up
9963      * fragmenting everything to be completely disjoint */
9964     r= _new_invlist(len_a + len_b);
9965
9966     /* Will contain U+0000 iff both components do */
9967     array_r = _invlist_array_init(r,    len_a > 0 && array_a[0] == 0
9968                                      && len_b > 0 && array_b[0] == 0);
9969
9970     /* Go through each list item by item, stopping when have exhausted one of
9971      * them */
9972     while (i_a < len_a && i_b < len_b) {
9973         UV cp;      /* The element to potentially add to the intersection's
9974                        array */
9975         bool cp_in_set; /* Is it in the input list's set or not */
9976
9977         /* We need to take one or the other of the two inputs for the
9978          * intersection.  Since we are merging two sorted lists, we take the
9979          * smaller of the next items.  In case of a tie, we take first the one
9980          * that is not in its set (a difference from the union algorithm).  If
9981          * we first took the one in its set, it would increment the count,
9982          * possibly to 2 which would cause it to be output as starting a range
9983          * in the intersection, and the next time through we would take that
9984          * same number, and output it again as ending the set.  By doing the
9985          * opposite of this, there is no possibility that the count will be
9986          * momentarily incremented to 2.  (In a tie and both are in the set or
9987          * both not in the set, it doesn't matter which we take first.) */
9988         if (       array_a[i_a] < array_b[i_b]
9989             || (   array_a[i_a] == array_b[i_b]
9990                 && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
9991         {
9992             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
9993             cp = array_a[i_a++];
9994         }
9995         else {
9996             cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
9997             cp= array_b[i_b++];
9998         }
9999
10000         /* Here, have chosen which of the two inputs to look at.  Only output
10001          * if the running count changes to/from 2, which marks the
10002          * beginning/end of a range that's in the intersection */
10003         if (cp_in_set) {
10004             count++;
10005             if (count == 2) {
10006                 array_r[i_r++] = cp;
10007             }
10008         }
10009         else {
10010             if (count == 2) {
10011                 array_r[i_r++] = cp;
10012             }
10013             count--;
10014         }
10015
10016     }
10017
10018     /* The loop above increments the index into exactly one of the input lists
10019      * each iteration, and ends when either index gets to its list end.  That
10020      * means the other index is lower than its end, and so something is
10021      * remaining in that one.  We increment 'count', as explained below, if the
10022      * exhausted list was in its set.  (i_a and i_b each currently index the
10023      * element beyond the one we care about.) */
10024     if (   (i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
10025         || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
10026     {
10027         count++;
10028     }
10029
10030     /* Above we incremented 'count' if the exhausted list was in its set.  This
10031      * has made it so that 'count' being below 2 means there is nothing left to
10032      * output; otheriwse what's left to add to the intersection is precisely
10033      * that which is left in the non-exhausted input list.
10034      *
10035      * To see why, note first that the exhausted input obviously has nothing
10036      * left to affect the intersection.  If it was in its set at its end, that
10037      * means the set extends from here to the platform's infinity, and hence
10038      * anything in the non-exhausted's list will be in the intersection, and
10039      * anything not in it won't be.  Hence, the rest of the intersection is
10040      * precisely what's in the non-exhausted list  The exhausted set also
10041      * contributed 1 to 'count', meaning 'count' was at least 1.  Incrementing
10042      * it means 'count' is now at least 2.  This is consistent with the
10043      * incremented 'count' being >= 2 means to add the non-exhausted list to
10044      * the intersection.
10045      *
10046      * But if the exhausted input wasn't in its set, it contributed 0 to
10047      * 'count', and the intersection can't include anything further; the
10048      * non-exhausted set is irrelevant.  'count' was at most 1, and doesn't get
10049      * incremented.  This is consistent with 'count' being < 2 meaning nothing
10050      * further to add to the intersection. */
10051     if (count < 2) { /* Nothing left to put in the intersection. */
10052         len_r = i_r;
10053     }
10054     else { /* copy the non-exhausted list, unchanged. */
10055         IV copy_count = len_a - i_a;
10056         if (copy_count > 0) {   /* a is the one with stuff left */
10057             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
10058         }
10059         else {  /* b is the one with stuff left */
10060             copy_count = len_b - i_b;
10061             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
10062         }
10063         len_r = i_r + copy_count;
10064     }
10065
10066     /* Set the result to the final length, which can change the pointer to
10067      * array_r, so re-find it.  (Note that it is unlikely that this will
10068      * change, as we are shrinking the space, not enlarging it) */
10069     if (len_r != _invlist_len(r)) {
10070         invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
10071         invlist_trim(r);
10072         array_r = invlist_array(r);
10073     }
10074
10075     if (*i == NULL) { /* Simply return the calculated intersection */
10076         *i = r;
10077     }
10078     else { /* Otherwise, replace the existing inversion list in '*i'.  We could
10079               instead free '*i', and then set it to 'r', but experience has
10080               shown [perl #127392] that if the input is a mortal, we can get a
10081               huge build-up of these during regex compilation before they get
10082               freed. */
10083         if (len_r) {
10084             invlist_replace_list_destroys_src(*i, r);
10085         }
10086         else {
10087             invlist_clear(*i);
10088         }
10089         SvREFCNT_dec_NN(r);
10090     }
10091
10092     return;
10093 }
10094
10095 SV*
10096 Perl__add_range_to_invlist(pTHX_ SV* invlist, UV start, UV end)
10097 {
10098     /* Add the range from 'start' to 'end' inclusive to the inversion list's
10099      * set.  A pointer to the inversion list is returned.  This may actually be
10100      * a new list, in which case the passed in one has been destroyed.  The
10101      * passed-in inversion list can be NULL, in which case a new one is created
10102      * with just the one range in it.  The new list is not necessarily
10103      * NUL-terminated.  Space is not freed if the inversion list shrinks as a
10104      * result of this function.  The gain would not be large, and in many
10105      * cases, this is called multiple times on a single inversion list, so
10106      * anything freed may almost immediately be needed again.
10107      *
10108      * This used to mostly call the 'union' routine, but that is much more
10109      * heavyweight than really needed for a single range addition */
10110
10111     UV* array;              /* The array implementing the inversion list */
10112     UV len;                 /* How many elements in 'array' */
10113     SSize_t i_s;            /* index into the invlist array where 'start'
10114                                should go */
10115     SSize_t i_e = 0;        /* And the index where 'end' should go */
10116     UV cur_highest;         /* The highest code point in the inversion list
10117                                upon entry to this function */
10118
10119     /* This range becomes the whole inversion list if none already existed */
10120     if (invlist == NULL) {
10121         invlist = _new_invlist(2);
10122         _append_range_to_invlist(invlist, start, end);
10123         return invlist;
10124     }
10125
10126     /* Likewise, if the inversion list is currently empty */
10127     len = _invlist_len(invlist);
10128     if (len == 0) {
10129         _append_range_to_invlist(invlist, start, end);
10130         return invlist;
10131     }
10132
10133     /* Starting here, we have to know the internals of the list */
10134     array = invlist_array(invlist);
10135
10136     /* If the new range ends higher than the current highest ... */
10137     cur_highest = invlist_highest(invlist);
10138     if (end > cur_highest) {
10139
10140         /* If the whole range is higher, we can just append it */
10141         if (start > cur_highest) {
10142             _append_range_to_invlist(invlist, start, end);
10143             return invlist;
10144         }
10145
10146         /* Otherwise, add the portion that is higher ... */
10147         _append_range_to_invlist(invlist, cur_highest + 1, end);
10148
10149         /* ... and continue on below to handle the rest.  As a result of the
10150          * above append, we know that the index of the end of the range is the
10151          * final even numbered one of the array.  Recall that the final element
10152          * always starts a range that extends to infinity.  If that range is in
10153          * the set (meaning the set goes from here to infinity), it will be an
10154          * even index, but if it isn't in the set, it's odd, and the final
10155          * range in the set is one less, which is even. */
10156         if (end == UV_MAX) {
10157             i_e = len;
10158         }
10159         else {
10160             i_e = len - 2;
10161         }
10162     }
10163
10164     /* We have dealt with appending, now see about prepending.  If the new
10165      * range starts lower than the current lowest ... */
10166     if (start < array[0]) {
10167
10168         /* Adding something which has 0 in it is somewhat tricky, and uncommon.
10169          * Let the union code handle it, rather than having to know the
10170          * trickiness in two code places.  */
10171         if (UNLIKELY(start == 0)) {
10172             SV* range_invlist;
10173
10174             range_invlist = _new_invlist(2);
10175             _append_range_to_invlist(range_invlist, start, end);
10176
10177             _invlist_union(invlist, range_invlist, &invlist);
10178
10179             SvREFCNT_dec_NN(range_invlist);
10180
10181             return invlist;
10182         }
10183
10184         /* If the whole new range comes before the first entry, and doesn't
10185          * extend it, we have to insert it as an additional range */
10186         if (end < array[0] - 1) {
10187             i_s = i_e = -1;
10188             goto splice_in_new_range;
10189         }
10190
10191         /* Here the new range adjoins the existing first range, extending it
10192          * downwards. */
10193         array[0] = start;
10194
10195         /* And continue on below to handle the rest.  We know that the index of
10196          * the beginning of the range is the first one of the array */
10197         i_s = 0;
10198     }
10199     else { /* Not prepending any part of the new range to the existing list.
10200             * Find where in the list it should go.  This finds i_s, such that:
10201             *     invlist[i_s] <= start < array[i_s+1]
10202             */
10203         i_s = _invlist_search(invlist, start);
10204     }
10205
10206     /* At this point, any extending before the beginning of the inversion list
10207      * and/or after the end has been done.  This has made it so that, in the
10208      * code below, each endpoint of the new range is either in a range that is
10209      * in the set, or is in a gap between two ranges that are.  This means we
10210      * don't have to worry about exceeding the array bounds.
10211      *
10212      * Find where in the list the new range ends (but we can skip this if we
10213      * have already determined what it is, or if it will be the same as i_s,
10214      * which we already have computed) */
10215     if (i_e == 0) {
10216         i_e = (start == end)
10217               ? i_s
10218               : _invlist_search(invlist, end);
10219     }
10220
10221     /* Here generally invlist[i_e] <= end < array[i_e+1].  But if invlist[i_e]
10222      * is a range that goes to infinity there is no element at invlist[i_e+1],
10223      * so only the first relation holds. */
10224
10225     if ( ! ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10226
10227         /* Here, the ranges on either side of the beginning of the new range
10228          * are in the set, and this range starts in the gap between them.
10229          *
10230          * The new range extends the range above it downwards if the new range
10231          * ends at or above that range's start */
10232         const bool extends_the_range_above = (   end == UV_MAX
10233                                               || end + 1 >= array[i_s+1]);
10234
10235         /* The new range extends the range below it upwards if it begins just
10236          * after where that range ends */
10237         if (start == array[i_s]) {
10238
10239             /* If the new range fills the entire gap between the other ranges,
10240              * they will get merged together.  Other ranges may also get
10241              * merged, depending on how many of them the new range spans.  In
10242              * the general case, we do the merge later, just once, after we
10243              * figure out how many to merge.  But in the case where the new
10244              * range exactly spans just this one gap (possibly extending into
10245              * the one above), we do the merge here, and an early exit.  This
10246              * is done here to avoid having to special case later. */
10247             if (i_e - i_s <= 1) {
10248
10249                 /* If i_e - i_s == 1, it means that the new range terminates
10250                  * within the range above, and hence 'extends_the_range_above'
10251                  * must be true.  (If the range above it extends to infinity,
10252                  * 'i_s+2' will be above the array's limit, but 'len-i_s-2'
10253                  * will be 0, so no harm done.) */
10254                 if (extends_the_range_above) {
10255                     Move(array + i_s + 2, array + i_s, len - i_s - 2, UV);
10256                     invlist_set_len(invlist,
10257                                     len - 2,
10258                                     *(get_invlist_offset_addr(invlist)));
10259                     return invlist;
10260                 }
10261
10262                 /* Here, i_e must == i_s.  We keep them in sync, as they apply
10263                  * to the same range, and below we are about to decrement i_s
10264                  * */
10265                 i_e--;
10266             }
10267
10268             /* Here, the new range is adjacent to the one below.  (It may also
10269              * span beyond the range above, but that will get resolved later.)
10270              * Extend the range below to include this one. */
10271             array[i_s] = (end == UV_MAX) ? UV_MAX : end + 1;
10272             i_s--;
10273             start = array[i_s];
10274         }
10275         else if (extends_the_range_above) {
10276
10277             /* Here the new range only extends the range above it, but not the
10278              * one below.  It merges with the one above.  Again, we keep i_e
10279              * and i_s in sync if they point to the same range */
10280             if (i_e == i_s) {
10281                 i_e++;
10282             }
10283             i_s++;
10284             array[i_s] = start;
10285         }
10286     }
10287
10288     /* Here, we've dealt with the new range start extending any adjoining
10289      * existing ranges.
10290      *
10291      * If the new range extends to infinity, it is now the final one,
10292      * regardless of what was there before */
10293     if (UNLIKELY(end == UV_MAX)) {
10294         invlist_set_len(invlist, i_s + 1, *(get_invlist_offset_addr(invlist)));
10295         return invlist;
10296     }
10297
10298     /* If i_e started as == i_s, it has also been dealt with,
10299      * and been updated to the new i_s, which will fail the following if */
10300     if (! ELEMENT_RANGE_MATCHES_INVLIST(i_e)) {
10301
10302         /* Here, the ranges on either side of the end of the new range are in
10303          * the set, and this range ends in the gap between them.
10304          *
10305          * If this range is adjacent to (hence extends) the range above it, it
10306          * becomes part of that range; likewise if it extends the range below,
10307          * it becomes part of that range */
10308         if (end + 1 == array[i_e+1]) {
10309             i_e++;
10310             array[i_e] = start;
10311         }
10312         else if (start <= array[i_e]) {
10313             array[i_e] = end + 1;
10314             i_e--;
10315         }
10316     }
10317
10318     if (i_s == i_e) {
10319
10320         /* If the range fits entirely in an existing range (as possibly already
10321          * extended above), it doesn't add anything new */
10322         if (ELEMENT_RANGE_MATCHES_INVLIST(i_s)) {
10323             return invlist;
10324         }
10325
10326         /* Here, no part of the range is in the list.  Must add it.  It will
10327          * occupy 2 more slots */
10328       splice_in_new_range:
10329
10330         invlist_extend(invlist, len + 2);
10331         array = invlist_array(invlist);
10332         /* Move the rest of the array down two slots. Don't include any
10333          * trailing NUL */
10334         Move(array + i_e + 1, array + i_e + 3, len - i_e - 1, UV);
10335
10336         /* Do the actual splice */
10337         array[i_e+1] = start;
10338         array[i_e+2] = end + 1;
10339         invlist_set_len(invlist, len + 2, *(get_invlist_offset_addr(invlist)));
10340         return invlist;
10341     }
10342
10343     /* Here the new range crossed the boundaries of a pre-existing range.  The
10344      * code above has adjusted things so that both ends are in ranges that are
10345      * in the set.  This means everything in between must also be in the set.
10346      * Just squash things together */
10347     Move(array + i_e + 1, array + i_s + 1, len - i_e - 1, UV);
10348     invlist_set_len(invlist,
10349                     len - i_e + i_s,
10350                     *(get_invlist_offset_addr(invlist)));
10351
10352     return invlist;
10353 }
10354
10355 SV*
10356 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
10357                                  UV** other_elements_ptr)
10358 {
10359     /* Create and return an inversion list whose contents are to be populated
10360      * by the caller.  The caller gives the number of elements (in 'size') and
10361      * the very first element ('element0').  This function will set
10362      * '*other_elements_ptr' to an array of UVs, where the remaining elements
10363      * are to be placed.
10364      *
10365      * Obviously there is some trust involved that the caller will properly
10366      * fill in the other elements of the array.
10367      *
10368      * (The first element needs to be passed in, as the underlying code does
10369      * things differently depending on whether it is zero or non-zero) */
10370
10371     SV* invlist = _new_invlist(size);
10372     bool offset;
10373
10374     PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
10375
10376     invlist = add_cp_to_invlist(invlist, element0);
10377     offset = *get_invlist_offset_addr(invlist);
10378
10379     invlist_set_len(invlist, size, offset);
10380     *other_elements_ptr = invlist_array(invlist) + 1;
10381     return invlist;
10382 }
10383
10384 #endif
10385
10386 #ifndef PERL_IN_XSUB_RE
10387 void
10388 Perl__invlist_invert(pTHX_ SV* const invlist)
10389 {
10390     /* Complement the input inversion list.  This adds a 0 if the list didn't
10391      * have a zero; removes it otherwise.  As described above, the data
10392      * structure is set up so that this is very efficient */
10393
10394     PERL_ARGS_ASSERT__INVLIST_INVERT;
10395
10396     assert(! invlist_is_iterating(invlist));
10397
10398     /* The inverse of matching nothing is matching everything */
10399     if (_invlist_len(invlist) == 0) {
10400         _append_range_to_invlist(invlist, 0, UV_MAX);
10401         return;
10402     }
10403
10404     *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
10405 }
10406
10407 SV*
10408 Perl_invlist_clone(pTHX_ SV* const invlist, SV* new_invlist)
10409 {
10410     /* Return a new inversion list that is a copy of the input one, which is
10411      * unchanged.  The new list will not be mortal even if the old one was. */
10412
10413     const STRLEN nominal_length = _invlist_len(invlist);
10414     const STRLEN physical_length = SvCUR(invlist);
10415     const bool offset = *(get_invlist_offset_addr(invlist));
10416
10417     PERL_ARGS_ASSERT_INVLIST_CLONE;
10418
10419     if (new_invlist == NULL) {
10420         new_invlist = _new_invlist(nominal_length);
10421     }
10422     else {
10423         sv_upgrade(new_invlist, SVt_INVLIST);
10424         initialize_invlist_guts(new_invlist, nominal_length);
10425     }
10426
10427     *(get_invlist_offset_addr(new_invlist)) = offset;
10428     invlist_set_len(new_invlist, nominal_length, offset);
10429     Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
10430
10431     return new_invlist;
10432 }
10433
10434 #endif
10435
10436 PERL_STATIC_INLINE UV
10437 S_invlist_lowest(SV* const invlist)
10438 {
10439     /* Returns the lowest code point that matches an inversion list.  This API
10440      * has an ambiguity, as it returns 0 under either the lowest is actually
10441      * 0, or if the list is empty.  If this distinction matters to you, check
10442      * for emptiness before calling this function */
10443
10444     UV len = _invlist_len(invlist);
10445     UV *array;
10446
10447     PERL_ARGS_ASSERT_INVLIST_LOWEST;
10448
10449     if (len == 0) {
10450         return 0;
10451     }
10452
10453     array = invlist_array(invlist);
10454
10455     return array[0];
10456 }
10457
10458 STATIC SV *
10459 S_invlist_contents(pTHX_ SV* const invlist, const bool traditional_style)
10460 {
10461     /* Get the contents of an inversion list into a string SV so that they can
10462      * be printed out.  If 'traditional_style' is TRUE, it uses the format
10463      * traditionally done for debug tracing; otherwise it uses a format
10464      * suitable for just copying to the output, with blanks between ranges and
10465      * a dash between range components */
10466
10467     UV start, end;
10468     SV* output;
10469     const char intra_range_delimiter = (traditional_style ? '\t' : '-');
10470     const char inter_range_delimiter = (traditional_style ? '\n' : ' ');
10471
10472     if (traditional_style) {
10473         output = newSVpvs("\n");
10474     }
10475     else {
10476         output = newSVpvs("");
10477     }
10478
10479     PERL_ARGS_ASSERT_INVLIST_CONTENTS;
10480
10481     assert(! invlist_is_iterating(invlist));
10482
10483     invlist_iterinit(invlist);
10484     while (invlist_iternext(invlist, &start, &end)) {
10485         if (end == UV_MAX) {
10486             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%cINFTY%c",
10487                                           start, intra_range_delimiter,
10488                                                  inter_range_delimiter);
10489         }
10490         else if (end != start) {
10491             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c%04" UVXf "%c",
10492                                           start,
10493                                                    intra_range_delimiter,
10494                                                   end, inter_range_delimiter);
10495         }
10496         else {
10497             Perl_sv_catpvf(aTHX_ output, "%04" UVXf "%c",
10498                                           start, inter_range_delimiter);
10499         }
10500     }
10501
10502     if (SvCUR(output) && ! traditional_style) {/* Get rid of trailing blank */
10503         SvCUR_set(output, SvCUR(output) - 1);
10504     }
10505
10506     return output;
10507 }
10508
10509 #ifndef PERL_IN_XSUB_RE
10510 void
10511 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
10512                          const char * const indent, SV* const invlist)
10513 {
10514     /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
10515      * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
10516      * the string 'indent'.  The output looks like this:
10517          [0] 0x000A .. 0x000D
10518          [2] 0x0085
10519          [4] 0x2028 .. 0x2029
10520          [6] 0x3104 .. INFTY
10521      * This means that the first range of code points matched by the list are
10522      * 0xA through 0xD; the second range contains only the single code point
10523      * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
10524      * are used to define each range (except if the final range extends to
10525      * infinity, only a single element is needed).  The array index of the
10526      * first element for the corresponding range is given in brackets. */
10527
10528     UV start, end;
10529     STRLEN count = 0;
10530
10531     PERL_ARGS_ASSERT__INVLIST_DUMP;
10532
10533     if (invlist_is_iterating(invlist)) {
10534         Perl_dump_indent(aTHX_ level, file,
10535              "%sCan't dump inversion list because is in middle of iterating\n",
10536              indent);
10537         return;
10538     }
10539
10540     invlist_iterinit(invlist);
10541     while (invlist_iternext(invlist, &start, &end)) {
10542         if (end == UV_MAX) {
10543             Perl_dump_indent(aTHX_ level, file,
10544                                        "%s[%" UVuf "] 0x%04" UVXf " .. INFTY\n",
10545                                    indent, (UV)count, start);
10546         }
10547         else if (end != start) {
10548             Perl_dump_indent(aTHX_ level, file,
10549                                     "%s[%" UVuf "] 0x%04" UVXf " .. 0x%04" UVXf "\n",
10550                                 indent, (UV)count, start,         end);
10551         }
10552         else {
10553             Perl_dump_indent(aTHX_ level, file, "%s[%" UVuf "] 0x%04" UVXf "\n",
10554                                             indent, (UV)count, start);
10555         }
10556         count += 2;
10557     }
10558 }
10559
10560 #endif
10561
10562 #if defined(PERL_ARGS_ASSERT__INVLISTEQ) && !defined(PERL_IN_XSUB_RE)
10563 bool
10564 Perl__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
10565 {
10566     /* Return a boolean as to if the two passed in inversion lists are
10567      * identical.  The final argument, if TRUE, says to take the complement of
10568      * the second inversion list before doing the comparison */
10569
10570     const UV len_a = _invlist_len(a);
10571     UV len_b = _invlist_len(b);
10572
10573     const UV* array_a = NULL;
10574     const UV* array_b = NULL;
10575
10576     PERL_ARGS_ASSERT__INVLISTEQ;
10577
10578     /* This code avoids accessing the arrays unless it knows the length is
10579      * non-zero */
10580
10581     if (len_a == 0) {
10582         if (len_b == 0) {
10583             return ! complement_b;
10584         }
10585     }
10586     else {
10587         array_a = invlist_array(a);
10588     }
10589
10590     if (len_b != 0) {
10591         array_b = invlist_array(b);
10592     }
10593
10594     /* If are to compare 'a' with the complement of b, set it
10595      * up so are looking at b's complement. */
10596     if (complement_b) {
10597
10598         /* The complement of nothing is everything, so <a> would have to have
10599          * just one element, starting at zero (ending at infinity) */
10600         if (len_b == 0) {
10601             return (len_a == 1 && array_a[0] == 0);
10602         }
10603         if (array_b[0] == 0) {
10604
10605             /* Otherwise, to complement, we invert.  Here, the first element is
10606              * 0, just remove it.  To do this, we just pretend the array starts
10607              * one later */
10608
10609             array_b++;
10610             len_b--;
10611         }
10612         else {
10613
10614             /* But if the first element is not zero, we pretend the list starts
10615              * at the 0 that is always stored immediately before the array. */
10616             array_b--;
10617             len_b++;
10618         }
10619     }
10620
10621     return    len_a == len_b
10622            && memEQ(array_a, array_b, len_a * sizeof(array_a[0]));
10623
10624 }
10625 #endif
10626
10627 /*
10628  * As best we can, determine the characters that can match the start of
10629  * the given EXACTF-ish node.  This is for use in creating ssc nodes, so there
10630  * can be false positive matches
10631  *
10632  * Returns the invlist as a new SV*; it is the caller's responsibility to
10633  * call SvREFCNT_dec() when done with it.
10634  */
10635 STATIC SV*
10636 S_make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
10637 {
10638     const U8 * s = (U8*)STRING(node);
10639     SSize_t bytelen = STR_LEN(node);
10640     UV uc;
10641     /* Start out big enough for 2 separate code points */
10642     SV* invlist = _new_invlist(4);
10643
10644     PERL_ARGS_ASSERT_MAKE_EXACTF_INVLIST;
10645
10646     if (! UTF) {
10647         uc = *s;
10648
10649         /* We punt and assume can match anything if the node begins
10650          * with a multi-character fold.  Things are complicated.  For
10651          * example, /ffi/i could match any of:
10652          *  "\N{LATIN SMALL LIGATURE FFI}"
10653          *  "\N{LATIN SMALL LIGATURE FF}I"
10654          *  "F\N{LATIN SMALL LIGATURE FI}"
10655          *  plus several other things; and making sure we have all the
10656          *  possibilities is hard. */
10657         if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
10658             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10659         }
10660         else {
10661             /* Any Latin1 range character can potentially match any
10662              * other depending on the locale, and in Turkic locales, U+130 and
10663              * U+131 */
10664             if (OP(node) == EXACTFL) {
10665                 _invlist_union(invlist, PL_Latin1, &invlist);
10666                 invlist = add_cp_to_invlist(invlist,
10667                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10668                 invlist = add_cp_to_invlist(invlist,
10669                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10670             }
10671             else {
10672                 /* But otherwise, it matches at least itself.  We can
10673                  * quickly tell if it has a distinct fold, and if so,
10674                  * it matches that as well */
10675                 invlist = add_cp_to_invlist(invlist, uc);
10676                 if (IS_IN_SOME_FOLD_L1(uc))
10677                     invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
10678             }
10679
10680             /* Some characters match above-Latin1 ones under /i.  This
10681              * is true of EXACTFL ones when the locale is UTF-8 */
10682             if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
10683                 && (! isASCII(uc) || ! inRANGE(OP(node), EXACTFAA,
10684                                                          EXACTFAA_NO_TRIE)))
10685             {
10686                 add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
10687             }
10688         }
10689     }
10690     else {  /* Pattern is UTF-8 */
10691         U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
10692         const U8* e = s + bytelen;
10693         IV fc;
10694
10695         fc = uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
10696
10697         /* The only code points that aren't folded in a UTF EXACTFish
10698          * node are the problematic ones in EXACTFL nodes */
10699         if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
10700             /* We need to check for the possibility that this EXACTFL
10701              * node begins with a multi-char fold.  Therefore we fold
10702              * the first few characters of it so that we can make that
10703              * check */
10704             U8 *d = folded;
10705             int i;
10706
10707             fc = -1;
10708             for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
10709                 if (isASCII(*s)) {
10710                     *(d++) = (U8) toFOLD(*s);
10711                     if (fc < 0) {       /* Save the first fold */
10712                         fc = *(d-1);
10713                     }
10714                     s++;
10715                 }
10716                 else {
10717                     STRLEN len;
10718                     UV fold = toFOLD_utf8_safe(s, e, d, &len);
10719                     if (fc < 0) {       /* Save the first fold */
10720                         fc = fold;
10721                     }
10722                     d += len;
10723                     s += UTF8SKIP(s);
10724                 }
10725             }
10726
10727             /* And set up so the code below that looks in this folded
10728              * buffer instead of the node's string */
10729             e = d;
10730             s = folded;
10731         }
10732
10733         /* When we reach here 's' points to the fold of the first
10734          * character(s) of the node; and 'e' points to far enough along
10735          * the folded string to be just past any possible multi-char
10736          * fold.
10737          *
10738          * Like the non-UTF case above, we punt if the node begins with a
10739          * multi-char fold  */
10740
10741         if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
10742             invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
10743         }
10744         else {  /* Single char fold */
10745             unsigned int k;
10746             U32 first_fold;
10747             const U32 * remaining_folds;
10748             Size_t folds_count;
10749
10750             /* It matches itself */
10751             invlist = add_cp_to_invlist(invlist, fc);
10752
10753             /* ... plus all the things that fold to it, which are found in
10754              * PL_utf8_foldclosures */
10755             folds_count = _inverse_folds(fc, &first_fold,
10756                                                 &remaining_folds);
10757             for (k = 0; k < folds_count; k++) {
10758                 UV c = (k == 0) ? first_fold : remaining_folds[k-1];
10759
10760                 /* /aa doesn't allow folds between ASCII and non- */
10761                 if (   inRANGE(OP(node), EXACTFAA, EXACTFAA_NO_TRIE)
10762                     && isASCII(c) != isASCII(fc))
10763                 {
10764                     continue;
10765                 }
10766
10767                 invlist = add_cp_to_invlist(invlist, c);
10768             }
10769
10770             if (OP(node) == EXACTFL) {
10771
10772                 /* If either [iI] are present in an EXACTFL node the above code
10773                  * should have added its normal case pair, but under a Turkish
10774                  * locale they could match instead the case pairs from it.  Add
10775                  * those as potential matches as well */
10776                 if (isALPHA_FOLD_EQ(fc, 'I')) {
10777                     invlist = add_cp_to_invlist(invlist,
10778                                                 LATIN_SMALL_LETTER_DOTLESS_I);
10779                     invlist = add_cp_to_invlist(invlist,
10780                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
10781                 }
10782                 else if (fc == LATIN_SMALL_LETTER_DOTLESS_I) {
10783                     invlist = add_cp_to_invlist(invlist, 'I');
10784                 }
10785                 else if (fc == LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE) {
10786                     invlist = add_cp_to_invlist(invlist, 'i');
10787                 }
10788             }
10789         }
10790     }
10791
10792     return invlist;
10793 }
10794
10795 #undef HEADER_LENGTH
10796 #undef TO_INTERNAL_SIZE
10797 #undef FROM_INTERNAL_SIZE
10798 #undef INVLIST_VERSION_ID
10799
10800 /* End of inversion list object */
10801
10802 STATIC void
10803 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
10804 {
10805     /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
10806      * constructs, and updates RExC_flags with them.  On input, RExC_parse
10807      * should point to the first flag; it is updated on output to point to the
10808      * final ')' or ':'.  There needs to be at least one flag, or this will
10809      * abort */
10810
10811     /* for (?g), (?gc), and (?o) warnings; warning
10812        about (?c) will warn about (?g) -- japhy    */
10813
10814 #define WASTED_O  0x01
10815 #define WASTED_G  0x02
10816 #define WASTED_C  0x04
10817 #define WASTED_GC (WASTED_G|WASTED_C)
10818     I32 wastedflags = 0x00;
10819     U32 posflags = 0, negflags = 0;
10820     U32 *flagsp = &posflags;
10821     char has_charset_modifier = '\0';
10822     regex_charset cs;
10823     bool has_use_defaults = FALSE;
10824     const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
10825     int x_mod_count = 0;
10826
10827     PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
10828
10829     /* '^' as an initial flag sets certain defaults */
10830     if (UCHARAT(RExC_parse) == '^') {
10831         RExC_parse++;
10832         has_use_defaults = TRUE;
10833         STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
10834         cs = (toUSE_UNI_CHARSET_NOT_DEPENDS)
10835              ? REGEX_UNICODE_CHARSET
10836              : REGEX_DEPENDS_CHARSET;
10837         set_regex_charset(&RExC_flags, cs);
10838     }
10839     else {
10840         cs = get_regex_charset(RExC_flags);
10841         if (   cs == REGEX_DEPENDS_CHARSET
10842             && (toUSE_UNI_CHARSET_NOT_DEPENDS))
10843         {
10844             cs = REGEX_UNICODE_CHARSET;
10845         }
10846     }
10847
10848     while (RExC_parse < RExC_end) {
10849         /* && memCHRs("iogcmsx", *RExC_parse) */
10850         /* (?g), (?gc) and (?o) are useless here
10851            and must be globally applied -- japhy */
10852         if ((RExC_pm_flags & PMf_WILDCARD)) {
10853             if (flagsp == & negflags) {
10854                 if (*RExC_parse == 'm') {
10855                     RExC_parse++;
10856                     /* diag_listed_as: Use of %s is not allowed in Unicode
10857                        property wildcard subpatterns in regex; marked by <--
10858                        HERE in m/%s/ */
10859                     vFAIL("Use of modifier '-m' is not allowed in Unicode"
10860                           " property wildcard subpatterns");
10861                 }
10862             }
10863             else {
10864                 if (*RExC_parse == 's') {
10865                     goto modifier_illegal_in_wildcard;
10866                 }
10867             }
10868         }
10869
10870         switch (*RExC_parse) {
10871
10872             /* Code for the imsxn flags */
10873             CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
10874
10875             case LOCALE_PAT_MOD:
10876                 if (has_charset_modifier) {
10877                     goto excess_modifier;
10878                 }
10879                 else if (flagsp == &negflags) {
10880                     goto neg_modifier;
10881                 }
10882                 cs = REGEX_LOCALE_CHARSET;
10883                 has_charset_modifier = LOCALE_PAT_MOD;
10884                 break;
10885             case UNICODE_PAT_MOD:
10886                 if (has_charset_modifier) {
10887                     goto excess_modifier;
10888                 }
10889                 else if (flagsp == &negflags) {
10890                     goto neg_modifier;
10891                 }
10892                 cs = REGEX_UNICODE_CHARSET;
10893                 has_charset_modifier = UNICODE_PAT_MOD;
10894                 break;
10895             case ASCII_RESTRICT_PAT_MOD:
10896                 if (flagsp == &negflags) {
10897                     goto neg_modifier;
10898                 }
10899                 if (has_charset_modifier) {
10900                     if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
10901                         goto excess_modifier;
10902                     }
10903                     /* Doubled modifier implies more restricted */
10904                     cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
10905                 }
10906                 else {
10907                     cs = REGEX_ASCII_RESTRICTED_CHARSET;
10908                 }
10909                 has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
10910                 break;
10911             case DEPENDS_PAT_MOD:
10912                 if (has_use_defaults) {
10913                     goto fail_modifiers;
10914                 }
10915                 else if (flagsp == &negflags) {
10916                     goto neg_modifier;
10917                 }
10918                 else if (has_charset_modifier) {
10919                     goto excess_modifier;
10920                 }
10921
10922                 /* The dual charset means unicode semantics if the
10923                  * pattern (or target, not known until runtime) are
10924                  * utf8, or something in the pattern indicates unicode
10925                  * semantics */
10926                 cs = (toUSE_UNI_CHARSET_NOT_DEPENDS)
10927                      ? REGEX_UNICODE_CHARSET
10928                      : REGEX_DEPENDS_CHARSET;
10929                 has_charset_modifier = DEPENDS_PAT_MOD;
10930                 break;
10931               excess_modifier:
10932                 RExC_parse++;
10933                 if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
10934                     vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
10935                 }
10936                 else if (has_charset_modifier == *(RExC_parse - 1)) {
10937                     vFAIL2("Regexp modifier \"%c\" may not appear twice",
10938                                         *(RExC_parse - 1));
10939                 }
10940                 else {
10941                     vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
10942                 }
10943                 NOT_REACHED; /*NOTREACHED*/
10944               neg_modifier:
10945                 RExC_parse++;
10946                 vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
10947                                     *(RExC_parse - 1));
10948                 NOT_REACHED; /*NOTREACHED*/
10949             case GLOBAL_PAT_MOD: /* 'g' */
10950                 if (RExC_pm_flags & PMf_WILDCARD) {
10951                     goto modifier_illegal_in_wildcard;
10952                 }
10953                 /*FALLTHROUGH*/
10954             case ONCE_PAT_MOD: /* 'o' */
10955                 if (ckWARN(WARN_REGEXP)) {
10956                     const I32 wflagbit = *RExC_parse == 'o'
10957                                          ? WASTED_O
10958                                          : WASTED_G;
10959                     if (! (wastedflags & wflagbit) ) {
10960                         wastedflags |= wflagbit;
10961                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10962                         vWARN5(
10963                             RExC_parse + 1,
10964                             "Useless (%s%c) - %suse /%c modifier",
10965                             flagsp == &negflags ? "?-" : "?",
10966                             *RExC_parse,
10967                             flagsp == &negflags ? "don't " : "",
10968                             *RExC_parse
10969                         );
10970                     }
10971                 }
10972                 break;
10973
10974             case CONTINUE_PAT_MOD: /* 'c' */
10975                 if (RExC_pm_flags & PMf_WILDCARD) {
10976                     goto modifier_illegal_in_wildcard;
10977                 }
10978                 if (ckWARN(WARN_REGEXP)) {
10979                     if (! (wastedflags & WASTED_C) ) {
10980                         wastedflags |= WASTED_GC;
10981                         /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
10982                         vWARN3(
10983                             RExC_parse + 1,
10984                             "Useless (%sc) - %suse /gc modifier",
10985                             flagsp == &negflags ? "?-" : "?",
10986                             flagsp == &negflags ? "don't " : ""
10987                         );
10988                     }
10989                 }
10990                 break;
10991             case KEEPCOPY_PAT_MOD: /* 'p' */
10992                 if (RExC_pm_flags & PMf_WILDCARD) {
10993                     goto modifier_illegal_in_wildcard;
10994                 }
10995                 if (flagsp == &negflags) {
10996                     ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
10997                 } else {
10998                     *flagsp |= RXf_PMf_KEEPCOPY;
10999                 }
11000                 break;
11001             case '-':
11002                 /* A flag is a default iff it is following a minus, so
11003                  * if there is a minus, it means will be trying to
11004                  * re-specify a default which is an error */
11005                 if (has_use_defaults || flagsp == &negflags) {
11006                     goto fail_modifiers;
11007                 }
11008                 flagsp = &negflags;
11009                 wastedflags = 0;  /* reset so (?g-c) warns twice */
11010                 x_mod_count = 0;
11011                 break;
11012             case ':':
11013             case ')':
11014
11015                 if (  (RExC_pm_flags & PMf_WILDCARD)
11016                     && cs != REGEX_ASCII_MORE_RESTRICTED_CHARSET)
11017                 {
11018                     RExC_parse++;
11019                     /* diag_listed_as: Use of %s is not allowed in Unicode
11020                        property wildcard subpatterns in regex; marked by <--
11021                        HERE in m/%s/ */
11022                     vFAIL2("Use of modifier '%c' is not allowed in Unicode"
11023                            " property wildcard subpatterns",
11024                            has_charset_modifier);
11025                 }
11026
11027                 if ((posflags & (RXf_PMf_EXTENDED|RXf_PMf_EXTENDED_MORE)) == RXf_PMf_EXTENDED) {
11028                     negflags |= RXf_PMf_EXTENDED_MORE;
11029                 }
11030                 RExC_flags |= posflags;
11031
11032                 if (negflags & RXf_PMf_EXTENDED) {
11033                     negflags |= RXf_PMf_EXTENDED_MORE;
11034                 }
11035                 RExC_flags &= ~negflags;
11036                 set_regex_charset(&RExC_flags, cs);
11037
11038                 return;
11039             default:
11040               fail_modifiers:
11041                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11042                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11043                 vFAIL2utf8f("Sequence (%" UTF8f "...) not recognized",
11044                       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11045                 NOT_REACHED; /*NOTREACHED*/
11046         }
11047
11048         RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11049     }
11050
11051     vFAIL("Sequence (?... not terminated");
11052
11053   modifier_illegal_in_wildcard:
11054     RExC_parse++;
11055     /* diag_listed_as: Use of %s is not allowed in Unicode property wildcard
11056        subpatterns in regex; marked by <-- HERE in m/%s/ */
11057     vFAIL2("Use of modifier '%c' is not allowed in Unicode property wildcard"
11058            " subpatterns", *(RExC_parse - 1));
11059 }
11060
11061 /*
11062  - reg - regular expression, i.e. main body or parenthesized thing
11063  *
11064  * Caller must absorb opening parenthesis.
11065  *
11066  * Combining parenthesis handling with the base level of regular expression
11067  * is a trifle forced, but the need to tie the tails of the branches to what
11068  * follows makes it hard to avoid.
11069  */
11070 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
11071 #ifdef DEBUGGING
11072 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
11073 #else
11074 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
11075 #endif
11076
11077 STATIC regnode_offset
11078 S_handle_named_backref(pTHX_ RExC_state_t *pRExC_state,
11079                              I32 *flagp,
11080                              char * parse_start,
11081                              char ch
11082                       )
11083 {
11084     regnode_offset ret;
11085     char* name_start = RExC_parse;
11086     U32 num = 0;
11087     SV *sv_dat = reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11088     DECLARE_AND_GET_RE_DEBUG_FLAGS;
11089
11090     PERL_ARGS_ASSERT_HANDLE_NAMED_BACKREF;
11091
11092     if (RExC_parse != name_start && ch == '}') {
11093         while (isBLANK(*RExC_parse)) {
11094             RExC_parse++;
11095         }
11096     }
11097     if (RExC_parse == name_start || *RExC_parse != ch) {
11098         /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
11099         vFAIL2("Sequence %.3s... not terminated", parse_start);
11100     }
11101
11102     if (sv_dat) {
11103         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11104         RExC_rxi->data->data[num]=(void*)sv_dat;
11105         SvREFCNT_inc_simple_void_NN(sv_dat);
11106     }
11107     RExC_sawback = 1;
11108     ret = reganode(pRExC_state,
11109                    ((! FOLD)
11110                      ? REFN
11111                      : (ASCII_FOLD_RESTRICTED)
11112                        ? REFFAN
11113                        : (AT_LEAST_UNI_SEMANTICS)
11114                          ? REFFUN
11115                          : (LOC)
11116                            ? REFFLN
11117                            : REFFN),
11118                     num);
11119     *flagp |= HASWIDTH;
11120
11121     Set_Node_Offset(REGNODE_p(ret), parse_start+1);
11122     Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
11123
11124     nextchar(pRExC_state);
11125     return ret;
11126 }
11127
11128 /* On success, returns the offset at which any next node should be placed into
11129  * the regex engine program being compiled.
11130  *
11131  * Returns 0 otherwise, with *flagp set to indicate why:
11132  *  TRYAGAIN        at the end of (?) that only sets flags.
11133  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
11134  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
11135  *  Otherwise would only return 0 if regbranch() returns 0, which cannot
11136  *  happen.  */
11137 STATIC regnode_offset
11138 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp, U32 depth)
11139     /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
11140      * 2 is like 1, but indicates that nextchar() has been called to advance
11141      * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
11142      * this flag alerts us to the need to check for that */
11143 {
11144     regnode_offset ret = 0;    /* Will be the head of the group. */
11145     regnode_offset br;
11146     regnode_offset lastbr;
11147     regnode_offset ender = 0;
11148     I32 parno = 0;
11149     I32 flags;
11150     U32 oregflags = RExC_flags;
11151     bool have_branch = 0;
11152     bool is_open = 0;
11153     I32 freeze_paren = 0;
11154     I32 after_freeze = 0;
11155     I32 num; /* numeric backreferences */
11156     SV * max_open;  /* Max number of unclosed parens */
11157     I32 was_in_lookaround = RExC_in_lookaround;
11158
11159     char * parse_start = RExC_parse; /* MJD */
11160     char * const oregcomp_parse = RExC_parse;
11161
11162     DECLARE_AND_GET_RE_DEBUG_FLAGS;
11163
11164     PERL_ARGS_ASSERT_REG;
11165     DEBUG_PARSE("reg ");
11166
11167     max_open = get_sv(RE_COMPILE_RECURSION_LIMIT, GV_ADD);
11168     assert(max_open);
11169     if (!SvIOK(max_open)) {
11170         sv_setiv(max_open, RE_COMPILE_RECURSION_INIT);
11171     }
11172     if (depth > 4 * (UV) SvIV(max_open)) { /* We increase depth by 4 for each
11173                                               open paren */
11174         vFAIL("Too many nested open parens");
11175     }
11176
11177     *flagp = 0;                         /* Initialize. */
11178
11179     /* Having this true makes it feasible to have a lot fewer tests for the
11180      * parse pointer being in scope.  For example, we can write
11181      *      while(isFOO(*RExC_parse)) RExC_parse++;
11182      * instead of
11183      *      while(RExC_parse < RExC_end && isFOO(*RExC_parse)) RExC_parse++;
11184      */
11185     assert(*RExC_end == '\0');
11186
11187     /* Make an OPEN node, if parenthesized. */
11188     if (paren) {
11189
11190         /* Under /x, space and comments can be gobbled up between the '(' and
11191          * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
11192          * intervening space, as the sequence is a token, and a token should be
11193          * indivisible */
11194         bool has_intervening_patws = (paren == 2)
11195                                   && *(RExC_parse - 1) != '(';
11196
11197         if (RExC_parse >= RExC_end) {
11198             vFAIL("Unmatched (");
11199         }
11200
11201         if (paren == 'r') {     /* Atomic script run */
11202             paren = '>';
11203             goto parse_rest;
11204         }
11205         else if ( *RExC_parse == '*') { /* (*VERB:ARG), (*construct:...) */
11206             char *start_verb = RExC_parse + 1;
11207             STRLEN verb_len;
11208             char *start_arg = NULL;
11209             unsigned char op = 0;
11210             int arg_required = 0;
11211             int internal_argval = -1; /* if >-1 we are not allowed an argument*/
11212             bool has_upper = FALSE;
11213
11214             if (has_intervening_patws) {
11215                 RExC_parse++;   /* past the '*' */
11216
11217                 /* For strict backwards compatibility, don't change the message
11218                  * now that we also have lowercase operands */
11219                 if (isUPPER(*RExC_parse)) {
11220                     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
11221                 }
11222                 else {
11223                     vFAIL("In '(*...)', the '(' and '*' must be adjacent");
11224                 }
11225             }
11226             while (RExC_parse < RExC_end && *RExC_parse != ')' ) {
11227                 if ( *RExC_parse == ':' ) {
11228                     start_arg = RExC_parse + 1;
11229                     break;
11230                 }
11231                 else if (! UTF) {
11232                     if (isUPPER(*RExC_parse)) {
11233                         has_upper = TRUE;
11234                     }
11235                     RExC_parse++;
11236                 }
11237                 else {
11238                     RExC_parse += UTF8SKIP(RExC_parse);
11239                 }
11240             }
11241             verb_len = RExC_parse - start_verb;
11242             if ( start_arg ) {
11243                 if (RExC_parse >= RExC_end) {
11244                     goto unterminated_verb_pattern;
11245                 }
11246
11247                 RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11248                 while ( RExC_parse < RExC_end && *RExC_parse != ')' ) {
11249                     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11250                 }
11251                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11252                   unterminated_verb_pattern:
11253                     if (has_upper) {
11254                         vFAIL("Unterminated verb pattern argument");
11255                     }
11256                     else {
11257                         vFAIL("Unterminated '(*...' argument");
11258                     }
11259                 }
11260             } else {
11261                 if ( RExC_parse >= RExC_end || *RExC_parse != ')' ) {
11262                     if (has_upper) {
11263                         vFAIL("Unterminated verb pattern");
11264                     }
11265                     else {
11266                         vFAIL("Unterminated '(*...' construct");
11267                     }
11268                 }
11269             }
11270
11271             /* Here, we know that RExC_parse < RExC_end */
11272
11273             switch ( *start_verb ) {
11274             case 'A':  /* (*ACCEPT) */
11275                 if ( memEQs(start_verb, verb_len,"ACCEPT") ) {
11276                     op = ACCEPT;
11277                     internal_argval = RExC_nestroot;
11278                 }
11279                 break;
11280             case 'C':  /* (*COMMIT) */
11281                 if ( memEQs(start_verb, verb_len,"COMMIT") )
11282                     op = COMMIT;
11283                 break;
11284             case 'F':  /* (*FAIL) */
11285                 if ( verb_len==1 || memEQs(start_verb, verb_len,"FAIL") ) {
11286                     op = OPFAIL;
11287                 }
11288                 break;
11289             case ':':  /* (*:NAME) */
11290             case 'M':  /* (*MARK:NAME) */
11291                 if ( verb_len==0 || memEQs(start_verb, verb_len,"MARK") ) {
11292                     op = MARKPOINT;
11293                     arg_required = 1;
11294                 }
11295                 break;
11296             case 'P':  /* (*PRUNE) */
11297                 if ( memEQs(start_verb, verb_len,"PRUNE") )
11298                     op = PRUNE;
11299                 break;
11300             case 'S':   /* (*SKIP) */
11301                 if ( memEQs(start_verb, verb_len,"SKIP") )
11302                     op = SKIP;
11303                 break;
11304             case 'T':  /* (*THEN) */
11305                 /* [19:06] <TimToady> :: is then */
11306                 if ( memEQs(start_verb, verb_len,"THEN") ) {
11307                     op = CUTGROUP;
11308                     RExC_seen |= REG_CUTGROUP_SEEN;
11309                 }
11310                 break;
11311             case 'a':
11312                 if (   memEQs(start_verb, verb_len, "asr")
11313                     || memEQs(start_verb, verb_len, "atomic_script_run"))
11314                 {
11315                     paren = 'r';        /* Mnemonic: recursed run */
11316                     goto script_run;
11317                 }
11318                 else if (memEQs(start_verb, verb_len, "atomic")) {
11319                     paren = 't';    /* AtOMIC */
11320                     goto alpha_assertions;
11321                 }
11322                 break;
11323             case 'p':
11324                 if (   memEQs(start_verb, verb_len, "plb")
11325                     || memEQs(start_verb, verb_len, "positive_lookbehind"))
11326                 {
11327                     paren = 'b';
11328                     goto lookbehind_alpha_assertions;
11329                 }
11330                 else if (   memEQs(start_verb, verb_len, "pla")
11331                          || memEQs(start_verb, verb_len, "positive_lookahead"))
11332                 {
11333                     paren = 'a';
11334                     goto alpha_assertions;
11335                 }
11336                 break;
11337             case 'n':
11338                 if (   memEQs(start_verb, verb_len, "nlb")
11339                     || memEQs(start_verb, verb_len, "negative_lookbehind"))
11340                 {
11341                     paren = 'B';
11342                     goto lookbehind_alpha_assertions;
11343                 }
11344                 else if (   memEQs(start_verb, verb_len, "nla")
11345                          || memEQs(start_verb, verb_len, "negative_lookahead"))
11346                 {
11347                     paren = 'A';
11348                     goto alpha_assertions;
11349                 }
11350                 break;
11351             case 's':
11352                 if (   memEQs(start_verb, verb_len, "sr")
11353                     || memEQs(start_verb, verb_len, "script_run"))
11354                 {
11355                     regnode_offset atomic;
11356
11357                     paren = 's';
11358
11359                    script_run:
11360
11361                     /* This indicates Unicode rules. */
11362                     REQUIRE_UNI_RULES(flagp, 0);
11363
11364                     if (! start_arg) {
11365                         goto no_colon;
11366                     }
11367
11368                     RExC_parse = start_arg;
11369
11370                     if (RExC_in_script_run) {
11371
11372                         /*  Nested script runs are treated as no-ops, because
11373                          *  if the nested one fails, the outer one must as
11374                          *  well.  It could fail sooner, and avoid (??{} with
11375                          *  side effects, but that is explicitly documented as
11376                          *  undefined behavior. */
11377
11378                         ret = 0;
11379
11380                         if (paren == 's') {
11381                             paren = ':';
11382                             goto parse_rest;
11383                         }
11384
11385                         /* But, the atomic part of a nested atomic script run
11386                          * isn't a no-op, but can be treated just like a '(?>'
11387                          * */
11388                         paren = '>';
11389                         goto parse_rest;
11390                     }
11391
11392                     if (paren == 's') {
11393                         /* Here, we're starting a new regular script run */
11394                         ret = reg_node(pRExC_state, SROPEN);
11395                         RExC_in_script_run = 1;
11396                         is_open = 1;
11397                         goto parse_rest;
11398                     }
11399
11400                     /* Here, we are starting an atomic script run.  This is
11401                      * handled by recursing to deal with the atomic portion
11402                      * separately, enclosed in SROPEN ... SRCLOSE nodes */
11403
11404                     ret = reg_node(pRExC_state, SROPEN);
11405
11406                     RExC_in_script_run = 1;
11407
11408                     atomic = reg(pRExC_state, 'r', &flags, depth);
11409                     if (flags & (RESTART_PARSE|NEED_UTF8)) {
11410                         *flagp = flags & (RESTART_PARSE|NEED_UTF8);
11411                         return 0;
11412                     }
11413
11414                     if (! REGTAIL(pRExC_state, ret, atomic)) {
11415                         REQUIRE_BRANCHJ(flagp, 0);
11416                     }
11417
11418                     if (! REGTAIL(pRExC_state, atomic, reg_node(pRExC_state,
11419                                                                 SRCLOSE)))
11420                     {
11421                         REQUIRE_BRANCHJ(flagp, 0);
11422                     }
11423
11424                     RExC_in_script_run = 0;
11425                     return ret;
11426                 }
11427
11428                 break;
11429
11430             lookbehind_alpha_assertions:
11431                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11432                 /*FALLTHROUGH*/
11433
11434             alpha_assertions:
11435
11436                 RExC_in_lookaround++;
11437                 RExC_seen_zerolen++;
11438
11439                 if (! start_arg) {
11440                     goto no_colon;
11441                 }
11442
11443                 /* An empty negative lookahead assertion simply is failure */
11444                 if (paren == 'A' && RExC_parse == start_arg) {
11445                     ret=reganode(pRExC_state, OPFAIL, 0);
11446                     nextchar(pRExC_state);
11447                     return ret;
11448                 }
11449
11450                 RExC_parse = start_arg;
11451                 goto parse_rest;
11452
11453               no_colon:
11454                 vFAIL2utf8f(
11455                 "'(*%" UTF8f "' requires a terminating ':'",
11456                 UTF8fARG(UTF, verb_len, start_verb));
11457                 NOT_REACHED; /*NOTREACHED*/
11458
11459             } /* End of switch */
11460             if ( ! op ) {
11461                 RExC_parse += UTF
11462                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
11463                               : 1;
11464                 if (has_upper || verb_len == 0) {
11465                     vFAIL2utf8f(
11466                     "Unknown verb pattern '%" UTF8f "'",
11467                     UTF8fARG(UTF, verb_len, start_verb));
11468                 }
11469                 else {
11470                     vFAIL2utf8f(
11471                     "Unknown '(*...)' construct '%" UTF8f "'",
11472                     UTF8fARG(UTF, verb_len, start_verb));
11473                 }
11474             }
11475             if ( RExC_parse == start_arg ) {
11476                 start_arg = NULL;
11477             }
11478             if ( arg_required && !start_arg ) {
11479                 vFAIL3("Verb pattern '%.*s' has a mandatory argument",
11480                     (int) verb_len, start_verb);
11481             }
11482             if (internal_argval == -1) {
11483                 ret = reganode(pRExC_state, op, 0);
11484             } else {
11485                 ret = reg2Lanode(pRExC_state, op, 0, internal_argval);
11486             }
11487             RExC_seen |= REG_VERBARG_SEEN;
11488             if (start_arg) {
11489                 SV *sv = newSVpvn( start_arg,
11490                                     RExC_parse - start_arg);
11491                 ARG(REGNODE_p(ret)) = add_data( pRExC_state,
11492                                         STR_WITH_LEN("S"));
11493                 RExC_rxi->data->data[ARG(REGNODE_p(ret))]=(void*)sv;
11494                 FLAGS(REGNODE_p(ret)) = 1;
11495             } else {
11496                 FLAGS(REGNODE_p(ret)) = 0;
11497             }
11498             if ( internal_argval != -1 )
11499                 ARG2L_SET(REGNODE_p(ret), internal_argval);
11500             nextchar(pRExC_state);
11501             return ret;
11502         }
11503         else if (*RExC_parse == '?') { /* (?...) */
11504             bool is_logical = 0;
11505             const char * const seqstart = RExC_parse;
11506             const char * endptr;
11507             const char non_existent_group_msg[]
11508                                             = "Reference to nonexistent group";
11509             const char impossible_group[] = "Invalid reference to group";
11510
11511             if (has_intervening_patws) {
11512                 RExC_parse++;
11513                 vFAIL("In '(?...)', the '(' and '?' must be adjacent");
11514             }
11515
11516             RExC_parse++;           /* past the '?' */
11517             paren = *RExC_parse;    /* might be a trailing NUL, if not
11518                                        well-formed */
11519             RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
11520             if (RExC_parse > RExC_end) {
11521                 paren = '\0';
11522             }
11523             ret = 0;                    /* For look-ahead/behind. */
11524             switch (paren) {
11525
11526             case 'P':   /* (?P...) variants for those used to PCRE/Python */
11527                 paren = *RExC_parse;
11528                 if ( paren == '<') {    /* (?P<...>) named capture */
11529                     RExC_parse++;
11530                     if (RExC_parse >= RExC_end) {
11531                         vFAIL("Sequence (?P<... not terminated");
11532                     }
11533                     goto named_capture;
11534                 }
11535                 else if (paren == '>') {   /* (?P>name) named recursion */
11536                     RExC_parse++;
11537                     if (RExC_parse >= RExC_end) {
11538                         vFAIL("Sequence (?P>... not terminated");
11539                     }
11540                     goto named_recursion;
11541                 }
11542                 else if (paren == '=') {   /* (?P=...)  named backref */
11543                     RExC_parse++;
11544                     return handle_named_backref(pRExC_state, flagp,
11545                                                 parse_start, ')');
11546                 }
11547                 RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11548                 /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11549                 vFAIL3("Sequence (%.*s...) not recognized",
11550                                 (int) (RExC_parse - seqstart), seqstart);
11551                 NOT_REACHED; /*NOTREACHED*/
11552             case '<':           /* (?<...) */
11553                 /* If you want to support (?<*...), first reconcile with GH #17363 */
11554                 if (*RExC_parse == '!')
11555                     paren = ',';
11556                 else if (*RExC_parse != '=')
11557               named_capture:
11558                 {               /* (?<...>) */
11559                     char *name_start;
11560                     SV *svname;
11561                     paren= '>';
11562                 /* FALLTHROUGH */
11563             case '\'':          /* (?'...') */
11564                     name_start = RExC_parse;
11565                     svname = reg_scan_name(pRExC_state, REG_RSN_RETURN_NAME);
11566                     if (   RExC_parse == name_start
11567                         || RExC_parse >= RExC_end
11568                         || *RExC_parse != paren)
11569                     {
11570                         vFAIL2("Sequence (?%c... not terminated",
11571                             paren=='>' ? '<' : (char) paren);
11572                     }
11573                     {
11574                         HE *he_str;
11575                         SV *sv_dat = NULL;
11576                         if (!svname) /* shouldn't happen */
11577                             Perl_croak(aTHX_
11578                                 "panic: reg_scan_name returned NULL");
11579                         if (!RExC_paren_names) {
11580                             RExC_paren_names= newHV();
11581                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
11582 #ifdef DEBUGGING
11583                             RExC_paren_name_list= newAV();
11584                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
11585 #endif
11586                         }
11587                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
11588                         if ( he_str )
11589                             sv_dat = HeVAL(he_str);
11590                         if ( ! sv_dat ) {
11591                             /* croak baby croak */
11592                             Perl_croak(aTHX_
11593                                 "panic: paren_name hash element allocation failed");
11594                         } else if ( SvPOK(sv_dat) ) {
11595                             /* (?|...) can mean we have dupes so scan to check
11596                                its already been stored. Maybe a flag indicating
11597                                we are inside such a construct would be useful,
11598                                but the arrays are likely to be quite small, so
11599                                for now we punt -- dmq */
11600                             IV count = SvIV(sv_dat);
11601                             I32 *pv = (I32*)SvPVX(sv_dat);
11602                             IV i;
11603                             for ( i = 0 ; i < count ; i++ ) {
11604                                 if ( pv[i] == RExC_npar ) {
11605                                     count = 0;
11606                                     break;
11607                                 }
11608                             }
11609                             if ( count ) {
11610                                 pv = (I32*)SvGROW(sv_dat,
11611                                                 SvCUR(sv_dat) + sizeof(I32)+1);
11612                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
11613                                 pv[count] = RExC_npar;
11614                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
11615                             }
11616                         } else {
11617                             (void)SvUPGRADE(sv_dat, SVt_PVNV);
11618                             sv_setpvn(sv_dat, (char *)&(RExC_npar),
11619                                                                 sizeof(I32));
11620                             SvIOK_on(sv_dat);
11621                             SvIV_set(sv_dat, 1);
11622                         }
11623 #ifdef DEBUGGING
11624                         /* Yes this does cause a memory leak in debugging Perls
11625                          * */
11626                         if (!av_store(RExC_paren_name_list,
11627                                       RExC_npar, SvREFCNT_inc_NN(svname)))
11628                             SvREFCNT_dec_NN(svname);
11629 #endif
11630
11631                         /*sv_dump(sv_dat);*/
11632                     }
11633                     nextchar(pRExC_state);
11634                     paren = 1;
11635                     goto capturing_parens;
11636                 }
11637
11638                 RExC_seen |= REG_LOOKBEHIND_SEEN;
11639                 RExC_in_lookaround++;
11640                 RExC_parse++;
11641                 if (RExC_parse >= RExC_end) {
11642                     vFAIL("Sequence (?... not terminated");
11643                 }
11644                 RExC_seen_zerolen++;
11645                 break;
11646             case '=':           /* (?=...) */
11647                 RExC_seen_zerolen++;
11648                 RExC_in_lookaround++;
11649                 break;
11650             case '!':           /* (?!...) */
11651                 RExC_seen_zerolen++;
11652                 /* check if we're really just a "FAIL" assertion */
11653                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
11654                                         FALSE /* Don't force to /x */ );
11655                 if (*RExC_parse == ')') {
11656                     ret=reganode(pRExC_state, OPFAIL, 0);
11657                     nextchar(pRExC_state);
11658                     return ret;
11659                 }
11660                 RExC_in_lookaround++;
11661                 break;
11662             case '|':           /* (?|...) */
11663                 /* branch reset, behave like a (?:...) except that
11664                    buffers in alternations share the same numbers */
11665                 paren = ':';
11666                 after_freeze = freeze_paren = RExC_npar;
11667
11668                 /* XXX This construct currently requires an extra pass.
11669                  * Investigation would be required to see if that could be
11670                  * changed */
11671                 REQUIRE_PARENS_PASS;
11672                 break;
11673             case ':':           /* (?:...) */
11674             case '>':           /* (?>...) */
11675                 break;
11676             case '$':           /* (?$...) */
11677             case '@':           /* (?@...) */
11678                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
11679                 break;
11680             case '0' :           /* (?0) */
11681             case 'R' :           /* (?R) */
11682                 if (RExC_parse == RExC_end || *RExC_parse != ')')
11683                     FAIL("Sequence (?R) not terminated");
11684                 num = 0;
11685                 RExC_seen |= REG_RECURSE_SEEN;
11686
11687                 /* XXX These constructs currently require an extra pass.
11688                  * It probably could be changed */
11689                 REQUIRE_PARENS_PASS;
11690
11691                 *flagp |= POSTPONED;
11692                 goto gen_recurse_regop;
11693                 /*notreached*/
11694             /* named and numeric backreferences */
11695             case '&':            /* (?&NAME) */
11696                 parse_start = RExC_parse - 1;
11697               named_recursion:
11698                 {
11699                     SV *sv_dat = reg_scan_name(pRExC_state,
11700                                                REG_RSN_RETURN_DATA);
11701                    num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
11702                 }
11703                 if (RExC_parse >= RExC_end || *RExC_parse != ')')
11704                     vFAIL("Sequence (?&... not terminated");
11705                 goto gen_recurse_regop;
11706                 /* NOTREACHED */
11707             case '+':
11708                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11709                     RExC_parse++;
11710                     vFAIL("Illegal pattern");
11711                 }
11712                 goto parse_recursion;
11713                 /* NOTREACHED*/
11714             case '-': /* (?-1) */
11715                 if (! inRANGE(RExC_parse[0], '1', '9')) {
11716                     RExC_parse--; /* rewind to let it be handled later */
11717                     goto parse_flags;
11718                 }
11719                 /* FALLTHROUGH */
11720             case '1': case '2': case '3': case '4': /* (?1) */
11721             case '5': case '6': case '7': case '8': case '9':
11722                 RExC_parse = (char *) seqstart + 1;  /* Point to the digit */
11723               parse_recursion:
11724                 {
11725                     bool is_neg = FALSE;
11726                     UV unum;
11727                     parse_start = RExC_parse - 1; /* MJD */
11728                     if (*RExC_parse == '-') {
11729                         RExC_parse++;
11730                         is_neg = TRUE;
11731                     }
11732                     endptr = RExC_end;
11733                     if (grok_atoUV(RExC_parse, &unum, &endptr)
11734                         && unum <= I32_MAX
11735                     ) {
11736                         num = (I32)unum;
11737                         RExC_parse = (char*)endptr;
11738                     }
11739                     else {  /* Overflow, or something like that.  Position
11740                                beyond all digits for the message */
11741                         while (RExC_parse < RExC_end && isDIGIT(*RExC_parse))  {
11742                             RExC_parse++;
11743                         }
11744                         vFAIL(impossible_group);
11745                     }
11746                     if (is_neg) {
11747                         /* -num is always representable on 1 and 2's complement
11748                          * machines */
11749                         num = -num;
11750                     }
11751                 }
11752                 if (*RExC_parse!=')')
11753                     vFAIL("Expecting close bracket");
11754
11755               gen_recurse_regop:
11756                 if (paren == '-' || paren == '+') {
11757
11758                     /* Don't overflow */
11759                     if (UNLIKELY(I32_MAX - RExC_npar < num)) {
11760                         RExC_parse++;
11761                         vFAIL(impossible_group);
11762                     }
11763
11764                     /*
11765                     Diagram of capture buffer numbering.
11766                     Top line is the normal capture buffer numbers
11767                     Bottom line is the negative indexing as from
11768                     the X (the (?-2))
11769
11770                         1 2    3 4 5 X   Y      6 7
11771                        /(a(x)y)(a(b(c(?+2)d)e)f)(g(h))/
11772                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
11773                     -   5 4    3 2 1 X   Y      x x
11774
11775                     Resolve to absolute group.  Recall that RExC_npar is +1 of
11776                     the actual parenthesis group number.  For lookahead, we
11777                     have to compensate for that.  Using the above example, when
11778                     we get to Y in the parse, num is 2 and RExC_npar is 6.  We
11779                     want 7 for +2, and 4 for -2.
11780                     */
11781                     if ( paren == '+' ) {
11782                         num--;
11783                     }
11784
11785                     num += RExC_npar;
11786
11787                     if (paren == '-' && num < 1) {
11788                         RExC_parse++;
11789                         vFAIL(non_existent_group_msg);
11790                     }
11791                 }
11792
11793                 if (num >= RExC_npar) {
11794
11795                     /* It might be a forward reference; we can't fail until we
11796                      * know, by completing the parse to get all the groups, and
11797                      * then reparsing */
11798                     if (ALL_PARENS_COUNTED)  {
11799                         if (num >= RExC_total_parens) {
11800                             RExC_parse++;
11801                             vFAIL(non_existent_group_msg);
11802                         }
11803                     }
11804                     else {
11805                         REQUIRE_PARENS_PASS;
11806                     }
11807                 }
11808
11809                 /* We keep track how many GOSUB items we have produced.
11810                    To start off the ARG2L() of the GOSUB holds its "id",
11811                    which is used later in conjunction with RExC_recurse
11812                    to calculate the offset we need to jump for the GOSUB,
11813                    which it will store in the final representation.
11814                    We have to defer the actual calculation until much later
11815                    as the regop may move.
11816                  */
11817                 ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
11818                 RExC_recurse_count++;
11819                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
11820                     "%*s%*s Recurse #%" UVuf " to %" IVdf "\n",
11821                             22, "|    |", (int)(depth * 2 + 1), "",
11822                             (UV)ARG(REGNODE_p(ret)),
11823                             (IV)ARG2L(REGNODE_p(ret))));
11824                 RExC_seen |= REG_RECURSE_SEEN;
11825
11826                 Set_Node_Length(REGNODE_p(ret),
11827                                 1 + regarglen[OP(REGNODE_p(ret))]); /* MJD */
11828                 Set_Node_Offset(REGNODE_p(ret), parse_start); /* MJD */
11829
11830                 *flagp |= POSTPONED;
11831                 assert(*RExC_parse == ')');
11832                 nextchar(pRExC_state);
11833                 return ret;
11834
11835             /* NOTREACHED */
11836
11837             case '?':           /* (??...) */
11838                 is_logical = 1;
11839                 if (*RExC_parse != '{') {
11840                     RExC_parse += SKIP_IF_CHAR(RExC_parse, RExC_end);
11841                     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
11842                     vFAIL2utf8f(
11843                         "Sequence (%" UTF8f "...) not recognized",
11844                         UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
11845                     NOT_REACHED; /*NOTREACHED*/
11846                 }
11847                 *flagp |= POSTPONED;
11848                 paren = '{';
11849                 RExC_parse++;
11850                 /* FALLTHROUGH */
11851             case '{':           /* (?{...}) */
11852             {
11853                 U32 n = 0;
11854                 struct reg_code_block *cb;
11855                 OP * o;
11856
11857                 RExC_seen_zerolen++;
11858
11859                 if (   !pRExC_state->code_blocks
11860                     || pRExC_state->code_index
11861                                         >= pRExC_state->code_blocks->count
11862                     || pRExC_state->code_blocks->cb[pRExC_state->code_index].start
11863                         != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
11864                             - RExC_start)
11865                 ) {
11866                     if (RExC_pm_flags & PMf_USE_RE_EVAL)
11867                         FAIL("panic: Sequence (?{...}): no code block found\n");
11868                     FAIL("Eval-group not allowed at runtime, use re 'eval'");
11869                 }
11870                 /* this is a pre-compiled code block (?{...}) */
11871                 cb = &pRExC_state->code_blocks->cb[pRExC_state->code_index];
11872                 RExC_parse = RExC_start + cb->end;
11873                 o = cb->block;
11874                 if (cb->src_regex) {
11875                     n = add_data(pRExC_state, STR_WITH_LEN("rl"));
11876                     RExC_rxi->data->data[n] =
11877                         (void*)SvREFCNT_inc((SV*)cb->src_regex);
11878                     RExC_rxi->data->data[n+1] = (void*)o;
11879                 }
11880                 else {
11881                     n = add_data(pRExC_state,
11882                             (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
11883                     RExC_rxi->data->data[n] = (void*)o;
11884                 }
11885                 pRExC_state->code_index++;
11886                 nextchar(pRExC_state);
11887
11888                 if (is_logical) {
11889                     regnode_offset eval;
11890                     ret = reg_node(pRExC_state, LOGICAL);
11891
11892                     eval = reg2Lanode(pRExC_state, EVAL,
11893                                        n,
11894
11895                                        /* for later propagation into (??{})
11896                                         * return value */
11897                                        RExC_flags & RXf_PMf_COMPILETIME
11898                                       );
11899                     FLAGS(REGNODE_p(ret)) = 2;
11900                     if (! REGTAIL(pRExC_state, ret, eval)) {
11901                         REQUIRE_BRANCHJ(flagp, 0);
11902                     }
11903                     /* deal with the length of this later - MJD */
11904                     return ret;
11905                 }
11906                 ret = reg2Lanode(pRExC_state, EVAL, n, 0);
11907                 Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1);
11908                 Set_Node_Offset(REGNODE_p(ret), parse_start);
11909                 return ret;
11910             }
11911             case '(':           /* (?(?{...})...) and (?(?=...)...) */
11912             {
11913                 int is_define= 0;
11914                 const int DEFINE_len = sizeof("DEFINE") - 1;
11915                 if (    RExC_parse < RExC_end - 1
11916                     && (   (       RExC_parse[0] == '?'        /* (?(?...)) */
11917                             && (   RExC_parse[1] == '='
11918                                 || RExC_parse[1] == '!'
11919                                 || RExC_parse[1] == '<'
11920                                 || RExC_parse[1] == '{'))
11921                         || (       RExC_parse[0] == '*'        /* (?(*...)) */
11922                             && (   memBEGINs(RExC_parse + 1,
11923                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11924                                          "pla:")
11925                                 || memBEGINs(RExC_parse + 1,
11926                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11927                                          "plb:")
11928                                 || memBEGINs(RExC_parse + 1,
11929                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11930                                          "nla:")
11931                                 || memBEGINs(RExC_parse + 1,
11932                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11933                                          "nlb:")
11934                                 || memBEGINs(RExC_parse + 1,
11935                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11936                                          "positive_lookahead:")
11937                                 || memBEGINs(RExC_parse + 1,
11938                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11939                                          "positive_lookbehind:")
11940                                 || memBEGINs(RExC_parse + 1,
11941                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11942                                          "negative_lookahead:")
11943                                 || memBEGINs(RExC_parse + 1,
11944                                          (Size_t) (RExC_end - (RExC_parse + 1)),
11945                                          "negative_lookbehind:"))))
11946                 ) { /* Lookahead or eval. */
11947                     I32 flag;
11948                     regnode_offset tail;
11949
11950                     ret = reg_node(pRExC_state, LOGICAL);
11951                     FLAGS(REGNODE_p(ret)) = 1;
11952
11953                     tail = reg(pRExC_state, 1, &flag, depth+1);
11954                     RETURN_FAIL_ON_RESTART(flag, flagp);
11955                     if (! REGTAIL(pRExC_state, ret, tail)) {
11956                         REQUIRE_BRANCHJ(flagp, 0);
11957                     }
11958                     goto insert_if;
11959                 }
11960                 else if (   RExC_parse[0] == '<'     /* (?(<NAME>)...) */
11961                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
11962                 {
11963                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
11964                     char *name_start= RExC_parse++;
11965                     U32 num = 0;
11966                     SV *sv_dat=reg_scan_name(pRExC_state, REG_RSN_RETURN_DATA);
11967                     if (   RExC_parse == name_start
11968                         || RExC_parse >= RExC_end
11969                         || *RExC_parse != ch)
11970                     {
11971                         vFAIL2("Sequence (?(%c... not terminated",
11972                             (ch == '>' ? '<' : ch));
11973                     }
11974                     RExC_parse++;
11975                     if (sv_dat) {
11976                         num = add_data( pRExC_state, STR_WITH_LEN("S"));
11977                         RExC_rxi->data->data[num]=(void*)sv_dat;
11978                         SvREFCNT_inc_simple_void_NN(sv_dat);
11979                     }
11980                     ret = reganode(pRExC_state, GROUPPN, num);
11981                     goto insert_if_check_paren;
11982                 }
11983                 else if (memBEGINs(RExC_parse,
11984                                    (STRLEN) (RExC_end - RExC_parse),
11985                                    "DEFINE"))
11986                 {
11987                     ret = reganode(pRExC_state, DEFINEP, 0);
11988                     RExC_parse += DEFINE_len;
11989                     is_define = 1;
11990                     goto insert_if_check_paren;
11991                 }
11992                 else if (RExC_parse[0] == 'R') {
11993                     RExC_parse++;
11994                     /* parno == 0 => /(?(R)YES|NO)/  "in any form of recursion OR eval"
11995                      * parno == 1 => /(?(R0)YES|NO)/ "in GOSUB (?0) / (?R)"
11996                      * parno == 2 => /(?(R1)YES|NO)/ "in GOSUB (?1) (parno-1)"
11997                      */
11998                     parno = 0;
11999                     if (RExC_parse[0] == '0') {
12000                         parno = 1;
12001                         RExC_parse++;
12002                     }
12003                     else if (inRANGE(RExC_parse[0], '1', '9')) {
12004                         UV uv;
12005                         endptr = RExC_end;
12006                         if (grok_atoUV(RExC_parse, &uv, &endptr)
12007                             && uv <= I32_MAX
12008                         ) {
12009                             parno = (I32)uv + 1;
12010                             RExC_parse = (char*)endptr;
12011                         }
12012                         /* else "Switch condition not recognized" below */
12013                     } else if (RExC_parse[0] == '&') {
12014                         SV *sv_dat;
12015                         RExC_parse++;
12016                         sv_dat = reg_scan_name(pRExC_state,
12017                                                REG_RSN_RETURN_DATA);
12018                         if (sv_dat)
12019                             parno = 1 + *((I32 *)SvPVX(sv_dat));
12020                     }
12021                     ret = reganode(pRExC_state, INSUBP, parno);
12022                     goto insert_if_check_paren;
12023                 }
12024                 else if (inRANGE(RExC_parse[0], '1', '9')) {
12025                     /* (?(1)...) */
12026                     char c;
12027                     UV uv;
12028                     endptr = RExC_end;
12029                     if (grok_atoUV(RExC_parse, &uv, &endptr)
12030                         && uv <= I32_MAX
12031                     ) {
12032                         parno = (I32)uv;
12033                         RExC_parse = (char*)endptr;
12034                     }
12035                     else {
12036                         vFAIL("panic: grok_atoUV returned FALSE");
12037                     }
12038                     ret = reganode(pRExC_state, GROUPP, parno);
12039
12040                  insert_if_check_paren:
12041                     if (UCHARAT(RExC_parse) != ')') {
12042                         RExC_parse += UTF
12043                                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
12044                                       : 1;
12045                         vFAIL("Switch condition not recognized");
12046                     }
12047                     nextchar(pRExC_state);
12048                   insert_if:
12049                     if (! REGTAIL(pRExC_state, ret, reganode(pRExC_state,
12050                                                              IFTHEN, 0)))
12051                     {
12052                         REQUIRE_BRANCHJ(flagp, 0);
12053                     }
12054                     br = regbranch(pRExC_state, &flags, 1, depth+1);
12055                     if (br == 0) {
12056                         RETURN_FAIL_ON_RESTART(flags,flagp);
12057                         FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
12058                               (UV) flags);
12059                     } else
12060                     if (! REGTAIL(pRExC_state, br, reganode(pRExC_state,
12061                                                              LONGJMP, 0)))
12062                     {
12063                         REQUIRE_BRANCHJ(flagp, 0);
12064                     }
12065                     c = UCHARAT(RExC_parse);
12066                     nextchar(pRExC_state);
12067                     if (flags&HASWIDTH)
12068                         *flagp |= HASWIDTH;
12069                     if (c == '|') {
12070                         if (is_define)
12071                             vFAIL("(?(DEFINE)....) does not allow branches");
12072
12073                         /* Fake one for optimizer.  */
12074                         lastbr = reganode(pRExC_state, IFTHEN, 0);
12075
12076                         if (!regbranch(pRExC_state, &flags, 1, depth+1)) {
12077                             RETURN_FAIL_ON_RESTART(flags, flagp);
12078                             FAIL2("panic: regbranch returned failure, flags=%#" UVxf,
12079                                   (UV) flags);
12080                         }
12081                         if (! REGTAIL(pRExC_state, ret, lastbr)) {
12082                             REQUIRE_BRANCHJ(flagp, 0);
12083                         }
12084                         if (flags&HASWIDTH)
12085                             *flagp |= HASWIDTH;
12086                         c = UCHARAT(RExC_parse);
12087                         nextchar(pRExC_state);
12088                     }
12089                     else
12090                         lastbr = 0;
12091                     if (c != ')') {
12092                         if (RExC_parse >= RExC_end)
12093                             vFAIL("Switch (?(condition)... not terminated");
12094                         else
12095                             vFAIL("Switch (?(condition)... contains too many branches");
12096                     }
12097                     ender = reg_node(pRExC_state, TAIL);
12098                     if (! REGTAIL(pRExC_state, br, ender)) {
12099                         REQUIRE_BRANCHJ(flagp, 0);
12100                     }
12101                     if (lastbr) {
12102                         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12103                             REQUIRE_BRANCHJ(flagp, 0);
12104                         }
12105                         if (! REGTAIL(pRExC_state,
12106                                       REGNODE_OFFSET(
12107                                                  NEXTOPER(
12108                                                  NEXTOPER(REGNODE_p(lastbr)))),
12109                                       ender))
12110                         {
12111                             REQUIRE_BRANCHJ(flagp, 0);
12112                         }
12113                     }
12114                     else
12115                         if (! REGTAIL(pRExC_state, ret, ender)) {
12116                             REQUIRE_BRANCHJ(flagp, 0);
12117                         }
12118 #if 0  /* Removing this doesn't cause failures in the test suite -- khw */
12119                     RExC_size++; /* XXX WHY do we need this?!!
12120                                     For large programs it seems to be required
12121                                     but I can't figure out why. -- dmq*/
12122 #endif
12123                     return ret;
12124                 }
12125                 RExC_parse += UTF
12126                               ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
12127                               : 1;
12128                 vFAIL("Unknown switch condition (?(...))");
12129             }
12130             case '[':           /* (?[ ... ]) */
12131                 return handle_regex_sets(pRExC_state, NULL, flagp, depth+1,
12132                                          oregcomp_parse);
12133             case 0: /* A NUL */
12134                 RExC_parse--; /* for vFAIL to print correctly */
12135                 vFAIL("Sequence (? incomplete");
12136                 break;
12137
12138             case ')':
12139                 if (RExC_strict) {  /* [perl #132851] */
12140                     ckWARNreg(RExC_parse, "Empty (?) without any modifiers");
12141                 }
12142                 /* FALLTHROUGH */
12143             case '*': /* If you want to support (?*...), first reconcile with GH #17363 */
12144             /* FALLTHROUGH */
12145             default: /* e.g., (?i) */
12146                 RExC_parse = (char *) seqstart + 1;
12147               parse_flags:
12148                 parse_lparen_question_flags(pRExC_state);
12149                 if (UCHARAT(RExC_parse) != ':') {
12150                     if (RExC_parse < RExC_end)
12151                         nextchar(pRExC_state);
12152                     *flagp = TRYAGAIN;
12153                     return 0;
12154                 }
12155                 paren = ':';
12156                 nextchar(pRExC_state);
12157                 ret = 0;
12158                 goto parse_rest;
12159             } /* end switch */
12160         }
12161         else if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
12162           capturing_parens:
12163             parno = RExC_npar;
12164             RExC_npar++;
12165             if (! ALL_PARENS_COUNTED) {
12166                 /* If we are in our first pass through (and maybe only pass),
12167                  * we  need to allocate memory for the capturing parentheses
12168                  * data structures.
12169                  */
12170
12171                 if (!RExC_parens_buf_size) {
12172                     /* first guess at number of parens we might encounter */
12173                     RExC_parens_buf_size = 10;
12174
12175                     /* setup RExC_open_parens, which holds the address of each
12176                      * OPEN tag, and to make things simpler for the 0 index the
12177                      * start of the program - this is used later for offsets */
12178                     Newxz(RExC_open_parens, RExC_parens_buf_size,
12179                             regnode_offset);
12180                     RExC_open_parens[0] = 1;    /* +1 for REG_MAGIC */
12181
12182                     /* setup RExC_close_parens, which holds the address of each
12183                      * CLOSE tag, and to make things simpler for the 0 index
12184                      * the end of the program - this is used later for offsets
12185                      * */
12186                     Newxz(RExC_close_parens, RExC_parens_buf_size,
12187                             regnode_offset);
12188                     /* we dont know where end op starts yet, so we dont need to
12189                      * set RExC_close_parens[0] like we do RExC_open_parens[0]
12190                      * above */
12191                 }
12192                 else if (RExC_npar > RExC_parens_buf_size) {
12193                     I32 old_size = RExC_parens_buf_size;
12194
12195                     RExC_parens_buf_size *= 2;
12196
12197                     Renew(RExC_open_parens, RExC_parens_buf_size,
12198                             regnode_offset);
12199                     Zero(RExC_open_parens + old_size,
12200                             RExC_parens_buf_size - old_size, regnode_offset);
12201
12202                     Renew(RExC_close_parens, RExC_parens_buf_size,
12203                             regnode_offset);
12204                     Zero(RExC_close_parens + old_size,
12205                             RExC_parens_buf_size - old_size, regnode_offset);
12206                 }
12207             }
12208
12209             ret = reganode(pRExC_state, OPEN, parno);
12210             if (!RExC_nestroot)
12211                 RExC_nestroot = parno;
12212             if (RExC_open_parens && !RExC_open_parens[parno])
12213             {
12214                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12215                     "%*s%*s Setting open paren #%" IVdf " to %zu\n",
12216                     22, "|    |", (int)(depth * 2 + 1), "",
12217                     (IV)parno, ret));
12218                 RExC_open_parens[parno]= ret;
12219             }
12220
12221             Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
12222             Set_Node_Offset(REGNODE_p(ret), RExC_parse); /* MJD */
12223             is_open = 1;
12224         } else {
12225             /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
12226             paren = ':';
12227             ret = 0;
12228         }
12229     }
12230     else                        /* ! paren */
12231         ret = 0;
12232
12233    parse_rest:
12234     /* Pick up the branches, linking them together. */
12235     parse_start = RExC_parse;   /* MJD */
12236     br = regbranch(pRExC_state, &flags, 1, depth+1);
12237
12238     /*     branch_len = (paren != 0); */
12239
12240     if (br == 0) {
12241         RETURN_FAIL_ON_RESTART(flags, flagp);
12242         FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12243     }
12244     if (*RExC_parse == '|') {
12245         if (RExC_use_BRANCHJ) {
12246             reginsert(pRExC_state, BRANCHJ, br, depth+1);
12247         }
12248         else {                  /* MJD */
12249             reginsert(pRExC_state, BRANCH, br, depth+1);
12250             Set_Node_Length(REGNODE_p(br), paren != 0);
12251             Set_Node_Offset_To_R(br, parse_start-RExC_start);
12252         }
12253         have_branch = 1;
12254     }
12255     else if (paren == ':') {
12256         *flagp |= flags&SIMPLE;
12257     }
12258     if (is_open) {                              /* Starts with OPEN. */
12259         if (! REGTAIL(pRExC_state, ret, br)) {  /* OPEN -> first. */
12260             REQUIRE_BRANCHJ(flagp, 0);
12261         }
12262     }
12263     else if (paren != '?')              /* Not Conditional */
12264         ret = br;
12265     *flagp |= flags & (HASWIDTH | POSTPONED);
12266     lastbr = br;
12267     while (*RExC_parse == '|') {
12268         if (RExC_use_BRANCHJ) {
12269             bool shut_gcc_up;
12270
12271             ender = reganode(pRExC_state, LONGJMP, 0);
12272
12273             /* Append to the previous. */
12274             shut_gcc_up = REGTAIL(pRExC_state,
12275                          REGNODE_OFFSET(NEXTOPER(NEXTOPER(REGNODE_p(lastbr)))),
12276                          ender);
12277             PERL_UNUSED_VAR(shut_gcc_up);
12278         }
12279         nextchar(pRExC_state);
12280         if (freeze_paren) {
12281             if (RExC_npar > after_freeze)
12282                 after_freeze = RExC_npar;
12283             RExC_npar = freeze_paren;
12284         }
12285         br = regbranch(pRExC_state, &flags, 0, depth+1);
12286
12287         if (br == 0) {
12288             RETURN_FAIL_ON_RESTART(flags, flagp);
12289             FAIL2("panic: regbranch returned failure, flags=%#" UVxf, (UV) flags);
12290         }
12291         if (!  REGTAIL(pRExC_state, lastbr, br)) {  /* BRANCH -> BRANCH. */
12292             REQUIRE_BRANCHJ(flagp, 0);
12293         }
12294         lastbr = br;
12295         *flagp |= flags & (HASWIDTH | POSTPONED);
12296     }
12297
12298     if (have_branch || paren != ':') {
12299         regnode * br;
12300
12301         /* Make a closing node, and hook it on the end. */
12302         switch (paren) {
12303         case ':':
12304             ender = reg_node(pRExC_state, TAIL);
12305             break;
12306         case 1: case 2:
12307             ender = reganode(pRExC_state, CLOSE, parno);
12308             if ( RExC_close_parens ) {
12309                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12310                         "%*s%*s Setting close paren #%" IVdf " to %zu\n",
12311                         22, "|    |", (int)(depth * 2 + 1), "",
12312                         (IV)parno, ender));
12313                 RExC_close_parens[parno]= ender;
12314                 if (RExC_nestroot == parno)
12315                     RExC_nestroot = 0;
12316             }
12317             Set_Node_Offset(REGNODE_p(ender), RExC_parse+1); /* MJD */
12318             Set_Node_Length(REGNODE_p(ender), 1); /* MJD */
12319             break;
12320         case 's':
12321             ender = reg_node(pRExC_state, SRCLOSE);
12322             RExC_in_script_run = 0;
12323             break;
12324         case '<':
12325         case 'a':
12326         case 'A':
12327         case 'b':
12328         case 'B':
12329         case ',':
12330         case '=':
12331         case '!':
12332             *flagp &= ~HASWIDTH;
12333             /* FALLTHROUGH */
12334         case 't':   /* aTomic */
12335         case '>':
12336             ender = reg_node(pRExC_state, SUCCEED);
12337             break;
12338         case 0:
12339             ender = reg_node(pRExC_state, END);
12340             assert(!RExC_end_op); /* there can only be one! */
12341             RExC_end_op = REGNODE_p(ender);
12342             if (RExC_close_parens) {
12343                 DEBUG_OPTIMISE_MORE_r(Perl_re_printf( aTHX_
12344                     "%*s%*s Setting close paren #0 (END) to %zu\n",
12345                     22, "|    |", (int)(depth * 2 + 1), "",
12346                     ender));
12347
12348                 RExC_close_parens[0]= ender;
12349             }
12350             break;
12351         }
12352         DEBUG_PARSE_r({
12353             DEBUG_PARSE_MSG("lsbr");
12354             regprop(RExC_rx, RExC_mysv1, REGNODE_p(lastbr), NULL, pRExC_state);
12355             regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender), NULL, pRExC_state);
12356             Perl_re_printf( aTHX_  "~ tying lastbr %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12357                           SvPV_nolen_const(RExC_mysv1),
12358                           (IV)lastbr,
12359                           SvPV_nolen_const(RExC_mysv2),
12360                           (IV)ender,
12361                           (IV)(ender - lastbr)
12362             );
12363         });
12364         if (! REGTAIL(pRExC_state, lastbr, ender)) {
12365             REQUIRE_BRANCHJ(flagp, 0);
12366         }
12367
12368         if (have_branch) {
12369             char is_nothing= 1;
12370             if (depth==1)
12371                 RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
12372
12373             /* Hook the tails of the branches to the closing node. */
12374             for (br = REGNODE_p(ret); br; br = regnext(br)) {
12375                 const U8 op = PL_regkind[OP(br)];
12376                 if (op == BRANCH) {
12377                     if (! REGTAIL_STUDY(pRExC_state,
12378                                         REGNODE_OFFSET(NEXTOPER(br)),
12379                                         ender))
12380                     {
12381                         REQUIRE_BRANCHJ(flagp, 0);
12382                     }
12383                     if ( OP(NEXTOPER(br)) != NOTHING
12384                          || regnext(NEXTOPER(br)) != REGNODE_p(ender))
12385                         is_nothing= 0;
12386                 }
12387                 else if (op == BRANCHJ) {
12388                     bool shut_gcc_up = REGTAIL_STUDY(pRExC_state,
12389                                         REGNODE_OFFSET(NEXTOPER(NEXTOPER(br))),
12390                                         ender);
12391                     PERL_UNUSED_VAR(shut_gcc_up);
12392                     /* for now we always disable this optimisation * /
12393                     if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
12394                          || regnext(NEXTOPER(NEXTOPER(br))) != REGNODE_p(ender))
12395                     */
12396                         is_nothing= 0;
12397                 }
12398             }
12399             if (is_nothing) {
12400                 regnode * ret_as_regnode = REGNODE_p(ret);
12401                 br= PL_regkind[OP(ret_as_regnode)] != BRANCH
12402                                ? regnext(ret_as_regnode)
12403                                : ret_as_regnode;
12404                 DEBUG_PARSE_r({
12405                     DEBUG_PARSE_MSG("NADA");
12406                     regprop(RExC_rx, RExC_mysv1, ret_as_regnode,
12407                                      NULL, pRExC_state);
12408                     regprop(RExC_rx, RExC_mysv2, REGNODE_p(ender),
12409                                      NULL, pRExC_state);
12410                     Perl_re_printf( aTHX_  "~ converting ret %s (%" IVdf ") to ender %s (%" IVdf ") offset %" IVdf "\n",
12411                                   SvPV_nolen_const(RExC_mysv1),
12412                                   (IV)REG_NODE_NUM(ret_as_regnode),
12413                                   SvPV_nolen_const(RExC_mysv2),
12414                                   (IV)ender,
12415                                   (IV)(ender - ret)
12416                     );
12417                 });
12418                 OP(br)= NOTHING;
12419                 if (OP(REGNODE_p(ender)) == TAIL) {
12420                     NEXT_OFF(br)= 0;
12421                     RExC_emit= REGNODE_OFFSET(br) + 1;
12422                 } else {
12423                     regnode *opt;
12424                     for ( opt= br + 1; opt < REGNODE_p(ender) ; opt++ )
12425                         OP(opt)= OPTIMIZED;
12426                     NEXT_OFF(br)= REGNODE_p(ender) - br;
12427                 }
12428             }
12429         }
12430     }
12431
12432     {
12433         const char *p;
12434          /* Even/odd or x=don't care: 010101x10x */
12435         static const char parens[] = "=!aA<,>Bbt";
12436          /* flag below is set to 0 up through 'A'; 1 for larger */
12437
12438         if (paren && (p = strchr(parens, paren))) {
12439             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
12440             int flag = (p - parens) > 3;
12441
12442             if (paren == '>' || paren == 't') {
12443                 node = SUSPEND, flag = 0;
12444             }
12445
12446             reginsert(pRExC_state, node, ret, depth+1);
12447             Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12448             Set_Node_Offset(REGNODE_p(ret), parse_start + 1);
12449             FLAGS(REGNODE_p(ret)) = flag;
12450             if (! REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL)))
12451             {
12452                 REQUIRE_BRANCHJ(flagp, 0);
12453             }
12454         }
12455     }
12456
12457     /* Check for proper termination. */
12458     if (paren) {
12459         /* restore original flags, but keep (?p) and, if we've encountered
12460          * something in the parse that changes /d rules into /u, keep the /u */
12461         RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
12462         if (DEPENDS_SEMANTICS && toUSE_UNI_CHARSET_NOT_DEPENDS) {
12463             set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
12464         }
12465         if (RExC_parse >= RExC_end || UCHARAT(RExC_parse) != ')') {
12466             RExC_parse = oregcomp_parse;
12467             vFAIL("Unmatched (");
12468         }
12469         nextchar(pRExC_state);
12470     }
12471     else if (!paren && RExC_parse < RExC_end) {
12472         if (*RExC_parse == ')') {
12473             RExC_parse++;
12474             vFAIL("Unmatched )");
12475         }
12476         else
12477             FAIL("Junk on end of regexp");      /* "Can't happen". */
12478         NOT_REACHED; /* NOTREACHED */
12479     }
12480
12481     if (after_freeze > RExC_npar)
12482         RExC_npar = after_freeze;
12483
12484     RExC_in_lookaround = was_in_lookaround;
12485     
12486     return(ret);
12487 }
12488
12489 /*
12490  - regbranch - one alternative of an | operator
12491  *
12492  * Implements the concatenation operator.
12493  *
12494  * On success, returns the offset at which any next node should be placed into
12495  * the regex engine program being compiled.
12496  *
12497  * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
12498  * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
12499  * UTF-8
12500  */
12501 STATIC regnode_offset
12502 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
12503 {
12504     regnode_offset ret;
12505     regnode_offset chain = 0;
12506     regnode_offset latest;
12507     I32 flags = 0, c = 0;
12508     DECLARE_AND_GET_RE_DEBUG_FLAGS;
12509
12510     PERL_ARGS_ASSERT_REGBRANCH;
12511
12512     DEBUG_PARSE("brnc");
12513
12514     if (first)
12515         ret = 0;
12516     else {
12517         if (RExC_use_BRANCHJ)
12518             ret = reganode(pRExC_state, BRANCHJ, 0);
12519         else {
12520             ret = reg_node(pRExC_state, BRANCH);
12521             Set_Node_Length(REGNODE_p(ret), 1);
12522         }
12523     }
12524
12525     *flagp = 0;                 /* Initialize. */
12526
12527     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
12528                             FALSE /* Don't force to /x */ );
12529     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
12530         flags &= ~TRYAGAIN;
12531         latest = regpiece(pRExC_state, &flags, depth+1);
12532         if (latest == 0) {
12533             if (flags & TRYAGAIN)
12534                 continue;
12535             RETURN_FAIL_ON_RESTART(flags, flagp);
12536             FAIL2("panic: regpiece returned failure, flags=%#" UVxf, (UV) flags);
12537         }
12538         else if (ret == 0)
12539             ret = latest;
12540         *flagp |= flags&(HASWIDTH|POSTPONED);
12541         if (chain != 0) {
12542             /* FIXME adding one for every branch after the first is probably
12543              * excessive now we have TRIE support. (hv) */
12544             MARK_NAUGHTY(1);
12545             if (! REGTAIL(pRExC_state, chain, latest)) {
12546                 /* XXX We could just redo this branch, but figuring out what
12547                  * bookkeeping needs to be reset is a pain, and it's likely
12548                  * that other branches that goto END will also be too large */
12549                 REQUIRE_BRANCHJ(flagp, 0);
12550             }
12551         }
12552         chain = latest;
12553         c++;
12554     }
12555     if (chain == 0) {   /* Loop ran zero times. */
12556         chain = reg_node(pRExC_state, NOTHING);
12557         if (ret == 0)
12558             ret = chain;
12559     }
12560     if (c == 1) {
12561         *flagp |= flags&SIMPLE;
12562     }
12563
12564     return ret;
12565 }
12566
12567 #define RBRACE  0
12568 #define MIN_S   1
12569 #define MIN_E   2
12570 #define MAX_S   3
12571 #define MAX_E   4
12572
12573 #ifndef PERL_IN_XSUB_RE
12574 bool
12575 Perl_regcurly(const char *s, const char *e, const char * result[5])
12576 {
12577     /* This function matches a {m,n} quantifier.  When called with a NULL final
12578      * argument, it simply parses the input from 's' up through 'e-1', and
12579      * returns a boolean as to whether or not this input is syntactically a
12580      * {m,n} quantifier.
12581      *
12582      * When called with a non-NULL final parameter, and when the function
12583      * returns TRUE, it additionally stores information into the array
12584      * specified by that parameter about what it found in the parse.  The
12585      * parameter must be a pointer into a 5 element array of 'const char *'
12586      * elements.  The returned information is as follows:
12587      *   result[RBRACE]  points to the closing brace
12588      *   result[MIN_S]   points to the first byte of the lower bound
12589      *   result[MIN_E]   points to one beyond the final byte of the lower bound
12590      *   result[MAX_S]   points to the first byte of the upper bound
12591      *   result[MAX_E]   points to one beyond the final byte of the upper bound
12592      *
12593      * If the quantifier is of the form {m,} (meaning an infinite upper
12594      * bound), result[MAX_E] is set to result[MAX_S]; what they actually point
12595      * to is irrelevant, just that it's the same place
12596      *
12597      * If instead the quantifier is of the form {m} there is actually only
12598      * one bound, and both the upper and lower result[] elements are set to
12599      * point to it.
12600      *
12601      * This function checks only for syntactic validity; it leaves checking for
12602      * semantic validity and raising any diagnostics to the caller.  This
12603      * function is called in multiple places to check for syntax, but only from
12604      * one for semantics.  It makes it as simple as possible for the
12605      * syntax-only callers, while furnishing just enough information for the
12606      * semantic caller.
12607      */
12608
12609     const char * min_start = NULL;
12610     const char * max_start = NULL;
12611     const char * min_end = NULL;
12612     const char * max_end = NULL;
12613
12614     bool has_comma = FALSE;
12615
12616     PERL_ARGS_ASSERT_REGCURLY;
12617
12618     if (s >= e || *s++ != '{')
12619         return FALSE;
12620
12621     while (s < e && isBLANK(*s)) {
12622         s++;
12623     }
12624
12625     if isDIGIT(*s) {
12626         min_start = s;
12627         do {
12628             s++;
12629         } while (s < e && isDIGIT(*s));
12630         min_end = s;
12631     }
12632
12633     while (s < e && isBLANK(*s)) {
12634         s++;
12635     }
12636
12637     if (*s == ',') {
12638         has_comma = TRUE;
12639         s++;
12640
12641         while (s < e && isBLANK(*s)) {
12642             s++;
12643         }
12644
12645         if isDIGIT(*s) {
12646             max_start = s;
12647             do {
12648                 s++;
12649             } while (s < e && isDIGIT(*s));
12650             max_end = s;
12651         }
12652     }
12653
12654     while (s < e && isBLANK(*s)) {
12655         s++;
12656     }
12657                                /* Need at least one number */
12658     if (s >= e || *s != '}' || (! min_start && ! max_end)) {
12659         return FALSE;
12660     }
12661
12662     if (result) {
12663
12664         result[RBRACE] = s;
12665
12666         result[MIN_S] = min_start;
12667         result[MIN_E] = min_end;
12668         if (has_comma) {
12669             if (max_start) {
12670                 result[MAX_S] = max_start;
12671                 result[MAX_E] = max_end;
12672             }
12673             else {
12674                 /* Having no value after the comma is signalled by setting
12675                  * start and end to the same value.  What that value is isn't
12676                  * relevant; NULL is chosen simply because it will fail if the
12677                  * caller mistakenly uses it */
12678                 result[MAX_S] = result[MAX_E] = NULL;
12679             }
12680         }
12681         else {  /* No comma means lower and upper bounds are the same */
12682             result[MAX_S] = min_start;
12683             result[MAX_E] = min_end;
12684         }
12685     }
12686
12687     return TRUE;
12688 }
12689 #endif
12690
12691 U32
12692 S_get_quantifier_value(pTHX_ RExC_state_t *pRExC_state,
12693                        const char * start, const char * end)
12694 {
12695     /* This is a helper function for regpiece() to compute, given the
12696      * quantifier {m,n}, the value of either m or n, based on the starting
12697      * position 'start' in the string, through the byte 'end-1', returning it
12698      * if valid, and failing appropriately if not.  It knows the restrictions
12699      * imposed on quantifier values */
12700
12701     UV uv;
12702     STATIC_ASSERT_DECL(REG_INFTY <= U32_MAX);
12703
12704     PERL_ARGS_ASSERT_GET_QUANTIFIER_VALUE;
12705
12706     if (grok_atoUV(start, &uv, &end)) {
12707         if (uv < REG_INFTY) {   /* A valid, small-enough number */
12708             return (U32) uv;
12709         }
12710     }
12711     else if (*start == '0') { /* grok_atoUV() fails for only two reasons:
12712                                  leading zeros or overflow */
12713         RExC_parse = (char * ) end;
12714
12715         /* Perhaps too generic a msg for what is only failure from having
12716          * leading zeros, but this is how it's always behaved. */
12717         vFAIL("Invalid quantifier in {,}");
12718         NOT_REACHED; /*NOTREACHED*/
12719     }
12720
12721     /* Here, found a quantifier, but was too large; either it overflowed or was
12722      * too big a legal number */
12723     RExC_parse = (char * ) end;
12724     vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
12725
12726     NOT_REACHED; /*NOTREACHED*/
12727     return U32_MAX; /* Perhaps some compilers will be expecting a return */
12728 }
12729
12730 /*
12731  - regpiece - something followed by possible quantifier * + ? {n,m}
12732  *
12733  * Note that the branching code sequences used for ? and the general cases
12734  * of * and + are somewhat optimized:  they use the same NOTHING node as
12735  * both the endmarker for their branch list and the body of the last branch.
12736  * It might seem that this node could be dispensed with entirely, but the
12737  * endmarker role is not redundant.
12738  *
12739  * On success, returns the offset at which any next node should be placed into
12740  * the regex engine program being compiled.
12741  *
12742  * Returns 0 otherwise, with *flagp set to indicate why:
12743  *  TRYAGAIN        if regatom() returns 0 with TRYAGAIN.
12744  *  RESTART_PARSE   if the parse needs to be restarted, or'd with
12745  *                  NEED_UTF8 if the pattern needs to be upgraded to UTF-8.
12746  */
12747 STATIC regnode_offset
12748 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
12749 {
12750     regnode_offset ret;
12751     char op;
12752     I32 flags;
12753     const char * const origparse = RExC_parse;
12754     I32 min;
12755     I32 max = REG_INFTY;
12756 #ifdef RE_TRACK_PATTERN_OFFSETS
12757     char *parse_start;
12758 #endif
12759
12760     /* Save the original in case we change the emitted regop to a FAIL. */
12761     const regnode_offset orig_emit = RExC_emit;
12762
12763     DECLARE_AND_GET_RE_DEBUG_FLAGS;
12764
12765     PERL_ARGS_ASSERT_REGPIECE;
12766
12767     DEBUG_PARSE("piec");
12768
12769     ret = regatom(pRExC_state, &flags, depth+1);
12770     if (ret == 0) {
12771         RETURN_FAIL_ON_RESTART_OR_FLAGS(flags, flagp, TRYAGAIN);
12772         FAIL2("panic: regatom returned failure, flags=%#" UVxf, (UV) flags);
12773     }
12774
12775 #ifdef RE_TRACK_PATTERN_OFFSETS
12776     parse_start = RExC_parse;
12777 #endif
12778
12779     op = *RExC_parse;
12780     switch (op) {
12781         const char * regcurly_return[5];
12782
12783       case '*':
12784         nextchar(pRExC_state);
12785         min = 0;
12786         break;
12787
12788       case '+':
12789         nextchar(pRExC_state);
12790         min = 1;
12791         break;
12792
12793       case '?':
12794         nextchar(pRExC_state);
12795         min = 0; max = 1;
12796         break;
12797
12798       case '{':  /* A '{' may or may not indicate a quantifier; call regcurly()
12799                     to determine which */
12800         if (regcurly(RExC_parse, RExC_end, regcurly_return)) {
12801             const char * min_start = regcurly_return[MIN_S];
12802             const char * min_end   = regcurly_return[MIN_E];
12803             const char * max_start = regcurly_return[MAX_S];
12804             const char * max_end   = regcurly_return[MAX_E];
12805
12806             if (min_start) {
12807                 min = get_quantifier_value(pRExC_state, min_start, min_end);
12808             }
12809             else {
12810                 min = 0;
12811             }
12812
12813             if (max_start == max_end) {     /* Was of the form {m,} */
12814                 max = REG_INFTY;
12815             }
12816             else if (max_start == min_start) {  /* Was of the form {m} */
12817                 max = min;
12818             }
12819             else {  /* Was of the form {m,n} */
12820                 assert(max_end >= max_start);
12821
12822                 max = get_quantifier_value(pRExC_state, max_start, max_end);
12823             }
12824
12825             RExC_parse = (char *) regcurly_return[RBRACE];
12826             nextchar(pRExC_state);
12827
12828             if (max < min) {    /* If can't match, warn and optimize to fail
12829                                    unconditionally */
12830                 reginsert(pRExC_state, OPFAIL, orig_emit, depth+1);
12831                 ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
12832                 NEXT_OFF(REGNODE_p(orig_emit)) =
12833                                     regarglen[OPFAIL] + NODE_STEP_REGNODE;
12834                 return ret;
12835             }
12836             else if (min == max && *RExC_parse == '?') {
12837                 ckWARN2reg(RExC_parse + 1,
12838                            "Useless use of greediness modifier '%c'",
12839                            *RExC_parse);
12840             }
12841
12842             break;
12843         } /* End of is {m,n} */
12844
12845         /* Here was a '{', but what followed it didn't form a quantifier. */
12846         /* FALLTHROUGH */
12847
12848       default:
12849         *flagp = flags;
12850         return(ret);
12851         NOT_REACHED; /*NOTREACHED*/
12852     }
12853
12854     /* Here we have a quantifier, and have calculated 'min' and 'max'.
12855      *
12856      * Check and possibly adjust a zero width operand */
12857     if (! (flags & (HASWIDTH|POSTPONED))) {
12858         if (max > REG_INFTY/3) {
12859             if (origparse[0] == '\\' && origparse[1] == 'K') {
12860                 vFAIL2utf8f(
12861                            "%" UTF8f " is forbidden - matches null string"
12862                            " many times",
12863                            UTF8fARG(UTF, (RExC_parse >= origparse
12864                                          ? RExC_parse - origparse
12865                                          : 0),
12866                            origparse));
12867             } else {
12868                 ckWARN2reg(RExC_parse,
12869                            "%" UTF8f " matches null string many times",
12870                            UTF8fARG(UTF, (RExC_parse >= origparse
12871                                          ? RExC_parse - origparse
12872                                          : 0),
12873                            origparse));
12874             }
12875         }
12876
12877         /* There's no point in trying to match something 0 length more than
12878          * once except for extra side effects, which we don't have here since
12879          * not POSTPONED */
12880         if (max > 1) {
12881             max = 1;
12882             if (min > max) {
12883                 min = max;
12884             }
12885         }
12886     }
12887
12888     /* If this is a code block pass it up */
12889     *flagp |= (flags & POSTPONED);
12890
12891     if (max > 0) {
12892         *flagp |= (flags & HASWIDTH);
12893         if (max == REG_INFTY)
12894             RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
12895     }
12896
12897     /* 'SIMPLE' operands don't require full generality */
12898     if ((flags&SIMPLE)) {
12899         if (max == REG_INFTY) {
12900             if (min == 0) {
12901                 if (UNLIKELY(RExC_pm_flags & PMf_WILDCARD)) {
12902                     goto min0_maxINF_wildcard_forbidden;
12903                 }
12904
12905                 reginsert(pRExC_state, STAR, ret, depth+1);
12906                 MARK_NAUGHTY(4);
12907                 goto done_main_op;
12908             }
12909             else if (min == 1) {
12910                 reginsert(pRExC_state, PLUS, ret, depth+1);
12911                 MARK_NAUGHTY(3);
12912                 goto done_main_op;
12913             }
12914         }
12915
12916         /* Here, SIMPLE, but not the '*' and '+' special cases */
12917
12918         MARK_NAUGHTY_EXP(2, 2);
12919         reginsert(pRExC_state, CURLY, ret, depth+1);
12920         Set_Node_Offset(REGNODE_p(ret), parse_start+1); /* MJD */
12921         Set_Node_Cur_Length(REGNODE_p(ret), parse_start);
12922     }
12923     else {  /* not SIMPLE */
12924         const regnode_offset w = reg_node(pRExC_state, WHILEM);
12925
12926         FLAGS(REGNODE_p(w)) = 0;
12927         if (!  REGTAIL(pRExC_state, ret, w)) {
12928             REQUIRE_BRANCHJ(flagp, 0);
12929         }
12930         if (RExC_use_BRANCHJ) {
12931             reginsert(pRExC_state, LONGJMP, ret, depth+1);
12932             reginsert(pRExC_state, NOTHING, ret, depth+1);
12933             NEXT_OFF(REGNODE_p(ret)) = 3;        /* Go over LONGJMP. */
12934         }
12935         reginsert(pRExC_state, CURLYX, ret, depth+1);
12936                         /* MJD hk */
12937         Set_Node_Offset(REGNODE_p(ret), parse_start+1);
12938         Set_Node_Length(REGNODE_p(ret),
12939                         op == '{' ? (RExC_parse - parse_start) : 1);
12940
12941         if (RExC_use_BRANCHJ)
12942             NEXT_OFF(REGNODE_p(ret)) = 3;   /* Go over NOTHING to
12943                                                LONGJMP. */
12944         if (! REGTAIL(pRExC_state, ret, reg_node(pRExC_state,
12945                                                   NOTHING)))
12946         {
12947             REQUIRE_BRANCHJ(flagp, 0);
12948         }
12949         RExC_whilem_seen++;
12950         MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
12951     }
12952
12953     /* Finish up the CURLY/CURLYX case */
12954     FLAGS(REGNODE_p(ret)) = 0;
12955
12956     ARG1_SET(REGNODE_p(ret), (U16)min);
12957     ARG2_SET(REGNODE_p(ret), (U16)max);
12958
12959   done_main_op:
12960
12961     /* Process any greediness modifiers */
12962     if (*RExC_parse == '?') {
12963         nextchar(pRExC_state);
12964         reginsert(pRExC_state, MINMOD, ret, depth+1);
12965         if (! REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE)) {
12966             REQUIRE_BRANCHJ(flagp, 0);
12967         }
12968     }
12969     else if (*RExC_parse == '+') {
12970         regnode_offset ender;
12971         nextchar(pRExC_state);
12972         ender = reg_node(pRExC_state, SUCCEED);
12973         if (! REGTAIL(pRExC_state, ret, ender)) {
12974             REQUIRE_BRANCHJ(flagp, 0);
12975         }
12976         reginsert(pRExC_state, SUSPEND, ret, depth+1);
12977         ender = reg_node(pRExC_state, TAIL);
12978         if (! REGTAIL(pRExC_state, ret, ender)) {
12979             REQUIRE_BRANCHJ(flagp, 0);
12980         }
12981     }
12982
12983     /* Forbid extra quantifiers */
12984     if (isQUANTIFIER(RExC_parse, RExC_end)) {
12985         RExC_parse++;
12986         vFAIL("Nested quantifiers");
12987     }
12988
12989     return(ret);
12990
12991   min0_maxINF_wildcard_forbidden:
12992
12993     /* Here we are in a wildcard match, and the minimum match length is 0, and
12994      * the max could be infinity.  This is currently forbidden.  The only
12995      * reason is to make it harder to write patterns that take a long long time
12996      * to halt, and because the use of this construct isn't necessary in
12997      * matching Unicode property values */
12998     RExC_parse++;
12999     /* diag_listed_as: Use of %s is not allowed in Unicode property wildcard
13000        subpatterns in regex; marked by <-- HERE in m/%s/
13001      */
13002     vFAIL("Use of quantifier '*' is not allowed in Unicode property wildcard"
13003           " subpatterns");
13004
13005     /* Note, don't need to worry about the input being '{0,}', as a '}' isn't
13006      * legal at all in wildcards, so can't get this far */
13007
13008     NOT_REACHED; /*NOTREACHED*/
13009 }
13010
13011 STATIC bool
13012 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
13013                 regnode_offset * node_p,
13014                 UV * code_point_p,
13015                 int * cp_count,
13016                 I32 * flagp,
13017                 const bool strict,
13018                 const U32 depth
13019     )
13020 {
13021  /* This routine teases apart the various meanings of \N and returns
13022   * accordingly.  The input parameters constrain which meaning(s) is/are valid
13023   * in the current context.
13024   *
13025   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
13026   *
13027   * If <code_point_p> is not NULL, the context is expecting the result to be a
13028   * single code point.  If this \N instance turns out to a single code point,
13029   * the function returns TRUE and sets *code_point_p to that code point.
13030   *
13031   * If <node_p> is not NULL, the context is expecting the result to be one of
13032   * the things representable by a regnode.  If this \N instance turns out to be
13033   * one such, the function generates the regnode, returns TRUE and sets *node_p
13034   * to point to the offset of that regnode into the regex engine program being
13035   * compiled.
13036   *
13037   * If this instance of \N isn't legal in any context, this function will
13038   * generate a fatal error and not return.
13039   *
13040   * On input, RExC_parse should point to the first char following the \N at the
13041   * time of the call.  On successful return, RExC_parse will have been updated
13042   * to point to just after the sequence identified by this routine.  Also
13043   * *flagp has been updated as needed.
13044   *
13045   * When there is some problem with the current context and this \N instance,
13046   * the function returns FALSE, without advancing RExC_parse, nor setting
13047   * *node_p, nor *code_point_p, nor *flagp.
13048   *
13049   * If <cp_count> is not NULL, the caller wants to know the length (in code
13050   * points) that this \N sequence matches.  This is set, and the input is
13051   * parsed for errors, even if the function returns FALSE, as detailed below.
13052   *
13053   * There are 6 possibilities here, as detailed in the next 6 paragraphs.
13054   *
13055   * Probably the most common case is for the \N to specify a single code point.
13056   * *cp_count will be set to 1, and *code_point_p will be set to that code
13057   * point.
13058   *
13059   * Another possibility is for the input to be an empty \N{}.  This is no
13060   * longer accepted, and will generate a fatal error.
13061   *
13062   * Another possibility is for a custom charnames handler to be in effect which
13063   * translates the input name to an empty string.  *cp_count will be set to 0.
13064   * *node_p will be set to a generated NOTHING node.
13065   *
13066   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
13067   * set to 0. *node_p will be set to a generated REG_ANY node.
13068   *
13069   * The fifth possibility is that \N resolves to a sequence of more than one
13070   * code points.  *cp_count will be set to the number of code points in the
13071   * sequence. *node_p will be set to a generated node returned by this
13072   * function calling S_reg().
13073   *
13074   * The sixth and final possibility is that it is premature to be calling this
13075   * function; the parse needs to be restarted.  This can happen when this
13076   * changes from /d to /u rules, or when the pattern needs to be upgraded to
13077   * UTF-8.  The latter occurs only when the fifth possibility would otherwise
13078   * be in effect, and is because one of those code points requires the pattern
13079   * to be recompiled as UTF-8.  The function returns FALSE, and sets the
13080   * RESTART_PARSE and NEED_UTF8 flags in *flagp, as appropriate.  When this
13081   * happens, the caller needs to desist from continuing parsing, and return
13082   * this information to its caller.  This is not set for when there is only one
13083   * code point, as this can be called as part of an ANYOF node, and they can
13084   * store above-Latin1 code points without the pattern having to be in UTF-8.
13085   *
13086   * For non-single-quoted regexes, the tokenizer has resolved character and
13087   * sequence names inside \N{...} into their Unicode values, normalizing the
13088   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
13089   * hex-represented code points in the sequence.  This is done there because
13090   * the names can vary based on what charnames pragma is in scope at the time,
13091   * so we need a way to take a snapshot of what they resolve to at the time of
13092   * the original parse. [perl #56444].
13093   *
13094   * That parsing is skipped for single-quoted regexes, so here we may get
13095   * '\N{NAME}', which is parsed now.  If the single-quoted regex is something
13096   * like '\N{U+41}', that code point is Unicode, and has to be translated into
13097   * the native character set for non-ASCII platforms.  The other possibilities
13098   * are already native, so no translation is done. */
13099
13100     char * endbrace;    /* points to '}' following the name */
13101     char * e;           /* points to final non-blank before endbrace */
13102     char* p = RExC_parse; /* Temporary */
13103
13104     SV * substitute_parse = NULL;
13105     char *orig_end;
13106     char *save_start;
13107     I32 flags;
13108
13109     DECLARE_AND_GET_RE_DEBUG_FLAGS;
13110
13111     PERL_ARGS_ASSERT_GROK_BSLASH_N;
13112
13113     assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
13114     assert(! (node_p && cp_count));               /* At most 1 should be set */
13115
13116     if (cp_count) {     /* Initialize return for the most common case */
13117         *cp_count = 1;
13118     }
13119
13120     /* The [^\n] meaning of \N ignores spaces and comments under the /x
13121      * modifier.  The other meanings do not (except blanks adjacent to and
13122      * within the braces), so use a temporary until we find out which we are
13123      * being called with */
13124     skip_to_be_ignored_text(pRExC_state, &p,
13125                             FALSE /* Don't force to /x */ );
13126
13127     /* Disambiguate between \N meaning a named character versus \N meaning
13128      * [^\n].  The latter is assumed when the {...} following the \N is a legal
13129      * quantifier, or if there is no '{' at all */
13130     if (*p != '{' || regcurly(p, RExC_end, NULL)) {
13131         RExC_parse = p;
13132         if (cp_count) {
13133             *cp_count = -1;
13134         }
13135
13136         if (! node_p) {
13137             return FALSE;
13138         }
13139
13140         *node_p = reg_node(pRExC_state, REG_ANY);
13141         *flagp |= HASWIDTH|SIMPLE;
13142         MARK_NAUGHTY(1);
13143         Set_Node_Length(REGNODE_p(*(node_p)), 1); /* MJD */
13144         return TRUE;
13145     }
13146
13147     /* The test above made sure that the next real character is a '{', but
13148      * under the /x modifier, it could be separated by space (or a comment and
13149      * \n) and this is not allowed (for consistency with \x{...} and the
13150      * tokenizer handling of \N{NAME}). */
13151     if (*RExC_parse != '{') {
13152         vFAIL("Missing braces on \\N{}");
13153     }
13154
13155     RExC_parse++;       /* Skip past the '{' */
13156
13157     endbrace = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
13158     if (! endbrace) { /* no trailing brace */
13159         vFAIL2("Missing right brace on \\%c{}", 'N');
13160     }
13161
13162     /* Here, we have decided it should be a named character or sequence.  These
13163      * imply Unicode semantics */
13164     REQUIRE_UNI_RULES(flagp, FALSE);
13165
13166     /* \N{_} is what toke.c returns to us to indicate a name that evaluates to
13167      * nothing at all (not allowed under strict) */
13168     if (endbrace - RExC_parse == 1 && *RExC_parse == '_') {
13169         RExC_parse = endbrace;
13170         if (strict) {
13171             RExC_parse++;   /* Position after the "}" */
13172             vFAIL("Zero length \\N{}");
13173         }
13174
13175         if (cp_count) {
13176             *cp_count = 0;
13177         }
13178         nextchar(pRExC_state);
13179         if (! node_p) {
13180             return FALSE;
13181         }
13182
13183         *node_p = reg_node(pRExC_state, NOTHING);
13184         return TRUE;
13185     }
13186
13187     while (isBLANK(*RExC_parse)) {
13188         RExC_parse++;
13189     }
13190
13191     e = endbrace;
13192     while (RExC_parse < e && isBLANK(*(e-1))) {
13193         e--;
13194     }
13195
13196     if (e - RExC_parse < 2 || ! strBEGINs(RExC_parse, "U+")) {
13197
13198         /* Here, the name isn't of the form  U+....  This can happen if the
13199          * pattern is single-quoted, so didn't get evaluated in toke.c.  Now
13200          * is the time to find out what the name means */
13201
13202         const STRLEN name_len = e - RExC_parse;
13203         SV *  value_sv;     /* What does this name evaluate to */
13204         SV ** value_svp;
13205         const U8 * value;   /* string of name's value */
13206         STRLEN value_len;   /* and its length */
13207
13208         /*  RExC_unlexed_names is a hash of names that weren't evaluated by
13209          *  toke.c, and their values. Make sure is initialized */
13210         if (! RExC_unlexed_names) {
13211             RExC_unlexed_names = newHV();
13212         }
13213
13214         /* If we have already seen this name in this pattern, use that.  This
13215          * allows us to only call the charnames handler once per name per
13216          * pattern.  A broken or malicious handler could return something
13217          * different each time, which could cause the results to vary depending
13218          * on if something gets added or subtracted from the pattern that
13219          * causes the number of passes to change, for example */
13220         if ((value_svp = hv_fetch(RExC_unlexed_names, RExC_parse,
13221                                                       name_len, 0)))
13222         {
13223             value_sv = *value_svp;
13224         }
13225         else { /* Otherwise we have to go out and get the name */
13226             const char * error_msg = NULL;
13227             value_sv = get_and_check_backslash_N_name(RExC_parse, e,
13228                                                       UTF,
13229                                                       &error_msg);
13230             if (error_msg) {
13231                 RExC_parse = endbrace;
13232                 vFAIL(error_msg);
13233             }
13234
13235             /* If no error message, should have gotten a valid return */
13236             assert (value_sv);
13237
13238             /* Save the name's meaning for later use */
13239             if (! hv_store(RExC_unlexed_names, RExC_parse, name_len,
13240                            value_sv, 0))
13241             {
13242                 Perl_croak(aTHX_ "panic: hv_store() unexpectedly failed");
13243             }
13244         }
13245
13246         /* Here, we have the value the name evaluates to in 'value_sv' */
13247         value = (U8 *) SvPV(value_sv, value_len);
13248
13249         /* See if the result is one code point vs 0 or multiple */
13250         if (inRANGE(value_len, 1, ((UV) SvUTF8(value_sv)
13251                                   ? UTF8SKIP(value)
13252                                   : 1)))
13253         {
13254             /* Here, exactly one code point.  If that isn't what is wanted,
13255              * fail */
13256             if (! code_point_p) {
13257                 RExC_parse = p;
13258                 return FALSE;
13259             }
13260
13261             /* Convert from string to numeric code point */
13262             *code_point_p = (SvUTF8(value_sv))
13263                             ? valid_utf8_to_uvchr(value, NULL)
13264                             : *value;
13265
13266             /* Have parsed this entire single code point \N{...}.  *cp_count
13267              * has already been set to 1, so don't do it again. */
13268             RExC_parse = endbrace;
13269             nextchar(pRExC_state);
13270             return TRUE;
13271         } /* End of is a single code point */
13272
13273         /* Count the code points, if caller desires.  The API says to do this
13274          * even if we will later return FALSE */
13275         if (cp_count) {
13276             *cp_count = 0;
13277
13278             *cp_count = (SvUTF8(value_sv))
13279                         ? utf8_length(value, value + value_len)
13280                         : value_len;
13281         }
13282
13283         /* Fail if caller doesn't want to handle a multi-code-point sequence.
13284          * But don't back the pointer up if the caller wants to know how many
13285          * code points there are (they need to handle it themselves in this
13286          * case).  */
13287         if (! node_p) {
13288             if (! cp_count) {
13289                 RExC_parse = p;
13290             }
13291             return FALSE;
13292         }
13293
13294         /* Convert this to a sub-pattern of the form "(?: ... )", and then call
13295          * reg recursively to parse it.  That way, it retains its atomicness,
13296          * while not having to worry about any special handling that some code
13297          * points may have. */
13298
13299         substitute_parse = newSVpvs("?:");
13300         sv_catsv(substitute_parse, value_sv);
13301         sv_catpv(substitute_parse, ")");
13302
13303         /* The value should already be native, so no need to convert on EBCDIC
13304          * platforms.*/
13305         assert(! RExC_recode_x_to_native);
13306
13307     }
13308     else {   /* \N{U+...} */
13309         Size_t count = 0;   /* code point count kept internally */
13310
13311         /* We can get to here when the input is \N{U+...} or when toke.c has
13312          * converted a name to the \N{U+...} form.  This include changing a
13313          * name that evaluates to multiple code points to \N{U+c1.c2.c3 ...} */
13314
13315         RExC_parse += 2;    /* Skip past the 'U+' */
13316
13317         /* Code points are separated by dots.  The '}' terminates the whole
13318          * thing. */
13319
13320         do {    /* Loop until the ending brace */
13321             I32 flags = PERL_SCAN_SILENT_OVERFLOW
13322                       | PERL_SCAN_SILENT_ILLDIGIT
13323                       | PERL_SCAN_NOTIFY_ILLDIGIT
13324                       | PERL_SCAN_ALLOW_MEDIAL_UNDERSCORES
13325                       | PERL_SCAN_DISALLOW_PREFIX;
13326             STRLEN len = e - RExC_parse;
13327             NV overflow_value;
13328             char * start_digit = RExC_parse;
13329             UV cp = grok_hex(RExC_parse, &len, &flags, &overflow_value);
13330
13331             if (len == 0) {
13332                 RExC_parse++;
13333               bad_NU:
13334                 vFAIL("Invalid hexadecimal number in \\N{U+...}");
13335             }
13336
13337             RExC_parse += len;
13338
13339             if (cp > MAX_LEGAL_CP) {
13340                 vFAIL(form_cp_too_large_msg(16, start_digit, len, 0));
13341             }
13342
13343             if (RExC_parse >= e) { /* Got to the closing '}' */
13344                 if (count) {
13345                     goto do_concat;
13346                 }
13347
13348                 /* Here, is a single code point; fail if doesn't want that */
13349                 if (! code_point_p) {
13350                     RExC_parse = p;
13351                     return FALSE;
13352                 }
13353
13354                 /* A single code point is easy to handle; just return it */
13355                 *code_point_p = UNI_TO_NATIVE(cp);
13356                 RExC_parse = endbrace;
13357                 nextchar(pRExC_state);
13358                 return TRUE;
13359             }
13360
13361             /* Here, the parse stopped bfore the ending brace.  This is legal
13362              * only if that character is a dot separating code points, like a
13363              * multiple character sequence (of the form "\N{U+c1.c2. ... }".
13364              * So the next character must be a dot (and the one after that
13365              * can't be the ending brace, or we'd have something like
13366              * \N{U+100.} )
13367              * */
13368             if (*RExC_parse != '.' || RExC_parse + 1 >= e) {
13369                 RExC_parse += (RExC_orig_utf8)  /* point to after 1st invalid */
13370                               ? UTF8SKIP(RExC_parse)
13371                               : 1;
13372                 RExC_parse = MIN(e, RExC_parse);/* Guard against malformed utf8
13373                                                  */
13374                 goto bad_NU;
13375             }
13376
13377             /* Here, looks like its really a multiple character sequence.  Fail
13378              * if that's not what the caller wants.  But continue with counting
13379              * and error checking if they still want a count */
13380             if (! node_p && ! cp_count) {
13381                 return FALSE;
13382             }
13383
13384             /* What is done here is to convert this to a sub-pattern of the
13385              * form \x{char1}\x{char2}...  and then call reg recursively to
13386              * parse it (enclosing in "(?: ... )" ).  That way, it retains its
13387              * atomicness, while not having to worry about special handling
13388              * that some code points may have.  We don't create a subpattern,
13389              * but go through the motions of code point counting and error
13390              * checking, if the caller doesn't want a node returned. */
13391
13392             if (node_p && ! substitute_parse) {
13393                 substitute_parse = newSVpvs("?:");
13394             }
13395
13396           do_concat:
13397
13398             if (node_p) {
13399                 /* Convert to notation the rest of the code understands */
13400                 sv_catpvs(substitute_parse, "\\x{");
13401                 sv_catpvn(substitute_parse, start_digit,
13402                                             RExC_parse - start_digit);
13403                 sv_catpvs(substitute_parse, "}");
13404             }
13405
13406             /* Move to after the dot (or ending brace the final time through.)
13407              * */
13408             RExC_parse++;
13409             count++;
13410
13411         } while (RExC_parse < e);
13412
13413         if (! node_p) { /* Doesn't want the node */
13414             assert (cp_count);
13415
13416             *cp_count = count;
13417             return FALSE;
13418         }
13419
13420         sv_catpvs(substitute_parse, ")");
13421
13422         /* The values are Unicode, and therefore have to be converted to native
13423          * on a non-Unicode (meaning non-ASCII) platform. */
13424         SET_recode_x_to_native(1);
13425     }
13426
13427     /* Here, we have the string the name evaluates to, ready to be parsed,
13428      * stored in 'substitute_parse' as a series of valid "\x{...}\x{...}"
13429      * constructs.  This can be called from within a substitute parse already.
13430      * The error reporting mechanism doesn't work for 2 levels of this, but the
13431      * code above has validated this new construct, so there should be no
13432      * errors generated by the below.  And this isn' an exact copy, so the
13433      * mechanism to seamlessly deal with this won't work, so turn off warnings
13434      * during it */
13435     save_start = RExC_start;
13436     orig_end = RExC_end;
13437
13438     RExC_parse = RExC_start = SvPVX(substitute_parse);
13439     RExC_end = RExC_parse + SvCUR(substitute_parse);
13440     TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
13441
13442     *node_p = reg(pRExC_state, 1, &flags, depth+1);
13443
13444     /* Restore the saved values */
13445     RESTORE_WARNINGS;
13446     RExC_start = save_start;
13447     RExC_parse = endbrace;
13448     RExC_end = orig_end;
13449     SET_recode_x_to_native(0);
13450
13451     SvREFCNT_dec_NN(substitute_parse);
13452
13453     if (! *node_p) {
13454         RETURN_FAIL_ON_RESTART(flags, flagp);
13455         FAIL2("panic: reg returned failure to grok_bslash_N, flags=%#" UVxf,
13456             (UV) flags);
13457     }
13458     *flagp |= flags&(HASWIDTH|SIMPLE|POSTPONED);
13459
13460     nextchar(pRExC_state);
13461
13462     return TRUE;
13463 }
13464
13465
13466 STATIC U8
13467 S_compute_EXACTish(RExC_state_t *pRExC_state)
13468 {
13469     U8 op;
13470
13471     PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
13472
13473     if (! FOLD) {
13474         return (LOC)
13475                 ? EXACTL
13476                 : EXACT;
13477     }
13478
13479     op = get_regex_charset(RExC_flags);
13480     if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
13481         op--; /* /a is same as /u, and map /aa's offset to what /a's would have
13482                  been, so there is no hole */
13483     }
13484
13485     return op + EXACTF;
13486 }
13487
13488 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
13489  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
13490
13491 static I32
13492 S_backref_value(char *p, char *e)
13493 {
13494     const char* endptr = e;
13495     UV val;
13496     if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
13497         return (I32)val;
13498     return I32_MAX;
13499 }
13500
13501
13502 /*
13503  - regatom - the lowest level
13504
13505    Try to identify anything special at the start of the current parse position.
13506    If there is, then handle it as required. This may involve generating a
13507    single regop, such as for an assertion; or it may involve recursing, such as
13508    to handle a () structure.
13509
13510    If the string doesn't start with something special then we gobble up
13511    as much literal text as we can.  If we encounter a quantifier, we have to
13512    back off the final literal character, as that quantifier applies to just it
13513    and not to the whole string of literals.
13514
13515    Once we have been able to handle whatever type of thing started the
13516    sequence, we return the offset into the regex engine program being compiled
13517    at which any  next regnode should be placed.
13518
13519    Returns 0, setting *flagp to TRYAGAIN if reg() returns 0 with TRYAGAIN.
13520    Returns 0, setting *flagp to RESTART_PARSE if the parse needs to be
13521    restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to UTF-8
13522    Otherwise does not return 0.
13523
13524    Note: we have to be careful with escapes, as they can be both literal
13525    and special, and in the case of \10 and friends, context determines which.
13526
13527    A summary of the code structure is:
13528
13529    switch (first_byte) {
13530         cases for each special:
13531             handle this special;
13532             break;
13533         case '\\':
13534             switch (2nd byte) {
13535                 cases for each unambiguous special:
13536                     handle this special;
13537                     break;
13538                 cases for each ambigous special/literal:
13539                     disambiguate;
13540                     if (special)  handle here
13541                     else goto defchar;
13542                 default: // unambiguously literal:
13543                     goto defchar;
13544             }
13545         default:  // is a literal char
13546             // FALL THROUGH
13547         defchar:
13548             create EXACTish node for literal;
13549             while (more input and node isn't full) {
13550                 switch (input_byte) {
13551                    cases for each special;
13552                        make sure parse pointer is set so that the next call to
13553                            regatom will see this special first
13554                        goto loopdone; // EXACTish node terminated by prev. char
13555                    default:
13556                        append char to EXACTISH node;
13557                 }
13558                 get next input byte;
13559             }
13560         loopdone:
13561    }
13562    return the generated node;
13563
13564    Specifically there are two separate switches for handling
13565    escape sequences, with the one for handling literal escapes requiring
13566    a dummy entry for all of the special escapes that are actually handled
13567    by the other.
13568
13569 */
13570
13571 STATIC regnode_offset
13572 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
13573 {
13574     regnode_offset ret = 0;
13575     I32 flags = 0;
13576     char *parse_start;
13577     U8 op;
13578     int invert = 0;
13579
13580     DECLARE_AND_GET_RE_DEBUG_FLAGS;
13581
13582     *flagp = 0;         /* Initialize. */
13583
13584     DEBUG_PARSE("atom");
13585
13586     PERL_ARGS_ASSERT_REGATOM;
13587
13588   tryagain:
13589     parse_start = RExC_parse;
13590     assert(RExC_parse < RExC_end);
13591     switch ((U8)*RExC_parse) {
13592     case '^':
13593         RExC_seen_zerolen++;
13594         nextchar(pRExC_state);
13595         if (RExC_flags & RXf_PMf_MULTILINE)
13596             ret = reg_node(pRExC_state, MBOL);
13597         else
13598             ret = reg_node(pRExC_state, SBOL);
13599         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13600         break;
13601     case '$':
13602         nextchar(pRExC_state);
13603         if (*RExC_parse)
13604             RExC_seen_zerolen++;
13605         if (RExC_flags & RXf_PMf_MULTILINE)
13606             ret = reg_node(pRExC_state, MEOL);
13607         else
13608             ret = reg_node(pRExC_state, SEOL);
13609         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13610         break;
13611     case '.':
13612         nextchar(pRExC_state);
13613         if (RExC_flags & RXf_PMf_SINGLELINE)
13614             ret = reg_node(pRExC_state, SANY);
13615         else
13616             ret = reg_node(pRExC_state, REG_ANY);
13617         *flagp |= HASWIDTH|SIMPLE;
13618         MARK_NAUGHTY(1);
13619         Set_Node_Length(REGNODE_p(ret), 1); /* MJD */
13620         break;
13621     case '[':
13622     {
13623         char * const oregcomp_parse = ++RExC_parse;
13624         ret = regclass(pRExC_state, flagp, depth+1,
13625                        FALSE, /* means parse the whole char class */
13626                        TRUE, /* allow multi-char folds */
13627                        FALSE, /* don't silence non-portable warnings. */
13628                        (bool) RExC_strict,
13629                        TRUE, /* Allow an optimized regnode result */
13630                        NULL);
13631         if (ret == 0) {
13632             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13633             FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13634                   (UV) *flagp);
13635         }
13636         if (*RExC_parse != ']') {
13637             RExC_parse = oregcomp_parse;
13638             vFAIL("Unmatched [");
13639         }
13640         nextchar(pRExC_state);
13641         Set_Node_Length(REGNODE_p(ret), RExC_parse - oregcomp_parse + 1); /* MJD */
13642         break;
13643     }
13644     case '(':
13645         nextchar(pRExC_state);
13646         ret = reg(pRExC_state, 2, &flags, depth+1);
13647         if (ret == 0) {
13648                 if (flags & TRYAGAIN) {
13649                     if (RExC_parse >= RExC_end) {
13650                          /* Make parent create an empty node if needed. */
13651                         *flagp |= TRYAGAIN;
13652                         return(0);
13653                     }
13654                     goto tryagain;
13655                 }
13656                 RETURN_FAIL_ON_RESTART(flags, flagp);
13657                 FAIL2("panic: reg returned failure to regatom, flags=%#" UVxf,
13658                                                                  (UV) flags);
13659         }
13660         *flagp |= flags&(HASWIDTH|SIMPLE|POSTPONED);
13661         break;
13662     case '|':
13663     case ')':
13664         if (flags & TRYAGAIN) {
13665             *flagp |= TRYAGAIN;
13666             return 0;
13667         }
13668         vFAIL("Internal urp");
13669                                 /* Supposed to be caught earlier. */
13670         break;
13671     case '?':
13672     case '+':
13673     case '*':
13674         RExC_parse++;
13675         vFAIL("Quantifier follows nothing");
13676         break;
13677     case '\\':
13678         /* Special Escapes
13679
13680            This switch handles escape sequences that resolve to some kind
13681            of special regop and not to literal text. Escape sequences that
13682            resolve to literal text are handled below in the switch marked
13683            "Literal Escapes".
13684
13685            Every entry in this switch *must* have a corresponding entry
13686            in the literal escape switch. However, the opposite is not
13687            required, as the default for this switch is to jump to the
13688            literal text handling code.
13689         */
13690         RExC_parse++;
13691         switch ((U8)*RExC_parse) {
13692         /* Special Escapes */
13693         case 'A':
13694             RExC_seen_zerolen++;
13695             /* Under wildcards, this is changed to match \n; should be
13696              * invisible to the user, as they have to compile under /m */
13697             if (RExC_pm_flags & PMf_WILDCARD) {
13698                 ret = reg_node(pRExC_state, MBOL);
13699             }
13700             else {
13701                 ret = reg_node(pRExC_state, SBOL);
13702                 /* SBOL is shared with /^/ so we set the flags so we can tell
13703                  * /\A/ from /^/ in split. */
13704                 FLAGS(REGNODE_p(ret)) = 1;
13705             }
13706             goto finish_meta_pat;
13707         case 'G':
13708             if (RExC_pm_flags & PMf_WILDCARD) {
13709                 RExC_parse++;
13710                 /* diag_listed_as: Use of %s is not allowed in Unicode property
13711                    wildcard subpatterns in regex; marked by <-- HERE in m/%s/
13712                  */
13713                 vFAIL("Use of '\\G' is not allowed in Unicode property"
13714                       " wildcard subpatterns");
13715             }
13716             ret = reg_node(pRExC_state, GPOS);
13717             RExC_seen |= REG_GPOS_SEEN;
13718             goto finish_meta_pat;
13719         case 'K':
13720             if (!RExC_in_lookaround) {
13721                 RExC_seen_zerolen++;
13722                 ret = reg_node(pRExC_state, KEEPS);
13723                 /* XXX:dmq : disabling in-place substitution seems to
13724                  * be necessary here to avoid cases of memory corruption, as
13725                  * with: C<$_="x" x 80; s/x\K/y/> -- rgs
13726                  */
13727                 RExC_seen |= REG_LOOKBEHIND_SEEN;
13728                 goto finish_meta_pat;
13729             }
13730             else {
13731                 ++RExC_parse; /* advance past the 'K' */
13732                 vFAIL("\\K not permitted in lookahead/lookbehind");
13733             }
13734         case 'Z':
13735             if (RExC_pm_flags & PMf_WILDCARD) {
13736                 /* See comment under \A above */
13737                 ret = reg_node(pRExC_state, MEOL);
13738             }
13739             else {
13740                 ret = reg_node(pRExC_state, SEOL);
13741             }
13742             RExC_seen_zerolen++;                /* Do not optimize RE away */
13743             goto finish_meta_pat;
13744         case 'z':
13745             if (RExC_pm_flags & PMf_WILDCARD) {
13746                 /* See comment under \A above */
13747                 ret = reg_node(pRExC_state, MEOL);
13748             }
13749             else {
13750                 ret = reg_node(pRExC_state, EOS);
13751             }
13752             RExC_seen_zerolen++;                /* Do not optimize RE away */
13753             goto finish_meta_pat;
13754         case 'C':
13755             vFAIL("\\C no longer supported");
13756         case 'X':
13757             ret = reg_node(pRExC_state, CLUMP);
13758             *flagp |= HASWIDTH;
13759             goto finish_meta_pat;
13760
13761         case 'B':
13762             invert = 1;
13763             /* FALLTHROUGH */
13764         case 'b':
13765           {
13766             U8 flags = 0;
13767             regex_charset charset = get_regex_charset(RExC_flags);
13768
13769             RExC_seen_zerolen++;
13770             RExC_seen |= REG_LOOKBEHIND_SEEN;
13771             op = BOUND + charset;
13772
13773             if (RExC_parse >= RExC_end || *(RExC_parse + 1) != '{') {
13774                 flags = TRADITIONAL_BOUND;
13775                 if (op > BOUNDA) {  /* /aa is same as /a */
13776                     op = BOUNDA;
13777                 }
13778             }
13779             else {
13780                 STRLEN length;
13781                 char name = *RExC_parse;
13782                 char * endbrace =  (char *) memchr(RExC_parse, '}',
13783                                                    RExC_end - RExC_parse);
13784                 char * e = endbrace;
13785
13786                 RExC_parse += 2;
13787
13788                 if (! endbrace) {
13789                     vFAIL2("Missing right brace on \\%c{}", name);
13790                 }
13791
13792                 while (isBLANK(*RExC_parse)) {
13793                     RExC_parse++;
13794                 }
13795
13796                 while (RExC_parse < e && isBLANK(*(e - 1))) {
13797                     e--;
13798                 }
13799
13800                 if (e == RExC_parse) {
13801                     RExC_parse = endbrace + 1;  /* After the '}' */
13802                     vFAIL2("Empty \\%c{}", name);
13803                 }
13804
13805                 length = e - RExC_parse;
13806
13807                 switch (*RExC_parse) {
13808                     case 'g':
13809                         if (    length != 1
13810                             && (memNEs(RExC_parse + 1, length - 1, "cb")))
13811                         {
13812                             goto bad_bound_type;
13813                         }
13814                         flags = GCB_BOUND;
13815                         break;
13816                     case 'l':
13817                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13818                             goto bad_bound_type;
13819                         }
13820                         flags = LB_BOUND;
13821                         break;
13822                     case 's':
13823                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13824                             goto bad_bound_type;
13825                         }
13826                         flags = SB_BOUND;
13827                         break;
13828                     case 'w':
13829                         if (length != 2 || *(RExC_parse + 1) != 'b') {
13830                             goto bad_bound_type;
13831                         }
13832                         flags = WB_BOUND;
13833                         break;
13834                     default:
13835                       bad_bound_type:
13836                         RExC_parse = e;
13837                         vFAIL2utf8f(
13838                             "'%" UTF8f "' is an unknown bound type",
13839                             UTF8fARG(UTF, length, e - length));
13840                         NOT_REACHED; /*NOTREACHED*/
13841                 }
13842                 RExC_parse = endbrace;
13843                 REQUIRE_UNI_RULES(flagp, 0);
13844
13845                 if (op == BOUND) {
13846                     op = BOUNDU;
13847                 }
13848                 else if (op >= BOUNDA) {  /* /aa is same as /a */
13849                     op = BOUNDU;
13850                     length += 4;
13851
13852                     /* Don't have to worry about UTF-8, in this message because
13853                      * to get here the contents of the \b must be ASCII */
13854                     ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
13855                               "Using /u for '%.*s' instead of /%s",
13856                               (unsigned) length,
13857                               endbrace - length + 1,
13858                               (charset == REGEX_ASCII_RESTRICTED_CHARSET)
13859                               ? ASCII_RESTRICT_PAT_MODS
13860                               : ASCII_MORE_RESTRICT_PAT_MODS);
13861                 }
13862             }
13863
13864             if (op == BOUND) {
13865                 RExC_seen_d_op = TRUE;
13866             }
13867             else if (op == BOUNDL) {
13868                 RExC_contains_locale = 1;
13869             }
13870
13871             if (invert) {
13872                 op += NBOUND - BOUND;
13873             }
13874
13875             ret = reg_node(pRExC_state, op);
13876             FLAGS(REGNODE_p(ret)) = flags;
13877
13878             goto finish_meta_pat;
13879           }
13880
13881         case 'R':
13882             ret = reg_node(pRExC_state, LNBREAK);
13883             *flagp |= HASWIDTH|SIMPLE;
13884             goto finish_meta_pat;
13885
13886         case 'd':
13887         case 'D':
13888         case 'h':
13889         case 'H':
13890         case 'p':
13891         case 'P':
13892         case 's':
13893         case 'S':
13894         case 'v':
13895         case 'V':
13896         case 'w':
13897         case 'W':
13898             /* These all have the same meaning inside [brackets], and it knows
13899              * how to do the best optimizations for them.  So, pretend we found
13900              * these within brackets, and let it do the work */
13901             RExC_parse--;
13902
13903             ret = regclass(pRExC_state, flagp, depth+1,
13904                            TRUE, /* means just parse this element */
13905                            FALSE, /* don't allow multi-char folds */
13906                            FALSE, /* don't silence non-portable warnings.  It
13907                                      would be a bug if these returned
13908                                      non-portables */
13909                            (bool) RExC_strict,
13910                            TRUE, /* Allow an optimized regnode result */
13911                            NULL);
13912             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13913             /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
13914              * multi-char folds are allowed.  */
13915             if (!ret)
13916                 FAIL2("panic: regclass returned failure to regatom, flags=%#" UVxf,
13917                       (UV) *flagp);
13918
13919             RExC_parse--;   /* regclass() leaves this one too far ahead */
13920
13921           finish_meta_pat:
13922                    /* The escapes above that don't take a parameter can't be
13923                     * followed by a '{'.  But 'pX', 'p{foo}' and
13924                     * correspondingly 'P' can be */
13925             if (   RExC_parse - parse_start == 1
13926                 && UCHARAT(RExC_parse + 1) == '{'
13927                 && UNLIKELY(! regcurly(RExC_parse + 1, RExC_end, NULL)))
13928             {
13929                 RExC_parse += 2;
13930                 vFAIL("Unescaped left brace in regex is illegal here");
13931             }
13932             Set_Node_Offset(REGNODE_p(ret), parse_start);
13933             Set_Node_Length(REGNODE_p(ret), RExC_parse - parse_start + 1); /* MJD */
13934             nextchar(pRExC_state);
13935             break;
13936         case 'N':
13937             /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
13938              * \N{...} evaluates to a sequence of more than one code points).
13939              * The function call below returns a regnode, which is our result.
13940              * The parameters cause it to fail if the \N{} evaluates to a
13941              * single code point; we handle those like any other literal.  The
13942              * reason that the multicharacter case is handled here and not as
13943              * part of the EXACtish code is because of quantifiers.  In
13944              * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
13945              * this way makes that Just Happen. dmq.
13946              * join_exact() will join this up with adjacent EXACTish nodes
13947              * later on, if appropriate. */
13948             ++RExC_parse;
13949             if (grok_bslash_N(pRExC_state,
13950                               &ret,     /* Want a regnode returned */
13951                               NULL,     /* Fail if evaluates to a single code
13952                                            point */
13953                               NULL,     /* Don't need a count of how many code
13954                                            points */
13955                               flagp,
13956                               RExC_strict,
13957                               depth)
13958             ) {
13959                 break;
13960             }
13961
13962             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
13963
13964             /* Here, evaluates to a single code point.  Go get that */
13965             RExC_parse = parse_start;
13966             goto defchar;
13967
13968         case 'k':    /* Handle \k<NAME> and \k'NAME' and \k{NAME} */
13969       parse_named_seq:  /* Also handle non-numeric \g{...} */
13970         {
13971             char ch;
13972             if (   RExC_parse >= RExC_end - 1
13973                 || ((   ch = RExC_parse[1]) != '<'
13974                                       && ch != '\''
13975                                       && ch != '{'))
13976             {
13977                 RExC_parse++;
13978                 /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
13979                 vFAIL2("Sequence %.2s... not terminated", parse_start);
13980             } else {
13981                 RExC_parse += 2;
13982                 if (ch == '{') {
13983                     while (isBLANK(*RExC_parse)) {
13984                         RExC_parse++;
13985                     }
13986                 }
13987                 ret = handle_named_backref(pRExC_state,
13988                                            flagp,
13989                                            parse_start,
13990                                            (ch == '<')
13991                                            ? '>'
13992                                            : (ch == '{')
13993                                              ? '}'
13994                                              : '\'');
13995             }
13996             break;
13997         }
13998         case 'g':
13999         case '1': case '2': case '3': case '4':
14000         case '5': case '6': case '7': case '8': case '9':
14001             {
14002                 I32 num;
14003                 char * endbrace = NULL;
14004                 char * s = RExC_parse;
14005                 char * e = RExC_end;
14006
14007                 if (*s == 'g') {
14008                     bool isrel = 0;
14009
14010                     s++;
14011                     if (*s == '{') {
14012                         endbrace = (char *) memchr(s, '}', RExC_end - s);
14013                         if (! endbrace ) {
14014
14015                             /* Missing '}'.  Position after the number to give
14016                              * a better indication to the user of where the
14017                              * problem is. */
14018                             s++;
14019                             if (*s == '-') {
14020                                 s++;
14021                             }
14022
14023                             /* If it looks to be a name and not a number, go
14024                              * handle it there */
14025                             if (! isDIGIT(*s)) {
14026                                 goto parse_named_seq;
14027                             }
14028
14029                             do {
14030                                 s++;
14031                             } while isDIGIT(*s);
14032
14033                             RExC_parse = s;
14034                             vFAIL("Unterminated \\g{...} pattern");
14035                         }
14036
14037                         s++;    /* Past the '{' */
14038
14039                         while (isBLANK(*s)) {
14040                             s++;
14041                         }
14042
14043                         /* Ignore trailing blanks */
14044                         e = endbrace;
14045                         while (s < e && isBLANK(*(e - 1))) {
14046                             e--;
14047                         }
14048                     }
14049
14050                     /* Here, have isolated the meat of the construct from any
14051                      * surrounding braces */
14052
14053                     if (*s == '-') {
14054                         isrel = 1;
14055                         s++;
14056                     }
14057
14058                     if (endbrace && !isDIGIT(*s)) {
14059                         goto parse_named_seq;
14060                     }
14061
14062                     RExC_parse = s;
14063                     num = S_backref_value(RExC_parse, RExC_end);
14064                     if (num == 0)
14065                         vFAIL("Reference to invalid group 0");
14066                     else if (num == I32_MAX) {
14067                          if (isDIGIT(*RExC_parse))
14068                             vFAIL("Reference to nonexistent group");
14069                         else
14070                             vFAIL("Unterminated \\g... pattern");
14071                     }
14072
14073                     if (isrel) {
14074                         num = RExC_npar - num;
14075                         if (num < 1)
14076                             vFAIL("Reference to nonexistent or unclosed group");
14077                     }
14078                 }
14079                 else {
14080                     num = S_backref_value(RExC_parse, RExC_end);
14081                     /* bare \NNN might be backref or octal - if it is larger
14082                      * than or equal RExC_npar then it is assumed to be an
14083                      * octal escape. Note RExC_npar is +1 from the actual
14084                      * number of parens. */
14085                     /* Note we do NOT check if num == I32_MAX here, as that is
14086                      * handled by the RExC_npar check */
14087
14088                     if (    /* any numeric escape < 10 is always a backref */
14089                            num > 9
14090                             /* any numeric escape < RExC_npar is a backref */
14091                         && num >= RExC_npar
14092                             /* cannot be an octal escape if it starts with [89]
14093                              * */
14094                         && ! inRANGE(*RExC_parse, '8', '9')
14095                     ) {
14096                         /* Probably not meant to be a backref, instead likely
14097                          * to be an octal character escape, e.g. \35 or \777.
14098                          * The above logic should make it obvious why using
14099                          * octal escapes in patterns is problematic. - Yves */
14100                         RExC_parse = parse_start;
14101                         goto defchar;
14102                     }
14103                 }
14104
14105                 /* At this point RExC_parse points at a numeric escape like
14106                  * \12 or \88 or the digits in \g{34} or \g34 or something
14107                  * similar, which we should NOT treat as an octal escape. It
14108                  * may or may not be a valid backref escape. For instance
14109                  * \88888888 is unlikely to be a valid backref.
14110                  *
14111                  * We've already figured out what value the digits represent.
14112                  * Now, move the parse to beyond them. */
14113                 if (endbrace) {
14114                     RExC_parse = endbrace + 1;
14115                 }
14116                 else while (isDIGIT(*RExC_parse)) {
14117                     RExC_parse++;
14118                 }
14119
14120                 if (num >= (I32)RExC_npar) {
14121
14122                     /* It might be a forward reference; we can't fail until we
14123                      * know, by completing the parse to get all the groups, and
14124                      * then reparsing */
14125                     if (ALL_PARENS_COUNTED)  {
14126                         if (num >= RExC_total_parens)  {
14127                             vFAIL("Reference to nonexistent group");
14128                         }
14129                     }
14130                     else {
14131                         REQUIRE_PARENS_PASS;
14132                     }
14133                 }
14134                 RExC_sawback = 1;
14135                 ret = reganode(pRExC_state,
14136                                ((! FOLD)
14137                                  ? REF
14138                                  : (ASCII_FOLD_RESTRICTED)
14139                                    ? REFFA
14140                                    : (AT_LEAST_UNI_SEMANTICS)
14141                                      ? REFFU
14142                                      : (LOC)
14143                                        ? REFFL
14144                                        : REFF),
14145                                 num);
14146                 if (OP(REGNODE_p(ret)) == REFF) {
14147                     RExC_seen_d_op = TRUE;
14148                 }
14149                 *flagp |= HASWIDTH;
14150
14151                 /* override incorrect value set in reganode MJD */
14152                 Set_Node_Offset(REGNODE_p(ret), parse_start);
14153                 Set_Node_Cur_Length(REGNODE_p(ret), parse_start-1);
14154                 skip_to_be_ignored_text(pRExC_state, &RExC_parse,
14155                                         FALSE /* Don't force to /x */ );
14156             }
14157             break;
14158         case '\0':
14159             if (RExC_parse >= RExC_end)
14160                 FAIL("Trailing \\");
14161             /* FALLTHROUGH */
14162         default:
14163             /* Do not generate "unrecognized" warnings here, we fall
14164                back into the quick-grab loop below */
14165             RExC_parse = parse_start;
14166             goto defchar;
14167         } /* end of switch on a \foo sequence */
14168         break;
14169
14170     case '#':
14171
14172         /* '#' comments should have been spaced over before this function was
14173          * called */
14174         assert((RExC_flags & RXf_PMf_EXTENDED) == 0);
14175         /*
14176         if (RExC_flags & RXf_PMf_EXTENDED) {
14177             RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
14178             if (RExC_parse < RExC_end)
14179                 goto tryagain;
14180         }
14181         */
14182
14183         /* FALLTHROUGH */
14184
14185     default:
14186           defchar: {
14187
14188             /* Here, we have determined that the next thing is probably a
14189              * literal character.  RExC_parse points to the first byte of its
14190              * definition.  (It still may be an escape sequence that evaluates
14191              * to a single character) */
14192
14193             STRLEN len = 0;
14194             UV ender = 0;
14195             char *p;
14196             char *s, *old_s = NULL, *old_old_s = NULL;
14197             char *s0;
14198             U32 max_string_len = 255;
14199
14200             /* We may have to reparse the node, artificially stopping filling
14201              * it early, based on info gleaned in the first parse.  This
14202              * variable gives where we stop.  Make it above the normal stopping
14203              * place first time through; otherwise it would stop too early */
14204             U32 upper_fill = max_string_len + 1;
14205
14206             /* We start out as an EXACT node, even if under /i, until we find a
14207              * character which is in a fold.  The algorithm now segregates into
14208              * separate nodes, characters that fold from those that don't under
14209              * /i.  (This hopefully will create nodes that are fixed strings
14210              * even under /i, giving the optimizer something to grab on to.)
14211              * So, if a node has something in it and the next character is in
14212              * the opposite category, that node is closed up, and the function
14213              * returns.  Then regatom is called again, and a new node is
14214              * created for the new category. */
14215             U8 node_type = EXACT;
14216
14217             /* Assume the node will be fully used; the excess is given back at
14218              * the end.  Under /i, we may need to temporarily add the fold of
14219              * an extra character or two at the end to check for splitting
14220              * multi-char folds, so allocate extra space for that.   We can't
14221              * make any other length assumptions, as a byte input sequence
14222              * could shrink down. */
14223             Ptrdiff_t current_string_nodes = STR_SZ(max_string_len
14224                                                  + ((! FOLD)
14225                                                     ? 0
14226                                                     : 2 * ((UTF)
14227                                                            ? UTF8_MAXBYTES_CASE
14228                         /* Max non-UTF-8 expansion is 2 */ : 2)));
14229
14230             bool next_is_quantifier;
14231             char * oldp = NULL;
14232
14233             /* We can convert EXACTF nodes to EXACTFU if they contain only
14234              * characters that match identically regardless of the target
14235              * string's UTF8ness.  The reason to do this is that EXACTF is not
14236              * trie-able, EXACTFU is, and EXACTFU requires fewer operations at
14237              * runtime.
14238              *
14239              * Similarly, we can convert EXACTFL nodes to EXACTFLU8 if they
14240              * contain only above-Latin1 characters (hence must be in UTF8),
14241              * which don't participate in folds with Latin1-range characters,
14242              * as the latter's folds aren't known until runtime. */
14243             bool maybe_exactfu = FOLD && (DEPENDS_SEMANTICS || LOC);
14244
14245             /* Single-character EXACTish nodes are almost always SIMPLE.  This
14246              * allows us to override this as encountered */
14247             U8 maybe_SIMPLE = SIMPLE;
14248
14249             /* Does this node contain something that can't match unless the
14250              * target string is (also) in UTF-8 */
14251             bool requires_utf8_target = FALSE;
14252
14253             /* The sequence 'ss' is problematic in non-UTF-8 patterns. */
14254             bool has_ss = FALSE;
14255
14256             /* So is the MICRO SIGN */
14257             bool has_micro_sign = FALSE;
14258
14259             /* Set when we fill up the current node and there is still more
14260              * text to process */
14261             bool overflowed;
14262
14263             /* Allocate an EXACT node.  The node_type may change below to
14264              * another EXACTish node, but since the size of the node doesn't
14265              * change, it works */
14266             ret = regnode_guts(pRExC_state, node_type, current_string_nodes,
14267                                                                     "exact");
14268             FILL_NODE(ret, node_type);
14269             RExC_emit++;
14270
14271             s = STRING(REGNODE_p(ret));
14272
14273             s0 = s;
14274
14275           reparse:
14276
14277             p = RExC_parse;
14278             len = 0;
14279             s = s0;
14280             node_type = EXACT;
14281             oldp = NULL;
14282             maybe_exactfu = FOLD && (DEPENDS_SEMANTICS || LOC);
14283             maybe_SIMPLE = SIMPLE;
14284             requires_utf8_target = FALSE;
14285             has_ss = FALSE;
14286             has_micro_sign = FALSE;
14287
14288           continue_parse:
14289
14290             /* This breaks under rare circumstances.  If folding, we do not
14291              * want to split a node at a character that is a non-final in a
14292              * multi-char fold, as an input string could just happen to want to
14293              * match across the node boundary.  The code at the end of the loop
14294              * looks for this, and backs off until it finds not such a
14295              * character, but it is possible (though extremely, extremely
14296              * unlikely) for all characters in the node to be non-final fold
14297              * ones, in which case we just leave the node fully filled, and
14298              * hope that it doesn't match the string in just the wrong place */
14299
14300             assert( ! UTF     /* Is at the beginning of a character */
14301                    || UTF8_IS_INVARIANT(UCHARAT(RExC_parse))
14302                    || UTF8_IS_START(UCHARAT(RExC_parse)));
14303
14304             overflowed = FALSE;
14305
14306             /* Here, we have a literal character.  Find the maximal string of
14307              * them in the input that we can fit into a single EXACTish node.
14308              * We quit at the first non-literal or when the node gets full, or
14309              * under /i the categorization of folding/non-folding character
14310              * changes */
14311             while (p < RExC_end && len < upper_fill) {
14312
14313                 /* In most cases each iteration adds one byte to the output.
14314                  * The exceptions override this */
14315                 Size_t added_len = 1;
14316
14317                 oldp = p;
14318                 old_old_s = old_s;
14319                 old_s = s;
14320
14321                 /* White space has already been ignored */
14322                 assert(   (RExC_flags & RXf_PMf_EXTENDED) == 0
14323                        || ! is_PATWS_safe((p), RExC_end, UTF));
14324
14325                 switch ((U8)*p) {
14326                   const char* message;
14327                   U32 packed_warn;
14328                   U8 grok_c_char;
14329
14330                 case '^':
14331                 case '$':
14332                 case '.':
14333                 case '[':
14334                 case '(':
14335                 case ')':
14336                 case '|':
14337                     goto loopdone;
14338                 case '\\':
14339                     /* Literal Escapes Switch
14340
14341                        This switch is meant to handle escape sequences that
14342                        resolve to a literal character.
14343
14344                        Every escape sequence that represents something
14345                        else, like an assertion or a char class, is handled
14346                        in the switch marked 'Special Escapes' above in this
14347                        routine, but also has an entry here as anything that
14348                        isn't explicitly mentioned here will be treated as
14349                        an unescaped equivalent literal.
14350                     */
14351
14352                     switch ((U8)*++p) {
14353
14354                     /* These are all the special escapes. */
14355                     case 'A':             /* Start assertion */
14356                     case 'b': case 'B':   /* Word-boundary assertion*/
14357                     case 'C':             /* Single char !DANGEROUS! */
14358                     case 'd': case 'D':   /* digit class */
14359                     case 'g': case 'G':   /* generic-backref, pos assertion */
14360                     case 'h': case 'H':   /* HORIZWS */
14361                     case 'k': case 'K':   /* named backref, keep marker */
14362                     case 'p': case 'P':   /* Unicode property */
14363                               case 'R':   /* LNBREAK */
14364                     case 's': case 'S':   /* space class */
14365                     case 'v': case 'V':   /* VERTWS */
14366                     case 'w': case 'W':   /* word class */
14367                     case 'X':             /* eXtended Unicode "combining
14368                                              character sequence" */
14369                     case 'z': case 'Z':   /* End of line/string assertion */
14370                         --p;
14371                         goto loopdone;
14372
14373                     /* Anything after here is an escape that resolves to a
14374                        literal. (Except digits, which may or may not)
14375                      */
14376                     case 'n':
14377                         ender = '\n';
14378                         p++;
14379                         break;
14380                     case 'N': /* Handle a single-code point named character. */
14381                         RExC_parse = p + 1;
14382                         if (! grok_bslash_N(pRExC_state,
14383                                             NULL,   /* Fail if evaluates to
14384                                                        anything other than a
14385                                                        single code point */
14386                                             &ender, /* The returned single code
14387                                                        point */
14388                                             NULL,   /* Don't need a count of
14389                                                        how many code points */
14390                                             flagp,
14391                                             RExC_strict,
14392                                             depth)
14393                         ) {
14394                             if (*flagp & NEED_UTF8)
14395                                 FAIL("panic: grok_bslash_N set NEED_UTF8");
14396                             RETURN_FAIL_ON_RESTART_FLAGP(flagp);
14397
14398                             /* Here, it wasn't a single code point.  Go close
14399                              * up this EXACTish node.  The switch() prior to
14400                              * this switch handles the other cases */
14401                             RExC_parse = p = oldp;
14402                             goto loopdone;
14403                         }
14404                         p = RExC_parse;
14405                         RExC_parse = parse_start;
14406
14407                         /* The \N{} means the pattern, if previously /d,
14408                          * becomes /u.  That means it can't be an EXACTF node,
14409                          * but an EXACTFU */
14410                         if (node_type == EXACTF) {
14411                             node_type = EXACTFU;
14412
14413                             /* If the node already contains something that
14414                              * differs between EXACTF and EXACTFU, reparse it
14415                              * as EXACTFU */
14416                             if (! maybe_exactfu) {
14417                                 len = 0;
14418                                 s = s0;
14419                                 goto reparse;
14420                             }
14421                         }
14422
14423                         break;
14424                     case 'r':
14425                         ender = '\r';
14426                         p++;
14427                         break;
14428                     case 't':
14429                         ender = '\t';
14430                         p++;
14431                         break;
14432                     case 'f':
14433                         ender = '\f';
14434                         p++;
14435                         break;
14436                     case 'e':
14437                         ender = ESC_NATIVE;
14438                         p++;
14439                         break;
14440                     case 'a':
14441                         ender = '\a';
14442                         p++;
14443                         break;
14444                     case 'o':
14445                         if (! grok_bslash_o(&p,
14446                                             RExC_end,
14447                                             &ender,
14448                                             &message,
14449                                             &packed_warn,
14450                                             (bool) RExC_strict,
14451                                             FALSE, /* No illegal cp's */
14452                                             UTF))
14453                         {
14454                             RExC_parse = p; /* going to die anyway; point to
14455                                                exact spot of failure */
14456                             vFAIL(message);
14457                         }
14458
14459                         if (message && TO_OUTPUT_WARNINGS(p)) {
14460                             warn_non_literal_string(p, packed_warn, message);
14461                         }
14462                         break;
14463                     case 'x':
14464                         if (! grok_bslash_x(&p,
14465                                             RExC_end,
14466                                             &ender,
14467                                             &message,
14468                                             &packed_warn,
14469                                             (bool) RExC_strict,
14470                                             FALSE, /* No illegal cp's */
14471                                             UTF))
14472                         {
14473                             RExC_parse = p;     /* going to die anyway; point
14474                                                    to exact spot of failure */
14475                             vFAIL(message);
14476                         }
14477
14478                         if (message && TO_OUTPUT_WARNINGS(p)) {
14479                             warn_non_literal_string(p, packed_warn, message);
14480                         }
14481
14482 #ifdef EBCDIC
14483                         if (ender < 0x100) {
14484                             if (RExC_recode_x_to_native) {
14485                                 ender = LATIN1_TO_NATIVE(ender);
14486                             }
14487                         }
14488 #endif
14489                         break;
14490                     case 'c':
14491                         p++;
14492                         if (! grok_bslash_c(*p, &grok_c_char,
14493                                             &message, &packed_warn))
14494                         {
14495                             /* going to die anyway; point to exact spot of
14496                              * failure */
14497                             RExC_parse = p + ((UTF)
14498                                               ? UTF8_SAFE_SKIP(p, RExC_end)
14499                                               : 1);
14500                             vFAIL(message);
14501                         }
14502
14503                         ender = grok_c_char;
14504                         p++;
14505                         if (message && TO_OUTPUT_WARNINGS(p)) {
14506                             warn_non_literal_string(p, packed_warn, message);
14507                         }
14508
14509                         break;
14510                     case '8': case '9': /* must be a backreference */
14511                         --p;
14512                         /* we have an escape like \8 which cannot be an octal escape
14513                          * so we exit the loop, and let the outer loop handle this
14514                          * escape which may or may not be a legitimate backref. */
14515                         goto loopdone;
14516                     case '1': case '2': case '3':case '4':
14517                     case '5': case '6': case '7':
14518
14519                         /* When we parse backslash escapes there is ambiguity
14520                          * between backreferences and octal escapes. Any escape
14521                          * from \1 - \9 is a backreference, any multi-digit
14522                          * escape which does not start with 0 and which when
14523                          * evaluated as decimal could refer to an already
14524                          * parsed capture buffer is a back reference. Anything
14525                          * else is octal.
14526                          *
14527                          * Note this implies that \118 could be interpreted as
14528                          * 118 OR as "\11" . "8" depending on whether there
14529                          * were 118 capture buffers defined already in the
14530                          * pattern.  */
14531
14532                         /* NOTE, RExC_npar is 1 more than the actual number of
14533                          * parens we have seen so far, hence the "<" as opposed
14534                          * to "<=" */
14535                         if ( !isDIGIT(p[1]) || S_backref_value(p, RExC_end) < RExC_npar)
14536                         {  /* Not to be treated as an octal constant, go
14537                                    find backref */
14538                             p = oldp;
14539                             goto loopdone;
14540                         }
14541                         /* FALLTHROUGH */
14542                     case '0':
14543                         {
14544                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT
14545                                       | PERL_SCAN_NOTIFY_ILLDIGIT;
14546                             STRLEN numlen = 3;
14547                             ender = grok_oct(p, &numlen, &flags, NULL);
14548                             p += numlen;
14549                             if (  (flags & PERL_SCAN_NOTIFY_ILLDIGIT)
14550                                 && isDIGIT(*p)  /* like \08, \178 */
14551                                 && ckWARN(WARN_REGEXP))
14552                             {
14553                                 reg_warn_non_literal_string(
14554                                      p + 1,
14555                                      form_alien_digit_msg(8, numlen, p,
14556                                                         RExC_end, UTF, FALSE));
14557                             }
14558                         }
14559                         break;
14560                     case '\0':
14561                         if (p >= RExC_end)
14562                             FAIL("Trailing \\");
14563                         /* FALLTHROUGH */
14564                     default:
14565                         if (isALPHANUMERIC(*p)) {
14566                             /* An alpha followed by '{' is going to fail next
14567                              * iteration, so don't output this warning in that
14568                              * case */
14569                             if (! isALPHA(*p) || *(p + 1) != '{') {
14570                                 ckWARN2reg(p + 1, "Unrecognized escape \\%.1s"
14571                                                   " passed through", p);
14572                             }
14573                         }
14574                         goto normal_default;
14575                     } /* End of switch on '\' */
14576                     break;
14577                 case '{':
14578                     /* Trying to gain new uses for '{' without breaking too
14579                      * much existing code is hard.  The solution currently
14580                      * adopted is:
14581                      *  1)  If there is no ambiguity that a '{' should always
14582                      *      be taken literally, at the start of a construct, we
14583                      *      just do so.
14584                      *  2)  If the literal '{' conflicts with our desired use
14585                      *      of it as a metacharacter, we die.  The deprecation
14586                      *      cycles for this have come and gone.
14587                      *  3)  If there is ambiguity, we raise a simple warning.
14588                      *      This could happen, for example, if the user
14589                      *      intended it to introduce a quantifier, but slightly
14590                      *      misspelled the quantifier.  Without this warning,
14591                      *      the quantifier would silently be taken as a literal
14592                      *      string of characters instead of a meta construct */
14593                     if (len || (p > RExC_start && isALPHA_A(*(p - 1)))) {
14594                         if (      RExC_strict
14595                             || (  p > parse_start + 1
14596                                 && isALPHA_A(*(p - 1))
14597                                 && *(p - 2) == '\\'))
14598                         {
14599                             RExC_parse = p + 1;
14600                             vFAIL("Unescaped left brace in regex is "
14601                                   "illegal here");
14602                         }
14603                         ckWARNreg(p + 1, "Unescaped left brace in regex is"
14604                                          " passed through");
14605                     }
14606                     goto normal_default;
14607                 case '}':
14608                 case ']':
14609                     if (p > RExC_parse && RExC_strict) {
14610                         ckWARN2reg(p + 1, "Unescaped literal '%c'", *p);
14611                     }
14612                     /*FALLTHROUGH*/
14613                 default:    /* A literal character */
14614                   normal_default:
14615                     if (! UTF8_IS_INVARIANT(*p) && UTF) {
14616                         STRLEN numlen;
14617                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
14618                                                &numlen, UTF8_ALLOW_DEFAULT);
14619                         p += numlen;
14620                     }
14621                     else
14622                         ender = (U8) *p++;
14623                     break;
14624                 } /* End of switch on the literal */
14625
14626                 /* Here, have looked at the literal character, and <ender>
14627                  * contains its ordinal; <p> points to the character after it.
14628                  * */
14629
14630                 if (ender > 255) {
14631                     REQUIRE_UTF8(flagp);
14632                     if (   UNICODE_IS_PERL_EXTENDED(ender)
14633                         && TO_OUTPUT_WARNINGS(p))
14634                     {
14635                         ckWARN2_non_literal_string(p,
14636                                                    packWARN(WARN_PORTABLE),
14637                                                    PL_extended_cp_format,
14638                                                    ender);
14639                     }
14640                 }
14641
14642                 /* We need to check if the next non-ignored thing is a
14643                  * quantifier.  Move <p> to after anything that should be
14644                  * ignored, which, as a side effect, positions <p> for the next
14645                  * loop iteration */
14646                 skip_to_be_ignored_text(pRExC_state, &p,
14647                                         FALSE /* Don't force to /x */ );
14648
14649                 /* If the next thing is a quantifier, it applies to this
14650                  * character only, which means that this character has to be in
14651                  * its own node and can't just be appended to the string in an
14652                  * existing node, so if there are already other characters in
14653                  * the node, close the node with just them, and set up to do
14654                  * this character again next time through, when it will be the
14655                  * only thing in its new node */
14656
14657                 next_is_quantifier =    LIKELY(p < RExC_end)
14658                                      && UNLIKELY(isQUANTIFIER(p, RExC_end));
14659
14660                 if (next_is_quantifier && LIKELY(len)) {
14661                     p = oldp;
14662                     goto loopdone;
14663                 }
14664
14665                 /* Ready to add 'ender' to the node */
14666
14667                 if (! FOLD) {  /* The simple case, just append the literal */
14668                   not_fold_common:
14669
14670                     /* Don't output if it would overflow */
14671                     if (UNLIKELY(len > max_string_len - ((UTF)
14672                                                       ? UVCHR_SKIP(ender)
14673                                                       : 1)))
14674                     {
14675                         overflowed = TRUE;
14676                         break;
14677                     }
14678
14679                     if (UVCHR_IS_INVARIANT(ender) || ! UTF) {
14680                         *(s++) = (char) ender;
14681                     }
14682                     else {
14683                         U8 * new_s = uvchr_to_utf8((U8*)s, ender);
14684                         added_len = (char *) new_s - s;
14685                         s = (char *) new_s;
14686
14687                         if (ender > 255)  {
14688                             requires_utf8_target = TRUE;
14689                         }
14690                     }
14691                 }
14692                 else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
14693
14694                     /* Here are folding under /l, and the code point is
14695                      * problematic.  If this is the first character in the
14696                      * node, change the node type to folding.   Otherwise, if
14697                      * this is the first problematic character, close up the
14698                      * existing node, so can start a new node with this one */
14699                     if (! len) {
14700                         node_type = EXACTFL;
14701                         RExC_contains_locale = 1;
14702                     }
14703                     else if (node_type == EXACT) {
14704                         p = oldp;
14705                         goto loopdone;
14706                     }
14707
14708                     /* This problematic code point means we can't simplify
14709                      * things */
14710                     maybe_exactfu = FALSE;
14711
14712                     /* Although these two characters have folds that are
14713                      * locale-problematic, they also have folds to above Latin1
14714                      * that aren't a problem.  Doing these now helps at
14715                      * runtime. */
14716                     if (UNLIKELY(   ender == GREEK_CAPITAL_LETTER_MU
14717                                  || ender == LATIN_CAPITAL_LETTER_SHARP_S))
14718                     {
14719                         goto fold_anyway;
14720                     }
14721
14722                     /* Here, we are adding a problematic fold character.
14723                      * "Problematic" in this context means that its fold isn't
14724                      * known until runtime.  (The non-problematic code points
14725                      * are the above-Latin1 ones that fold to also all
14726                      * above-Latin1.  Their folds don't vary no matter what the
14727                      * locale is.) But here we have characters whose fold
14728                      * depends on the locale.  We just add in the unfolded
14729                      * character, and wait until runtime to fold it */
14730                     goto not_fold_common;
14731                 }
14732                 else /* regular fold; see if actually is in a fold */
14733                      if (   (ender < 256 && ! IS_IN_SOME_FOLD_L1(ender))
14734                          || (ender > 255
14735                             && ! _invlist_contains_cp(PL_in_some_fold, ender)))
14736                 {
14737                     /* Here, folding, but the character isn't in a fold.
14738                      *
14739                      * Start a new node if previous characters in the node were
14740                      * folded */
14741                     if (len && node_type != EXACT) {
14742                         p = oldp;
14743                         goto loopdone;
14744                     }
14745
14746                     /* Here, continuing a node with non-folded characters.  Add
14747                      * this one */
14748                     goto not_fold_common;
14749                 }
14750                 else {  /* Here, does participate in some fold */
14751
14752                     /* If this is the first character in the node, change its
14753                      * type to folding.  Otherwise, if this is the first
14754                      * folding character in the node, close up the existing
14755                      * node, so can start a new node with this one.  */
14756                     if (! len) {
14757                         node_type = compute_EXACTish(pRExC_state);
14758                     }
14759                     else if (node_type == EXACT) {
14760                         p = oldp;
14761                         goto loopdone;
14762                     }
14763
14764                     if (UTF) {  /* Alway use the folded value for UTF-8
14765                                    patterns */
14766                         if (UVCHR_IS_INVARIANT(ender)) {
14767                             if (UNLIKELY(len + 1 > max_string_len)) {
14768                                 overflowed = TRUE;
14769                                 break;
14770                             }
14771
14772                             *(s)++ = (U8) toFOLD(ender);
14773                         }
14774                         else {
14775                             UV folded;
14776
14777                           fold_anyway:
14778                             folded = _to_uni_fold_flags(
14779                                     ender,
14780                                     (U8 *) s,  /* We have allocated extra space
14781                                                   in 's' so can't run off the
14782                                                   end */
14783                                     &added_len,
14784                                     FOLD_FLAGS_FULL
14785                                   | ((   ASCII_FOLD_RESTRICTED
14786                                       || node_type == EXACTFL)
14787                                     ? FOLD_FLAGS_NOMIX_ASCII
14788                                     : 0));
14789                             if (UNLIKELY(len + added_len > max_string_len)) {
14790                                 overflowed = TRUE;
14791                                 break;
14792                             }
14793
14794                             s += added_len;
14795
14796                             if (   folded > 255
14797                                 && LIKELY(folded != GREEK_SMALL_LETTER_MU))
14798                             {
14799                                 /* U+B5 folds to the MU, so its possible for a
14800                                  * non-UTF-8 target to match it */
14801                                 requires_utf8_target = TRUE;
14802                             }
14803                         }
14804                     }
14805                     else { /* Here is non-UTF8. */
14806
14807                         /* The fold will be one or (rarely) two characters.
14808                          * Check that there's room for at least a single one
14809                          * before setting any flags, etc.  Because otherwise an
14810                          * overflowing character could cause a flag to be set
14811                          * even though it doesn't end up in this node.  (For
14812                          * the two character fold, we check again, before
14813                          * setting any flags) */
14814                         if (UNLIKELY(len + 1 > max_string_len)) {
14815                             overflowed = TRUE;
14816                             break;
14817                         }
14818
14819 #if    UNICODE_MAJOR_VERSION > 3 /* no multifolds in early Unicode */   \
14820    || (UNICODE_MAJOR_VERSION == 3 && (   UNICODE_DOT_VERSION > 0)       \
14821                                       || UNICODE_DOT_DOT_VERSION > 0)
14822
14823                         /* On non-ancient Unicodes, check for the only possible
14824                          * multi-char fold  */
14825                         if (UNLIKELY(ender == LATIN_SMALL_LETTER_SHARP_S)) {
14826
14827                             /* This potential multi-char fold means the node
14828                              * can't be simple (because it could match more
14829                              * than a single char).  And in some cases it will
14830                              * match 'ss', so set that flag */
14831                             maybe_SIMPLE = 0;
14832                             has_ss = TRUE;
14833
14834                             /* It can't change to be an EXACTFU (unless already
14835                              * is one).  We fold it iff under /u rules. */
14836                             if (node_type != EXACTFU) {
14837                                 maybe_exactfu = FALSE;
14838                             }
14839                             else {
14840                                 if (UNLIKELY(len + 2 > max_string_len)) {
14841                                     overflowed = TRUE;
14842                                     break;
14843                                 }
14844
14845                                 *(s++) = 's';
14846                                 *(s++) = 's';
14847                                 added_len = 2;
14848
14849                                 goto done_with_this_char;
14850                             }
14851                         }
14852                         else if (   UNLIKELY(isALPHA_FOLD_EQ(ender, 's'))
14853                                  && LIKELY(len > 0)
14854                                  && UNLIKELY(isALPHA_FOLD_EQ(*(s-1), 's')))
14855                         {
14856                             /* Also, the sequence 'ss' is special when not
14857                              * under /u.  If the target string is UTF-8, it
14858                              * should match SHARP S; otherwise it won't.  So,
14859                              * here we have to exclude the possibility of this
14860                              * node moving to /u.*/
14861                             has_ss = TRUE;
14862                             maybe_exactfu = FALSE;
14863                         }
14864 #endif
14865                         /* Here, the fold will be a single character */
14866
14867                         if (UNLIKELY(ender == MICRO_SIGN)) {
14868                             has_micro_sign = TRUE;
14869                         }
14870                         else if (PL_fold[ender] != PL_fold_latin1[ender]) {
14871
14872                             /* If the character's fold differs between /d and
14873                              * /u, this can't change to be an EXACTFU node */
14874                             maybe_exactfu = FALSE;
14875                         }
14876
14877                         *(s++) = (DEPENDS_SEMANTICS)
14878                                  ? (char) toFOLD(ender)
14879
14880                                    /* Under /u, the fold of any character in
14881                                     * the 0-255 range happens to be its
14882                                     * lowercase equivalent, except for LATIN
14883                                     * SMALL LETTER SHARP S, which was handled
14884                                     * above, and the MICRO SIGN, whose fold
14885                                     * requires UTF-8 to represent.  */
14886                                  : (char) toLOWER_L1(ender);
14887                     }
14888                 } /* End of adding current character to the node */
14889
14890               done_with_this_char:
14891
14892                 len += added_len;
14893
14894                 if (next_is_quantifier) {
14895
14896                     /* Here, the next input is a quantifier, and to get here,
14897                      * the current character is the only one in the node. */
14898                     goto loopdone;
14899                 }
14900
14901             } /* End of loop through literal characters */
14902
14903             /* Here we have either exhausted the input or run out of room in
14904              * the node.  If the former, we are done.  (If we encountered a
14905              * character that can't be in the node, transfer is made directly
14906              * to <loopdone>, and so we wouldn't have fallen off the end of the
14907              * loop.)  */
14908             if (LIKELY(! overflowed)) {
14909                 goto loopdone;
14910             }
14911
14912             /* Here we have run out of room.  We can grow plain EXACT and
14913              * LEXACT nodes.  If the pattern is gigantic enough, though,
14914              * eventually we'll have to artificially chunk the pattern into
14915              * multiple nodes. */
14916             if (! LOC && (node_type == EXACT || node_type == LEXACT)) {
14917                 Size_t overhead = 1 + regarglen[OP(REGNODE_p(ret))];
14918                 Size_t overhead_expansion = 0;
14919                 char temp[256];
14920                 Size_t max_nodes_for_string;
14921                 Size_t achievable;
14922                 SSize_t delta;
14923
14924                 /* Here we couldn't fit the final character in the current
14925                  * node, so it will have to be reparsed, no matter what else we
14926                  * do */
14927                 p = oldp;
14928
14929                 /* If would have overflowed a regular EXACT node, switch
14930                  * instead to an LEXACT.  The code below is structured so that
14931                  * the actual growing code is common to changing from an EXACT
14932                  * or just increasing the LEXACT size.  This means that we have
14933                  * to save the string in the EXACT case before growing, and
14934                  * then copy it afterwards to its new location */
14935                 if (node_type == EXACT) {
14936                     overhead_expansion = regarglen[LEXACT] - regarglen[EXACT];
14937                     RExC_emit += overhead_expansion;
14938                     Copy(s0, temp, len, char);
14939                 }
14940
14941                 /* Ready to grow.  If it was a plain EXACT, the string was
14942                  * saved, and the first few bytes of it overwritten by adding
14943                  * an argument field.  We assume, as we do elsewhere in this
14944                  * file, that one byte of remaining input will translate into
14945                  * one byte of output, and if that's too small, we grow again,
14946                  * if too large the excess memory is freed at the end */
14947
14948                 max_nodes_for_string = U16_MAX - overhead - overhead_expansion;
14949                 achievable = MIN(max_nodes_for_string,
14950                                  current_string_nodes + STR_SZ(RExC_end - p));
14951                 delta = achievable - current_string_nodes;
14952
14953                 /* If there is just no more room, go finish up this chunk of
14954                  * the pattern. */
14955                 if (delta <= 0) {
14956                     goto loopdone;
14957                 }
14958
14959                 change_engine_size(pRExC_state, delta + overhead_expansion);
14960                 current_string_nodes += delta;
14961                 max_string_len
14962                            = sizeof(struct regnode) * current_string_nodes;
14963                 upper_fill = max_string_len + 1;
14964
14965                 /* If the length was small, we know this was originally an
14966                  * EXACT node now converted to LEXACT, and the string has to be
14967                  * restored.  Otherwise the string was untouched.  260 is just
14968                  * a number safely above 255 so don't have to worry about
14969                  * getting it precise */
14970                 if (len < 260) {
14971                     node_type = LEXACT;
14972                     FILL_NODE(ret, node_type);
14973                     s0 = STRING(REGNODE_p(ret));
14974                     Copy(temp, s0, len, char);
14975                     s = s0 + len;
14976                 }
14977
14978                 goto continue_parse;
14979             }
14980             else if (FOLD) {
14981                 bool splittable = FALSE;
14982                 bool backed_up = FALSE;
14983                 char * e;       /* should this be U8? */
14984                 char * s_start; /* should this be U8? */
14985
14986                 /* Here is /i.  Running out of room creates a problem if we are
14987                  * folding, and the split happens in the middle of a
14988                  * multi-character fold, as a match that should have occurred,
14989                  * won't, due to the way nodes are matched, and our artificial
14990                  * boundary.  So back off until we aren't splitting such a
14991                  * fold.  If there is no such place to back off to, we end up
14992                  * taking the entire node as-is.  This can happen if the node
14993                  * consists entirely of 'f' or entirely of 's' characters (or
14994                  * things that fold to them) as 'ff' and 'ss' are
14995                  * multi-character folds.
14996                  *
14997                  * The Unicode standard says that multi character folds consist
14998                  * of either two or three characters.  That means we would be
14999                  * splitting one if the final character in the node is at the
15000                  * beginning of either type, or is the second of a three
15001                  * character fold.
15002                  *
15003                  * At this point:
15004                  *  ender     is the code point of the character that won't fit
15005                  *            in the node
15006                  *  s         points to just beyond the final byte in the node.
15007                  *            It's where we would place ender if there were
15008                  *            room, and where in fact we do place ender's fold
15009                  *            in the code below, as we've over-allocated space
15010                  *            for s0 (hence s) to allow for this
15011                  *  e         starts at 's' and advances as we append things.
15012                  *  old_s     is the same as 's'.  (If ender had fit, 's' would
15013                  *            have been advanced to beyond it).
15014                  *  old_old_s points to the beginning byte of the final
15015                  *            character in the node
15016                  *  p         points to the beginning byte in the input of the
15017                  *            character beyond 'ender'.
15018                  *  oldp      points to the beginning byte in the input of
15019                  *            'ender'.
15020                  *
15021                  * In the case of /il, we haven't folded anything that could be
15022                  * affected by the locale.  That means only above-Latin1
15023                  * characters that fold to other above-latin1 characters get
15024                  * folded at compile time.  To check where a good place to
15025                  * split nodes is, everything in it will have to be folded.
15026                  * The boolean 'maybe_exactfu' keeps track in /il if there are
15027                  * any unfolded characters in the node. */
15028                 bool need_to_fold_loc = LOC && ! maybe_exactfu;
15029
15030                 /* If we do need to fold the node, we need a place to store the
15031                  * folded copy, and a way to map back to the unfolded original
15032                  * */
15033                 char * locfold_buf = NULL;
15034                 Size_t * loc_correspondence = NULL;
15035
15036                 if (! need_to_fold_loc) {   /* The normal case.  Just
15037                                                initialize to the actual node */
15038                     e = s;
15039                     s_start = s0;
15040                     s = old_old_s;  /* Point to the beginning of the final char
15041                                        that fits in the node */
15042                 }
15043                 else {
15044
15045                     /* Here, we have filled a /il node, and there are unfolded
15046                      * characters in it.  If the runtime locale turns out to be
15047                      * UTF-8, there are possible multi-character folds, just
15048                      * like when not under /l.  The node hence can't terminate
15049                      * in the middle of such a fold.  To determine this, we
15050                      * have to create a folded copy of this node.  That means
15051                      * reparsing the node, folding everything assuming a UTF-8
15052                      * locale.  (If at runtime it isn't such a locale, the
15053                      * actions here wouldn't have been necessary, but we have
15054                      * to assume the worst case.)  If we find we need to back
15055                      * off the folded string, we do so, and then map that
15056                      * position back to the original unfolded node, which then
15057                      * gets output, truncated at that spot */
15058
15059                     char * redo_p = RExC_parse;
15060                     char * redo_e;
15061                     char * old_redo_e;
15062
15063                     /* Allow enough space assuming a single byte input folds to
15064                      * a single byte output, plus assume that the two unparsed
15065                      * characters (that we may need) fold to the largest number
15066                      * of bytes possible, plus extra for one more worst case
15067                      * scenario.  In the loop below, if we start eating into
15068                      * that final spare space, we enlarge this initial space */
15069                     Size_t size = max_string_len + (3 * UTF8_MAXBYTES_CASE) + 1;
15070
15071                     Newxz(locfold_buf, size, char);
15072                     Newxz(loc_correspondence, size, Size_t);
15073
15074                     /* Redo this node's parse, folding into 'locfold_buf' */
15075                     redo_p = RExC_parse;
15076                     old_redo_e = redo_e = locfold_buf;
15077                     while (redo_p <= oldp) {
15078
15079                         old_redo_e = redo_e;
15080                         loc_correspondence[redo_e - locfold_buf]
15081                                                         = redo_p - RExC_parse;
15082
15083                         if (UTF) {
15084                             Size_t added_len;
15085
15086                             (void) _to_utf8_fold_flags((U8 *) redo_p,
15087                                                        (U8 *) RExC_end,
15088                                                        (U8 *) redo_e,
15089                                                        &added_len,
15090                                                        FOLD_FLAGS_FULL);
15091                             redo_e += added_len;
15092                             redo_p += UTF8SKIP(redo_p);
15093                         }
15094                         else {
15095
15096                             /* Note that if this code is run on some ancient
15097                              * Unicode versions, SHARP S doesn't fold to 'ss',
15098                              * but rather than clutter the code with #ifdef's,
15099                              * as is done above, we ignore that possibility.
15100                              * This is ok because this code doesn't affect what
15101                              * gets matched, but merely where the node gets
15102                              * split */
15103                             if (UCHARAT(redo_p) != LATIN_SMALL_LETTER_SHARP_S) {
15104                                 *redo_e++ = toLOWER_L1(UCHARAT(redo_p));
15105                             }
15106                             else {
15107                                 *redo_e++ = 's';
15108                                 *redo_e++ = 's';
15109                             }
15110                             redo_p++;
15111                         }
15112
15113
15114                         /* If we're getting so close to the end that a
15115                          * worst-case fold in the next character would cause us
15116                          * to overflow, increase, assuming one byte output byte
15117                          * per one byte input one, plus room for another worst
15118                          * case fold */
15119                         if (   redo_p <= oldp
15120                             && redo_e > locfold_buf + size
15121                                                     - (UTF8_MAXBYTES_CASE + 1))
15122                         {
15123                             Size_t new_size = size
15124                                             + (oldp - redo_p)
15125                                             + UTF8_MAXBYTES_CASE + 1;
15126                             Ptrdiff_t e_offset = redo_e - locfold_buf;
15127
15128                             Renew(locfold_buf, new_size, char);
15129                             Renew(loc_correspondence, new_size, Size_t);
15130                             size = new_size;
15131
15132                             redo_e = locfold_buf + e_offset;
15133                         }
15134                     }
15135
15136                     /* Set so that things are in terms of the folded, temporary
15137                      * string */
15138                     s = old_redo_e;
15139                     s_start = locfold_buf;
15140                     e = redo_e;
15141
15142                 }
15143
15144                 /* Here, we have 's', 's_start' and 'e' set up to point to the
15145                  * input that goes into the node, folded.
15146                  *
15147                  * If the final character of the node and the fold of ender
15148                  * form the first two characters of a three character fold, we
15149                  * need to peek ahead at the next (unparsed) character in the
15150                  * input to determine if the three actually do form such a
15151                  * fold.  Just looking at that character is not generally
15152                  * sufficient, as it could be, for example, an escape sequence
15153                  * that evaluates to something else, and it needs to be folded.
15154                  *
15155                  * khw originally thought to just go through the parse loop one
15156                  * extra time, but that doesn't work easily as that iteration
15157                  * could cause things to think that the parse is over and to
15158                  * goto loopdone.  The character could be a '$' for example, or
15159                  * the character beyond could be a quantifier, and other
15160                  * glitches as well.
15161                  *
15162                  * The solution used here for peeking ahead is to look at that
15163                  * next character.  If it isn't ASCII punctuation, then it will
15164                  * be something that would continue on in an EXACTish node if
15165                  * there were space.  We append the fold of it to s, having
15166                  * reserved enough room in s0 for the purpose.  If we can't
15167                  * reasonably peek ahead, we instead assume the worst case:
15168                  * that it is something that would form the completion of a
15169                  * multi-char fold.
15170                  *
15171                  * If we can't split between s and ender, we work backwards
15172                  * character-by-character down to s0.  At each current point
15173                  * see if we are at the beginning of a multi-char fold.  If so,
15174                  * that means we would be splitting the fold across nodes, and
15175                  * so we back up one and try again.
15176                  *
15177                  * If we're not at the beginning, we still could be at the
15178                  * final two characters of a (rare) three character fold.  We
15179                  * check if the sequence starting at the character before the
15180                  * current position (and including the current and next
15181                  * characters) is a three character fold.  If not, the node can
15182                  * be split here.  If it is, we have to backup two characters
15183                  * and try again.
15184                  *
15185                  * Otherwise, the node can be split at the current position.
15186                  *
15187                  * The same logic is used for UTF-8 patterns and not */
15188                 if (UTF) {
15189                     Size_t added_len;
15190
15191                     /* Append the fold of ender */
15192                     (void) _to_uni_fold_flags(
15193                         ender,
15194                         (U8 *) e,
15195                         &added_len,
15196                         FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
15197                                         ? FOLD_FLAGS_NOMIX_ASCII
15198                                         : 0));
15199                     e += added_len;
15200
15201                     /* 's' and the character folded to by ender may be the
15202                      * first two of a three-character fold, in which case the
15203                      * node should not be split here.  That may mean examining
15204                      * the so-far unparsed character starting at 'p'.  But if
15205                      * ender folded to more than one character, we already have
15206                      * three characters to look at.  Also, we first check if
15207                      * the sequence consisting of s and the next character form
15208                      * the first two of some three character fold.  If not,
15209                      * there's no need to peek ahead. */
15210                     if (   added_len <= UTF8SKIP(e - added_len)
15211                         && UNLIKELY(is_THREE_CHAR_FOLD_HEAD_utf8_safe(s, e)))
15212                     {
15213                         /* Here, the two do form the beginning of a potential
15214                          * three character fold.  The unexamined character may
15215                          * or may not complete it.  Peek at it.  It might be
15216                          * something that ends the node or an escape sequence,
15217                          * in which case we don't know without a lot of work
15218                          * what it evaluates to, so we have to assume the worst
15219                          * case: that it does complete the fold, and so we
15220                          * can't split here.  All such instances  will have
15221                          * that character be an ASCII punctuation character,
15222                          * like a backslash.  So, for that case, backup one and
15223                          * drop down to try at that position */
15224                         if (isPUNCT(*p)) {
15225                             s = (char *) utf8_hop_back((U8 *) s, -1,
15226                                        (U8 *) s_start);
15227                             backed_up = TRUE;
15228                         }
15229                         else {
15230                             /* Here, since it's not punctuation, it must be a
15231                              * real character, and we can append its fold to
15232                              * 'e' (having deliberately reserved enough space
15233                              * for this eventuality) and drop down to check if
15234                              * the three actually do form a folded sequence */
15235                             (void) _to_utf8_fold_flags(
15236                                 (U8 *) p, (U8 *) RExC_end,
15237                                 (U8 *) e,
15238                                 &added_len,
15239                                 FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
15240                                                 ? FOLD_FLAGS_NOMIX_ASCII
15241                                                 : 0));
15242                             e += added_len;
15243                         }
15244                     }
15245
15246                     /* Here, we either have three characters available in
15247                      * sequence starting at 's', or we have two characters and
15248                      * know that the following one can't possibly be part of a
15249                      * three character fold.  We go through the node backwards
15250                      * until we find a place where we can split it without
15251                      * breaking apart a multi-character fold.  At any given
15252                      * point we have to worry about if such a fold begins at
15253                      * the current 's', and also if a three-character fold
15254                      * begins at s-1, (containing s and s+1).  Splitting in
15255                      * either case would break apart a fold */
15256                     do {
15257                         char *prev_s = (char *) utf8_hop_back((U8 *) s, -1,
15258                                                             (U8 *) s_start);
15259
15260                         /* If is a multi-char fold, can't split here.  Backup
15261                          * one char and try again */
15262                         if (UNLIKELY(is_MULTI_CHAR_FOLD_utf8_safe(s, e))) {
15263                             s = prev_s;
15264                             backed_up = TRUE;
15265                             continue;
15266                         }
15267
15268                         /* If the two characters beginning at 's' are part of a
15269                          * three character fold starting at the character
15270                          * before s, we can't split either before or after s.
15271                          * Backup two chars and try again */
15272                         if (   LIKELY(s > s_start)
15273                             && UNLIKELY(is_THREE_CHAR_FOLD_utf8_safe(prev_s, e)))
15274                         {
15275                             s = prev_s;
15276                             s = (char *) utf8_hop_back((U8 *) s, -1, (U8 *) s_start);
15277                             backed_up = TRUE;
15278                             continue;
15279                         }
15280
15281                         /* Here there's no multi-char fold between s and the
15282                          * next character following it.  We can split */
15283                         splittable = TRUE;
15284                         break;
15285
15286                     } while (s > s_start); /* End of loops backing up through the node */
15287
15288                     /* Here we either couldn't find a place to split the node,
15289                      * or else we broke out of the loop setting 'splittable' to
15290                      * true.  In the latter case, the place to split is between
15291                      * the first and second characters in the sequence starting
15292                      * at 's' */
15293                     if (splittable) {
15294                         s += UTF8SKIP(s);
15295                     }
15296                 }
15297                 else {  /* Pattern not UTF-8 */
15298                     if (   ender != LATIN_SMALL_LETTER_SHARP_S
15299                         || ASCII_FOLD_RESTRICTED)
15300                     {
15301                         assert( toLOWER_L1(ender) < 256 );
15302                         *e++ = (char)(toLOWER_L1(ender)); /* should e and the cast be U8? */
15303                     }
15304                     else {
15305                         *e++ = 's';
15306                         *e++ = 's';
15307                     }
15308
15309                     if (   e - s  <= 1
15310                         && UNLIKELY(is_THREE_CHAR_FOLD_HEAD_latin1_safe(s, e)))
15311                     {
15312                         if (isPUNCT(*p)) {
15313                             s--;
15314                             backed_up = TRUE;
15315                         }
15316                         else {
15317                             if (   UCHARAT(p) != LATIN_SMALL_LETTER_SHARP_S
15318                                 || ASCII_FOLD_RESTRICTED)
15319                             {
15320                                 assert( toLOWER_L1(ender) < 256 );
15321                                 *e++ = (char)(toLOWER_L1(ender)); /* should e and the cast be U8? */
15322                             }
15323                             else {
15324                                 *e++ = 's';
15325                                 *e++ = 's';
15326                             }
15327                         }
15328                     }
15329
15330                     do {
15331                         if (UNLIKELY(is_MULTI_CHAR_FOLD_latin1_safe(s, e))) {
15332                             s--;
15333                             backed_up = TRUE;
15334                             continue;
15335                         }
15336
15337                         if (   LIKELY(s > s_start)
15338                             && UNLIKELY(is_THREE_CHAR_FOLD_latin1_safe(s - 1, e)))
15339                         {
15340                             s -= 2;
15341                             backed_up = TRUE;
15342                             continue;
15343                         }
15344
15345                         splittable = TRUE;
15346                         break;
15347
15348                     } while (s > s_start);
15349
15350                     if (splittable) {
15351                         s++;
15352                     }
15353                 }
15354
15355                 /* Here, we are done backing up.  If we didn't backup at all
15356                  * (the likely case), just proceed */
15357                 if (backed_up) {
15358
15359                    /* If we did find a place to split, reparse the entire node
15360                     * stopping where we have calculated. */
15361                     if (splittable) {
15362
15363                        /* If we created a temporary folded string under /l, we
15364                         * have to map that back to the original */
15365                         if (need_to_fold_loc) {
15366                             upper_fill = loc_correspondence[s - s_start];
15367                             if (upper_fill == 0) {
15368                                 FAIL2("panic: loc_correspondence[%d] is 0",
15369                                       (int) (s - s_start));
15370                             }
15371                             Safefree(locfold_buf);
15372                             Safefree(loc_correspondence);
15373                         }
15374                         else {
15375                             upper_fill = s - s0;
15376                         }
15377                         goto reparse;
15378                     }
15379
15380                     /* Here the node consists entirely of non-final multi-char
15381                      * folds.  (Likely it is all 'f's or all 's's.)  There's no
15382                      * decent place to split it, so give up and just take the
15383                      * whole thing */
15384                     len = old_s - s0;
15385                 }
15386
15387                 if (need_to_fold_loc) {
15388                     Safefree(locfold_buf);
15389                     Safefree(loc_correspondence);
15390                 }
15391             }   /* End of verifying node ends with an appropriate char */
15392
15393             /* We need to start the next node at the character that didn't fit
15394              * in this one */
15395             p = oldp;
15396
15397           loopdone:   /* Jumped to when encounters something that shouldn't be
15398                          in the node */
15399
15400             /* Free up any over-allocated space; cast is to silence bogus
15401              * warning in MS VC */
15402             change_engine_size(pRExC_state,
15403                         - (Ptrdiff_t) (current_string_nodes - STR_SZ(len)));
15404
15405             /* I (khw) don't know if you can get here with zero length, but the
15406              * old code handled this situation by creating a zero-length EXACT
15407              * node.  Might as well be NOTHING instead */
15408             if (len == 0) {
15409                 OP(REGNODE_p(ret)) = NOTHING;
15410             }
15411             else {
15412
15413                 /* If the node type is EXACT here, check to see if it
15414                  * should be EXACTL, or EXACT_REQ8. */
15415                 if (node_type == EXACT) {
15416                     if (LOC) {
15417                         node_type = EXACTL;
15418                     }
15419                     else if (requires_utf8_target) {
15420                         node_type = EXACT_REQ8;
15421                     }
15422                 }
15423                 else if (node_type == LEXACT) {
15424                     if (requires_utf8_target) {
15425                         node_type = LEXACT_REQ8;
15426                     }
15427                 }
15428                 else if (FOLD) {
15429                     if (    UNLIKELY(has_micro_sign || has_ss)
15430                         && (node_type == EXACTFU || (   node_type == EXACTF
15431                                                      && maybe_exactfu)))
15432                     {   /* These two conditions are problematic in non-UTF-8
15433                            EXACTFU nodes. */
15434                         assert(! UTF);
15435                         node_type = EXACTFUP;
15436                     }
15437                     else if (node_type == EXACTFL) {
15438
15439                         /* 'maybe_exactfu' is deliberately set above to
15440                          * indicate this node type, where all code points in it
15441                          * are above 255 */
15442                         if (maybe_exactfu) {
15443                             node_type = EXACTFLU8;
15444                         }
15445                         else if (UNLIKELY(
15446                              _invlist_contains_cp(PL_HasMultiCharFold, ender)))
15447                         {
15448                             /* A character that folds to more than one will
15449                              * match multiple characters, so can't be SIMPLE.
15450                              * We don't have to worry about this with EXACTFLU8
15451                              * nodes just above, as they have already been
15452                              * folded (since the fold doesn't vary at run
15453                              * time).  Here, if the final character in the node
15454                              * folds to multiple, it can't be simple.  (This
15455                              * only has an effect if the node has only a single
15456                              * character, hence the final one, as elsewhere we
15457                              * turn off simple for nodes whose length > 1 */
15458                             maybe_SIMPLE = 0;
15459                         }
15460                     }
15461                     else if (node_type == EXACTF) {  /* Means is /di */
15462
15463                         /* This intermediate variable is needed solely because
15464                          * the asserts in the macro where used exceed Win32's
15465                          * literal string capacity */
15466                         char first_char = * STRING(REGNODE_p(ret));
15467
15468                         /* If 'maybe_exactfu' is clear, then we need to stay
15469                          * /di.  If it is set, it means there are no code
15470                          * points that match differently depending on UTF8ness
15471                          * of the target string, so it can become an EXACTFU
15472                          * node */
15473                         if (! maybe_exactfu) {
15474                             RExC_seen_d_op = TRUE;
15475                         }
15476                         else if (   isALPHA_FOLD_EQ(first_char, 's')
15477                                  || isALPHA_FOLD_EQ(ender, 's'))
15478                         {
15479                             /* But, if the node begins or ends in an 's' we
15480                              * have to defer changing it into an EXACTFU, as
15481                              * the node could later get joined with another one
15482                              * that ends or begins with 's' creating an 'ss'
15483                              * sequence which would then wrongly match the
15484                              * sharp s without the target being UTF-8.  We
15485                              * create a special node that we resolve later when
15486                              * we join nodes together */
15487
15488                             node_type = EXACTFU_S_EDGE;
15489                         }
15490                         else {
15491                             node_type = EXACTFU;
15492                         }
15493                     }
15494
15495                     if (requires_utf8_target && node_type == EXACTFU) {
15496                         node_type = EXACTFU_REQ8;
15497                     }
15498                 }
15499
15500                 OP(REGNODE_p(ret)) = node_type;
15501                 setSTR_LEN(REGNODE_p(ret), len);
15502                 RExC_emit += STR_SZ(len);
15503
15504                 /* If the node isn't a single character, it can't be SIMPLE */
15505                 if (len > (Size_t) ((UTF) ? UTF8SKIP(STRING(REGNODE_p(ret))) : 1)) {
15506                     maybe_SIMPLE = 0;
15507                 }
15508
15509                 *flagp |= HASWIDTH | maybe_SIMPLE;
15510             }
15511
15512             Set_Node_Length(REGNODE_p(ret), p - parse_start - 1);
15513             RExC_parse = p;
15514
15515             {
15516                 /* len is STRLEN which is unsigned, need to copy to signed */
15517                 IV iv = len;
15518                 if (iv < 0)
15519                     vFAIL("Internal disaster");
15520             }
15521
15522         } /* End of label 'defchar:' */
15523         break;
15524     } /* End of giant switch on input character */
15525
15526     /* Position parse to next real character */
15527     skip_to_be_ignored_text(pRExC_state, &RExC_parse,
15528                                             FALSE /* Don't force to /x */ );
15529     if (   *RExC_parse == '{'
15530         && OP(REGNODE_p(ret)) != SBOL && ! regcurly(RExC_parse, RExC_end, NULL))
15531     {
15532         if (RExC_strict) {
15533             RExC_parse++;
15534             vFAIL("Unescaped left brace in regex is illegal here");
15535         }
15536         ckWARNreg(RExC_parse + 1, "Unescaped left brace in regex is"
15537                                   " passed through");
15538     }
15539
15540     return(ret);
15541 }
15542
15543
15544 STATIC void
15545 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
15546 {
15547     /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
15548      * sets up the bitmap and any flags, removing those code points from the
15549      * inversion list, setting it to NULL should it become completely empty */
15550
15551
15552     PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
15553     assert(PL_regkind[OP(node)] == ANYOF);
15554
15555     /* There is no bitmap for this node type */
15556     if (inRANGE(OP(node), ANYOFH, ANYOFRb)) {
15557         return;
15558     }
15559
15560     ANYOF_BITMAP_ZERO(node);
15561     if (*invlist_ptr) {
15562
15563         /* This gets set if we actually need to modify things */
15564         bool change_invlist = FALSE;
15565
15566         UV start, end;
15567
15568         /* Start looking through *invlist_ptr */
15569         invlist_iterinit(*invlist_ptr);
15570         while (invlist_iternext(*invlist_ptr, &start, &end)) {
15571             UV high;
15572             int i;
15573
15574             if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
15575                 ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
15576             }
15577
15578             /* Quit if are above what we should change */
15579             if (start >= NUM_ANYOF_CODE_POINTS) {
15580                 break;
15581             }
15582
15583             change_invlist = TRUE;
15584
15585             /* Set all the bits in the range, up to the max that we are doing */
15586             high = (end < NUM_ANYOF_CODE_POINTS - 1)
15587                    ? end
15588                    : NUM_ANYOF_CODE_POINTS - 1;
15589             for (i = start; i <= (int) high; i++) {
15590                 ANYOF_BITMAP_SET(node, i);
15591             }
15592         }
15593         invlist_iterfinish(*invlist_ptr);
15594
15595         /* Done with loop; remove any code points that are in the bitmap from
15596          * *invlist_ptr; similarly for code points above the bitmap if we have
15597          * a flag to match all of them anyways */
15598         if (change_invlist) {
15599             _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
15600         }
15601         if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
15602             _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
15603         }
15604
15605         /* If have completely emptied it, remove it completely */
15606         if (_invlist_len(*invlist_ptr) == 0) {
15607             SvREFCNT_dec_NN(*invlist_ptr);
15608             *invlist_ptr = NULL;
15609         }
15610     }
15611 }
15612
15613 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
15614    Character classes ([:foo:]) can also be negated ([:^foo:]).
15615    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
15616    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
15617    but trigger failures because they are currently unimplemented. */
15618
15619 #define POSIXCC_DONE(c)   ((c) == ':')
15620 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
15621 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
15622 #define MAYBE_POSIXCC(c) (POSIXCC(c) || (c) == '^' || (c) == ';')
15623
15624 #define WARNING_PREFIX              "Assuming NOT a POSIX class since "
15625 #define NO_BLANKS_POSIX_WARNING     "no blanks are allowed in one"
15626 #define SEMI_COLON_POSIX_WARNING    "a semi-colon was found instead of a colon"
15627
15628 #define NOT_MEANT_TO_BE_A_POSIX_CLASS (OOB_NAMEDCLASS - 1)
15629
15630 /* 'posix_warnings' and 'warn_text' are names of variables in the following
15631  * routine. q.v. */
15632 #define ADD_POSIX_WARNING(p, text)  STMT_START {                            \
15633         if (posix_warnings) {                                               \
15634             if (! RExC_warn_text ) RExC_warn_text =                         \
15635                                          (AV *) sv_2mortal((SV *) newAV()); \
15636             av_push(RExC_warn_text, Perl_newSVpvf(aTHX_                     \
15637                                              WARNING_PREFIX                 \
15638                                              text                           \
15639                                              REPORT_LOCATION,               \
15640                                              REPORT_LOCATION_ARGS(p)));     \
15641         }                                                                   \
15642     } STMT_END
15643 #define CLEAR_POSIX_WARNINGS()                                              \
15644     STMT_START {                                                            \
15645         if (posix_warnings && RExC_warn_text)                               \
15646             av_clear(RExC_warn_text);                                       \
15647     } STMT_END
15648
15649 #define CLEAR_POSIX_WARNINGS_AND_RETURN(ret)                                \
15650     STMT_START {                                                            \
15651         CLEAR_POSIX_WARNINGS();                                             \
15652         return ret;                                                         \
15653     } STMT_END
15654
15655 STATIC int
15656 S_handle_possible_posix(pTHX_ RExC_state_t *pRExC_state,
15657
15658     const char * const s,      /* Where the putative posix class begins.
15659                                   Normally, this is one past the '['.  This
15660                                   parameter exists so it can be somewhere
15661                                   besides RExC_parse. */
15662     char ** updated_parse_ptr, /* Where to set the updated parse pointer, or
15663                                   NULL */
15664     AV ** posix_warnings,      /* Where to place any generated warnings, or
15665                                   NULL */
15666     const bool check_only      /* Don't die if error */
15667 )
15668 {
15669     /* This parses what the caller thinks may be one of the three POSIX
15670      * constructs:
15671      *  1) a character class, like [:blank:]
15672      *  2) a collating symbol, like [. .]
15673      *  3) an equivalence class, like [= =]
15674      * In the latter two cases, it croaks if it finds a syntactically legal
15675      * one, as these are not handled by Perl.
15676      *
15677      * The main purpose is to look for a POSIX character class.  It returns:
15678      *  a) the class number
15679      *      if it is a completely syntactically and semantically legal class.
15680      *      'updated_parse_ptr', if not NULL, is set to point to just after the
15681      *      closing ']' of the class
15682      *  b) OOB_NAMEDCLASS
15683      *      if it appears that one of the three POSIX constructs was meant, but
15684      *      its specification was somehow defective.  'updated_parse_ptr', if
15685      *      not NULL, is set to point to the character just after the end
15686      *      character of the class.  See below for handling of warnings.
15687      *  c) NOT_MEANT_TO_BE_A_POSIX_CLASS
15688      *      if it  doesn't appear that a POSIX construct was intended.
15689      *      'updated_parse_ptr' is not changed.  No warnings nor errors are
15690      *      raised.
15691      *
15692      * In b) there may be errors or warnings generated.  If 'check_only' is
15693      * TRUE, then any errors are discarded.  Warnings are returned to the
15694      * caller via an AV* created into '*posix_warnings' if it is not NULL.  If
15695      * instead it is NULL, warnings are suppressed.
15696      *
15697      * The reason for this function, and its complexity is that a bracketed
15698      * character class can contain just about anything.  But it's easy to
15699      * mistype the very specific posix class syntax but yielding a valid
15700      * regular bracketed class, so it silently gets compiled into something
15701      * quite unintended.
15702      *
15703      * The solution adopted here maintains backward compatibility except that
15704      * it adds a warning if it looks like a posix class was intended but
15705      * improperly specified.  The warning is not raised unless what is input
15706      * very closely resembles one of the 14 legal posix classes.  To do this,
15707      * it uses fuzzy parsing.  It calculates how many single-character edits it
15708      * would take to transform what was input into a legal posix class.  Only
15709      * if that number is quite small does it think that the intention was a
15710      * posix class.  Obviously these are heuristics, and there will be cases
15711      * where it errs on one side or another, and they can be tweaked as
15712      * experience informs.
15713      *
15714      * The syntax for a legal posix class is:
15715      *
15716      * qr/(?xa: \[ : \^? [[:lower:]]{4,6} : \] )/
15717      *
15718      * What this routine considers syntactically to be an intended posix class
15719      * is this (the comments indicate some restrictions that the pattern
15720      * doesn't show):
15721      *
15722      *  qr/(?x: \[?                         # The left bracket, possibly
15723      *                                      # omitted
15724      *          \h*                         # possibly followed by blanks
15725      *          (?: \^ \h* )?               # possibly a misplaced caret
15726      *          [:;]?                       # The opening class character,
15727      *                                      # possibly omitted.  A typo
15728      *                                      # semi-colon can also be used.
15729      *          \h*
15730      *          \^?                         # possibly a correctly placed
15731      *                                      # caret, but not if there was also
15732      *                                      # a misplaced one
15733      *          \h*
15734      *          .{3,15}                     # The class name.  If there are
15735      *                                      # deviations from the legal syntax,
15736      *                                      # its edit distance must be close
15737      *                                      # to a real class name in order
15738      *                                      # for it to be considered to be
15739      *                                      # an intended posix class.
15740      *          \h*
15741      *          [[:punct:]]?                # The closing class character,
15742      *                                      # possibly omitted.  If not a colon
15743      *                                      # nor semi colon, the class name
15744      *                                      # must be even closer to a valid
15745      *                                      # one
15746      *          \h*
15747      *          \]?                         # The right bracket, possibly
15748      *                                      # omitted.
15749      *     )/
15750      *
15751      * In the above, \h must be ASCII-only.
15752      *
15753      * These are heuristics, and can be tweaked as field experience dictates.
15754      * There will be cases when someone didn't intend to specify a posix class
15755      * that this warns as being so.  The goal is to minimize these, while
15756      * maximizing the catching of things intended to be a posix class that
15757      * aren't parsed as such.
15758      */
15759
15760     const char* p             = s;
15761     const char * const e      = RExC_end;
15762     unsigned complement       = 0;      /* If to complement the class */
15763     bool found_problem        = FALSE;  /* Assume OK until proven otherwise */
15764     bool has_opening_bracket  = FALSE;
15765     bool has_opening_colon    = FALSE;
15766     int class_number          = OOB_NAMEDCLASS; /* Out-of-bounds until find
15767                                                    valid class */
15768     const char * possible_end = NULL;   /* used for a 2nd parse pass */
15769     const char* name_start;             /* ptr to class name first char */
15770
15771     /* If the number of single-character typos the input name is away from a
15772      * legal name is no more than this number, it is considered to have meant
15773      * the legal name */
15774     int max_distance          = 2;
15775
15776     /* to store the name.  The size determines the maximum length before we
15777      * decide that no posix class was intended.  Should be at least
15778      * sizeof("alphanumeric") */
15779     UV input_text[15];
15780     STATIC_ASSERT_DECL(C_ARRAY_LENGTH(input_text) >= sizeof "alphanumeric");
15781
15782     PERL_ARGS_ASSERT_HANDLE_POSSIBLE_POSIX;
15783
15784     CLEAR_POSIX_WARNINGS();
15785
15786     if (p >= e) {
15787         return NOT_MEANT_TO_BE_A_POSIX_CLASS;
15788     }
15789
15790     if (*(p - 1) != '[') {
15791         ADD_POSIX_WARNING(p, "it doesn't start with a '['");
15792         found_problem = TRUE;
15793     }
15794     else {
15795         has_opening_bracket = TRUE;
15796     }
15797
15798     /* They could be confused and think you can put spaces between the
15799      * components */
15800     if (isBLANK(*p)) {
15801         found_problem = TRUE;
15802
15803         do {
15804             p++;
15805         } while (p < e && isBLANK(*p));
15806
15807         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15808     }
15809
15810     /* For [. .] and [= =].  These are quite different internally from [: :],
15811      * so they are handled separately.  */
15812     if (POSIXCC_NOTYET(*p) && p < e - 3) /* 1 for the close, and 1 for the ']'
15813                                             and 1 for at least one char in it
15814                                           */
15815     {
15816         const char open_char  = *p;
15817         const char * temp_ptr = p + 1;
15818
15819         /* These two constructs are not handled by perl, and if we find a
15820          * syntactically valid one, we croak.  khw, who wrote this code, finds
15821          * this explanation of them very unclear:
15822          * http://pubs.opengroup.org/onlinepubs/009696899/basedefs/xbd_chap09.html
15823          * And searching the rest of the internet wasn't very helpful either.
15824          * It looks like just about any byte can be in these constructs,
15825          * depending on the locale.  But unless the pattern is being compiled
15826          * under /l, which is very rare, Perl runs under the C or POSIX locale.
15827          * In that case, it looks like [= =] isn't allowed at all, and that
15828          * [. .] could be any single code point, but for longer strings the
15829          * constituent characters would have to be the ASCII alphabetics plus
15830          * the minus-hyphen.  Any sensible locale definition would limit itself
15831          * to these.  And any portable one definitely should.  Trying to parse
15832          * the general case is a nightmare (see [perl #127604]).  So, this code
15833          * looks only for interiors of these constructs that match:
15834          *      qr/.|[-\w]{2,}/
15835          * Using \w relaxes the apparent rules a little, without adding much
15836          * danger of mistaking something else for one of these constructs.
15837          *
15838          * [. .] in some implementations described on the internet is usable to
15839          * escape a character that otherwise is special in bracketed character
15840          * classes.  For example [.].] means a literal right bracket instead of
15841          * the ending of the class
15842          *
15843          * [= =] can legitimately contain a [. .] construct, but we don't
15844          * handle this case, as that [. .] construct will later get parsed
15845          * itself and croak then.  And [= =] is checked for even when not under
15846          * /l, as Perl has long done so.
15847          *
15848          * The code below relies on there being a trailing NUL, so it doesn't
15849          * have to keep checking if the parse ptr < e.
15850          */
15851         if (temp_ptr[1] == open_char) {
15852             temp_ptr++;
15853         }
15854         else while (    temp_ptr < e
15855                     && (isWORDCHAR(*temp_ptr) || *temp_ptr == '-'))
15856         {
15857             temp_ptr++;
15858         }
15859
15860         if (*temp_ptr == open_char) {
15861             temp_ptr++;
15862             if (*temp_ptr == ']') {
15863                 temp_ptr++;
15864                 if (! found_problem && ! check_only) {
15865                     RExC_parse = (char *) temp_ptr;
15866                     vFAIL3("POSIX syntax [%c %c] is reserved for future "
15867                             "extensions", open_char, open_char);
15868                 }
15869
15870                 /* Here, the syntax wasn't completely valid, or else the call
15871                  * is to check-only */
15872                 if (updated_parse_ptr) {
15873                     *updated_parse_ptr = (char *) temp_ptr;
15874                 }
15875
15876                 CLEAR_POSIX_WARNINGS_AND_RETURN(OOB_NAMEDCLASS);
15877             }
15878         }
15879
15880         /* If we find something that started out to look like one of these
15881          * constructs, but isn't, we continue below so that it can be checked
15882          * for being a class name with a typo of '.' or '=' instead of a colon.
15883          * */
15884     }
15885
15886     /* Here, we think there is a possibility that a [: :] class was meant, and
15887      * we have the first real character.  It could be they think the '^' comes
15888      * first */
15889     if (*p == '^') {
15890         found_problem = TRUE;
15891         ADD_POSIX_WARNING(p + 1, "the '^' must come after the colon");
15892         complement = 1;
15893         p++;
15894
15895         if (isBLANK(*p)) {
15896             found_problem = TRUE;
15897
15898             do {
15899                 p++;
15900             } while (p < e && isBLANK(*p));
15901
15902             ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15903         }
15904     }
15905
15906     /* But the first character should be a colon, which they could have easily
15907      * mistyped on a qwerty keyboard as a semi-colon (and which may be hard to
15908      * distinguish from a colon, so treat that as a colon).  */
15909     if (*p == ':') {
15910         p++;
15911         has_opening_colon = TRUE;
15912     }
15913     else if (*p == ';') {
15914         found_problem = TRUE;
15915         p++;
15916         ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15917         has_opening_colon = TRUE;
15918     }
15919     else {
15920         found_problem = TRUE;
15921         ADD_POSIX_WARNING(p, "there must be a starting ':'");
15922
15923         /* Consider an initial punctuation (not one of the recognized ones) to
15924          * be a left terminator */
15925         if (*p != '^' && *p != ']' && isPUNCT(*p)) {
15926             p++;
15927         }
15928     }
15929
15930     /* They may think that you can put spaces between the components */
15931     if (isBLANK(*p)) {
15932         found_problem = TRUE;
15933
15934         do {
15935             p++;
15936         } while (p < e && isBLANK(*p));
15937
15938         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15939     }
15940
15941     if (*p == '^') {
15942
15943         /* We consider something like [^:^alnum:]] to not have been intended to
15944          * be a posix class, but XXX maybe we should */
15945         if (complement) {
15946             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15947         }
15948
15949         complement = 1;
15950         p++;
15951     }
15952
15953     /* Again, they may think that you can put spaces between the components */
15954     if (isBLANK(*p)) {
15955         found_problem = TRUE;
15956
15957         do {
15958             p++;
15959         } while (p < e && isBLANK(*p));
15960
15961         ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
15962     }
15963
15964     if (*p == ']') {
15965
15966         /* XXX This ']' may be a typo, and something else was meant.  But
15967          * treating it as such creates enough complications, that that
15968          * possibility isn't currently considered here.  So we assume that the
15969          * ']' is what is intended, and if we've already found an initial '[',
15970          * this leaves this construct looking like [:] or [:^], which almost
15971          * certainly weren't intended to be posix classes */
15972         if (has_opening_bracket) {
15973             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15974         }
15975
15976         /* But this function can be called when we parse the colon for
15977          * something like qr/[alpha:]]/, so we back up to look for the
15978          * beginning */
15979         p--;
15980
15981         if (*p == ';') {
15982             found_problem = TRUE;
15983             ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
15984         }
15985         else if (*p != ':') {
15986
15987             /* XXX We are currently very restrictive here, so this code doesn't
15988              * consider the possibility that, say, /[alpha.]]/ was intended to
15989              * be a posix class. */
15990             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
15991         }
15992
15993         /* Here we have something like 'foo:]'.  There was no initial colon,
15994          * and we back up over 'foo.  XXX Unlike the going forward case, we
15995          * don't handle typos of non-word chars in the middle */
15996         has_opening_colon = FALSE;
15997         p--;
15998
15999         while (p > RExC_start && isWORDCHAR(*p)) {
16000             p--;
16001         }
16002         p++;
16003
16004         /* Here, we have positioned ourselves to where we think the first
16005          * character in the potential class is */
16006     }
16007
16008     /* Now the interior really starts.  There are certain key characters that
16009      * can end the interior, or these could just be typos.  To catch both
16010      * cases, we may have to do two passes.  In the first pass, we keep on
16011      * going unless we come to a sequence that matches
16012      *      qr/ [[:punct:]] [[:blank:]]* \] /xa
16013      * This means it takes a sequence to end the pass, so two typos in a row if
16014      * that wasn't what was intended.  If the class is perfectly formed, just
16015      * this one pass is needed.  We also stop if there are too many characters
16016      * being accumulated, but this number is deliberately set higher than any
16017      * real class.  It is set high enough so that someone who thinks that
16018      * 'alphanumeric' is a correct name would get warned that it wasn't.
16019      * While doing the pass, we keep track of where the key characters were in
16020      * it.  If we don't find an end to the class, and one of the key characters
16021      * was found, we redo the pass, but stop when we get to that character.
16022      * Thus the key character was considered a typo in the first pass, but a
16023      * terminator in the second.  If two key characters are found, we stop at
16024      * the second one in the first pass.  Again this can miss two typos, but
16025      * catches a single one
16026      *
16027      * In the first pass, 'possible_end' starts as NULL, and then gets set to
16028      * point to the first key character.  For the second pass, it starts as -1.
16029      * */
16030
16031     name_start = p;
16032   parse_name:
16033     {
16034         bool has_blank               = FALSE;
16035         bool has_upper               = FALSE;
16036         bool has_terminating_colon   = FALSE;
16037         bool has_terminating_bracket = FALSE;
16038         bool has_semi_colon          = FALSE;
16039         unsigned int name_len        = 0;
16040         int punct_count              = 0;
16041
16042         while (p < e) {
16043
16044             /* Squeeze out blanks when looking up the class name below */
16045             if (isBLANK(*p) ) {
16046                 has_blank = TRUE;
16047                 found_problem = TRUE;
16048                 p++;
16049                 continue;
16050             }
16051
16052             /* The name will end with a punctuation */
16053             if (isPUNCT(*p)) {
16054                 const char * peek = p + 1;
16055
16056                 /* Treat any non-']' punctuation followed by a ']' (possibly
16057                  * with intervening blanks) as trying to terminate the class.
16058                  * ']]' is very likely to mean a class was intended (but
16059                  * missing the colon), but the warning message that gets
16060                  * generated shows the error position better if we exit the
16061                  * loop at the bottom (eventually), so skip it here. */
16062                 if (*p != ']') {
16063                     if (peek < e && isBLANK(*peek)) {
16064                         has_blank = TRUE;
16065                         found_problem = TRUE;
16066                         do {
16067                             peek++;
16068                         } while (peek < e && isBLANK(*peek));
16069                     }
16070
16071                     if (peek < e && *peek == ']') {
16072                         has_terminating_bracket = TRUE;
16073                         if (*p == ':') {
16074                             has_terminating_colon = TRUE;
16075                         }
16076                         else if (*p == ';') {
16077                             has_semi_colon = TRUE;
16078                             has_terminating_colon = TRUE;
16079                         }
16080                         else {
16081                             found_problem = TRUE;
16082                         }
16083                         p = peek + 1;
16084                         goto try_posix;
16085                     }
16086                 }
16087
16088                 /* Here we have punctuation we thought didn't end the class.
16089                  * Keep track of the position of the key characters that are
16090                  * more likely to have been class-enders */
16091                 if (*p == ']' || *p == '[' || *p == ':' || *p == ';') {
16092
16093                     /* Allow just one such possible class-ender not actually
16094                      * ending the class. */
16095                     if (possible_end) {
16096                         break;
16097                     }
16098                     possible_end = p;
16099                 }
16100
16101                 /* If we have too many punctuation characters, no use in
16102                  * keeping going */
16103                 if (++punct_count > max_distance) {
16104                     break;
16105                 }
16106
16107                 /* Treat the punctuation as a typo. */
16108                 input_text[name_len++] = *p;
16109                 p++;
16110             }
16111             else if (isUPPER(*p)) { /* Use lowercase for lookup */
16112                 input_text[name_len++] = toLOWER(*p);
16113                 has_upper = TRUE;
16114                 found_problem = TRUE;
16115                 p++;
16116             } else if (! UTF || UTF8_IS_INVARIANT(*p)) {
16117                 input_text[name_len++] = *p;
16118                 p++;
16119             }
16120             else {
16121                 input_text[name_len++] = utf8_to_uvchr_buf((U8 *) p, e, NULL);
16122                 p+= UTF8SKIP(p);
16123             }
16124
16125             /* The declaration of 'input_text' is how long we allow a potential
16126              * class name to be, before saying they didn't mean a class name at
16127              * all */
16128             if (name_len >= C_ARRAY_LENGTH(input_text)) {
16129                 break;
16130             }
16131         }
16132
16133         /* We get to here when the possible class name hasn't been properly
16134          * terminated before:
16135          *   1) we ran off the end of the pattern; or
16136          *   2) found two characters, each of which might have been intended to
16137          *      be the name's terminator
16138          *   3) found so many punctuation characters in the purported name,
16139          *      that the edit distance to a valid one is exceeded
16140          *   4) we decided it was more characters than anyone could have
16141          *      intended to be one. */
16142
16143         found_problem = TRUE;
16144
16145         /* In the final two cases, we know that looking up what we've
16146          * accumulated won't lead to a match, even a fuzzy one. */
16147         if (   name_len >= C_ARRAY_LENGTH(input_text)
16148             || punct_count > max_distance)
16149         {
16150             /* If there was an intermediate key character that could have been
16151              * an intended end, redo the parse, but stop there */
16152             if (possible_end && possible_end != (char *) -1) {
16153                 possible_end = (char *) -1; /* Special signal value to say
16154                                                we've done a first pass */
16155                 p = name_start;
16156                 goto parse_name;
16157             }
16158
16159             /* Otherwise, it can't have meant to have been a class */
16160             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
16161         }
16162
16163         /* If we ran off the end, and the final character was a punctuation
16164          * one, back up one, to look at that final one just below.  Later, we
16165          * will restore the parse pointer if appropriate */
16166         if (name_len && p == e && isPUNCT(*(p-1))) {
16167             p--;
16168             name_len--;
16169         }
16170
16171         if (p < e && isPUNCT(*p)) {
16172             if (*p == ']') {
16173                 has_terminating_bracket = TRUE;
16174
16175                 /* If this is a 2nd ']', and the first one is just below this
16176                  * one, consider that to be the real terminator.  This gives a
16177                  * uniform and better positioning for the warning message  */
16178                 if (   possible_end
16179                     && possible_end != (char *) -1
16180                     && *possible_end == ']'
16181                     && name_len && input_text[name_len - 1] == ']')
16182                 {
16183                     name_len--;
16184                     p = possible_end;
16185
16186                     /* And this is actually equivalent to having done the 2nd
16187                      * pass now, so set it to not try again */
16188                     possible_end = (char *) -1;
16189                 }
16190             }
16191             else {
16192                 if (*p == ':') {
16193                     has_terminating_colon = TRUE;
16194                 }
16195                 else if (*p == ';') {
16196                     has_semi_colon = TRUE;
16197                     has_terminating_colon = TRUE;
16198                 }
16199                 p++;
16200             }
16201         }
16202
16203     try_posix:
16204
16205         /* Here, we have a class name to look up.  We can short circuit the
16206          * stuff below for short names that can't possibly be meant to be a
16207          * class name.  (We can do this on the first pass, as any second pass
16208          * will yield an even shorter name) */
16209         if (name_len < 3) {
16210             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
16211         }
16212
16213         /* Find which class it is.  Initially switch on the length of the name.
16214          * */
16215         switch (name_len) {
16216             case 4:
16217                 if (memEQs(name_start, 4, "word")) {
16218                     /* this is not POSIX, this is the Perl \w */
16219                     class_number = ANYOF_WORDCHAR;
16220                 }
16221                 break;
16222             case 5:
16223                 /* Names all of length 5: alnum alpha ascii blank cntrl digit
16224                  *                        graph lower print punct space upper
16225                  * Offset 4 gives the best switch position.  */
16226                 switch (name_start[4]) {
16227                     case 'a':
16228                         if (memBEGINs(name_start, 5, "alph")) /* alpha */
16229                             class_number = ANYOF_ALPHA;
16230                         break;
16231                     case 'e':
16232                         if (memBEGINs(name_start, 5, "spac")) /* space */
16233                             class_number = ANYOF_SPACE;
16234                         break;
16235                     case 'h':
16236                         if (memBEGINs(name_start, 5, "grap")) /* graph */
16237                             class_number = ANYOF_GRAPH;
16238                         break;
16239                     case 'i':
16240                         if (memBEGINs(name_start, 5, "asci")) /* ascii */
16241                             class_number = ANYOF_ASCII;
16242                         break;
16243                     case 'k':
16244                         if (memBEGINs(name_start, 5, "blan")) /* blank */
16245                             class_number = ANYOF_BLANK;
16246                         break;
16247                     case 'l':
16248                         if (memBEGINs(name_start, 5, "cntr")) /* cntrl */
16249                             class_number = ANYOF_CNTRL;
16250                         break;
16251                     case 'm':
16252                         if (memBEGINs(name_start, 5, "alnu")) /* alnum */
16253                             class_number = ANYOF_ALPHANUMERIC;
16254                         break;
16255                     case 'r':
16256                         if (memBEGINs(name_start, 5, "lowe")) /* lower */
16257                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
16258                         else if (memBEGINs(name_start, 5, "uppe")) /* upper */
16259                             class_number = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
16260                         break;
16261                     case 't':
16262                         if (memBEGINs(name_start, 5, "digi")) /* digit */
16263                             class_number = ANYOF_DIGIT;
16264                         else if (memBEGINs(name_start, 5, "prin")) /* print */
16265                             class_number = ANYOF_PRINT;
16266                         else if (memBEGINs(name_start, 5, "punc")) /* punct */
16267                             class_number = ANYOF_PUNCT;
16268                         break;
16269                 }
16270                 break;
16271             case 6:
16272                 if (memEQs(name_start, 6, "xdigit"))
16273                     class_number = ANYOF_XDIGIT;
16274                 break;
16275         }
16276
16277         /* If the name exactly matches a posix class name the class number will
16278          * here be set to it, and the input almost certainly was meant to be a
16279          * posix class, so we can skip further checking.  If instead the syntax
16280          * is exactly correct, but the name isn't one of the legal ones, we
16281          * will return that as an error below.  But if neither of these apply,
16282          * it could be that no posix class was intended at all, or that one
16283          * was, but there was a typo.  We tease these apart by doing fuzzy
16284          * matching on the name */
16285         if (class_number == OOB_NAMEDCLASS && found_problem) {
16286             const UV posix_names[][6] = {
16287                                                 { 'a', 'l', 'n', 'u', 'm' },
16288                                                 { 'a', 'l', 'p', 'h', 'a' },
16289                                                 { 'a', 's', 'c', 'i', 'i' },
16290                                                 { 'b', 'l', 'a', 'n', 'k' },
16291                                                 { 'c', 'n', 't', 'r', 'l' },
16292                                                 { 'd', 'i', 'g', 'i', 't' },
16293                                                 { 'g', 'r', 'a', 'p', 'h' },
16294                                                 { 'l', 'o', 'w', 'e', 'r' },
16295                                                 { 'p', 'r', 'i', 'n', 't' },
16296                                                 { 'p', 'u', 'n', 'c', 't' },
16297                                                 { 's', 'p', 'a', 'c', 'e' },
16298                                                 { 'u', 'p', 'p', 'e', 'r' },
16299                                                 { 'w', 'o', 'r', 'd' },
16300                                                 { 'x', 'd', 'i', 'g', 'i', 't' }
16301                                             };
16302             /* The names of the above all have added NULs to make them the same
16303              * size, so we need to also have the real lengths */
16304             const UV posix_name_lengths[] = {
16305                                                 sizeof("alnum") - 1,
16306                                                 sizeof("alpha") - 1,
16307                                                 sizeof("ascii") - 1,
16308                                                 sizeof("blank") - 1,
16309                                                 sizeof("cntrl") - 1,
16310                                                 sizeof("digit") - 1,
16311                                                 sizeof("graph") - 1,
16312                                                 sizeof("lower") - 1,
16313                                                 sizeof("print") - 1,
16314                                                 sizeof("punct") - 1,
16315                                                 sizeof("space") - 1,
16316                                                 sizeof("upper") - 1,
16317                                                 sizeof("word")  - 1,
16318                                                 sizeof("xdigit")- 1
16319                                             };
16320             unsigned int i;
16321             int temp_max = max_distance;    /* Use a temporary, so if we
16322                                                reparse, we haven't changed the
16323                                                outer one */
16324
16325             /* Use a smaller max edit distance if we are missing one of the
16326              * delimiters */
16327             if (   has_opening_bracket + has_opening_colon < 2
16328                 || has_terminating_bracket + has_terminating_colon < 2)
16329             {
16330                 temp_max--;
16331             }
16332
16333             /* See if the input name is close to a legal one */
16334             for (i = 0; i < C_ARRAY_LENGTH(posix_names); i++) {
16335
16336                 /* Short circuit call if the lengths are too far apart to be
16337                  * able to match */
16338                 if (abs( (int) (name_len - posix_name_lengths[i]))
16339                     > temp_max)
16340                 {
16341                     continue;
16342                 }
16343
16344                 if (edit_distance(input_text,
16345                                   posix_names[i],
16346                                   name_len,
16347                                   posix_name_lengths[i],
16348                                   temp_max
16349                                  )
16350                     > -1)
16351                 { /* If it is close, it probably was intended to be a class */
16352                     goto probably_meant_to_be;
16353                 }
16354             }
16355
16356             /* Here the input name is not close enough to a valid class name
16357              * for us to consider it to be intended to be a posix class.  If
16358              * we haven't already done so, and the parse found a character that
16359              * could have been terminators for the name, but which we absorbed
16360              * as typos during the first pass, repeat the parse, signalling it
16361              * to stop at that character */
16362             if (possible_end && possible_end != (char *) -1) {
16363                 possible_end = (char *) -1;
16364                 p = name_start;
16365                 goto parse_name;
16366             }
16367
16368             /* Here neither pass found a close-enough class name */
16369             CLEAR_POSIX_WARNINGS_AND_RETURN(NOT_MEANT_TO_BE_A_POSIX_CLASS);
16370         }
16371
16372     probably_meant_to_be:
16373
16374         /* Here we think that a posix specification was intended.  Update any
16375          * parse pointer */
16376         if (updated_parse_ptr) {
16377             *updated_parse_ptr = (char *) p;
16378         }
16379
16380         /* If a posix class name was intended but incorrectly specified, we
16381          * output or return the warnings */
16382         if (found_problem) {
16383
16384             /* We set flags for these issues in the parse loop above instead of
16385              * adding them to the list of warnings, because we can parse it
16386              * twice, and we only want one warning instance */
16387             if (has_upper) {
16388                 ADD_POSIX_WARNING(p, "the name must be all lowercase letters");
16389             }
16390             if (has_blank) {
16391                 ADD_POSIX_WARNING(p, NO_BLANKS_POSIX_WARNING);
16392             }
16393             if (has_semi_colon) {
16394                 ADD_POSIX_WARNING(p, SEMI_COLON_POSIX_WARNING);
16395             }
16396             else if (! has_terminating_colon) {
16397                 ADD_POSIX_WARNING(p, "there is no terminating ':'");
16398             }
16399             if (! has_terminating_bracket) {
16400                 ADD_POSIX_WARNING(p, "there is no terminating ']'");
16401             }
16402
16403             if (   posix_warnings
16404                 && RExC_warn_text
16405                 && av_count(RExC_warn_text) > 0)
16406             {
16407                 *posix_warnings = RExC_warn_text;
16408             }
16409         }
16410         else if (class_number != OOB_NAMEDCLASS) {
16411             /* If it is a known class, return the class.  The class number
16412              * #defines are structured so each complement is +1 to the normal
16413              * one */
16414             CLEAR_POSIX_WARNINGS_AND_RETURN(class_number + complement);
16415         }
16416         else if (! check_only) {
16417
16418             /* Here, it is an unrecognized class.  This is an error (unless the
16419             * call is to check only, which we've already handled above) */
16420             const char * const complement_string = (complement)
16421                                                    ? "^"
16422                                                    : "";
16423             RExC_parse = (char *) p;
16424             vFAIL3utf8f("POSIX class [:%s%" UTF8f ":] unknown",
16425                         complement_string,
16426                         UTF8fARG(UTF, RExC_parse - name_start - 2, name_start));
16427         }
16428     }
16429
16430     return OOB_NAMEDCLASS;
16431 }
16432 #undef ADD_POSIX_WARNING
16433
16434 STATIC unsigned  int
16435 S_regex_set_precedence(const U8 my_operator) {
16436
16437     /* Returns the precedence in the (?[...]) construct of the input operator,
16438      * specified by its character representation.  The precedence follows
16439      * general Perl rules, but it extends this so that ')' and ']' have (low)
16440      * precedence even though they aren't really operators */
16441
16442     switch (my_operator) {
16443         case '!':
16444             return 5;
16445         case '&':
16446             return 4;
16447         case '^':
16448         case '|':
16449         case '+':
16450         case '-':
16451             return 3;
16452         case ')':
16453             return 2;
16454         case ']':
16455             return 1;
16456     }
16457
16458     NOT_REACHED; /* NOTREACHED */
16459     return 0;   /* Silence compiler warning */
16460 }
16461
16462 STATIC regnode_offset
16463 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
16464                     I32 *flagp, U32 depth,
16465                     char * const oregcomp_parse)
16466 {
16467     /* Handle the (?[...]) construct to do set operations */
16468
16469     U8 curchar;                     /* Current character being parsed */
16470     UV start, end;                  /* End points of code point ranges */
16471     SV* final = NULL;               /* The end result inversion list */
16472     SV* result_string;              /* 'final' stringified */
16473     AV* stack;                      /* stack of operators and operands not yet
16474                                        resolved */
16475     AV* fence_stack = NULL;         /* A stack containing the positions in
16476                                        'stack' of where the undealt-with left
16477                                        parens would be if they were actually
16478                                        put there */
16479     /* The 'volatile' is a workaround for an optimiser bug
16480      * in Solaris Studio 12.3. See RT #127455 */
16481     volatile IV fence = 0;          /* Position of where most recent undealt-
16482                                        with left paren in stack is; -1 if none.
16483                                      */
16484     STRLEN len;                     /* Temporary */
16485     regnode_offset node;            /* Temporary, and final regnode returned by
16486                                        this function */
16487     const bool save_fold = FOLD;    /* Temporary */
16488     char *save_end, *save_parse;    /* Temporaries */
16489     const bool in_locale = LOC;     /* we turn off /l during processing */
16490
16491     DECLARE_AND_GET_RE_DEBUG_FLAGS;
16492
16493     PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
16494     PERL_UNUSED_ARG(oregcomp_parse); /* Only for Set_Node_Length */
16495
16496     DEBUG_PARSE("xcls");
16497
16498     if (in_locale) {
16499         set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);
16500     }
16501
16502     /* The use of this operator implies /u.  This is required so that the
16503      * compile time values are valid in all runtime cases */
16504     REQUIRE_UNI_RULES(flagp, 0);
16505
16506     ckWARNexperimental(RExC_parse,
16507                        WARN_EXPERIMENTAL__REGEX_SETS,
16508                        "The regex_sets feature is experimental");
16509
16510     /* Everything in this construct is a metacharacter.  Operands begin with
16511      * either a '\' (for an escape sequence), or a '[' for a bracketed
16512      * character class.  Any other character should be an operator, or
16513      * parenthesis for grouping.  Both types of operands are handled by calling
16514      * regclass() to parse them.  It is called with a parameter to indicate to
16515      * return the computed inversion list.  The parsing here is implemented via
16516      * a stack.  Each entry on the stack is a single character representing one
16517      * of the operators; or else a pointer to an operand inversion list. */
16518
16519 #define IS_OPERATOR(a) SvIOK(a)
16520 #define IS_OPERAND(a)  (! IS_OPERATOR(a))
16521
16522     /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
16523      * to luke-a-shave-itch (or -itz), but people who didn't want to bother
16524      * with pronouncing it called it Reverse Polish instead, but now that YOU
16525      * know how to pronounce it you can use the correct term, thus giving due
16526      * credit to the person who invented it, and impressing your geek friends.
16527      * Wikipedia says that the pronounciation of "Ł" has been changing so that
16528      * it is now more like an English initial W (as in wonk) than an L.)
16529      *
16530      * This means that, for example, 'a | b & c' is stored on the stack as
16531      *
16532      * c  [4]
16533      * b  [3]
16534      * &  [2]
16535      * a  [1]
16536      * |  [0]
16537      *
16538      * where the numbers in brackets give the stack [array] element number.
16539      * In this implementation, parentheses are not stored on the stack.
16540      * Instead a '(' creates a "fence" so that the part of the stack below the
16541      * fence is invisible except to the corresponding ')' (this allows us to
16542      * replace testing for parens, by using instead subtraction of the fence
16543      * position).  As new operands are processed they are pushed onto the stack
16544      * (except as noted in the next paragraph).  New operators of higher
16545      * precedence than the current final one are inserted on the stack before
16546      * the lhs operand (so that when the rhs is pushed next, everything will be
16547      * in the correct positions shown above.  When an operator of equal or
16548      * lower precedence is encountered in parsing, all the stacked operations
16549      * of equal or higher precedence are evaluated, leaving the result as the
16550      * top entry on the stack.  This makes higher precedence operations
16551      * evaluate before lower precedence ones, and causes operations of equal
16552      * precedence to left associate.
16553      *
16554      * The only unary operator '!' is immediately pushed onto the stack when
16555      * encountered.  When an operand is encountered, if the top of the stack is
16556      * a '!", the complement is immediately performed, and the '!' popped.  The
16557      * resulting value is treated as a new operand, and the logic in the
16558      * previous paragraph is executed.  Thus in the expression
16559      *      [a] + ! [b]
16560      * the stack looks like
16561      *
16562      * !
16563      * a
16564      * +
16565      *
16566      * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
16567      * becomes
16568      *
16569      * !b
16570      * a
16571      * +
16572      *
16573      * A ')' is treated as an operator with lower precedence than all the
16574      * aforementioned ones, which causes all operations on the stack above the
16575      * corresponding '(' to be evaluated down to a single resultant operand.
16576      * Then the fence for the '(' is removed, and the operand goes through the
16577      * algorithm above, without the fence.
16578      *
16579      * A separate stack is kept of the fence positions, so that the position of
16580      * the latest so-far unbalanced '(' is at the top of it.
16581      *
16582      * The ']' ending the construct is treated as the lowest operator of all,
16583      * so that everything gets evaluated down to a single operand, which is the
16584      * result */
16585
16586     sv_2mortal((SV *)(stack = newAV()));
16587     sv_2mortal((SV *)(fence_stack = newAV()));
16588
16589     while (RExC_parse < RExC_end) {
16590         I32 top_index;              /* Index of top-most element in 'stack' */
16591         SV** top_ptr;               /* Pointer to top 'stack' element */
16592         SV* current = NULL;         /* To contain the current inversion list
16593                                        operand */
16594         SV* only_to_avoid_leaks;
16595
16596         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
16597                                 TRUE /* Force /x */ );
16598         if (RExC_parse >= RExC_end) {   /* Fail */
16599             break;
16600         }
16601
16602         curchar = UCHARAT(RExC_parse);
16603
16604 redo_curchar:
16605
16606 #ifdef ENABLE_REGEX_SETS_DEBUGGING
16607                     /* Enable with -Accflags=-DENABLE_REGEX_SETS_DEBUGGING */
16608         DEBUG_U(dump_regex_sets_structures(pRExC_state,
16609                                            stack, fence, fence_stack));
16610 #endif
16611
16612         top_index = av_tindex_skip_len_mg(stack);
16613
16614         switch (curchar) {
16615             SV** stacked_ptr;       /* Ptr to something already on 'stack' */
16616             char stacked_operator;  /* The topmost operator on the 'stack'. */
16617             SV* lhs;                /* Operand to the left of the operator */
16618             SV* rhs;                /* Operand to the right of the operator */
16619             SV* fence_ptr;          /* Pointer to top element of the fence
16620                                        stack */
16621             case '(':
16622
16623                 if (   RExC_parse < RExC_end - 2
16624                     && UCHARAT(RExC_parse + 1) == '?'
16625                     && UCHARAT(RExC_parse + 2) == '^')
16626                 {
16627                     const regnode_offset orig_emit = RExC_emit;
16628                     SV * resultant_invlist;
16629
16630                     /* If is a '(?^', could be an embedded '(?^flags:(?[...])'.
16631                      * This happens when we have some thing like
16632                      *
16633                      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
16634                      *   ...
16635                      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
16636                      *
16637                      * Here we would be handling the interpolated
16638                      * '$thai_or_lao'.  We handle this by a recursive call to
16639                      * reg which returns the inversion list the
16640                      * interpolated expression evaluates to.  Actually, the
16641                      * return is a special regnode containing a pointer to that
16642                      * inversion list.  If the return isn't that regnode alone,
16643                      * we know that this wasn't such an interpolation, which is
16644                      * an error: we need to get a single inversion list back
16645                      * from the recursion */
16646
16647                     RExC_parse++;
16648                     RExC_sets_depth++;
16649
16650                     node = reg(pRExC_state, 2, flagp, depth+1);
16651                     RETURN_FAIL_ON_RESTART(*flagp, flagp);
16652
16653                     if (   OP(REGNODE_p(node)) != REGEX_SET
16654                            /* If more than a single node returned, the nested
16655                             * parens evaluated to more than just a (?[...]),
16656                             * which isn't legal */
16657                         || RExC_emit != orig_emit
16658                                       + NODE_STEP_REGNODE
16659                                       + regarglen[REGEX_SET])
16660                     {
16661                         vFAIL("Expecting interpolated extended charclass");
16662                     }
16663                     resultant_invlist = (SV *) ARGp(REGNODE_p(node));
16664                     current = invlist_clone(resultant_invlist, NULL);
16665                     SvREFCNT_dec(resultant_invlist);
16666
16667                     RExC_sets_depth--;
16668                     RExC_emit = orig_emit;
16669                     goto handle_operand;
16670                 }
16671
16672                 /* A regular '('.  Look behind for illegal syntax */
16673                 if (top_index - fence >= 0) {
16674                     /* If the top entry on the stack is an operator, it had
16675                      * better be a '!', otherwise the entry below the top
16676                      * operand should be an operator */
16677                     if (   ! (top_ptr = av_fetch(stack, top_index, FALSE))
16678                         || (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) != '!')
16679                         || (   IS_OPERAND(*top_ptr)
16680                             && (   top_index - fence < 1
16681                                 || ! (stacked_ptr = av_fetch(stack,
16682                                                              top_index - 1,
16683                                                              FALSE))
16684                                 || ! IS_OPERATOR(*stacked_ptr))))
16685                     {
16686                         RExC_parse++;
16687                         vFAIL("Unexpected '(' with no preceding operator");
16688                     }
16689                 }
16690
16691                 /* Stack the position of this undealt-with left paren */
16692                 av_push(fence_stack, newSViv(fence));
16693                 fence = top_index + 1;
16694                 break;
16695
16696             case '\\':
16697                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
16698                  * multi-char folds are allowed.  */
16699                 if (!regclass(pRExC_state, flagp, depth+1,
16700                               TRUE, /* means parse just the next thing */
16701                               FALSE, /* don't allow multi-char folds */
16702                               FALSE, /* don't silence non-portable warnings.  */
16703                               TRUE,  /* strict */
16704                               FALSE, /* Require return to be an ANYOF */
16705                               &current))
16706                 {
16707                     RETURN_FAIL_ON_RESTART(*flagp, flagp);
16708                     goto regclass_failed;
16709                 }
16710
16711                 assert(current);
16712
16713                 /* regclass() will return with parsing just the \ sequence,
16714                  * leaving the parse pointer at the next thing to parse */
16715                 RExC_parse--;
16716                 goto handle_operand;
16717
16718             case '[':   /* Is a bracketed character class */
16719             {
16720                 /* See if this is a [:posix:] class. */
16721                 bool is_posix_class = (OOB_NAMEDCLASS
16722                             < handle_possible_posix(pRExC_state,
16723                                                 RExC_parse + 1,
16724                                                 NULL,
16725                                                 NULL,
16726                                                 TRUE /* checking only */));
16727                 /* If it is a posix class, leave the parse pointer at the '['
16728                  * to fool regclass() into thinking it is part of a
16729                  * '[[:posix:]]'. */
16730                 if (! is_posix_class) {
16731                     RExC_parse++;
16732                 }
16733
16734                 /* regclass() can only return RESTART_PARSE and NEED_UTF8 if
16735                  * multi-char folds are allowed.  */
16736                 if (!regclass(pRExC_state, flagp, depth+1,
16737                                 is_posix_class, /* parse the whole char
16738                                                     class only if not a
16739                                                     posix class */
16740                                 FALSE, /* don't allow multi-char folds */
16741                                 TRUE, /* silence non-portable warnings. */
16742                                 TRUE, /* strict */
16743                                 FALSE, /* Require return to be an ANYOF */
16744                                 &current))
16745                 {
16746                     RETURN_FAIL_ON_RESTART(*flagp, flagp);
16747                     goto regclass_failed;
16748                 }
16749
16750                 assert(current);
16751
16752                 /* function call leaves parse pointing to the ']', except if we
16753                  * faked it */
16754                 if (is_posix_class) {
16755                     RExC_parse--;
16756                 }
16757
16758                 goto handle_operand;
16759             }
16760
16761             case ']':
16762                 if (top_index >= 1) {
16763                     goto join_operators;
16764                 }
16765
16766                 /* Only a single operand on the stack: are done */
16767                 goto done;
16768
16769             case ')':
16770                 if (av_tindex_skip_len_mg(fence_stack) < 0) {
16771                     if (UCHARAT(RExC_parse - 1) == ']')  {
16772                         break;
16773                     }
16774                     RExC_parse++;
16775                     vFAIL("Unexpected ')'");
16776                 }
16777
16778                 /* If nothing after the fence, is missing an operand */
16779                 if (top_index - fence < 0) {
16780                     RExC_parse++;
16781                     goto bad_syntax;
16782                 }
16783                 /* If at least two things on the stack, treat this as an
16784                   * operator */
16785                 if (top_index - fence >= 1) {
16786                     goto join_operators;
16787                 }
16788
16789                 /* Here only a single thing on the fenced stack, and there is a
16790                  * fence.  Get rid of it */
16791                 fence_ptr = av_pop(fence_stack);
16792                 assert(fence_ptr);
16793                 fence = SvIV(fence_ptr);
16794                 SvREFCNT_dec_NN(fence_ptr);
16795                 fence_ptr = NULL;
16796
16797                 if (fence < 0) {
16798                     fence = 0;
16799                 }
16800
16801                 /* Having gotten rid of the fence, we pop the operand at the
16802                  * stack top and process it as a newly encountered operand */
16803                 current = av_pop(stack);
16804                 if (IS_OPERAND(current)) {
16805                     goto handle_operand;
16806                 }
16807
16808                 RExC_parse++;
16809                 goto bad_syntax;
16810
16811             case '&':
16812             case '|':
16813             case '+':
16814             case '-':
16815             case '^':
16816
16817                 /* These binary operators should have a left operand already
16818                  * parsed */
16819                 if (   top_index - fence < 0
16820                     || top_index - fence == 1
16821                     || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
16822                     || ! IS_OPERAND(*top_ptr))
16823                 {
16824                     goto unexpected_binary;
16825                 }
16826
16827                 /* If only the one operand is on the part of the stack visible
16828                  * to us, we just place this operator in the proper position */
16829                 if (top_index - fence < 2) {
16830
16831                     /* Place the operator before the operand */
16832
16833                     SV* lhs = av_pop(stack);
16834                     av_push(stack, newSVuv(curchar));
16835                     av_push(stack, lhs);
16836                     break;
16837                 }
16838
16839                 /* But if there is something else on the stack, we need to
16840                  * process it before this new operator if and only if the
16841                  * stacked operation has equal or higher precedence than the
16842                  * new one */
16843
16844              join_operators:
16845
16846                 /* The operator on the stack is supposed to be below both its
16847                  * operands */
16848                 if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
16849                     || IS_OPERAND(*stacked_ptr))
16850                 {
16851                     /* But if not, it's legal and indicates we are completely
16852                      * done if and only if we're currently processing a ']',
16853                      * which should be the final thing in the expression */
16854                     if (curchar == ']') {
16855                         goto done;
16856                     }
16857
16858                   unexpected_binary:
16859                     RExC_parse++;
16860                     vFAIL2("Unexpected binary operator '%c' with no "
16861                            "preceding operand", curchar);
16862                 }
16863                 stacked_operator = (char) SvUV(*stacked_ptr);
16864
16865                 if (regex_set_precedence(curchar)
16866                     > regex_set_precedence(stacked_operator))
16867                 {
16868                     /* Here, the new operator has higher precedence than the
16869                      * stacked one.  This means we need to add the new one to
16870                      * the stack to await its rhs operand (and maybe more
16871                      * stuff).  We put it before the lhs operand, leaving
16872                      * untouched the stacked operator and everything below it
16873                      * */
16874                     lhs = av_pop(stack);
16875                     assert(IS_OPERAND(lhs));
16876
16877                     av_push(stack, newSVuv(curchar));
16878                     av_push(stack, lhs);
16879                     break;
16880                 }
16881
16882                 /* Here, the new operator has equal or lower precedence than
16883                  * what's already there.  This means the operation already
16884                  * there should be performed now, before the new one. */
16885
16886                 rhs = av_pop(stack);
16887                 if (! IS_OPERAND(rhs)) {
16888
16889                     /* This can happen when a ! is not followed by an operand,
16890                      * like in /(?[\t &!])/ */
16891                     goto bad_syntax;
16892                 }
16893
16894                 lhs = av_pop(stack);
16895
16896                 if (! IS_OPERAND(lhs)) {
16897
16898                     /* This can happen when there is an empty (), like in
16899                      * /(?[[0]+()+])/ */
16900                     goto bad_syntax;
16901                 }
16902
16903                 switch (stacked_operator) {
16904                     case '&':
16905                         _invlist_intersection(lhs, rhs, &rhs);
16906                         break;
16907
16908                     case '|':
16909                     case '+':
16910                         _invlist_union(lhs, rhs, &rhs);
16911                         break;
16912
16913                     case '-':
16914                         _invlist_subtract(lhs, rhs, &rhs);
16915                         break;
16916
16917                     case '^':   /* The union minus the intersection */
16918                     {
16919                         SV* i = NULL;
16920                         SV* u = NULL;
16921
16922                         _invlist_union(lhs, rhs, &u);
16923                         _invlist_intersection(lhs, rhs, &i);
16924                         _invlist_subtract(u, i, &rhs);
16925                         SvREFCNT_dec_NN(i);
16926                         SvREFCNT_dec_NN(u);
16927                         break;
16928                     }
16929                 }
16930                 SvREFCNT_dec(lhs);
16931
16932                 /* Here, the higher precedence operation has been done, and the
16933                  * result is in 'rhs'.  We overwrite the stacked operator with
16934                  * the result.  Then we redo this code to either push the new
16935                  * operator onto the stack or perform any higher precedence
16936                  * stacked operation */
16937                 only_to_avoid_leaks = av_pop(stack);
16938                 SvREFCNT_dec(only_to_avoid_leaks);
16939                 av_push(stack, rhs);
16940                 goto redo_curchar;
16941
16942             case '!':   /* Highest priority, right associative */
16943
16944                 /* If what's already at the top of the stack is another '!",
16945                  * they just cancel each other out */
16946                 if (   (top_ptr = av_fetch(stack, top_index, FALSE))
16947                     && (IS_OPERATOR(*top_ptr) && SvUV(*top_ptr) == '!'))
16948                 {
16949                     only_to_avoid_leaks = av_pop(stack);
16950                     SvREFCNT_dec(only_to_avoid_leaks);
16951                 }
16952                 else { /* Otherwise, since it's right associative, just push
16953                           onto the stack */
16954                     av_push(stack, newSVuv(curchar));
16955                 }
16956                 break;
16957
16958             default:
16959                 RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
16960                 if (RExC_parse >= RExC_end) {
16961                     break;
16962                 }
16963                 vFAIL("Unexpected character");
16964
16965           handle_operand:
16966
16967             /* Here 'current' is the operand.  If something is already on the
16968              * stack, we have to check if it is a !.  But first, the code above
16969              * may have altered the stack in the time since we earlier set
16970              * 'top_index'.  */
16971
16972             top_index = av_tindex_skip_len_mg(stack);
16973             if (top_index - fence >= 0) {
16974                 /* If the top entry on the stack is an operator, it had better
16975                  * be a '!', otherwise the entry below the top operand should
16976                  * be an operator */
16977                 top_ptr = av_fetch(stack, top_index, FALSE);
16978                 assert(top_ptr);
16979                 if (IS_OPERATOR(*top_ptr)) {
16980
16981                     /* The only permissible operator at the top of the stack is
16982                      * '!', which is applied immediately to this operand. */
16983                     curchar = (char) SvUV(*top_ptr);
16984                     if (curchar != '!') {
16985                         SvREFCNT_dec(current);
16986                         vFAIL2("Unexpected binary operator '%c' with no "
16987                                 "preceding operand", curchar);
16988                     }
16989
16990                     _invlist_invert(current);
16991
16992                     only_to_avoid_leaks = av_pop(stack);
16993                     SvREFCNT_dec(only_to_avoid_leaks);
16994
16995                     /* And we redo with the inverted operand.  This allows
16996                      * handling multiple ! in a row */
16997                     goto handle_operand;
16998                 }
16999                           /* Single operand is ok only for the non-binary ')'
17000                            * operator */
17001                 else if ((top_index - fence == 0 && curchar != ')')
17002                          || (top_index - fence > 0
17003                              && (! (stacked_ptr = av_fetch(stack,
17004                                                            top_index - 1,
17005                                                            FALSE))
17006                                  || IS_OPERAND(*stacked_ptr))))
17007                 {
17008                     SvREFCNT_dec(current);
17009                     vFAIL("Operand with no preceding operator");
17010                 }
17011             }
17012
17013             /* Here there was nothing on the stack or the top element was
17014              * another operand.  Just add this new one */
17015             av_push(stack, current);
17016
17017         } /* End of switch on next parse token */
17018
17019         RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
17020     } /* End of loop parsing through the construct */
17021
17022     vFAIL("Syntax error in (?[...])");
17023
17024   done:
17025
17026     if (RExC_parse >= RExC_end || RExC_parse[1] != ')') {
17027         if (RExC_parse < RExC_end) {
17028             RExC_parse++;
17029         }
17030
17031         vFAIL("Unexpected ']' with no following ')' in (?[...");
17032     }
17033
17034     if (av_tindex_skip_len_mg(fence_stack) >= 0) {
17035         vFAIL("Unmatched (");
17036     }
17037
17038     if (av_tindex_skip_len_mg(stack) < 0   /* Was empty */
17039         || ((final = av_pop(stack)) == NULL)
17040         || ! IS_OPERAND(final)
17041         || ! is_invlist(final)
17042         || av_tindex_skip_len_mg(stack) >= 0)  /* More left on stack */
17043     {
17044       bad_syntax:
17045         SvREFCNT_dec(final);
17046         vFAIL("Incomplete expression within '(?[ ])'");
17047     }
17048
17049     /* Here, 'final' is the resultant inversion list from evaluating the
17050      * expression.  Return it if so requested */
17051     if (return_invlist) {
17052         *return_invlist = final;
17053         return END;
17054     }
17055
17056     if (RExC_sets_depth) {  /* If within a recursive call, return in a special
17057                                regnode */
17058         RExC_parse++;
17059         node = regpnode(pRExC_state, REGEX_SET, final);
17060     }
17061     else {
17062
17063         /* Otherwise generate a resultant node, based on 'final'.  regclass()
17064          * is expecting a string of ranges and individual code points */
17065         invlist_iterinit(final);
17066         result_string = newSVpvs("");
17067         while (invlist_iternext(final, &start, &end)) {
17068             if (start == end) {
17069                 Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}", start);
17070             }
17071             else {
17072                 Perl_sv_catpvf(aTHX_ result_string, "\\x{%" UVXf "}-\\x{%"
17073                                                         UVXf "}", start, end);
17074             }
17075         }
17076
17077         /* About to generate an ANYOF (or similar) node from the inversion list
17078          * we have calculated */
17079         save_parse = RExC_parse;
17080         RExC_parse = SvPV(result_string, len);
17081         save_end = RExC_end;
17082         RExC_end = RExC_parse + len;
17083         TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE;
17084
17085         /* We turn off folding around the call, as the class we have
17086          * constructed already has all folding taken into consideration, and we
17087          * don't want regclass() to add to that */
17088         RExC_flags &= ~RXf_PMf_FOLD;
17089         /* regclass() can only return RESTART_PARSE and NEED_UTF8 if multi-char
17090          * folds are allowed.  */
17091         node = regclass(pRExC_state, flagp, depth+1,
17092                         FALSE, /* means parse the whole char class */
17093                         FALSE, /* don't allow multi-char folds */
17094                         TRUE, /* silence non-portable warnings.  The above may
17095                                  very well have generated non-portable code
17096                                  points, but they're valid on this machine */
17097                         FALSE, /* similarly, no need for strict */
17098
17099                         /* We can optimize into something besides an ANYOF,
17100                          * except under /l, which needs to be ANYOF because of
17101                          * runtime checks for locale sanity, etc */
17102                     ! in_locale,
17103                         NULL
17104                     );
17105
17106         RESTORE_WARNINGS;
17107         RExC_parse = save_parse + 1;
17108         RExC_end = save_end;
17109         SvREFCNT_dec_NN(final);
17110         SvREFCNT_dec_NN(result_string);
17111
17112         if (save_fold) {
17113             RExC_flags |= RXf_PMf_FOLD;
17114         }
17115
17116         if (!node) {
17117             RETURN_FAIL_ON_RESTART(*flagp, flagp);
17118             goto regclass_failed;
17119         }
17120
17121         /* Fix up the node type if we are in locale.  (We have pretended we are
17122          * under /u for the purposes of regclass(), as this construct will only
17123          * work under UTF-8 locales.  But now we change the opcode to be ANYOFL
17124          * (so as to cause any warnings about bad locales to be output in
17125          * regexec.c), and add the flag that indicates to check if not in a
17126          * UTF-8 locale.  The reason we above forbid optimization into
17127          * something other than an ANYOF node is simply to minimize the number
17128          * of code changes in regexec.c.  Otherwise we would have to create new
17129          * EXACTish node types and deal with them.  This decision could be
17130          * revisited should this construct become popular.
17131          *
17132          * (One might think we could look at the resulting ANYOF node and
17133          * suppress the flag if everything is above 255, as those would be
17134          * UTF-8 only, but this isn't true, as the components that led to that
17135          * result could have been locale-affected, and just happen to cancel
17136          * each other out under UTF-8 locales.) */
17137         if (in_locale) {
17138             set_regex_charset(&RExC_flags, REGEX_LOCALE_CHARSET);
17139
17140             assert(OP(REGNODE_p(node)) == ANYOF);
17141
17142             OP(REGNODE_p(node)) = ANYOFL;
17143             ANYOF_FLAGS(REGNODE_p(node))
17144                     |= ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
17145         }
17146     }
17147
17148     nextchar(pRExC_state);
17149     Set_Node_Length(REGNODE_p(node), RExC_parse - oregcomp_parse + 1); /* MJD */
17150     return node;
17151
17152   regclass_failed:
17153     FAIL2("panic: regclass returned failure to handle_sets, " "flags=%#" UVxf,
17154                                                                 (UV) *flagp);
17155 }
17156
17157 #ifdef ENABLE_REGEX_SETS_DEBUGGING
17158
17159 STATIC void
17160 S_dump_regex_sets_structures(pTHX_ RExC_state_t *pRExC_state,
17161                              AV * stack, const IV fence, AV * fence_stack)
17162 {   /* Dumps the stacks in handle_regex_sets() */
17163
17164     const SSize_t stack_top = av_tindex_skip_len_mg(stack);
17165     const SSize_t fence_stack_top = av_tindex_skip_len_mg(fence_stack);
17166     SSize_t i;
17167
17168     PERL_ARGS_ASSERT_DUMP_REGEX_SETS_STRUCTURES;
17169
17170     PerlIO_printf(Perl_debug_log, "\nParse position is:%s\n", RExC_parse);
17171
17172     if (stack_top < 0) {
17173         PerlIO_printf(Perl_debug_log, "Nothing on stack\n");
17174     }
17175     else {
17176         PerlIO_printf(Perl_debug_log, "Stack: (fence=%d)\n", (int) fence);
17177         for (i = stack_top; i >= 0; i--) {
17178             SV ** element_ptr = av_fetch(stack, i, FALSE);
17179             if (! element_ptr) {
17180             }
17181
17182             if (IS_OPERATOR(*element_ptr)) {
17183                 PerlIO_printf(Perl_debug_log, "[%d]: %c\n",
17184                                             (int) i, (int) SvIV(*element_ptr));
17185             }
17186             else {
17187                 PerlIO_printf(Perl_debug_log, "[%d] ", (int) i);
17188                 sv_dump(*element_ptr);
17189             }
17190         }
17191     }
17192
17193     if (fence_stack_top < 0) {
17194         PerlIO_printf(Perl_debug_log, "Nothing on fence_stack\n");
17195     }
17196     else {
17197         PerlIO_printf(Perl_debug_log, "Fence_stack: \n");
17198         for (i = fence_stack_top; i >= 0; i--) {
17199             SV ** element_ptr = av_fetch(fence_stack, i, FALSE);
17200             if (! element_ptr) {
17201             }
17202
17203             PerlIO_printf(Perl_debug_log, "[%d]: %d\n",
17204                                             (int) i, (int) SvIV(*element_ptr));
17205         }
17206     }
17207 }
17208
17209 #endif
17210
17211 #undef IS_OPERATOR
17212 #undef IS_OPERAND
17213
17214 STATIC void
17215 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
17216 {
17217     /* This adds the Latin1/above-Latin1 folding rules.
17218      *
17219      * This should be called only for a Latin1-range code points, cp, which is
17220      * known to be involved in a simple fold with other code points above
17221      * Latin1.  It would give false results if /aa has been specified.
17222      * Multi-char folds are outside the scope of this, and must be handled
17223      * specially. */
17224
17225     PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
17226
17227     assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
17228
17229     /* The rules that are valid for all Unicode versions are hard-coded in */
17230     switch (cp) {
17231         case 'k':
17232         case 'K':
17233           *invlist =
17234              add_cp_to_invlist(*invlist, KELVIN_SIGN);
17235             break;
17236         case 's':
17237         case 'S':
17238           *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
17239             break;
17240         case MICRO_SIGN:
17241           *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
17242           *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
17243             break;
17244         case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
17245         case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
17246           *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
17247             break;
17248         case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
17249           *invlist = add_cp_to_invlist(*invlist,
17250                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
17251             break;
17252
17253         default:    /* Other code points are checked against the data for the
17254                        current Unicode version */
17255           {
17256             Size_t folds_count;
17257             U32 first_fold;
17258             const U32 * remaining_folds;
17259             UV folded_cp;
17260
17261             if (isASCII(cp)) {
17262                 folded_cp = toFOLD(cp);
17263             }
17264             else {
17265                 U8 dummy_fold[UTF8_MAXBYTES_CASE+1];
17266                 Size_t dummy_len;
17267                 folded_cp = _to_fold_latin1(cp, dummy_fold, &dummy_len, 0);
17268             }
17269
17270             if (folded_cp > 255) {
17271                 *invlist = add_cp_to_invlist(*invlist, folded_cp);
17272             }
17273
17274             folds_count = _inverse_folds(folded_cp, &first_fold,
17275                                                     &remaining_folds);
17276             if (folds_count == 0) {
17277
17278                 /* Use deprecated warning to increase the chances of this being
17279                  * output */
17280                 ckWARN2reg_d(RExC_parse,
17281                         "Perl folding rules are not up-to-date for 0x%02X;"
17282                         " please use the perlbug utility to report;", cp);
17283             }
17284             else {
17285                 unsigned int i;
17286
17287                 if (first_fold > 255) {
17288                     *invlist = add_cp_to_invlist(*invlist, first_fold);
17289                 }
17290                 for (i = 0; i < folds_count - 1; i++) {
17291                     if (remaining_folds[i] > 255) {
17292                         *invlist = add_cp_to_invlist(*invlist,
17293                                                     remaining_folds[i]);
17294                     }
17295                 }
17296             }
17297             break;
17298          }
17299     }
17300 }
17301
17302 STATIC void
17303 S_output_posix_warnings(pTHX_ RExC_state_t *pRExC_state, AV* posix_warnings)
17304 {
17305     /* Output the elements of the array given by '*posix_warnings' as REGEXP
17306      * warnings. */
17307
17308     SV * msg;
17309     const bool first_is_fatal = ckDEAD(packWARN(WARN_REGEXP));
17310
17311     PERL_ARGS_ASSERT_OUTPUT_POSIX_WARNINGS;
17312
17313     if (! TO_OUTPUT_WARNINGS(RExC_parse)) {
17314         CLEAR_POSIX_WARNINGS();
17315         return;
17316     }
17317
17318     while ((msg = av_shift(posix_warnings)) != &PL_sv_undef) {
17319         if (first_is_fatal) {           /* Avoid leaking this */
17320             av_undef(posix_warnings);   /* This isn't necessary if the
17321                                             array is mortal, but is a
17322                                             fail-safe */
17323             (void) sv_2mortal(msg);
17324             PREPARE_TO_DIE;
17325         }
17326         Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s", SvPVX(msg));
17327         SvREFCNT_dec_NN(msg);
17328     }
17329
17330     UPDATE_WARNINGS_LOC(RExC_parse);
17331 }
17332
17333 PERL_STATIC_INLINE Size_t
17334 S_find_first_differing_byte_pos(const U8 * s1, const U8 * s2, const Size_t max)
17335 {
17336     const U8 * const start = s1;
17337     const U8 * const send = start + max;
17338
17339     PERL_ARGS_ASSERT_FIND_FIRST_DIFFERING_BYTE_POS;
17340
17341     while (s1 < send && *s1  == *s2) {
17342         s1++; s2++;
17343     }
17344
17345     return s1 - start;
17346 }
17347
17348
17349 STATIC AV *
17350 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
17351 {
17352     /* This adds the string scalar <multi_string> to the array
17353      * <multi_char_matches>.  <multi_string> is known to have exactly
17354      * <cp_count> code points in it.  This is used when constructing a
17355      * bracketed character class and we find something that needs to match more
17356      * than a single character.
17357      *
17358      * <multi_char_matches> is actually an array of arrays.  Each top-level
17359      * element is an array that contains all the strings known so far that are
17360      * the same length.  And that length (in number of code points) is the same
17361      * as the index of the top-level array.  Hence, the [2] element is an
17362      * array, each element thereof is a string containing TWO code points;
17363      * while element [3] is for strings of THREE characters, and so on.  Since
17364      * this is for multi-char strings there can never be a [0] nor [1] element.
17365      *
17366      * When we rewrite the character class below, we will do so such that the
17367      * longest strings are written first, so that it prefers the longest
17368      * matching strings first.  This is done even if it turns out that any
17369      * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
17370      * Christiansen has agreed that this is ok.  This makes the test for the
17371      * ligature 'ffi' come before the test for 'ff', for example */
17372
17373     AV* this_array;
17374     AV** this_array_ptr;
17375
17376     PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
17377
17378     if (! multi_char_matches) {
17379         multi_char_matches = newAV();
17380     }
17381
17382     if (av_exists(multi_char_matches, cp_count)) {
17383         this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
17384         this_array = *this_array_ptr;
17385     }
17386     else {
17387         this_array = newAV();
17388         av_store(multi_char_matches, cp_count,
17389                  (SV*) this_array);
17390     }
17391     av_push(this_array, multi_string);
17392
17393     return multi_char_matches;
17394 }
17395
17396 /* The names of properties whose definitions are not known at compile time are
17397  * stored in this SV, after a constant heading.  So if the length has been
17398  * changed since initialization, then there is a run-time definition. */
17399 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
17400                                         (SvCUR(listsv) != initial_listsv_len)
17401
17402 /* There is a restricted set of white space characters that are legal when
17403  * ignoring white space in a bracketed character class.  This generates the
17404  * code to skip them.
17405  *
17406  * There is a line below that uses the same white space criteria but is outside
17407  * this macro.  Both here and there must use the same definition */
17408 #define SKIP_BRACKETED_WHITE_SPACE(do_skip, p, stop_p)                  \
17409     STMT_START {                                                        \
17410         if (do_skip) {                                                  \
17411             while (p < stop_p && isBLANK_A(UCHARAT(p)))                 \
17412             {                                                           \
17413                 p++;                                                    \
17414             }                                                           \
17415         }                                                               \
17416     } STMT_END
17417
17418 STATIC regnode_offset
17419 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
17420                  const bool stop_at_1,  /* Just parse the next thing, don't
17421                                            look for a full character class */
17422                  bool allow_mutiple_chars,
17423                  const bool silence_non_portable,   /* Don't output warnings
17424                                                        about too large
17425                                                        characters */
17426                  const bool strict,
17427                  bool optimizable,                  /* ? Allow a non-ANYOF return
17428                                                        node */
17429                  SV** ret_invlist  /* Return an inversion list, not a node */
17430           )
17431 {
17432     /* parse a bracketed class specification.  Most of these will produce an
17433      * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
17434      * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
17435      * under /i with multi-character folds: it will be rewritten following the
17436      * paradigm of this example, where the <multi-fold>s are characters which
17437      * fold to multiple character sequences:
17438      *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
17439      * gets effectively rewritten as:
17440      *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
17441      * reg() gets called (recursively) on the rewritten version, and this
17442      * function will return what it constructs.  (Actually the <multi-fold>s
17443      * aren't physically removed from the [abcdefghi], it's just that they are
17444      * ignored in the recursion by means of a flag:
17445      * <RExC_in_multi_char_class>.)
17446      *
17447      * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
17448      * characters, with the corresponding bit set if that character is in the
17449      * list.  For characters above this, an inversion list is used.  There
17450      * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
17451      * determinable at compile time
17452      *
17453      * On success, returns the offset at which any next node should be placed
17454      * into the regex engine program being compiled.
17455      *
17456      * Returns 0 otherwise, setting flagp to RESTART_PARSE if the parse needs
17457      * to be restarted, or'd with NEED_UTF8 if the pattern needs to be upgraded to
17458      * UTF-8
17459      */
17460
17461     UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
17462     IV range = 0;
17463     UV value = OOB_UNICODE, save_value = OOB_UNICODE;
17464     regnode_offset ret = -1;    /* Initialized to an illegal value */
17465     STRLEN numlen;
17466     int namedclass = OOB_NAMEDCLASS;
17467     char *rangebegin = NULL;
17468     SV *listsv = NULL;      /* List of \p{user-defined} whose definitions
17469                                aren't available at the time this was called */
17470     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
17471                                       than just initialized.  */
17472     SV* properties = NULL;    /* Code points that match \p{} \P{} */
17473     SV* posixes = NULL;     /* Code points that match classes like [:word:],
17474                                extended beyond the Latin1 range.  These have to
17475                                be kept separate from other code points for much
17476                                of this function because their handling  is
17477                                different under /i, and for most classes under
17478                                /d as well */
17479     SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
17480                                separate for a while from the non-complemented
17481                                versions because of complications with /d
17482                                matching */
17483     SV* simple_posixes = NULL; /* But under some conditions, the classes can be
17484                                   treated more simply than the general case,
17485                                   leading to less compilation and execution
17486                                   work */
17487     UV element_count = 0;   /* Number of distinct elements in the class.
17488                                Optimizations may be possible if this is tiny */
17489     AV * multi_char_matches = NULL; /* Code points that fold to more than one
17490                                        character; used under /i */
17491     UV n;
17492     char * stop_ptr = RExC_end;    /* where to stop parsing */
17493
17494     /* ignore unescaped whitespace? */
17495     const bool skip_white = cBOOL(   ret_invlist
17496                                   || (RExC_flags & RXf_PMf_EXTENDED_MORE));
17497
17498     /* inversion list of code points this node matches only when the target
17499      * string is in UTF-8.  These are all non-ASCII, < 256.  (Because is under
17500      * /d) */
17501     SV* upper_latin1_only_utf8_matches = NULL;
17502
17503     /* Inversion list of code points this node matches regardless of things
17504      * like locale, folding, utf8ness of the target string */
17505     SV* cp_list = NULL;
17506
17507     /* Like cp_list, but code points on this list need to be checked for things
17508      * that fold to/from them under /i */
17509     SV* cp_foldable_list = NULL;
17510
17511     /* Like cp_list, but code points on this list are valid only when the
17512      * runtime locale is UTF-8 */
17513     SV* only_utf8_locale_list = NULL;
17514
17515     /* In a range, if one of the endpoints is non-character-set portable,
17516      * meaning that it hard-codes a code point that may mean a different
17517      * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
17518      * mnemonic '\t' which each mean the same character no matter which
17519      * character set the platform is on. */
17520     unsigned int non_portable_endpoint = 0;
17521
17522     /* Is the range unicode? which means on a platform that isn't 1-1 native
17523      * to Unicode (i.e. non-ASCII), each code point in it should be considered
17524      * to be a Unicode value.  */
17525     bool unicode_range = FALSE;
17526     bool invert = FALSE;    /* Is this class to be complemented */
17527
17528     bool warn_super = ALWAYS_WARN_SUPER;
17529
17530     const char * orig_parse = RExC_parse;
17531
17532     /* This variable is used to mark where the end in the input is of something
17533      * that looks like a POSIX construct but isn't.  During the parse, when
17534      * something looks like it could be such a construct is encountered, it is
17535      * checked for being one, but not if we've already checked this area of the
17536      * input.  Only after this position is reached do we check again */
17537     char *not_posix_region_end = RExC_parse - 1;
17538
17539     AV* posix_warnings = NULL;
17540     const bool do_posix_warnings = ckWARN(WARN_REGEXP);
17541     U8 op = ANYOF;    /* The returned node-type, initialized the expected type.
17542                        */
17543     U8 anyof_flags = 0;   /* flag bits if the node is an ANYOF-type */
17544     U32 posixl = 0;       /* bit field of posix classes matched under /l */
17545
17546
17547 /* Flags as to what things aren't knowable until runtime.  (Note that these are
17548  * mutually exclusive.) */
17549 #define HAS_USER_DEFINED_PROPERTY 0x01   /* /u any user-defined properties that
17550                                             haven't been defined as of yet */
17551 #define HAS_D_RUNTIME_DEPENDENCY  0x02   /* /d if the target being matched is
17552                                             UTF-8 or not */
17553 #define HAS_L_RUNTIME_DEPENDENCY   0x04 /* /l what the posix classes match and
17554                                             what gets folded */
17555     U32 has_runtime_dependency = 0;     /* OR of the above flags */
17556
17557     DECLARE_AND_GET_RE_DEBUG_FLAGS;
17558
17559     PERL_ARGS_ASSERT_REGCLASS;
17560 #ifndef DEBUGGING
17561     PERL_UNUSED_ARG(depth);
17562 #endif
17563
17564     assert(! (ret_invlist && allow_mutiple_chars));
17565
17566     /* If wants an inversion list returned, we can't optimize to something
17567      * else. */
17568     if (ret_invlist) {
17569         optimizable = FALSE;
17570     }
17571
17572     DEBUG_PARSE("clas");
17573
17574 #if UNICODE_MAJOR_VERSION < 3 /* no multifolds in early Unicode */      \
17575     || (UNICODE_MAJOR_VERSION == 3 && UNICODE_DOT_VERSION == 0          \
17576                                    && UNICODE_DOT_DOT_VERSION == 0)
17577     allow_mutiple_chars = FALSE;
17578 #endif
17579
17580     /* We include the /i status at the beginning of this so that we can
17581      * know it at runtime */
17582     listsv = sv_2mortal(Perl_newSVpvf(aTHX_ "#%d\n", cBOOL(FOLD)));
17583     initial_listsv_len = SvCUR(listsv);
17584     SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
17585
17586     SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse, RExC_end);
17587
17588     assert(RExC_parse <= RExC_end);
17589
17590     if (UCHARAT(RExC_parse) == '^') {   /* Complement the class */
17591         RExC_parse++;
17592         invert = TRUE;
17593         allow_mutiple_chars = FALSE;
17594         MARK_NAUGHTY(1);
17595         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse, RExC_end);
17596     }
17597
17598     /* Check that they didn't say [:posix:] instead of [[:posix:]] */
17599     if (! ret_invlist && MAYBE_POSIXCC(UCHARAT(RExC_parse))) {
17600         int maybe_class = handle_possible_posix(pRExC_state,
17601                                                 RExC_parse,
17602                                                 &not_posix_region_end,
17603                                                 NULL,
17604                                                 TRUE /* checking only */);
17605         if (maybe_class >= OOB_NAMEDCLASS && do_posix_warnings) {
17606             ckWARN4reg(not_posix_region_end,
17607                     "POSIX syntax [%c %c] belongs inside character classes%s",
17608                     *RExC_parse, *RExC_parse,
17609                     (maybe_class == OOB_NAMEDCLASS)
17610                     ? ((POSIXCC_NOTYET(*RExC_parse))
17611                         ? " (but this one isn't implemented)"
17612                         : " (but this one isn't fully valid)")
17613                     : ""
17614                     );
17615         }
17616     }
17617
17618     /* If the caller wants us to just parse a single element, accomplish this
17619      * by faking the loop ending condition */
17620     if (stop_at_1 && RExC_end > RExC_parse) {
17621         stop_ptr = RExC_parse + 1;
17622     }
17623
17624     /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
17625     if (UCHARAT(RExC_parse) == ']')
17626         goto charclassloop;
17627
17628     while (1) {
17629
17630         if (   posix_warnings
17631             && av_tindex_skip_len_mg(posix_warnings) >= 0
17632             && RExC_parse > not_posix_region_end)
17633         {
17634             /* Warnings about posix class issues are considered tentative until
17635              * we are far enough along in the parse that we can no longer
17636              * change our mind, at which point we output them.  This is done
17637              * each time through the loop so that a later class won't zap them
17638              * before they have been dealt with. */
17639             output_posix_warnings(pRExC_state, posix_warnings);
17640         }
17641
17642         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse, RExC_end);
17643
17644         if  (RExC_parse >= stop_ptr) {
17645             break;
17646         }
17647
17648         if  (UCHARAT(RExC_parse) == ']') {
17649             break;
17650         }
17651
17652       charclassloop:
17653
17654         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
17655         save_value = value;
17656         save_prevvalue = prevvalue;
17657
17658         if (!range) {
17659             rangebegin = RExC_parse;
17660             element_count++;
17661             non_portable_endpoint = 0;
17662         }
17663         if (UTF && ! UTF8_IS_INVARIANT(* RExC_parse)) {
17664             value = utf8n_to_uvchr((U8*)RExC_parse,
17665                                    RExC_end - RExC_parse,
17666                                    &numlen, UTF8_ALLOW_DEFAULT);
17667             RExC_parse += numlen;
17668         }
17669         else
17670             value = UCHARAT(RExC_parse++);
17671
17672         if (value == '[') {
17673             char * posix_class_end;
17674             namedclass = handle_possible_posix(pRExC_state,
17675                                                RExC_parse,
17676                                                &posix_class_end,
17677                                                do_posix_warnings ? &posix_warnings : NULL,
17678                                                FALSE    /* die if error */);
17679             if (namedclass > OOB_NAMEDCLASS) {
17680
17681                 /* If there was an earlier attempt to parse this particular
17682                  * posix class, and it failed, it was a false alarm, as this
17683                  * successful one proves */
17684                 if (   posix_warnings
17685                     && av_tindex_skip_len_mg(posix_warnings) >= 0
17686                     && not_posix_region_end >= RExC_parse
17687                     && not_posix_region_end <= posix_class_end)
17688                 {
17689                     av_undef(posix_warnings);
17690                 }
17691
17692                 RExC_parse = posix_class_end;
17693             }
17694             else if (namedclass == OOB_NAMEDCLASS) {
17695                 not_posix_region_end = posix_class_end;
17696             }
17697             else {
17698                 namedclass = OOB_NAMEDCLASS;
17699             }
17700         }
17701         else if (   RExC_parse - 1 > not_posix_region_end
17702                  && MAYBE_POSIXCC(value))
17703         {
17704             (void) handle_possible_posix(
17705                         pRExC_state,
17706                         RExC_parse - 1,  /* -1 because parse has already been
17707                                             advanced */
17708                         &not_posix_region_end,
17709                         do_posix_warnings ? &posix_warnings : NULL,
17710                         TRUE /* checking only */);
17711         }
17712         else if (  strict && ! skip_white
17713                  && (   _generic_isCC(value, _CC_VERTSPACE)
17714                      || is_VERTWS_cp_high(value)))
17715         {
17716             vFAIL("Literal vertical space in [] is illegal except under /x");
17717         }
17718         else if (value == '\\') {
17719             /* Is a backslash; get the code point of the char after it */
17720
17721             if (RExC_parse >= RExC_end) {
17722                 vFAIL("Unmatched [");
17723             }
17724
17725             if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
17726                 value = utf8n_to_uvchr((U8*)RExC_parse,
17727                                    RExC_end - RExC_parse,
17728                                    &numlen, UTF8_ALLOW_DEFAULT);
17729                 RExC_parse += numlen;
17730             }
17731             else
17732                 value = UCHARAT(RExC_parse++);
17733
17734             /* Some compilers cannot handle switching on 64-bit integer
17735              * values, therefore value cannot be an UV.  Yes, this will
17736              * be a problem later if we want switch on Unicode.
17737              * A similar issue a little bit later when switching on
17738              * namedclass. --jhi */
17739
17740             /* If the \ is escaping white space when white space is being
17741              * skipped, it means that that white space is wanted literally, and
17742              * is already in 'value'.  Otherwise, need to translate the escape
17743              * into what it signifies. */
17744             if (! skip_white || ! isBLANK_A(value)) switch ((I32)value) {
17745                 const char * message;
17746                 U32 packed_warn;
17747                 U8 grok_c_char;
17748
17749             case 'w':   namedclass = ANYOF_WORDCHAR;    break;
17750             case 'W':   namedclass = ANYOF_NWORDCHAR;   break;
17751             case 's':   namedclass = ANYOF_SPACE;       break;
17752             case 'S':   namedclass = ANYOF_NSPACE;      break;
17753             case 'd':   namedclass = ANYOF_DIGIT;       break;
17754             case 'D':   namedclass = ANYOF_NDIGIT;      break;
17755             case 'v':   namedclass = ANYOF_VERTWS;      break;
17756             case 'V':   namedclass = ANYOF_NVERTWS;     break;
17757             case 'h':   namedclass = ANYOF_HORIZWS;     break;
17758             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
17759             case 'N':  /* Handle \N{NAME} in class */
17760                 {
17761                     const char * const backslash_N_beg = RExC_parse - 2;
17762                     int cp_count;
17763
17764                     if (! grok_bslash_N(pRExC_state,
17765                                         NULL,      /* No regnode */
17766                                         &value,    /* Yes single value */
17767                                         &cp_count, /* Multiple code pt count */
17768                                         flagp,
17769                                         strict,
17770                                         depth)
17771                     ) {
17772
17773                         if (*flagp & NEED_UTF8)
17774                             FAIL("panic: grok_bslash_N set NEED_UTF8");
17775
17776                         RETURN_FAIL_ON_RESTART_FLAGP(flagp);
17777
17778                         if (cp_count < 0) {
17779                             vFAIL("\\N in a character class must be a named character: \\N{...}");
17780                         }
17781                         else if (cp_count == 0) {
17782                             ckWARNreg(RExC_parse,
17783                               "Ignoring zero length \\N{} in character class");
17784                         }
17785                         else { /* cp_count > 1 */
17786                             assert(cp_count > 1);
17787                             if (! RExC_in_multi_char_class) {
17788                                 if ( ! allow_mutiple_chars
17789                                     || invert
17790                                     || range
17791                                     || *RExC_parse == '-')
17792                                 {
17793                                     if (strict) {
17794                                         RExC_parse--;
17795                                         vFAIL("\\N{} here is restricted to one character");
17796                                     }
17797                                     ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
17798                                     break; /* <value> contains the first code
17799                                               point. Drop out of the switch to
17800                                               process it */
17801                                 }
17802                                 else {
17803                                     SV * multi_char_N = newSVpvn(backslash_N_beg,
17804                                                  RExC_parse - backslash_N_beg);
17805                                     multi_char_matches
17806                                         = add_multi_match(multi_char_matches,
17807                                                           multi_char_N,
17808                                                           cp_count);
17809                                 }
17810                             }
17811                         } /* End of cp_count != 1 */
17812
17813                         /* This element should not be processed further in this
17814                          * class */
17815                         element_count--;
17816                         value = save_value;
17817                         prevvalue = save_prevvalue;
17818                         continue;   /* Back to top of loop to get next char */
17819                     }
17820
17821                     /* Here, is a single code point, and <value> contains it */
17822                     unicode_range = TRUE;   /* \N{} are Unicode */
17823                 }
17824                 break;
17825             case 'p':
17826             case 'P':
17827                 {
17828                 char *e;
17829
17830                 if (RExC_pm_flags & PMf_WILDCARD) {
17831                     RExC_parse++;
17832                     /* diag_listed_as: Use of %s is not allowed in Unicode
17833                        property wildcard subpatterns in regex; marked by <--
17834                        HERE in m/%s/ */
17835                     vFAIL3("Use of '\\%c%c' is not allowed in Unicode property"
17836                            " wildcard subpatterns", (char) value, *(RExC_parse - 1));
17837                 }
17838
17839                 /* \p means they want Unicode semantics */
17840                 REQUIRE_UNI_RULES(flagp, 0);
17841
17842                 if (RExC_parse >= RExC_end)
17843                     vFAIL2("Empty \\%c", (U8)value);
17844                 if (*RExC_parse == '{') {
17845                     const U8 c = (U8)value;
17846                     e = (char *) memchr(RExC_parse, '}', RExC_end - RExC_parse);
17847                     if (!e) {
17848                         RExC_parse++;
17849                         vFAIL2("Missing right brace on \\%c{}", c);
17850                     }
17851
17852                     RExC_parse++;
17853
17854                     /* White space is allowed adjacent to the braces and after
17855                      * any '^', even when not under /x */
17856                     while (isSPACE(*RExC_parse)) {
17857                          RExC_parse++;
17858                     }
17859
17860                     if (UCHARAT(RExC_parse) == '^') {
17861
17862                         /* toggle.  (The rhs xor gets the single bit that
17863                          * differs between P and p; the other xor inverts just
17864                          * that bit) */
17865                         value ^= 'P' ^ 'p';
17866
17867                         RExC_parse++;
17868                         while (isSPACE(*RExC_parse)) {
17869                             RExC_parse++;
17870                         }
17871                     }
17872
17873                     if (e == RExC_parse)
17874                         vFAIL2("Empty \\%c{}", c);
17875
17876                     n = e - RExC_parse;
17877                     while (isSPACE(*(RExC_parse + n - 1)))
17878                         n--;
17879
17880                 }   /* The \p isn't immediately followed by a '{' */
17881                 else if (! isALPHA(*RExC_parse)) {
17882                     RExC_parse += (UTF)
17883                                   ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
17884                                   : 1;
17885                     vFAIL2("Character following \\%c must be '{' or a "
17886                            "single-character Unicode property name",
17887                            (U8) value);
17888                 }
17889                 else {
17890                     e = RExC_parse;
17891                     n = 1;
17892                 }
17893                 {
17894                     char* name = RExC_parse;
17895
17896                     /* Any message returned about expanding the definition */
17897                     SV* msg = newSVpvs_flags("", SVs_TEMP);
17898
17899                     /* If set TRUE, the property is user-defined as opposed to
17900                      * official Unicode */
17901                     bool user_defined = FALSE;
17902                     AV * strings = NULL;
17903
17904                     SV * prop_definition = parse_uniprop_string(
17905                                             name, n, UTF, FOLD,
17906                                             FALSE, /* This is compile-time */
17907
17908                                             /* We can't defer this defn when
17909                                              * the full result is required in
17910                                              * this call */
17911                                             ! cBOOL(ret_invlist),
17912
17913                                             &strings,
17914                                             &user_defined,
17915                                             msg,
17916                                             0 /* Base level */
17917                                            );
17918                     if (SvCUR(msg)) {   /* Assumes any error causes a msg */
17919                         assert(prop_definition == NULL);
17920                         RExC_parse = e + 1;
17921                         if (SvUTF8(msg)) {  /* msg being UTF-8 makes the whole
17922                                                thing so, or else the display is
17923                                                mojibake */
17924                             RExC_utf8 = TRUE;
17925                         }
17926                         /* diag_listed_as: Can't find Unicode property definition "%s" in regex; marked by <-- HERE in m/%s/ */
17927                         vFAIL2utf8f("%" UTF8f, UTF8fARG(SvUTF8(msg),
17928                                     SvCUR(msg), SvPVX(msg)));
17929                     }
17930
17931                     assert(prop_definition || strings);
17932
17933                     if (strings) {
17934                         if (ret_invlist) {
17935                             if (! prop_definition) {
17936                                 RExC_parse = e + 1;
17937                                 vFAIL("Unicode string properties are not implemented in (?[...])");
17938                             }
17939                             else {
17940                                 ckWARNreg(e + 1,
17941                                     "Using just the single character results"
17942                                     " returned by \\p{} in (?[...])");
17943                             }
17944                         }
17945                         else if (! RExC_in_multi_char_class) {
17946                             if (invert ^ (value == 'P')) {
17947                                 RExC_parse = e + 1;
17948                                 vFAIL("Inverting a character class which contains"
17949                                     " a multi-character sequence is illegal");
17950                             }
17951
17952                             /* For each multi-character string ... */
17953                             while (av_count(strings) > 0) {
17954                                 /* ... Each entry is itself an array of code
17955                                 * points. */
17956                                 AV * this_string = (AV *) av_shift( strings);
17957                                 STRLEN cp_count = av_count(this_string);
17958                                 SV * final = newSV(cp_count * 4);
17959                                 SvPVCLEAR(final);
17960
17961                                 /* Create another string of sequences of \x{...} */
17962                                 while (av_count(this_string) > 0) {
17963                                     SV * character = av_shift(this_string);
17964                                     UV cp = SvUV(character);
17965
17966                                     if (cp > 255) {
17967                                         REQUIRE_UTF8(flagp);
17968                                     }
17969                                     Perl_sv_catpvf(aTHX_ final, "\\x{%" UVXf "}",
17970                                                                         cp);
17971                                     SvREFCNT_dec_NN(character);
17972                                 }
17973                                 SvREFCNT_dec_NN(this_string);
17974
17975                                 /* And add that to the list of such things */
17976                                 multi_char_matches
17977                                             = add_multi_match(multi_char_matches,
17978                                                             final,
17979                                                             cp_count);
17980                             }
17981                         }
17982                         SvREFCNT_dec_NN(strings);
17983                     }
17984
17985                     if (! prop_definition) {    /* If we got only a string,
17986                                                    this iteration didn't really
17987                                                    find a character */
17988                         element_count--;
17989                     }
17990                     else if (! is_invlist(prop_definition)) {
17991
17992                         /* Here, the definition isn't known, so we have gotten
17993                          * returned a string that will be evaluated if and when
17994                          * encountered at runtime.  We add it to the list of
17995                          * such properties, along with whether it should be
17996                          * complemented or not */
17997                         if (value == 'P') {
17998                             sv_catpvs(listsv, "!");
17999                         }
18000                         else {
18001                             sv_catpvs(listsv, "+");
18002                         }
18003                         sv_catsv(listsv, prop_definition);
18004
18005                         has_runtime_dependency |= HAS_USER_DEFINED_PROPERTY;
18006
18007                         /* We don't know yet what this matches, so have to flag
18008                          * it */
18009                         anyof_flags |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
18010                     }
18011                     else {
18012                         assert (prop_definition && is_invlist(prop_definition));
18013
18014                         /* Here we do have the complete property definition
18015                          *
18016                          * Temporary workaround for [perl #133136].  For this
18017                          * precise input that is in the .t that is failing,
18018                          * load utf8.pm, which is what the test wants, so that
18019                          * that .t passes */
18020                         if (     memEQs(RExC_start, e + 1 - RExC_start,
18021                                         "foo\\p{Alnum}")
18022                             && ! hv_common(GvHVn(PL_incgv),
18023                                            NULL,
18024                                            "utf8.pm", sizeof("utf8.pm") - 1,
18025                                            0, HV_FETCH_ISEXISTS, NULL, 0))
18026                         {
18027                             require_pv("utf8.pm");
18028                         }
18029
18030                         if (! user_defined &&
18031                             /* We warn on matching an above-Unicode code point
18032                              * if the match would return true, except don't
18033                              * warn for \p{All}, which has exactly one element
18034                              * = 0 */
18035                             (_invlist_contains_cp(prop_definition, 0x110000)
18036                                 && (! (_invlist_len(prop_definition) == 1
18037                                        && *invlist_array(prop_definition) == 0))))
18038                         {
18039                             warn_super = TRUE;
18040                         }
18041
18042                         /* Invert if asking for the complement */
18043                         if (value == 'P') {
18044                             _invlist_union_complement_2nd(properties,
18045                                                           prop_definition,
18046                                                           &properties);
18047                         }
18048                         else {
18049                             _invlist_union(properties, prop_definition, &properties);
18050                         }
18051                     }
18052                 }
18053
18054                 RExC_parse = e + 1;
18055                 namedclass = ANYOF_UNIPROP;  /* no official name, but it's
18056                                                 named */
18057                 }
18058                 break;
18059             case 'n':   value = '\n';                   break;
18060             case 'r':   value = '\r';                   break;
18061             case 't':   value = '\t';                   break;
18062             case 'f':   value = '\f';                   break;
18063             case 'b':   value = '\b';                   break;
18064             case 'e':   value = ESC_NATIVE;             break;
18065             case 'a':   value = '\a';                   break;
18066             case 'o':
18067                 RExC_parse--;   /* function expects to be pointed at the 'o' */
18068                 if (! grok_bslash_o(&RExC_parse,
18069                                             RExC_end,
18070                                             &value,
18071                                             &message,
18072                                             &packed_warn,
18073                                             strict,
18074                                             cBOOL(range), /* MAX_UV allowed for range
18075                                                       upper limit */
18076                                             UTF))
18077                 {
18078                     vFAIL(message);
18079                 }
18080                 else if (message && TO_OUTPUT_WARNINGS(RExC_parse)) {
18081                     warn_non_literal_string(RExC_parse, packed_warn, message);
18082                 }
18083
18084                 if (value < 256) {
18085                     non_portable_endpoint++;
18086                 }
18087                 break;
18088             case 'x':
18089                 RExC_parse--;   /* function expects to be pointed at the 'x' */
18090                 if (!  grok_bslash_x(&RExC_parse,
18091                                             RExC_end,
18092                                             &value,
18093                                             &message,
18094                                             &packed_warn,
18095                                             strict,
18096                                             cBOOL(range), /* MAX_UV allowed for range
18097                                                       upper limit */
18098                                             UTF))
18099                 {
18100                     vFAIL(message);
18101                 }
18102                 else if (message && TO_OUTPUT_WARNINGS(RExC_parse)) {
18103                     warn_non_literal_string(RExC_parse, packed_warn, message);
18104                 }
18105
18106                 if (value < 256) {
18107                     non_portable_endpoint++;
18108                 }
18109                 break;
18110             case 'c':
18111                 if (! grok_bslash_c(*RExC_parse, &grok_c_char, &message,
18112                                                                 &packed_warn))
18113                 {
18114                     /* going to die anyway; point to exact spot of
18115                         * failure */
18116                     RExC_parse += (UTF)
18117                                   ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
18118                                   : 1;
18119                     vFAIL(message);
18120                 }
18121
18122                 value = grok_c_char;
18123                 RExC_parse++;
18124                 if (message && TO_OUTPUT_WARNINGS(RExC_parse)) {
18125                     warn_non_literal_string(RExC_parse, packed_warn, message);
18126                 }
18127
18128                 non_portable_endpoint++;
18129                 break;
18130             case '0': case '1': case '2': case '3': case '4':
18131             case '5': case '6': case '7':
18132                 {
18133                     /* Take 1-3 octal digits */
18134                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT
18135                               | PERL_SCAN_NOTIFY_ILLDIGIT;
18136                     numlen = (strict) ? 4 : 3;
18137                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
18138                     RExC_parse += numlen;
18139                     if (numlen != 3) {
18140                         if (strict) {
18141                             RExC_parse += (UTF)
18142                                           ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
18143                                           : 1;
18144                             vFAIL("Need exactly 3 octal digits");
18145                         }
18146                         else if (  (flags & PERL_SCAN_NOTIFY_ILLDIGIT)
18147                                  && RExC_parse < RExC_end
18148                                  && isDIGIT(*RExC_parse)
18149                                  && ckWARN(WARN_REGEXP))
18150                         {
18151                             reg_warn_non_literal_string(
18152                                  RExC_parse + 1,
18153                                  form_alien_digit_msg(8, numlen, RExC_parse,
18154                                                         RExC_end, UTF, FALSE));
18155                         }
18156                     }
18157                     if (value < 256) {
18158                         non_portable_endpoint++;
18159                     }
18160                     break;
18161                 }
18162             default:
18163                 /* Allow \_ to not give an error */
18164                 if (isWORDCHAR(value) && value != '_') {
18165                     if (strict) {
18166                         vFAIL2("Unrecognized escape \\%c in character class",
18167                                (int)value);
18168                     }
18169                     else {
18170                         ckWARN2reg(RExC_parse,
18171                             "Unrecognized escape \\%c in character class passed through",
18172                             (int)value);
18173                     }
18174                 }
18175                 break;
18176             }   /* End of switch on char following backslash */
18177         } /* end of handling backslash escape sequences */
18178
18179         /* Here, we have the current token in 'value' */
18180
18181         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
18182             U8 classnum;
18183
18184             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
18185              * literal, as is the character that began the false range, i.e.
18186              * the 'a' in the examples */
18187             if (range) {
18188                 const int w = (RExC_parse >= rangebegin)
18189                                 ? RExC_parse - rangebegin
18190                                 : 0;
18191                 if (strict) {
18192                     vFAIL2utf8f(
18193                         "False [] range \"%" UTF8f "\"",
18194                         UTF8fARG(UTF, w, rangebegin));
18195                 }
18196                 else {
18197                     ckWARN2reg(RExC_parse,
18198                         "False [] range \"%" UTF8f "\"",
18199                         UTF8fARG(UTF, w, rangebegin));
18200                     cp_list = add_cp_to_invlist(cp_list, '-');
18201                     cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
18202                                                             prevvalue);
18203                 }
18204
18205                 range = 0; /* this was not a true range */
18206                 element_count += 2; /* So counts for three values */
18207             }
18208
18209             classnum = namedclass_to_classnum(namedclass);
18210
18211             if (LOC && namedclass < ANYOF_POSIXL_MAX
18212 #ifndef HAS_ISASCII
18213                 && classnum != _CC_ASCII
18214 #endif
18215             ) {
18216                 SV* scratch_list = NULL;
18217
18218                 /* What the Posix classes (like \w, [:space:]) match isn't
18219                  * generally knowable under locale until actual match time.  A
18220                  * special node is used for these which has extra space for a
18221                  * bitmap, with a bit reserved for each named class that is to
18222                  * be matched against.  (This isn't needed for \p{} and
18223                  * pseudo-classes, as they are not affected by locale, and
18224                  * hence are dealt with separately.)  However, if a named class
18225                  * and its complement are both present, then it matches
18226                  * everything, and there is no runtime dependency.  Odd numbers
18227                  * are the complements of the next lower number, so xor works.
18228                  * (Note that something like [\w\D] should match everything,
18229                  * because \d should be a proper subset of \w.  But rather than
18230                  * trust that the locale is well behaved, we leave this to
18231                  * runtime to sort out) */
18232                 if (POSIXL_TEST(posixl, namedclass ^ 1)) {
18233                     cp_list = _add_range_to_invlist(cp_list, 0, UV_MAX);
18234                     POSIXL_ZERO(posixl);
18235                     has_runtime_dependency &= ~HAS_L_RUNTIME_DEPENDENCY;
18236                     anyof_flags &= ~ANYOF_MATCHES_POSIXL;
18237                     continue;   /* We could ignore the rest of the class, but
18238                                    best to parse it for any errors */
18239                 }
18240                 else { /* Here, isn't the complement of any already parsed
18241                           class */
18242                     POSIXL_SET(posixl, namedclass);
18243                     has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
18244                     anyof_flags |= ANYOF_MATCHES_POSIXL;
18245
18246                     /* The above-Latin1 characters are not subject to locale
18247                      * rules.  Just add them to the unconditionally-matched
18248                      * list */
18249
18250                     /* Get the list of the above-Latin1 code points this
18251                      * matches */
18252                     _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
18253                                             PL_XPosix_ptrs[classnum],
18254
18255                                             /* Odd numbers are complements,
18256                                              * like NDIGIT, NASCII, ... */
18257                                             namedclass % 2 != 0,
18258                                             &scratch_list);
18259                     /* Checking if 'cp_list' is NULL first saves an extra
18260                      * clone.  Its reference count will be decremented at the
18261                      * next union, etc, or if this is the only instance, at the
18262                      * end of the routine */
18263                     if (! cp_list) {
18264                         cp_list = scratch_list;
18265                     }
18266                     else {
18267                         _invlist_union(cp_list, scratch_list, &cp_list);
18268                         SvREFCNT_dec_NN(scratch_list);
18269                     }
18270                     continue;   /* Go get next character */
18271                 }
18272             }
18273             else {
18274
18275                 /* Here, is not /l, or is a POSIX class for which /l doesn't
18276                  * matter (or is a Unicode property, which is skipped here). */
18277                 if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
18278                     if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
18279
18280                         /* Here, should be \h, \H, \v, or \V.  None of /d, /i
18281                          * nor /l make a difference in what these match,
18282                          * therefore we just add what they match to cp_list. */
18283                         if (classnum != _CC_VERTSPACE) {
18284                             assert(   namedclass == ANYOF_HORIZWS
18285                                    || namedclass == ANYOF_NHORIZWS);
18286
18287                             /* It turns out that \h is just a synonym for
18288                              * XPosixBlank */
18289                             classnum = _CC_BLANK;
18290                         }
18291
18292                         _invlist_union_maybe_complement_2nd(
18293                                 cp_list,
18294                                 PL_XPosix_ptrs[classnum],
18295                                 namedclass % 2 != 0,    /* Complement if odd
18296                                                           (NHORIZWS, NVERTWS)
18297                                                         */
18298                                 &cp_list);
18299                     }
18300                 }
18301                 else if (   AT_LEAST_UNI_SEMANTICS
18302                          || classnum == _CC_ASCII
18303                          || (DEPENDS_SEMANTICS && (   classnum == _CC_DIGIT
18304                                                    || classnum == _CC_XDIGIT)))
18305                 {
18306                     /* We usually have to worry about /d affecting what POSIX
18307                      * classes match, with special code needed because we won't
18308                      * know until runtime what all matches.  But there is no
18309                      * extra work needed under /u and /a; and [:ascii:] is
18310                      * unaffected by /d; and :digit: and :xdigit: don't have
18311                      * runtime differences under /d.  So we can special case
18312                      * these, and avoid some extra work below, and at runtime.
18313                      * */
18314                     _invlist_union_maybe_complement_2nd(
18315                                                      simple_posixes,
18316                                                       ((AT_LEAST_ASCII_RESTRICTED)
18317                                                        ? PL_Posix_ptrs[classnum]
18318                                                        : PL_XPosix_ptrs[classnum]),
18319                                                      namedclass % 2 != 0,
18320                                                      &simple_posixes);
18321                 }
18322                 else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
18323                            complement and use nposixes */
18324                     SV** posixes_ptr = namedclass % 2 == 0
18325                                        ? &posixes
18326                                        : &nposixes;
18327                     _invlist_union_maybe_complement_2nd(
18328                                                      *posixes_ptr,
18329                                                      PL_XPosix_ptrs[classnum],
18330                                                      namedclass % 2 != 0,
18331                                                      posixes_ptr);
18332                 }
18333             }
18334         } /* end of namedclass \blah */
18335
18336         SKIP_BRACKETED_WHITE_SPACE(skip_white, RExC_parse, RExC_end);
18337
18338         /* If 'range' is set, 'value' is the ending of a range--check its
18339          * validity.  (If value isn't a single code point in the case of a
18340          * range, we should have figured that out above in the code that
18341          * catches false ranges).  Later, we will handle each individual code
18342          * point in the range.  If 'range' isn't set, this could be the
18343          * beginning of a range, so check for that by looking ahead to see if
18344          * the next real character to be processed is the range indicator--the
18345          * minus sign */
18346
18347         if (range) {
18348 #ifdef EBCDIC
18349             /* For unicode ranges, we have to test that the Unicode as opposed
18350              * to the native values are not decreasing.  (Above 255, there is
18351              * no difference between native and Unicode) */
18352             if (unicode_range && prevvalue < 255 && value < 255) {
18353                 if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
18354                     goto backwards_range;
18355                 }
18356             }
18357             else
18358 #endif
18359             if (prevvalue > value) /* b-a */ {
18360                 int w;
18361 #ifdef EBCDIC
18362               backwards_range:
18363 #endif
18364                 w = RExC_parse - rangebegin;
18365                 vFAIL2utf8f(
18366                     "Invalid [] range \"%" UTF8f "\"",
18367                     UTF8fARG(UTF, w, rangebegin));
18368                 NOT_REACHED; /* NOTREACHED */
18369             }
18370         }
18371         else {
18372             prevvalue = value; /* save the beginning of the potential range */
18373             if (! stop_at_1     /* Can't be a range if parsing just one thing */
18374                 && *RExC_parse == '-')
18375             {
18376                 char* next_char_ptr = RExC_parse + 1;
18377
18378                 /* Get the next real char after the '-' */
18379                 SKIP_BRACKETED_WHITE_SPACE(skip_white, next_char_ptr, RExC_end);
18380
18381                 /* If the '-' is at the end of the class (just before the ']',
18382                  * it is a literal minus; otherwise it is a range */
18383                 if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
18384                     RExC_parse = next_char_ptr;
18385
18386                     /* a bad range like \w-, [:word:]- ? */
18387                     if (namedclass > OOB_NAMEDCLASS) {
18388                         if (strict || ckWARN(WARN_REGEXP)) {
18389                             const int w = RExC_parse >= rangebegin
18390                                           ?  RExC_parse - rangebegin
18391                                           : 0;
18392                             if (strict) {
18393                                 vFAIL4("False [] range \"%*.*s\"",
18394                                     w, w, rangebegin);
18395                             }
18396                             else {
18397                                 vWARN4(RExC_parse,
18398                                     "False [] range \"%*.*s\"",
18399                                     w, w, rangebegin);
18400                             }
18401                         }
18402                         cp_list = add_cp_to_invlist(cp_list, '-');
18403                         element_count++;
18404                     } else
18405                         range = 1;      /* yeah, it's a range! */
18406                     continue;   /* but do it the next time */
18407                 }
18408             }
18409         }
18410
18411         if (namedclass > OOB_NAMEDCLASS) {
18412             continue;
18413         }
18414
18415         /* Here, we have a single value this time through the loop, and
18416          * <prevvalue> is the beginning of the range, if any; or <value> if
18417          * not. */
18418
18419         /* non-Latin1 code point implies unicode semantics. */
18420         if (value > 255) {
18421             if (value > MAX_LEGAL_CP && (   value != UV_MAX
18422                                          || prevvalue > MAX_LEGAL_CP))
18423             {
18424                 vFAIL(form_cp_too_large_msg(16, NULL, 0, value));
18425             }
18426             REQUIRE_UNI_RULES(flagp, 0);
18427             if (  ! silence_non_portable
18428                 &&  UNICODE_IS_PERL_EXTENDED(value)
18429                 &&  TO_OUTPUT_WARNINGS(RExC_parse))
18430             {
18431                 ckWARN2_non_literal_string(RExC_parse,
18432                                            packWARN(WARN_PORTABLE),
18433                                            PL_extended_cp_format,
18434                                            value);
18435             }
18436         }
18437
18438         /* Ready to process either the single value, or the completed range.
18439          * For single-valued non-inverted ranges, we consider the possibility
18440          * of multi-char folds.  (We made a conscious decision to not do this
18441          * for the other cases because it can often lead to non-intuitive
18442          * results.  For example, you have the peculiar case that:
18443          *  "s s" =~ /^[^\xDF]+$/i => Y
18444          *  "ss"  =~ /^[^\xDF]+$/i => N
18445          *
18446          * See [perl #89750] */
18447         if (FOLD && allow_mutiple_chars && value == prevvalue) {
18448             if (    value == LATIN_SMALL_LETTER_SHARP_S
18449                 || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
18450                                                         value)))
18451             {
18452                 /* Here <value> is indeed a multi-char fold.  Get what it is */
18453
18454                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
18455                 STRLEN foldlen;
18456
18457                 UV folded = _to_uni_fold_flags(
18458                                 value,
18459                                 foldbuf,
18460                                 &foldlen,
18461                                 FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
18462                                                    ? FOLD_FLAGS_NOMIX_ASCII
18463                                                    : 0)
18464                                 );
18465
18466                 /* Here, <folded> should be the first character of the
18467                  * multi-char fold of <value>, with <foldbuf> containing the
18468                  * whole thing.  But, if this fold is not allowed (because of
18469                  * the flags), <fold> will be the same as <value>, and should
18470                  * be processed like any other character, so skip the special
18471                  * handling */
18472                 if (folded != value) {
18473
18474                     /* Skip if we are recursed, currently parsing the class
18475                      * again.  Otherwise add this character to the list of
18476                      * multi-char folds. */
18477                     if (! RExC_in_multi_char_class) {
18478                         STRLEN cp_count = utf8_length(foldbuf,
18479                                                       foldbuf + foldlen);
18480                         SV* multi_fold = sv_2mortal(newSVpvs(""));
18481
18482                         Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%" UVXf "}", value);
18483
18484                         multi_char_matches
18485                                         = add_multi_match(multi_char_matches,
18486                                                           multi_fold,
18487                                                           cp_count);
18488
18489                     }
18490
18491                     /* This element should not be processed further in this
18492                      * class */
18493                     element_count--;
18494                     value = save_value;
18495                     prevvalue = save_prevvalue;
18496                     continue;
18497                 }
18498             }
18499         }
18500
18501         if (strict && ckWARN(WARN_REGEXP)) {
18502             if (range) {
18503
18504                 /* If the range starts above 255, everything is portable and
18505                  * likely to be so for any forseeable character set, so don't
18506                  * warn. */
18507                 if (unicode_range && non_portable_endpoint && prevvalue < 256) {
18508                     vWARN(RExC_parse, "Both or neither range ends should be Unicode");
18509                 }
18510                 else if (prevvalue != value) {
18511
18512                     /* Under strict, ranges that stop and/or end in an ASCII
18513                      * printable should have each end point be a portable value
18514                      * for it (preferably like 'A', but we don't warn if it is
18515                      * a (portable) Unicode name or code point), and the range
18516                      * must be all digits or all letters of the same case.
18517                      * Otherwise, the range is non-portable and unclear as to
18518                      * what it contains */
18519                     if (             (isPRINT_A(prevvalue) || isPRINT_A(value))
18520                         && (          non_portable_endpoint
18521                             || ! (   (isDIGIT_A(prevvalue) && isDIGIT_A(value))
18522                                   || (isLOWER_A(prevvalue) && isLOWER_A(value))
18523                                   || (isUPPER_A(prevvalue) && isUPPER_A(value))
18524                     ))) {
18525                         vWARN(RExC_parse, "Ranges of ASCII printables should"
18526                                           " be some subset of \"0-9\","
18527                                           " \"A-Z\", or \"a-z\"");
18528                     }
18529                     else if (prevvalue >= FIRST_NON_ASCII_DECIMAL_DIGIT) {
18530                         SSize_t index_start;
18531                         SSize_t index_final;
18532
18533                         /* But the nature of Unicode and languages mean we
18534                          * can't do the same checks for above-ASCII ranges,
18535                          * except in the case of digit ones.  These should
18536                          * contain only digits from the same group of 10.  The
18537                          * ASCII case is handled just above.  Hence here, the
18538                          * range could be a range of digits.  First some
18539                          * unlikely special cases.  Grandfather in that a range
18540                          * ending in 19DA (NEW TAI LUE THAM DIGIT ONE) is bad
18541                          * if its starting value is one of the 10 digits prior
18542                          * to it.  This is because it is an alternate way of
18543                          * writing 19D1, and some people may expect it to be in
18544                          * that group.  But it is bad, because it won't give
18545                          * the expected results.  In Unicode 5.2 it was
18546                          * considered to be in that group (of 11, hence), but
18547                          * this was fixed in the next version */
18548
18549                         if (UNLIKELY(value == 0x19DA && prevvalue >= 0x19D0)) {
18550                             goto warn_bad_digit_range;
18551                         }
18552                         else if (UNLIKELY(   prevvalue >= 0x1D7CE
18553                                           &&     value <= 0x1D7FF))
18554                         {
18555                             /* This is the only other case currently in Unicode
18556                              * where the algorithm below fails.  The code
18557                              * points just above are the end points of a single
18558                              * range containing only decimal digits.  It is 5
18559                              * different series of 0-9.  All other ranges of
18560                              * digits currently in Unicode are just a single
18561                              * series.  (And mktables will notify us if a later
18562                              * Unicode version breaks this.)
18563                              *
18564                              * If the range being checked is at most 9 long,
18565                              * and the digit values represented are in
18566                              * numerical order, they are from the same series.
18567                              * */
18568                             if (         value - prevvalue > 9
18569                                 ||    (((    value - 0x1D7CE) % 10)
18570                                      <= (prevvalue - 0x1D7CE) % 10))
18571                             {
18572                                 goto warn_bad_digit_range;
18573                             }
18574                         }
18575                         else {
18576
18577                             /* For all other ranges of digits in Unicode, the
18578                              * algorithm is just to check if both end points
18579                              * are in the same series, which is the same range.
18580                              * */
18581                             index_start = _invlist_search(
18582                                                     PL_XPosix_ptrs[_CC_DIGIT],
18583                                                     prevvalue);
18584
18585                             /* Warn if the range starts and ends with a digit,
18586                              * and they are not in the same group of 10. */
18587                             if (   index_start >= 0
18588                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_start)
18589                                 && (index_final =
18590                                     _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
18591                                                     value)) != index_start
18592                                 && index_final >= 0
18593                                 && ELEMENT_RANGE_MATCHES_INVLIST(index_final))
18594                             {
18595                               warn_bad_digit_range:
18596                                 vWARN(RExC_parse, "Ranges of digits should be"
18597                                                   " from the same group of"
18598                                                   " 10");
18599                             }
18600                         }
18601                     }
18602                 }
18603             }
18604             if ((! range || prevvalue == value) && non_portable_endpoint) {
18605                 if (isPRINT_A(value)) {
18606                     char literal[3];
18607                     unsigned d = 0;
18608                     if (isBACKSLASHED_PUNCT(value)) {
18609                         literal[d++] = '\\';
18610                     }
18611                     literal[d++] = (char) value;
18612                     literal[d++] = '\0';
18613
18614                     vWARN4(RExC_parse,
18615                            "\"%.*s\" is more clearly written simply as \"%s\"",
18616                            (int) (RExC_parse - rangebegin),
18617                            rangebegin,
18618                            literal
18619                         );
18620                 }
18621                 else if (isMNEMONIC_CNTRL(value)) {
18622                     vWARN4(RExC_parse,
18623                            "\"%.*s\" is more clearly written simply as \"%s\"",
18624                            (int) (RExC_parse - rangebegin),
18625                            rangebegin,
18626                            cntrl_to_mnemonic((U8) value)
18627                         );
18628                 }
18629             }
18630         }
18631
18632         /* Deal with this element of the class */
18633
18634 #ifndef EBCDIC
18635         cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
18636                                                     prevvalue, value);
18637 #else
18638         /* On non-ASCII platforms, for ranges that span all of 0..255, and ones
18639          * that don't require special handling, we can just add the range like
18640          * we do for ASCII platforms */
18641         if ((UNLIKELY(prevvalue == 0) && value >= 255)
18642             || ! (prevvalue < 256
18643                     && (unicode_range
18644                         || (! non_portable_endpoint
18645                             && ((isLOWER_A(prevvalue) && isLOWER_A(value))
18646                                 || (isUPPER_A(prevvalue)
18647                                     && isUPPER_A(value)))))))
18648         {
18649             cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
18650                                                         prevvalue, value);
18651         }
18652         else {
18653             /* Here, requires special handling.  This can be because it is a
18654              * range whose code points are considered to be Unicode, and so
18655              * must be individually translated into native, or because its a
18656              * subrange of 'A-Z' or 'a-z' which each aren't contiguous in
18657              * EBCDIC, but we have defined them to include only the "expected"
18658              * upper or lower case ASCII alphabetics.  Subranges above 255 are
18659              * the same in native and Unicode, so can be added as a range */
18660             U8 start = NATIVE_TO_LATIN1(prevvalue);
18661             unsigned j;
18662             U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
18663             for (j = start; j <= end; j++) {
18664                 cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
18665             }
18666             if (value > 255) {
18667                 cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
18668                                                             256, value);
18669             }
18670         }
18671 #endif
18672
18673         range = 0; /* this range (if it was one) is done now */
18674     } /* End of loop through all the text within the brackets */
18675
18676     if (   posix_warnings && av_tindex_skip_len_mg(posix_warnings) >= 0) {
18677         output_posix_warnings(pRExC_state, posix_warnings);
18678     }
18679
18680     /* If anything in the class expands to more than one character, we have to
18681      * deal with them by building up a substitute parse string, and recursively
18682      * calling reg() on it, instead of proceeding */
18683     if (multi_char_matches) {
18684         SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
18685         I32 cp_count;
18686         STRLEN len;
18687         char *save_end = RExC_end;
18688         char *save_parse = RExC_parse;
18689         char *save_start = RExC_start;
18690         Size_t constructed_prefix_len = 0; /* This gives the length of the
18691                                               constructed portion of the
18692                                               substitute parse. */
18693         bool first_time = TRUE;     /* First multi-char occurrence doesn't get
18694                                        a "|" */
18695         I32 reg_flags;
18696
18697         assert(! invert);
18698         /* Only one level of recursion allowed */
18699         assert(RExC_copy_start_in_constructed == RExC_precomp);
18700
18701 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
18702            because too confusing */
18703         if (invert) {
18704             sv_catpvs(substitute_parse, "(?:");
18705         }
18706 #endif
18707
18708         /* Look at the longest strings first */
18709         for (cp_count = av_tindex_skip_len_mg(multi_char_matches);
18710                         cp_count > 0;
18711                         cp_count--)
18712         {
18713
18714             if (av_exists(multi_char_matches, cp_count)) {
18715                 AV** this_array_ptr;
18716                 SV* this_sequence;
18717
18718                 this_array_ptr = (AV**) av_fetch(multi_char_matches,
18719                                                  cp_count, FALSE);
18720                 while ((this_sequence = av_pop(*this_array_ptr)) !=
18721                                                                 &PL_sv_undef)
18722                 {
18723                     if (! first_time) {
18724                         sv_catpvs(substitute_parse, "|");
18725                     }
18726                     first_time = FALSE;
18727
18728                     sv_catpv(substitute_parse, SvPVX(this_sequence));
18729                 }
18730             }
18731         }
18732
18733         /* If the character class contains anything else besides these
18734          * multi-character strings, have to include it in recursive parsing */
18735         if (element_count) {
18736             bool has_l_bracket = orig_parse > RExC_start && *(orig_parse - 1) == '[';
18737
18738             sv_catpvs(substitute_parse, "|");
18739             if (has_l_bracket) {    /* Add an [ if the original had one */
18740                 sv_catpvs(substitute_parse, "[");
18741             }
18742             constructed_prefix_len = SvCUR(substitute_parse);
18743             sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
18744
18745             /* Put in a closing ']' to match any opening one, but not if going
18746              * off the end, as otherwise we are adding something that really
18747              * isn't there */
18748             if (has_l_bracket && RExC_parse < RExC_end) {
18749                 sv_catpvs(substitute_parse, "]");
18750             }
18751         }
18752
18753         sv_catpvs(substitute_parse, ")");
18754 #if 0
18755         if (invert) {
18756             /* This is a way to get the parse to skip forward a whole named
18757              * sequence instead of matching the 2nd character when it fails the
18758              * first */
18759             sv_catpvs(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
18760         }
18761 #endif
18762
18763         /* Set up the data structure so that any errors will be properly
18764          * reported.  See the comments at the definition of
18765          * REPORT_LOCATION_ARGS for details */
18766         RExC_copy_start_in_input = (char *) orig_parse;
18767         RExC_start = RExC_parse = SvPV(substitute_parse, len);
18768         RExC_copy_start_in_constructed = RExC_start + constructed_prefix_len;
18769         RExC_end = RExC_parse + len;
18770         RExC_in_multi_char_class = 1;
18771
18772         ret = reg(pRExC_state, 1, &reg_flags, depth+1);
18773
18774         *flagp |= reg_flags & (HASWIDTH|SIMPLE|POSTPONED|RESTART_PARSE|NEED_UTF8);
18775
18776         /* And restore so can parse the rest of the pattern */
18777         RExC_parse = save_parse;
18778         RExC_start = RExC_copy_start_in_constructed = RExC_copy_start_in_input = save_start;
18779         RExC_end = save_end;
18780         RExC_in_multi_char_class = 0;
18781         SvREFCNT_dec_NN(multi_char_matches);
18782         SvREFCNT_dec(properties);
18783         SvREFCNT_dec(cp_list);
18784         SvREFCNT_dec(simple_posixes);
18785         SvREFCNT_dec(posixes);
18786         SvREFCNT_dec(nposixes);
18787         SvREFCNT_dec(cp_foldable_list);
18788         return ret;
18789     }
18790
18791     /* If folding, we calculate all characters that could fold to or from the
18792      * ones already on the list */
18793     if (cp_foldable_list) {
18794         if (FOLD) {
18795             UV start, end;      /* End points of code point ranges */
18796
18797             SV* fold_intersection = NULL;
18798             SV** use_list;
18799
18800             /* Our calculated list will be for Unicode rules.  For locale
18801              * matching, we have to keep a separate list that is consulted at
18802              * runtime only when the locale indicates Unicode rules (and we
18803              * don't include potential matches in the ASCII/Latin1 range, as
18804              * any code point could fold to any other, based on the run-time
18805              * locale).   For non-locale, we just use the general list */
18806             if (LOC) {
18807                 use_list = &only_utf8_locale_list;
18808             }
18809             else {
18810                 use_list = &cp_list;
18811             }
18812
18813             /* Only the characters in this class that participate in folds need
18814              * be checked.  Get the intersection of this class and all the
18815              * possible characters that are foldable.  This can quickly narrow
18816              * down a large class */
18817             _invlist_intersection(PL_in_some_fold, cp_foldable_list,
18818                                   &fold_intersection);
18819
18820             /* Now look at the foldable characters in this class individually */
18821             invlist_iterinit(fold_intersection);
18822             while (invlist_iternext(fold_intersection, &start, &end)) {
18823                 UV j;
18824                 UV folded;
18825
18826                 /* Look at every character in the range */
18827                 for (j = start; j <= end; j++) {
18828                     U8 foldbuf[UTF8_MAXBYTES_CASE+1];
18829                     STRLEN foldlen;
18830                     unsigned int k;
18831                     Size_t folds_count;
18832                     U32 first_fold;
18833                     const U32 * remaining_folds;
18834
18835                     if (j < 256) {
18836
18837                         /* Under /l, we don't know what code points below 256
18838                          * fold to, except we do know the MICRO SIGN folds to
18839                          * an above-255 character if the locale is UTF-8, so we
18840                          * add it to the special list (in *use_list)  Otherwise
18841                          * we know now what things can match, though some folds
18842                          * are valid under /d only if the target is UTF-8.
18843                          * Those go in a separate list */
18844                         if (      IS_IN_SOME_FOLD_L1(j)
18845                             && ! (LOC && j != MICRO_SIGN))
18846                         {
18847
18848                             /* ASCII is always matched; non-ASCII is matched
18849                              * only under Unicode rules (which could happen
18850                              * under /l if the locale is a UTF-8 one */
18851                             if (isASCII(j) || ! DEPENDS_SEMANTICS) {
18852                                 *use_list = add_cp_to_invlist(*use_list,
18853                                                             PL_fold_latin1[j]);
18854                             }
18855                             else if (j != PL_fold_latin1[j]) {
18856                                 upper_latin1_only_utf8_matches
18857                                         = add_cp_to_invlist(
18858                                                 upper_latin1_only_utf8_matches,
18859                                                 PL_fold_latin1[j]);
18860                             }
18861                         }
18862
18863                         if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
18864                             && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
18865                         {
18866                             add_above_Latin1_folds(pRExC_state,
18867                                                    (U8) j,
18868                                                    use_list);
18869                         }
18870                         continue;
18871                     }
18872
18873                     /* Here is an above Latin1 character.  We don't have the
18874                      * rules hard-coded for it.  First, get its fold.  This is
18875                      * the simple fold, as the multi-character folds have been
18876                      * handled earlier and separated out */
18877                     folded = _to_uni_fold_flags(j, foldbuf, &foldlen,
18878                                                         (ASCII_FOLD_RESTRICTED)
18879                                                         ? FOLD_FLAGS_NOMIX_ASCII
18880                                                         : 0);
18881
18882                     /* Single character fold of above Latin1.  Add everything
18883                      * in its fold closure to the list that this node should
18884                      * match. */
18885                     folds_count = _inverse_folds(folded, &first_fold,
18886                                                     &remaining_folds);
18887                     for (k = 0; k <= folds_count; k++) {
18888                         UV c = (k == 0)     /* First time through use itself */
18889                                 ? folded
18890                                 : (k == 1)  /* 2nd time use, the first fold */
18891                                    ? first_fold
18892
18893                                      /* Then the remaining ones */
18894                                    : remaining_folds[k-2];
18895
18896                         /* /aa doesn't allow folds between ASCII and non- */
18897                         if ((   ASCII_FOLD_RESTRICTED
18898                             && (isASCII(c) != isASCII(j))))
18899                         {
18900                             continue;
18901                         }
18902
18903                         /* Folds under /l which cross the 255/256 boundary are
18904                          * added to a separate list.  (These are valid only
18905                          * when the locale is UTF-8.) */
18906                         if (c < 256 && LOC) {
18907                             *use_list = add_cp_to_invlist(*use_list, c);
18908                             continue;
18909                         }
18910
18911                         if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
18912                         {
18913                             cp_list = add_cp_to_invlist(cp_list, c);
18914                         }
18915                         else {
18916                             /* Similarly folds involving non-ascii Latin1
18917                              * characters under /d are added to their list */
18918                             upper_latin1_only_utf8_matches
18919                                     = add_cp_to_invlist(
18920                                                 upper_latin1_only_utf8_matches,
18921                                                 c);
18922                         }
18923                     }
18924                 }
18925             }
18926             SvREFCNT_dec_NN(fold_intersection);
18927         }
18928
18929         /* Now that we have finished adding all the folds, there is no reason
18930          * to keep the foldable list separate */
18931         _invlist_union(cp_list, cp_foldable_list, &cp_list);
18932         SvREFCNT_dec_NN(cp_foldable_list);
18933     }
18934
18935     /* And combine the result (if any) with any inversion lists from posix
18936      * classes.  The lists are kept separate up to now because we don't want to
18937      * fold the classes */
18938     if (simple_posixes) {   /* These are the classes known to be unaffected by
18939                                /a, /aa, and /d */
18940         if (cp_list) {
18941             _invlist_union(cp_list, simple_posixes, &cp_list);
18942             SvREFCNT_dec_NN(simple_posixes);
18943         }
18944         else {
18945             cp_list = simple_posixes;
18946         }
18947     }
18948     if (posixes || nposixes) {
18949         if (! DEPENDS_SEMANTICS) {
18950
18951             /* For everything but /d, we can just add the current 'posixes' and
18952              * 'nposixes' to the main list */
18953             if (posixes) {
18954                 if (cp_list) {
18955                     _invlist_union(cp_list, posixes, &cp_list);
18956                     SvREFCNT_dec_NN(posixes);
18957                 }
18958                 else {
18959                     cp_list = posixes;
18960                 }
18961             }
18962             if (nposixes) {
18963                 if (cp_list) {
18964                     _invlist_union(cp_list, nposixes, &cp_list);
18965                     SvREFCNT_dec_NN(nposixes);
18966                 }
18967                 else {
18968                     cp_list = nposixes;
18969                 }
18970             }
18971         }
18972         else {
18973             /* Under /d, things like \w match upper Latin1 characters only if
18974              * the target string is in UTF-8.  But things like \W match all the
18975              * upper Latin1 characters if the target string is not in UTF-8.
18976              *
18977              * Handle the case with something like \W separately */
18978             if (nposixes) {
18979                 SV* only_non_utf8_list = invlist_clone(PL_UpperLatin1, NULL);
18980
18981                 /* A complemented posix class matches all upper Latin1
18982                  * characters if not in UTF-8.  And it matches just certain
18983                  * ones when in UTF-8.  That means those certain ones are
18984                  * matched regardless, so can just be added to the
18985                  * unconditional list */
18986                 if (cp_list) {
18987                     _invlist_union(cp_list, nposixes, &cp_list);
18988                     SvREFCNT_dec_NN(nposixes);
18989                     nposixes = NULL;
18990                 }
18991                 else {
18992                     cp_list = nposixes;
18993                 }
18994
18995                 /* Likewise for 'posixes' */
18996                 _invlist_union(posixes, cp_list, &cp_list);
18997                 SvREFCNT_dec(posixes);
18998
18999                 /* Likewise for anything else in the range that matched only
19000                  * under UTF-8 */
19001                 if (upper_latin1_only_utf8_matches) {
19002                     _invlist_union(cp_list,
19003                                    upper_latin1_only_utf8_matches,
19004                                    &cp_list);
19005                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
19006                     upper_latin1_only_utf8_matches = NULL;
19007                 }
19008
19009                 /* If we don't match all the upper Latin1 characters regardless
19010                  * of UTF-8ness, we have to set a flag to match the rest when
19011                  * not in UTF-8 */
19012                 _invlist_subtract(only_non_utf8_list, cp_list,
19013                                   &only_non_utf8_list);
19014                 if (_invlist_len(only_non_utf8_list) != 0) {
19015                     anyof_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
19016                 }
19017                 SvREFCNT_dec_NN(only_non_utf8_list);
19018             }
19019             else {
19020                 /* Here there were no complemented posix classes.  That means
19021                  * the upper Latin1 characters in 'posixes' match only when the
19022                  * target string is in UTF-8.  So we have to add them to the
19023                  * list of those types of code points, while adding the
19024                  * remainder to the unconditional list.
19025                  *
19026                  * First calculate what they are */
19027                 SV* nonascii_but_latin1_properties = NULL;
19028                 _invlist_intersection(posixes, PL_UpperLatin1,
19029                                       &nonascii_but_latin1_properties);
19030
19031                 /* And add them to the final list of such characters. */
19032                 _invlist_union(upper_latin1_only_utf8_matches,
19033                                nonascii_but_latin1_properties,
19034                                &upper_latin1_only_utf8_matches);
19035
19036                 /* Remove them from what now becomes the unconditional list */
19037                 _invlist_subtract(posixes, nonascii_but_latin1_properties,
19038                                   &posixes);
19039
19040                 /* And add those unconditional ones to the final list */
19041                 if (cp_list) {
19042                     _invlist_union(cp_list, posixes, &cp_list);
19043                     SvREFCNT_dec_NN(posixes);
19044                     posixes = NULL;
19045                 }
19046                 else {
19047                     cp_list = posixes;
19048                 }
19049
19050                 SvREFCNT_dec(nonascii_but_latin1_properties);
19051
19052                 /* Get rid of any characters from the conditional list that we
19053                  * now know are matched unconditionally, which may make that
19054                  * list empty */
19055                 _invlist_subtract(upper_latin1_only_utf8_matches,
19056                                   cp_list,
19057                                   &upper_latin1_only_utf8_matches);
19058                 if (_invlist_len(upper_latin1_only_utf8_matches) == 0) {
19059                     SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
19060                     upper_latin1_only_utf8_matches = NULL;
19061                 }
19062             }
19063         }
19064     }
19065
19066     /* And combine the result (if any) with any inversion list from properties.
19067      * The lists are kept separate up to now so that we can distinguish the two
19068      * in regards to matching above-Unicode.  A run-time warning is generated
19069      * if a Unicode property is matched against a non-Unicode code point. But,
19070      * we allow user-defined properties to match anything, without any warning,
19071      * and we also suppress the warning if there is a portion of the character
19072      * class that isn't a Unicode property, and which matches above Unicode, \W
19073      * or [\x{110000}] for example.
19074      * (Note that in this case, unlike the Posix one above, there is no
19075      * <upper_latin1_only_utf8_matches>, because having a Unicode property
19076      * forces Unicode semantics */
19077     if (properties) {
19078         if (cp_list) {
19079
19080             /* If it matters to the final outcome, see if a non-property
19081              * component of the class matches above Unicode.  If so, the
19082              * warning gets suppressed.  This is true even if just a single
19083              * such code point is specified, as, though not strictly correct if
19084              * another such code point is matched against, the fact that they
19085              * are using above-Unicode code points indicates they should know
19086              * the issues involved */
19087             if (warn_super) {
19088                 warn_super = ! (invert
19089                                ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
19090             }
19091
19092             _invlist_union(properties, cp_list, &cp_list);
19093             SvREFCNT_dec_NN(properties);
19094         }
19095         else {
19096             cp_list = properties;
19097         }
19098
19099         if (warn_super) {
19100             anyof_flags
19101              |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
19102
19103             /* Because an ANYOF node is the only one that warns, this node
19104              * can't be optimized into something else */
19105             optimizable = FALSE;
19106         }
19107     }
19108
19109     /* Here, we have calculated what code points should be in the character
19110      * class.
19111      *
19112      * Now we can see about various optimizations.  Fold calculation (which we
19113      * did above) needs to take place before inversion.  Otherwise /[^k]/i
19114      * would invert to include K, which under /i would match k, which it
19115      * shouldn't.  Therefore we can't invert folded locale now, as it won't be
19116      * folded until runtime */
19117
19118     /* If we didn't do folding, it's because some information isn't available
19119      * until runtime; set the run-time fold flag for these  We know to set the
19120      * flag if we have a non-NULL list for UTF-8 locales, or the class matches
19121      * at least one 0-255 range code point */
19122     if (LOC && FOLD) {
19123
19124         /* Some things on the list might be unconditionally included because of
19125          * other components.  Remove them, and clean up the list if it goes to
19126          * 0 elements */
19127         if (only_utf8_locale_list && cp_list) {
19128             _invlist_subtract(only_utf8_locale_list, cp_list,
19129                               &only_utf8_locale_list);
19130
19131             if (_invlist_len(only_utf8_locale_list) == 0) {
19132                 SvREFCNT_dec_NN(only_utf8_locale_list);
19133                 only_utf8_locale_list = NULL;
19134             }
19135         }
19136         if (    only_utf8_locale_list
19137             || (cp_list && (   _invlist_contains_cp(cp_list, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE)
19138                             || _invlist_contains_cp(cp_list, LATIN_SMALL_LETTER_DOTLESS_I))))
19139         {
19140             has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
19141             anyof_flags
19142                  |= ANYOFL_FOLD
19143                  |  ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
19144         }
19145         else if (cp_list && invlist_lowest(cp_list) < 256) {
19146             /* If nothing is below 256, has no locale dependency; otherwise it
19147              * does */
19148             anyof_flags |= ANYOFL_FOLD;
19149             has_runtime_dependency |= HAS_L_RUNTIME_DEPENDENCY;
19150         }
19151     }
19152     else if (   DEPENDS_SEMANTICS
19153              && (    upper_latin1_only_utf8_matches
19154                  || (anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)))
19155     {
19156         RExC_seen_d_op = TRUE;
19157         has_runtime_dependency |= HAS_D_RUNTIME_DEPENDENCY;
19158     }
19159
19160     /* Optimize inverted patterns (e.g. [^a-z]) when everything is known at
19161      * compile time. */
19162     if (     cp_list
19163         &&   invert
19164         && ! has_runtime_dependency)
19165     {
19166         _invlist_invert(cp_list);
19167
19168         /* Clear the invert flag since have just done it here */
19169         invert = FALSE;
19170     }
19171
19172     /* All possible optimizations below still have these characteristics.
19173      * (Multi-char folds aren't SIMPLE, but they don't get this far in this
19174      * routine) */
19175     *flagp |= HASWIDTH|SIMPLE;
19176
19177     if (ret_invlist) {
19178         *ret_invlist = cp_list;
19179
19180         return (cp_list) ? RExC_emit : 0;
19181     }
19182
19183     if (anyof_flags & ANYOF_LOCALE_FLAGS) {
19184         RExC_contains_locale = 1;
19185     }
19186
19187     if (optimizable) {
19188
19189         /* Some character classes are equivalent to other nodes.  Such nodes
19190          * take up less room, and some nodes require fewer operations to
19191          * execute, than ANYOF nodes.  EXACTish nodes may be joinable with
19192          * adjacent nodes to improve efficiency. */
19193         op = optimize_regclass(pRExC_state, cp_list,
19194                                             only_utf8_locale_list,
19195                                             upper_latin1_only_utf8_matches,
19196                                             has_runtime_dependency,
19197                                             posixl,
19198                                             &anyof_flags, &invert, &ret, flagp);
19199         RETURN_FAIL_ON_RESTART_FLAGP(flagp);
19200
19201         /* If optimized to something else, finish up and return */
19202         if (ret >= 0) {
19203             Set_Node_Offset_Length(REGNODE_p(ret), orig_parse - RExC_start,
19204                                                    RExC_parse - orig_parse);;
19205             SvREFCNT_dec(cp_list);;
19206             SvREFCNT_dec(only_utf8_locale_list);
19207             SvREFCNT_dec(upper_latin1_only_utf8_matches);
19208             return ret;
19209         }
19210     }
19211
19212     /* Here didn't optimize, or optimized to a specialized ANYOF node.  If the
19213      * former, set the particular type */
19214     if (op == ANYOF) {
19215         if (has_runtime_dependency & HAS_D_RUNTIME_DEPENDENCY) {
19216             op = ANYOFD;
19217         }
19218         else if (posixl) {
19219             op = ANYOFPOSIXL;
19220         }
19221         else if (LOC) {
19222             op = ANYOFL;
19223         }
19224     }
19225
19226     ret = regnode_guts(pRExC_state, op, regarglen[op], "anyof");
19227     FILL_NODE(ret, op);        /* We set the argument later */
19228     RExC_emit += 1 + regarglen[op];
19229     ANYOF_FLAGS(REGNODE_p(ret)) = anyof_flags;
19230
19231     /* Here, <cp_list> contains all the code points we can determine at
19232      * compile time that match under all conditions.  Go through it, and
19233      * for things that belong in the bitmap, put them there, and delete from
19234      * <cp_list>.  While we are at it, see if everything above 255 is in the
19235      * list, and if so, set a flag to speed up execution */
19236
19237     populate_ANYOF_from_invlist(REGNODE_p(ret), &cp_list);
19238
19239     if (posixl) {
19240         ANYOF_POSIXL_SET_TO_BITMAP(REGNODE_p(ret), posixl);
19241     }
19242
19243     if (invert) {
19244         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_INVERT;
19245     }
19246
19247     /* Here, the bitmap has been populated with all the Latin1 code points that
19248      * always match.  Can now add to the overall list those that match only
19249      * when the target string is UTF-8 (<upper_latin1_only_utf8_matches>).
19250      * */
19251     if (upper_latin1_only_utf8_matches) {
19252         if (cp_list) {
19253             _invlist_union(cp_list,
19254                            upper_latin1_only_utf8_matches,
19255                            &cp_list);
19256             SvREFCNT_dec_NN(upper_latin1_only_utf8_matches);
19257         }
19258         else {
19259             cp_list = upper_latin1_only_utf8_matches;
19260         }
19261         ANYOF_FLAGS(REGNODE_p(ret)) |= ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP;
19262     }
19263
19264     set_ANYOF_arg(pRExC_state, REGNODE_p(ret), cp_list,
19265                   (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
19266                    ? listsv
19267                    : NULL,
19268                   only_utf8_locale_list);
19269
19270     SvREFCNT_dec(cp_list);;
19271     SvREFCNT_dec(only_utf8_locale_list);
19272     return ret;
19273 }
19274
19275 STATIC U8
19276 S_optimize_regclass(pTHX_
19277                     RExC_state_t *pRExC_state,
19278                     SV * cp_list,
19279                     SV* only_utf8_locale_list,
19280                     SV* upper_latin1_only_utf8_matches,
19281                     const U32 has_runtime_dependency,
19282                     const U32 posixl,
19283                     U8  * anyof_flags,
19284                     bool * invert,
19285                     regnode_offset * ret,
19286                     I32 *flagp
19287                   )
19288 {
19289     /* This function exists just to make S_regclass() smaller.  It extracts out
19290      * the code that looks for potential optimizations away from a full generic
19291      * ANYOF node.  The parameter names are the same as the corresponding
19292      * variables in S_regclass.
19293      *
19294      * It returns the new op (ANYOF if no optimization found) and sets *ret to
19295      * any created regnode.  If the new op is sufficiently like plain ANYOF, it
19296      * leaves *ret unchanged for allocation in S_regclass.
19297      *
19298      * Certain of the parameters may be updated as a result of the changes herein */
19299
19300         U8 op = ANYOF; /* The returned node-type, initialized to the unoptimized
19301                         one. */
19302         UV value;
19303         PERL_UINT_FAST8_T i;
19304         UV partial_cp_count = 0;
19305         UV start[MAX_FOLD_FROMS+1] = { 0 }; /* +1 for the folded-to char */
19306         UV   end[MAX_FOLD_FROMS+1] = { 0 };
19307         bool single_range = FALSE;
19308
19309         PERL_ARGS_ASSERT_OPTIMIZE_REGCLASS;
19310
19311         if (cp_list) { /* Count the code points in enough ranges that we would
19312                           see all the ones possible in any fold in this version
19313                           of Unicode */
19314
19315             invlist_iterinit(cp_list);
19316             for (i = 0; i <= MAX_FOLD_FROMS; i++) {
19317                 if (! invlist_iternext(cp_list, &start[i], &end[i])) {
19318                     break;
19319                 }
19320                 partial_cp_count += end[i] - start[i] + 1;
19321             }
19322
19323             if (i == 1) {
19324                 single_range = TRUE;
19325             }
19326             invlist_iterfinish(cp_list);
19327         }
19328
19329         /* If we know at compile time that this matches every possible code
19330          * point, any run-time dependencies don't matter */
19331         if (start[0] == 0 && end[0] == UV_MAX) {
19332             if (*invert) {
19333                 op = OPFAIL;
19334                 *ret = reganode(pRExC_state, op, 0);
19335             }
19336             else {
19337                 op = SANY;
19338                 *ret = reg_node(pRExC_state, op);
19339                 MARK_NAUGHTY(1);
19340             }
19341             return op;
19342         }
19343
19344         /* Similarly, for /l posix classes, if both a class and its
19345          * complement match, any run-time dependencies don't matter */
19346         if (posixl) {
19347             int namedclass;
19348             for (namedclass = 0; namedclass < ANYOF_POSIXL_MAX;
19349                                                         namedclass += 2)
19350             {
19351                 if (   POSIXL_TEST(posixl, namedclass)      /* class */
19352                     && POSIXL_TEST(posixl, namedclass + 1)) /* its complement */
19353                 {
19354                     if (*invert) {
19355                         op = OPFAIL;
19356                         *ret = reganode(pRExC_state, op, 0);
19357                     }
19358                     else {
19359                         op = SANY;
19360                         *ret = reg_node(pRExC_state, op);
19361                         MARK_NAUGHTY(1);
19362                     }
19363                     return op;
19364                 }
19365             }
19366
19367             /* For well-behaved locales, some classes are subsets of others,
19368              * so complementing the subset and including the non-complemented
19369              * superset should match everything, like [\D[:alnum:]], and
19370              * [[:^alpha:][:alnum:]], but some implementations of locales are
19371              * buggy, and khw thinks its a bad idea to have optimization change
19372              * behavior, even if it avoids an OS bug in a given case */
19373
19374 #define isSINGLE_BIT_SET(n) isPOWER_OF_2(n)
19375
19376             /* If is a single posix /l class, can optimize to just that op.
19377              * Such a node will not match anything in the Latin1 range, as that
19378              * is not determinable until runtime, but will match whatever the
19379              * class does outside that range.  (Note that some classes won't
19380              * match anything outside the range, like [:ascii:]) */
19381             if (    isSINGLE_BIT_SET(posixl)
19382                 && (partial_cp_count == 0 || start[0] > 255))
19383             {
19384                 U8 classnum;
19385                 SV * class_above_latin1 = NULL;
19386                 bool already_inverted;
19387                 bool are_equivalent;
19388
19389                 /* Compute which bit is set, which is the same thing as, e.g.,
19390                  * ANYOF_CNTRL.  From
19391                  * https://graphics.stanford.edu/~seander/bithacks.html#IntegerLogDeBruijn
19392                  * */
19393                 static const int MultiplyDeBruijnBitPosition2[32] =
19394                     {
19395                     0, 1, 28, 2, 29, 14, 24, 3, 30, 22, 20, 15, 25, 17, 4, 8,
19396                     31, 27, 13, 23, 21, 19, 16, 7, 26, 12, 18, 6, 11, 5, 10, 9
19397                     };
19398
19399                 namedclass = MultiplyDeBruijnBitPosition2[(posixl
19400                                                           * 0x077CB531U) >> 27];
19401                 classnum = namedclass_to_classnum(namedclass);
19402
19403                 /* The named classes are such that the inverted number is one
19404                  * larger than the non-inverted one */
19405                 already_inverted = namedclass
19406                                  - classnum_to_namedclass(classnum);
19407
19408                 /* Create an inversion list of the official property, inverted
19409                  * if the constructed node list is inverted, and restricted to
19410                  * only the above latin1 code points, which are the only ones
19411                  * known at compile time */
19412                 _invlist_intersection_maybe_complement_2nd(
19413                                                     PL_AboveLatin1,
19414                                                     PL_XPosix_ptrs[classnum],
19415                                                     already_inverted,
19416                                                     &class_above_latin1);
19417                 are_equivalent = _invlistEQ(class_above_latin1, cp_list,
19418                                                                         FALSE);
19419                 SvREFCNT_dec_NN(class_above_latin1);
19420
19421                 if (are_equivalent) {
19422
19423                     /* Resolve the run-time inversion flag with this possibly
19424                      * inverted class */
19425                     *invert = *invert ^ already_inverted;
19426
19427                     op = POSIXL + *invert * (NPOSIXL - POSIXL);
19428                     *ret = reg_node(pRExC_state, op);
19429                     FLAGS(REGNODE_p(*ret)) = classnum;
19430                     return op;
19431                 }
19432             }
19433         }
19434
19435         /* khw can't think of any other possible transformation involving
19436          * these. */
19437         if (has_runtime_dependency & HAS_USER_DEFINED_PROPERTY) {
19438             return op;
19439         }
19440
19441         if (! has_runtime_dependency) {
19442
19443             /* If the list is empty, nothing matches.  This happens, for
19444              * example, when a Unicode property that doesn't match anything is
19445              * the only element in the character class (perluniprops.pod notes
19446              * such properties). */
19447             if (partial_cp_count == 0) {
19448                 if (*invert) {
19449                     op = SANY;
19450                     *ret = reg_node(pRExC_state, op);
19451                 }
19452                 else {
19453                     op = OPFAIL;
19454                     *ret = reganode(pRExC_state, op, 0);
19455                 }
19456
19457                 return op;
19458             }
19459
19460             /* If matches everything but \n */
19461             if (   start[0] == 0 && end[0] == '\n' - 1
19462                 && start[1] == '\n' + 1 && end[1] == UV_MAX)
19463             {
19464                 assert (! *invert);
19465                 op = REG_ANY;
19466                 *ret = reg_node(pRExC_state, op);
19467                 MARK_NAUGHTY(1);
19468                 return op;
19469             }
19470         }
19471
19472         /* Next see if can optimize classes that contain just a few code points
19473          * into an EXACTish node.  The reason to do this is to let the
19474          * optimizer join this node with adjacent EXACTish ones, and ANYOF
19475          * nodes require conversion to code point from UTF-8.
19476          *
19477          * An EXACTFish node can be generated even if not under /i, and vice
19478          * versa.  But care must be taken.  An EXACTFish node has to be such
19479          * that it only matches precisely the code points in the class, but we
19480          * want to generate the least restrictive one that does that, to
19481          * increase the odds of being able to join with an adjacent node.  For
19482          * example, if the class contains [kK], we have to make it an EXACTFAA
19483          * node to prevent the KELVIN SIGN from matching.  Whether we are under
19484          * /i or not is irrelevant in this case.  Less obvious is the pattern
19485          * qr/[\x{02BC}]n/i.  U+02BC is MODIFIER LETTER APOSTROPHE. That is
19486          * supposed to match the single character U+0149 LATIN SMALL LETTER N
19487          * PRECEDED BY APOSTROPHE.  And so even though there is no simple fold
19488          * that includes \X{02BC}, there is a multi-char fold that does, and so
19489          * the node generated for it must be an EXACTFish one.  On the other
19490          * hand qr/:/i should generate a plain EXACT node since the colon
19491          * participates in no fold whatsoever, and having it EXACT tells the
19492          * optimizer the target string cannot match unless it has a colon in
19493          * it.
19494          */
19495         if (   ! posixl
19496             && ! *invert
19497
19498                 /* Only try if there are no more code points in the class than
19499                  * in the max possible fold */
19500             &&   inRANGE(partial_cp_count, 1, MAX_FOLD_FROMS + 1))
19501         {
19502             if (partial_cp_count == 1 && ! upper_latin1_only_utf8_matches)
19503             {
19504                 /* We can always make a single code point class into an
19505                  * EXACTish node. */
19506
19507                 if (LOC) {
19508
19509                     /* Here is /l:  Use EXACTL, except if there is a fold not
19510                      * known until runtime so shows as only a single code point
19511                      * here.  For code points above 255, we know which can
19512                      * cause problems by having a potential fold to the Latin1
19513                      * range. */
19514                     if (  ! FOLD
19515                         || (     start[0] > 255
19516                             && ! is_PROBLEMATIC_LOCALE_FOLD_cp(start[0])))
19517                     {
19518                         op = EXACTL;
19519                     }
19520                     else {
19521                         op = EXACTFL;
19522                     }
19523                 }
19524                 else if (! FOLD) { /* Not /l and not /i */
19525                     op = (start[0] < 256) ? EXACT : EXACT_REQ8;
19526                 }
19527                 else if (start[0] < 256) { /* /i, not /l, and the code point is
19528                                               small */
19529
19530                     /* Under /i, it gets a little tricky.  A code point that
19531                      * doesn't participate in a fold should be an EXACT node.
19532                      * We know this one isn't the result of a simple fold, or
19533                      * there'd be more than one code point in the list, but it
19534                      * could be part of a multi- character fold.  In that case
19535                      * we better not create an EXACT node, as we would wrongly
19536                      * be telling the optimizer that this code point must be in
19537                      * the target string, and that is wrong.  This is because
19538                      * if the sequence around this code point forms a
19539                      * multi-char fold, what needs to be in the string could be
19540                      * the code point that folds to the sequence.
19541                      *
19542                      * This handles the case of below-255 code points, as we
19543                      * have an easy look up for those.  The next clause handles
19544                      * the above-256 one */
19545                     op = IS_IN_SOME_FOLD_L1(start[0])
19546                          ? EXACTFU
19547                          : EXACT;
19548                 }
19549                 else {  /* /i, larger code point.  Since we are under /i, and
19550                            have just this code point, we know that it can't
19551                            fold to something else, so PL_InMultiCharFold
19552                            applies to it */
19553                     op = _invlist_contains_cp(PL_InMultiCharFold,
19554                                               start[0])
19555                          ? EXACTFU_REQ8
19556                          : EXACT_REQ8;
19557                 }
19558
19559                 value = start[0];
19560             }
19561             else if (  ! (has_runtime_dependency & ~HAS_D_RUNTIME_DEPENDENCY)
19562                      && _invlist_contains_cp(PL_in_some_fold, start[0]))
19563             {
19564                 /* Here, the only runtime dependency, if any, is from /d, and
19565                  * the class matches more than one code point, and the lowest
19566                  * code point participates in some fold.  It might be that the
19567                  * other code points are /i equivalent to this one, and hence
19568                  * they would representable by an EXACTFish node.  Above, we
19569                  * eliminated classes that contain too many code points to be
19570                  * EXACTFish, with the test for MAX_FOLD_FROMS
19571                  *
19572                  * First, special case the ASCII fold pairs, like 'B' and 'b'.
19573                  * We do this because we have EXACTFAA at our disposal for the
19574                  * ASCII range */
19575                 if (partial_cp_count == 2 && isASCII(start[0])) {
19576
19577                     /* The only ASCII characters that participate in folds are
19578                      * alphabetics */
19579                     assert(isALPHA(start[0]));
19580                     if (   end[0] == start[0]   /* First range is a single
19581                                                    character, so 2nd exists */
19582                         && isALPHA_FOLD_EQ(start[0], start[1]))
19583                     {
19584
19585                         /* Here, is part of an ASCII fold pair */
19586
19587                         if (   ASCII_FOLD_RESTRICTED
19588                             || HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(start[0]))
19589                         {
19590                             /* If the second clause just above was true, it
19591                              * means we can't be under /i, or else the list
19592                              * would have included more than this fold pair.
19593                              * Therefore we have to exclude the possibility of
19594                              * whatever else it is that folds to these, by
19595                              * using EXACTFAA */
19596                             op = EXACTFAA;
19597                         }
19598                         else if (HAS_NONLATIN1_FOLD_CLOSURE(start[0])) {
19599
19600                             /* Here, there's no simple fold that start[0] is part
19601                              * of, but there is a multi-character one.  If we
19602                              * are not under /i, we want to exclude that
19603                              * possibility; if under /i, we want to include it
19604                              * */
19605                             op = (FOLD) ? EXACTFU : EXACTFAA;
19606                         }
19607                         else {
19608
19609                             /* Here, the only possible fold start[0] particpates in
19610                              * is with start[1].  /i or not isn't relevant */
19611                             op = EXACTFU;
19612                         }
19613
19614                         value = toFOLD(start[0]);
19615                     }
19616                 }
19617                 else if (  ! upper_latin1_only_utf8_matches
19618                          || (   _invlist_len(upper_latin1_only_utf8_matches)
19619                                                                           == 2
19620                              && PL_fold_latin1[
19621                                invlist_highest(upper_latin1_only_utf8_matches)]
19622                              == start[0]))
19623                 {
19624                     /* Here, the smallest character is non-ascii or there are
19625                      * more than 2 code points matched by this node.  Also, we
19626                      * either don't have /d UTF-8 dependent matches, or if we
19627                      * do, they look like they could be a single character that
19628                      * is the fold of the lowest one in the always-match list.
19629                      * This test quickly excludes most of the false positives
19630                      * when there are /d UTF-8 depdendent matches.  These are
19631                      * like LATIN CAPITAL LETTER A WITH GRAVE matching LATIN
19632                      * SMALL LETTER A WITH GRAVE iff the target string is
19633                      * UTF-8.  (We don't have to worry above about exceeding
19634                      * the array bounds of PL_fold_latin1[] because any code
19635                      * point in 'upper_latin1_only_utf8_matches' is below 256.)
19636                      *
19637                      * EXACTFAA would apply only to pairs (hence exactly 2 code
19638                      * points) in the ASCII range, so we can't use it here to
19639                      * artificially restrict the fold domain, so we check if
19640                      * the class does or does not match some EXACTFish node.
19641                      * Further, if we aren't under /i, and the folded-to
19642                      * character is part of a multi-character fold, we can't do
19643                      * this optimization, as the sequence around it could be
19644                      * that multi-character fold, and we don't here know the
19645                      * context, so we have to assume it is that multi-char
19646                      * fold, to prevent potential bugs.
19647                      *
19648                      * To do the general case, we first find the fold of the
19649                      * lowest code point (which may be higher than the lowest
19650                      * one), then find everything that folds to it.  (The data
19651                      * structure we have only maps from the folded code points,
19652                      * so we have to do the earlier step.) */
19653
19654                     Size_t foldlen;
19655                     U8 foldbuf[UTF8_MAXBYTES_CASE];
19656                     UV folded = _to_uni_fold_flags(start[0],
19657                                                         foldbuf, &foldlen, 0);
19658                     U32 first_fold;
19659                     const U32 * remaining_folds;
19660                     Size_t folds_to_this_cp_count = _inverse_folds(
19661                                                             folded,
19662                                                             &first_fold,
19663                                                             &remaining_folds);
19664                     Size_t folds_count = folds_to_this_cp_count + 1;
19665                     SV * fold_list = _new_invlist(folds_count);
19666                     unsigned int i;
19667
19668                     /* If there are UTF-8 dependent matches, create a temporary
19669                      * list of what this node matches, including them. */
19670                     SV * all_cp_list = NULL;
19671                     SV ** use_this_list = &cp_list;
19672
19673                     if (upper_latin1_only_utf8_matches) {
19674                         all_cp_list = _new_invlist(0);
19675                         use_this_list = &all_cp_list;
19676                         _invlist_union(cp_list,
19677                                        upper_latin1_only_utf8_matches,
19678                                        use_this_list);
19679                     }
19680
19681                     /* Having gotten everything that participates in the fold
19682                      * containing the lowest code point, we turn that into an
19683                      * inversion list, making sure everything is included. */
19684                     fold_list = add_cp_to_invlist(fold_list, start[0]);
19685                     fold_list = add_cp_to_invlist(fold_list, folded);
19686                     if (folds_to_this_cp_count > 0) {
19687                         fold_list = add_cp_to_invlist(fold_list, first_fold);
19688                         for (i = 0; i + 1 < folds_to_this_cp_count; i++) {
19689                             fold_list = add_cp_to_invlist(fold_list,
19690                                                         remaining_folds[i]);
19691                         }
19692                     }
19693
19694                     /* If the fold list is identical to what's in this ANYOF
19695                      * node, the node can be represented by an EXACTFish one
19696                      * instead */
19697                     if (_invlistEQ(*use_this_list, fold_list,
19698                                    0 /* Don't complement */ )
19699                     ) {
19700
19701                         /* But, we have to be careful, as mentioned above.
19702                          * Just the right sequence of characters could match
19703                          * this if it is part of a multi-character fold.  That
19704                          * IS what we want if we are under /i.  But it ISN'T
19705                          * what we want if not under /i, as it could match when
19706                          * it shouldn't.  So, when we aren't under /i and this
19707                          * character participates in a multi-char fold, we
19708                          * don't optimize into an EXACTFish node.  So, for each
19709                          * case below we have to check if we are folding
19710                          * and if not, if it is not part of a multi-char fold.
19711                          * */
19712                         if (start[0] > 255) {    /* Highish code point */
19713                             if (FOLD || ! _invlist_contains_cp(
19714                                             PL_InMultiCharFold, folded))
19715                             {
19716                                 op = (LOC)
19717                                      ? EXACTFLU8
19718                                      : (ASCII_FOLD_RESTRICTED)
19719                                        ? EXACTFAA
19720                                        : EXACTFU_REQ8;
19721                                 value = folded;
19722                             }
19723                         }   /* Below, the lowest code point < 256 */
19724                         else if (    FOLD
19725                                  &&  folded == 's'
19726                                  &&  DEPENDS_SEMANTICS)
19727                         {   /* An EXACTF node containing a single character
19728                                 's', can be an EXACTFU if it doesn't get
19729                                 joined with an adjacent 's' */
19730                             op = EXACTFU_S_EDGE;
19731                             value = folded;
19732                         }
19733                         else if (    FOLD
19734                                 || ! HAS_NONLATIN1_FOLD_CLOSURE(start[0]))
19735                         {
19736                             if (upper_latin1_only_utf8_matches) {
19737                                 op = EXACTF;
19738
19739                                 /* We can't use the fold, as that only matches
19740                                  * under UTF-8 */
19741                                 value = start[0];
19742                             }
19743                             else if (     UNLIKELY(start[0] == MICRO_SIGN)
19744                                      && ! UTF)
19745                             {   /* EXACTFUP is a special node for this
19746                                    character */
19747                                 op = (ASCII_FOLD_RESTRICTED)
19748                                      ? EXACTFAA
19749                                      : EXACTFUP;
19750                                 value = MICRO_SIGN;
19751                             }
19752                             else if (     ASCII_FOLD_RESTRICTED
19753                                      && ! isASCII(start[0]))
19754                             {   /* For ASCII under /iaa, we can use EXACTFU
19755                                    below */
19756                                 op = EXACTFAA;
19757                                 value = folded;
19758                             }
19759                             else {
19760                                 op = EXACTFU;
19761                                 value = folded;
19762                             }
19763                         }
19764                     }
19765
19766                     SvREFCNT_dec_NN(fold_list);
19767                     SvREFCNT_dec(all_cp_list);
19768                 }
19769             }
19770
19771             if (op != ANYOF) {
19772                 U8 len;
19773
19774                 /* Here, we have calculated what EXACTish node to use.  Have to
19775                  * convert to UTF-8 if not already there */
19776                 if (value > 255) {
19777                     if (! UTF) {
19778                         SvREFCNT_dec(cp_list);;
19779                         REQUIRE_UTF8(flagp);
19780                     }
19781
19782                     /* This is a kludge to the special casing issues with this
19783                      * ligature under /aa.  FB05 should fold to FB06, but the
19784                      * call above to _to_uni_fold_flags() didn't find this, as
19785                      * it didn't use the /aa restriction in order to not miss
19786                      * other folds that would be affected.  This is the only
19787                      * instance likely to ever be a problem in all of Unicode.
19788                      * So special case it. */
19789                     if (   value == LATIN_SMALL_LIGATURE_LONG_S_T
19790                         && ASCII_FOLD_RESTRICTED)
19791                     {
19792                         value = LATIN_SMALL_LIGATURE_ST;
19793                     }
19794                 }
19795
19796                 len = (UTF) ? UVCHR_SKIP(value) : 1;
19797
19798                 *ret = regnode_guts(pRExC_state, op, len, "exact");
19799                 FILL_NODE(*ret, op);
19800                 RExC_emit += 1 + STR_SZ(len);
19801                 setSTR_LEN(REGNODE_p(*ret), len);
19802                 if (len == 1) {
19803                     *STRINGs(REGNODE_p(*ret)) = (U8) value;
19804                 }
19805                 else {
19806                     uvchr_to_utf8((U8 *) STRINGs(REGNODE_p(*ret)), value);
19807                 }
19808                 return op;
19809             }
19810         }
19811
19812         if (! has_runtime_dependency) {
19813
19814             /* See if this can be turned into an ANYOFM node.  Think about the
19815              * bit patterns in two different bytes.  In some positions, the
19816              * bits in each will be 1; and in other positions both will be 0;
19817              * and in some positions the bit will be 1 in one byte, and 0 in
19818              * the other.  Let 'n' be the number of positions where the bits
19819              * differ.  We create a mask which has exactly 'n' 0 bits, each in
19820              * a position where the two bytes differ.  Now take the set of all
19821              * bytes that when ANDed with the mask yield the same result.  That
19822              * set has 2**n elements, and is representable by just two 8 bit
19823              * numbers: the result and the mask.  Importantly, matching the set
19824              * can be vectorized by creating a word full of the result bytes,
19825              * and a word full of the mask bytes, yielding a significant speed
19826              * up.  Here, see if this node matches such a set.  As a concrete
19827              * example consider [01], and the byte representing '0' which is
19828              * 0x30 on ASCII machines.  It has the bits 0011 0000.  Take the
19829              * mask 1111 1110.  If we AND 0x31 and 0x30 with that mask we get
19830              * 0x30.  Any other bytes ANDed yield something else.  So [01],
19831              * which is a common usage, is optimizable into ANYOFM, and can
19832              * benefit from the speed up.  We can only do this on UTF-8
19833              * invariant bytes, because they have the same bit patterns under
19834              * UTF-8 as not. */
19835             PERL_UINT_FAST8_T inverted = 0;
19836 #ifdef EBCDIC
19837             const PERL_UINT_FAST8_T max_permissible = 0xFF;
19838 #else
19839             const PERL_UINT_FAST8_T max_permissible = 0x7F;
19840 #endif
19841             /* If doesn't fit the criteria for ANYOFM, invert and try again.
19842              * If that works we will instead later generate an NANYOFM, and
19843              * invert back when through */
19844             if (invlist_highest(cp_list) > max_permissible) {
19845                 _invlist_invert(cp_list);
19846                 inverted = 1;
19847             }
19848
19849             if (invlist_highest(cp_list) <= max_permissible) {
19850                 UV this_start, this_end;
19851                 UV lowest_cp = UV_MAX;  /* init'ed to suppress compiler warn */
19852                 U8 bits_differing = 0;
19853                 Size_t full_cp_count = 0;
19854                 bool first_time = TRUE;
19855
19856                 /* Go through the bytes and find the bit positions that differ
19857                  * */
19858                 invlist_iterinit(cp_list);
19859                 while (invlist_iternext(cp_list, &this_start, &this_end)) {
19860                     unsigned int i = this_start;
19861
19862                     if (first_time) {
19863                         if (! UVCHR_IS_INVARIANT(i)) {
19864                             goto done_anyofm;
19865                         }
19866
19867                         first_time = FALSE;
19868                         lowest_cp = this_start;
19869
19870                         /* We have set up the code point to compare with.
19871                          * Don't compare it with itself */
19872                         i++;
19873                     }
19874
19875                     /* Find the bit positions that differ from the lowest code
19876                      * point in the node.  Keep track of all such positions by
19877                      * OR'ing */
19878                     for (; i <= this_end; i++) {
19879                         if (! UVCHR_IS_INVARIANT(i)) {
19880                             goto done_anyofm;
19881                         }
19882
19883                         bits_differing  |= i ^ lowest_cp;
19884                     }
19885
19886                     full_cp_count += this_end - this_start + 1;
19887                 }
19888
19889                 /* At the end of the loop, we count how many bits differ from
19890                  * the bits in lowest code point, call the count 'd'.  If the
19891                  * set we found contains 2**d elements, it is the closure of
19892                  * all code points that differ only in those bit positions.  To
19893                  * convince yourself of that, first note that the number in the
19894                  * closure must be a power of 2, which we test for.  The only
19895                  * way we could have that count and it be some differing set,
19896                  * is if we got some code points that don't differ from the
19897                  * lowest code point in any position, but do differ from each
19898                  * other in some other position.  That means one code point has
19899                  * a 1 in that position, and another has a 0.  But that would
19900                  * mean that one of them differs from the lowest code point in
19901                  * that position, which possibility we've already excluded.  */
19902                 if (  (inverted || full_cp_count > 1)
19903                     && full_cp_count == 1U << PL_bitcount[bits_differing])
19904                 {
19905                     U8 ANYOFM_mask;
19906
19907                     op = ANYOFM + inverted;;
19908
19909                     /* We need to make the bits that differ be 0's */
19910                     ANYOFM_mask = ~ bits_differing; /* This goes into FLAGS */
19911
19912                     /* The argument is the lowest code point */
19913                     *ret = reganode(pRExC_state, op, lowest_cp);
19914                     FLAGS(REGNODE_p(*ret)) = ANYOFM_mask;
19915                 }
19916
19917               done_anyofm:
19918                 invlist_iterfinish(cp_list);
19919             }
19920
19921             if (inverted) {
19922                 _invlist_invert(cp_list);
19923             }
19924
19925             if (op != ANYOF) {
19926                 return op;
19927             }
19928
19929             /* XXX We could create an ANYOFR_LOW node here if we saved above if
19930              * all were invariants, it wasn't inverted, and there is a single
19931              * range.  This would be faster than some of the posix nodes we
19932              * create below like /\d/a, but would be twice the size.  Without
19933              * having actually measured the gain, khw doesn't think the
19934              * tradeoff is really worth it */
19935         }
19936
19937         if (! (*anyof_flags & ANYOF_LOCALE_FLAGS)) {
19938             PERL_UINT_FAST8_T type;
19939             SV * intersection = NULL;
19940             SV* d_invlist = NULL;
19941
19942             /* See if this matches any of the POSIX classes.  The POSIXA and
19943              * POSIXD ones are about the same speed as ANYOF ops, but take less
19944              * room; the ones that have above-Latin1 code point matches are
19945              * somewhat faster than ANYOF.  */
19946
19947             for (type = POSIXA; type >= POSIXD; type--) {
19948                 int posix_class;
19949
19950                 if (type == POSIXL) {   /* But not /l posix classes */
19951                     continue;
19952                 }
19953
19954                 for (posix_class = 0;
19955                      posix_class <= _HIGHEST_REGCOMP_DOT_H_SYNC;
19956                      posix_class++)
19957                 {
19958                     SV** our_code_points = &cp_list;
19959                     SV** official_code_points;
19960                     int try_inverted;
19961
19962                     if (type == POSIXA) {
19963                         official_code_points = &PL_Posix_ptrs[posix_class];
19964                     }
19965                     else {
19966                         official_code_points = &PL_XPosix_ptrs[posix_class];
19967                     }
19968
19969                     /* Skip non-existent classes of this type.  e.g. \v only
19970                      * has an entry in PL_XPosix_ptrs */
19971                     if (! *official_code_points) {
19972                         continue;
19973                     }
19974
19975                     /* Try both the regular class, and its inversion */
19976                     for (try_inverted = 0; try_inverted < 2; try_inverted++) {
19977                         bool this_inverted = *invert ^ try_inverted;
19978
19979                         if (type != POSIXD) {
19980
19981                             /* This class that isn't /d can't match if we have
19982                              * /d dependencies */
19983                             if (has_runtime_dependency
19984                                                     & HAS_D_RUNTIME_DEPENDENCY)
19985                             {
19986                                 continue;
19987                             }
19988                         }
19989                         else /* is /d */ if (! this_inverted) {
19990
19991                             /* /d classes don't match anything non-ASCII below
19992                              * 256 unconditionally (which cp_list contains) */
19993                             _invlist_intersection(cp_list, PL_UpperLatin1,
19994                                                            &intersection);
19995                             if (_invlist_len(intersection) != 0) {
19996                                 continue;
19997                             }
19998
19999                             SvREFCNT_dec(d_invlist);
20000                             d_invlist = invlist_clone(cp_list, NULL);
20001
20002                             /* But under UTF-8 it turns into using /u rules.
20003                              * Add the things it matches under these conditions
20004                              * so that we check below that these are identical
20005                              * to what the tested class should match */
20006                             if (upper_latin1_only_utf8_matches) {
20007                                 _invlist_union(
20008                                             d_invlist,
20009                                             upper_latin1_only_utf8_matches,
20010                                             &d_invlist);
20011                             }
20012                             our_code_points = &d_invlist;
20013                         }
20014                         else {  /* POSIXD, inverted.  If this doesn't have this
20015                                    flag set, it isn't /d. */
20016                             if (! (*anyof_flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
20017                             {
20018                                 continue;
20019                             }
20020                             our_code_points = &cp_list;
20021                         }
20022
20023                         /* Here, have weeded out some things.  We want to see
20024                          * if the list of characters this node contains
20025                          * ('*our_code_points') precisely matches those of the
20026                          * class we are currently checking against
20027                          * ('*official_code_points'). */
20028                         if (_invlistEQ(*our_code_points,
20029                                        *official_code_points,
20030                                        try_inverted))
20031                         {
20032                             /* Here, they precisely match.  Optimize this ANYOF
20033                              * node into its equivalent POSIX one of the
20034                              * correct type, possibly inverted */
20035                             op = (try_inverted)
20036                                 ? type + NPOSIXA - POSIXA
20037                                 : type;
20038                             *ret = reg_node(pRExC_state, op);
20039                             FLAGS(REGNODE_p(*ret)) = posix_class;
20040                             SvREFCNT_dec(d_invlist);
20041                             SvREFCNT_dec(intersection);
20042                             return op;
20043                         }
20044                     }
20045                 }
20046             }
20047             SvREFCNT_dec(d_invlist);
20048             SvREFCNT_dec(intersection);
20049         }
20050
20051         /* If it is a single contiguous range, ANYOFR is an efficient regnode,
20052          * both in size and speed.  Currently, a 20 bit range base (smallest
20053          * code point in the range), and a 12 bit maximum delta are packed into
20054          * a 32 bit word.  This allows for using it on all of the Unicode code
20055          * points except for the highest plane, which is only for private use
20056          * code points.  khw doubts that a bigger delta is likely in real world
20057          * applications */
20058         if (     single_range
20059             && ! has_runtime_dependency
20060             &&   *anyof_flags == 0
20061             &&   start[0] < (1 << ANYOFR_BASE_BITS)
20062             &&   end[0] - start[0]
20063                     < ((1U << (sizeof(((struct regnode_1 *)NULL)->arg1)
20064                                    * CHARBITS - ANYOFR_BASE_BITS))))
20065
20066         {
20067             U8 low_utf8[UTF8_MAXBYTES+1];
20068             U8 high_utf8[UTF8_MAXBYTES+1];
20069
20070             op = ANYOFR;
20071             *ret = reganode(pRExC_state, op,
20072                         (start[0] | (end[0] - start[0]) << ANYOFR_BASE_BITS));
20073
20074             /* Place the lowest UTF-8 start byte in the flags field, so as to
20075              * allow efficient ruling out at run time of many possible inputs.
20076              * */
20077             (void) uvchr_to_utf8(low_utf8, start[0]);
20078             (void) uvchr_to_utf8(high_utf8, end[0]);
20079
20080             /* If all code points share the same first byte, this can be an
20081              * ANYOFRb.  Otherwise store the lowest UTF-8 start byte which can
20082              * quickly rule out many inputs at run-time without having to
20083              * compute the code point from UTF-8.  For EBCDIC, we use I8, as
20084              * not doing that transformation would not rule out nearly so many
20085              * things */
20086             if (low_utf8[0] == high_utf8[0]) {
20087                 op = ANYOFRb;
20088                 OP(REGNODE_p(*ret)) = op;
20089                 ANYOF_FLAGS(REGNODE_p(*ret)) = low_utf8[0];
20090             }
20091             else {
20092                 ANYOF_FLAGS(REGNODE_p(*ret))
20093                                     = NATIVE_UTF8_TO_I8(low_utf8[0]);
20094             }
20095
20096             return op;
20097         }
20098
20099         /* If didn't find an optimization and there is no need for a bitmap,
20100          * optimize to indicate that */
20101         if (     start[0] >= NUM_ANYOF_CODE_POINTS
20102             && ! LOC
20103             && ! upper_latin1_only_utf8_matches
20104             &&   *anyof_flags == 0)
20105         {
20106             U8 low_utf8[UTF8_MAXBYTES+1];
20107             UV highest_cp = invlist_highest(cp_list);
20108
20109             /* Currently the maximum allowed code point by the system is
20110              * IV_MAX.  Higher ones are reserved for future internal use.  This
20111              * particular regnode can be used for higher ones, but we can't
20112              * calculate the code point of those.  IV_MAX suffices though, as
20113              * it will be a large first byte */
20114             Size_t low_len = uvchr_to_utf8(low_utf8, MIN(start[0], IV_MAX))
20115                            - low_utf8;
20116
20117             /* We store the lowest possible first byte of the UTF-8
20118              * representation, using the flags field.  This allows for quick
20119              * ruling out of some inputs without having to convert from UTF-8
20120              * to code point.  For EBCDIC, we use I8, as not doing that
20121              * transformation would not rule out nearly so many things */
20122             *anyof_flags = NATIVE_UTF8_TO_I8(low_utf8[0]);
20123
20124             op = ANYOFH;
20125
20126             /* If the first UTF-8 start byte for the highest code point in the
20127              * range is suitably small, we may be able to get an upper bound as
20128              * well */
20129             if (highest_cp <= IV_MAX) {
20130                 U8 high_utf8[UTF8_MAXBYTES+1];
20131                 Size_t high_len = uvchr_to_utf8(high_utf8, highest_cp)
20132                                 - high_utf8;
20133
20134                 /* If the lowest and highest are the same, we can get an exact
20135                  * first byte instead of a just minimum or even a sequence of
20136                  * exact leading bytes.  We signal these with different
20137                  * regnodes */
20138                 if (low_utf8[0] == high_utf8[0]) {
20139                     Size_t len = find_first_differing_byte_pos(low_utf8,
20140                                                                high_utf8,
20141                                                        MIN(low_len, high_len));
20142
20143                     if (len == 1) {
20144
20145                         /* No need to convert to I8 for EBCDIC as this is an
20146                          * exact match */
20147                         *anyof_flags = low_utf8[0];
20148                         op = ANYOFHb;
20149                     }
20150                     else {
20151                         op = ANYOFHs;
20152                         *ret = regnode_guts(pRExC_state, op,
20153                                            regarglen[op] + STR_SZ(len),
20154                                            "anyofhs");
20155                         FILL_NODE(*ret, op);
20156                         ((struct regnode_anyofhs *) REGNODE_p(*ret))->str_len
20157                                                                         = len;
20158                         Copy(low_utf8,  /* Add the common bytes */
20159                         ((struct regnode_anyofhs *) REGNODE_p(*ret))->string,
20160                            len, U8);
20161                         RExC_emit += NODE_SZ_STR(REGNODE_p(*ret));
20162                         set_ANYOF_arg(pRExC_state, REGNODE_p(*ret), cp_list,
20163                                                   NULL, only_utf8_locale_list);
20164                         return op;
20165                     }
20166                 }
20167                 else if (NATIVE_UTF8_TO_I8(high_utf8[0]) <= MAX_ANYOF_HRx_BYTE)
20168                 {
20169
20170                     /* Here, the high byte is not the same as the low, but is
20171                      * small enough that its reasonable to have a loose upper
20172                      * bound, which is packed in with the strict lower bound.
20173                      * See comments at the definition of MAX_ANYOF_HRx_BYTE.
20174                      * On EBCDIC platforms, I8 is used.  On ASCII platforms I8
20175                      * is the same thing as UTF-8 */
20176
20177                     U8 bits = 0;
20178                     U8 max_range_diff = MAX_ANYOF_HRx_BYTE - *anyof_flags;
20179                     U8 range_diff = NATIVE_UTF8_TO_I8(high_utf8[0])
20180                                 - *anyof_flags;
20181
20182                     if (range_diff <= max_range_diff / 8) {
20183                         bits = 3;
20184                     }
20185                     else if (range_diff <= max_range_diff / 4) {
20186                         bits = 2;
20187                     }
20188                     else if (range_diff <= max_range_diff / 2) {
20189                         bits = 1;
20190                     }
20191                     *anyof_flags = (*anyof_flags - 0xC0) << 2 | bits;
20192                     op = ANYOFHr;
20193                 }
20194             }
20195         }
20196
20197         return op;
20198 }
20199
20200 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
20201
20202 STATIC void
20203 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
20204                 regnode* const node,
20205                 SV* const cp_list,
20206                 SV* const runtime_defns,
20207                 SV* const only_utf8_locale_list)
20208 {
20209     /* Sets the arg field of an ANYOF-type node 'node', using information about
20210      * the node passed-in.  If there is nothing outside the node's bitmap, the
20211      * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
20212      * the count returned by add_data(), having allocated and stored an array,
20213      * av, as follows:
20214      *
20215      *  av[0] stores the inversion list defining this class as far as known at
20216      *        this time, or PL_sv_undef if nothing definite is now known.
20217      *  av[1] stores the inversion list of code points that match only if the
20218      *        current locale is UTF-8, or if none, PL_sv_undef if there is an
20219      *        av[2], or no entry otherwise.
20220      *  av[2] stores the list of user-defined properties whose subroutine
20221      *        definitions aren't known at this time, or no entry if none. */
20222
20223     UV n;
20224
20225     PERL_ARGS_ASSERT_SET_ANYOF_ARG;
20226
20227     if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
20228         assert(! (ANYOF_FLAGS(node)
20229                 & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP));
20230         ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
20231     }
20232     else {
20233         AV * const av = newAV();
20234         SV *rv;
20235
20236         if (cp_list) {
20237             av_store(av, INVLIST_INDEX, SvREFCNT_inc_NN(cp_list));
20238         }
20239
20240         /* (Note that if any of this changes, the size calculations in
20241          * S_optimize_regclass() might need to be updated.) */
20242
20243         if (only_utf8_locale_list) {
20244             av_store(av, ONLY_LOCALE_MATCHES_INDEX,
20245                                      SvREFCNT_inc_NN(only_utf8_locale_list));
20246         }
20247
20248         if (runtime_defns) {
20249             av_store(av, DEFERRED_USER_DEFINED_INDEX,
20250                          SvREFCNT_inc_NN(runtime_defns));
20251         }
20252
20253         rv = newRV_noinc(MUTABLE_SV(av));
20254         n = add_data(pRExC_state, STR_WITH_LEN("s"));
20255         RExC_rxi->data->data[n] = (void*)rv;
20256         ARG_SET(node, n);
20257     }
20258 }
20259
20260 SV *
20261
20262 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
20263 Perl_get_regclass_nonbitmap_data(pTHX_ const regexp *prog, const regnode* node, bool doinit, SV** listsvp, SV** only_utf8_locale_ptr, SV** output_invlist)
20264 #else
20265 Perl_get_re_gclass_nonbitmap_data(pTHX_ const regexp *prog, const regnode* node, bool doinit, SV** listsvp, SV** only_utf8_locale_ptr, SV** output_invlist)
20266 #endif
20267
20268 {
20269     /* For internal core use only.
20270      * Returns the inversion list for the input 'node' in the regex 'prog'.
20271      * If <doinit> is 'true', will attempt to create the inversion list if not
20272      *    already done.
20273      * If <listsvp> is non-null, will return the printable contents of the
20274      *    property definition.  This can be used to get debugging information
20275      *    even before the inversion list exists, by calling this function with
20276      *    'doinit' set to false, in which case the components that will be used
20277      *    to eventually create the inversion list are returned  (in a printable
20278      *    form).
20279      * If <only_utf8_locale_ptr> is not NULL, it is where this routine is to
20280      *    store an inversion list of code points that should match only if the
20281      *    execution-time locale is a UTF-8 one.
20282      * If <output_invlist> is not NULL, it is where this routine is to store an
20283      *    inversion list of the code points that would be instead returned in
20284      *    <listsvp> if this were NULL.  Thus, what gets output in <listsvp>
20285      *    when this parameter is used, is just the non-code point data that
20286      *    will go into creating the inversion list.  This currently should be just
20287      *    user-defined properties whose definitions were not known at compile
20288      *    time.  Using this parameter allows for easier manipulation of the
20289      *    inversion list's data by the caller.  It is illegal to call this
20290      *    function with this parameter set, but not <listsvp>
20291      *
20292      * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
20293      * that, in spite of this function's name, the inversion list it returns
20294      * may include the bitmap data as well */
20295
20296     SV *si  = NULL;         /* Input initialization string */
20297     SV* invlist = NULL;
20298
20299     RXi_GET_DECL(prog, progi);
20300     const struct reg_data * const data = prog ? progi->data : NULL;
20301
20302 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
20303     PERL_ARGS_ASSERT_GET_REGCLASS_NONBITMAP_DATA;
20304 #else
20305     PERL_ARGS_ASSERT_GET_RE_GCLASS_NONBITMAP_DATA;
20306 #endif
20307     assert(! output_invlist || listsvp);
20308
20309     if (data && data->count) {
20310         const U32 n = ARG(node);
20311
20312         if (data->what[n] == 's') {
20313             SV * const rv = MUTABLE_SV(data->data[n]);
20314             AV * const av = MUTABLE_AV(SvRV(rv));
20315             SV **const ary = AvARRAY(av);
20316
20317             invlist = ary[INVLIST_INDEX];
20318
20319             if (av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX) {
20320                 *only_utf8_locale_ptr = ary[ONLY_LOCALE_MATCHES_INDEX];
20321             }
20322
20323             if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
20324                 si = ary[DEFERRED_USER_DEFINED_INDEX];
20325             }
20326
20327             if (doinit && (si || invlist)) {
20328                 if (si) {
20329                     bool user_defined;
20330                     SV * msg = newSVpvs_flags("", SVs_TEMP);
20331
20332                     SV * prop_definition = handle_user_defined_property(
20333                             "", 0, FALSE,   /* There is no \p{}, \P{} */
20334                             SvPVX_const(si)[1] - '0',   /* /i or not has been
20335                                                            stored here for just
20336                                                            this occasion */
20337                             TRUE,           /* run time */
20338                             FALSE,          /* This call must find the defn */
20339                             si,             /* The property definition  */
20340                             &user_defined,
20341                             msg,
20342                             0               /* base level call */
20343                            );
20344
20345                     if (SvCUR(msg)) {
20346                         assert(prop_definition == NULL);
20347
20348                         Perl_croak(aTHX_ "%" UTF8f,
20349                                 UTF8fARG(SvUTF8(msg), SvCUR(msg), SvPVX(msg)));
20350                     }
20351
20352                     if (invlist) {
20353                         _invlist_union(invlist, prop_definition, &invlist);
20354                         SvREFCNT_dec_NN(prop_definition);
20355                     }
20356                     else {
20357                         invlist = prop_definition;
20358                     }
20359
20360                     STATIC_ASSERT_STMT(ONLY_LOCALE_MATCHES_INDEX == 1 + INVLIST_INDEX);
20361                     STATIC_ASSERT_STMT(DEFERRED_USER_DEFINED_INDEX == 1 + ONLY_LOCALE_MATCHES_INDEX);
20362
20363                     ary[INVLIST_INDEX] = invlist;
20364                     av_fill(av, (ary[ONLY_LOCALE_MATCHES_INDEX])
20365                                  ? ONLY_LOCALE_MATCHES_INDEX
20366                                  : INVLIST_INDEX);
20367                     si = NULL;
20368                 }
20369             }
20370         }
20371     }
20372
20373     /* If requested, return a printable version of what this ANYOF node matches
20374      * */
20375     if (listsvp) {
20376         SV* matches_string = NULL;
20377
20378         /* This function can be called at compile-time, before everything gets
20379          * resolved, in which case we return the currently best available
20380          * information, which is the string that will eventually be used to do
20381          * that resolving, 'si' */
20382         if (si) {
20383             /* Here, we only have 'si' (and possibly some passed-in data in
20384              * 'invlist', which is handled below)  If the caller only wants
20385              * 'si', use that.  */
20386             if (! output_invlist) {
20387                 matches_string = newSVsv(si);
20388             }
20389             else {
20390                 /* But if the caller wants an inversion list of the node, we
20391                  * need to parse 'si' and place as much as possible in the
20392                  * desired output inversion list, making 'matches_string' only
20393                  * contain the currently unresolvable things */
20394                 const char *si_string = SvPVX(si);
20395                 STRLEN remaining = SvCUR(si);
20396                 UV prev_cp = 0;
20397                 U8 count = 0;
20398
20399                 /* Ignore everything before and including the first new-line */
20400                 si_string = (const char *) memchr(si_string, '\n', SvCUR(si));
20401                 assert (si_string != NULL);
20402                 si_string++;
20403                 remaining = SvPVX(si) + SvCUR(si) - si_string;
20404
20405                 while (remaining > 0) {
20406
20407                     /* The data consists of just strings defining user-defined
20408                      * property names, but in prior incarnations, and perhaps
20409                      * somehow from pluggable regex engines, it could still
20410                      * hold hex code point definitions, all of which should be
20411                      * legal (or it wouldn't have gotten this far).  Each
20412                      * component of a range would be separated by a tab, and
20413                      * each range by a new-line.  If these are found, instead
20414                      * add them to the inversion list */
20415                     I32 grok_flags =  PERL_SCAN_SILENT_ILLDIGIT
20416                                      |PERL_SCAN_SILENT_NON_PORTABLE;
20417                     STRLEN len = remaining;
20418                     UV cp = grok_hex(si_string, &len, &grok_flags, NULL);
20419
20420                     /* If the hex decode routine found something, it should go
20421                      * up to the next \n */
20422                     if (   *(si_string + len) == '\n') {
20423                         if (count) {    /* 2nd code point on line */
20424                             *output_invlist = _add_range_to_invlist(*output_invlist, prev_cp, cp);
20425                         }
20426                         else {
20427                             *output_invlist = add_cp_to_invlist(*output_invlist, cp);
20428                         }
20429                         count = 0;
20430                         goto prepare_for_next_iteration;
20431                     }
20432
20433                     /* If the hex decode was instead for the lower range limit,
20434                      * save it, and go parse the upper range limit */
20435                     if (*(si_string + len) == '\t') {
20436                         assert(count == 0);
20437
20438                         prev_cp = cp;
20439                         count = 1;
20440                       prepare_for_next_iteration:
20441                         si_string += len + 1;
20442                         remaining -= len + 1;
20443                         continue;
20444                     }
20445
20446                     /* Here, didn't find a legal hex number.  Just add the text
20447                      * from here up to the next \n, omitting any trailing
20448                      * markers. */
20449
20450                     remaining -= len;
20451                     len = strcspn(si_string,
20452                                         DEFERRED_COULD_BE_OFFICIAL_MARKERs "\n");
20453                     remaining -= len;
20454                     if (matches_string) {
20455                         sv_catpvn(matches_string, si_string, len);
20456                     }
20457                     else {
20458                         matches_string = newSVpvn(si_string, len);
20459                     }
20460                     sv_catpvs(matches_string, " ");
20461
20462                     si_string += len;
20463                     if (   remaining
20464                         && UCHARAT(si_string)
20465                                             == DEFERRED_COULD_BE_OFFICIAL_MARKERc)
20466                     {
20467                         si_string++;
20468                         remaining--;
20469                     }
20470                     if (remaining && UCHARAT(si_string) == '\n') {
20471                         si_string++;
20472                         remaining--;
20473                     }
20474                 } /* end of loop through the text */
20475
20476                 assert(matches_string);
20477                 if (SvCUR(matches_string)) {  /* Get rid of trailing blank */
20478                     SvCUR_set(matches_string, SvCUR(matches_string) - 1);
20479                 }
20480             } /* end of has an 'si' */
20481         }
20482
20483         /* Add the stuff that's already known */
20484         if (invlist) {
20485
20486             /* Again, if the caller doesn't want the output inversion list, put
20487              * everything in 'matches-string' */
20488             if (! output_invlist) {
20489                 if ( ! matches_string) {
20490                     matches_string = newSVpvs("\n");
20491                 }
20492                 sv_catsv(matches_string, invlist_contents(invlist,
20493                                                   TRUE /* traditional style */
20494                                                   ));
20495             }
20496             else if (! *output_invlist) {
20497                 *output_invlist = invlist_clone(invlist, NULL);
20498             }
20499             else {
20500                 _invlist_union(*output_invlist, invlist, output_invlist);
20501             }
20502         }
20503
20504         *listsvp = matches_string;
20505     }
20506
20507     return invlist;
20508 }
20509
20510 /* reg_skipcomment()
20511
20512    Absorbs an /x style # comment from the input stream,
20513    returning a pointer to the first character beyond the comment, or if the
20514    comment terminates the pattern without anything following it, this returns
20515    one past the final character of the pattern (in other words, RExC_end) and
20516    sets the REG_RUN_ON_COMMENT_SEEN flag.
20517
20518    Note it's the callers responsibility to ensure that we are
20519    actually in /x mode
20520
20521 */
20522
20523 PERL_STATIC_INLINE char*
20524 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
20525 {
20526     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
20527
20528     assert(*p == '#');
20529
20530     while (p < RExC_end) {
20531         if (*(++p) == '\n') {
20532             return p+1;
20533         }
20534     }
20535
20536     /* we ran off the end of the pattern without ending the comment, so we have
20537      * to add an \n when wrapping */
20538     RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
20539     return p;
20540 }
20541
20542 STATIC void
20543 S_skip_to_be_ignored_text(pTHX_ RExC_state_t *pRExC_state,
20544                                 char ** p,
20545                                 const bool force_to_xmod
20546                          )
20547 {
20548     /* If the text at the current parse position '*p' is a '(?#...)' comment,
20549      * or if we are under /x or 'force_to_xmod' is TRUE, and the text at '*p'
20550      * is /x whitespace, advance '*p' so that on exit it points to the first
20551      * byte past all such white space and comments */
20552
20553     const bool use_xmod = force_to_xmod || (RExC_flags & RXf_PMf_EXTENDED);
20554
20555     PERL_ARGS_ASSERT_SKIP_TO_BE_IGNORED_TEXT;
20556
20557     assert( ! UTF || UTF8_IS_INVARIANT(**p) || UTF8_IS_START(**p));
20558
20559     for (;;) {
20560         if (RExC_end - (*p) >= 3
20561             && *(*p)     == '('
20562             && *(*p + 1) == '?'
20563             && *(*p + 2) == '#')
20564         {
20565             while (*(*p) != ')') {
20566                 if ((*p) == RExC_end)
20567                     FAIL("Sequence (?#... not terminated");
20568                 (*p)++;
20569             }
20570             (*p)++;
20571             continue;
20572         }
20573
20574         if (use_xmod) {
20575             const char * save_p = *p;
20576             while ((*p) < RExC_end) {
20577                 STRLEN len;
20578                 if ((len = is_PATWS_safe((*p), RExC_end, UTF))) {
20579                     (*p) += len;
20580                 }
20581                 else if (*(*p) == '#') {
20582                     (*p) = reg_skipcomment(pRExC_state, (*p));
20583                 }
20584                 else {
20585                     break;
20586                 }
20587             }
20588             if (*p != save_p) {
20589                 continue;
20590             }
20591         }
20592
20593         break;
20594     }
20595
20596     return;
20597 }
20598
20599 /* nextchar()
20600
20601    Advances the parse position by one byte, unless that byte is the beginning
20602    of a '(?#...)' style comment, or is /x whitespace and /x is in effect.  In
20603    those two cases, the parse position is advanced beyond all such comments and
20604    white space.
20605
20606    This is the UTF, (?#...), and /x friendly way of saying RExC_parse++.
20607 */
20608
20609 STATIC void
20610 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
20611 {
20612     PERL_ARGS_ASSERT_NEXTCHAR;
20613
20614     if (RExC_parse < RExC_end) {
20615         assert(   ! UTF
20616                || UTF8_IS_INVARIANT(*RExC_parse)
20617                || UTF8_IS_START(*RExC_parse));
20618
20619         RExC_parse += (UTF)
20620                       ? UTF8_SAFE_SKIP(RExC_parse, RExC_end)
20621                       : 1;
20622
20623         skip_to_be_ignored_text(pRExC_state, &RExC_parse,
20624                                 FALSE /* Don't force /x */ );
20625     }
20626 }
20627
20628 STATIC void
20629 S_change_engine_size(pTHX_ RExC_state_t *pRExC_state, const Ptrdiff_t size)
20630 {
20631     /* 'size' is the delta number of smallest regnode equivalents to add or
20632      * subtract from the current memory allocated to the regex engine being
20633      * constructed. */
20634
20635     PERL_ARGS_ASSERT_CHANGE_ENGINE_SIZE;
20636
20637     RExC_size += size;
20638
20639     Renewc(RExC_rxi,
20640            sizeof(regexp_internal) + (RExC_size + 1) * sizeof(regnode),
20641                                                 /* +1 for REG_MAGIC */
20642            char,
20643            regexp_internal);
20644     if ( RExC_rxi == NULL )
20645         FAIL("Regexp out of space");
20646     RXi_SET(RExC_rx, RExC_rxi);
20647
20648     RExC_emit_start = RExC_rxi->program;
20649     if (size > 0) {
20650         Zero(REGNODE_p(RExC_emit), size, regnode);
20651     }
20652
20653 #ifdef RE_TRACK_PATTERN_OFFSETS
20654     Renew(RExC_offsets, 2*RExC_size+1, U32);
20655     if (size > 0) {
20656         Zero(RExC_offsets + 2*(RExC_size - size) + 1, 2 * size, U32);
20657     }
20658     RExC_offsets[0] = RExC_size;
20659 #endif
20660 }
20661
20662 STATIC regnode_offset
20663 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
20664 {
20665     /* Allocate a regnode for 'op', with 'extra_size' extra (smallest) regnode
20666      * equivalents space.  It aligns and increments RExC_size
20667      *
20668      * It returns the regnode's offset into the regex engine program */
20669
20670     const regnode_offset ret = RExC_emit;
20671
20672     DECLARE_AND_GET_RE_DEBUG_FLAGS;
20673
20674     PERL_ARGS_ASSERT_REGNODE_GUTS;
20675
20676     SIZE_ALIGN(RExC_size);
20677     change_engine_size(pRExC_state, (Ptrdiff_t) 1 + extra_size);
20678     NODE_ALIGN_FILL(REGNODE_p(ret));
20679 #ifndef RE_TRACK_PATTERN_OFFSETS
20680     PERL_UNUSED_ARG(name);
20681     PERL_UNUSED_ARG(op);
20682 #else
20683     assert(extra_size >= regarglen[op] || PL_regkind[op] == ANYOF);
20684
20685     if (RExC_offsets) {         /* MJD */
20686         MJD_OFFSET_DEBUG(
20687               ("%s:%d: (op %s) %s %" UVuf " (len %" UVuf ") (max %" UVuf ").\n",
20688               name, __LINE__,
20689               PL_reg_name[op],
20690               (UV)(RExC_emit) > RExC_offsets[0]
20691                 ? "Overwriting end of array!\n" : "OK",
20692               (UV)(RExC_emit),
20693               (UV)(RExC_parse - RExC_start),
20694               (UV)RExC_offsets[0]));
20695         Set_Node_Offset(REGNODE_p(RExC_emit), RExC_parse + (op == END));
20696     }
20697 #endif
20698     return(ret);
20699 }
20700
20701 /*
20702 - reg_node - emit a node
20703 */
20704 STATIC regnode_offset /* Location. */
20705 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
20706 {
20707     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
20708     regnode_offset ptr = ret;
20709
20710     PERL_ARGS_ASSERT_REG_NODE;
20711
20712     assert(regarglen[op] == 0);
20713
20714     FILL_ADVANCE_NODE(ptr, op);
20715     RExC_emit = ptr;
20716     return(ret);
20717 }
20718
20719 /*
20720 - reganode - emit a node with an argument
20721 */
20722 STATIC regnode_offset /* Location. */
20723 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
20724 {
20725     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
20726     regnode_offset ptr = ret;
20727
20728     PERL_ARGS_ASSERT_REGANODE;
20729
20730     /* ANYOF are special cased to allow non-length 1 args */
20731     assert(regarglen[op] == 1);
20732
20733     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
20734     RExC_emit = ptr;
20735     return(ret);
20736 }
20737
20738 /*
20739 - regpnode - emit a temporary node with a SV* argument
20740 */
20741 STATIC regnode_offset /* Location. */
20742 S_regpnode(pTHX_ RExC_state_t *pRExC_state, U8 op, SV * arg)
20743 {
20744     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "regpnode");
20745     regnode_offset ptr = ret;
20746
20747     PERL_ARGS_ASSERT_REGPNODE;
20748
20749     FILL_ADVANCE_NODE_ARGp(ptr, op, arg);
20750     RExC_emit = ptr;
20751     return(ret);
20752 }
20753
20754 STATIC regnode_offset
20755 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
20756 {
20757     /* emit a node with U32 and I32 arguments */
20758
20759     const regnode_offset ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
20760     regnode_offset ptr = ret;
20761
20762     PERL_ARGS_ASSERT_REG2LANODE;
20763
20764     assert(regarglen[op] == 2);
20765
20766     FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
20767     RExC_emit = ptr;
20768     return(ret);
20769 }
20770
20771 /*
20772 - reginsert - insert an operator in front of already-emitted operand
20773 *
20774 * That means that on exit 'operand' is the offset of the newly inserted
20775 * operator, and the original operand has been relocated.
20776 *
20777 * IMPORTANT NOTE - it is the *callers* responsibility to correctly
20778 * set up NEXT_OFF() of the inserted node if needed. Something like this:
20779 *
20780 *   reginsert(pRExC, OPFAIL, orig_emit, depth+1);
20781 *   NEXT_OFF(orig_emit) = regarglen[OPFAIL] + NODE_STEP_REGNODE;
20782 *
20783 * ALSO NOTE - FLAGS(newly-inserted-operator) will be set to 0 as well.
20784 */
20785 STATIC void
20786 S_reginsert(pTHX_ RExC_state_t *pRExC_state, const U8 op,
20787                   const regnode_offset operand, const U32 depth)
20788 {
20789     regnode *src;
20790     regnode *dst;
20791     regnode *place;
20792     const int offset = regarglen[(U8)op];
20793     const int size = NODE_STEP_REGNODE + offset;
20794     DECLARE_AND_GET_RE_DEBUG_FLAGS;
20795
20796     PERL_ARGS_ASSERT_REGINSERT;
20797     PERL_UNUSED_CONTEXT;
20798     PERL_UNUSED_ARG(depth);
20799 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
20800     DEBUG_PARSE_FMT("inst"," - %s", PL_reg_name[op]);
20801     assert(!RExC_study_started); /* I believe we should never use reginsert once we have started
20802                                     studying. If this is wrong then we need to adjust RExC_recurse
20803                                     below like we do with RExC_open_parens/RExC_close_parens. */
20804     change_engine_size(pRExC_state, (Ptrdiff_t) size);
20805     src = REGNODE_p(RExC_emit);
20806     RExC_emit += size;
20807     dst = REGNODE_p(RExC_emit);
20808
20809     /* If we are in a "count the parentheses" pass, the numbers are unreliable,
20810      * and [perl #133871] shows this can lead to problems, so skip this
20811      * realignment of parens until a later pass when they are reliable */
20812     if (! IN_PARENS_PASS && RExC_open_parens) {
20813         int paren;
20814         /*DEBUG_PARSE_FMT("inst"," - %" IVdf, (IV)RExC_npar);*/
20815         /* remember that RExC_npar is rex->nparens + 1,
20816          * iow it is 1 more than the number of parens seen in
20817          * the pattern so far. */
20818         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
20819             /* note, RExC_open_parens[0] is the start of the
20820              * regex, it can't move. RExC_close_parens[0] is the end
20821              * of the regex, it *can* move. */
20822             if ( paren && RExC_open_parens[paren] >= operand ) {
20823                 /*DEBUG_PARSE_FMT("open"," - %d", size);*/
20824                 RExC_open_parens[paren] += size;
20825             } else {
20826                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
20827             }
20828             if ( RExC_close_parens[paren] >= operand ) {
20829                 /*DEBUG_PARSE_FMT("close"," - %d", size);*/
20830                 RExC_close_parens[paren] += size;
20831             } else {
20832                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
20833             }
20834         }
20835     }
20836     if (RExC_end_op)
20837         RExC_end_op += size;
20838
20839     while (src > REGNODE_p(operand)) {
20840         StructCopy(--src, --dst, regnode);
20841 #ifdef RE_TRACK_PATTERN_OFFSETS
20842         if (RExC_offsets) {     /* MJD 20010112 */
20843             MJD_OFFSET_DEBUG(
20844                  ("%s(%d): (op %s) %s copy %" UVuf " -> %" UVuf " (max %" UVuf ").\n",
20845                   "reginsert",
20846                   __LINE__,
20847                   PL_reg_name[op],
20848                   (UV)(REGNODE_OFFSET(dst)) > RExC_offsets[0]
20849                     ? "Overwriting end of array!\n" : "OK",
20850                   (UV)REGNODE_OFFSET(src),
20851                   (UV)REGNODE_OFFSET(dst),
20852                   (UV)RExC_offsets[0]));
20853             Set_Node_Offset_To_R(REGNODE_OFFSET(dst), Node_Offset(src));
20854             Set_Node_Length_To_R(REGNODE_OFFSET(dst), Node_Length(src));
20855         }
20856 #endif
20857     }
20858
20859     place = REGNODE_p(operand); /* Op node, where operand used to be. */
20860 #ifdef RE_TRACK_PATTERN_OFFSETS
20861     if (RExC_offsets) {         /* MJD */
20862         MJD_OFFSET_DEBUG(
20863               ("%s(%d): (op %s) %s %" UVuf " <- %" UVuf " (max %" UVuf ").\n",
20864               "reginsert",
20865               __LINE__,
20866               PL_reg_name[op],
20867               (UV)REGNODE_OFFSET(place) > RExC_offsets[0]
20868               ? "Overwriting end of array!\n" : "OK",
20869               (UV)REGNODE_OFFSET(place),
20870               (UV)(RExC_parse - RExC_start),
20871               (UV)RExC_offsets[0]));
20872         Set_Node_Offset(place, RExC_parse);
20873         Set_Node_Length(place, 1);
20874     }
20875 #endif
20876     src = NEXTOPER(place);
20877     FLAGS(place) = 0;
20878     FILL_NODE(operand, op);
20879
20880     /* Zero out any arguments in the new node */
20881     Zero(src, offset, regnode);
20882 }
20883
20884 /*
20885 - regtail - set the next-pointer at the end of a node chain of p to val.  If
20886             that value won't fit in the space available, instead returns FALSE.
20887             (Except asserts if we can't fit in the largest space the regex
20888             engine is designed for.)
20889 - SEE ALSO: regtail_study
20890 */
20891 STATIC bool
20892 S_regtail(pTHX_ RExC_state_t * pRExC_state,
20893                 const regnode_offset p,
20894                 const regnode_offset val,
20895                 const U32 depth)
20896 {
20897     regnode_offset scan;
20898     DECLARE_AND_GET_RE_DEBUG_FLAGS;
20899
20900     PERL_ARGS_ASSERT_REGTAIL;
20901 #ifndef DEBUGGING
20902     PERL_UNUSED_ARG(depth);
20903 #endif
20904
20905     /* The final node in the chain is the first one with a nonzero next pointer
20906      * */
20907     scan = (regnode_offset) p;
20908     for (;;) {
20909         regnode * const temp = regnext(REGNODE_p(scan));
20910         DEBUG_PARSE_r({
20911             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
20912             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
20913             Perl_re_printf( aTHX_  "~ %s (%zu) %s %s\n",
20914                 SvPV_nolen_const(RExC_mysv), scan,
20915                     (temp == NULL ? "->" : ""),
20916                     (temp == NULL ? PL_reg_name[OP(REGNODE_p(val))] : "")
20917             );
20918         });
20919         if (temp == NULL)
20920             break;
20921         scan = REGNODE_OFFSET(temp);
20922     }
20923
20924     /* Populate this node's next pointer */
20925     assert(val >= scan);
20926     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
20927         assert((UV) (val - scan) <= U32_MAX);
20928         ARG_SET(REGNODE_p(scan), val - scan);
20929     }
20930     else {
20931         if (val - scan > U16_MAX) {
20932             /* Populate this with something that won't loop and will likely
20933              * lead to a crash if the caller ignores the failure return, and
20934              * execution continues */
20935             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
20936             return FALSE;
20937         }
20938         NEXT_OFF(REGNODE_p(scan)) = val - scan;
20939     }
20940
20941     return TRUE;
20942 }
20943
20944 #ifdef DEBUGGING
20945 /*
20946 - regtail_study - set the next-pointer at the end of a node chain of p to val.
20947 - Look for optimizable sequences at the same time.
20948 - currently only looks for EXACT chains.
20949
20950 This is experimental code. The idea is to use this routine to perform
20951 in place optimizations on branches and groups as they are constructed,
20952 with the long term intention of removing optimization from study_chunk so
20953 that it is purely analytical.
20954
20955 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
20956 to control which is which.
20957
20958 This used to return a value that was ignored.  It was a problem that it is
20959 #ifdef'd to be another function that didn't return a value.  khw has changed it
20960 so both currently return a pass/fail return.
20961
20962 */
20963 /* TODO: All four parms should be const */
20964
20965 STATIC bool
20966 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode_offset p,
20967                       const regnode_offset val, U32 depth)
20968 {
20969     regnode_offset scan;
20970     U8 exact = PSEUDO;
20971 #ifdef EXPERIMENTAL_INPLACESCAN
20972     I32 min = 0;
20973 #endif
20974     DECLARE_AND_GET_RE_DEBUG_FLAGS;
20975
20976     PERL_ARGS_ASSERT_REGTAIL_STUDY;
20977
20978
20979     /* Find last node. */
20980
20981     scan = p;
20982     for (;;) {
20983         regnode * const temp = regnext(REGNODE_p(scan));
20984 #ifdef EXPERIMENTAL_INPLACESCAN
20985         if (PL_regkind[OP(REGNODE_p(scan))] == EXACT) {
20986             bool unfolded_multi_char;   /* Unexamined in this routine */
20987             if (join_exact(pRExC_state, scan, &min,
20988                            &unfolded_multi_char, 1, REGNODE_p(val), depth+1))
20989                 return TRUE; /* Was return EXACT */
20990         }
20991 #endif
20992         if ( exact ) {
20993             if (PL_regkind[OP(REGNODE_p(scan))] == EXACT) {
20994                 if (exact == PSEUDO )
20995                     exact= OP(REGNODE_p(scan));
20996                 else if (exact != OP(REGNODE_p(scan)) )
20997                     exact= 0;
20998             }
20999             else if (OP(REGNODE_p(scan)) != NOTHING) {
21000                 exact= 0;
21001             }
21002         }
21003         DEBUG_PARSE_r({
21004             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
21005             regprop(RExC_rx, RExC_mysv, REGNODE_p(scan), NULL, pRExC_state);
21006             Perl_re_printf( aTHX_  "~ %s (%zu) -> %s\n",
21007                 SvPV_nolen_const(RExC_mysv),
21008                 scan,
21009                 PL_reg_name[exact]);
21010         });
21011         if (temp == NULL)
21012             break;
21013         scan = REGNODE_OFFSET(temp);
21014     }
21015     DEBUG_PARSE_r({
21016         DEBUG_PARSE_MSG("");
21017         regprop(RExC_rx, RExC_mysv, REGNODE_p(val), NULL, pRExC_state);
21018         Perl_re_printf( aTHX_
21019                       "~ attach to %s (%" IVdf ") offset to %" IVdf "\n",
21020                       SvPV_nolen_const(RExC_mysv),
21021                       (IV)val,
21022                       (IV)(val - scan)
21023         );
21024     });
21025     if (reg_off_by_arg[OP(REGNODE_p(scan))]) {
21026         assert((UV) (val - scan) <= U32_MAX);
21027         ARG_SET(REGNODE_p(scan), val - scan);
21028     }
21029     else {
21030         if (val - scan > U16_MAX) {
21031             /* Populate this with something that won't loop and will likely
21032              * lead to a crash if the caller ignores the failure return, and
21033              * execution continues */
21034             NEXT_OFF(REGNODE_p(scan)) = U16_MAX;
21035             return FALSE;
21036         }
21037         NEXT_OFF(REGNODE_p(scan)) = val - scan;
21038     }
21039
21040     return TRUE; /* Was 'return exact' */
21041 }
21042 #endif
21043
21044 STATIC SV*
21045 S_get_ANYOFM_contents(pTHX_ const regnode * n) {
21046
21047     /* Returns an inversion list of all the code points matched by the
21048      * ANYOFM/NANYOFM node 'n' */
21049
21050     SV * cp_list = _new_invlist(-1);
21051     const U8 lowest = (U8) ARG(n);
21052     unsigned int i;
21053     U8 count = 0;
21054     U8 needed = 1U << PL_bitcount[ (U8) ~ FLAGS(n)];
21055
21056     PERL_ARGS_ASSERT_GET_ANYOFM_CONTENTS;
21057
21058     /* Starting with the lowest code point, any code point that ANDed with the
21059      * mask yields the lowest code point is in the set */
21060     for (i = lowest; i <= 0xFF; i++) {
21061         if ((i & FLAGS(n)) == ARG(n)) {
21062             cp_list = add_cp_to_invlist(cp_list, i);
21063             count++;
21064
21065             /* We know how many code points (a power of two) that are in the
21066              * set.  No use looking once we've got that number */
21067             if (count >= needed) break;
21068         }
21069     }
21070
21071     if (OP(n) == NANYOFM) {
21072         _invlist_invert(cp_list);
21073     }
21074     return cp_list;
21075 }
21076
21077 /*
21078  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
21079  */
21080 #ifdef DEBUGGING
21081
21082 static void
21083 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
21084 {
21085     int bit;
21086     int set=0;
21087
21088     ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
21089
21090     for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
21091         if (flags & (1<<bit)) {
21092             if (!set++ && lead)
21093                 Perl_re_printf( aTHX_  "%s", lead);
21094             Perl_re_printf( aTHX_  "%s ", PL_reg_intflags_name[bit]);
21095         }
21096     }
21097     if (lead)  {
21098         if (set)
21099             Perl_re_printf( aTHX_  "\n");
21100         else
21101             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
21102     }
21103 }
21104
21105 static void
21106 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
21107 {
21108     int bit;
21109     int set=0;
21110     regex_charset cs;
21111
21112     ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
21113
21114     for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
21115         if (flags & (1<<bit)) {
21116             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
21117                 continue;
21118             }
21119             if (!set++ && lead)
21120                 Perl_re_printf( aTHX_  "%s", lead);
21121             Perl_re_printf( aTHX_  "%s ", PL_reg_extflags_name[bit]);
21122         }
21123     }
21124     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
21125             if (!set++ && lead) {
21126                 Perl_re_printf( aTHX_  "%s", lead);
21127             }
21128             switch (cs) {
21129                 case REGEX_UNICODE_CHARSET:
21130                     Perl_re_printf( aTHX_  "UNICODE");
21131                     break;
21132                 case REGEX_LOCALE_CHARSET:
21133                     Perl_re_printf( aTHX_  "LOCALE");
21134                     break;
21135                 case REGEX_ASCII_RESTRICTED_CHARSET:
21136                     Perl_re_printf( aTHX_  "ASCII-RESTRICTED");
21137                     break;
21138                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
21139                     Perl_re_printf( aTHX_  "ASCII-MORE_RESTRICTED");
21140                     break;
21141                 default:
21142                     Perl_re_printf( aTHX_  "UNKNOWN CHARACTER SET");
21143                     break;
21144             }
21145     }
21146     if (lead)  {
21147         if (set)
21148             Perl_re_printf( aTHX_  "\n");
21149         else
21150             Perl_re_printf( aTHX_  "%s[none-set]\n", lead);
21151     }
21152 }
21153 #endif
21154
21155 void
21156 Perl_regdump(pTHX_ const regexp *r)
21157 {
21158 #ifdef DEBUGGING
21159     int i;
21160     SV * const sv = sv_newmortal();
21161     SV *dsv= sv_newmortal();
21162     RXi_GET_DECL(r, ri);
21163     DECLARE_AND_GET_RE_DEBUG_FLAGS;
21164
21165     PERL_ARGS_ASSERT_REGDUMP;
21166
21167     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
21168
21169     /* Header fields of interest. */
21170     for (i = 0; i < 2; i++) {
21171         if (r->substrs->data[i].substr) {
21172             RE_PV_QUOTED_DECL(s, 0, dsv,
21173                             SvPVX_const(r->substrs->data[i].substr),
21174                             RE_SV_DUMPLEN(r->substrs->data[i].substr),
21175                             PL_dump_re_max_len);
21176             Perl_re_printf( aTHX_
21177                           "%s %s%s at %" IVdf "..%" UVuf " ",
21178                           i ? "floating" : "anchored",
21179                           s,
21180                           RE_SV_TAIL(r->substrs->data[i].substr),
21181                           (IV)r->substrs->data[i].min_offset,
21182                           (UV)r->substrs->data[i].max_offset);
21183         }
21184         else if (r->substrs->data[i].utf8_substr) {
21185             RE_PV_QUOTED_DECL(s, 1, dsv,
21186                             SvPVX_const(r->substrs->data[i].utf8_substr),
21187                             RE_SV_DUMPLEN(r->substrs->data[i].utf8_substr),
21188                             30);
21189             Perl_re_printf( aTHX_
21190                           "%s utf8 %s%s at %" IVdf "..%" UVuf " ",
21191                           i ? "floating" : "anchored",
21192                           s,
21193                           RE_SV_TAIL(r->substrs->data[i].utf8_substr),
21194                           (IV)r->substrs->data[i].min_offset,
21195                           (UV)r->substrs->data[i].max_offset);
21196         }
21197     }
21198
21199     if (r->check_substr || r->check_utf8)
21200         Perl_re_printf( aTHX_
21201                       (const char *)
21202                       (   r->check_substr == r->substrs->data[1].substr
21203                        && r->check_utf8   == r->substrs->data[1].utf8_substr
21204                        ? "(checking floating" : "(checking anchored"));
21205     if (r->intflags & PREGf_NOSCAN)
21206         Perl_re_printf( aTHX_  " noscan");
21207     if (r->extflags & RXf_CHECK_ALL)
21208         Perl_re_printf( aTHX_  " isall");
21209     if (r->check_substr || r->check_utf8)
21210         Perl_re_printf( aTHX_  ") ");
21211
21212     if (ri->regstclass) {
21213         regprop(r, sv, ri->regstclass, NULL, NULL);
21214         Perl_re_printf( aTHX_  "stclass %s ", SvPVX_const(sv));
21215     }
21216     if (r->intflags & PREGf_ANCH) {
21217         Perl_re_printf( aTHX_  "anchored");
21218         if (r->intflags & PREGf_ANCH_MBOL)
21219             Perl_re_printf( aTHX_  "(MBOL)");
21220         if (r->intflags & PREGf_ANCH_SBOL)
21221             Perl_re_printf( aTHX_  "(SBOL)");
21222         if (r->intflags & PREGf_ANCH_GPOS)
21223             Perl_re_printf( aTHX_  "(GPOS)");
21224         Perl_re_printf( aTHX_ " ");
21225     }
21226     if (r->intflags & PREGf_GPOS_SEEN)
21227         Perl_re_printf( aTHX_  "GPOS:%" UVuf " ", (UV)r->gofs);
21228     if (r->intflags & PREGf_SKIP)
21229         Perl_re_printf( aTHX_  "plus ");
21230     if (r->intflags & PREGf_IMPLICIT)
21231         Perl_re_printf( aTHX_  "implicit ");
21232     Perl_re_printf( aTHX_  "minlen %" IVdf " ", (IV)r->minlen);
21233     if (r->extflags & RXf_EVAL_SEEN)
21234         Perl_re_printf( aTHX_  "with eval ");
21235     Perl_re_printf( aTHX_  "\n");
21236     DEBUG_FLAGS_r({
21237         regdump_extflags("r->extflags: ", r->extflags);
21238         regdump_intflags("r->intflags: ", r->intflags);
21239     });
21240 #else
21241     PERL_ARGS_ASSERT_REGDUMP;
21242     PERL_UNUSED_CONTEXT;
21243     PERL_UNUSED_ARG(r);
21244 #endif  /* DEBUGGING */
21245 }
21246
21247 /* Should be synchronized with ANYOF_ #defines in regcomp.h */
21248 #ifdef DEBUGGING
21249
21250 #  if   _CC_WORDCHAR != 0 || _CC_DIGIT != 1        || _CC_ALPHA != 2    \
21251      || _CC_LOWER != 3    || _CC_UPPER != 4        || _CC_PUNCT != 5    \
21252      || _CC_PRINT != 6    || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8    \
21253      || _CC_CASED != 9    || _CC_SPACE != 10       || _CC_BLANK != 11   \
21254      || _CC_XDIGIT != 12  || _CC_CNTRL != 13       || _CC_ASCII != 14   \
21255      || _CC_VERTSPACE != 15
21256 #   error Need to adjust order of anyofs[]
21257 #  endif
21258 static const char * const anyofs[] = {
21259     "\\w",
21260     "\\W",
21261     "\\d",
21262     "\\D",
21263     "[:alpha:]",
21264     "[:^alpha:]",
21265     "[:lower:]",
21266     "[:^lower:]",
21267     "[:upper:]",
21268     "[:^upper:]",
21269     "[:punct:]",
21270     "[:^punct:]",
21271     "[:print:]",
21272     "[:^print:]",
21273     "[:alnum:]",
21274     "[:^alnum:]",
21275     "[:graph:]",
21276     "[:^graph:]",
21277     "[:cased:]",
21278     "[:^cased:]",
21279     "\\s",
21280     "\\S",
21281     "[:blank:]",
21282     "[:^blank:]",
21283     "[:xdigit:]",
21284     "[:^xdigit:]",
21285     "[:cntrl:]",
21286     "[:^cntrl:]",
21287     "[:ascii:]",
21288     "[:^ascii:]",
21289     "\\v",
21290     "\\V"
21291 };
21292 #endif
21293
21294 /*
21295 - regprop - printable representation of opcode, with run time support
21296 */
21297
21298 void
21299 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
21300 {
21301 #ifdef DEBUGGING
21302     int k;
21303     RXi_GET_DECL(prog, progi);
21304     DECLARE_AND_GET_RE_DEBUG_FLAGS;
21305
21306     PERL_ARGS_ASSERT_REGPROP;
21307
21308     SvPVCLEAR(sv);
21309
21310     if (OP(o) > REGNODE_MAX) {          /* regnode.type is unsigned */
21311         if (pRExC_state) {  /* This gives more info, if we have it */
21312             FAIL3("panic: corrupted regexp opcode %d > %d",
21313                   (int)OP(o), (int)REGNODE_MAX);
21314         }
21315         else {
21316             Perl_croak(aTHX_ "panic: corrupted regexp opcode %d > %d",
21317                              (int)OP(o), (int)REGNODE_MAX);
21318         }
21319     }
21320     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
21321
21322     k = PL_regkind[OP(o)];
21323
21324     if (k == EXACT) {
21325         sv_catpvs(sv, " ");
21326         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
21327          * is a crude hack but it may be the best for now since
21328          * we have no flag "this EXACTish node was UTF-8"
21329          * --jhi */
21330         pv_pretty(sv, STRING(o), STR_LEN(o), PL_dump_re_max_len,
21331                   PL_colors[0], PL_colors[1],
21332                   PERL_PV_ESCAPE_UNI_DETECT |
21333                   PERL_PV_ESCAPE_NONASCII   |
21334                   PERL_PV_PRETTY_ELLIPSES   |
21335                   PERL_PV_PRETTY_LTGT       |
21336                   PERL_PV_PRETTY_NOCLEAR
21337                   );
21338     } else if (k == TRIE) {
21339         /* print the details of the trie in dumpuntil instead, as
21340          * progi->data isn't available here */
21341         const char op = OP(o);
21342         const U32 n = ARG(o);
21343         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
21344                (reg_ac_data *)progi->data->data[n] :
21345                NULL;
21346         const reg_trie_data * const trie
21347             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
21348
21349         Perl_sv_catpvf(aTHX_ sv, "-%s", PL_reg_name[o->flags]);
21350         DEBUG_TRIE_COMPILE_r({
21351           if (trie->jump)
21352             sv_catpvs(sv, "(JUMP)");
21353           Perl_sv_catpvf(aTHX_ sv,
21354             "<S:%" UVuf "/%" IVdf " W:%" UVuf " L:%" UVuf "/%" UVuf " C:%" UVuf "/%" UVuf ">",
21355             (UV)trie->startstate,
21356             (IV)trie->statecount-1, /* -1 because of the unused 0 element */
21357             (UV)trie->wordcount,
21358             (UV)trie->minlen,
21359             (UV)trie->maxlen,
21360             (UV)TRIE_CHARCOUNT(trie),
21361             (UV)trie->uniquecharcount
21362           );
21363         });
21364         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
21365             sv_catpvs(sv, "[");
21366             (void) put_charclass_bitmap_innards(sv,
21367                                                 ((IS_ANYOF_TRIE(op))
21368                                                  ? ANYOF_BITMAP(o)
21369                                                  : TRIE_BITMAP(trie)),
21370                                                 NULL,
21371                                                 NULL,
21372                                                 NULL,
21373                                                 0,
21374                                                 FALSE
21375                                                );
21376             sv_catpvs(sv, "]");
21377         }
21378     } else if (k == CURLY) {
21379         U32 lo = ARG1(o), hi = ARG2(o);
21380         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
21381             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
21382         Perl_sv_catpvf(aTHX_ sv, "{%u,", (unsigned) lo);
21383         if (hi == REG_INFTY)
21384             sv_catpvs(sv, "INFTY");
21385         else
21386             Perl_sv_catpvf(aTHX_ sv, "%u", (unsigned) hi);
21387         sv_catpvs(sv, "}");
21388     }
21389     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
21390         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
21391     else if (k == REF || k == OPEN || k == CLOSE
21392              || k == GROUPP || OP(o)==ACCEPT)
21393     {
21394         AV *name_list= NULL;
21395         U32 parno= OP(o) == ACCEPT ? (U32)ARG2L(o) : ARG(o);
21396         Perl_sv_catpvf(aTHX_ sv, "%" UVuf, (UV)parno);        /* Parenth number */
21397         if ( RXp_PAREN_NAMES(prog) ) {
21398             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
21399         } else if ( pRExC_state ) {
21400             name_list= RExC_paren_name_list;
21401         }
21402         if (name_list) {
21403             if ( k != REF || (OP(o) < REFN)) {
21404                 SV **name= av_fetch(name_list, parno, 0 );
21405                 if (name)
21406                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
21407             }
21408             else {
21409                 SV *sv_dat= MUTABLE_SV(progi->data->data[ parno ]);
21410                 I32 *nums=(I32*)SvPVX(sv_dat);
21411                 SV **name= av_fetch(name_list, nums[0], 0 );
21412                 I32 n;
21413                 if (name) {
21414                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
21415                         Perl_sv_catpvf(aTHX_ sv, "%s%" IVdf,
21416                                     (n ? "," : ""), (IV)nums[n]);
21417                     }
21418                     Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
21419                 }
21420             }
21421         }
21422         if ( k == REF && reginfo) {
21423             U32 n = ARG(o);  /* which paren pair */
21424             I32 ln = prog->offs[n].start;
21425             if (prog->lastparen < n || ln == -1 || prog->offs[n].end == -1)
21426                 Perl_sv_catpvf(aTHX_ sv, ": FAIL");
21427             else if (ln == prog->offs[n].end)
21428                 Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
21429             else {
21430                 const char *s = reginfo->strbeg + ln;
21431                 Perl_sv_catpvf(aTHX_ sv, ": ");
21432                 Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
21433                     PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
21434             }
21435         }
21436     } else if (k == GOSUB) {
21437         AV *name_list= NULL;
21438         if ( RXp_PAREN_NAMES(prog) ) {
21439             name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
21440         } else if ( pRExC_state ) {
21441             name_list= RExC_paren_name_list;
21442         }
21443
21444         /* Paren and offset */
21445         Perl_sv_catpvf(aTHX_ sv, "%d[%+d:%d]", (int)ARG(o),(int)ARG2L(o),
21446                 (int)((o + (int)ARG2L(o)) - progi->program) );
21447         if (name_list) {
21448             SV **name= av_fetch(name_list, ARG(o), 0 );
21449             if (name)
21450                 Perl_sv_catpvf(aTHX_ sv, " '%" SVf "'", SVfARG(*name));
21451         }
21452     }
21453     else if (k == LOGICAL)
21454         /* 2: embedded, otherwise 1 */
21455         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
21456     else if (k == ANYOF || k == ANYOFR) {
21457         U8 flags;
21458         char * bitmap;
21459         U32 arg;
21460         bool do_sep = FALSE;    /* Do we need to separate various components of
21461                                    the output? */
21462         /* Set if there is still an unresolved user-defined property */
21463         SV *unresolved                = NULL;
21464
21465         /* Things that are ignored except when the runtime locale is UTF-8 */
21466         SV *only_utf8_locale_invlist = NULL;
21467
21468         /* Code points that don't fit in the bitmap */
21469         SV *nonbitmap_invlist = NULL;
21470
21471         /* And things that aren't in the bitmap, but are small enough to be */
21472         SV* bitmap_range_not_in_bitmap = NULL;
21473
21474         bool inverted;
21475
21476         if (inRANGE(OP(o), ANYOFH, ANYOFRb)) {
21477             flags = 0;
21478             bitmap = NULL;
21479             arg = 0;
21480         }
21481         else {
21482             flags = ANYOF_FLAGS(o);
21483             bitmap = ANYOF_BITMAP(o);
21484             arg = ARG(o);
21485         }
21486
21487         if (OP(o) == ANYOFL || OP(o) == ANYOFPOSIXL) {
21488             if (ANYOFL_UTF8_LOCALE_REQD(flags)) {
21489                 sv_catpvs(sv, "{utf8-locale-reqd}");
21490             }
21491             if (flags & ANYOFL_FOLD) {
21492                 sv_catpvs(sv, "{i}");
21493             }
21494         }
21495
21496         inverted = flags & ANYOF_INVERT;
21497
21498         /* If there is stuff outside the bitmap, get it */
21499         if (arg != ANYOF_ONLY_HAS_BITMAP) {
21500             if (inRANGE(OP(o), ANYOFR, ANYOFRb)) {
21501                 nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
21502                                             ANYOFRbase(o),
21503                                             ANYOFRbase(o) + ANYOFRdelta(o));
21504             }
21505             else {
21506 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
21507                 (void) get_regclass_nonbitmap_data(prog, o, FALSE,
21508                                                 &unresolved,
21509                                                 &only_utf8_locale_invlist,
21510                                                 &nonbitmap_invlist);
21511 #else
21512                 (void) get_re_gclass_nonbitmap_data(prog, o, FALSE,
21513                                                 &unresolved,
21514                                                 &only_utf8_locale_invlist,
21515                                                 &nonbitmap_invlist);
21516 #endif
21517             }
21518
21519             /* The non-bitmap data may contain stuff that could fit in the
21520              * bitmap.  This could come from a user-defined property being
21521              * finally resolved when this call was done; or much more likely
21522              * because there are matches that require UTF-8 to be valid, and so
21523              * aren't in the bitmap (or ANYOFR).  This is teased apart later */
21524             _invlist_intersection(nonbitmap_invlist,
21525                                   PL_InBitmap,
21526                                   &bitmap_range_not_in_bitmap);
21527             /* Leave just the things that don't fit into the bitmap */
21528             _invlist_subtract(nonbitmap_invlist,
21529                               PL_InBitmap,
21530                               &nonbitmap_invlist);
21531         }
21532
21533         /* Obey this flag to add all above-the-bitmap code points */
21534         if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
21535             nonbitmap_invlist = _add_range_to_invlist(nonbitmap_invlist,
21536                                                       NUM_ANYOF_CODE_POINTS,
21537                                                       UV_MAX);
21538         }
21539
21540         /* Ready to start outputting.  First, the initial left bracket */
21541         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
21542
21543         /* ANYOFH by definition doesn't have anything that will fit inside the
21544          * bitmap;  ANYOFR may or may not. */
21545         if (  ! inRANGE(OP(o), ANYOFH, ANYOFHr)
21546             && (   ! inRANGE(OP(o), ANYOFR, ANYOFRb)
21547                 ||   ANYOFRbase(o) < NUM_ANYOF_CODE_POINTS))
21548         {
21549             /* Then all the things that could fit in the bitmap */
21550             do_sep = put_charclass_bitmap_innards(sv,
21551                                                   bitmap,
21552                                                   bitmap_range_not_in_bitmap,
21553                                                   only_utf8_locale_invlist,
21554                                                   o,
21555                                                   flags,
21556
21557                                                   /* Can't try inverting for a
21558                                                    * better display if there
21559                                                    * are things that haven't
21560                                                    * been resolved */
21561                                                   unresolved != NULL
21562                                             || inRANGE(OP(o), ANYOFR, ANYOFRb));
21563             SvREFCNT_dec(bitmap_range_not_in_bitmap);
21564
21565             /* If there are user-defined properties which haven't been defined
21566              * yet, output them.  If the result is not to be inverted, it is
21567              * clearest to output them in a separate [] from the bitmap range
21568              * stuff.  If the result is to be complemented, we have to show
21569              * everything in one [], as the inversion applies to the whole
21570              * thing.  Use {braces} to separate them from anything in the
21571              * bitmap and anything above the bitmap. */
21572             if (unresolved) {
21573                 if (inverted) {
21574                     if (! do_sep) { /* If didn't output anything in the bitmap
21575                                      */
21576                         sv_catpvs(sv, "^");
21577                     }
21578                     sv_catpvs(sv, "{");
21579                 }
21580                 else if (do_sep) {
21581                     Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1],
21582                                                       PL_colors[0]);
21583                 }
21584                 sv_catsv(sv, unresolved);
21585                 if (inverted) {
21586                     sv_catpvs(sv, "}");
21587                 }
21588                 do_sep = ! inverted;
21589             }
21590         }
21591
21592         /* And, finally, add the above-the-bitmap stuff */
21593         if (nonbitmap_invlist && _invlist_len(nonbitmap_invlist)) {
21594             SV* contents;
21595
21596             /* See if truncation size is overridden */
21597             const STRLEN dump_len = (PL_dump_re_max_len > 256)
21598                                     ? PL_dump_re_max_len
21599                                     : 256;
21600
21601             /* This is output in a separate [] */
21602             if (do_sep) {
21603                 Perl_sv_catpvf(aTHX_ sv,"%s][%s", PL_colors[1], PL_colors[0]);
21604             }
21605
21606             /* And, for easy of understanding, it is shown in the
21607              * uncomplemented form if possible.  The one exception being if
21608              * there are unresolved items, where the inversion has to be
21609              * delayed until runtime */
21610             if (inverted && ! unresolved) {
21611                 _invlist_invert(nonbitmap_invlist);
21612                 _invlist_subtract(nonbitmap_invlist, PL_InBitmap, &nonbitmap_invlist);
21613             }
21614
21615             contents = invlist_contents(nonbitmap_invlist,
21616                                         FALSE /* output suitable for catsv */
21617                                        );
21618
21619             /* If the output is shorter than the permissible maximum, just do it. */
21620             if (SvCUR(contents) <= dump_len) {
21621                 sv_catsv(sv, contents);
21622             }
21623             else {
21624                 const char * contents_string = SvPVX(contents);
21625                 STRLEN i = dump_len;
21626
21627                 /* Otherwise, start at the permissible max and work back to the
21628                  * first break possibility */
21629                 while (i > 0 && contents_string[i] != ' ') {
21630                     i--;
21631                 }
21632                 if (i == 0) {       /* Fail-safe.  Use the max if we couldn't
21633                                        find a legal break */
21634                     i = dump_len;
21635                 }
21636
21637                 sv_catpvn(sv, contents_string, i);
21638                 sv_catpvs(sv, "...");
21639             }
21640
21641             SvREFCNT_dec_NN(contents);
21642             SvREFCNT_dec_NN(nonbitmap_invlist);
21643         }
21644
21645         /* And finally the matching, closing ']' */
21646         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
21647
21648         if (OP(o) == ANYOFHs) {
21649             Perl_sv_catpvf(aTHX_ sv, " (Leading UTF-8 bytes=%s", _byte_dump_string((U8 *) ((struct regnode_anyofhs *) o)->string, FLAGS(o), 1));
21650         }
21651         else if (inRANGE(OP(o), ANYOFH, ANYOFRb)) {
21652             U8 lowest = (OP(o) != ANYOFHr)
21653                          ? FLAGS(o)
21654                          : LOWEST_ANYOF_HRx_BYTE(FLAGS(o));
21655             U8 highest = (OP(o) == ANYOFHr)
21656                          ? HIGHEST_ANYOF_HRx_BYTE(FLAGS(o))
21657                          : (OP(o) == ANYOFH || OP(o) == ANYOFR)
21658                            ? 0xFF
21659                            : lowest;
21660 #ifndef EBCDIC
21661             if (OP(o) != ANYOFR || ! isASCII(ANYOFRbase(o) + ANYOFRdelta(o)))
21662 #endif
21663             {
21664                 Perl_sv_catpvf(aTHX_ sv, " (First UTF-8 byte=%02X", lowest);
21665                 if (lowest != highest) {
21666                     Perl_sv_catpvf(aTHX_ sv, "-%02X", highest);
21667                 }
21668                 Perl_sv_catpvf(aTHX_ sv, ")");
21669             }
21670         }
21671
21672         SvREFCNT_dec(unresolved);
21673     }
21674     else if (k == ANYOFM) {
21675         SV * cp_list = get_ANYOFM_contents(o);
21676
21677         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
21678         if (OP(o) == NANYOFM) {
21679             _invlist_invert(cp_list);
21680         }
21681
21682         put_charclass_bitmap_innards(sv, NULL, cp_list, NULL, NULL, 0, TRUE);
21683         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
21684
21685         SvREFCNT_dec(cp_list);
21686     }
21687     else if (k == POSIXD || k == NPOSIXD) {
21688         U8 index = FLAGS(o) * 2;
21689         if (index < C_ARRAY_LENGTH(anyofs)) {
21690             if (*anyofs[index] != '[')  {
21691                 sv_catpvs(sv, "[");
21692             }
21693             sv_catpv(sv, anyofs[index]);
21694             if (*anyofs[index] != '[')  {
21695                 sv_catpvs(sv, "]");
21696             }
21697         }
21698         else {
21699             Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
21700         }
21701     }
21702     else if (k == BOUND || k == NBOUND) {
21703         /* Must be synced with order of 'bound_type' in regcomp.h */
21704         const char * const bounds[] = {
21705             "",      /* Traditional */
21706             "{gcb}",
21707             "{lb}",
21708             "{sb}",
21709             "{wb}"
21710         };
21711         assert(FLAGS(o) < C_ARRAY_LENGTH(bounds));
21712         sv_catpv(sv, bounds[FLAGS(o)]);
21713     }
21714     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH)) {
21715         Perl_sv_catpvf(aTHX_ sv, "[%d", -(o->flags));
21716         if (o->next_off) {
21717             Perl_sv_catpvf(aTHX_ sv, "..-%d", o->flags - o->next_off);
21718         }
21719         Perl_sv_catpvf(aTHX_ sv, "]");
21720     }
21721     else if (OP(o) == SBOL)
21722         Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
21723
21724     /* add on the verb argument if there is one */
21725     if ( ( k == VERB || OP(o) == ACCEPT || OP(o) == OPFAIL ) && o->flags) {
21726         if ( ARG(o) )
21727             Perl_sv_catpvf(aTHX_ sv, ":%" SVf,
21728                        SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
21729         else
21730             sv_catpvs(sv, ":NULL");
21731     }
21732 #else
21733     PERL_UNUSED_CONTEXT;
21734     PERL_UNUSED_ARG(sv);
21735     PERL_UNUSED_ARG(o);
21736     PERL_UNUSED_ARG(prog);
21737     PERL_UNUSED_ARG(reginfo);
21738     PERL_UNUSED_ARG(pRExC_state);
21739 #endif  /* DEBUGGING */
21740 }
21741
21742
21743
21744 SV *
21745 Perl_re_intuit_string(pTHX_ REGEXP * const r)
21746 {                               /* Assume that RE_INTUIT is set */
21747     /* Returns an SV containing a string that must appear in the target for it
21748      * to match, or NULL if nothing is known that must match.
21749      *
21750      * CAUTION: the SV can be freed during execution of the regex engine */
21751
21752     struct regexp *const prog = ReANY(r);
21753     DECLARE_AND_GET_RE_DEBUG_FLAGS;
21754
21755     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
21756     PERL_UNUSED_CONTEXT;
21757
21758     DEBUG_COMPILE_r(
21759         {
21760             if (prog->maxlen > 0) {
21761                 const char * const s = SvPV_nolen_const(RX_UTF8(r)
21762                       ? prog->check_utf8 : prog->check_substr);
21763
21764                 if (!PL_colorset) reginitcolors();
21765                 Perl_re_printf( aTHX_
21766                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
21767                       PL_colors[4],
21768                       RX_UTF8(r) ? "utf8 " : "",
21769                       PL_colors[5], PL_colors[0],
21770                       s,
21771                       PL_colors[1],
21772                       (strlen(s) > PL_dump_re_max_len ? "..." : ""));
21773             }
21774         } );
21775
21776     /* use UTF8 check substring if regexp pattern itself is in UTF8 */
21777     return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
21778 }
21779
21780 /*
21781    pregfree()
21782
21783    handles refcounting and freeing the perl core regexp structure. When
21784    it is necessary to actually free the structure the first thing it
21785    does is call the 'free' method of the regexp_engine associated to
21786    the regexp, allowing the handling of the void *pprivate; member
21787    first. (This routine is not overridable by extensions, which is why
21788    the extensions free is called first.)
21789
21790    See regdupe and regdupe_internal if you change anything here.
21791 */
21792 #ifndef PERL_IN_XSUB_RE
21793 void
21794 Perl_pregfree(pTHX_ REGEXP *r)
21795 {
21796     SvREFCNT_dec(r);
21797 }
21798
21799 void
21800 Perl_pregfree2(pTHX_ REGEXP *rx)
21801 {
21802     struct regexp *const r = ReANY(rx);
21803     DECLARE_AND_GET_RE_DEBUG_FLAGS;
21804
21805     PERL_ARGS_ASSERT_PREGFREE2;
21806
21807     if (! r)
21808         return;
21809
21810     if (r->mother_re) {
21811         ReREFCNT_dec(r->mother_re);
21812     } else {
21813         CALLREGFREE_PVT(rx); /* free the private data */
21814         SvREFCNT_dec(RXp_PAREN_NAMES(r));
21815     }
21816     if (r->substrs) {
21817         int i;
21818         for (i = 0; i < 2; i++) {
21819             SvREFCNT_dec(r->substrs->data[i].substr);
21820             SvREFCNT_dec(r->substrs->data[i].utf8_substr);
21821         }
21822         Safefree(r->substrs);
21823     }
21824     RX_MATCH_COPY_FREE(rx);
21825 #ifdef PERL_ANY_COW
21826     SvREFCNT_dec(r->saved_copy);
21827 #endif
21828     Safefree(r->offs);
21829     SvREFCNT_dec(r->qr_anoncv);
21830     if (r->recurse_locinput)
21831         Safefree(r->recurse_locinput);
21832 }
21833
21834
21835 /*  reg_temp_copy()
21836
21837     Copy ssv to dsv, both of which should of type SVt_REGEXP or SVt_PVLV,
21838     except that dsv will be created if NULL.
21839
21840     This function is used in two main ways. First to implement
21841         $r = qr/....; $s = $$r;
21842
21843     Secondly, it is used as a hacky workaround to the structural issue of
21844     match results
21845     being stored in the regexp structure which is in turn stored in
21846     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
21847     could be PL_curpm in multiple contexts, and could require multiple
21848     result sets being associated with the pattern simultaneously, such
21849     as when doing a recursive match with (??{$qr})
21850
21851     The solution is to make a lightweight copy of the regexp structure
21852     when a qr// is returned from the code executed by (??{$qr}) this
21853     lightweight copy doesn't actually own any of its data except for
21854     the starp/end and the actual regexp structure itself.
21855
21856 */
21857
21858
21859 REGEXP *
21860 Perl_reg_temp_copy(pTHX_ REGEXP *dsv, REGEXP *ssv)
21861 {
21862     struct regexp *drx;
21863     struct regexp *const srx = ReANY(ssv);
21864     const bool islv = dsv && SvTYPE(dsv) == SVt_PVLV;
21865
21866     PERL_ARGS_ASSERT_REG_TEMP_COPY;
21867
21868     if (!dsv)
21869         dsv = (REGEXP*) newSV_type(SVt_REGEXP);
21870     else {
21871         assert(SvTYPE(dsv) == SVt_REGEXP || (SvTYPE(dsv) == SVt_PVLV));
21872
21873         /* our only valid caller, sv_setsv_flags(), should have done
21874          * a SV_CHECK_THINKFIRST_COW_DROP() by now */
21875         assert(!SvOOK(dsv));
21876         assert(!SvIsCOW(dsv));
21877         assert(!SvROK(dsv));
21878
21879         if (SvPVX_const(dsv)) {
21880             if (SvLEN(dsv))
21881                 Safefree(SvPVX(dsv));
21882             SvPVX(dsv) = NULL;
21883         }
21884         SvLEN_set(dsv, 0);
21885         SvCUR_set(dsv, 0);
21886         SvOK_off((SV *)dsv);
21887
21888         if (islv) {
21889             /* For PVLVs, the head (sv_any) points to an XPVLV, while
21890              * the LV's xpvlenu_rx will point to a regexp body, which
21891              * we allocate here */
21892             REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
21893             assert(!SvPVX(dsv));
21894             ((XPV*)SvANY(dsv))->xpv_len_u.xpvlenu_rx = temp->sv_any;
21895             temp->sv_any = NULL;
21896             SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
21897             SvREFCNT_dec_NN(temp);
21898             /* SvCUR still resides in the xpvlv struct, so the regexp copy-
21899                ing below will not set it. */
21900             SvCUR_set(dsv, SvCUR(ssv));
21901         }
21902     }
21903     /* This ensures that SvTHINKFIRST(sv) is true, and hence that
21904        sv_force_normal(sv) is called.  */
21905     SvFAKE_on(dsv);
21906     drx = ReANY(dsv);
21907
21908     SvFLAGS(dsv) |= SvFLAGS(ssv) & (SVf_POK|SVp_POK|SVf_UTF8);
21909     SvPV_set(dsv, RX_WRAPPED(ssv));
21910     /* We share the same string buffer as the original regexp, on which we
21911        hold a reference count, incremented when mother_re is set below.
21912        The string pointer is copied here, being part of the regexp struct.
21913      */
21914     memcpy(&(drx->xpv_cur), &(srx->xpv_cur),
21915            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
21916     if (!islv)
21917         SvLEN_set(dsv, 0);
21918     if (srx->offs) {
21919         const I32 npar = srx->nparens+1;
21920         Newx(drx->offs, npar, regexp_paren_pair);
21921         Copy(srx->offs, drx->offs, npar, regexp_paren_pair);
21922     }
21923     if (srx->substrs) {
21924         int i;
21925         Newx(drx->substrs, 1, struct reg_substr_data);
21926         StructCopy(srx->substrs, drx->substrs, struct reg_substr_data);
21927
21928         for (i = 0; i < 2; i++) {
21929             SvREFCNT_inc_void(drx->substrs->data[i].substr);
21930             SvREFCNT_inc_void(drx->substrs->data[i].utf8_substr);
21931         }
21932
21933         /* check_substr and check_utf8, if non-NULL, point to either their
21934            anchored or float namesakes, and don't hold a second reference.  */
21935     }
21936     RX_MATCH_COPIED_off(dsv);
21937 #ifdef PERL_ANY_COW
21938     drx->saved_copy = NULL;
21939 #endif
21940     drx->mother_re = ReREFCNT_inc(srx->mother_re ? srx->mother_re : ssv);
21941     SvREFCNT_inc_void(drx->qr_anoncv);
21942     if (srx->recurse_locinput)
21943         Newx(drx->recurse_locinput, srx->nparens + 1, char *);
21944
21945     return dsv;
21946 }
21947 #endif
21948
21949
21950 /* regfree_internal()
21951
21952    Free the private data in a regexp. This is overloadable by
21953    extensions. Perl takes care of the regexp structure in pregfree(),
21954    this covers the *pprivate pointer which technically perl doesn't
21955    know about, however of course we have to handle the
21956    regexp_internal structure when no extension is in use.
21957
21958    Note this is called before freeing anything in the regexp
21959    structure.
21960  */
21961
21962 void
21963 Perl_regfree_internal(pTHX_ REGEXP * const rx)
21964 {
21965     struct regexp *const r = ReANY(rx);
21966     RXi_GET_DECL(r, ri);
21967     DECLARE_AND_GET_RE_DEBUG_FLAGS;
21968
21969     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
21970
21971     if (! ri) {
21972         return;
21973     }
21974
21975     DEBUG_COMPILE_r({
21976         if (!PL_colorset)
21977             reginitcolors();
21978         {
21979             SV *dsv= sv_newmortal();
21980             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
21981                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), PL_dump_re_max_len);
21982             Perl_re_printf( aTHX_ "%sFreeing REx:%s %s\n",
21983                 PL_colors[4], PL_colors[5], s);
21984         }
21985     });
21986
21987 #ifdef RE_TRACK_PATTERN_OFFSETS
21988     if (ri->u.offsets)
21989         Safefree(ri->u.offsets);             /* 20010421 MJD */
21990 #endif
21991     if (ri->code_blocks)
21992         S_free_codeblocks(aTHX_ ri->code_blocks);
21993
21994     if (ri->data) {
21995         int n = ri->data->count;
21996
21997         while (--n >= 0) {
21998           /* If you add a ->what type here, update the comment in regcomp.h */
21999             switch (ri->data->what[n]) {
22000             case 'a':
22001             case 'r':
22002             case 's':
22003             case 'S':
22004             case 'u':
22005                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
22006                 break;
22007             case 'f':
22008                 Safefree(ri->data->data[n]);
22009                 break;
22010             case 'l':
22011             case 'L':
22012                 break;
22013             case 'T':
22014                 { /* Aho Corasick add-on structure for a trie node.
22015                      Used in stclass optimization only */
22016                     U32 refcount;
22017                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
22018                     OP_REFCNT_LOCK;
22019                     refcount = --aho->refcount;
22020                     OP_REFCNT_UNLOCK;
22021                     if ( !refcount ) {
22022                         PerlMemShared_free(aho->states);
22023                         PerlMemShared_free(aho->fail);
22024                          /* do this last!!!! */
22025                         PerlMemShared_free(ri->data->data[n]);
22026                         /* we should only ever get called once, so
22027                          * assert as much, and also guard the free
22028                          * which /might/ happen twice. At the least
22029                          * it will make code anlyzers happy and it
22030                          * doesn't cost much. - Yves */
22031                         assert(ri->regstclass);
22032                         if (ri->regstclass) {
22033                             PerlMemShared_free(ri->regstclass);
22034                             ri->regstclass = 0;
22035                         }
22036                     }
22037                 }
22038                 break;
22039             case 't':
22040                 {
22041                     /* trie structure. */
22042                     U32 refcount;
22043                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
22044                     OP_REFCNT_LOCK;
22045                     refcount = --trie->refcount;
22046                     OP_REFCNT_UNLOCK;
22047                     if ( !refcount ) {
22048                         PerlMemShared_free(trie->charmap);
22049                         PerlMemShared_free(trie->states);
22050                         PerlMemShared_free(trie->trans);
22051                         if (trie->bitmap)
22052                             PerlMemShared_free(trie->bitmap);
22053                         if (trie->jump)
22054                             PerlMemShared_free(trie->jump);
22055                         PerlMemShared_free(trie->wordinfo);
22056                         /* do this last!!!! */
22057                         PerlMemShared_free(ri->data->data[n]);
22058                     }
22059                 }
22060                 break;
22061             default:
22062                 Perl_croak(aTHX_ "panic: regfree data code '%c'",
22063                                                     ri->data->what[n]);
22064             }
22065         }
22066         Safefree(ri->data->what);
22067         Safefree(ri->data);
22068     }
22069
22070     Safefree(ri);
22071 }
22072
22073 #define av_dup_inc(s, t)        MUTABLE_AV(sv_dup_inc((const SV *)s, t))
22074 #define hv_dup_inc(s, t)        MUTABLE_HV(sv_dup_inc((const SV *)s, t))
22075 #define SAVEPVN(p, n)   ((p) ? savepvn(p, n) : NULL)
22076
22077 /*
22078 =for apidoc re_dup_guts
22079 Duplicate a regexp.
22080
22081 This routine is expected to clone a given regexp structure. It is only
22082 compiled under USE_ITHREADS.
22083
22084 After all of the core data stored in struct regexp is duplicated
22085 the C<regexp_engine.dupe> method is used to copy any private data
22086 stored in the *pprivate pointer. This allows extensions to handle
22087 any duplication they need to do.
22088
22089 =cut
22090
22091    See pregfree() and regfree_internal() if you change anything here.
22092 */
22093 #if defined(USE_ITHREADS)
22094 #ifndef PERL_IN_XSUB_RE
22095 void
22096 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
22097 {
22098     I32 npar;
22099     const struct regexp *r = ReANY(sstr);
22100     struct regexp *ret = ReANY(dstr);
22101
22102     PERL_ARGS_ASSERT_RE_DUP_GUTS;
22103
22104     npar = r->nparens+1;
22105     Newx(ret->offs, npar, regexp_paren_pair);
22106     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
22107
22108     if (ret->substrs) {
22109         /* Do it this way to avoid reading from *r after the StructCopy().
22110            That way, if any of the sv_dup_inc()s dislodge *r from the L1
22111            cache, it doesn't matter.  */
22112         int i;
22113         const bool anchored = r->check_substr
22114             ? r->check_substr == r->substrs->data[0].substr
22115             : r->check_utf8   == r->substrs->data[0].utf8_substr;
22116         Newx(ret->substrs, 1, struct reg_substr_data);
22117         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
22118
22119         for (i = 0; i < 2; i++) {
22120             ret->substrs->data[i].substr =
22121                         sv_dup_inc(ret->substrs->data[i].substr, param);
22122             ret->substrs->data[i].utf8_substr =
22123                         sv_dup_inc(ret->substrs->data[i].utf8_substr, param);
22124         }
22125
22126         /* check_substr and check_utf8, if non-NULL, point to either their
22127            anchored or float namesakes, and don't hold a second reference.  */
22128
22129         if (ret->check_substr) {
22130             if (anchored) {
22131                 assert(r->check_utf8 == r->substrs->data[0].utf8_substr);
22132
22133                 ret->check_substr = ret->substrs->data[0].substr;
22134                 ret->check_utf8   = ret->substrs->data[0].utf8_substr;
22135             } else {
22136                 assert(r->check_substr == r->substrs->data[1].substr);
22137                 assert(r->check_utf8   == r->substrs->data[1].utf8_substr);
22138
22139                 ret->check_substr = ret->substrs->data[1].substr;
22140                 ret->check_utf8   = ret->substrs->data[1].utf8_substr;
22141             }
22142         } else if (ret->check_utf8) {
22143             if (anchored) {
22144                 ret->check_utf8 = ret->substrs->data[0].utf8_substr;
22145             } else {
22146                 ret->check_utf8 = ret->substrs->data[1].utf8_substr;
22147             }
22148         }
22149     }
22150
22151     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
22152     ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
22153     if (r->recurse_locinput)
22154         Newx(ret->recurse_locinput, r->nparens + 1, char *);
22155
22156     if (ret->pprivate)
22157         RXi_SET(ret, CALLREGDUPE_PVT(dstr, param));
22158
22159     if (RX_MATCH_COPIED(dstr))
22160         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
22161     else
22162         ret->subbeg = NULL;
22163 #ifdef PERL_ANY_COW
22164     ret->saved_copy = NULL;
22165 #endif
22166
22167     /* Whether mother_re be set or no, we need to copy the string.  We
22168        cannot refrain from copying it when the storage points directly to
22169        our mother regexp, because that's
22170                1: a buffer in a different thread
22171                2: something we no longer hold a reference on
22172                so we need to copy it locally.  */
22173     RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED_const(sstr), SvCUR(sstr)+1);
22174     /* set malloced length to a non-zero value so it will be freed
22175      * (otherwise in combination with SVf_FAKE it looks like an alien
22176      * buffer). It doesn't have to be the actual malloced size, since it
22177      * should never be grown */
22178     SvLEN_set(dstr, SvCUR(sstr)+1);
22179     ret->mother_re   = NULL;
22180 }
22181 #endif /* PERL_IN_XSUB_RE */
22182
22183 /*
22184    regdupe_internal()
22185
22186    This is the internal complement to regdupe() which is used to copy
22187    the structure pointed to by the *pprivate pointer in the regexp.
22188    This is the core version of the extension overridable cloning hook.
22189    The regexp structure being duplicated will be copied by perl prior
22190    to this and will be provided as the regexp *r argument, however
22191    with the /old/ structures pprivate pointer value. Thus this routine
22192    may override any copying normally done by perl.
22193
22194    It returns a pointer to the new regexp_internal structure.
22195 */
22196
22197 void *
22198 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
22199 {
22200     struct regexp *const r = ReANY(rx);
22201     regexp_internal *reti;
22202     int len;
22203     RXi_GET_DECL(r, ri);
22204
22205     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
22206
22207     len = ProgLen(ri);
22208
22209     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
22210           char, regexp_internal);
22211     Copy(ri->program, reti->program, len+1, regnode);
22212
22213
22214     if (ri->code_blocks) {
22215         int n;
22216         Newx(reti->code_blocks, 1, struct reg_code_blocks);
22217         Newx(reti->code_blocks->cb, ri->code_blocks->count,
22218                     struct reg_code_block);
22219         Copy(ri->code_blocks->cb, reti->code_blocks->cb,
22220              ri->code_blocks->count, struct reg_code_block);
22221         for (n = 0; n < ri->code_blocks->count; n++)
22222              reti->code_blocks->cb[n].src_regex = (REGEXP*)
22223                     sv_dup_inc((SV*)(ri->code_blocks->cb[n].src_regex), param);
22224         reti->code_blocks->count = ri->code_blocks->count;
22225         reti->code_blocks->refcnt = 1;
22226     }
22227     else
22228         reti->code_blocks = NULL;
22229
22230     reti->regstclass = NULL;
22231
22232     if (ri->data) {
22233         struct reg_data *d;
22234         const int count = ri->data->count;
22235         int i;
22236
22237         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
22238                 char, struct reg_data);
22239         Newx(d->what, count, U8);
22240
22241         d->count = count;
22242         for (i = 0; i < count; i++) {
22243             d->what[i] = ri->data->what[i];
22244             switch (d->what[i]) {
22245                 /* see also regcomp.h and regfree_internal() */
22246             case 'a': /* actually an AV, but the dup function is identical.
22247                          values seem to be "plain sv's" generally. */
22248             case 'r': /* a compiled regex (but still just another SV) */
22249             case 's': /* an RV (currently only used for an RV to an AV by the ANYOF code)
22250                          this use case should go away, the code could have used
22251                          'a' instead - see S_set_ANYOF_arg() for array contents. */
22252             case 'S': /* actually an SV, but the dup function is identical.  */
22253             case 'u': /* actually an HV, but the dup function is identical.
22254                          values are "plain sv's" */
22255                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
22256                 break;
22257             case 'f':
22258                 /* Synthetic Start Class - "Fake" charclass we generate to optimize
22259                  * patterns which could start with several different things. Pre-TRIE
22260                  * this was more important than it is now, however this still helps
22261                  * in some places, for instance /x?a+/ might produce a SSC equivalent
22262                  * to [xa]. This is used by Perl_re_intuit_start() and S_find_byclass()
22263                  * in regexec.c
22264                  */
22265                 /* This is cheating. */
22266                 Newx(d->data[i], 1, regnode_ssc);
22267                 StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
22268                 reti->regstclass = (regnode*)d->data[i];
22269                 break;
22270             case 'T':
22271                 /* AHO-CORASICK fail table */
22272                 /* Trie stclasses are readonly and can thus be shared
22273                  * without duplication. We free the stclass in pregfree
22274                  * when the corresponding reg_ac_data struct is freed.
22275                  */
22276                 reti->regstclass= ri->regstclass;
22277                 /* FALLTHROUGH */
22278             case 't':
22279                 /* TRIE transition table */
22280                 OP_REFCNT_LOCK;
22281                 ((reg_trie_data*)ri->data->data[i])->refcount++;
22282                 OP_REFCNT_UNLOCK;
22283                 /* FALLTHROUGH */
22284             case 'l': /* (?{...}) or (??{ ... }) code (cb->block) */
22285             case 'L': /* same when RExC_pm_flags & PMf_HAS_CV and code
22286                          is not from another regexp */
22287                 d->data[i] = ri->data->data[i];
22288                 break;
22289             default:
22290                 Perl_croak(aTHX_ "panic: re_dup_guts unknown data code '%c'",
22291                                                            ri->data->what[i]);
22292             }
22293         }
22294
22295         reti->data = d;
22296     }
22297     else
22298         reti->data = NULL;
22299
22300     reti->name_list_idx = ri->name_list_idx;
22301
22302 #ifdef RE_TRACK_PATTERN_OFFSETS
22303     if (ri->u.offsets) {
22304         Newx(reti->u.offsets, 2*len+1, U32);
22305         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
22306     }
22307 #else
22308     SetProgLen(reti, len);
22309 #endif
22310
22311     return (void*)reti;
22312 }
22313
22314 #endif    /* USE_ITHREADS */
22315
22316 #ifndef PERL_IN_XSUB_RE
22317
22318 /*
22319  - regnext - dig the "next" pointer out of a node
22320  */
22321 regnode *
22322 Perl_regnext(pTHX_ regnode *p)
22323 {
22324     I32 offset;
22325
22326     if (!p)
22327         return(NULL);
22328
22329     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
22330         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
22331                                                 (int)OP(p), (int)REGNODE_MAX);
22332     }
22333
22334     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
22335     if (offset == 0)
22336         return(NULL);
22337
22338     return(p+offset);
22339 }
22340
22341 #endif
22342
22343 STATIC void
22344 S_re_croak(pTHX_ bool utf8, const char* pat,...)
22345 {
22346     va_list args;
22347     STRLEN len = strlen(pat);
22348     char buf[512];
22349     SV *msv;
22350     const char *message;
22351
22352     PERL_ARGS_ASSERT_RE_CROAK;
22353
22354     if (len > 510)
22355         len = 510;
22356     Copy(pat, buf, len , char);
22357     buf[len] = '\n';
22358     buf[len + 1] = '\0';
22359     va_start(args, pat);
22360     msv = vmess(buf, &args);
22361     va_end(args);
22362     message = SvPV_const(msv, len);
22363     if (len > 512)
22364         len = 512;
22365     Copy(message, buf, len , char);
22366     /* len-1 to avoid \n */
22367     Perl_croak(aTHX_ "%" UTF8f, UTF8fARG(utf8, len-1, buf));
22368 }
22369
22370 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
22371
22372 #ifndef PERL_IN_XSUB_RE
22373 void
22374 Perl_save_re_context(pTHX)
22375 {
22376     I32 nparens = -1;
22377     I32 i;
22378
22379     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
22380
22381     if (PL_curpm) {
22382         const REGEXP * const rx = PM_GETRE(PL_curpm);
22383         if (rx)
22384             nparens = RX_NPARENS(rx);
22385     }
22386
22387     /* RT #124109. This is a complete hack; in the SWASHNEW case we know
22388      * that PL_curpm will be null, but that utf8.pm and the modules it
22389      * loads will only use $1..$3.
22390      * The t/porting/re_context.t test file checks this assumption.
22391      */
22392     if (nparens == -1)
22393         nparens = 3;
22394
22395     for (i = 1; i <= nparens; i++) {
22396         char digits[TYPE_CHARS(long)];
22397         const STRLEN len = my_snprintf(digits, sizeof(digits),
22398                                        "%lu", (long)i);
22399         GV *const *const gvp
22400             = (GV**)hv_fetch(PL_defstash, digits, len, 0);
22401
22402         if (gvp) {
22403             GV * const gv = *gvp;
22404             if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
22405                 save_scalar(gv);
22406         }
22407     }
22408 }
22409 #endif
22410
22411 #ifdef DEBUGGING
22412
22413 STATIC void
22414 S_put_code_point(pTHX_ SV *sv, UV c)
22415 {
22416     PERL_ARGS_ASSERT_PUT_CODE_POINT;
22417
22418     if (c > 255) {
22419         Perl_sv_catpvf(aTHX_ sv, "\\x{%04" UVXf "}", c);
22420     }
22421     else if (isPRINT(c)) {
22422         const char string = (char) c;
22423
22424         /* We use {phrase} as metanotation in the class, so also escape literal
22425          * braces */
22426         if (isBACKSLASHED_PUNCT(c) || c == '{' || c == '}')
22427             sv_catpvs(sv, "\\");
22428         sv_catpvn(sv, &string, 1);
22429     }
22430     else if (isMNEMONIC_CNTRL(c)) {
22431         Perl_sv_catpvf(aTHX_ sv, "%s", cntrl_to_mnemonic((U8) c));
22432     }
22433     else {
22434         Perl_sv_catpvf(aTHX_ sv, "\\x%02X", (U8) c);
22435     }
22436 }
22437
22438 STATIC void
22439 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
22440 {
22441     /* Appends to 'sv' a displayable version of the range of code points from
22442      * 'start' to 'end'.  Mnemonics (like '\r') are used for the few controls
22443      * that have them, when they occur at the beginning or end of the range.
22444      * It uses hex to output the remaining code points, unless 'allow_literals'
22445      * is true, in which case the printable ASCII ones are output as-is (though
22446      * some of these will be escaped by put_code_point()).
22447      *
22448      * NOTE:  This is designed only for printing ranges of code points that fit
22449      *        inside an ANYOF bitmap.  Higher code points are simply suppressed
22450      */
22451
22452     const unsigned int min_range_count = 3;
22453
22454     assert(start <= end);
22455
22456     PERL_ARGS_ASSERT_PUT_RANGE;
22457
22458     while (start <= end) {
22459         UV this_end;
22460         const char * format;
22461
22462         if (    end - start < min_range_count
22463             && (end - start <= 2 || (isPRINT_A(start) && isPRINT_A(end))))
22464         {
22465             /* Output a range of 1 or 2 chars individually, or longer ranges
22466              * when printable */
22467             for (; start <= end; start++) {
22468                 put_code_point(sv, start);
22469             }
22470             break;
22471         }
22472
22473         /* If permitted by the input options, and there is a possibility that
22474          * this range contains a printable literal, look to see if there is
22475          * one. */
22476         if (allow_literals && start <= MAX_PRINT_A) {
22477
22478             /* If the character at the beginning of the range isn't an ASCII
22479              * printable, effectively split the range into two parts:
22480              *  1) the portion before the first such printable,
22481              *  2) the rest
22482              * and output them separately. */
22483             if (! isPRINT_A(start)) {
22484                 UV temp_end = start + 1;
22485
22486                 /* There is no point looking beyond the final possible
22487                  * printable, in MAX_PRINT_A */
22488                 UV max = MIN(end, MAX_PRINT_A);
22489
22490                 while (temp_end <= max && ! isPRINT_A(temp_end)) {
22491                     temp_end++;
22492                 }
22493
22494                 /* Here, temp_end points to one beyond the first printable if
22495                  * found, or to one beyond 'max' if not.  If none found, make
22496                  * sure that we use the entire range */
22497                 if (temp_end > MAX_PRINT_A) {
22498                     temp_end = end + 1;
22499                 }
22500
22501                 /* Output the first part of the split range: the part that
22502                  * doesn't have printables, with the parameter set to not look
22503                  * for literals (otherwise we would infinitely recurse) */
22504                 put_range(sv, start, temp_end - 1, FALSE);
22505
22506                 /* The 2nd part of the range (if any) starts here. */
22507                 start = temp_end;
22508
22509                 /* We do a continue, instead of dropping down, because even if
22510                  * the 2nd part is non-empty, it could be so short that we want
22511                  * to output it as individual characters, as tested for at the
22512                  * top of this loop.  */
22513                 continue;
22514             }
22515
22516             /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
22517              * output a sub-range of just the digits or letters, then process
22518              * the remaining portion as usual. */
22519             if (isALPHANUMERIC_A(start)) {
22520                 UV mask = (isDIGIT_A(start))
22521                            ? _CC_DIGIT
22522                              : isUPPER_A(start)
22523                                ? _CC_UPPER
22524                                : _CC_LOWER;
22525                 UV temp_end = start + 1;
22526
22527                 /* Find the end of the sub-range that includes just the
22528                  * characters in the same class as the first character in it */
22529                 while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
22530                     temp_end++;
22531                 }
22532                 temp_end--;
22533
22534                 /* For short ranges, don't duplicate the code above to output
22535                  * them; just call recursively */
22536                 if (temp_end - start < min_range_count) {
22537                     put_range(sv, start, temp_end, FALSE);
22538                 }
22539                 else {  /* Output as a range */
22540                     put_code_point(sv, start);
22541                     sv_catpvs(sv, "-");
22542                     put_code_point(sv, temp_end);
22543                 }
22544                 start = temp_end + 1;
22545                 continue;
22546             }
22547
22548             /* We output any other printables as individual characters */
22549             if (isPUNCT_A(start) || isSPACE_A(start)) {
22550                 while (start <= end && (isPUNCT_A(start)
22551                                         || isSPACE_A(start)))
22552                 {
22553                     put_code_point(sv, start);
22554                     start++;
22555                 }
22556                 continue;
22557             }
22558         } /* End of looking for literals */
22559
22560         /* Here is not to output as a literal.  Some control characters have
22561          * mnemonic names.  Split off any of those at the beginning and end of
22562          * the range to print mnemonically.  It isn't possible for many of
22563          * these to be in a row, so this won't overwhelm with output */
22564         if (   start <= end
22565             && (isMNEMONIC_CNTRL(start) || isMNEMONIC_CNTRL(end)))
22566         {
22567             while (isMNEMONIC_CNTRL(start) && start <= end) {
22568                 put_code_point(sv, start);
22569                 start++;
22570             }
22571
22572             /* If this didn't take care of the whole range ... */
22573             if (start <= end) {
22574
22575                 /* Look backwards from the end to find the final non-mnemonic
22576                  * */
22577                 UV temp_end = end;
22578                 while (isMNEMONIC_CNTRL(temp_end)) {
22579                     temp_end--;
22580                 }
22581
22582                 /* And separately output the interior range that doesn't start
22583                  * or end with mnemonics */
22584                 put_range(sv, start, temp_end, FALSE);
22585
22586                 /* Then output the mnemonic trailing controls */
22587                 start = temp_end + 1;
22588                 while (start <= end) {
22589                     put_code_point(sv, start);
22590                     start++;
22591                 }
22592                 break;
22593             }
22594         }
22595
22596         /* As a final resort, output the range or subrange as hex. */
22597
22598         if (start >= NUM_ANYOF_CODE_POINTS) {
22599             this_end = end;
22600         }
22601         else {  /* Have to split range at the bitmap boundary */
22602             this_end = (end < NUM_ANYOF_CODE_POINTS)
22603                         ? end
22604                         : NUM_ANYOF_CODE_POINTS - 1;
22605         }
22606 #if NUM_ANYOF_CODE_POINTS > 256
22607         format = (this_end < 256)
22608                  ? "\\x%02" UVXf "-\\x%02" UVXf
22609                  : "\\x{%04" UVXf "}-\\x{%04" UVXf "}";
22610 #else
22611         format = "\\x%02" UVXf "-\\x%02" UVXf;
22612 #endif
22613         GCC_DIAG_IGNORE_STMT(-Wformat-nonliteral);
22614         Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
22615         GCC_DIAG_RESTORE_STMT;
22616         break;
22617     }
22618 }
22619
22620 STATIC void
22621 S_put_charclass_bitmap_innards_invlist(pTHX_ SV *sv, SV* invlist)
22622 {
22623     /* Concatenate onto the PV in 'sv' a displayable form of the inversion list
22624      * 'invlist' */
22625
22626     UV start, end;
22627     bool allow_literals = TRUE;
22628
22629     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_INVLIST;
22630
22631     /* Generally, it is more readable if printable characters are output as
22632      * literals, but if a range (nearly) spans all of them, it's best to output
22633      * it as a single range.  This code will use a single range if all but 2
22634      * ASCII printables are in it */
22635     invlist_iterinit(invlist);
22636     while (invlist_iternext(invlist, &start, &end)) {
22637
22638         /* If the range starts beyond the final printable, it doesn't have any
22639          * in it */
22640         if (start > MAX_PRINT_A) {
22641             break;
22642         }
22643
22644         /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
22645          * all but two, the range must start and end no later than 2 from
22646          * either end */
22647         if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
22648             if (end > MAX_PRINT_A) {
22649                 end = MAX_PRINT_A;
22650             }
22651             if (start < ' ') {
22652                 start = ' ';
22653             }
22654             if (end - start >= MAX_PRINT_A - ' ' - 2) {
22655                 allow_literals = FALSE;
22656             }
22657             break;
22658         }
22659     }
22660     invlist_iterfinish(invlist);
22661
22662     /* Here we have figured things out.  Output each range */
22663     invlist_iterinit(invlist);
22664     while (invlist_iternext(invlist, &start, &end)) {
22665         if (start >= NUM_ANYOF_CODE_POINTS) {
22666             break;
22667         }
22668         put_range(sv, start, end, allow_literals);
22669     }
22670     invlist_iterfinish(invlist);
22671
22672     return;
22673 }
22674
22675 STATIC SV*
22676 S_put_charclass_bitmap_innards_common(pTHX_
22677         SV* invlist,            /* The bitmap */
22678         SV* posixes,            /* Under /l, things like [:word:], \S */
22679         SV* only_utf8,          /* Under /d, matches iff the target is UTF-8 */
22680         SV* not_utf8,           /* /d, matches iff the target isn't UTF-8 */
22681         SV* only_utf8_locale,   /* Under /l, matches if the locale is UTF-8 */
22682         const bool invert       /* Is the result to be inverted? */
22683 )
22684 {
22685     /* Create and return an SV containing a displayable version of the bitmap
22686      * and associated information determined by the input parameters.  If the
22687      * output would have been only the inversion indicator '^', NULL is instead
22688      * returned. */
22689
22690     SV * output;
22691
22692     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS_COMMON;
22693
22694     if (invert) {
22695         output = newSVpvs("^");
22696     }
22697     else {
22698         output = newSVpvs("");
22699     }
22700
22701     /* First, the code points in the bitmap that are unconditionally there */
22702     put_charclass_bitmap_innards_invlist(output, invlist);
22703
22704     /* Traditionally, these have been placed after the main code points */
22705     if (posixes) {
22706         sv_catsv(output, posixes);
22707     }
22708
22709     if (only_utf8 && _invlist_len(only_utf8)) {
22710         Perl_sv_catpvf(aTHX_ output, "%s{utf8}%s", PL_colors[1], PL_colors[0]);
22711         put_charclass_bitmap_innards_invlist(output, only_utf8);
22712     }
22713
22714     if (not_utf8 && _invlist_len(not_utf8)) {
22715         Perl_sv_catpvf(aTHX_ output, "%s{not utf8}%s", PL_colors[1], PL_colors[0]);
22716         put_charclass_bitmap_innards_invlist(output, not_utf8);
22717     }
22718
22719     if (only_utf8_locale && _invlist_len(only_utf8_locale)) {
22720         Perl_sv_catpvf(aTHX_ output, "%s{utf8 locale}%s", PL_colors[1], PL_colors[0]);
22721         put_charclass_bitmap_innards_invlist(output, only_utf8_locale);
22722
22723         /* This is the only list in this routine that can legally contain code
22724          * points outside the bitmap range.  The call just above to
22725          * 'put_charclass_bitmap_innards_invlist' will simply suppress them, so
22726          * output them here.  There's about a half-dozen possible, and none in
22727          * contiguous ranges longer than 2 */
22728         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
22729             UV start, end;
22730             SV* above_bitmap = NULL;
22731
22732             _invlist_subtract(only_utf8_locale, PL_InBitmap, &above_bitmap);
22733
22734             invlist_iterinit(above_bitmap);
22735             while (invlist_iternext(above_bitmap, &start, &end)) {
22736                 UV i;
22737
22738                 for (i = start; i <= end; i++) {
22739                     put_code_point(output, i);
22740                 }
22741             }
22742             invlist_iterfinish(above_bitmap);
22743             SvREFCNT_dec_NN(above_bitmap);
22744         }
22745     }
22746
22747     if (invert && SvCUR(output) == 1) {
22748         return NULL;
22749     }
22750
22751     return output;
22752 }
22753
22754 STATIC bool
22755 S_put_charclass_bitmap_innards(pTHX_ SV *sv,
22756                                      char *bitmap,
22757                                      SV *nonbitmap_invlist,
22758                                      SV *only_utf8_locale_invlist,
22759                                      const regnode * const node,
22760                                      const U8 flags,
22761                                      const bool force_as_is_display)
22762 {
22763     /* Appends to 'sv' a displayable version of the innards of the bracketed
22764      * character class defined by the other arguments:
22765      *  'bitmap' points to the bitmap, or NULL if to ignore that.
22766      *  'nonbitmap_invlist' is an inversion list of the code points that are in
22767      *      the bitmap range, but for some reason aren't in the bitmap; NULL if
22768      *      none.  The reasons for this could be that they require some
22769      *      condition such as the target string being or not being in UTF-8
22770      *      (under /d), or because they came from a user-defined property that
22771      *      was not resolved at the time of the regex compilation (under /u)
22772      *  'only_utf8_locale_invlist' is an inversion list of the code points that
22773      *      are valid only if the runtime locale is a UTF-8 one; NULL if none
22774      *  'node' is the regex pattern ANYOF node.  It is needed only when the
22775      *      above two parameters are not null, and is passed so that this
22776      *      routine can tease apart the various reasons for them.
22777      *  'flags' is the flags field of 'node'
22778      *  'force_as_is_display' is TRUE if this routine should definitely NOT try
22779      *      to invert things to see if that leads to a cleaner display.  If
22780      *      FALSE, this routine is free to use its judgment about doing this.
22781      *
22782      * It returns TRUE if there was actually something output.  (It may be that
22783      * the bitmap, etc is empty.)
22784      *
22785      * When called for outputting the bitmap of a non-ANYOF node, just pass the
22786      * bitmap, with the succeeding parameters set to NULL, and the final one to
22787      * FALSE.
22788      */
22789
22790     /* In general, it tries to display the 'cleanest' representation of the
22791      * innards, choosing whether to display them inverted or not, regardless of
22792      * whether the class itself is to be inverted.  However,  there are some
22793      * cases where it can't try inverting, as what actually matches isn't known
22794      * until runtime, and hence the inversion isn't either. */
22795
22796     bool inverting_allowed = ! force_as_is_display;
22797
22798     int i;
22799     STRLEN orig_sv_cur = SvCUR(sv);
22800
22801     SV* invlist;            /* Inversion list we accumulate of code points that
22802                                are unconditionally matched */
22803     SV* only_utf8 = NULL;   /* Under /d, list of matches iff the target is
22804                                UTF-8 */
22805     SV* not_utf8 =  NULL;   /* /d, list of matches iff the target isn't UTF-8
22806                              */
22807     SV* posixes = NULL;     /* Under /l, string of things like [:word:], \D */
22808     SV* only_utf8_locale = NULL;    /* Under /l, list of matches if the locale
22809                                        is UTF-8 */
22810
22811     SV* as_is_display;      /* The output string when we take the inputs
22812                                literally */
22813     SV* inverted_display;   /* The output string when we invert the inputs */
22814
22815     bool invert = cBOOL(flags & ANYOF_INVERT);  /* Is the input to be inverted
22816                                                    to match? */
22817     /* We are biased in favor of displaying things without them being inverted,
22818      * as that is generally easier to understand */
22819     const int bias = 5;
22820
22821     PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
22822
22823     /* Start off with whatever code points are passed in.  (We clone, so we
22824      * don't change the caller's list) */
22825     if (nonbitmap_invlist) {
22826         assert(invlist_highest(nonbitmap_invlist) < NUM_ANYOF_CODE_POINTS);
22827         invlist = invlist_clone(nonbitmap_invlist, NULL);
22828     }
22829     else {  /* Worst case size is every other code point is matched */
22830         invlist = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
22831     }
22832
22833     if (flags) {
22834         if (OP(node) == ANYOFD) {
22835
22836             /* This flag indicates that the code points below 0x100 in the
22837              * nonbitmap list are precisely the ones that match only when the
22838              * target is UTF-8 (they should all be non-ASCII). */
22839             if (flags & ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)
22840             {
22841                 _invlist_intersection(invlist, PL_UpperLatin1, &only_utf8);
22842                 _invlist_subtract(invlist, only_utf8, &invlist);
22843             }
22844
22845             /* And this flag for matching all non-ASCII 0xFF and below */
22846             if (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER)
22847             {
22848                 not_utf8 = invlist_clone(PL_UpperLatin1, NULL);
22849             }
22850         }
22851         else if (OP(node) == ANYOFL || OP(node) == ANYOFPOSIXL) {
22852
22853             /* If either of these flags are set, what matches isn't
22854              * determinable except during execution, so don't know enough here
22855              * to invert */
22856             if (flags & (ANYOFL_FOLD|ANYOF_MATCHES_POSIXL)) {
22857                 inverting_allowed = FALSE;
22858             }
22859
22860             /* What the posix classes match also varies at runtime, so these
22861              * will be output symbolically. */
22862             if (ANYOF_POSIXL_TEST_ANY_SET(node)) {
22863                 int i;
22864
22865                 posixes = newSVpvs("");
22866                 for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
22867                     if (ANYOF_POSIXL_TEST(node, i)) {
22868                         sv_catpv(posixes, anyofs[i]);
22869                     }
22870                 }
22871             }
22872         }
22873     }
22874
22875     /* Accumulate the bit map into the unconditional match list */
22876     if (bitmap) {
22877         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
22878             if (BITMAP_TEST(bitmap, i)) {
22879                 int start = i++;
22880                 for (;
22881                      i < NUM_ANYOF_CODE_POINTS && BITMAP_TEST(bitmap, i);
22882                      i++)
22883                 { /* empty */ }
22884                 invlist = _add_range_to_invlist(invlist, start, i-1);
22885             }
22886         }
22887     }
22888
22889     /* Make sure that the conditional match lists don't have anything in them
22890      * that match unconditionally; otherwise the output is quite confusing.
22891      * This could happen if the code that populates these misses some
22892      * duplication. */
22893     if (only_utf8) {
22894         _invlist_subtract(only_utf8, invlist, &only_utf8);
22895     }
22896     if (not_utf8) {
22897         _invlist_subtract(not_utf8, invlist, &not_utf8);
22898     }
22899
22900     if (only_utf8_locale_invlist) {
22901
22902         /* Since this list is passed in, we have to make a copy before
22903          * modifying it */
22904         only_utf8_locale = invlist_clone(only_utf8_locale_invlist, NULL);
22905
22906         _invlist_subtract(only_utf8_locale, invlist, &only_utf8_locale);
22907
22908         /* And, it can get really weird for us to try outputting an inverted
22909          * form of this list when it has things above the bitmap, so don't even
22910          * try */
22911         if (invlist_highest(only_utf8_locale) >= NUM_ANYOF_CODE_POINTS) {
22912             inverting_allowed = FALSE;
22913         }
22914     }
22915
22916     /* Calculate what the output would be if we take the input as-is */
22917     as_is_display = put_charclass_bitmap_innards_common(invlist,
22918                                                     posixes,
22919                                                     only_utf8,
22920                                                     not_utf8,
22921                                                     only_utf8_locale,
22922                                                     invert);
22923
22924     /* If have to take the output as-is, just do that */
22925     if (! inverting_allowed) {
22926         if (as_is_display) {
22927             sv_catsv(sv, as_is_display);
22928             SvREFCNT_dec_NN(as_is_display);
22929         }
22930     }
22931     else { /* But otherwise, create the output again on the inverted input, and
22932               use whichever version is shorter */
22933
22934         int inverted_bias, as_is_bias;
22935
22936         /* We will apply our bias to whichever of the results doesn't have
22937          * the '^' */
22938         if (invert) {
22939             invert = FALSE;
22940             as_is_bias = bias;
22941             inverted_bias = 0;
22942         }
22943         else {
22944             invert = TRUE;
22945             as_is_bias = 0;
22946             inverted_bias = bias;
22947         }
22948
22949         /* Now invert each of the lists that contribute to the output,
22950          * excluding from the result things outside the possible range */
22951
22952         /* For the unconditional inversion list, we have to add in all the
22953          * conditional code points, so that when inverted, they will be gone
22954          * from it */
22955         _invlist_union(only_utf8, invlist, &invlist);
22956         _invlist_union(not_utf8, invlist, &invlist);
22957         _invlist_union(only_utf8_locale, invlist, &invlist);
22958         _invlist_invert(invlist);
22959         _invlist_intersection(invlist, PL_InBitmap, &invlist);
22960
22961         if (only_utf8) {
22962             _invlist_invert(only_utf8);
22963             _invlist_intersection(only_utf8, PL_UpperLatin1, &only_utf8);
22964         }
22965         else if (not_utf8) {
22966
22967             /* If a code point matches iff the target string is not in UTF-8,
22968              * then complementing the result has it not match iff not in UTF-8,
22969              * which is the same thing as matching iff it is UTF-8. */
22970             only_utf8 = not_utf8;
22971             not_utf8 = NULL;
22972         }
22973
22974         if (only_utf8_locale) {
22975             _invlist_invert(only_utf8_locale);
22976             _invlist_intersection(only_utf8_locale,
22977                                   PL_InBitmap,
22978                                   &only_utf8_locale);
22979         }
22980
22981         inverted_display = put_charclass_bitmap_innards_common(
22982                                             invlist,
22983                                             posixes,
22984                                             only_utf8,
22985                                             not_utf8,
22986                                             only_utf8_locale, invert);
22987
22988         /* Use the shortest representation, taking into account our bias
22989          * against showing it inverted */
22990         if (   inverted_display
22991             && (   ! as_is_display
22992                 || (  SvCUR(inverted_display) + inverted_bias
22993                     < SvCUR(as_is_display)    + as_is_bias)))
22994         {
22995             sv_catsv(sv, inverted_display);
22996         }
22997         else if (as_is_display) {
22998             sv_catsv(sv, as_is_display);
22999         }
23000
23001         SvREFCNT_dec(as_is_display);
23002         SvREFCNT_dec(inverted_display);
23003     }
23004
23005     SvREFCNT_dec_NN(invlist);
23006     SvREFCNT_dec(only_utf8);
23007     SvREFCNT_dec(not_utf8);
23008     SvREFCNT_dec(posixes);
23009     SvREFCNT_dec(only_utf8_locale);
23010
23011     return SvCUR(sv) > orig_sv_cur;
23012 }
23013
23014 #define CLEAR_OPTSTART                                                       \
23015     if (optstart) STMT_START {                                               \
23016         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_                                           \
23017                               " (%" IVdf " nodes)\n", (IV)(node - optstart))); \
23018         optstart=NULL;                                                       \
23019     } STMT_END
23020
23021 #define DUMPUNTIL(b,e)                                                       \
23022                     CLEAR_OPTSTART;                                          \
23023                     node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
23024
23025 STATIC const regnode *
23026 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
23027             const regnode *last, const regnode *plast,
23028             SV* sv, I32 indent, U32 depth)
23029 {
23030     U8 op = PSEUDO;     /* Arbitrary non-END op. */
23031     const regnode *next;
23032     const regnode *optstart= NULL;
23033
23034     RXi_GET_DECL(r, ri);
23035     DECLARE_AND_GET_RE_DEBUG_FLAGS;
23036
23037     PERL_ARGS_ASSERT_DUMPUNTIL;
23038
23039 #ifdef DEBUG_DUMPUNTIL
23040     Perl_re_printf( aTHX_  "--- %d : %d - %d - %d\n", indent, node-start,
23041         last ? last-start : 0, plast ? plast-start : 0);
23042 #endif
23043
23044     if (plast && plast < last)
23045         last= plast;
23046
23047     while (PL_regkind[op] != END && (!last || node < last)) {
23048         assert(node);
23049         /* While that wasn't END last time... */
23050         NODE_ALIGN(node);
23051         op = OP(node);
23052         if (op == CLOSE || op == SRCLOSE || op == WHILEM)
23053             indent--;
23054         next = regnext((regnode *)node);
23055
23056         /* Where, what. */
23057         if (OP(node) == OPTIMIZED) {
23058             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
23059                 optstart = node;
23060             else
23061                 goto after_print;
23062         } else
23063             CLEAR_OPTSTART;
23064
23065         regprop(r, sv, node, NULL, NULL);
23066         Perl_re_printf( aTHX_  "%4" IVdf ":%*s%s", (IV)(node - start),
23067                       (int)(2*indent + 1), "", SvPVX_const(sv));
23068
23069         if (OP(node) != OPTIMIZED) {
23070             if (next == NULL)           /* Next ptr. */
23071                 Perl_re_printf( aTHX_  " (0)");
23072             else if (PL_regkind[(U8)op] == BRANCH
23073                      && PL_regkind[OP(next)] != BRANCH )
23074                 Perl_re_printf( aTHX_  " (FAIL)");
23075             else
23076                 Perl_re_printf( aTHX_  " (%" IVdf ")", (IV)(next - start));
23077             Perl_re_printf( aTHX_ "\n");
23078         }
23079
23080       after_print:
23081         if (PL_regkind[(U8)op] == BRANCHJ) {
23082             assert(next);
23083             {
23084                 const regnode *nnode = (OP(next) == LONGJMP
23085                                        ? regnext((regnode *)next)
23086                                        : next);
23087                 if (last && nnode > last)
23088                     nnode = last;
23089                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
23090             }
23091         }
23092         else if (PL_regkind[(U8)op] == BRANCH) {
23093             assert(next);
23094             DUMPUNTIL(NEXTOPER(node), next);
23095         }
23096         else if ( PL_regkind[(U8)op]  == TRIE ) {
23097             const regnode *this_trie = node;
23098             const char op = OP(node);
23099             const U32 n = ARG(node);
23100             const reg_ac_data * const ac = op>=AHOCORASICK ?
23101                (reg_ac_data *)ri->data->data[n] :
23102                NULL;
23103             const reg_trie_data * const trie =
23104                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
23105 #ifdef DEBUGGING
23106             AV *const trie_words
23107                            = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
23108 #endif
23109             const regnode *nextbranch= NULL;
23110             I32 word_idx;
23111             SvPVCLEAR(sv);
23112             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
23113                 SV ** const elem_ptr = av_fetch(trie_words, word_idx, 0);
23114
23115                 Perl_re_indentf( aTHX_  "%s ",
23116                     indent+3,
23117                     elem_ptr
23118                     ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
23119                                 SvCUR(*elem_ptr), PL_dump_re_max_len,
23120                                 PL_colors[0], PL_colors[1],
23121                                 (SvUTF8(*elem_ptr)
23122                                  ? PERL_PV_ESCAPE_UNI
23123                                  : 0)
23124                                 | PERL_PV_PRETTY_ELLIPSES
23125                                 | PERL_PV_PRETTY_LTGT
23126                             )
23127                     : "???"
23128                 );
23129                 if (trie->jump) {
23130                     U16 dist= trie->jump[word_idx+1];
23131                     Perl_re_printf( aTHX_  "(%" UVuf ")\n",
23132                                (UV)((dist ? this_trie + dist : next) - start));
23133                     if (dist) {
23134                         if (!nextbranch)
23135                             nextbranch= this_trie + trie->jump[0];
23136                         DUMPUNTIL(this_trie + dist, nextbranch);
23137                     }
23138                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
23139                         nextbranch= regnext((regnode *)nextbranch);
23140                 } else {
23141                     Perl_re_printf( aTHX_  "\n");
23142                 }
23143             }
23144             if (last && next > last)
23145                 node= last;
23146             else
23147                 node= next;
23148         }
23149         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
23150             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
23151                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
23152         }
23153         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
23154             assert(next);
23155             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
23156         }
23157         else if ( op == PLUS || op == STAR) {
23158             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
23159         }
23160         else if (PL_regkind[(U8)op] == EXACT || op == ANYOFHs) {
23161             /* Literal string, where present. */
23162             node += NODE_SZ_STR(node) - 1;
23163             node = NEXTOPER(node);
23164         }
23165         else {
23166             node = NEXTOPER(node);
23167             node += regarglen[(U8)op];
23168         }
23169         if (op == CURLYX || op == OPEN || op == SROPEN)
23170             indent++;
23171     }
23172     CLEAR_OPTSTART;
23173 #ifdef DEBUG_DUMPUNTIL
23174     Perl_re_printf( aTHX_  "--- %d\n", (int)indent);
23175 #endif
23176     return node;
23177 }
23178
23179 #endif  /* DEBUGGING */
23180
23181 #ifndef PERL_IN_XSUB_RE
23182
23183 #  include "uni_keywords.h"
23184
23185 void
23186 Perl_init_uniprops(pTHX)
23187 {
23188
23189 #  ifdef DEBUGGING
23190     char * dump_len_string;
23191
23192     dump_len_string = PerlEnv_getenv("PERL_DUMP_RE_MAX_LEN");
23193     if (   ! dump_len_string
23194         || ! grok_atoUV(dump_len_string, (UV *)&PL_dump_re_max_len, NULL))
23195     {
23196         PL_dump_re_max_len = 60;    /* A reasonable default */
23197     }
23198 #  endif
23199
23200     PL_user_def_props = newHV();
23201
23202 #  ifdef USE_ITHREADS
23203
23204     HvSHAREKEYS_off(PL_user_def_props);
23205     PL_user_def_props_aTHX = aTHX;
23206
23207 #  endif
23208
23209     /* Set up the inversion list interpreter-level variables */
23210
23211     PL_XPosix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
23212     PL_XPosix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALNUM]);
23213     PL_XPosix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXALPHA]);
23214     PL_XPosix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXBLANK]);
23215     PL_XPosix_ptrs[_CC_CASED] =  _new_invlist_C_array(uni_prop_ptrs[UNI_CASED]);
23216     PL_XPosix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXCNTRL]);
23217     PL_XPosix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXDIGIT]);
23218     PL_XPosix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXGRAPH]);
23219     PL_XPosix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXLOWER]);
23220     PL_XPosix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPRINT]);
23221     PL_XPosix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXPUNCT]);
23222     PL_XPosix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXSPACE]);
23223     PL_XPosix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXUPPER]);
23224     PL_XPosix_ptrs[_CC_VERTSPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_VERTSPACE]);
23225     PL_XPosix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXWORD]);
23226     PL_XPosix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_XPOSIXXDIGIT]);
23227
23228     PL_Posix_ptrs[_CC_ASCII] = _new_invlist_C_array(uni_prop_ptrs[UNI_ASCII]);
23229     PL_Posix_ptrs[_CC_ALPHANUMERIC] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALNUM]);
23230     PL_Posix_ptrs[_CC_ALPHA] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXALPHA]);
23231     PL_Posix_ptrs[_CC_BLANK] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXBLANK]);
23232     PL_Posix_ptrs[_CC_CASED] = PL_Posix_ptrs[_CC_ALPHA];
23233     PL_Posix_ptrs[_CC_CNTRL] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXCNTRL]);
23234     PL_Posix_ptrs[_CC_DIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXDIGIT]);
23235     PL_Posix_ptrs[_CC_GRAPH] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXGRAPH]);
23236     PL_Posix_ptrs[_CC_LOWER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXLOWER]);
23237     PL_Posix_ptrs[_CC_PRINT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPRINT]);
23238     PL_Posix_ptrs[_CC_PUNCT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXPUNCT]);
23239     PL_Posix_ptrs[_CC_SPACE] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXSPACE]);
23240     PL_Posix_ptrs[_CC_UPPER] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXUPPER]);
23241     PL_Posix_ptrs[_CC_VERTSPACE] = NULL;
23242     PL_Posix_ptrs[_CC_WORDCHAR] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXWORD]);
23243     PL_Posix_ptrs[_CC_XDIGIT] = _new_invlist_C_array(uni_prop_ptrs[UNI_POSIXXDIGIT]);
23244
23245     PL_GCB_invlist = _new_invlist_C_array(_Perl_GCB_invlist);
23246     PL_SB_invlist = _new_invlist_C_array(_Perl_SB_invlist);
23247     PL_WB_invlist = _new_invlist_C_array(_Perl_WB_invlist);
23248     PL_LB_invlist = _new_invlist_C_array(_Perl_LB_invlist);
23249     PL_SCX_invlist = _new_invlist_C_array(_Perl_SCX_invlist);
23250
23251     PL_InBitmap = _new_invlist_C_array(InBitmap_invlist);
23252     PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
23253     PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
23254     PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
23255
23256     PL_Assigned_invlist = _new_invlist_C_array(uni_prop_ptrs[UNI_ASSIGNED]);
23257
23258     PL_utf8_perl_idstart = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDSTART]);
23259     PL_utf8_perl_idcont = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_IDCONT]);
23260
23261     PL_utf8_charname_begin = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_BEGIN]);
23262     PL_utf8_charname_continue = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_CHARNAME_CONTINUE]);
23263
23264     PL_in_some_fold = _new_invlist_C_array(uni_prop_ptrs[UNI__PERL_ANY_FOLDS]);
23265     PL_HasMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
23266                                             UNI__PERL_FOLDS_TO_MULTI_CHAR]);
23267     PL_InMultiCharFold = _new_invlist_C_array(uni_prop_ptrs[
23268                                             UNI__PERL_IS_IN_MULTI_CHAR_FOLD]);
23269     PL_utf8_toupper = _new_invlist_C_array(Uppercase_Mapping_invlist);
23270     PL_utf8_tolower = _new_invlist_C_array(Lowercase_Mapping_invlist);
23271     PL_utf8_totitle = _new_invlist_C_array(Titlecase_Mapping_invlist);
23272     PL_utf8_tofold = _new_invlist_C_array(Case_Folding_invlist);
23273     PL_utf8_tosimplefold = _new_invlist_C_array(Simple_Case_Folding_invlist);
23274     PL_utf8_foldclosures = _new_invlist_C_array(_Perl_IVCF_invlist);
23275     PL_utf8_mark = _new_invlist_C_array(uni_prop_ptrs[UNI_M]);
23276     PL_CCC_non0_non230 = _new_invlist_C_array(_Perl_CCC_non0_non230_invlist);
23277     PL_Private_Use = _new_invlist_C_array(uni_prop_ptrs[UNI_CO]);
23278
23279 #  ifdef UNI_XIDC
23280     /* The below are used only by deprecated functions.  They could be removed */
23281     PL_utf8_xidcont  = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDC]);
23282     PL_utf8_idcont   = _new_invlist_C_array(uni_prop_ptrs[UNI_IDC]);
23283     PL_utf8_xidstart = _new_invlist_C_array(uni_prop_ptrs[UNI_XIDS]);
23284 #  endif
23285 }
23286
23287 /* These four functions are compiled only in regcomp.c, where they have access
23288  * to the data they return.  They are a way for re_comp.c to get access to that
23289  * data without having to compile the whole data structures. */
23290
23291 I16
23292 Perl_do_uniprop_match(const char * const key, const U16 key_len)
23293 {
23294     PERL_ARGS_ASSERT_DO_UNIPROP_MATCH;
23295
23296     return match_uniprop((U8 *) key, key_len);
23297 }
23298
23299 SV *
23300 Perl_get_prop_definition(pTHX_ const int table_index)
23301 {
23302     PERL_ARGS_ASSERT_GET_PROP_DEFINITION;
23303
23304     /* Create and return the inversion list */
23305     return _new_invlist_C_array(uni_prop_ptrs[table_index]);
23306 }
23307
23308 const char * const *
23309 Perl_get_prop_values(const int table_index)
23310 {
23311     PERL_ARGS_ASSERT_GET_PROP_VALUES;
23312
23313     return UNI_prop_value_ptrs[table_index];
23314 }
23315
23316 const char *
23317 Perl_get_deprecated_property_msg(const Size_t warning_offset)
23318 {
23319     PERL_ARGS_ASSERT_GET_DEPRECATED_PROPERTY_MSG;
23320
23321     return deprecated_property_msgs[warning_offset];
23322 }
23323
23324 #  if 0
23325
23326 This code was mainly added for backcompat to give a warning for non-portable
23327 code points in user-defined properties.  But experiments showed that the
23328 warning in earlier perls were only omitted on overflow, which should be an
23329 error, so there really isnt a backcompat issue, and actually adding the
23330 warning when none was present before might cause breakage, for little gain.  So
23331 khw left this code in, but not enabled.  Tests were never added.
23332
23333 embed.fnc entry:
23334 Ei      |const char *|get_extended_utf8_msg|const UV cp
23335
23336 PERL_STATIC_INLINE const char *
23337 S_get_extended_utf8_msg(pTHX_ const UV cp)
23338 {
23339     U8 dummy[UTF8_MAXBYTES + 1];
23340     HV *msgs;
23341     SV **msg;
23342
23343     uvchr_to_utf8_flags_msgs(dummy, cp, UNICODE_WARN_PERL_EXTENDED,
23344                              &msgs);
23345
23346     msg = hv_fetchs(msgs, "text", 0);
23347     assert(msg);
23348
23349     (void) sv_2mortal((SV *) msgs);
23350
23351     return SvPVX(*msg);
23352 }
23353
23354 #  endif
23355 #endif /* end of ! PERL_IN_XSUB_RE */
23356
23357 STATIC REGEXP *
23358 S_compile_wildcard(pTHX_ const char * subpattern, const STRLEN len,
23359                          const bool ignore_case)
23360 {
23361     /* Pretends that the input subpattern is qr/subpattern/aam, compiling it
23362      * possibly with /i if the 'ignore_case' parameter is true.  Use /aa
23363      * because nothing outside of ASCII will match.  Use /m because the input
23364      * string may be a bunch of lines strung together.
23365      *
23366      * Also sets up the debugging info */
23367
23368     U32 flags = PMf_MULTILINE|PMf_WILDCARD;
23369     U32 rx_flags;
23370     SV * subpattern_sv = sv_2mortal(newSVpvn(subpattern, len));
23371     REGEXP * subpattern_re;
23372     DECLARE_AND_GET_RE_DEBUG_FLAGS;
23373
23374     PERL_ARGS_ASSERT_COMPILE_WILDCARD;
23375
23376     if (ignore_case) {
23377         flags |= PMf_FOLD;
23378     }
23379     set_regex_charset(&flags, REGEX_ASCII_MORE_RESTRICTED_CHARSET);
23380
23381     /* Like in op.c, we copy the compile time pm flags to the rx ones */
23382     rx_flags = flags & RXf_PMf_COMPILETIME;
23383
23384 #ifndef PERL_IN_XSUB_RE
23385     /* Use the core engine if this file is regcomp.c.  That means no
23386      * 'use re "Debug ..." is in effect, so the core engine is sufficient */
23387     subpattern_re = Perl_re_op_compile(aTHX_ &subpattern_sv, 1, NULL,
23388                                              &PL_core_reg_engine,
23389                                              NULL, NULL,
23390                                              rx_flags, flags);
23391 #else
23392     if (isDEBUG_WILDCARD) {
23393         /* Use the special debugging engine if this file is re_comp.c and wants
23394          * to output the wildcard matching.  This uses whatever
23395          * 'use re "Debug ..." is in effect */
23396         subpattern_re = Perl_re_op_compile(aTHX_ &subpattern_sv, 1, NULL,
23397                                                  &my_reg_engine,
23398                                                  NULL, NULL,
23399                                                  rx_flags, flags);
23400     }
23401     else {
23402         /* Use the special wildcard engine if this file is re_comp.c and
23403          * doesn't want to output the wildcard matching.  This uses whatever
23404          * 'use re "Debug ..." is in effect for compilation, but this engine
23405          * structure has been set up so that it uses the core engine for
23406          * execution, so no execution debugging as a result of re.pm will be
23407          * displayed. */
23408         subpattern_re = Perl_re_op_compile(aTHX_ &subpattern_sv, 1, NULL,
23409                                                  &wild_reg_engine,
23410                                                  NULL, NULL,
23411                                                  rx_flags, flags);
23412         /* XXX The above has the effect that any user-supplied regex engine
23413          * won't be called for matching wildcards.  That might be good, or bad.
23414          * It could be changed in several ways.  The reason it is done the
23415          * current way is to avoid having to save and restore
23416          * ^{^RE_DEBUG_FLAGS} around the execution.  save_scalar() perhaps
23417          * could be used.  Another suggestion is to keep the authoritative
23418          * value of the debug flags in a thread-local variable and add set/get
23419          * magic to ${^RE_DEBUG_FLAGS} to keep the C level variable up to date.
23420          * Still another is to pass a flag, say in the engine's intflags that
23421          * would be checked each time before doing the debug output */
23422     }
23423 #endif
23424
23425     assert(subpattern_re);  /* Should have died if didn't compile successfully */
23426     return subpattern_re;
23427 }
23428
23429 STATIC I32
23430 S_execute_wildcard(pTHX_ REGEXP * const prog, char* stringarg, char *strend,
23431          char *strbeg, SSize_t minend, SV *screamer, U32 nosave)
23432 {
23433     I32 result;
23434     DECLARE_AND_GET_RE_DEBUG_FLAGS;
23435
23436     PERL_ARGS_ASSERT_EXECUTE_WILDCARD;
23437
23438     ENTER;
23439
23440     /* The compilation has set things up so that if the program doesn't want to
23441      * see the wildcard matching procedure, it will get the core execution
23442      * engine, which is subject only to -Dr.  So we have to turn that off
23443      * around this procedure */
23444     if (! isDEBUG_WILDCARD) {
23445         /* Note! Casts away 'volatile' */
23446         SAVEI32(PL_debug);
23447         PL_debug &= ~ DEBUG_r_FLAG;
23448     }
23449
23450     result = CALLREGEXEC(prog, stringarg, strend, strbeg, minend, screamer,
23451                          NULL, nosave);
23452     LEAVE;
23453
23454     return result;
23455 }
23456
23457 SV *
23458 S_handle_user_defined_property(pTHX_
23459
23460     /* Parses the contents of a user-defined property definition; returning the
23461      * expanded definition if possible.  If so, the return is an inversion
23462      * list.
23463      *
23464      * If there are subroutines that are part of the expansion and which aren't
23465      * known at the time of the call to this function, this returns what
23466      * parse_uniprop_string() returned for the first one encountered.
23467      *
23468      * If an error was found, NULL is returned, and 'msg' gets a suitable
23469      * message appended to it.  (Appending allows the back trace of how we got
23470      * to the faulty definition to be displayed through nested calls of
23471      * user-defined subs.)
23472      *
23473      * The caller IS responsible for freeing any returned SV.
23474      *
23475      * The syntax of the contents is pretty much described in perlunicode.pod,
23476      * but we also allow comments on each line */
23477
23478     const char * name,          /* Name of property */
23479     const STRLEN name_len,      /* The name's length in bytes */
23480     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
23481     const bool to_fold,         /* ? Is this under /i */
23482     const bool runtime,         /* ? Are we in compile- or run-time */
23483     const bool deferrable,      /* Is it ok for this property's full definition
23484                                    to be deferred until later? */
23485     SV* contents,               /* The property's definition */
23486     bool *user_defined_ptr,     /* This will be set TRUE as we wouldn't be
23487                                    getting called unless this is thought to be
23488                                    a user-defined property */
23489     SV * msg,                   /* Any error or warning msg(s) are appended to
23490                                    this */
23491     const STRLEN level)         /* Recursion level of this call */
23492 {
23493     STRLEN len;
23494     const char * string         = SvPV_const(contents, len);
23495     const char * const e        = string + len;
23496     const bool is_contents_utf8 = cBOOL(SvUTF8(contents));
23497     const STRLEN msgs_length_on_entry = SvCUR(msg);
23498
23499     const char * s0 = string;   /* Points to first byte in the current line
23500                                    being parsed in 'string' */
23501     const char overflow_msg[] = "Code point too large in \"";
23502     SV* running_definition = NULL;
23503
23504     PERL_ARGS_ASSERT_HANDLE_USER_DEFINED_PROPERTY;
23505
23506     *user_defined_ptr = TRUE;
23507
23508     /* Look at each line */
23509     while (s0 < e) {
23510         const char * s;     /* Current byte */
23511         char op = '+';      /* Default operation is 'union' */
23512         IV   min = 0;       /* range begin code point */
23513         IV   max = -1;      /* and range end */
23514         SV* this_definition;
23515
23516         /* Skip comment lines */
23517         if (*s0 == '#') {
23518             s0 = strchr(s0, '\n');
23519             if (s0 == NULL) {
23520                 break;
23521             }
23522             s0++;
23523             continue;
23524         }
23525
23526         /* For backcompat, allow an empty first line */
23527         if (*s0 == '\n') {
23528             s0++;
23529             continue;
23530         }
23531
23532         /* First character in the line may optionally be the operation */
23533         if (   *s0 == '+'
23534             || *s0 == '!'
23535             || *s0 == '-'
23536             || *s0 == '&')
23537         {
23538             op = *s0++;
23539         }
23540
23541         /* If the line is one or two hex digits separated by blank space, its
23542          * a range; otherwise it is either another user-defined property or an
23543          * error */
23544
23545         s = s0;
23546
23547         if (! isXDIGIT(*s)) {
23548             goto check_if_property;
23549         }
23550
23551         do { /* Each new hex digit will add 4 bits. */
23552             if (min > ( (IV) MAX_LEGAL_CP >> 4)) {
23553                 s = strchr(s, '\n');
23554                 if (s == NULL) {
23555                     s = e;
23556                 }
23557                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23558                 sv_catpv(msg, overflow_msg);
23559                 Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
23560                                      UTF8fARG(is_contents_utf8, s - s0, s0));
23561                 sv_catpvs(msg, "\"");
23562                 goto return_failure;
23563             }
23564
23565             /* Accumulate this digit into the value */
23566             min = (min << 4) + READ_XDIGIT(s);
23567         } while (isXDIGIT(*s));
23568
23569         while (isBLANK(*s)) { s++; }
23570
23571         /* We allow comments at the end of the line */
23572         if (*s == '#') {
23573             s = strchr(s, '\n');
23574             if (s == NULL) {
23575                 s = e;
23576             }
23577             s++;
23578         }
23579         else if (s < e && *s != '\n') {
23580             if (! isXDIGIT(*s)) {
23581                 goto check_if_property;
23582             }
23583
23584             /* Look for the high point of the range */
23585             max = 0;
23586             do {
23587                 if (max > ( (IV) MAX_LEGAL_CP >> 4)) {
23588                     s = strchr(s, '\n');
23589                     if (s == NULL) {
23590                         s = e;
23591                     }
23592                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23593                     sv_catpv(msg, overflow_msg);
23594                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
23595                                       UTF8fARG(is_contents_utf8, s - s0, s0));
23596                     sv_catpvs(msg, "\"");
23597                     goto return_failure;
23598                 }
23599
23600                 max = (max << 4) + READ_XDIGIT(s);
23601             } while (isXDIGIT(*s));
23602
23603             while (isBLANK(*s)) { s++; }
23604
23605             if (*s == '#') {
23606                 s = strchr(s, '\n');
23607                 if (s == NULL) {
23608                     s = e;
23609                 }
23610             }
23611             else if (s < e && *s != '\n') {
23612                 goto check_if_property;
23613             }
23614         }
23615
23616         if (max == -1) {    /* The line only had one entry */
23617             max = min;
23618         }
23619         else if (max < min) {
23620             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23621             sv_catpvs(msg, "Illegal range in \"");
23622             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
23623                                 UTF8fARG(is_contents_utf8, s - s0, s0));
23624             sv_catpvs(msg, "\"");
23625             goto return_failure;
23626         }
23627
23628 #  if 0   /* See explanation at definition above of get_extended_utf8_msg() */
23629
23630         if (   UNICODE_IS_PERL_EXTENDED(min)
23631             || UNICODE_IS_PERL_EXTENDED(max))
23632         {
23633             if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
23634
23635             /* If both code points are non-portable, warn only on the lower
23636              * one. */
23637             sv_catpv(msg, get_extended_utf8_msg(
23638                                             (UNICODE_IS_PERL_EXTENDED(min))
23639                                             ? min : max));
23640             sv_catpvs(msg, " in \"");
23641             Perl_sv_catpvf(aTHX_ msg, "%" UTF8f,
23642                                  UTF8fARG(is_contents_utf8, s - s0, s0));
23643             sv_catpvs(msg, "\"");
23644         }
23645
23646 #  endif
23647
23648         /* Here, this line contains a legal range */
23649         this_definition = sv_2mortal(_new_invlist(2));
23650         this_definition = _add_range_to_invlist(this_definition, min, max);
23651         goto calculate;
23652
23653       check_if_property:
23654
23655         /* Here it isn't a legal range line.  See if it is a legal property
23656          * line.  First find the end of the meat of the line */
23657         s = strpbrk(s, "#\n");
23658         if (s == NULL) {
23659             s = e;
23660         }
23661
23662         /* Ignore trailing blanks in keeping with the requirements of
23663          * parse_uniprop_string() */
23664         s--;
23665         while (s > s0 && isBLANK_A(*s)) {
23666             s--;
23667         }
23668         s++;
23669
23670         this_definition = parse_uniprop_string(s0, s - s0,
23671                                                is_utf8, to_fold, runtime,
23672                                                deferrable,
23673                                                NULL,
23674                                                user_defined_ptr, msg,
23675                                                (name_len == 0)
23676                                                 ? level /* Don't increase level
23677                                                            if input is empty */
23678                                                 : level + 1
23679                                               );
23680         if (this_definition == NULL) {
23681             goto return_failure;    /* 'msg' should have had the reason
23682                                        appended to it by the above call */
23683         }
23684
23685         if (! is_invlist(this_definition)) {    /* Unknown at this time */
23686             return newSVsv(this_definition);
23687         }
23688
23689         if (*s != '\n') {
23690             s = strchr(s, '\n');
23691             if (s == NULL) {
23692                 s = e;
23693             }
23694         }
23695
23696       calculate:
23697
23698         switch (op) {
23699             case '+':
23700                 _invlist_union(running_definition, this_definition,
23701                                                         &running_definition);
23702                 break;
23703             case '-':
23704                 _invlist_subtract(running_definition, this_definition,
23705                                                         &running_definition);
23706                 break;
23707             case '&':
23708                 _invlist_intersection(running_definition, this_definition,
23709                                                         &running_definition);
23710                 break;
23711             case '!':
23712                 _invlist_union_complement_2nd(running_definition,
23713                                         this_definition, &running_definition);
23714                 break;
23715             default:
23716                 Perl_croak(aTHX_ "panic: %s: %d: Unexpected operation %d",
23717                                  __FILE__, __LINE__, op);
23718                 break;
23719         }
23720
23721         /* Position past the '\n' */
23722         s0 = s + 1;
23723     }   /* End of loop through the lines of 'contents' */
23724
23725     /* Here, we processed all the lines in 'contents' without error.  If we
23726      * didn't add any warnings, simply return success */
23727     if (msgs_length_on_entry == SvCUR(msg)) {
23728
23729         /* If the expansion was empty, the answer isn't nothing: its an empty
23730          * inversion list */
23731         if (running_definition == NULL) {
23732             running_definition = _new_invlist(1);
23733         }
23734
23735         return running_definition;
23736     }
23737
23738     /* Otherwise, add some explanatory text, but we will return success */
23739     goto return_msg;
23740
23741   return_failure:
23742     running_definition = NULL;
23743
23744   return_msg:
23745
23746     if (name_len > 0) {
23747         sv_catpvs(msg, " in expansion of ");
23748         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
23749     }
23750
23751     return running_definition;
23752 }
23753
23754 /* As explained below, certain operations need to take place in the first
23755  * thread created.  These macros switch contexts */
23756 #  ifdef USE_ITHREADS
23757 #    define DECLARATION_FOR_GLOBAL_CONTEXT                                  \
23758                                         PerlInterpreter * save_aTHX = aTHX;
23759 #    define SWITCH_TO_GLOBAL_CONTEXT                                        \
23760                            PERL_SET_CONTEXT((aTHX = PL_user_def_props_aTHX))
23761 #    define RESTORE_CONTEXT  PERL_SET_CONTEXT((aTHX = save_aTHX));
23762 #    define CUR_CONTEXT      aTHX
23763 #    define ORIGINAL_CONTEXT save_aTHX
23764 #  else
23765 #    define DECLARATION_FOR_GLOBAL_CONTEXT    dNOOP
23766 #    define SWITCH_TO_GLOBAL_CONTEXT          NOOP
23767 #    define RESTORE_CONTEXT                   NOOP
23768 #    define CUR_CONTEXT                       NULL
23769 #    define ORIGINAL_CONTEXT                  NULL
23770 #  endif
23771
23772 STATIC void
23773 S_delete_recursion_entry(pTHX_ void *key)
23774 {
23775     /* Deletes the entry used to detect recursion when expanding user-defined
23776      * properties.  This is a function so it can be set up to be called even if
23777      * the program unexpectedly quits */
23778
23779     SV ** current_entry;
23780     const STRLEN key_len = strlen((const char *) key);
23781     DECLARATION_FOR_GLOBAL_CONTEXT;
23782
23783     SWITCH_TO_GLOBAL_CONTEXT;
23784
23785     /* If the entry is one of these types, it is a permanent entry, and not the
23786      * one used to detect recursions.  This function should delete only the
23787      * recursion entry */
23788     current_entry = hv_fetch(PL_user_def_props, (const char *) key, key_len, 0);
23789     if (     current_entry
23790         && ! is_invlist(*current_entry)
23791         && ! SvPOK(*current_entry))
23792     {
23793         (void) hv_delete(PL_user_def_props, (const char *) key, key_len,
23794                                                                     G_DISCARD);
23795     }
23796
23797     RESTORE_CONTEXT;
23798 }
23799
23800 STATIC SV *
23801 S_get_fq_name(pTHX_
23802               const char * const name,    /* The first non-blank in the \p{}, \P{} */
23803               const Size_t name_len,      /* Its length in bytes, not including any trailing space */
23804               const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
23805               const bool has_colon_colon
23806              )
23807 {
23808     /* Returns a mortal SV containing the fully qualified version of the input
23809      * name */
23810
23811     SV * fq_name;
23812
23813     fq_name = newSVpvs_flags("", SVs_TEMP);
23814
23815     /* Use the current package if it wasn't included in our input */
23816     if (! has_colon_colon) {
23817         const HV * pkg = (IN_PERL_COMPILETIME)
23818                          ? PL_curstash
23819                          : CopSTASH(PL_curcop);
23820         const char* pkgname = HvNAME(pkg);
23821
23822         Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
23823                       UTF8fARG(is_utf8, strlen(pkgname), pkgname));
23824         sv_catpvs(fq_name, "::");
23825     }
23826
23827     Perl_sv_catpvf(aTHX_ fq_name, "%" UTF8f,
23828                          UTF8fARG(is_utf8, name_len, name));
23829     return fq_name;
23830 }
23831
23832 STATIC SV *
23833 S_parse_uniprop_string(pTHX_
23834
23835     /* Parse the interior of a \p{}, \P{}.  Returns its definition if knowable
23836      * now.  If so, the return is an inversion list.
23837      *
23838      * If the property is user-defined, it is a subroutine, which in turn
23839      * may call other subroutines.  This function will call the whole nest of
23840      * them to get the definition they return; if some aren't known at the time
23841      * of the call to this function, the fully qualified name of the highest
23842      * level sub is returned.  It is an error to call this function at runtime
23843      * without every sub defined.
23844      *
23845      * If an error was found, NULL is returned, and 'msg' gets a suitable
23846      * message appended to it.  (Appending allows the back trace of how we got
23847      * to the faulty definition to be displayed through nested calls of
23848      * user-defined subs.)
23849      *
23850      * The caller should NOT try to free any returned inversion list.
23851      *
23852      * Other parameters will be set on return as described below */
23853
23854     const char * const name,    /* The first non-blank in the \p{}, \P{} */
23855     Size_t name_len,            /* Its length in bytes, not including any
23856                                    trailing space */
23857     const bool is_utf8,         /* ? Is 'name' encoded in UTF-8 */
23858     const bool to_fold,         /* ? Is this under /i */
23859     const bool runtime,         /* TRUE if this is being called at run time */
23860     const bool deferrable,      /* TRUE if it's ok for the definition to not be
23861                                    known at this call */
23862     AV ** strings,              /* To return string property values, like named
23863                                    sequences */
23864     bool *user_defined_ptr,     /* Upon return from this function it will be
23865                                    set to TRUE if any component is a
23866                                    user-defined property */
23867     SV * msg,                   /* Any error or warning msg(s) are appended to
23868                                    this */
23869     const STRLEN level)         /* Recursion level of this call */
23870 {
23871     char* lookup_name;          /* normalized name for lookup in our tables */
23872     unsigned lookup_len;        /* Its length */
23873     enum { Not_Strict = 0,      /* Some properties have stricter name */
23874            Strict,              /* normalization rules, which we decide */
23875            As_Is                /* upon based on parsing */
23876          } stricter = Not_Strict;
23877
23878     /* nv= or numeric_value=, or possibly one of the cjk numeric properties
23879      * (though it requires extra effort to download them from Unicode and
23880      * compile perl to know about them) */
23881     bool is_nv_type = FALSE;
23882
23883     unsigned int i, j = 0;
23884     int equals_pos = -1;    /* Where the '=' is found, or negative if none */
23885     int slash_pos  = -1;    /* Where the '/' is found, or negative if none */
23886     int table_index = 0;    /* The entry number for this property in the table
23887                                of all Unicode property names */
23888     bool starts_with_Is = FALSE;  /* ? Does the name start with 'Is' */
23889     Size_t lookup_offset = 0;   /* Used to ignore the first few characters of
23890                                    the normalized name in certain situations */
23891     Size_t non_pkg_begin = 0;   /* Offset of first byte in 'name' that isn't
23892                                    part of a package name */
23893     Size_t lun_non_pkg_begin = 0;   /* Similarly for 'lookup_name' */
23894     bool could_be_user_defined = TRUE;  /* ? Could this be a user-defined
23895                                              property rather than a Unicode
23896                                              one. */
23897     SV * prop_definition = NULL;  /* The returned definition of 'name' or NULL
23898                                      if an error.  If it is an inversion list,
23899                                      it is the definition.  Otherwise it is a
23900                                      string containing the fully qualified sub
23901                                      name of 'name' */
23902     SV * fq_name = NULL;        /* For user-defined properties, the fully
23903                                    qualified name */
23904     bool invert_return = FALSE; /* ? Do we need to complement the result before
23905                                      returning it */
23906     bool stripped_utf8_pkg = FALSE; /* Set TRUE if the input includes an
23907                                        explicit utf8:: package that we strip
23908                                        off  */
23909     /* The expansion of properties that could be either user-defined or
23910      * official unicode ones is deferred until runtime, including a marker for
23911      * those that might be in the latter category.  This boolean indicates if
23912      * we've seen that marker.  If not, what we're parsing can't be such an
23913      * official Unicode property whose expansion was deferred */
23914     bool could_be_deferred_official = FALSE;
23915
23916     PERL_ARGS_ASSERT_PARSE_UNIPROP_STRING;
23917
23918     /* The input will be normalized into 'lookup_name' */
23919     Newx(lookup_name, name_len, char);
23920     SAVEFREEPV(lookup_name);
23921
23922     /* Parse the input. */
23923     for (i = 0; i < name_len; i++) {
23924         char cur = name[i];
23925
23926         /* Most of the characters in the input will be of this ilk, being parts
23927          * of a name */
23928         if (isIDCONT_A(cur)) {
23929
23930             /* Case differences are ignored.  Our lookup routine assumes
23931              * everything is lowercase, so normalize to that */
23932             if (isUPPER_A(cur)) {
23933                 lookup_name[j++] = toLOWER_A(cur);
23934                 continue;
23935             }
23936
23937             if (cur == '_') { /* Don't include these in the normalized name */
23938                 continue;
23939             }
23940
23941             lookup_name[j++] = cur;
23942
23943             /* The first character in a user-defined name must be of this type.
23944              * */
23945             if (i - non_pkg_begin == 0 && ! isIDFIRST_A(cur)) {
23946                 could_be_user_defined = FALSE;
23947             }
23948
23949             continue;
23950         }
23951
23952         /* Here, the character is not something typically in a name,  But these
23953          * two types of characters (and the '_' above) can be freely ignored in
23954          * most situations.  Later it may turn out we shouldn't have ignored
23955          * them, and we have to reparse, but we don't have enough information
23956          * yet to make that decision */
23957         if (cur == '-' || isSPACE_A(cur)) {
23958             could_be_user_defined = FALSE;
23959             continue;
23960         }
23961
23962         /* An equals sign or single colon mark the end of the first part of
23963          * the property name */
23964         if (    cur == '='
23965             || (cur == ':' && (i >= name_len - 1 || name[i+1] != ':')))
23966         {
23967             lookup_name[j++] = '='; /* Treat the colon as an '=' */
23968             equals_pos = j; /* Note where it occurred in the input */
23969             could_be_user_defined = FALSE;
23970             break;
23971         }
23972
23973         /* If this looks like it is a marker we inserted at compile time,
23974          * set a flag and otherwise ignore it.  If it isn't in the final
23975          * position, keep it as it would have been user input. */
23976         if (     UNLIKELY(cur == DEFERRED_COULD_BE_OFFICIAL_MARKERc)
23977             && ! deferrable
23978             &&   could_be_user_defined
23979             &&   i == name_len - 1)
23980         {
23981             name_len--;
23982             could_be_deferred_official = TRUE;
23983             continue;
23984         }
23985
23986         /* Otherwise, this character is part of the name. */
23987         lookup_name[j++] = cur;
23988
23989         /* Here it isn't a single colon, so if it is a colon, it must be a
23990          * double colon */
23991         if (cur == ':') {
23992
23993             /* A double colon should be a package qualifier.  We note its
23994              * position and continue.  Note that one could have
23995              *      pkg1::pkg2::...::foo
23996              * so that the position at the end of the loop will be just after
23997              * the final qualifier */
23998
23999             i++;
24000             non_pkg_begin = i + 1;
24001             lookup_name[j++] = ':';
24002             lun_non_pkg_begin = j;
24003         }
24004         else { /* Only word chars (and '::') can be in a user-defined name */
24005             could_be_user_defined = FALSE;
24006         }
24007     } /* End of parsing through the lhs of the property name (or all of it if
24008          no rhs) */
24009
24010 #  define STRLENs(s)  (sizeof("" s "") - 1)
24011
24012     /* If there is a single package name 'utf8::', it is ambiguous.  It could
24013      * be for a user-defined property, or it could be a Unicode property, as
24014      * all of them are considered to be for that package.  For the purposes of
24015      * parsing the rest of the property, strip it off */
24016     if (non_pkg_begin == STRLENs("utf8::") && memBEGINPs(name, name_len, "utf8::")) {
24017         lookup_name +=  STRLENs("utf8::");
24018         j -=  STRLENs("utf8::");
24019         equals_pos -=  STRLENs("utf8::");
24020         stripped_utf8_pkg = TRUE;
24021     }
24022
24023     /* Here, we are either done with the whole property name, if it was simple;
24024      * or are positioned just after the '=' if it is compound. */
24025
24026     if (equals_pos >= 0) {
24027         assert(stricter == Not_Strict); /* We shouldn't have set this yet */
24028
24029         /* Space immediately after the '=' is ignored */
24030         i++;
24031         for (; i < name_len; i++) {
24032             if (! isSPACE_A(name[i])) {
24033                 break;
24034             }
24035         }
24036
24037         /* Most punctuation after the equals indicates a subpattern, like
24038          * \p{foo=/bar/} */
24039         if (   isPUNCT_A(name[i])
24040             &&  name[i] != '-'
24041             &&  name[i] != '+'
24042             &&  name[i] != '_'
24043             &&  name[i] != '{'
24044                 /* A backslash means the real delimitter is the next character,
24045                  * but it must be punctuation */
24046             && (name[i] != '\\' || (i < name_len && isPUNCT_A(name[i+1]))))
24047         {
24048             bool special_property = memEQs(lookup_name, j - 1, "name")
24049                                  || memEQs(lookup_name, j - 1, "na");
24050             if (! special_property) {
24051                 /* Find the property.  The table includes the equals sign, so
24052                  * we use 'j' as-is */
24053                 table_index = do_uniprop_match(lookup_name, j);
24054             }
24055             if (special_property || table_index) {
24056                 REGEXP * subpattern_re;
24057                 char open = name[i++];
24058                 char close;
24059                 const char * pos_in_brackets;
24060                 const char * const * prop_values;
24061                 bool escaped = 0;
24062
24063                 /* Backslash => delimitter is the character following.  We
24064                  * already checked that it is punctuation */
24065                 if (open == '\\') {
24066                     open = name[i++];
24067                     escaped = 1;
24068                 }
24069
24070                 /* This data structure is constructed so that the matching
24071                  * closing bracket is 3 past its matching opening.  The second
24072                  * set of closing is so that if the opening is something like
24073                  * ']', the closing will be that as well.  Something similar is
24074                  * done in toke.c */
24075                 pos_in_brackets = memCHRs("([<)]>)]>", open);
24076                 close = (pos_in_brackets) ? pos_in_brackets[3] : open;
24077
24078                 if (    i >= name_len
24079                     ||  name[name_len-1] != close
24080                     || (escaped && name[name_len-2] != '\\')
24081                         /* Also make sure that there are enough characters.
24082                          * e.g., '\\\' would show up incorrectly as legal even
24083                          * though it is too short */
24084                     || (SSize_t) (name_len - i - 1 - escaped) < 0)
24085                 {
24086                     sv_catpvs(msg, "Unicode property wildcard not terminated");
24087                     goto append_name_to_msg;
24088                 }
24089
24090                 Perl_ck_warner_d(aTHX_
24091                     packWARN(WARN_EXPERIMENTAL__UNIPROP_WILDCARDS),
24092                     "The Unicode property wildcards feature is experimental");
24093
24094                 if (special_property) {
24095                     const char * error_msg;
24096                     const char * revised_name = name + i;
24097                     Size_t revised_name_len = name_len - (i + 1 + escaped);
24098
24099                     /* Currently, the only 'special_property' is name, which we
24100                      * lookup in _charnames.pm */
24101
24102                     if (! load_charnames(newSVpvs("placeholder"),
24103                                          revised_name, revised_name_len,
24104                                          &error_msg))
24105                     {
24106                         sv_catpv(msg, error_msg);
24107                         goto append_name_to_msg;
24108                     }
24109
24110                     /* Farm this out to a function just to make the current
24111                      * function less unwieldy */
24112                     if (handle_names_wildcard(revised_name, revised_name_len,
24113                                               &prop_definition,
24114                                               strings))
24115                     {
24116                         return prop_definition;
24117                     }
24118
24119                     goto failed;
24120                 }
24121
24122                 prop_values = get_prop_values(table_index);
24123
24124                 /* Now create and compile the wildcard subpattern.  Use /i
24125                  * because the property values are supposed to match with case
24126                  * ignored. */
24127                 subpattern_re = compile_wildcard(name + i,
24128                                                  name_len - i - 1 - escaped,
24129                                                  TRUE /* /i */
24130                                                 );
24131
24132                 /* For each legal property value, see if the supplied pattern
24133                  * matches it. */
24134                 while (*prop_values) {
24135                     const char * const entry = *prop_values;
24136                     const Size_t len = strlen(entry);
24137                     SV* entry_sv = newSVpvn_flags(entry, len, SVs_TEMP);
24138
24139                     if (execute_wildcard(subpattern_re,
24140                                  (char *) entry,
24141                                  (char *) entry + len,
24142                                  (char *) entry, 0,
24143                                  entry_sv,
24144                                  0))
24145                     { /* Here, matched.  Add to the returned list */
24146                         Size_t total_len = j + len;
24147                         SV * sub_invlist = NULL;
24148                         char * this_string;
24149
24150                         /* We know this is a legal \p{property=value}.  Call
24151                          * the function to return the list of code points that
24152                          * match it */
24153                         Newxz(this_string, total_len + 1, char);
24154                         Copy(lookup_name, this_string, j, char);
24155                         my_strlcat(this_string, entry, total_len + 1);
24156                         SAVEFREEPV(this_string);
24157                         sub_invlist = parse_uniprop_string(this_string,
24158                                                            total_len,
24159                                                            is_utf8,
24160                                                            to_fold,
24161                                                            runtime,
24162                                                            deferrable,
24163                                                            NULL,
24164                                                            user_defined_ptr,
24165                                                            msg,
24166                                                            level + 1);
24167                         _invlist_union(prop_definition, sub_invlist,
24168                                        &prop_definition);
24169                     }
24170
24171                     prop_values++;  /* Next iteration, look at next propvalue */
24172                 } /* End of looking through property values; (the data
24173                      structure is terminated by a NULL ptr) */
24174
24175                 SvREFCNT_dec_NN(subpattern_re);
24176
24177                 if (prop_definition) {
24178                     return prop_definition;
24179                 }
24180
24181                 sv_catpvs(msg, "No Unicode property value wildcard matches:");
24182                 goto append_name_to_msg;
24183             }
24184
24185             /* Here's how khw thinks we should proceed to handle the properties
24186              * not yet done:    Bidi Mirroring Glyph        can map to ""
24187                                 Bidi Paired Bracket         can map to ""
24188                                 Case Folding  (both full and simple)
24189                                             Shouldn't /i be good enough for Full
24190                                 Decomposition Mapping
24191                                 Equivalent Unified Ideograph    can map to ""
24192                                 Lowercase Mapping  (both full and simple)
24193                                 NFKC Case Fold                  can map to ""
24194                                 Titlecase Mapping  (both full and simple)
24195                                 Uppercase Mapping  (both full and simple)
24196              * Handle these the same way Name is done, using say, _wild.pm, but
24197              * having both loose and full, like in charclass_invlists.h.
24198              * Perhaps move block and script to that as they are somewhat large
24199              * in charclass_invlists.h.
24200              * For properties where the default is the code point itself, such
24201              * as any of the case changing mappings, the string would otherwise
24202              * consist of all Unicode code points in UTF-8 strung together.
24203              * This would be impractical.  So instead, examine their compiled
24204              * pattern, looking at the ssc.  If none, reject the pattern as an
24205              * error.  Otherwise run the pattern against every code point in
24206              * the ssc.  The ssc is kind of like tr18's 3.9 Possible Match Sets
24207              * And it might be good to create an API to return the ssc.
24208              * Or handle them like the algorithmic names are done
24209              */
24210         } /* End of is a wildcard subppattern */
24211
24212         /* \p{name=...} is handled specially.  Instead of using the normal
24213          * mechanism involving charclass_invlists.h, it uses _charnames.pm
24214          * which has the necessary (huge) data accessible to it, and which
24215          * doesn't get loaded unless necessary.  The legal syntax for names is
24216          * somewhat different than other properties due both to the vagaries of
24217          * a few outlier official names, and the fact that only a few ASCII
24218          * characters are permitted in them */
24219         if (   memEQs(lookup_name, j - 1, "name")
24220             || memEQs(lookup_name, j - 1, "na"))
24221         {
24222             dSP;
24223             HV * table;
24224             SV * character;
24225             const char * error_msg;
24226             CV* lookup_loose;
24227             SV * character_name;
24228             STRLEN character_len;
24229             UV cp;
24230
24231             stricter = As_Is;
24232
24233             /* Since the RHS (after skipping initial space) is passed unchanged
24234              * to charnames, and there are different criteria for what are
24235              * legal characters in the name, just parse it here.  A character
24236              * name must begin with an ASCII alphabetic */
24237             if (! isALPHA(name[i])) {
24238                 goto failed;
24239             }
24240             lookup_name[j++] = name[i];
24241
24242             for (++i; i < name_len; i++) {
24243                 /* Official names can only be in the ASCII range, and only
24244                  * certain characters */
24245                 if (! isASCII(name[i]) || ! isCHARNAME_CONT(name[i])) {
24246                     goto failed;
24247                 }
24248                 lookup_name[j++] = name[i];
24249             }
24250
24251             /* Finished parsing, save the name into an SV */
24252             character_name = newSVpvn(lookup_name + equals_pos, j - equals_pos);
24253
24254             /* Make sure _charnames is loaded.  (The parameters give context
24255              * for any errors generated */
24256             table = load_charnames(character_name, name, name_len, &error_msg);
24257             if (table == NULL) {
24258                 sv_catpv(msg, error_msg);
24259                 goto append_name_to_msg;
24260             }
24261
24262             lookup_loose = get_cvs("_charnames::_loose_regcomp_lookup", 0);
24263             if (! lookup_loose) {
24264                 Perl_croak(aTHX_
24265                        "panic: Can't find '_charnames::_loose_regcomp_lookup");
24266             }
24267
24268             PUSHSTACKi(PERLSI_REGCOMP);
24269             ENTER ;
24270             SAVETMPS;
24271             save_re_context();
24272
24273             PUSHMARK(SP) ;
24274             XPUSHs(character_name);
24275             PUTBACK;
24276             call_sv(MUTABLE_SV(lookup_loose), G_SCALAR);
24277
24278             SPAGAIN ;
24279
24280             character = POPs;
24281             SvREFCNT_inc_simple_void_NN(character);
24282
24283             PUTBACK ;
24284             FREETMPS ;
24285             LEAVE ;
24286             POPSTACK;
24287
24288             if (! SvOK(character)) {
24289                 goto failed;
24290             }
24291
24292             cp = valid_utf8_to_uvchr((U8 *) SvPVX(character), &character_len);
24293             if (character_len == SvCUR(character)) {
24294                 prop_definition = add_cp_to_invlist(NULL, cp);
24295             }
24296             else {
24297                 AV * this_string;
24298
24299                 /* First of the remaining characters in the string. */
24300                 char * remaining = SvPVX(character) + character_len;
24301
24302                 if (strings == NULL) {
24303                     goto failed;    /* XXX Perhaps a specific msg instead, like
24304                                        'not available here' */
24305                 }
24306
24307                 if (*strings == NULL) {
24308                     *strings = newAV();
24309                 }
24310
24311                 this_string = newAV();
24312                 av_push(this_string, newSVuv(cp));
24313
24314                 do {
24315                     cp = valid_utf8_to_uvchr((U8 *) remaining, &character_len);
24316                     av_push(this_string, newSVuv(cp));
24317                     remaining += character_len;
24318                 } while (remaining < SvEND(character));
24319
24320                 av_push(*strings, (SV *) this_string);
24321             }
24322
24323             return prop_definition;
24324         }
24325
24326         /* Certain properties whose values are numeric need special handling.
24327          * They may optionally be prefixed by 'is'.  Ignore that prefix for the
24328          * purposes of checking if this is one of those properties */
24329         if (memBEGINPs(lookup_name, j, "is")) {
24330             lookup_offset = 2;
24331         }
24332
24333         /* Then check if it is one of these specially-handled properties.  The
24334          * possibilities are hard-coded because easier this way, and the list
24335          * is unlikely to change.
24336          *
24337          * All numeric value type properties are of this ilk, and are also
24338          * special in a different way later on.  So find those first.  There
24339          * are several numeric value type properties in the Unihan DB (which is
24340          * unlikely to be compiled with perl, but we handle it here in case it
24341          * does get compiled).  They all end with 'numeric'.  The interiors
24342          * aren't checked for the precise property.  This would stop working if
24343          * a cjk property were to be created that ended with 'numeric' and
24344          * wasn't a numeric type */
24345         is_nv_type = memEQs(lookup_name + lookup_offset,
24346                        j - 1 - lookup_offset, "numericvalue")
24347                   || memEQs(lookup_name + lookup_offset,
24348                       j - 1 - lookup_offset, "nv")
24349                   || (   memENDPs(lookup_name + lookup_offset,
24350                             j - 1 - lookup_offset, "numeric")
24351                       && (   memBEGINPs(lookup_name + lookup_offset,
24352                                       j - 1 - lookup_offset, "cjk")
24353                           || memBEGINPs(lookup_name + lookup_offset,
24354                                       j - 1 - lookup_offset, "k")));
24355         if (   is_nv_type
24356             || memEQs(lookup_name + lookup_offset,
24357                       j - 1 - lookup_offset, "canonicalcombiningclass")
24358             || memEQs(lookup_name + lookup_offset,
24359                       j - 1 - lookup_offset, "ccc")
24360             || memEQs(lookup_name + lookup_offset,
24361                       j - 1 - lookup_offset, "age")
24362             || memEQs(lookup_name + lookup_offset,
24363                       j - 1 - lookup_offset, "in")
24364             || memEQs(lookup_name + lookup_offset,
24365                       j - 1 - lookup_offset, "presentin"))
24366         {
24367             unsigned int k;
24368
24369             /* Since the stuff after the '=' is a number, we can't throw away
24370              * '-' willy-nilly, as those could be a minus sign.  Other stricter
24371              * rules also apply.  However, these properties all can have the
24372              * rhs not be a number, in which case they contain at least one
24373              * alphabetic.  In those cases, the stricter rules don't apply.
24374              * But the numeric type properties can have the alphas [Ee] to
24375              * signify an exponent, and it is still a number with stricter
24376              * rules.  So look for an alpha that signifies not-strict */
24377             stricter = Strict;
24378             for (k = i; k < name_len; k++) {
24379                 if (   isALPHA_A(name[k])
24380                     && (! is_nv_type || ! isALPHA_FOLD_EQ(name[k], 'E')))
24381                 {
24382                     stricter = Not_Strict;
24383                     break;
24384                 }
24385             }
24386         }
24387
24388         if (stricter) {
24389
24390             /* A number may have a leading '+' or '-'.  The latter is retained
24391              * */
24392             if (name[i] == '+') {
24393                 i++;
24394             }
24395             else if (name[i] == '-') {
24396                 lookup_name[j++] = '-';
24397                 i++;
24398             }
24399
24400             /* Skip leading zeros including single underscores separating the
24401              * zeros, or between the final leading zero and the first other
24402              * digit */
24403             for (; i < name_len - 1; i++) {
24404                 if (    name[i] != '0'
24405                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
24406                 {
24407                     break;
24408                 }
24409             }
24410         }
24411     }
24412     else {  /* No '=' */
24413
24414        /* Only a few properties without an '=' should be parsed with stricter
24415         * rules.  The list is unlikely to change. */
24416         if (   memBEGINPs(lookup_name, j, "perl")
24417             && memNEs(lookup_name + 4, j - 4, "space")
24418             && memNEs(lookup_name + 4, j - 4, "word"))
24419         {
24420             stricter = Strict;
24421
24422             /* We set the inputs back to 0 and the code below will reparse,
24423              * using strict */
24424             i = j = 0;
24425         }
24426     }
24427
24428     /* Here, we have either finished the property, or are positioned to parse
24429      * the remainder, and we know if stricter rules apply.  Finish out, if not
24430      * already done */
24431     for (; i < name_len; i++) {
24432         char cur = name[i];
24433
24434         /* In all instances, case differences are ignored, and we normalize to
24435          * lowercase */
24436         if (isUPPER_A(cur)) {
24437             lookup_name[j++] = toLOWER(cur);
24438             continue;
24439         }
24440
24441         /* An underscore is skipped, but not under strict rules unless it
24442          * separates two digits */
24443         if (cur == '_') {
24444             if (    stricter
24445                 && (     i == 0 || (int) i == equals_pos || i == name_len- 1
24446                     || ! isDIGIT_A(name[i-1]) || ! isDIGIT_A(name[i+1])))
24447             {
24448                 lookup_name[j++] = '_';
24449             }
24450             continue;
24451         }
24452
24453         /* Hyphens are skipped except under strict */
24454         if (cur == '-' && ! stricter) {
24455             continue;
24456         }
24457
24458         /* XXX Bug in documentation.  It says white space skipped adjacent to
24459          * non-word char.  Maybe we should, but shouldn't skip it next to a dot
24460          * in a number */
24461         if (isSPACE_A(cur) && ! stricter) {
24462             continue;
24463         }
24464
24465         lookup_name[j++] = cur;
24466
24467         /* Unless this is a non-trailing slash, we are done with it */
24468         if (i >= name_len - 1 || cur != '/') {
24469             continue;
24470         }
24471
24472         slash_pos = j;
24473
24474         /* A slash in the 'numeric value' property indicates that what follows
24475          * is a denominator.  It can have a leading '+' and '0's that should be
24476          * skipped.  But we have never allowed a negative denominator, so treat
24477          * a minus like every other character.  (No need to rule out a second
24478          * '/', as that won't match anything anyway */
24479         if (is_nv_type) {
24480             i++;
24481             if (i < name_len && name[i] == '+') {
24482                 i++;
24483             }
24484
24485             /* Skip leading zeros including underscores separating digits */
24486             for (; i < name_len - 1; i++) {
24487                 if (   name[i] != '0'
24488                     && (name[i] != '_' || ! isDIGIT_A(name[i+1])))
24489                 {
24490                     break;
24491                 }
24492             }
24493
24494             /* Store the first real character in the denominator */
24495             if (i < name_len) {
24496                 lookup_name[j++] = name[i];
24497             }
24498         }
24499     }
24500
24501     /* Here are completely done parsing the input 'name', and 'lookup_name'
24502      * contains a copy, normalized.
24503      *
24504      * This special case is grandfathered in: 'L_' and 'GC=L_' are accepted and
24505      * different from without the underscores.  */
24506     if (  (   UNLIKELY(memEQs(lookup_name, j, "l"))
24507            || UNLIKELY(memEQs(lookup_name, j, "gc=l")))
24508         && UNLIKELY(name[name_len-1] == '_'))
24509     {
24510         lookup_name[j++] = '&';
24511     }
24512
24513     /* If the original input began with 'In' or 'Is', it could be a subroutine
24514      * call to a user-defined property instead of a Unicode property name. */
24515     if (    name_len - non_pkg_begin > 2
24516         &&  name[non_pkg_begin+0] == 'I'
24517         && (name[non_pkg_begin+1] == 'n' || name[non_pkg_begin+1] == 's'))
24518     {
24519         /* Names that start with In have different characterstics than those
24520          * that start with Is */
24521         if (name[non_pkg_begin+1] == 's') {
24522             starts_with_Is = TRUE;
24523         }
24524     }
24525     else {
24526         could_be_user_defined = FALSE;
24527     }
24528
24529     if (could_be_user_defined) {
24530         CV* user_sub;
24531
24532         /* If the user defined property returns the empty string, it could
24533          * easily be because the pattern is being compiled before the data it
24534          * actually needs to compile is available.  This could be argued to be
24535          * a bug in the perl code, but this is a change of behavior for Perl,
24536          * so we handle it.  This means that intentionally returning nothing
24537          * will not be resolved until runtime */
24538         bool empty_return = FALSE;
24539
24540         /* Here, the name could be for a user defined property, which are
24541          * implemented as subs. */
24542         user_sub = get_cvn_flags(name, name_len, 0);
24543         if (! user_sub) {
24544
24545             /* Here, the property name could be a user-defined one, but there
24546              * is no subroutine to handle it (as of now).   Defer handling it
24547              * until runtime.  Otherwise, a block defined by Unicode in a later
24548              * release would get the synonym InFoo added for it, and existing
24549              * code that used that name would suddenly break if it referred to
24550              * the property before the sub was declared.  See [perl #134146] */
24551             if (deferrable) {
24552                 goto definition_deferred;
24553             }
24554
24555             /* Here, we are at runtime, and didn't find the user property.  It
24556              * could be an official property, but only if no package was
24557              * specified, or just the utf8:: package. */
24558             if (could_be_deferred_official) {
24559                 lookup_name += lun_non_pkg_begin;
24560                 j -= lun_non_pkg_begin;
24561             }
24562             else if (! stripped_utf8_pkg) {
24563                 goto unknown_user_defined;
24564             }
24565
24566             /* Drop down to look up in the official properties */
24567         }
24568         else {
24569             const char insecure[] = "Insecure user-defined property";
24570
24571             /* Here, there is a sub by the correct name.  Normally we call it
24572              * to get the property definition */
24573             dSP;
24574             SV * user_sub_sv = MUTABLE_SV(user_sub);
24575             SV * error;     /* Any error returned by calling 'user_sub' */
24576             SV * key;       /* The key into the hash of user defined sub names
24577                              */
24578             SV * placeholder;
24579             SV ** saved_user_prop_ptr;      /* Hash entry for this property */
24580
24581             /* How many times to retry when another thread is in the middle of
24582              * expanding the same definition we want */
24583             PERL_INT_FAST8_T retry_countdown = 10;
24584
24585             DECLARATION_FOR_GLOBAL_CONTEXT;
24586
24587             /* If we get here, we know this property is user-defined */
24588             *user_defined_ptr = TRUE;
24589
24590             /* We refuse to call a potentially tainted subroutine; returning an
24591              * error instead */
24592             if (TAINT_get) {
24593                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
24594                 sv_catpvn(msg, insecure, sizeof(insecure) - 1);
24595                 goto append_name_to_msg;
24596             }
24597
24598             /* In principal, we only call each subroutine property definition
24599              * once during the life of the program.  This guarantees that the
24600              * property definition never changes.  The results of the single
24601              * sub call are stored in a hash, which is used instead for future
24602              * references to this property.  The property definition is thus
24603              * immutable.  But, to allow the user to have a /i-dependent
24604              * definition, we call the sub once for non-/i, and once for /i,
24605              * should the need arise, passing the /i status as a parameter.
24606              *
24607              * We start by constructing the hash key name, consisting of the
24608              * fully qualified subroutine name, preceded by the /i status, so
24609              * that there is a key for /i and a different key for non-/i */
24610             key = newSVpvn(((to_fold) ? "1" : "0"), 1);
24611             fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
24612                                           non_pkg_begin != 0);
24613             sv_catsv(key, fq_name);
24614             sv_2mortal(key);
24615
24616             /* We only call the sub once throughout the life of the program
24617              * (with the /i, non-/i exception noted above).  That means the
24618              * hash must be global and accessible to all threads.  It is
24619              * created at program start-up, before any threads are created, so
24620              * is accessible to all children.  But this creates some
24621              * complications.
24622              *
24623              * 1) The keys can't be shared, or else problems arise; sharing is
24624              *    turned off at hash creation time
24625              * 2) All SVs in it are there for the remainder of the life of the
24626              *    program, and must be created in the same interpreter context
24627              *    as the hash, or else they will be freed from the wrong pool
24628              *    at global destruction time.  This is handled by switching to
24629              *    the hash's context to create each SV going into it, and then
24630              *    immediately switching back
24631              * 3) All accesses to the hash must be controlled by a mutex, to
24632              *    prevent two threads from getting an unstable state should
24633              *    they simultaneously be accessing it.  The code below is
24634              *    crafted so that the mutex is locked whenever there is an
24635              *    access and unlocked only when the next stable state is
24636              *    achieved.
24637              *
24638              * The hash stores either the definition of the property if it was
24639              * valid, or, if invalid, the error message that was raised.  We
24640              * use the type of SV to distinguish.
24641              *
24642              * There's also the need to guard against the definition expansion
24643              * from infinitely recursing.  This is handled by storing the aTHX
24644              * of the expanding thread during the expansion.  Again the SV type
24645              * is used to distinguish this from the other two cases.  If we
24646              * come to here and the hash entry for this property is our aTHX,
24647              * it means we have recursed, and the code assumes that we would
24648              * infinitely recurse, so instead stops and raises an error.
24649              * (Any recursion has always been treated as infinite recursion in
24650              * this feature.)
24651              *
24652              * If instead, the entry is for a different aTHX, it means that
24653              * that thread has gotten here first, and hasn't finished expanding
24654              * the definition yet.  We just have to wait until it is done.  We
24655              * sleep and retry a few times, returning an error if the other
24656              * thread doesn't complete. */
24657
24658           re_fetch:
24659             USER_PROP_MUTEX_LOCK;
24660
24661             /* If we have an entry for this key, the subroutine has already
24662              * been called once with this /i status. */
24663             saved_user_prop_ptr = hv_fetch(PL_user_def_props,
24664                                                    SvPVX(key), SvCUR(key), 0);
24665             if (saved_user_prop_ptr) {
24666
24667                 /* If the saved result is an inversion list, it is the valid
24668                  * definition of this property */
24669                 if (is_invlist(*saved_user_prop_ptr)) {
24670                     prop_definition = *saved_user_prop_ptr;
24671
24672                     /* The SV in the hash won't be removed until global
24673                      * destruction, so it is stable and we can unlock */
24674                     USER_PROP_MUTEX_UNLOCK;
24675
24676                     /* The caller shouldn't try to free this SV */
24677                     return prop_definition;
24678                 }
24679
24680                 /* Otherwise, if it is a string, it is the error message
24681                  * that was returned when we first tried to evaluate this
24682                  * property.  Fail, and append the message */
24683                 if (SvPOK(*saved_user_prop_ptr)) {
24684                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
24685                     sv_catsv(msg, *saved_user_prop_ptr);
24686
24687                     /* The SV in the hash won't be removed until global
24688                      * destruction, so it is stable and we can unlock */
24689                     USER_PROP_MUTEX_UNLOCK;
24690
24691                     return NULL;
24692                 }
24693
24694                 assert(SvIOK(*saved_user_prop_ptr));
24695
24696                 /* Here, we have an unstable entry in the hash.  Either another
24697                  * thread is in the middle of expanding the property's
24698                  * definition, or we are ourselves recursing.  We use the aTHX
24699                  * in it to distinguish */
24700                 if (SvIV(*saved_user_prop_ptr) != PTR2IV(CUR_CONTEXT)) {
24701
24702                     /* Here, it's another thread doing the expanding.  We've
24703                      * looked as much as we are going to at the contents of the
24704                      * hash entry.  It's safe to unlock. */
24705                     USER_PROP_MUTEX_UNLOCK;
24706
24707                     /* Retry a few times */
24708                     if (retry_countdown-- > 0) {
24709                         PerlProc_sleep(1);
24710                         goto re_fetch;
24711                     }
24712
24713                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
24714                     sv_catpvs(msg, "Timeout waiting for another thread to "
24715                                    "define");
24716                     goto append_name_to_msg;
24717                 }
24718
24719                 /* Here, we are recursing; don't dig any deeper */
24720                 USER_PROP_MUTEX_UNLOCK;
24721
24722                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
24723                 sv_catpvs(msg,
24724                           "Infinite recursion in user-defined property");
24725                 goto append_name_to_msg;
24726             }
24727
24728             /* Here, this thread has exclusive control, and there is no entry
24729              * for this property in the hash.  So we have the go ahead to
24730              * expand the definition ourselves. */
24731
24732             PUSHSTACKi(PERLSI_REGCOMP);
24733             ENTER;
24734
24735             /* Create a temporary placeholder in the hash to detect recursion
24736              * */
24737             SWITCH_TO_GLOBAL_CONTEXT;
24738             placeholder= newSVuv(PTR2IV(ORIGINAL_CONTEXT));
24739             (void) hv_store_ent(PL_user_def_props, key, placeholder, 0);
24740             RESTORE_CONTEXT;
24741
24742             /* Now that we have a placeholder, we can let other threads
24743              * continue */
24744             USER_PROP_MUTEX_UNLOCK;
24745
24746             /* Make sure the placeholder always gets destroyed */
24747             SAVEDESTRUCTOR_X(S_delete_recursion_entry, SvPVX(key));
24748
24749             PUSHMARK(SP);
24750             SAVETMPS;
24751
24752             /* Call the user's function, with the /i status as a parameter.
24753              * Note that we have gone to a lot of trouble to keep this call
24754              * from being within the locked mutex region. */
24755             XPUSHs(boolSV(to_fold));
24756             PUTBACK;
24757
24758             /* The following block was taken from swash_init().  Presumably
24759              * they apply to here as well, though we no longer use a swash --
24760              * khw */
24761             SAVEHINTS();
24762             save_re_context();
24763             /* We might get here via a subroutine signature which uses a utf8
24764              * parameter name, at which point PL_subname will have been set
24765              * but not yet used. */
24766             save_item(PL_subname);
24767
24768             /* G_SCALAR guarantees a single return value */
24769             (void) call_sv(user_sub_sv, G_EVAL|G_SCALAR);
24770
24771             SPAGAIN;
24772
24773             error = ERRSV;
24774             if (TAINT_get || SvTRUE(error)) {
24775                 if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
24776                 if (SvTRUE(error)) {
24777                     sv_catpvs(msg, "Error \"");
24778                     sv_catsv(msg, error);
24779                     sv_catpvs(msg, "\"");
24780                 }
24781                 if (TAINT_get) {
24782                     if (SvTRUE(error)) sv_catpvs(msg, "; ");
24783                     sv_catpvn(msg, insecure, sizeof(insecure) - 1);
24784                 }
24785
24786                 if (name_len > 0) {
24787                     sv_catpvs(msg, " in expansion of ");
24788                     Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8,
24789                                                                   name_len,
24790                                                                   name));
24791                 }
24792
24793                 (void) POPs;
24794                 prop_definition = NULL;
24795             }
24796             else {
24797                 SV * contents = POPs;
24798
24799                 /* The contents is supposed to be the expansion of the property
24800                  * definition.  If the definition is deferrable, and we got an
24801                  * empty string back, set a flag to later defer it (after clean
24802                  * up below). */
24803                 if (      deferrable
24804                     && (! SvPOK(contents) || SvCUR(contents) == 0))
24805                 {
24806                         empty_return = TRUE;
24807                 }
24808                 else { /* Otherwise, call a function to check for valid syntax,
24809                           and handle it */
24810
24811                     prop_definition = handle_user_defined_property(
24812                                                     name, name_len,
24813                                                     is_utf8, to_fold, runtime,
24814                                                     deferrable,
24815                                                     contents, user_defined_ptr,
24816                                                     msg,
24817                                                     level);
24818                 }
24819             }
24820
24821             /* Here, we have the results of the expansion.  Delete the
24822              * placeholder, and if the definition is now known, replace it with
24823              * that definition.  We need exclusive access to the hash, and we
24824              * can't let anyone else in, between when we delete the placeholder
24825              * and add the permanent entry */
24826             USER_PROP_MUTEX_LOCK;
24827
24828             S_delete_recursion_entry(aTHX_ SvPVX(key));
24829
24830             if (    ! empty_return
24831                 && (! prop_definition || is_invlist(prop_definition)))
24832             {
24833                 /* If we got success we use the inversion list defining the
24834                  * property; otherwise use the error message */
24835                 SWITCH_TO_GLOBAL_CONTEXT;
24836                 (void) hv_store_ent(PL_user_def_props,
24837                                     key,
24838                                     ((prop_definition)
24839                                      ? newSVsv(prop_definition)
24840                                      : newSVsv(msg)),
24841                                     0);
24842                 RESTORE_CONTEXT;
24843             }
24844
24845             /* All done, and the hash now has a permanent entry for this
24846              * property.  Give up exclusive control */
24847             USER_PROP_MUTEX_UNLOCK;
24848
24849             FREETMPS;
24850             LEAVE;
24851             POPSTACK;
24852
24853             if (empty_return) {
24854                 goto definition_deferred;
24855             }
24856
24857             if (prop_definition) {
24858
24859                 /* If the definition is for something not known at this time,
24860                  * we toss it, and go return the main property name, as that's
24861                  * the one the user will be aware of */
24862                 if (! is_invlist(prop_definition)) {
24863                     SvREFCNT_dec_NN(prop_definition);
24864                     goto definition_deferred;
24865                 }
24866
24867                 sv_2mortal(prop_definition);
24868             }
24869
24870             /* And return */
24871             return prop_definition;
24872
24873         }   /* End of calling the subroutine for the user-defined property */
24874     }       /* End of it could be a user-defined property */
24875
24876     /* Here it wasn't a user-defined property that is known at this time.  See
24877      * if it is a Unicode property */
24878
24879     lookup_len = j;     /* This is a more mnemonic name than 'j' */
24880
24881     /* Get the index into our pointer table of the inversion list corresponding
24882      * to the property */
24883     table_index = do_uniprop_match(lookup_name, lookup_len);
24884
24885     /* If it didn't find the property ... */
24886     if (table_index == 0) {
24887
24888         /* Try again stripping off any initial 'Is'.  This is because we
24889          * promise that an initial Is is optional.  The same isn't true of
24890          * names that start with 'In'.  Those can match only blocks, and the
24891          * lookup table already has those accounted for.  The lookup table also
24892          * has already accounted for Perl extensions (without and = sign)
24893          * starting with 'i's'. */
24894         if (starts_with_Is && equals_pos >= 0) {
24895             lookup_name += 2;
24896             lookup_len -= 2;
24897             equals_pos -= 2;
24898             slash_pos -= 2;
24899
24900             table_index = do_uniprop_match(lookup_name, lookup_len);
24901         }
24902
24903         if (table_index == 0) {
24904             char * canonical;
24905
24906             /* Here, we didn't find it.  If not a numeric type property, and
24907              * can't be a user-defined one, it isn't a legal property */
24908             if (! is_nv_type) {
24909                 if (! could_be_user_defined) {
24910                     goto failed;
24911                 }
24912
24913                 /* Here, the property name is legal as a user-defined one.   At
24914                  * compile time, it might just be that the subroutine for that
24915                  * property hasn't been encountered yet, but at runtime, it's
24916                  * an error to try to use an undefined one */
24917                 if (! deferrable) {
24918                     goto unknown_user_defined;;
24919                 }
24920
24921                 goto definition_deferred;
24922             } /* End of isn't a numeric type property */
24923
24924             /* The numeric type properties need more work to decide.  What we
24925              * do is make sure we have the number in canonical form and look
24926              * that up. */
24927
24928             if (slash_pos < 0) {    /* No slash */
24929
24930                 /* When it isn't a rational, take the input, convert it to a
24931                  * NV, then create a canonical string representation of that
24932                  * NV. */
24933
24934                 NV value;
24935                 SSize_t value_len = lookup_len - equals_pos;
24936
24937                 /* Get the value */
24938                 if (   value_len <= 0
24939                     || my_atof3(lookup_name + equals_pos, &value,
24940                                 value_len)
24941                           != lookup_name + lookup_len)
24942                 {
24943                     goto failed;
24944                 }
24945
24946                 /* If the value is an integer, the canonical value is integral
24947                  * */
24948                 if (Perl_ceil(value) == value) {
24949                     canonical = Perl_form(aTHX_ "%.*s%.0" NVff,
24950                                             equals_pos, lookup_name, value);
24951                 }
24952                 else {  /* Otherwise, it is %e with a known precision */
24953                     char * exp_ptr;
24954
24955                     canonical = Perl_form(aTHX_ "%.*s%.*" NVef,
24956                                                 equals_pos, lookup_name,
24957                                                 PL_E_FORMAT_PRECISION, value);
24958
24959                     /* The exponent generated is expecting two digits, whereas
24960                      * %e on some systems will generate three.  Remove leading
24961                      * zeros in excess of 2 from the exponent.  We start
24962                      * looking for them after the '=' */
24963                     exp_ptr = strchr(canonical + equals_pos, 'e');
24964                     if (exp_ptr) {
24965                         char * cur_ptr = exp_ptr + 2; /* past the 'e[+-]' */
24966                         SSize_t excess_exponent_len = strlen(cur_ptr) - 2;
24967
24968                         assert(*(cur_ptr - 1) == '-' || *(cur_ptr - 1) == '+');
24969
24970                         if (excess_exponent_len > 0) {
24971                             SSize_t leading_zeros = strspn(cur_ptr, "0");
24972                             SSize_t excess_leading_zeros
24973                                     = MIN(leading_zeros, excess_exponent_len);
24974                             if (excess_leading_zeros > 0) {
24975                                 Move(cur_ptr + excess_leading_zeros,
24976                                      cur_ptr,
24977                                      strlen(cur_ptr) - excess_leading_zeros
24978                                        + 1,  /* Copy the NUL as well */
24979                                      char);
24980                             }
24981                         }
24982                     }
24983                 }
24984             }
24985             else {  /* Has a slash.  Create a rational in canonical form  */
24986                 UV numerator, denominator, gcd, trial;
24987                 const char * end_ptr;
24988                 const char * sign = "";
24989
24990                 /* We can't just find the numerator, denominator, and do the
24991                  * division, then use the method above, because that is
24992                  * inexact.  And the input could be a rational that is within
24993                  * epsilon (given our precision) of a valid rational, and would
24994                  * then incorrectly compare valid.
24995                  *
24996                  * We're only interested in the part after the '=' */
24997                 const char * this_lookup_name = lookup_name + equals_pos;
24998                 lookup_len -= equals_pos;
24999                 slash_pos -= equals_pos;
25000
25001                 /* Handle any leading minus */
25002                 if (this_lookup_name[0] == '-') {
25003                     sign = "-";
25004                     this_lookup_name++;
25005                     lookup_len--;
25006                     slash_pos--;
25007                 }
25008
25009                 /* Convert the numerator to numeric */
25010                 end_ptr = this_lookup_name + slash_pos;
25011                 if (! grok_atoUV(this_lookup_name, &numerator, &end_ptr)) {
25012                     goto failed;
25013                 }
25014
25015                 /* It better have included all characters before the slash */
25016                 if (*end_ptr != '/') {
25017                     goto failed;
25018                 }
25019
25020                 /* Set to look at just the denominator */
25021                 this_lookup_name += slash_pos;
25022                 lookup_len -= slash_pos;
25023                 end_ptr = this_lookup_name + lookup_len;
25024
25025                 /* Convert the denominator to numeric */
25026                 if (! grok_atoUV(this_lookup_name, &denominator, &end_ptr)) {
25027                     goto failed;
25028                 }
25029
25030                 /* It better be the rest of the characters, and don't divide by
25031                  * 0 */
25032                 if (   end_ptr != this_lookup_name + lookup_len
25033                     || denominator == 0)
25034                 {
25035                     goto failed;
25036                 }
25037
25038                 /* Get the greatest common denominator using
25039                    http://en.wikipedia.org/wiki/Euclidean_algorithm */
25040                 gcd = numerator;
25041                 trial = denominator;
25042                 while (trial != 0) {
25043                     UV temp = trial;
25044                     trial = gcd % trial;
25045                     gcd = temp;
25046                 }
25047
25048                 /* If already in lowest possible terms, we have already tried
25049                  * looking this up */
25050                 if (gcd == 1) {
25051                     goto failed;
25052                 }
25053
25054                 /* Reduce the rational, which should put it in canonical form
25055                  * */
25056                 numerator /= gcd;
25057                 denominator /= gcd;
25058
25059                 canonical = Perl_form(aTHX_ "%.*s%s%" UVuf "/%" UVuf,
25060                         equals_pos, lookup_name, sign, numerator, denominator);
25061             }
25062
25063             /* Here, we have the number in canonical form.  Try that */
25064             table_index = do_uniprop_match(canonical, strlen(canonical));
25065             if (table_index == 0) {
25066                 goto failed;
25067             }
25068         }   /* End of still didn't find the property in our table */
25069     }       /* End of       didn't find the property in our table */
25070
25071     /* Here, we have a non-zero return, which is an index into a table of ptrs.
25072      * A negative return signifies that the real index is the absolute value,
25073      * but the result needs to be inverted */
25074     if (table_index < 0) {
25075         invert_return = TRUE;
25076         table_index = -table_index;
25077     }
25078
25079     /* Out-of band indices indicate a deprecated property.  The proper index is
25080      * modulo it with the table size.  And dividing by the table size yields
25081      * an offset into a table constructed by regen/mk_invlists.pl to contain
25082      * the corresponding warning message */
25083     if (table_index > MAX_UNI_KEYWORD_INDEX) {
25084         Size_t warning_offset = table_index / MAX_UNI_KEYWORD_INDEX;
25085         table_index %= MAX_UNI_KEYWORD_INDEX;
25086         Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),
25087                 "Use of '%.*s' in \\p{} or \\P{} is deprecated because: %s",
25088                 (int) name_len, name,
25089                 get_deprecated_property_msg(warning_offset));
25090     }
25091
25092     /* In a few properties, a different property is used under /i.  These are
25093      * unlikely to change, so are hard-coded here. */
25094     if (to_fold) {
25095         if (   table_index == UNI_XPOSIXUPPER
25096             || table_index == UNI_XPOSIXLOWER
25097             || table_index == UNI_TITLE)
25098         {
25099             table_index = UNI_CASED;
25100         }
25101         else if (   table_index == UNI_UPPERCASELETTER
25102                  || table_index == UNI_LOWERCASELETTER
25103 #  ifdef UNI_TITLECASELETTER   /* Missing from early Unicodes */
25104                  || table_index == UNI_TITLECASELETTER
25105 #  endif
25106         ) {
25107             table_index = UNI_CASEDLETTER;
25108         }
25109         else if (  table_index == UNI_POSIXUPPER
25110                 || table_index == UNI_POSIXLOWER)
25111         {
25112             table_index = UNI_POSIXALPHA;
25113         }
25114     }
25115
25116     /* Create and return the inversion list */
25117     prop_definition = get_prop_definition(table_index);
25118     sv_2mortal(prop_definition);
25119
25120     /* See if there is a private use override to add to this definition */
25121     {
25122         COPHH * hinthash = (IN_PERL_COMPILETIME)
25123                            ? CopHINTHASH_get(&PL_compiling)
25124                            : CopHINTHASH_get(PL_curcop);
25125         SV * pu_overrides = cophh_fetch_pv(hinthash, "private_use", 0, 0);
25126
25127         if (UNLIKELY(pu_overrides && SvPOK(pu_overrides))) {
25128
25129             /* See if there is an element in the hints hash for this table */
25130             SV * pu_lookup = Perl_newSVpvf(aTHX_ "%d=", table_index);
25131             const char * pos = strstr(SvPVX(pu_overrides), SvPVX(pu_lookup));
25132
25133             if (pos) {
25134                 bool dummy;
25135                 SV * pu_definition;
25136                 SV * pu_invlist;
25137                 SV * expanded_prop_definition =
25138                             sv_2mortal(invlist_clone(prop_definition, NULL));
25139
25140                 /* If so, it's definition is the string from here to the next
25141                  * \a character.  And its format is the same as a user-defined
25142                  * property */
25143                 pos += SvCUR(pu_lookup);
25144                 pu_definition = newSVpvn(pos, strchr(pos, '\a') - pos);
25145                 pu_invlist = handle_user_defined_property(lookup_name,
25146                                                           lookup_len,
25147                                                           0, /* Not UTF-8 */
25148                                                           0, /* Not folded */
25149                                                           runtime,
25150                                                           deferrable,
25151                                                           pu_definition,
25152                                                           &dummy,
25153                                                           msg,
25154                                                           level);
25155                 if (TAINT_get) {
25156                     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
25157                     sv_catpvs(msg, "Insecure private-use override");
25158                     goto append_name_to_msg;
25159                 }
25160
25161                 /* For now, as a safety measure, make sure that it doesn't
25162                  * override non-private use code points */
25163                 _invlist_intersection(pu_invlist, PL_Private_Use, &pu_invlist);
25164
25165                 /* Add it to the list to be returned */
25166                 _invlist_union(prop_definition, pu_invlist,
25167                                &expanded_prop_definition);
25168                 prop_definition = expanded_prop_definition;
25169                 Perl_ck_warner_d(aTHX_ packWARN(WARN_EXPERIMENTAL__PRIVATE_USE), "The private_use feature is experimental");
25170             }
25171         }
25172     }
25173
25174     if (invert_return) {
25175         _invlist_invert(prop_definition);
25176     }
25177     return prop_definition;
25178
25179   unknown_user_defined:
25180     if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
25181     sv_catpvs(msg, "Unknown user-defined property name");
25182     goto append_name_to_msg;
25183
25184   failed:
25185     if (non_pkg_begin != 0) {
25186         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
25187         sv_catpvs(msg, "Illegal user-defined property name");
25188     }
25189     else {
25190         if (SvCUR(msg) > 0) sv_catpvs(msg, "; ");
25191         sv_catpvs(msg, "Can't find Unicode property definition");
25192     }
25193     /* FALLTHROUGH */
25194
25195   append_name_to_msg:
25196     {
25197         const char * prefix = (runtime && level == 0) ?  " \\p{" : " \"";
25198         const char * suffix = (runtime && level == 0) ?  "}" : "\"";
25199
25200         sv_catpv(msg, prefix);
25201         Perl_sv_catpvf(aTHX_ msg, "%" UTF8f, UTF8fARG(is_utf8, name_len, name));
25202         sv_catpv(msg, suffix);
25203     }
25204
25205     return NULL;
25206
25207   definition_deferred:
25208
25209     {
25210         bool is_qualified = non_pkg_begin != 0;  /* If has "::" */
25211
25212         /* Here it could yet to be defined, so defer evaluation of this until
25213          * its needed at runtime.  We need the fully qualified property name to
25214          * avoid ambiguity */
25215         if (! fq_name) {
25216             fq_name = S_get_fq_name(aTHX_ name, name_len, is_utf8,
25217                                                                 is_qualified);
25218         }
25219
25220         /* If it didn't come with a package, or the package is utf8::, this
25221          * actually could be an official Unicode property whose inclusion we
25222          * are deferring until runtime to make sure that it isn't overridden by
25223          * a user-defined property of the same name (which we haven't
25224          * encountered yet).  Add a marker to indicate this possibility, for
25225          * use at such time when we first need the definition during pattern
25226          * matching execution */
25227         if (! is_qualified || memBEGINPs(name, non_pkg_begin, "utf8::")) {
25228             sv_catpvs(fq_name, DEFERRED_COULD_BE_OFFICIAL_MARKERs);
25229         }
25230
25231         /* We also need a trailing newline */
25232         sv_catpvs(fq_name, "\n");
25233
25234         *user_defined_ptr = TRUE;
25235         return fq_name;
25236     }
25237 }
25238
25239 STATIC bool
25240 S_handle_names_wildcard(pTHX_ const char * wname, /* wildcard name to match */
25241                               const STRLEN wname_len, /* Its length */
25242                               SV ** prop_definition,
25243                               AV ** strings)
25244 {
25245     /* Deal with Name property wildcard subpatterns; returns TRUE if there were
25246      * any matches, adding them to prop_definition */
25247
25248     dSP;
25249
25250     CV * get_names_info;        /* entry to charnames.pm to get info we need */
25251     SV * names_string;          /* Contains all character names, except algo */
25252     SV * algorithmic_names;     /* Contains info about algorithmically
25253                                    generated character names */
25254     REGEXP * subpattern_re;     /* The user's pattern to match with */
25255     struct regexp * prog;       /* The compiled pattern */
25256     char * all_names_start;     /* lib/unicore/Name.pl string of every
25257                                    (non-algorithmic) character name */
25258     char * cur_pos;             /* We match, effectively using /gc; this is
25259                                    where we are now */
25260     bool found_matches = FALSE; /* Did any name match so far? */
25261     SV * empty;                 /* For matching zero length names */
25262     SV * must_sv;               /* Contains the substring, if any, that must be
25263                                    in a name for the subpattern to match */
25264     const char * must;          /* The PV of 'must' */
25265     STRLEN must_len;            /* And its length */
25266     SV * syllable_name = NULL;  /* For Hangul syllables */
25267     const char hangul_prefix[] = "HANGUL SYLLABLE ";
25268     const STRLEN hangul_prefix_len = sizeof(hangul_prefix) - 1;
25269
25270     /* By inspection, there are a maximum of 7 bytes in the suffix of a hangul
25271      * syllable name, and these are immutable and guaranteed by the Unicode
25272      * standard to never be extended */
25273     const STRLEN syl_max_len = hangul_prefix_len + 7;
25274
25275     IV i;
25276
25277     PERL_ARGS_ASSERT_HANDLE_NAMES_WILDCARD;
25278
25279     /* Make sure _charnames is loaded.  (The parameters give context
25280      * for any errors generated */
25281     get_names_info = get_cv("_charnames::_get_names_info", 0);
25282     if (! get_names_info) {
25283         Perl_croak(aTHX_ "panic: Can't find '_charnames::_get_names_info");
25284     }
25285
25286     /* Get the charnames data */
25287     PUSHSTACKi(PERLSI_REGCOMP);
25288     ENTER ;
25289     SAVETMPS;
25290     save_re_context();
25291
25292     PUSHMARK(SP) ;
25293     PUTBACK;
25294
25295     /* Special _charnames entry point that returns the info this routine
25296      * requires */
25297     call_sv(MUTABLE_SV(get_names_info), G_ARRAY);
25298
25299     SPAGAIN ;
25300
25301     /* Data structure for names which end in their very own code points */
25302     algorithmic_names = POPs;
25303     SvREFCNT_inc_simple_void_NN(algorithmic_names);
25304
25305     /* The lib/unicore/Name.pl string */
25306     names_string = POPs;
25307     SvREFCNT_inc_simple_void_NN(names_string);
25308
25309     PUTBACK ;
25310     FREETMPS ;
25311     LEAVE ;
25312     POPSTACK;
25313
25314     if (   ! SvROK(names_string)
25315         || ! SvROK(algorithmic_names))
25316     {   /* Perhaps should panic instead XXX */
25317         SvREFCNT_dec(names_string);
25318         SvREFCNT_dec(algorithmic_names);
25319         return FALSE;
25320     }
25321
25322     names_string = sv_2mortal(SvRV(names_string));
25323     all_names_start = SvPVX(names_string);
25324     cur_pos = all_names_start;
25325
25326     algorithmic_names= sv_2mortal(SvRV(algorithmic_names));
25327
25328     /* Compile the subpattern consisting of the name being looked for */
25329     subpattern_re = compile_wildcard(wname, wname_len, FALSE /* /-i */ );
25330
25331     must_sv = re_intuit_string(subpattern_re);
25332     if (must_sv) {
25333         /* regexec.c can free the re_intuit_string() return. GH #17734 */
25334         must_sv = sv_2mortal(newSVsv(must_sv));
25335         must = SvPV(must_sv, must_len);
25336     }
25337     else {
25338         must = "";
25339         must_len = 0;
25340     }
25341
25342     /* (Note: 'must' could contain a NUL.  And yet we use strspn() below on it.
25343      * This works because the NUL causes the function to return early, thus
25344      * showing that there are characters in it other than the acceptable ones,
25345      * which is our desired result.) */
25346
25347     prog = ReANY(subpattern_re);
25348
25349     /* If only nothing is matched, skip to where empty names are looked for */
25350     if (prog->maxlen == 0) {
25351         goto check_empty;
25352     }
25353
25354     /* And match against the string of all names /gc.  Don't even try if it
25355      * must match a character not found in any name. */
25356     if (strspn(must, "\n -0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ()") == must_len)
25357     {
25358         while (execute_wildcard(subpattern_re,
25359                                 cur_pos,
25360                                 SvEND(names_string),
25361                                 all_names_start, 0,
25362                                 names_string,
25363                                 0))
25364         { /* Here, matched. */
25365
25366             /* Note the string entries look like
25367              *      00001\nSTART OF HEADING\n\n
25368              * so we could match anywhere in that string.  We have to rule out
25369              * matching a code point line */
25370             char * this_name_start = all_names_start
25371                                                 + RX_OFFS(subpattern_re)->start;
25372             char * this_name_end   = all_names_start
25373                                                 + RX_OFFS(subpattern_re)->end;
25374             char * cp_start;
25375             char * cp_end;
25376             UV cp = 0;      /* Silences some compilers */
25377             AV * this_string = NULL;
25378             bool is_multi = FALSE;
25379
25380             /* If matched nothing, advance to next possible match */
25381             if (this_name_start == this_name_end) {
25382                 cur_pos = (char *) memchr(this_name_end + 1, '\n',
25383                                           SvEND(names_string) - this_name_end);
25384                 if (cur_pos == NULL) {
25385                     break;
25386                 }
25387             }
25388             else {
25389                 /* Position the next match to start beyond the current returned
25390                  * entry */
25391                 cur_pos = (char *) memchr(this_name_end, '\n',
25392                                           SvEND(names_string) - this_name_end);
25393             }
25394
25395             /* Back up to the \n just before the beginning of the character. */
25396             cp_end = (char *) my_memrchr(all_names_start,
25397                                          '\n',
25398                                          this_name_start - all_names_start);
25399
25400             /* If we didn't find a \n, it means it matched somewhere in the
25401              * initial '00000' in the string, so isn't a real match */
25402             if (cp_end == NULL) {
25403                 continue;
25404             }
25405
25406             this_name_start = cp_end + 1;   /* The name starts just after */
25407             cp_end--;                       /* the \n, and the code point */
25408                                             /* ends just before it */
25409
25410             /* All code points are 5 digits long */
25411             cp_start = cp_end - 4;
25412
25413             /* This shouldn't happen, as we found a \n, and the first \n is
25414              * further along than what we subtracted */
25415             assert(cp_start >= all_names_start);
25416
25417             if (cp_start == all_names_start) {
25418                 *prop_definition = add_cp_to_invlist(*prop_definition, 0);
25419                 continue;
25420             }
25421
25422             /* If the character is a blank, we either have a named sequence, or
25423              * something is wrong */
25424             if (*(cp_start - 1) == ' ') {
25425                 cp_start = (char *) my_memrchr(all_names_start,
25426                                                '\n',
25427                                                cp_start - all_names_start);
25428                 cp_start++;
25429             }
25430
25431             assert(cp_start != NULL && cp_start >= all_names_start + 2);
25432
25433             /* Except for the first line in the string, the sequence before the
25434              * code point is \n\n.  If that isn't the case here, we didn't
25435              * match the name of a character.  (We could have matched a named
25436              * sequence, not currently handled */
25437             if (*(cp_start - 1) != '\n' || *(cp_start - 2) != '\n') {
25438                 continue;
25439             }
25440
25441             /* We matched!  Add this to the list */
25442             found_matches = TRUE;
25443
25444             /* Loop through all the code points in the sequence */
25445             while (cp_start < cp_end) {
25446
25447                 /* Calculate this code point from its 5 digits */
25448                 cp = (XDIGIT_VALUE(cp_start[0]) << 16)
25449                    + (XDIGIT_VALUE(cp_start[1]) << 12)
25450                    + (XDIGIT_VALUE(cp_start[2]) << 8)
25451                    + (XDIGIT_VALUE(cp_start[3]) << 4)
25452                    +  XDIGIT_VALUE(cp_start[4]);
25453
25454                 cp_start += 6;  /* Go past any blank */
25455
25456                 if (cp_start < cp_end || is_multi) {
25457                     if (this_string == NULL) {
25458                         this_string = newAV();
25459                     }
25460
25461                     is_multi = TRUE;
25462                     av_push(this_string, newSVuv(cp));
25463                 }
25464             }
25465
25466             if (is_multi) { /* Was more than one code point */
25467                 if (*strings == NULL) {
25468                     *strings = newAV();
25469                 }
25470
25471                 av_push(*strings, (SV *) this_string);
25472             }
25473             else {  /* Only a single code point */
25474                 *prop_definition = add_cp_to_invlist(*prop_definition, cp);
25475             }
25476         } /* End of loop through the non-algorithmic names string */
25477     }
25478
25479     /* There are also character names not in 'names_string'.  These are
25480      * algorithmically generatable.  Try this pattern on each possible one.
25481      * (khw originally planned to leave this out given the large number of
25482      * matches attempted; but the speed turned out to be quite acceptable
25483      *
25484      * There are plenty of opportunities to optimize to skip many of the tests.
25485      * beyond the rudimentary ones already here */
25486
25487     /* First see if the subpattern matches any of the algorithmic generatable
25488      * Hangul syllable names.
25489      *
25490      * We know none of these syllable names will match if the input pattern
25491      * requires more bytes than any syllable has, or if the input pattern only
25492      * matches an empty name, or if the pattern has something it must match and
25493      * one of the characters in that isn't in any Hangul syllable. */
25494     if (    prog->minlen <= (SSize_t) syl_max_len
25495         &&  prog->maxlen > 0
25496         && (strspn(must, "\n ABCDEGHIJKLMNOPRSTUWY") == must_len))
25497     {
25498         /* These constants, names, values, and algorithm are adapted from the
25499          * Unicode standard, version 5.1, section 3.12, and should never
25500          * change. */
25501         const char * JamoL[] = {
25502             "G", "GG", "N", "D", "DD", "R", "M", "B", "BB",
25503             "S", "SS", "", "J", "JJ", "C", "K", "T", "P", "H"
25504         };
25505         const int LCount = C_ARRAY_LENGTH(JamoL);
25506
25507         const char * JamoV[] = {
25508             "A", "AE", "YA", "YAE", "EO", "E", "YEO", "YE", "O", "WA",
25509             "WAE", "OE", "YO", "U", "WEO", "WE", "WI", "YU", "EU", "YI",
25510             "I"
25511         };
25512         const int VCount = C_ARRAY_LENGTH(JamoV);
25513
25514         const char * JamoT[] = {
25515             "", "G", "GG", "GS", "N", "NJ", "NH", "D", "L",
25516             "LG", "LM", "LB", "LS", "LT", "LP", "LH", "M", "B",
25517             "BS", "S", "SS", "NG", "J", "C", "K", "T", "P", "H"
25518         };
25519         const int TCount = C_ARRAY_LENGTH(JamoT);
25520
25521         int L, V, T;
25522
25523         /* This is the initial Hangul syllable code point; each time through the
25524          * inner loop, it maps to the next higher code point.  For more info,
25525          * see the Hangul syllable section of the Unicode standard. */
25526         int cp = 0xAC00;
25527
25528         syllable_name = sv_2mortal(newSV(syl_max_len));
25529         sv_setpvn(syllable_name, hangul_prefix, hangul_prefix_len);
25530
25531         for (L = 0; L < LCount; L++) {
25532             for (V = 0; V < VCount; V++) {
25533                 for (T = 0; T < TCount; T++) {
25534
25535                     /* Truncate back to the prefix, which is unvarying */
25536                     SvCUR_set(syllable_name, hangul_prefix_len);
25537
25538                     sv_catpv(syllable_name, JamoL[L]);
25539                     sv_catpv(syllable_name, JamoV[V]);
25540                     sv_catpv(syllable_name, JamoT[T]);
25541
25542                     if (execute_wildcard(subpattern_re,
25543                                 SvPVX(syllable_name),
25544                                 SvEND(syllable_name),
25545                                 SvPVX(syllable_name), 0,
25546                                 syllable_name,
25547                                 0))
25548                     {
25549                         *prop_definition = add_cp_to_invlist(*prop_definition,
25550                                                              cp);
25551                         found_matches = TRUE;
25552                     }
25553
25554                     cp++;
25555                 }
25556             }
25557         }
25558     }
25559
25560     /* The rest of the algorithmically generatable names are of the form
25561      * "PREFIX-code_point".  The prefixes and the code point limits of each
25562      * were returned to us in the array 'algorithmic_names' from data in
25563      * lib/unicore/Name.pm.  'code_point' in the name is expressed in hex. */
25564     for (i = 0; i <= av_top_index((AV *) algorithmic_names); i++) {
25565         IV j;
25566
25567         /* Each element of the array is a hash, giving the details for the
25568          * series of names it covers.  There is the base name of the characters
25569          * in the series, and the low and high code points in the series.  And,
25570          * for optimization purposes a string containing all the legal
25571          * characters that could possibly be in a name in this series. */
25572         HV * this_series = (HV *) SvRV(* av_fetch((AV *) algorithmic_names, i, 0));
25573         SV * prefix = * hv_fetchs(this_series, "name", 0);
25574         IV low = SvIV(* hv_fetchs(this_series, "low", 0));
25575         IV high = SvIV(* hv_fetchs(this_series, "high", 0));
25576         char * legal = SvPVX(* hv_fetchs(this_series, "legal", 0));
25577
25578         /* Pre-allocate an SV with enough space */
25579         SV * algo_name = sv_2mortal(Perl_newSVpvf(aTHX_ "%s-0000",
25580                                                         SvPVX(prefix)));
25581         if (high >= 0x10000) {
25582             sv_catpvs(algo_name, "0");
25583         }
25584
25585         /* This series can be skipped entirely if the pattern requires
25586          * something longer than any name in the series, or can only match an
25587          * empty name, or contains a character not found in any name in the
25588          * series */
25589         if (    prog->minlen <= (SSize_t) SvCUR(algo_name)
25590             &&  prog->maxlen > 0
25591             && (strspn(must, legal) == must_len))
25592         {
25593             for (j = low; j <= high; j++) { /* For each code point in the series */
25594
25595                 /* Get its name, and see if it matches the subpattern */
25596                 Perl_sv_setpvf(aTHX_ algo_name, "%s-%X", SvPVX(prefix),
25597                                      (unsigned) j);
25598
25599                 if (execute_wildcard(subpattern_re,
25600                                     SvPVX(algo_name),
25601                                     SvEND(algo_name),
25602                                     SvPVX(algo_name), 0,
25603                                     algo_name,
25604                                     0))
25605                 {
25606                     *prop_definition = add_cp_to_invlist(*prop_definition, j);
25607                     found_matches = TRUE;
25608                 }
25609             }
25610         }
25611     }
25612
25613   check_empty:
25614     /* Finally, see if the subpattern matches an empty string */
25615     empty = newSVpvs("");
25616     if (execute_wildcard(subpattern_re,
25617                          SvPVX(empty),
25618                          SvEND(empty),
25619                          SvPVX(empty), 0,
25620                          empty,
25621                          0))
25622     {
25623         /* Many code points have empty names.  Currently these are the \p{GC=C}
25624          * ones, minus CC and CF */
25625
25626         SV * empty_names_ref = get_prop_definition(UNI_C);
25627         SV * empty_names = invlist_clone(empty_names_ref, NULL);
25628
25629         SV * subtract = get_prop_definition(UNI_CC);
25630
25631         _invlist_subtract(empty_names, subtract, &empty_names);
25632         SvREFCNT_dec_NN(empty_names_ref);
25633         SvREFCNT_dec_NN(subtract);
25634
25635         subtract = get_prop_definition(UNI_CF);
25636         _invlist_subtract(empty_names, subtract, &empty_names);
25637         SvREFCNT_dec_NN(subtract);
25638
25639         _invlist_union(*prop_definition, empty_names, prop_definition);
25640         found_matches = TRUE;
25641         SvREFCNT_dec_NN(empty_names);
25642     }
25643     SvREFCNT_dec_NN(empty);
25644
25645 #if 0
25646     /* If we ever were to accept aliases for, say private use names, we would
25647      * need to do something fancier to find empty names.  The code below works
25648      * (at the time it was written), and is slower than the above */
25649     const char empties_pat[] = "^.";
25650     if (strNE(name, empties_pat)) {
25651         SV * empty = newSVpvs("");
25652         if (execute_wildcard(subpattern_re,
25653                     SvPVX(empty),
25654                     SvEND(empty),
25655                     SvPVX(empty), 0,
25656                     empty,
25657                     0))
25658         {
25659             SV * empties = NULL;
25660
25661             (void) handle_names_wildcard(empties_pat, strlen(empties_pat), &empties);
25662
25663             _invlist_union_complement_2nd(*prop_definition, empties, prop_definition);
25664             SvREFCNT_dec_NN(empties);
25665
25666             found_matches = TRUE;
25667         }
25668         SvREFCNT_dec_NN(empty);
25669     }
25670 #endif
25671
25672     SvREFCNT_dec_NN(subpattern_re);
25673     return found_matches;
25674 }
25675
25676 /*
25677  * ex: set ts=8 sts=4 sw=4 et:
25678  */