]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5022000/regcomp.c
613c281a021e3b4a544df77ccee51133c679593e
[perl/modules/re-engine-Hooks.git] / src / 5022000 / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  * Copyright (c) 1986 by University of Toronto.
42  * Written by Henry Spencer.  Not derived from licensed software.
43  *
44  * Permission is granted to anyone to use this software for any
45  * purpose on any computer system, and to redistribute it freely,
46  * subject to the following restrictions:
47  *
48  * 1. The author is not responsible for the consequences of use of
49  *  this software, no matter how awful, even if they arise
50  *  from defects in it.
51  *
52  * 2. The origin of this software must not be misrepresented, either
53  *  by explicit claim or by omission.
54  *
55  * 3. Altered versions must be plainly marked as such, and must not
56  *  be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #include "re_defs.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 EXTERN_C const struct regexp_engine my_reg_engine;
85 #else
86 #  include "regcomp.h"
87 #endif
88
89 #include "dquote_static.c"
90 #include "inline_invlist.c"
91 #include "unicode_constants.h"
92
93 #define HAS_NONLATIN1_FOLD_CLOSURE(i) \
94  _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
95 #define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
96  _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
97 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
98 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
99
100 #ifndef STATIC
101 #define STATIC static
102 #endif
103
104 #ifndef MIN
105 #define MIN(a,b) ((a) < (b) ? (a) : (b))
106 #endif
107
108 /* this is a chain of data about sub patterns we are processing that
109    need to be handled separately/specially in study_chunk. Its so
110    we can simulate recursion without losing state.  */
111 struct scan_frame;
112 typedef struct scan_frame {
113  regnode *last_regnode;      /* last node to process in this frame */
114  regnode *next_regnode;      /* next node to process when last is reached */
115  U32 prev_recursed_depth;
116  I32 stopparen;              /* what stopparen do we use */
117  U32 is_top_frame;           /* what flags do we use? */
118
119  struct scan_frame *this_prev_frame; /* this previous frame */
120  struct scan_frame *prev_frame;      /* previous frame */
121  struct scan_frame *next_frame;      /* next frame */
122 } scan_frame;
123
124 /* Certain characters are output as a sequence with the first being a
125  * backslash. */
126 #define isBACKSLASHED_PUNCT(c)                                              \
127      ((c) == '-' || (c) == ']' || (c) == '\\' || (c) == '^')
128
129
130 struct RExC_state_t {
131  U32  flags;   /* RXf_* are we folding, multilining? */
132  U32  pm_flags;  /* PMf_* stuff from the calling PMOP */
133  char *precomp;  /* uncompiled string. */
134  REGEXP *rx_sv;   /* The SV that is the regexp. */
135  regexp *rx;                    /* perl core regexp structure */
136  regexp_internal *rxi;           /* internal data for regexp object
137           pprivate field */
138  char *start;   /* Start of input for compile */
139  char *end;   /* End of input for compile */
140  char *parse;   /* Input-scan pointer. */
141  SSize_t whilem_seen;  /* number of WHILEM in this expr */
142  regnode *emit_start;  /* Start of emitted-code area */
143  regnode *emit_bound;  /* First regnode outside of the
144           allocated space */
145  regnode *emit;   /* Code-emit pointer; if = &emit_dummy,
146           implies compiling, so don't emit */
147  regnode_ssc emit_dummy;  /* placeholder for emit to point to;
148           large enough for the largest
149           non-EXACTish node, so can use it as
150           scratch in pass1 */
151  I32  naughty;  /* How bad is this pattern? */
152  I32  sawback;  /* Did we see \1, ...? */
153  U32  seen;
154  SSize_t size;   /* Code size. */
155  I32                npar;            /* Capture buffer count, (OPEN) plus
156           one. ("par" 0 is the whole
157           pattern)*/
158  I32  nestroot;  /* root parens we are in - used by
159           accept */
160  I32  extralen;
161  I32  seen_zerolen;
162  regnode **open_parens;  /* pointers to open parens */
163  regnode **close_parens;  /* pointers to close parens */
164  regnode *opend;   /* END node in program */
165  I32  utf8;  /* whether the pattern is utf8 or not */
166  I32  orig_utf8; /* whether the pattern was originally in utf8 */
167         /* XXX use this for future optimisation of case
168         * where pattern must be upgraded to utf8. */
169  I32  uni_semantics; /* If a d charset modifier should use unicode
170         rules, even if the pattern is not in
171         utf8 */
172  HV  *paren_names;  /* Paren names */
173
174  regnode **recurse;  /* Recurse regops */
175  I32  recurse_count;  /* Number of recurse regops */
176  U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
177           through */
178  U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
179  I32  in_lookbehind;
180  I32  contains_locale;
181  I32  contains_i;
182  I32  override_recoding;
183 #ifdef EBCDIC
184  I32  recode_x_to_native;
185 #endif
186  I32  in_multi_char_class;
187  struct reg_code_block *code_blocks; /* positions of literal (?{})
188            within pattern */
189  int  num_code_blocks; /* size of code_blocks[] */
190  int  code_index;  /* next code_blocks[] slot */
191  SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
192  scan_frame *frame_head;
193  scan_frame *frame_last;
194  U32         frame_count;
195  U32         strict;
196 #ifdef ADD_TO_REGEXEC
197  char  *starttry;  /* -Dr: where regtry was called. */
198 #define RExC_starttry (pRExC_state->starttry)
199 #endif
200  SV  *runtime_code_qr; /* qr with the runtime code blocks */
201 #ifdef DEBUGGING
202  const char  *lastparse;
203  I32         lastnum;
204  AV          *paren_name_list;       /* idx -> name */
205  U32         study_chunk_recursed_count;
206  SV          *mysv1;
207  SV          *mysv2;
208 #define RExC_lastparse (pRExC_state->lastparse)
209 #define RExC_lastnum (pRExC_state->lastnum)
210 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
211 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
212 #define RExC_mysv (pRExC_state->mysv1)
213 #define RExC_mysv1 (pRExC_state->mysv1)
214 #define RExC_mysv2 (pRExC_state->mysv2)
215
216 #endif
217 };
218
219 #define RExC_flags (pRExC_state->flags)
220 #define RExC_pm_flags (pRExC_state->pm_flags)
221 #define RExC_precomp (pRExC_state->precomp)
222 #define RExC_rx_sv (pRExC_state->rx_sv)
223 #define RExC_rx  (pRExC_state->rx)
224 #define RExC_rxi (pRExC_state->rxi)
225 #define RExC_start (pRExC_state->start)
226 #define RExC_end (pRExC_state->end)
227 #define RExC_parse (pRExC_state->parse)
228 #define RExC_whilem_seen (pRExC_state->whilem_seen)
229 #ifdef RE_TRACK_PATTERN_OFFSETS
230 #define RExC_offsets (pRExC_state->rxi->u.offsets) /* I am not like the
231               others */
232 #endif
233 #define RExC_emit (pRExC_state->emit)
234 #define RExC_emit_dummy (pRExC_state->emit_dummy)
235 #define RExC_emit_start (pRExC_state->emit_start)
236 #define RExC_emit_bound (pRExC_state->emit_bound)
237 #define RExC_sawback (pRExC_state->sawback)
238 #define RExC_seen (pRExC_state->seen)
239 #define RExC_size (pRExC_state->size)
240 #define RExC_maxlen        (pRExC_state->maxlen)
241 #define RExC_npar (pRExC_state->npar)
242 #define RExC_nestroot   (pRExC_state->nestroot)
243 #define RExC_extralen (pRExC_state->extralen)
244 #define RExC_seen_zerolen (pRExC_state->seen_zerolen)
245 #define RExC_utf8 (pRExC_state->utf8)
246 #define RExC_uni_semantics (pRExC_state->uni_semantics)
247 #define RExC_orig_utf8 (pRExC_state->orig_utf8)
248 #define RExC_open_parens (pRExC_state->open_parens)
249 #define RExC_close_parens (pRExC_state->close_parens)
250 #define RExC_opend (pRExC_state->opend)
251 #define RExC_paren_names (pRExC_state->paren_names)
252 #define RExC_recurse (pRExC_state->recurse)
253 #define RExC_recurse_count (pRExC_state->recurse_count)
254 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
255 #define RExC_study_chunk_recursed_bytes  \
256         (pRExC_state->study_chunk_recursed_bytes)
257 #define RExC_in_lookbehind (pRExC_state->in_lookbehind)
258 #define RExC_contains_locale (pRExC_state->contains_locale)
259 #define RExC_contains_i (pRExC_state->contains_i)
260 #define RExC_override_recoding (pRExC_state->override_recoding)
261 #ifdef EBCDIC
262 #   define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
263 #endif
264 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
265 #define RExC_frame_head (pRExC_state->frame_head)
266 #define RExC_frame_last (pRExC_state->frame_last)
267 #define RExC_frame_count (pRExC_state->frame_count)
268 #define RExC_strict (pRExC_state->strict)
269
270 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
271  * a flag to disable back-off on the fixed/floating substrings - if it's
272  * a high complexity pattern we assume the benefit of avoiding a full match
273  * is worth the cost of checking for the substrings even if they rarely help.
274  */
275 #define RExC_naughty (pRExC_state->naughty)
276 #define TOO_NAUGHTY (10)
277 #define MARK_NAUGHTY(add) \
278  if (RExC_naughty < TOO_NAUGHTY) \
279   RExC_naughty += (add)
280 #define MARK_NAUGHTY_EXP(exp, add) \
281  if (RExC_naughty < TOO_NAUGHTY) \
282   RExC_naughty += RExC_naughty / (exp) + (add)
283
284 #define ISMULT1(c) ((c) == '*' || (c) == '+' || (c) == '?')
285 #define ISMULT2(s) ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
286   ((*s) == '{' && regcurly(s)))
287
288 /*
289  * Flags to be passed up and down.
290  */
291 #define WORST  0 /* Worst case. */
292 #define HASWIDTH 0x01 /* Known to match non-null strings. */
293
294 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
295  * character.  (There needs to be a case: in the switch statement in regexec.c
296  * for any node marked SIMPLE.)  Note that this is not the same thing as
297  * REGNODE_SIMPLE */
298 #define SIMPLE  0x02
299 #define SPSTART  0x04 /* Starts with * or + */
300 #define POSTPONED 0x08    /* (?1),(?&name), (??{...}) or similar */
301 #define TRYAGAIN 0x10 /* Weeded out a declaration. */
302 #define RESTART_UTF8    0x20    /* Restart, need to calcuate sizes as UTF-8 */
303
304 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
305
306 /* whether trie related optimizations are enabled */
307 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
308 #define TRIE_STUDY_OPT
309 #define FULL_TRIE_STUDY
310 #define TRIE_STCLASS
311 #endif
312
313
314
315 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
316 #define PBITVAL(paren) (1 << ((paren) & 7))
317 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
318 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
319 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
320
321 #define REQUIRE_UTF8 STMT_START {                                       \
322          if (!UTF) {                           \
323           *flagp = RESTART_UTF8;            \
324           return NULL;                      \
325          }                                     \
326       } STMT_END
327
328 /* This converts the named class defined in regcomp.h to its equivalent class
329  * number defined in handy.h. */
330 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
331 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
332
333 #define _invlist_union_complement_2nd(a, b, output) \
334       _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
335 #define _invlist_intersection_complement_2nd(a, b, output) \
336     _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
337
338 /* About scan_data_t.
339
340   During optimisation we recurse through the regexp program performing
341   various inplace (keyhole style) optimisations. In addition study_chunk
342   and scan_commit populate this data structure with information about
343   what strings MUST appear in the pattern. We look for the longest
344   string that must appear at a fixed location, and we look for the
345   longest string that may appear at a floating location. So for instance
346   in the pattern:
347
348  /FOO[xX]A.*B[xX]BAR/
349
350   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
351   strings (because they follow a .* construct). study_chunk will identify
352   both FOO and BAR as being the longest fixed and floating strings respectively.
353
354   The strings can be composites, for instance
355
356  /(f)(o)(o)/
357
358   will result in a composite fixed substring 'foo'.
359
360   For each string some basic information is maintained:
361
362   - offset or min_offset
363  This is the position the string must appear at, or not before.
364  It also implicitly (when combined with minlenp) tells us how many
365  characters must match before the string we are searching for.
366  Likewise when combined with minlenp and the length of the string it
367  tells us how many characters must appear after the string we have
368  found.
369
370   - max_offset
371  Only used for floating strings. This is the rightmost point that
372  the string can appear at. If set to SSize_t_MAX it indicates that the
373  string can occur infinitely far to the right.
374
375   - minlenp
376  A pointer to the minimum number of characters of the pattern that the
377  string was found inside. This is important as in the case of positive
378  lookahead or positive lookbehind we can have multiple patterns
379  involved. Consider
380
381  /(?=FOO).*F/
382
383  The minimum length of the pattern overall is 3, the minimum length
384  of the lookahead part is 3, but the minimum length of the part that
385  will actually match is 1. So 'FOO's minimum length is 3, but the
386  minimum length for the F is 1. This is important as the minimum length
387  is used to determine offsets in front of and behind the string being
388  looked for.  Since strings can be composites this is the length of the
389  pattern at the time it was committed with a scan_commit. Note that
390  the length is calculated by study_chunk, so that the minimum lengths
391  are not known until the full pattern has been compiled, thus the
392  pointer to the value.
393
394   - lookbehind
395
396  In the case of lookbehind the string being searched for can be
397  offset past the start point of the final matching string.
398  If this value was just blithely removed from the min_offset it would
399  invalidate some of the calculations for how many chars must match
400  before or after (as they are derived from min_offset and minlen and
401  the length of the string being searched for).
402  When the final pattern is compiled and the data is moved from the
403  scan_data_t structure into the regexp structure the information
404  about lookbehind is factored in, with the information that would
405  have been lost precalculated in the end_shift field for the
406  associated string.
407
408   The fields pos_min and pos_delta are used to store the minimum offset
409   and the delta to the maximum offset at the current point in the pattern.
410
411 */
412
413 typedef struct scan_data_t {
414  /*I32 len_min;      unused */
415  /*I32 len_delta;    unused */
416  SSize_t pos_min;
417  SSize_t pos_delta;
418  SV *last_found;
419  SSize_t last_end;     /* min value, <0 unless valid. */
420  SSize_t last_start_min;
421  SSize_t last_start_max;
422  SV **longest;     /* Either &l_fixed, or &l_float. */
423  SV *longest_fixed;      /* longest fixed string found in pattern */
424  SSize_t offset_fixed;   /* offset where it starts */
425  SSize_t *minlen_fixed;  /* pointer to the minlen relevant to the string */
426  I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
427  SV *longest_float;      /* longest floating string found in pattern */
428  SSize_t offset_float_min; /* earliest point in string it can appear */
429  SSize_t offset_float_max; /* latest point in string it can appear */
430  SSize_t *minlen_float;  /* pointer to the minlen relevant to the string */
431  SSize_t lookbehind_float; /* is the pos of the string modified by LB */
432  I32 flags;
433  I32 whilem_c;
434  SSize_t *last_closep;
435  regnode_ssc *start_class;
436 } scan_data_t;
437
438 /*
439  * Forward declarations for pregcomp()'s friends.
440  */
441
442 static const scan_data_t zero_scan_data =
443   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
444
445 #define SF_BEFORE_EOL  (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
446 #define SF_BEFORE_SEOL  0x0001
447 #define SF_BEFORE_MEOL  0x0002
448 #define SF_FIX_BEFORE_EOL (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
449 #define SF_FL_BEFORE_EOL (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
450
451 #define SF_FIX_SHIFT_EOL (+2)
452 #define SF_FL_SHIFT_EOL  (+4)
453
454 #define SF_FIX_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
455 #define SF_FIX_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
456
457 #define SF_FL_BEFORE_SEOL (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
458 #define SF_FL_BEFORE_MEOL (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
459 #define SF_IS_INF  0x0040
460 #define SF_HAS_PAR  0x0080
461 #define SF_IN_PAR  0x0100
462 #define SF_HAS_EVAL  0x0200
463 #define SCF_DO_SUBSTR  0x0400
464 #define SCF_DO_STCLASS_AND 0x0800
465 #define SCF_DO_STCLASS_OR 0x1000
466 #define SCF_DO_STCLASS  (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
467 #define SCF_WHILEM_VISITED_POS 0x2000
468
469 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
470 #define SCF_SEEN_ACCEPT         0x8000
471 #define SCF_TRIE_DOING_RESTUDY 0x10000
472 #define SCF_IN_DEFINE          0x20000
473
474
475
476
477 #define UTF cBOOL(RExC_utf8)
478
479 /* The enums for all these are ordered so things work out correctly */
480 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
481 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
482              == REGEX_DEPENDS_CHARSET)
483 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
484 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
485              >= REGEX_UNICODE_CHARSET)
486 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
487            == REGEX_ASCII_RESTRICTED_CHARSET)
488 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
489            >= REGEX_ASCII_RESTRICTED_CHARSET)
490 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
491           == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
492
493 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
494
495 /* For programs that want to be strictly Unicode compatible by dying if any
496  * attempt is made to match a non-Unicode code point against a Unicode
497  * property.  */
498 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
499
500 #define OOB_NAMEDCLASS  -1
501
502 /* There is no code point that is out-of-bounds, so this is problematic.  But
503  * its only current use is to initialize a variable that is always set before
504  * looked at. */
505 #define OOB_UNICODE  0xDEADBEEF
506
507 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
508 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
509
510
511 /* length of regex to show in messages that don't mark a position within */
512 #define RegexLengthToShowInErrorMessages 127
513
514 /*
515  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
516  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
517  * op/pragma/warn/regcomp.
518  */
519 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
520 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
521
522 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
523       " in m/%"UTF8f MARKER2 "%"UTF8f"/"
524
525 #define REPORT_LOCATION_ARGS(offset)            \
526     UTF8fARG(UTF, offset, RExC_precomp), \
527     UTF8fARG(UTF, RExC_end - RExC_precomp - offset, RExC_precomp + offset)
528
529 /* Used to point after bad bytes for an error message, but avoid skipping
530  * past a nul byte. */
531 #define SKIP_IF_CHAR(s) (!*(s) ? 0 : UTF ? UTF8SKIP(s) : 1)
532
533 /*
534  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
535  * arg. Show regex, up to a maximum length. If it's too long, chop and add
536  * "...".
537  */
538 #define _FAIL(code) STMT_START {     \
539  const char *ellipses = "";      \
540  IV len = RExC_end - RExC_precomp;     \
541                   \
542  if (!SIZE_ONLY)       \
543   SAVEFREESV(RExC_rx_sv);      \
544  if (len > RegexLengthToShowInErrorMessages) {   \
545   /* chop 10 shorter than the max, to ensure meaning of "..." */ \
546   len = RegexLengthToShowInErrorMessages - 10;   \
547   ellipses = "...";      \
548  }         \
549  code;                                                               \
550 } STMT_END
551
552 #define FAIL(msg) _FAIL(       \
553  Perl_croak(aTHX_ "%s in regex m/%"UTF8f"%s/",     \
554    msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
555
556 #define FAIL2(msg,arg) _FAIL(       \
557  Perl_croak(aTHX_ msg " in regex m/%"UTF8f"%s/",     \
558    arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
559
560 /*
561  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
562  */
563 #define Simple_vFAIL(m) STMT_START {     \
564  const IV offset =                                                   \
565   (RExC_parse > RExC_end ? RExC_end : RExC_parse) - RExC_precomp; \
566  Perl_croak(aTHX_ "%s" REPORT_LOCATION,    \
567    m, REPORT_LOCATION_ARGS(offset)); \
568 } STMT_END
569
570 /*
571  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
572  */
573 #define vFAIL(m) STMT_START {    \
574  if (!SIZE_ONLY)     \
575   SAVEFREESV(RExC_rx_sv);    \
576  Simple_vFAIL(m);     \
577 } STMT_END
578
579 /*
580  * Like Simple_vFAIL(), but accepts two arguments.
581  */
582 #define Simple_vFAIL2(m,a1) STMT_START {   \
583  const IV offset = RExC_parse - RExC_precomp;   \
584  S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,   \
585      REPORT_LOCATION_ARGS(offset)); \
586 } STMT_END
587
588 /*
589  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
590  */
591 #define vFAIL2(m,a1) STMT_START {   \
592  if (!SIZE_ONLY)     \
593   SAVEFREESV(RExC_rx_sv);    \
594  Simple_vFAIL2(m, a1);    \
595 } STMT_END
596
597
598 /*
599  * Like Simple_vFAIL(), but accepts three arguments.
600  */
601 #define Simple_vFAIL3(m, a1, a2) STMT_START {   \
602  const IV offset = RExC_parse - RExC_precomp;  \
603  S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
604    REPORT_LOCATION_ARGS(offset)); \
605 } STMT_END
606
607 /*
608  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
609  */
610 #define vFAIL3(m,a1,a2) STMT_START {   \
611  if (!SIZE_ONLY)     \
612   SAVEFREESV(RExC_rx_sv);    \
613  Simple_vFAIL3(m, a1, a2);    \
614 } STMT_END
615
616 /*
617  * Like Simple_vFAIL(), but accepts four arguments.
618  */
619 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {  \
620  const IV offset = RExC_parse - RExC_precomp;  \
621  S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,  \
622    REPORT_LOCATION_ARGS(offset)); \
623 } STMT_END
624
625 #define vFAIL4(m,a1,a2,a3) STMT_START {   \
626  if (!SIZE_ONLY)     \
627   SAVEFREESV(RExC_rx_sv);    \
628  Simple_vFAIL4(m, a1, a2, a3);   \
629 } STMT_END
630
631 /* A specialized version of vFAIL2 that works with UTF8f */
632 #define vFAIL2utf8f(m, a1) STMT_START { \
633  const IV offset = RExC_parse - RExC_precomp;   \
634  if (!SIZE_ONLY)                                \
635   SAVEFREESV(RExC_rx_sv);                    \
636  S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, \
637    REPORT_LOCATION_ARGS(offset));         \
638 } STMT_END
639
640 /* These have asserts in them because of [perl #122671] Many warnings in
641  * regcomp.c can occur twice.  If they get output in pass1 and later in that
642  * pass, the pattern has to be converted to UTF-8 and the pass restarted, they
643  * would get output again.  So they should be output in pass2, and these
644  * asserts make sure new warnings follow that paradigm. */
645
646 /* m is not necessarily a "literal string", in this macro */
647 #define reg_warn_non_literal_string(loc, m) STMT_START {                \
648  const IV offset = loc - RExC_precomp;                               \
649  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
650    m, REPORT_LOCATION_ARGS(offset));       \
651 } STMT_END
652
653 #define ckWARNreg(loc,m) STMT_START {     \
654  const IV offset = loc - RExC_precomp;    \
655  __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
656    REPORT_LOCATION_ARGS(offset));  \
657 } STMT_END
658
659 #define vWARN(loc, m) STMT_START {            \
660  const IV offset = loc - RExC_precomp;    \
661  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
662    REPORT_LOCATION_ARGS(offset));         \
663 } STMT_END
664
665 #define vWARN_dep(loc, m) STMT_START {            \
666  const IV offset = loc - RExC_precomp;    \
667  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_DEPRECATED), m REPORT_LOCATION, \
668    REPORT_LOCATION_ARGS(offset));         \
669 } STMT_END
670
671 #define ckWARNdep(loc,m) STMT_START {            \
672  const IV offset = loc - RExC_precomp;    \
673  __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED),                 \
674    m REPORT_LOCATION,      \
675    REPORT_LOCATION_ARGS(offset));  \
676 } STMT_END
677
678 #define ckWARNregdep(loc,m) STMT_START {    \
679  const IV offset = loc - RExC_precomp;    \
680  __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP), \
681    m REPORT_LOCATION,      \
682    REPORT_LOCATION_ARGS(offset));  \
683 } STMT_END
684
685 #define ckWARN2reg_d(loc,m, a1) STMT_START {    \
686  const IV offset = loc - RExC_precomp;    \
687  __ASSERT_(PASS2) Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),   \
688    m REPORT_LOCATION,      \
689    a1, REPORT_LOCATION_ARGS(offset)); \
690 } STMT_END
691
692 #define ckWARN2reg(loc, m, a1) STMT_START {    \
693  const IV offset = loc - RExC_precomp;    \
694  __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
695    a1, REPORT_LOCATION_ARGS(offset)); \
696 } STMT_END
697
698 #define vWARN3(loc, m, a1, a2) STMT_START {    \
699  const IV offset = loc - RExC_precomp;    \
700  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,  \
701    a1, a2, REPORT_LOCATION_ARGS(offset)); \
702 } STMT_END
703
704 #define ckWARN3reg(loc, m, a1, a2) STMT_START {    \
705  const IV offset = loc - RExC_precomp;    \
706  __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
707    a1, a2, REPORT_LOCATION_ARGS(offset)); \
708 } STMT_END
709
710 #define vWARN4(loc, m, a1, a2, a3) STMT_START {    \
711  const IV offset = loc - RExC_precomp;    \
712  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,  \
713    a1, a2, a3, REPORT_LOCATION_ARGS(offset)); \
714 } STMT_END
715
716 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {   \
717  const IV offset = loc - RExC_precomp;    \
718  __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION, \
719    a1, a2, a3, REPORT_LOCATION_ARGS(offset)); \
720 } STMT_END
721
722 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {   \
723  const IV offset = loc - RExC_precomp;    \
724  __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,  \
725    a1, a2, a3, a4, REPORT_LOCATION_ARGS(offset)); \
726 } STMT_END
727
728 /* Macros for recording node offsets.   20001227 mjd@plover.com
729  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
730  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
731  * Element 0 holds the number n.
732  * Position is 1 indexed.
733  */
734 #ifndef RE_TRACK_PATTERN_OFFSETS
735 #define Set_Node_Offset_To_R(node,byte)
736 #define Set_Node_Offset(node,byte)
737 #define Set_Cur_Node_Offset
738 #define Set_Node_Length_To_R(node,len)
739 #define Set_Node_Length(node,len)
740 #define Set_Node_Cur_Length(node,start)
741 #define Node_Offset(n)
742 #define Node_Length(n)
743 #define Set_Node_Offset_Length(node,offset,len)
744 #define ProgLen(ri) ri->u.proglen
745 #define SetProgLen(ri,x) ri->u.proglen = x
746 #else
747 #define ProgLen(ri) ri->u.offsets[0]
748 #define SetProgLen(ri,x) ri->u.offsets[0] = x
749 #define Set_Node_Offset_To_R(node,byte) STMT_START {   \
750  if (! SIZE_ONLY) {       \
751   MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",  \
752      __LINE__, (int)(node), (int)(byte)));  \
753   if((node) < 0) {      \
754    Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
755           (int)(node));                  \
756   } else {       \
757    RExC_offsets[2*(node)-1] = (byte);    \
758   }        \
759  }         \
760 } STMT_END
761
762 #define Set_Node_Offset(node,byte) \
763  Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
764 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
765
766 #define Set_Node_Length_To_R(node,len) STMT_START {   \
767  if (! SIZE_ONLY) {       \
768   MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",  \
769     __LINE__, (int)(node), (int)(len)));   \
770   if((node) < 0) {      \
771    Perl_croak(aTHX_ "value of node is %d in Length macro",     \
772           (int)(node));                  \
773   } else {       \
774    RExC_offsets[2*(node)] = (len);    \
775   }        \
776  }         \
777 } STMT_END
778
779 #define Set_Node_Length(node,len) \
780  Set_Node_Length_To_R((node)-RExC_emit_start, len)
781 #define Set_Node_Cur_Length(node, start)                \
782  Set_Node_Length(node, RExC_parse - start)
783
784 /* Get offsets and lengths */
785 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
786 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
787
788 #define Set_Node_Offset_Length(node,offset,len) STMT_START { \
789  Set_Node_Offset_To_R((node)-RExC_emit_start, (offset)); \
790  Set_Node_Length_To_R((node)-RExC_emit_start, (len)); \
791 } STMT_END
792 #endif
793
794 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
795 #define EXPERIMENTAL_INPLACESCAN
796 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
797
798 #define DEBUG_RExC_seen() \
799   DEBUG_OPTIMISE_MORE_r({                                             \
800    PerlIO_printf(Perl_debug_log,"RExC_seen: ");                    \
801                    \
802    if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
803     PerlIO_printf(Perl_debug_log,"REG_ZERO_LEN_SEEN ");         \
804                    \
805    if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
806     PerlIO_printf(Perl_debug_log,"REG_LOOKBEHIND_SEEN ");       \
807                    \
808    if (RExC_seen & REG_GPOS_SEEN)                                  \
809     PerlIO_printf(Perl_debug_log,"REG_GPOS_SEEN ");             \
810                    \
811    if (RExC_seen & REG_CANY_SEEN)                                  \
812     PerlIO_printf(Perl_debug_log,"REG_CANY_SEEN ");             \
813                    \
814    if (RExC_seen & REG_RECURSE_SEEN)                               \
815     PerlIO_printf(Perl_debug_log,"REG_RECURSE_SEEN ");          \
816                    \
817    if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                         \
818     PerlIO_printf(Perl_debug_log,"REG_TOP_LEVEL_BRANCHES_SEEN ");    \
819                    \
820    if (RExC_seen & REG_VERBARG_SEEN)                               \
821     PerlIO_printf(Perl_debug_log,"REG_VERBARG_SEEN ");          \
822                    \
823    if (RExC_seen & REG_CUTGROUP_SEEN)                              \
824     PerlIO_printf(Perl_debug_log,"REG_CUTGROUP_SEEN ");         \
825                    \
826    if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
827     PerlIO_printf(Perl_debug_log,"REG_RUN_ON_COMMENT_SEEN ");   \
828                    \
829    if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
830     PerlIO_printf(Perl_debug_log,"REG_UNFOLDED_MULTI_SEEN ");   \
831                    \
832    if (RExC_seen & REG_GOSTART_SEEN)                               \
833     PerlIO_printf(Perl_debug_log,"REG_GOSTART_SEEN ");          \
834                    \
835    if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                               \
836     PerlIO_printf(Perl_debug_log,"REG_UNBOUNDED_QUANTIFIER_SEEN ");          \
837                    \
838    PerlIO_printf(Perl_debug_log,"\n");                             \
839   });
840
841 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
842   if ((flags) & flag) PerlIO_printf(Perl_debug_log, "%s ", #flag)
843
844 #define DEBUG_SHOW_STUDY_FLAGS(flags,open_str,close_str)                    \
845  if ( ( flags ) ) {                                                      \
846   PerlIO_printf(Perl_debug_log, "%s", open_str);                      \
847   DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_SEOL);                     \
848   DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_MEOL);                     \
849   DEBUG_SHOW_STUDY_FLAG(flags,SF_IS_INF);                             \
850   DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_PAR);                            \
851   DEBUG_SHOW_STUDY_FLAG(flags,SF_IN_PAR);                             \
852   DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_EVAL);                           \
853   DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_SUBSTR);                         \
854   DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_AND);                    \
855   DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_OR);                     \
856   DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS);                        \
857   DEBUG_SHOW_STUDY_FLAG(flags,SCF_WHILEM_VISITED_POS);                \
858   DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_RESTUDY);                      \
859   DEBUG_SHOW_STUDY_FLAG(flags,SCF_SEEN_ACCEPT);                       \
860   DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_DOING_RESTUDY);                \
861   DEBUG_SHOW_STUDY_FLAG(flags,SCF_IN_DEFINE);                         \
862   PerlIO_printf(Perl_debug_log, "%s", close_str);                     \
863  }
864
865
866 #define DEBUG_STUDYDATA(str,data,depth)                              \
867 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
868  PerlIO_printf(Perl_debug_log,                                    \
869   "%*s" str "Pos:%"IVdf"/%"IVdf                                \
870   " Flags: 0x%"UVXf,                                           \
871   (int)(depth)*2, "",                                          \
872   (IV)((data)->pos_min),                                       \
873   (IV)((data)->pos_delta),                                     \
874   (UV)((data)->flags)                                          \
875  );                                                               \
876  DEBUG_SHOW_STUDY_FLAGS((data)->flags," [ ","]");                 \
877  PerlIO_printf(Perl_debug_log,                                    \
878   " Whilem_c: %"IVdf" Lcp: %"IVdf" %s",                        \
879   (IV)((data)->whilem_c),                                      \
880   (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
881   is_inf ? "INF " : ""                                         \
882  );                                                               \
883  if ((data)->last_found)                                          \
884   PerlIO_printf(Perl_debug_log,                                \
885    "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
886    " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
887    SvPVX_const((data)->last_found),                         \
888    (IV)((data)->last_end),                                  \
889    (IV)((data)->last_start_min),                            \
890    (IV)((data)->last_start_max),                            \
891    ((data)->longest &&                                      \
892    (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
893    SvPVX_const((data)->longest_fixed),                      \
894    (IV)((data)->offset_fixed),                              \
895    ((data)->longest &&                                      \
896    (data)->longest==&((data)->longest_float)) ? "*" : "",  \
897    SvPVX_const((data)->longest_float),                      \
898    (IV)((data)->offset_float_min),                          \
899    (IV)((data)->offset_float_max)                           \
900   );                                                           \
901  PerlIO_printf(Perl_debug_log,"\n");                              \
902 });
903
904 /* is c a control character for which we have a mnemonic? */
905 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
906
907 STATIC const char *
908 S_cntrl_to_mnemonic(const U8 c)
909 {
910  /* Returns the mnemonic string that represents character 'c', if one
911  * exists; NULL otherwise.  The only ones that exist for the purposes of
912  * this routine are a few control characters */
913
914  switch (c) {
915   case '\a':       return "\\a";
916   case '\b':       return "\\b";
917   case ESC_NATIVE: return "\\e";
918   case '\f':       return "\\f";
919   case '\n':       return "\\n";
920   case '\r':       return "\\r";
921   case '\t':       return "\\t";
922  }
923
924  return NULL;
925 }
926
927 /* Mark that we cannot extend a found fixed substring at this point.
928    Update the longest found anchored substring and the longest found
929    floating substrings if needed. */
930
931 STATIC void
932 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
933      SSize_t *minlenp, int is_inf)
934 {
935  const STRLEN l = CHR_SVLEN(data->last_found);
936  const STRLEN old_l = CHR_SVLEN(*data->longest);
937  GET_RE_DEBUG_FLAGS_DECL;
938
939  PERL_ARGS_ASSERT_SCAN_COMMIT;
940
941  if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
942   SvSetMagicSV(*data->longest, data->last_found);
943   if (*data->longest == data->longest_fixed) {
944    data->offset_fixed = l ? data->last_start_min : data->pos_min;
945    if (data->flags & SF_BEFORE_EOL)
946     data->flags
947      |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
948    else
949     data->flags &= ~SF_FIX_BEFORE_EOL;
950    data->minlen_fixed=minlenp;
951    data->lookbehind_fixed=0;
952   }
953   else { /* *data->longest == data->longest_float */
954    data->offset_float_min = l ? data->last_start_min : data->pos_min;
955    data->offset_float_max = (l
956       ? data->last_start_max
957       : (data->pos_delta > SSize_t_MAX - data->pos_min
958           ? SSize_t_MAX
959           : data->pos_min + data->pos_delta));
960    if (is_inf
961     || (STRLEN)data->offset_float_max > (STRLEN)SSize_t_MAX)
962     data->offset_float_max = SSize_t_MAX;
963    if (data->flags & SF_BEFORE_EOL)
964     data->flags
965      |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
966    else
967     data->flags &= ~SF_FL_BEFORE_EOL;
968    data->minlen_float=minlenp;
969    data->lookbehind_float=0;
970   }
971  }
972  SvCUR_set(data->last_found, 0);
973  {
974   SV * const sv = data->last_found;
975   if (SvUTF8(sv) && SvMAGICAL(sv)) {
976    MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
977    if (mg)
978     mg->mg_len = 0;
979   }
980  }
981  data->last_end = -1;
982  data->flags &= ~SF_BEFORE_EOL;
983  DEBUG_STUDYDATA("commit: ",data,0);
984 }
985
986 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
987  * list that describes which code points it matches */
988
989 STATIC void
990 S_ssc_anything(pTHX_ regnode_ssc *ssc)
991 {
992  /* Set the SSC 'ssc' to match an empty string or any code point */
993
994  PERL_ARGS_ASSERT_SSC_ANYTHING;
995
996  assert(is_ANYOF_SYNTHETIC(ssc));
997
998  ssc->invlist = sv_2mortal(_new_invlist(2)); /* mortalize so won't leak */
999  _append_range_to_invlist(ssc->invlist, 0, UV_MAX);
1000  ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1001 }
1002
1003 STATIC int
1004 S_ssc_is_anything(const regnode_ssc *ssc)
1005 {
1006  /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1007  * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1008  * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1009  * in any way, so there's no point in using it */
1010
1011  UV start, end;
1012  bool ret;
1013
1014  PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1015
1016  assert(is_ANYOF_SYNTHETIC(ssc));
1017
1018  if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1019   return FALSE;
1020  }
1021
1022  /* See if the list consists solely of the range 0 - Infinity */
1023  invlist_iterinit(ssc->invlist);
1024  ret = invlist_iternext(ssc->invlist, &start, &end)
1025   && start == 0
1026   && end == UV_MAX;
1027
1028  invlist_iterfinish(ssc->invlist);
1029
1030  if (ret) {
1031   return TRUE;
1032  }
1033
1034  /* If e.g., both \w and \W are set, matches everything */
1035  if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1036   int i;
1037   for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1038    if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1039     return TRUE;
1040    }
1041   }
1042  }
1043
1044  return FALSE;
1045 }
1046
1047 STATIC void
1048 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1049 {
1050  /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1051  * string, any code point, or any posix class under locale */
1052
1053  PERL_ARGS_ASSERT_SSC_INIT;
1054
1055  Zero(ssc, 1, regnode_ssc);
1056  set_ANYOF_SYNTHETIC(ssc);
1057  ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1058  ssc_anything(ssc);
1059
1060  /* If any portion of the regex is to operate under locale rules that aren't
1061  * fully known at compile time, initialization includes it.  The reason
1062  * this isn't done for all regexes is that the optimizer was written under
1063  * the assumption that locale was all-or-nothing.  Given the complexity and
1064  * lack of documentation in the optimizer, and that there are inadequate
1065  * test cases for locale, many parts of it may not work properly, it is
1066  * safest to avoid locale unless necessary. */
1067  if (RExC_contains_locale) {
1068   ANYOF_POSIXL_SETALL(ssc);
1069  }
1070  else {
1071   ANYOF_POSIXL_ZERO(ssc);
1072  }
1073 }
1074
1075 STATIC int
1076 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1077       const regnode_ssc *ssc)
1078 {
1079  /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1080  * to the list of code points matched, and locale posix classes; hence does
1081  * not check its flags) */
1082
1083  UV start, end;
1084  bool ret;
1085
1086  PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1087
1088  assert(is_ANYOF_SYNTHETIC(ssc));
1089
1090  invlist_iterinit(ssc->invlist);
1091  ret = invlist_iternext(ssc->invlist, &start, &end)
1092   && start == 0
1093   && end == UV_MAX;
1094
1095  invlist_iterfinish(ssc->invlist);
1096
1097  if (! ret) {
1098   return FALSE;
1099  }
1100
1101  if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1102   return FALSE;
1103  }
1104
1105  return TRUE;
1106 }
1107
1108 STATIC SV*
1109 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1110        const regnode_charclass* const node)
1111 {
1112  /* Returns a mortal inversion list defining which code points are matched
1113  * by 'node', which is of type ANYOF.  Handles complementing the result if
1114  * appropriate.  If some code points aren't knowable at this time, the
1115  * returned list must, and will, contain every code point that is a
1116  * possibility. */
1117
1118  SV* invlist = sv_2mortal(_new_invlist(0));
1119  SV* only_utf8_locale_invlist = NULL;
1120  unsigned int i;
1121  const U32 n = ARG(node);
1122  bool new_node_has_latin1 = FALSE;
1123
1124  PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1125
1126  /* Look at the data structure created by S_set_ANYOF_arg() */
1127  if (n != ANYOF_ONLY_HAS_BITMAP) {
1128   SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1129   AV * const av = MUTABLE_AV(SvRV(rv));
1130   SV **const ary = AvARRAY(av);
1131   assert(RExC_rxi->data->what[n] == 's');
1132
1133   if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1134    invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1135   }
1136   else if (ary[0] && ary[0] != &PL_sv_undef) {
1137
1138    /* Here, no compile-time swash, and there are things that won't be
1139    * known until runtime -- we have to assume it could be anything */
1140    return _add_range_to_invlist(invlist, 0, UV_MAX);
1141   }
1142   else if (ary[3] && ary[3] != &PL_sv_undef) {
1143
1144    /* Here no compile-time swash, and no run-time only data.  Use the
1145    * node's inversion list */
1146    invlist = sv_2mortal(invlist_clone(ary[3]));
1147   }
1148
1149   /* Get the code points valid only under UTF-8 locales */
1150   if ((ANYOF_FLAGS(node) & ANYOF_LOC_FOLD)
1151    && ary[2] && ary[2] != &PL_sv_undef)
1152   {
1153    only_utf8_locale_invlist = ary[2];
1154   }
1155  }
1156
1157  /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1158  * code points, and an inversion list for the others, but if there are code
1159  * points that should match only conditionally on the target string being
1160  * UTF-8, those are placed in the inversion list, and not the bitmap.
1161  * Since there are circumstances under which they could match, they are
1162  * included in the SSC.  But if the ANYOF node is to be inverted, we have
1163  * to exclude them here, so that when we invert below, the end result
1164  * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1165  * have to do this here before we add the unconditionally matched code
1166  * points */
1167  if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1168   _invlist_intersection_complement_2nd(invlist,
1169            PL_UpperLatin1,
1170            &invlist);
1171  }
1172
1173  /* Add in the points from the bit map */
1174  for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1175   if (ANYOF_BITMAP_TEST(node, i)) {
1176    invlist = add_cp_to_invlist(invlist, i);
1177    new_node_has_latin1 = TRUE;
1178   }
1179  }
1180
1181  /* If this can match all upper Latin1 code points, have to add them
1182  * as well */
1183  if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII) {
1184   _invlist_union(invlist, PL_UpperLatin1, &invlist);
1185  }
1186
1187  /* Similarly for these */
1188  if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1189   _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1190  }
1191
1192  if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1193   _invlist_invert(invlist);
1194  }
1195  else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOF_LOC_FOLD) {
1196
1197   /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1198   * locale.  We can skip this if there are no 0-255 at all. */
1199   _invlist_union(invlist, PL_Latin1, &invlist);
1200  }
1201
1202  /* Similarly add the UTF-8 locale possible matches.  These have to be
1203  * deferred until after the non-UTF-8 locale ones are taken care of just
1204  * above, or it leads to wrong results under ANYOF_INVERT */
1205  if (only_utf8_locale_invlist) {
1206   _invlist_union_maybe_complement_2nd(invlist,
1207            only_utf8_locale_invlist,
1208            ANYOF_FLAGS(node) & ANYOF_INVERT,
1209            &invlist);
1210  }
1211
1212  return invlist;
1213 }
1214
1215 /* These two functions currently do the exact same thing */
1216 #define ssc_init_zero  ssc_init
1217
1218 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1219 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1220
1221 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1222  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1223  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1224
1225 STATIC void
1226 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1227     const regnode_charclass *and_with)
1228 {
1229  /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1230  * another SSC or a regular ANYOF class.  Can create false positives. */
1231
1232  SV* anded_cp_list;
1233  U8  anded_flags;
1234
1235  PERL_ARGS_ASSERT_SSC_AND;
1236
1237  assert(is_ANYOF_SYNTHETIC(ssc));
1238
1239  /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1240  * the code point inversion list and just the relevant flags */
1241  if (is_ANYOF_SYNTHETIC(and_with)) {
1242   anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1243   anded_flags = ANYOF_FLAGS(and_with);
1244
1245   /* XXX This is a kludge around what appears to be deficiencies in the
1246   * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1247   * there are paths through the optimizer where it doesn't get weeded
1248   * out when it should.  And if we don't make some extra provision for
1249   * it like the code just below, it doesn't get added when it should.
1250   * This solution is to add it only when AND'ing, which is here, and
1251   * only when what is being AND'ed is the pristine, original node
1252   * matching anything.  Thus it is like adding it to ssc_anything() but
1253   * only when the result is to be AND'ed.  Probably the same solution
1254   * could be adopted for the same problem we have with /l matching,
1255   * which is solved differently in S_ssc_init(), and that would lead to
1256   * fewer false positives than that solution has.  But if this solution
1257   * creates bugs, the consequences are only that a warning isn't raised
1258   * that should be; while the consequences for having /l bugs is
1259   * incorrect matches */
1260   if (ssc_is_anything((regnode_ssc *)and_with)) {
1261    anded_flags |= ANYOF_WARN_SUPER;
1262   }
1263  }
1264  else {
1265   anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1266   anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1267  }
1268
1269  ANYOF_FLAGS(ssc) &= anded_flags;
1270
1271  /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1272  * C2 is the list of code points in 'and-with'; P2, its posix classes.
1273  * 'and_with' may be inverted.  When not inverted, we have the situation of
1274  * computing:
1275  *  (C1 | P1) & (C2 | P2)
1276  *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1277  *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1278  *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1279  *                    <=  ((C1 & C2) | P1 | P2)
1280  * Alternatively, the last few steps could be:
1281  *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1282  *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1283  *                    <=  (C1 | C2 | (P1 & P2))
1284  * We favor the second approach if either P1 or P2 is non-empty.  This is
1285  * because these components are a barrier to doing optimizations, as what
1286  * they match cannot be known until the moment of matching as they are
1287  * dependent on the current locale, 'AND"ing them likely will reduce or
1288  * eliminate them.
1289  * But we can do better if we know that C1,P1 are in their initial state (a
1290  * frequent occurrence), each matching everything:
1291  *  (<everything>) & (C2 | P2) =  C2 | P2
1292  * Similarly, if C2,P2 are in their initial state (again a frequent
1293  * occurrence), the result is a no-op
1294  *  (C1 | P1) & (<everything>) =  C1 | P1
1295  *
1296  * Inverted, we have
1297  *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1298  *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1299  *                         <=  (C1 & ~C2) | (P1 & ~P2)
1300  * */
1301
1302  if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1303   && ! is_ANYOF_SYNTHETIC(and_with))
1304  {
1305   unsigned int i;
1306
1307   ssc_intersection(ssc,
1308       anded_cp_list,
1309       FALSE /* Has already been inverted */
1310       );
1311
1312   /* If either P1 or P2 is empty, the intersection will be also; can skip
1313   * the loop */
1314   if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1315    ANYOF_POSIXL_ZERO(ssc);
1316   }
1317   else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1318
1319    /* Note that the Posix class component P from 'and_with' actually
1320    * looks like:
1321    *      P = Pa | Pb | ... | Pn
1322    * where each component is one posix class, such as in [\w\s].
1323    * Thus
1324    *      ~P = ~(Pa | Pb | ... | Pn)
1325    *         = ~Pa & ~Pb & ... & ~Pn
1326    *        <= ~Pa | ~Pb | ... | ~Pn
1327    * The last is something we can easily calculate, but unfortunately
1328    * is likely to have many false positives.  We could do better
1329    * in some (but certainly not all) instances if two classes in
1330    * P have known relationships.  For example
1331    *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1332    * So
1333    *      :lower: & :print: = :lower:
1334    * And similarly for classes that must be disjoint.  For example,
1335    * since \s and \w can have no elements in common based on rules in
1336    * the POSIX standard,
1337    *      \w & ^\S = nothing
1338    * Unfortunately, some vendor locales do not meet the Posix
1339    * standard, in particular almost everything by Microsoft.
1340    * The loop below just changes e.g., \w into \W and vice versa */
1341
1342    regnode_charclass_posixl temp;
1343    int add = 1;    /* To calculate the index of the complement */
1344
1345    ANYOF_POSIXL_ZERO(&temp);
1346    for (i = 0; i < ANYOF_MAX; i++) {
1347     assert(i % 2 != 0
1348      || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1349      || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1350
1351     if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1352      ANYOF_POSIXL_SET(&temp, i + add);
1353     }
1354     add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1355    }
1356    ANYOF_POSIXL_AND(&temp, ssc);
1357
1358   } /* else ssc already has no posixes */
1359  } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1360   in its initial state */
1361  else if (! is_ANYOF_SYNTHETIC(and_with)
1362    || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1363  {
1364   /* But if 'ssc' is in its initial state, the result is just 'and_with';
1365   * copy it over 'ssc' */
1366   if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1367    if (is_ANYOF_SYNTHETIC(and_with)) {
1368     StructCopy(and_with, ssc, regnode_ssc);
1369    }
1370    else {
1371     ssc->invlist = anded_cp_list;
1372     ANYOF_POSIXL_ZERO(ssc);
1373     if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1374      ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1375     }
1376    }
1377   }
1378   else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1379     || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
1380   {
1381    /* One or the other of P1, P2 is non-empty. */
1382    if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1383     ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1384    }
1385    ssc_union(ssc, anded_cp_list, FALSE);
1386   }
1387   else { /* P1 = P2 = empty */
1388    ssc_intersection(ssc, anded_cp_list, FALSE);
1389   }
1390  }
1391 }
1392
1393 STATIC void
1394 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1395    const regnode_charclass *or_with)
1396 {
1397  /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1398  * another SSC or a regular ANYOF class.  Can create false positives if
1399  * 'or_with' is to be inverted. */
1400
1401  SV* ored_cp_list;
1402  U8 ored_flags;
1403
1404  PERL_ARGS_ASSERT_SSC_OR;
1405
1406  assert(is_ANYOF_SYNTHETIC(ssc));
1407
1408  /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1409  * the code point inversion list and just the relevant flags */
1410  if (is_ANYOF_SYNTHETIC(or_with)) {
1411   ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1412   ored_flags = ANYOF_FLAGS(or_with);
1413  }
1414  else {
1415   ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1416   ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1417  }
1418
1419  ANYOF_FLAGS(ssc) |= ored_flags;
1420
1421  /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1422  * C2 is the list of code points in 'or-with'; P2, its posix classes.
1423  * 'or_with' may be inverted.  When not inverted, we have the simple
1424  * situation of computing:
1425  *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1426  * If P1|P2 yields a situation with both a class and its complement are
1427  * set, like having both \w and \W, this matches all code points, and we
1428  * can delete these from the P component of the ssc going forward.  XXX We
1429  * might be able to delete all the P components, but I (khw) am not certain
1430  * about this, and it is better to be safe.
1431  *
1432  * Inverted, we have
1433  *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1434  *                         <=  (C1 | P1) | ~C2
1435  *                         <=  (C1 | ~C2) | P1
1436  * (which results in actually simpler code than the non-inverted case)
1437  * */
1438
1439  if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1440   && ! is_ANYOF_SYNTHETIC(or_with))
1441  {
1442   /* We ignore P2, leaving P1 going forward */
1443  }   /* else  Not inverted */
1444  else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
1445   ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1446   if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1447    unsigned int i;
1448    for (i = 0; i < ANYOF_MAX; i += 2) {
1449     if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1450     {
1451      ssc_match_all_cp(ssc);
1452      ANYOF_POSIXL_CLEAR(ssc, i);
1453      ANYOF_POSIXL_CLEAR(ssc, i+1);
1454     }
1455    }
1456   }
1457  }
1458
1459  ssc_union(ssc,
1460    ored_cp_list,
1461    FALSE /* Already has been inverted */
1462    );
1463 }
1464
1465 PERL_STATIC_INLINE void
1466 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1467 {
1468  PERL_ARGS_ASSERT_SSC_UNION;
1469
1470  assert(is_ANYOF_SYNTHETIC(ssc));
1471
1472  _invlist_union_maybe_complement_2nd(ssc->invlist,
1473           invlist,
1474           invert2nd,
1475           &ssc->invlist);
1476 }
1477
1478 PERL_STATIC_INLINE void
1479 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1480       SV* const invlist,
1481       const bool invert2nd)
1482 {
1483  PERL_ARGS_ASSERT_SSC_INTERSECTION;
1484
1485  assert(is_ANYOF_SYNTHETIC(ssc));
1486
1487  _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1488            invlist,
1489            invert2nd,
1490            &ssc->invlist);
1491 }
1492
1493 PERL_STATIC_INLINE void
1494 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1495 {
1496  PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1497
1498  assert(is_ANYOF_SYNTHETIC(ssc));
1499
1500  ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1501 }
1502
1503 PERL_STATIC_INLINE void
1504 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1505 {
1506  /* AND just the single code point 'cp' into the SSC 'ssc' */
1507
1508  SV* cp_list = _new_invlist(2);
1509
1510  PERL_ARGS_ASSERT_SSC_CP_AND;
1511
1512  assert(is_ANYOF_SYNTHETIC(ssc));
1513
1514  cp_list = add_cp_to_invlist(cp_list, cp);
1515  ssc_intersection(ssc, cp_list,
1516      FALSE /* Not inverted */
1517      );
1518  SvREFCNT_dec_NN(cp_list);
1519 }
1520
1521 PERL_STATIC_INLINE void
1522 S_ssc_clear_locale(regnode_ssc *ssc)
1523 {
1524  /* Set the SSC 'ssc' to not match any locale things */
1525  PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1526
1527  assert(is_ANYOF_SYNTHETIC(ssc));
1528
1529  ANYOF_POSIXL_ZERO(ssc);
1530  ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1531 }
1532
1533 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1534
1535 STATIC bool
1536 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1537 {
1538  /* The synthetic start class is used to hopefully quickly winnow down
1539  * places where a pattern could start a match in the target string.  If it
1540  * doesn't really narrow things down that much, there isn't much point to
1541  * having the overhead of using it.  This function uses some very crude
1542  * heuristics to decide if to use the ssc or not.
1543  *
1544  * It returns TRUE if 'ssc' rules out more than half what it considers to
1545  * be the "likely" possible matches, but of course it doesn't know what the
1546  * actual things being matched are going to be; these are only guesses
1547  *
1548  * For /l matches, it assumes that the only likely matches are going to be
1549  *      in the 0-255 range, uniformly distributed, so half of that is 127
1550  * For /a and /d matches, it assumes that the likely matches will be just
1551  *      the ASCII range, so half of that is 63
1552  * For /u and there isn't anything matching above the Latin1 range, it
1553  *      assumes that that is the only range likely to be matched, and uses
1554  *      half that as the cut-off: 127.  If anything matches above Latin1,
1555  *      it assumes that all of Unicode could match (uniformly), except for
1556  *      non-Unicode code points and things in the General Category "Other"
1557  *      (unassigned, private use, surrogates, controls and formats).  This
1558  *      is a much large number. */
1559
1560  const U32 max_match = (LOC)
1561       ? 127
1562       : (! UNI_SEMANTICS)
1563        ? 63
1564        : (invlist_highest(ssc->invlist) < 256)
1565        ? 127
1566        : ((NON_OTHER_COUNT + 1) / 2) - 1;
1567  U32 count = 0;      /* Running total of number of code points matched by
1568       'ssc' */
1569  UV start, end;      /* Start and end points of current range in inversion
1570       list */
1571
1572  PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1573
1574  invlist_iterinit(ssc->invlist);
1575  while (invlist_iternext(ssc->invlist, &start, &end)) {
1576
1577   /* /u is the only thing that we expect to match above 255; so if not /u
1578   * and even if there are matches above 255, ignore them.  This catches
1579   * things like \d under /d which does match the digits above 255, but
1580   * since the pattern is /d, it is not likely to be expecting them */
1581   if (! UNI_SEMANTICS) {
1582    if (start > 255) {
1583     break;
1584    }
1585    end = MIN(end, 255);
1586   }
1587   count += end - start + 1;
1588   if (count > max_match) {
1589    invlist_iterfinish(ssc->invlist);
1590    return FALSE;
1591   }
1592  }
1593
1594  return TRUE;
1595 }
1596
1597
1598 STATIC void
1599 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1600 {
1601  /* The inversion list in the SSC is marked mortal; now we need a more
1602  * permanent copy, which is stored the same way that is done in a regular
1603  * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
1604  * map */
1605
1606  SV* invlist = invlist_clone(ssc->invlist);
1607
1608  PERL_ARGS_ASSERT_SSC_FINALIZE;
1609
1610  assert(is_ANYOF_SYNTHETIC(ssc));
1611
1612  /* The code in this file assumes that all but these flags aren't relevant
1613  * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
1614  * by the time we reach here */
1615  assert(! (ANYOF_FLAGS(ssc) & ~ANYOF_COMMON_FLAGS));
1616
1617  populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1618
1619  set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1620         NULL, NULL, NULL, FALSE);
1621
1622  /* Make sure is clone-safe */
1623  ssc->invlist = NULL;
1624
1625  if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1626   ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
1627  }
1628
1629  assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
1630 }
1631
1632 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1633 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1634 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1635 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
1636        ? (TRIE_LIST_CUR( idx ) - 1)           \
1637        : 0 )
1638
1639
1640 #ifdef DEBUGGING
1641 /*
1642    dump_trie(trie,widecharmap,revcharmap)
1643    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1644    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1645
1646    These routines dump out a trie in a somewhat readable format.
1647    The _interim_ variants are used for debugging the interim
1648    tables that are used to generate the final compressed
1649    representation which is what dump_trie expects.
1650
1651    Part of the reason for their existence is to provide a form
1652    of documentation as to how the different representations function.
1653
1654 */
1655
1656 /*
1657   Dumps the final compressed table form of the trie to Perl_debug_log.
1658   Used for debugging make_trie().
1659 */
1660
1661 STATIC void
1662 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1663    AV *revcharmap, U32 depth)
1664 {
1665  U32 state;
1666  SV *sv=sv_newmortal();
1667  int colwidth= widecharmap ? 6 : 4;
1668  U16 word;
1669  GET_RE_DEBUG_FLAGS_DECL;
1670
1671  PERL_ARGS_ASSERT_DUMP_TRIE;
1672
1673  PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1674   (int)depth * 2 + 2,"",
1675   "Match","Base","Ofs" );
1676
1677  for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1678   SV ** const tmp = av_fetch( revcharmap, state, 0);
1679   if ( tmp ) {
1680    PerlIO_printf( Perl_debug_log, "%*s",
1681     colwidth,
1682     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1683        PL_colors[0], PL_colors[1],
1684        (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1685        PERL_PV_ESCAPE_FIRSTCHAR
1686     )
1687    );
1688   }
1689  }
1690  PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1691   (int)depth * 2 + 2,"");
1692
1693  for( state = 0 ; state < trie->uniquecharcount ; state++ )
1694   PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1695  PerlIO_printf( Perl_debug_log, "\n");
1696
1697  for( state = 1 ; state < trie->statecount ; state++ ) {
1698   const U32 base = trie->states[ state ].trans.base;
1699
1700   PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|",
1701          (int)depth * 2 + 2,"", (UV)state);
1702
1703   if ( trie->states[ state ].wordnum ) {
1704    PerlIO_printf( Perl_debug_log, " W%4X",
1705           trie->states[ state ].wordnum );
1706   } else {
1707    PerlIO_printf( Perl_debug_log, "%6s", "" );
1708   }
1709
1710   PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1711
1712   if ( base ) {
1713    U32 ofs = 0;
1714
1715    while( ( base + ofs  < trie->uniquecharcount ) ||
1716     ( base + ofs - trie->uniquecharcount < trie->lasttrans
1717      && trie->trans[ base + ofs - trie->uniquecharcount ].check
1718                  != state))
1719      ofs++;
1720
1721    PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1722
1723    for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1724     if ( ( base + ofs >= trie->uniquecharcount )
1725       && ( base + ofs - trie->uniquecharcount
1726               < trie->lasttrans )
1727       && trie->trans[ base + ofs
1728          - trie->uniquecharcount ].check == state )
1729     {
1730     PerlIO_printf( Perl_debug_log, "%*"UVXf,
1731      colwidth,
1732      (UV)trie->trans[ base + ofs
1733            - trie->uniquecharcount ].next );
1734     } else {
1735      PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1736     }
1737    }
1738
1739    PerlIO_printf( Perl_debug_log, "]");
1740
1741   }
1742   PerlIO_printf( Perl_debug_log, "\n" );
1743  }
1744  PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=",
1745         (int)depth*2, "");
1746  for (word=1; word <= trie->wordcount; word++) {
1747   PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1748    (int)word, (int)(trie->wordinfo[word].prev),
1749    (int)(trie->wordinfo[word].len));
1750  }
1751  PerlIO_printf(Perl_debug_log, "\n" );
1752 }
1753 /*
1754   Dumps a fully constructed but uncompressed trie in list form.
1755   List tries normally only are used for construction when the number of
1756   possible chars (trie->uniquecharcount) is very high.
1757   Used for debugging make_trie().
1758 */
1759 STATIC void
1760 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1761       HV *widecharmap, AV *revcharmap, U32 next_alloc,
1762       U32 depth)
1763 {
1764  U32 state;
1765  SV *sv=sv_newmortal();
1766  int colwidth= widecharmap ? 6 : 4;
1767  GET_RE_DEBUG_FLAGS_DECL;
1768
1769  PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1770
1771  /* print out the table precompression.  */
1772  PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1773   (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1774   "------:-----+-----------------\n" );
1775
1776  for( state=1 ; state < next_alloc ; state ++ ) {
1777   U16 charid;
1778
1779   PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1780    (int)depth * 2 + 2,"", (UV)state  );
1781   if ( ! trie->states[ state ].wordnum ) {
1782    PerlIO_printf( Perl_debug_log, "%5s| ","");
1783   } else {
1784    PerlIO_printf( Perl_debug_log, "W%4x| ",
1785     trie->states[ state ].wordnum
1786    );
1787   }
1788   for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1789    SV ** const tmp = av_fetch( revcharmap,
1790           TRIE_LIST_ITEM(state,charid).forid, 0);
1791    if ( tmp ) {
1792     PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1793      colwidth,
1794      pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
1795        colwidth,
1796        PL_colors[0], PL_colors[1],
1797        (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
1798        | PERL_PV_ESCAPE_FIRSTCHAR
1799      ) ,
1800      TRIE_LIST_ITEM(state,charid).forid,
1801      (UV)TRIE_LIST_ITEM(state,charid).newstate
1802     );
1803     if (!(charid % 10))
1804      PerlIO_printf(Perl_debug_log, "\n%*s| ",
1805       (int)((depth * 2) + 14), "");
1806    }
1807   }
1808   PerlIO_printf( Perl_debug_log, "\n");
1809  }
1810 }
1811
1812 /*
1813   Dumps a fully constructed but uncompressed trie in table form.
1814   This is the normal DFA style state transition table, with a few
1815   twists to facilitate compression later.
1816   Used for debugging make_trie().
1817 */
1818 STATIC void
1819 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1820       HV *widecharmap, AV *revcharmap, U32 next_alloc,
1821       U32 depth)
1822 {
1823  U32 state;
1824  U16 charid;
1825  SV *sv=sv_newmortal();
1826  int colwidth= widecharmap ? 6 : 4;
1827  GET_RE_DEBUG_FLAGS_DECL;
1828
1829  PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1830
1831  /*
1832  print out the table precompression so that we can do a visual check
1833  that they are identical.
1834  */
1835
1836  PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1837
1838  for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1839   SV ** const tmp = av_fetch( revcharmap, charid, 0);
1840   if ( tmp ) {
1841    PerlIO_printf( Perl_debug_log, "%*s",
1842     colwidth,
1843     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1844        PL_colors[0], PL_colors[1],
1845        (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1846        PERL_PV_ESCAPE_FIRSTCHAR
1847     )
1848    );
1849   }
1850  }
1851
1852  PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1853
1854  for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1855   PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1856  }
1857
1858  PerlIO_printf( Perl_debug_log, "\n" );
1859
1860  for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1861
1862   PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1863    (int)depth * 2 + 2,"",
1864    (UV)TRIE_NODENUM( state ) );
1865
1866   for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1867    UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1868    if (v)
1869     PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1870    else
1871     PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1872   }
1873   if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1874    PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n",
1875            (UV)trie->trans[ state ].check );
1876   } else {
1877    PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n",
1878            (UV)trie->trans[ state ].check,
1879    trie->states[ TRIE_NODENUM( state ) ].wordnum );
1880   }
1881  }
1882 }
1883
1884 #endif
1885
1886
1887 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1888   startbranch: the first branch in the whole branch sequence
1889   first      : start branch of sequence of branch-exact nodes.
1890    May be the same as startbranch
1891   last       : Thing following the last branch.
1892    May be the same as tail.
1893   tail       : item following the branch sequence
1894   count      : words in the sequence
1895   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
1896   depth      : indent depth
1897
1898 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1899
1900 A trie is an N'ary tree where the branches are determined by digital
1901 decomposition of the key. IE, at the root node you look up the 1st character and
1902 follow that branch repeat until you find the end of the branches. Nodes can be
1903 marked as "accepting" meaning they represent a complete word. Eg:
1904
1905   /he|she|his|hers/
1906
1907 would convert into the following structure. Numbers represent states, letters
1908 following numbers represent valid transitions on the letter from that state, if
1909 the number is in square brackets it represents an accepting state, otherwise it
1910 will be in parenthesis.
1911
1912  +-h->+-e->[3]-+-r->(8)-+-s->[9]
1913  |    |
1914  |   (2)
1915  |    |
1916  (1)   +-i->(6)-+-s->[7]
1917  |
1918  +-s->(3)-+-h->(4)-+-e->[5]
1919
1920  Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1921
1922 This shows that when matching against the string 'hers' we will begin at state 1
1923 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1924 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1925 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1926 single traverse. We store a mapping from accepting to state to which word was
1927 matched, and then when we have multiple possibilities we try to complete the
1928 rest of the regex in the order in which they occurred in the alternation.
1929
1930 The only prior NFA like behaviour that would be changed by the TRIE support is
1931 the silent ignoring of duplicate alternations which are of the form:
1932
1933  / (DUPE|DUPE) X? (?{ ... }) Y /x
1934
1935 Thus EVAL blocks following a trie may be called a different number of times with
1936 and without the optimisation. With the optimisations dupes will be silently
1937 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1938 the following demonstrates:
1939
1940  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1941
1942 which prints out 'word' three times, but
1943
1944  'words'=~/(word|word|word)(?{ print $1 })S/
1945
1946 which doesnt print it out at all. This is due to other optimisations kicking in.
1947
1948 Example of what happens on a structural level:
1949
1950 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1951
1952    1: CURLYM[1] {1,32767}(18)
1953    5:   BRANCH(8)
1954    6:     EXACT <ac>(16)
1955    8:   BRANCH(11)
1956    9:     EXACT <ad>(16)
1957   11:   BRANCH(14)
1958   12:     EXACT <ab>(16)
1959   16:   SUCCEED(0)
1960   17:   NOTHING(18)
1961   18: END(0)
1962
1963 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1964 and should turn into:
1965
1966    1: CURLYM[1] {1,32767}(18)
1967    5:   TRIE(16)
1968   [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1969   <ac>
1970   <ad>
1971   <ab>
1972   16:   SUCCEED(0)
1973   17:   NOTHING(18)
1974   18: END(0)
1975
1976 Cases where tail != last would be like /(?foo|bar)baz/:
1977
1978    1: BRANCH(4)
1979    2:   EXACT <foo>(8)
1980    4: BRANCH(7)
1981    5:   EXACT <bar>(8)
1982    7: TAIL(8)
1983    8: EXACT <baz>(10)
1984   10: END(0)
1985
1986 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1987 and would end up looking like:
1988
1989  1: TRIE(8)
1990  [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1991   <foo>
1992   <bar>
1993    7: TAIL(8)
1994    8: EXACT <baz>(10)
1995   10: END(0)
1996
1997  d = uvchr_to_utf8_flags(d, uv, 0);
1998
1999 is the recommended Unicode-aware way of saying
2000
2001  *(d++) = uv;
2002 */
2003
2004 #define TRIE_STORE_REVCHAR(val)                                            \
2005  STMT_START {                                                           \
2006   if (UTF) {          \
2007    SV *zlopp = newSV(7); /* XXX: optimize me */                   \
2008    unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);    \
2009    unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
2010    SvCUR_set(zlopp, kapow - flrbbbbb);       \
2011    SvPOK_on(zlopp);         \
2012    SvUTF8_on(zlopp);         \
2013    av_push(revcharmap, zlopp);        \
2014   } else {          \
2015    char ooooff = (char)val;                                           \
2016    av_push(revcharmap, newSVpvn(&ooooff, 1));      \
2017   }           \
2018   } STMT_END
2019
2020 /* This gets the next character from the input, folding it if not already
2021  * folded. */
2022 #define TRIE_READ_CHAR STMT_START {                                           \
2023  wordlen++;                                                                \
2024  if ( UTF ) {                                                              \
2025   /* if it is UTF then it is either already folded, or does not need    \
2026   * folding */                                                         \
2027   uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2028  }                                                                         \
2029  else if (folder == PL_fold_latin1) {                                      \
2030   /* This folder implies Unicode rules, which in the range expressible  \
2031   *  by not UTF is the lower case, with the two exceptions, one of     \
2032   *  which should have been taken care of before calling this */       \
2033   assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2034   uvc = toLOWER_L1(*uc);                                                \
2035   if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2036   len = 1;                                                              \
2037  } else {                                                                  \
2038   /* raw data, will be folded later if needed */                        \
2039   uvc = (U32)*uc;                                                       \
2040   len = 1;                                                              \
2041  }                                                                         \
2042 } STMT_END
2043
2044
2045
2046 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2047  if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2048   U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
2049   Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2050  }                                                           \
2051  TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2052  TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2053  TRIE_LIST_CUR( state )++;                                   \
2054 } STMT_END
2055
2056 #define TRIE_LIST_NEW(state) STMT_START {                       \
2057  Newxz( trie->states[ state ].trans.list,               \
2058   4, reg_trie_trans_le );                                 \
2059  TRIE_LIST_CUR( state ) = 1;                                \
2060  TRIE_LIST_LEN( state ) = 4;                                \
2061 } STMT_END
2062
2063 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2064  U16 dupe= trie->states[ state ].wordnum;                    \
2065  regnode * const noper_next = regnext( noper );              \
2066                 \
2067  DEBUG_r({                                                   \
2068   /* store the word for dumping */                        \
2069   SV* tmp;                                                \
2070   if (OP(noper) != NOTHING)                               \
2071    tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF); \
2072   else                                                    \
2073    tmp = newSVpvn_utf8( "", 0, UTF );   \
2074   av_push( trie_words, tmp );                             \
2075  });                                                         \
2076                 \
2077  curword++;                                                  \
2078  trie->wordinfo[curword].prev   = 0;                         \
2079  trie->wordinfo[curword].len    = wordlen;                   \
2080  trie->wordinfo[curword].accept = state;                     \
2081                 \
2082  if ( noper_next < tail ) {                                  \
2083   if (!trie->jump)                                        \
2084    trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2085             sizeof(U16) ); \
2086   trie->jump[curword] = (U16)(noper_next - convert);      \
2087   if (!jumper)                                            \
2088    jumper = noper_next;                                \
2089   if (!nextbranch)                                        \
2090    nextbranch= regnext(cur);                           \
2091  }                                                           \
2092                 \
2093  if ( dupe ) {                                               \
2094   /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2095   /* chain, so that when the bits of chain are later    */\
2096   /* linked together, the dups appear in the chain      */\
2097   trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2098   trie->wordinfo[dupe].prev = curword;                    \
2099  } else {                                                    \
2100   /* we haven't inserted this word yet.                */ \
2101   trie->states[ state ].wordnum = curword;                \
2102  }                                                           \
2103 } STMT_END
2104
2105
2106 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)  \
2107  ( ( base + charid >=  ucharcount     \
2108   && base + charid < ubound     \
2109   && state == trie->trans[ base - ucharcount + charid ].check \
2110   && trie->trans[ base - ucharcount + charid ].next )  \
2111   ? trie->trans[ base - ucharcount + charid ].next  \
2112   : ( state==1 ? special : 0 )     \
2113  )
2114
2115 #define MADE_TRIE       1
2116 #define MADE_JUMP_TRIE  2
2117 #define MADE_EXACT_TRIE 4
2118
2119 STATIC I32
2120 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2121     regnode *first, regnode *last, regnode *tail,
2122     U32 word_count, U32 flags, U32 depth)
2123 {
2124  /* first pass, loop through and scan words */
2125  reg_trie_data *trie;
2126  HV *widecharmap = NULL;
2127  AV *revcharmap = newAV();
2128  regnode *cur;
2129  STRLEN len = 0;
2130  UV uvc = 0;
2131  U16 curword = 0;
2132  U32 next_alloc = 0;
2133  regnode *jumper = NULL;
2134  regnode *nextbranch = NULL;
2135  regnode *convert = NULL;
2136  U32 *prev_states; /* temp array mapping each state to previous one */
2137  /* we just use folder as a flag in utf8 */
2138  const U8 * folder = NULL;
2139
2140 #ifdef DEBUGGING
2141  const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuuu"));
2142  AV *trie_words = NULL;
2143  /* along with revcharmap, this only used during construction but both are
2144  * useful during debugging so we store them in the struct when debugging.
2145  */
2146 #else
2147  const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2148  STRLEN trie_charcount=0;
2149 #endif
2150  SV *re_trie_maxbuff;
2151  GET_RE_DEBUG_FLAGS_DECL;
2152
2153  PERL_ARGS_ASSERT_MAKE_TRIE;
2154 #ifndef DEBUGGING
2155  PERL_UNUSED_ARG(depth);
2156 #endif
2157
2158  switch (flags) {
2159   case EXACT: case EXACTL: break;
2160   case EXACTFA:
2161   case EXACTFU_SS:
2162   case EXACTFU:
2163   case EXACTFLU8: folder = PL_fold_latin1; break;
2164   case EXACTF:  folder = PL_fold; break;
2165   default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2166  }
2167
2168  trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2169  trie->refcount = 1;
2170  trie->startstate = 1;
2171  trie->wordcount = word_count;
2172  RExC_rxi->data->data[ data_slot ] = (void*)trie;
2173  trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2174  if (flags == EXACT || flags == EXACTL)
2175   trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2176  trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2177      trie->wordcount+1, sizeof(reg_trie_wordinfo));
2178
2179  DEBUG_r({
2180   trie_words = newAV();
2181  });
2182
2183  re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2184  assert(re_trie_maxbuff);
2185  if (!SvIOK(re_trie_maxbuff)) {
2186   sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2187  }
2188  DEBUG_TRIE_COMPILE_r({
2189   PerlIO_printf( Perl_debug_log,
2190   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2191   (int)depth * 2 + 2, "",
2192   REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2193   REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2194  });
2195
2196    /* Find the node we are going to overwrite */
2197  if ( first == startbranch && OP( last ) != BRANCH ) {
2198   /* whole branch chain */
2199   convert = first;
2200  } else {
2201   /* branch sub-chain */
2202   convert = NEXTOPER( first );
2203  }
2204
2205  /*  -- First loop and Setup --
2206
2207  We first traverse the branches and scan each word to determine if it
2208  contains widechars, and how many unique chars there are, this is
2209  important as we have to build a table with at least as many columns as we
2210  have unique chars.
2211
2212  We use an array of integers to represent the character codes 0..255
2213  (trie->charmap) and we use a an HV* to store Unicode characters. We use
2214  the native representation of the character value as the key and IV's for
2215  the coded index.
2216
2217  *TODO* If we keep track of how many times each character is used we can
2218  remap the columns so that the table compression later on is more
2219  efficient in terms of memory by ensuring the most common value is in the
2220  middle and the least common are on the outside.  IMO this would be better
2221  than a most to least common mapping as theres a decent chance the most
2222  common letter will share a node with the least common, meaning the node
2223  will not be compressible. With a middle is most common approach the worst
2224  case is when we have the least common nodes twice.
2225
2226  */
2227
2228  for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2229   regnode *noper = NEXTOPER( cur );
2230   const U8 *uc = (U8*)STRING( noper );
2231   const U8 *e  = uc + STR_LEN( noper );
2232   int foldlen = 0;
2233   U32 wordlen      = 0;         /* required init */
2234   STRLEN minchars = 0;
2235   STRLEN maxchars = 0;
2236   bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2237            bitmap?*/
2238
2239   if (OP(noper) == NOTHING) {
2240    regnode *noper_next= regnext(noper);
2241    if (noper_next != tail && OP(noper_next) == flags) {
2242     noper = noper_next;
2243     uc= (U8*)STRING(noper);
2244     e= uc + STR_LEN(noper);
2245     trie->minlen= STR_LEN(noper);
2246    } else {
2247     trie->minlen= 0;
2248     continue;
2249    }
2250   }
2251
2252   if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2253    TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2254           regardless of encoding */
2255    if (OP( noper ) == EXACTFU_SS) {
2256     /* false positives are ok, so just set this */
2257     TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2258    }
2259   }
2260   for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2261           branch */
2262    TRIE_CHARCOUNT(trie)++;
2263    TRIE_READ_CHAR;
2264
2265    /* TRIE_READ_CHAR returns the current character, or its fold if /i
2266    * is in effect.  Under /i, this character can match itself, or
2267    * anything that folds to it.  If not under /i, it can match just
2268    * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2269    * all fold to k, and all are single characters.   But some folds
2270    * expand to more than one character, so for example LATIN SMALL
2271    * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2272    * the string beginning at 'uc' is 'ffi', it could be matched by
2273    * three characters, or just by the one ligature character. (It
2274    * could also be matched by two characters: LATIN SMALL LIGATURE FF
2275    * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2276    * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2277    * match.)  The trie needs to know the minimum and maximum number
2278    * of characters that could match so that it can use size alone to
2279    * quickly reject many match attempts.  The max is simple: it is
2280    * the number of folded characters in this branch (since a fold is
2281    * never shorter than what folds to it. */
2282
2283    maxchars++;
2284
2285    /* And the min is equal to the max if not under /i (indicated by
2286    * 'folder' being NULL), or there are no multi-character folds.  If
2287    * there is a multi-character fold, the min is incremented just
2288    * once, for the character that folds to the sequence.  Each
2289    * character in the sequence needs to be added to the list below of
2290    * characters in the trie, but we count only the first towards the
2291    * min number of characters needed.  This is done through the
2292    * variable 'foldlen', which is returned by the macros that look
2293    * for these sequences as the number of bytes the sequence
2294    * occupies.  Each time through the loop, we decrement 'foldlen' by
2295    * how many bytes the current char occupies.  Only when it reaches
2296    * 0 do we increment 'minchars' or look for another multi-character
2297    * sequence. */
2298    if (folder == NULL) {
2299     minchars++;
2300    }
2301    else if (foldlen > 0) {
2302     foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2303    }
2304    else {
2305     minchars++;
2306
2307     /* See if *uc is the beginning of a multi-character fold.  If
2308     * so, we decrement the length remaining to look at, to account
2309     * for the current character this iteration.  (We can use 'uc'
2310     * instead of the fold returned by TRIE_READ_CHAR because for
2311     * non-UTF, the latin1_safe macro is smart enough to account
2312     * for all the unfolded characters, and because for UTF, the
2313     * string will already have been folded earlier in the
2314     * compilation process */
2315     if (UTF) {
2316      if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2317       foldlen -= UTF8SKIP(uc);
2318      }
2319     }
2320     else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2321      foldlen--;
2322     }
2323    }
2324
2325    /* The current character (and any potential folds) should be added
2326    * to the possible matching characters for this position in this
2327    * branch */
2328    if ( uvc < 256 ) {
2329     if ( folder ) {
2330      U8 folded= folder[ (U8) uvc ];
2331      if ( !trie->charmap[ folded ] ) {
2332       trie->charmap[ folded ]=( ++trie->uniquecharcount );
2333       TRIE_STORE_REVCHAR( folded );
2334      }
2335     }
2336     if ( !trie->charmap[ uvc ] ) {
2337      trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2338      TRIE_STORE_REVCHAR( uvc );
2339     }
2340     if ( set_bit ) {
2341      /* store the codepoint in the bitmap, and its folded
2342      * equivalent. */
2343      TRIE_BITMAP_SET(trie, uvc);
2344
2345      /* store the folded codepoint */
2346      if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
2347
2348      if ( !UTF ) {
2349       /* store first byte of utf8 representation of
2350       variant codepoints */
2351       if (! UVCHR_IS_INVARIANT(uvc)) {
2352        TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
2353       }
2354      }
2355      set_bit = 0; /* We've done our bit :-) */
2356     }
2357    } else {
2358
2359     /* XXX We could come up with the list of code points that fold
2360     * to this using PL_utf8_foldclosures, except not for
2361     * multi-char folds, as there may be multiple combinations
2362     * there that could work, which needs to wait until runtime to
2363     * resolve (The comment about LIGATURE FFI above is such an
2364     * example */
2365
2366     SV** svpp;
2367     if ( !widecharmap )
2368      widecharmap = newHV();
2369
2370     svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2371
2372     if ( !svpp )
2373      Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
2374
2375     if ( !SvTRUE( *svpp ) ) {
2376      sv_setiv( *svpp, ++trie->uniquecharcount );
2377      TRIE_STORE_REVCHAR(uvc);
2378     }
2379    }
2380   } /* end loop through characters in this branch of the trie */
2381
2382   /* We take the min and max for this branch and combine to find the min
2383   * and max for all branches processed so far */
2384   if( cur == first ) {
2385    trie->minlen = minchars;
2386    trie->maxlen = maxchars;
2387   } else if (minchars < trie->minlen) {
2388    trie->minlen = minchars;
2389   } else if (maxchars > trie->maxlen) {
2390    trie->maxlen = maxchars;
2391   }
2392  } /* end first pass */
2393  DEBUG_TRIE_COMPILE_r(
2394   PerlIO_printf( Perl_debug_log,
2395     "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2396     (int)depth * 2 + 2,"",
2397     ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2398     (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2399     (int)trie->minlen, (int)trie->maxlen )
2400  );
2401
2402  /*
2403   We now know what we are dealing with in terms of unique chars and
2404   string sizes so we can calculate how much memory a naive
2405   representation using a flat table  will take. If it's over a reasonable
2406   limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2407   conservative but potentially much slower representation using an array
2408   of lists.
2409
2410   At the end we convert both representations into the same compressed
2411   form that will be used in regexec.c for matching with. The latter
2412   is a form that cannot be used to construct with but has memory
2413   properties similar to the list form and access properties similar
2414   to the table form making it both suitable for fast searches and
2415   small enough that its feasable to store for the duration of a program.
2416
2417   See the comment in the code where the compressed table is produced
2418   inplace from the flat tabe representation for an explanation of how
2419   the compression works.
2420
2421  */
2422
2423
2424  Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2425  prev_states[1] = 0;
2426
2427  if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2428              > SvIV(re_trie_maxbuff) )
2429  {
2430   /*
2431    Second Pass -- Array Of Lists Representation
2432
2433    Each state will be represented by a list of charid:state records
2434    (reg_trie_trans_le) the first such element holds the CUR and LEN
2435    points of the allocated array. (See defines above).
2436
2437    We build the initial structure using the lists, and then convert
2438    it into the compressed table form which allows faster lookups
2439    (but cant be modified once converted).
2440   */
2441
2442   STRLEN transcount = 1;
2443
2444   DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2445    "%*sCompiling trie using list compiler\n",
2446    (int)depth * 2 + 2, ""));
2447
2448   trie->states = (reg_trie_state *)
2449    PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2450         sizeof(reg_trie_state) );
2451   TRIE_LIST_NEW(1);
2452   next_alloc = 2;
2453
2454   for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2455
2456    regnode *noper   = NEXTOPER( cur );
2457    U8 *uc           = (U8*)STRING( noper );
2458    const U8 *e      = uc + STR_LEN( noper );
2459    U32 state        = 1;         /* required init */
2460    U16 charid       = 0;         /* sanity init */
2461    U32 wordlen      = 0;         /* required init */
2462
2463    if (OP(noper) == NOTHING) {
2464     regnode *noper_next= regnext(noper);
2465     if (noper_next != tail && OP(noper_next) == flags) {
2466      noper = noper_next;
2467      uc= (U8*)STRING(noper);
2468      e= uc + STR_LEN(noper);
2469     }
2470    }
2471
2472    if (OP(noper) != NOTHING) {
2473     for ( ; uc < e ; uc += len ) {
2474
2475      TRIE_READ_CHAR;
2476
2477      if ( uvc < 256 ) {
2478       charid = trie->charmap[ uvc ];
2479      } else {
2480       SV** const svpp = hv_fetch( widecharmap,
2481              (char*)&uvc,
2482              sizeof( UV ),
2483              0);
2484       if ( !svpp ) {
2485        charid = 0;
2486       } else {
2487        charid=(U16)SvIV( *svpp );
2488       }
2489      }
2490      /* charid is now 0 if we dont know the char read, or
2491      * nonzero if we do */
2492      if ( charid ) {
2493
2494       U16 check;
2495       U32 newstate = 0;
2496
2497       charid--;
2498       if ( !trie->states[ state ].trans.list ) {
2499        TRIE_LIST_NEW( state );
2500       }
2501       for ( check = 1;
2502        check <= TRIE_LIST_USED( state );
2503        check++ )
2504       {
2505        if ( TRIE_LIST_ITEM( state, check ).forid
2506                  == charid )
2507        {
2508         newstate = TRIE_LIST_ITEM( state, check ).newstate;
2509         break;
2510        }
2511       }
2512       if ( ! newstate ) {
2513        newstate = next_alloc++;
2514        prev_states[newstate] = state;
2515        TRIE_LIST_PUSH( state, charid, newstate );
2516        transcount++;
2517       }
2518       state = newstate;
2519      } else {
2520       Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2521      }
2522     }
2523    }
2524    TRIE_HANDLE_WORD(state);
2525
2526   } /* end second pass */
2527
2528   /* next alloc is the NEXT state to be allocated */
2529   trie->statecount = next_alloc;
2530   trie->states = (reg_trie_state *)
2531    PerlMemShared_realloc( trie->states,
2532         next_alloc
2533         * sizeof(reg_trie_state) );
2534
2535   /* and now dump it out before we compress it */
2536   DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2537               revcharmap, next_alloc,
2538               depth+1)
2539   );
2540
2541   trie->trans = (reg_trie_trans *)
2542    PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2543   {
2544    U32 state;
2545    U32 tp = 0;
2546    U32 zp = 0;
2547
2548
2549    for( state=1 ; state < next_alloc ; state ++ ) {
2550     U32 base=0;
2551
2552     /*
2553     DEBUG_TRIE_COMPILE_MORE_r(
2554      PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
2555     );
2556     */
2557
2558     if (trie->states[state].trans.list) {
2559      U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2560      U16 maxid=minid;
2561      U16 idx;
2562
2563      for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2564       const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2565       if ( forid < minid ) {
2566        minid=forid;
2567       } else if ( forid > maxid ) {
2568        maxid=forid;
2569       }
2570      }
2571      if ( transcount < tp + maxid - minid + 1) {
2572       transcount *= 2;
2573       trie->trans = (reg_trie_trans *)
2574        PerlMemShared_realloc( trie->trans,
2575              transcount
2576              * sizeof(reg_trie_trans) );
2577       Zero( trie->trans + (transcount / 2),
2578        transcount / 2,
2579        reg_trie_trans );
2580      }
2581      base = trie->uniquecharcount + tp - minid;
2582      if ( maxid == minid ) {
2583       U32 set = 0;
2584       for ( ; zp < tp ; zp++ ) {
2585        if ( ! trie->trans[ zp ].next ) {
2586         base = trie->uniquecharcount + zp - minid;
2587         trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2588                 1).newstate;
2589         trie->trans[ zp ].check = state;
2590         set = 1;
2591         break;
2592        }
2593       }
2594       if ( !set ) {
2595        trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2596                 1).newstate;
2597        trie->trans[ tp ].check = state;
2598        tp++;
2599        zp = tp;
2600       }
2601      } else {
2602       for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2603        const U32 tid = base
2604           - trie->uniquecharcount
2605           + TRIE_LIST_ITEM( state, idx ).forid;
2606        trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2607                 idx ).newstate;
2608        trie->trans[ tid ].check = state;
2609       }
2610       tp += ( maxid - minid + 1 );
2611      }
2612      Safefree(trie->states[ state ].trans.list);
2613     }
2614     /*
2615     DEBUG_TRIE_COMPILE_MORE_r(
2616      PerlIO_printf( Perl_debug_log, " base: %d\n",base);
2617     );
2618     */
2619     trie->states[ state ].trans.base=base;
2620    }
2621    trie->lasttrans = tp + 1;
2622   }
2623  } else {
2624   /*
2625   Second Pass -- Flat Table Representation.
2626
2627   we dont use the 0 slot of either trans[] or states[] so we add 1 to
2628   each.  We know that we will need Charcount+1 trans at most to store
2629   the data (one row per char at worst case) So we preallocate both
2630   structures assuming worst case.
2631
2632   We then construct the trie using only the .next slots of the entry
2633   structs.
2634
2635   We use the .check field of the first entry of the node temporarily
2636   to make compression both faster and easier by keeping track of how
2637   many non zero fields are in the node.
2638
2639   Since trans are numbered from 1 any 0 pointer in the table is a FAIL
2640   transition.
2641
2642   There are two terms at use here: state as a TRIE_NODEIDX() which is
2643   a number representing the first entry of the node, and state as a
2644   TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
2645   and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
2646   if there are 2 entrys per node. eg:
2647
2648    A B       A B
2649   1. 2 4    1. 3 7
2650   2. 0 3    3. 0 5
2651   3. 0 0    5. 0 0
2652   4. 0 0    7. 0 0
2653
2654   The table is internally in the right hand, idx form. However as we
2655   also have to deal with the states array which is indexed by nodenum
2656   we have to use TRIE_NODENUM() to convert.
2657
2658   */
2659   DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2660    "%*sCompiling trie using table compiler\n",
2661    (int)depth * 2 + 2, ""));
2662
2663   trie->trans = (reg_trie_trans *)
2664    PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2665         * trie->uniquecharcount + 1,
2666         sizeof(reg_trie_trans) );
2667   trie->states = (reg_trie_state *)
2668    PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2669         sizeof(reg_trie_state) );
2670   next_alloc = trie->uniquecharcount + 1;
2671
2672
2673   for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2674
2675    regnode *noper   = NEXTOPER( cur );
2676    const U8 *uc     = (U8*)STRING( noper );
2677    const U8 *e      = uc + STR_LEN( noper );
2678
2679    U32 state        = 1;         /* required init */
2680
2681    U16 charid       = 0;         /* sanity init */
2682    U32 accept_state = 0;         /* sanity init */
2683
2684    U32 wordlen      = 0;         /* required init */
2685
2686    if (OP(noper) == NOTHING) {
2687     regnode *noper_next= regnext(noper);
2688     if (noper_next != tail && OP(noper_next) == flags) {
2689      noper = noper_next;
2690      uc= (U8*)STRING(noper);
2691      e= uc + STR_LEN(noper);
2692     }
2693    }
2694
2695    if ( OP(noper) != NOTHING ) {
2696     for ( ; uc < e ; uc += len ) {
2697
2698      TRIE_READ_CHAR;
2699
2700      if ( uvc < 256 ) {
2701       charid = trie->charmap[ uvc ];
2702      } else {
2703       SV* const * const svpp = hv_fetch( widecharmap,
2704               (char*)&uvc,
2705               sizeof( UV ),
2706               0);
2707       charid = svpp ? (U16)SvIV(*svpp) : 0;
2708      }
2709      if ( charid ) {
2710       charid--;
2711       if ( !trie->trans[ state + charid ].next ) {
2712        trie->trans[ state + charid ].next = next_alloc;
2713        trie->trans[ state ].check++;
2714        prev_states[TRIE_NODENUM(next_alloc)]
2715          = TRIE_NODENUM(state);
2716        next_alloc += trie->uniquecharcount;
2717       }
2718       state = trie->trans[ state + charid ].next;
2719      } else {
2720       Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2721      }
2722      /* charid is now 0 if we dont know the char read, or
2723      * nonzero if we do */
2724     }
2725    }
2726    accept_state = TRIE_NODENUM( state );
2727    TRIE_HANDLE_WORD(accept_state);
2728
2729   } /* end second pass */
2730
2731   /* and now dump it out before we compress it */
2732   DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2733               revcharmap,
2734               next_alloc, depth+1));
2735
2736   {
2737   /*
2738   * Inplace compress the table.*
2739
2740   For sparse data sets the table constructed by the trie algorithm will
2741   be mostly 0/FAIL transitions or to put it another way mostly empty.
2742   (Note that leaf nodes will not contain any transitions.)
2743
2744   This algorithm compresses the tables by eliminating most such
2745   transitions, at the cost of a modest bit of extra work during lookup:
2746
2747   - Each states[] entry contains a .base field which indicates the
2748   index in the state[] array wheres its transition data is stored.
2749
2750   - If .base is 0 there are no valid transitions from that node.
2751
2752   - If .base is nonzero then charid is added to it to find an entry in
2753   the trans array.
2754
2755   -If trans[states[state].base+charid].check!=state then the
2756   transition is taken to be a 0/Fail transition. Thus if there are fail
2757   transitions at the front of the node then the .base offset will point
2758   somewhere inside the previous nodes data (or maybe even into a node
2759   even earlier), but the .check field determines if the transition is
2760   valid.
2761
2762   XXX - wrong maybe?
2763   The following process inplace converts the table to the compressed
2764   table: We first do not compress the root node 1,and mark all its
2765   .check pointers as 1 and set its .base pointer as 1 as well. This
2766   allows us to do a DFA construction from the compressed table later,
2767   and ensures that any .base pointers we calculate later are greater
2768   than 0.
2769
2770   - We set 'pos' to indicate the first entry of the second node.
2771
2772   - We then iterate over the columns of the node, finding the first and
2773   last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2774   and set the .check pointers accordingly, and advance pos
2775   appropriately and repreat for the next node. Note that when we copy
2776   the next pointers we have to convert them from the original
2777   NODEIDX form to NODENUM form as the former is not valid post
2778   compression.
2779
2780   - If a node has no transitions used we mark its base as 0 and do not
2781   advance the pos pointer.
2782
2783   - If a node only has one transition we use a second pointer into the
2784   structure to fill in allocated fail transitions from other states.
2785   This pointer is independent of the main pointer and scans forward
2786   looking for null transitions that are allocated to a state. When it
2787   finds one it writes the single transition into the "hole".  If the
2788   pointer doesnt find one the single transition is appended as normal.
2789
2790   - Once compressed we can Renew/realloc the structures to release the
2791   excess space.
2792
2793   See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2794   specifically Fig 3.47 and the associated pseudocode.
2795
2796   demq
2797   */
2798   const U32 laststate = TRIE_NODENUM( next_alloc );
2799   U32 state, charid;
2800   U32 pos = 0, zp=0;
2801   trie->statecount = laststate;
2802
2803   for ( state = 1 ; state < laststate ; state++ ) {
2804    U8 flag = 0;
2805    const U32 stateidx = TRIE_NODEIDX( state );
2806    const U32 o_used = trie->trans[ stateidx ].check;
2807    U32 used = trie->trans[ stateidx ].check;
2808    trie->trans[ stateidx ].check = 0;
2809
2810    for ( charid = 0;
2811     used && charid < trie->uniquecharcount;
2812     charid++ )
2813    {
2814     if ( flag || trie->trans[ stateidx + charid ].next ) {
2815      if ( trie->trans[ stateidx + charid ].next ) {
2816       if (o_used == 1) {
2817        for ( ; zp < pos ; zp++ ) {
2818         if ( ! trie->trans[ zp ].next ) {
2819          break;
2820         }
2821        }
2822        trie->states[ state ].trans.base
2823              = zp
2824              + trie->uniquecharcount
2825              - charid ;
2826        trie->trans[ zp ].next
2827         = SAFE_TRIE_NODENUM( trie->trans[ stateidx
2828                + charid ].next );
2829        trie->trans[ zp ].check = state;
2830        if ( ++zp > pos ) pos = zp;
2831        break;
2832       }
2833       used--;
2834      }
2835      if ( !flag ) {
2836       flag = 1;
2837       trie->states[ state ].trans.base
2838          = pos + trie->uniquecharcount - charid ;
2839      }
2840      trie->trans[ pos ].next
2841       = SAFE_TRIE_NODENUM(
2842          trie->trans[ stateidx + charid ].next );
2843      trie->trans[ pos ].check = state;
2844      pos++;
2845     }
2846    }
2847   }
2848   trie->lasttrans = pos + 1;
2849   trie->states = (reg_trie_state *)
2850    PerlMemShared_realloc( trie->states, laststate
2851         * sizeof(reg_trie_state) );
2852   DEBUG_TRIE_COMPILE_MORE_r(
2853    PerlIO_printf( Perl_debug_log,
2854     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2855     (int)depth * 2 + 2,"",
2856     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
2857      + 1 ),
2858     (IV)next_alloc,
2859     (IV)pos,
2860     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2861    );
2862
2863   } /* end table compress */
2864  }
2865  DEBUG_TRIE_COMPILE_MORE_r(
2866    PerlIO_printf(Perl_debug_log,
2867     "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2868     (int)depth * 2 + 2, "",
2869     (UV)trie->statecount,
2870     (UV)trie->lasttrans)
2871  );
2872  /* resize the trans array to remove unused space */
2873  trie->trans = (reg_trie_trans *)
2874   PerlMemShared_realloc( trie->trans, trie->lasttrans
2875        * sizeof(reg_trie_trans) );
2876
2877  {   /* Modify the program and insert the new TRIE node */
2878   U8 nodetype =(U8)(flags & 0xFF);
2879   char *str=NULL;
2880
2881 #ifdef DEBUGGING
2882   regnode *optimize = NULL;
2883 #ifdef RE_TRACK_PATTERN_OFFSETS
2884
2885   U32 mjd_offset = 0;
2886   U32 mjd_nodelen = 0;
2887 #endif /* RE_TRACK_PATTERN_OFFSETS */
2888 #endif /* DEBUGGING */
2889   /*
2890   This means we convert either the first branch or the first Exact,
2891   depending on whether the thing following (in 'last') is a branch
2892   or not and whther first is the startbranch (ie is it a sub part of
2893   the alternation or is it the whole thing.)
2894   Assuming its a sub part we convert the EXACT otherwise we convert
2895   the whole branch sequence, including the first.
2896   */
2897   /* Find the node we are going to overwrite */
2898   if ( first != startbranch || OP( last ) == BRANCH ) {
2899    /* branch sub-chain */
2900    NEXT_OFF( first ) = (U16)(last - first);
2901 #ifdef RE_TRACK_PATTERN_OFFSETS
2902    DEBUG_r({
2903     mjd_offset= Node_Offset((convert));
2904     mjd_nodelen= Node_Length((convert));
2905    });
2906 #endif
2907    /* whole branch chain */
2908   }
2909 #ifdef RE_TRACK_PATTERN_OFFSETS
2910   else {
2911    DEBUG_r({
2912     const  regnode *nop = NEXTOPER( convert );
2913     mjd_offset= Node_Offset((nop));
2914     mjd_nodelen= Node_Length((nop));
2915    });
2916   }
2917   DEBUG_OPTIMISE_r(
2918    PerlIO_printf(Perl_debug_log,
2919     "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2920     (int)depth * 2 + 2, "",
2921     (UV)mjd_offset, (UV)mjd_nodelen)
2922   );
2923 #endif
2924   /* But first we check to see if there is a common prefix we can
2925   split out as an EXACT and put in front of the TRIE node.  */
2926   trie->startstate= 1;
2927   if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2928    U32 state;
2929    for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2930     U32 ofs = 0;
2931     I32 idx = -1;
2932     U32 count = 0;
2933     const U32 base = trie->states[ state ].trans.base;
2934
2935     if ( trie->states[state].wordnum )
2936       count = 1;
2937
2938     for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2939      if ( ( base + ofs >= trie->uniquecharcount ) &&
2940       ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2941       trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2942      {
2943       if ( ++count > 1 ) {
2944        SV **tmp = av_fetch( revcharmap, ofs, 0);
2945        const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2946        if ( state == 1 ) break;
2947        if ( count == 2 ) {
2948         Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2949         DEBUG_OPTIMISE_r(
2950          PerlIO_printf(Perl_debug_log,
2951           "%*sNew Start State=%"UVuf" Class: [",
2952           (int)depth * 2 + 2, "",
2953           (UV)state));
2954         if (idx >= 0) {
2955          SV ** const tmp = av_fetch( revcharmap, idx, 0);
2956          const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2957
2958          TRIE_BITMAP_SET(trie,*ch);
2959          if ( folder )
2960           TRIE_BITMAP_SET(trie, folder[ *ch ]);
2961          DEBUG_OPTIMISE_r(
2962           PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2963          );
2964         }
2965        }
2966        TRIE_BITMAP_SET(trie,*ch);
2967        if ( folder )
2968         TRIE_BITMAP_SET(trie,folder[ *ch ]);
2969        DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2970       }
2971       idx = ofs;
2972      }
2973     }
2974     if ( count == 1 ) {
2975      SV **tmp = av_fetch( revcharmap, idx, 0);
2976      STRLEN len;
2977      char *ch = SvPV( *tmp, len );
2978      DEBUG_OPTIMISE_r({
2979       SV *sv=sv_newmortal();
2980       PerlIO_printf( Perl_debug_log,
2981        "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2982        (int)depth * 2 + 2, "",
2983        (UV)state, (UV)idx,
2984        pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2985         PL_colors[0], PL_colors[1],
2986         (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2987         PERL_PV_ESCAPE_FIRSTCHAR
2988        )
2989       );
2990      });
2991      if ( state==1 ) {
2992       OP( convert ) = nodetype;
2993       str=STRING(convert);
2994       STR_LEN(convert)=0;
2995      }
2996      STR_LEN(convert) += len;
2997      while (len--)
2998       *str++ = *ch++;
2999     } else {
3000 #ifdef DEBUGGING
3001      if (state>1)
3002       DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
3003 #endif
3004      break;
3005     }
3006    }
3007    trie->prefixlen = (state-1);
3008    if (str) {
3009     regnode *n = convert+NODE_SZ_STR(convert);
3010     NEXT_OFF(convert) = NODE_SZ_STR(convert);
3011     trie->startstate = state;
3012     trie->minlen -= (state - 1);
3013     trie->maxlen -= (state - 1);
3014 #ifdef DEBUGGING
3015    /* At least the UNICOS C compiler choked on this
3016     * being argument to DEBUG_r(), so let's just have
3017     * it right here. */
3018    if (
3019 #ifdef PERL_EXT_RE_BUILD
3020     1
3021 #else
3022     DEBUG_r_TEST
3023 #endif
3024     ) {
3025     regnode *fix = convert;
3026     U32 word = trie->wordcount;
3027     mjd_nodelen++;
3028     Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3029     while( ++fix < n ) {
3030      Set_Node_Offset_Length(fix, 0, 0);
3031     }
3032     while (word--) {
3033      SV ** const tmp = av_fetch( trie_words, word, 0 );
3034      if (tmp) {
3035       if ( STR_LEN(convert) <= SvCUR(*tmp) )
3036        sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3037       else
3038        sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3039      }
3040     }
3041    }
3042 #endif
3043     if (trie->maxlen) {
3044      convert = n;
3045     } else {
3046      NEXT_OFF(convert) = (U16)(tail - convert);
3047      DEBUG_r(optimize= n);
3048     }
3049    }
3050   }
3051   if (!jumper)
3052    jumper = last;
3053   if ( trie->maxlen ) {
3054    NEXT_OFF( convert ) = (U16)(tail - convert);
3055    ARG_SET( convert, data_slot );
3056    /* Store the offset to the first unabsorbed branch in
3057    jump[0], which is otherwise unused by the jump logic.
3058    We use this when dumping a trie and during optimisation. */
3059    if (trie->jump)
3060     trie->jump[0] = (U16)(nextbranch - convert);
3061
3062    /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3063    *   and there is a bitmap
3064    *   and the first "jump target" node we found leaves enough room
3065    * then convert the TRIE node into a TRIEC node, with the bitmap
3066    * embedded inline in the opcode - this is hypothetically faster.
3067    */
3068    if ( !trie->states[trie->startstate].wordnum
3069     && trie->bitmap
3070     && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3071    {
3072     OP( convert ) = TRIEC;
3073     Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3074     PerlMemShared_free(trie->bitmap);
3075     trie->bitmap= NULL;
3076    } else
3077     OP( convert ) = TRIE;
3078
3079    /* store the type in the flags */
3080    convert->flags = nodetype;
3081    DEBUG_r({
3082    optimize = convert
3083      + NODE_STEP_REGNODE
3084      + regarglen[ OP( convert ) ];
3085    });
3086    /* XXX We really should free up the resource in trie now,
3087     as we won't use them - (which resources?) dmq */
3088   }
3089   /* needed for dumping*/
3090   DEBUG_r(if (optimize) {
3091    regnode *opt = convert;
3092
3093    while ( ++opt < optimize) {
3094     Set_Node_Offset_Length(opt,0,0);
3095    }
3096    /*
3097     Try to clean up some of the debris left after the
3098     optimisation.
3099    */
3100    while( optimize < jumper ) {
3101     mjd_nodelen += Node_Length((optimize));
3102     OP( optimize ) = OPTIMIZED;
3103     Set_Node_Offset_Length(optimize,0,0);
3104     optimize++;
3105    }
3106    Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
3107   });
3108  } /* end node insert */
3109  REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, convert);
3110
3111  /*  Finish populating the prev field of the wordinfo array.  Walk back
3112  *  from each accept state until we find another accept state, and if
3113  *  so, point the first word's .prev field at the second word. If the
3114  *  second already has a .prev field set, stop now. This will be the
3115  *  case either if we've already processed that word's accept state,
3116  *  or that state had multiple words, and the overspill words were
3117  *  already linked up earlier.
3118  */
3119  {
3120   U16 word;
3121   U32 state;
3122   U16 prev;
3123
3124   for (word=1; word <= trie->wordcount; word++) {
3125    prev = 0;
3126    if (trie->wordinfo[word].prev)
3127     continue;
3128    state = trie->wordinfo[word].accept;
3129    while (state) {
3130     state = prev_states[state];
3131     if (!state)
3132      break;
3133     prev = trie->states[state].wordnum;
3134     if (prev)
3135      break;
3136    }
3137    trie->wordinfo[word].prev = prev;
3138   }
3139   Safefree(prev_states);
3140  }
3141
3142
3143  /* and now dump out the compressed format */
3144  DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3145
3146  RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3147 #ifdef DEBUGGING
3148  RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3149  RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3150 #else
3151  SvREFCNT_dec_NN(revcharmap);
3152 #endif
3153  return trie->jump
3154   ? MADE_JUMP_TRIE
3155   : trie->startstate>1
3156    ? MADE_EXACT_TRIE
3157    : MADE_TRIE;
3158 }
3159
3160 STATIC regnode *
3161 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3162 {
3163 /* The Trie is constructed and compressed now so we can build a fail array if
3164  * it's needed
3165
3166    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3167    3.32 in the
3168    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3169    Ullman 1985/88
3170    ISBN 0-201-10088-6
3171
3172    We find the fail state for each state in the trie, this state is the longest
3173    proper suffix of the current state's 'word' that is also a proper prefix of
3174    another word in our trie. State 1 represents the word '' and is thus the
3175    default fail state. This allows the DFA not to have to restart after its
3176    tried and failed a word at a given point, it simply continues as though it
3177    had been matching the other word in the first place.
3178    Consider
3179  'abcdgu'=~/abcdefg|cdgu/
3180    When we get to 'd' we are still matching the first word, we would encounter
3181    'g' which would fail, which would bring us to the state representing 'd' in
3182    the second word where we would try 'g' and succeed, proceeding to match
3183    'cdgu'.
3184  */
3185  /* add a fail transition */
3186  const U32 trie_offset = ARG(source);
3187  reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3188  U32 *q;
3189  const U32 ucharcount = trie->uniquecharcount;
3190  const U32 numstates = trie->statecount;
3191  const U32 ubound = trie->lasttrans + ucharcount;
3192  U32 q_read = 0;
3193  U32 q_write = 0;
3194  U32 charid;
3195  U32 base = trie->states[ 1 ].trans.base;
3196  U32 *fail;
3197  reg_ac_data *aho;
3198  const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3199  regnode *stclass;
3200  GET_RE_DEBUG_FLAGS_DECL;
3201
3202  PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3203  PERL_UNUSED_CONTEXT;
3204 #ifndef DEBUGGING
3205  PERL_UNUSED_ARG(depth);
3206 #endif
3207
3208  if ( OP(source) == TRIE ) {
3209   struct regnode_1 *op = (struct regnode_1 *)
3210    PerlMemShared_calloc(1, sizeof(struct regnode_1));
3211   StructCopy(source,op,struct regnode_1);
3212   stclass = (regnode *)op;
3213  } else {
3214   struct regnode_charclass *op = (struct regnode_charclass *)
3215    PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3216   StructCopy(source,op,struct regnode_charclass);
3217   stclass = (regnode *)op;
3218  }
3219  OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3220
3221  ARG_SET( stclass, data_slot );
3222  aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3223  RExC_rxi->data->data[ data_slot ] = (void*)aho;
3224  aho->trie=trie_offset;
3225  aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3226  Copy( trie->states, aho->states, numstates, reg_trie_state );
3227  Newxz( q, numstates, U32);
3228  aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3229  aho->refcount = 1;
3230  fail = aho->fail;
3231  /* initialize fail[0..1] to be 1 so that we always have
3232  a valid final fail state */
3233  fail[ 0 ] = fail[ 1 ] = 1;
3234
3235  for ( charid = 0; charid < ucharcount ; charid++ ) {
3236   const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3237   if ( newstate ) {
3238    q[ q_write ] = newstate;
3239    /* set to point at the root */
3240    fail[ q[ q_write++ ] ]=1;
3241   }
3242  }
3243  while ( q_read < q_write) {
3244   const U32 cur = q[ q_read++ % numstates ];
3245   base = trie->states[ cur ].trans.base;
3246
3247   for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3248    const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3249    if (ch_state) {
3250     U32 fail_state = cur;
3251     U32 fail_base;
3252     do {
3253      fail_state = fail[ fail_state ];
3254      fail_base = aho->states[ fail_state ].trans.base;
3255     } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3256
3257     fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3258     fail[ ch_state ] = fail_state;
3259     if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3260     {
3261       aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3262     }
3263     q[ q_write++ % numstates] = ch_state;
3264    }
3265   }
3266  }
3267  /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3268  when we fail in state 1, this allows us to use the
3269  charclass scan to find a valid start char. This is based on the principle
3270  that theres a good chance the string being searched contains lots of stuff
3271  that cant be a start char.
3272  */
3273  fail[ 0 ] = fail[ 1 ] = 0;
3274  DEBUG_TRIE_COMPILE_r({
3275   PerlIO_printf(Perl_debug_log,
3276      "%*sStclass Failtable (%"UVuf" states): 0",
3277      (int)(depth * 2), "", (UV)numstates
3278   );
3279   for( q_read=1; q_read<numstates; q_read++ ) {
3280    PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
3281   }
3282   PerlIO_printf(Perl_debug_log, "\n");
3283  });
3284  Safefree(q);
3285  /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3286  return stclass;
3287 }
3288
3289
3290 #define DEBUG_PEEP(str,scan,depth) \
3291  DEBUG_OPTIMISE_r({if (scan){ \
3292  regnode *Next = regnext(scan); \
3293  regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state); \
3294  PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)", \
3295   (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),\
3296   Next ? (REG_NODE_NUM(Next)) : 0 ); \
3297  DEBUG_SHOW_STUDY_FLAGS(flags," [ ","]");\
3298  PerlIO_printf(Perl_debug_log, "\n"); \
3299    }});
3300
3301 /* The below joins as many adjacent EXACTish nodes as possible into a single
3302  * one.  The regop may be changed if the node(s) contain certain sequences that
3303  * require special handling.  The joining is only done if:
3304  * 1) there is room in the current conglomerated node to entirely contain the
3305  *    next one.
3306  * 2) they are the exact same node type
3307  *
3308  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3309  * these get optimized out
3310  *
3311  * If a node is to match under /i (folded), the number of characters it matches
3312  * can be different than its character length if it contains a multi-character
3313  * fold.  *min_subtract is set to the total delta number of characters of the
3314  * input nodes.
3315  *
3316  * And *unfolded_multi_char is set to indicate whether or not the node contains
3317  * an unfolded multi-char fold.  This happens when whether the fold is valid or
3318  * not won't be known until runtime; namely for EXACTF nodes that contain LATIN
3319  * SMALL LETTER SHARP S, as only if the target string being matched against
3320  * turns out to be UTF-8 is that fold valid; and also for EXACTFL nodes whose
3321  * folding rules depend on the locale in force at runtime.  (Multi-char folds
3322  * whose components are all above the Latin1 range are not run-time locale
3323  * dependent, and have already been folded by the time this function is
3324  * called.)
3325  *
3326  * This is as good a place as any to discuss the design of handling these
3327  * multi-character fold sequences.  It's been wrong in Perl for a very long
3328  * time.  There are three code points in Unicode whose multi-character folds
3329  * were long ago discovered to mess things up.  The previous designs for
3330  * dealing with these involved assigning a special node for them.  This
3331  * approach doesn't always work, as evidenced by this example:
3332  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3333  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3334  * would match just the \xDF, it won't be able to handle the case where a
3335  * successful match would have to cross the node's boundary.  The new approach
3336  * that hopefully generally solves the problem generates an EXACTFU_SS node
3337  * that is "sss" in this case.
3338  *
3339  * It turns out that there are problems with all multi-character folds, and not
3340  * just these three.  Now the code is general, for all such cases.  The
3341  * approach taken is:
3342  * 1)   This routine examines each EXACTFish node that could contain multi-
3343  *      character folded sequences.  Since a single character can fold into
3344  *      such a sequence, the minimum match length for this node is less than
3345  *      the number of characters in the node.  This routine returns in
3346  *      *min_subtract how many characters to subtract from the the actual
3347  *      length of the string to get a real minimum match length; it is 0 if
3348  *      there are no multi-char foldeds.  This delta is used by the caller to
3349  *      adjust the min length of the match, and the delta between min and max,
3350  *      so that the optimizer doesn't reject these possibilities based on size
3351  *      constraints.
3352  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3353  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3354  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3355  *      there is a possible fold length change.  That means that a regular
3356  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3357  *      with length changes, and so can be processed faster.  regexec.c takes
3358  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3359  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3360  *      known until runtime).  This saves effort in regex matching.  However,
3361  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3362  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3363  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3364  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3365  *      possibilities for the non-UTF8 patterns are quite simple, except for
3366  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3367  *      members of a fold-pair, and arrays are set up for all of them so that
3368  *      the other member of the pair can be found quickly.  Code elsewhere in
3369  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3370  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3371  *      described in the next item.
3372  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3373  *      validity of the fold won't be known until runtime, and so must remain
3374  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFA
3375  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3376  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3377  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3378  *      The reason this is a problem is that the optimizer part of regexec.c
3379  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3380  *      that a character in the pattern corresponds to at most a single
3381  *      character in the target string.  (And I do mean character, and not byte
3382  *      here, unlike other parts of the documentation that have never been
3383  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3384  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFA nodes
3385  *      it can match "\x{17F}\x{17F}".  These, along with other ones in EXACTFL
3386  *      nodes, violate the assumption, and they are the only instances where it
3387  *      is violated.  I'm reluctant to try to change the assumption, as the
3388  *      code involved is impenetrable to me (khw), so instead the code here
3389  *      punts.  This routine examines EXACTFL nodes, and (when the pattern
3390  *      isn't UTF-8) EXACTF and EXACTFA for such unfolded folds, and returns a
3391  *      boolean indicating whether or not the node contains such a fold.  When
3392  *      it is true, the caller sets a flag that later causes the optimizer in
3393  *      this file to not set values for the floating and fixed string lengths,
3394  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3395  *      assumption.  Thus, there is no optimization based on string lengths for
3396  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3397  *      EXACTF and EXACTFA nodes that contain the sharp s.  (The reason the
3398  *      assumption is wrong only in these cases is that all other non-UTF-8
3399  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3400  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3401  *      EXACTF nodes because we don't know at compile time if it actually
3402  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3403  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3404  *      always matches; and EXACTFA where it never does.  In an EXACTFA node in
3405  *      a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3406  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3407  *      string would require the pattern to be forced into UTF-8, the overhead
3408  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3409  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3410  *      locale.)
3411  *
3412  *      Similarly, the code that generates tries doesn't currently handle
3413  *      not-already-folded multi-char folds, and it looks like a pain to change
3414  *      that.  Therefore, trie generation of EXACTFA nodes with the sharp s
3415  *      doesn't work.  Instead, such an EXACTFA is turned into a new regnode,
3416  *      EXACTFA_NO_TRIE, which the trie code knows not to handle.  Most people
3417  *      using /iaa matching will be doing so almost entirely with ASCII
3418  *      strings, so this should rarely be encountered in practice */
3419
3420 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3421  if (PL_regkind[OP(scan)] == EXACT) \
3422   join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3423
3424 STATIC U32
3425 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3426     UV *min_subtract, bool *unfolded_multi_char,
3427     U32 flags,regnode *val, U32 depth)
3428 {
3429  /* Merge several consecutive EXACTish nodes into one. */
3430  regnode *n = regnext(scan);
3431  U32 stringok = 1;
3432  regnode *next = scan + NODE_SZ_STR(scan);
3433  U32 merged = 0;
3434  U32 stopnow = 0;
3435 #ifdef DEBUGGING
3436  regnode *stop = scan;
3437  GET_RE_DEBUG_FLAGS_DECL;
3438 #else
3439  PERL_UNUSED_ARG(depth);
3440 #endif
3441
3442  PERL_ARGS_ASSERT_JOIN_EXACT;
3443 #ifndef EXPERIMENTAL_INPLACESCAN
3444  PERL_UNUSED_ARG(flags);
3445  PERL_UNUSED_ARG(val);
3446 #endif
3447  DEBUG_PEEP("join",scan,depth);
3448
3449  /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3450  * EXACT ones that are mergeable to the current one. */
3451  while (n
3452   && (PL_regkind[OP(n)] == NOTHING
3453    || (stringok && OP(n) == OP(scan)))
3454   && NEXT_OFF(n)
3455   && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3456  {
3457
3458   if (OP(n) == TAIL || n > next)
3459    stringok = 0;
3460   if (PL_regkind[OP(n)] == NOTHING) {
3461    DEBUG_PEEP("skip:",n,depth);
3462    NEXT_OFF(scan) += NEXT_OFF(n);
3463    next = n + NODE_STEP_REGNODE;
3464 #ifdef DEBUGGING
3465    if (stringok)
3466     stop = n;
3467 #endif
3468    n = regnext(n);
3469   }
3470   else if (stringok) {
3471    const unsigned int oldl = STR_LEN(scan);
3472    regnode * const nnext = regnext(n);
3473
3474    /* XXX I (khw) kind of doubt that this works on platforms (should
3475    * Perl ever run on one) where U8_MAX is above 255 because of lots
3476    * of other assumptions */
3477    /* Don't join if the sum can't fit into a single node */
3478    if (oldl + STR_LEN(n) > U8_MAX)
3479     break;
3480
3481    DEBUG_PEEP("merg",n,depth);
3482    merged++;
3483
3484    NEXT_OFF(scan) += NEXT_OFF(n);
3485    STR_LEN(scan) += STR_LEN(n);
3486    next = n + NODE_SZ_STR(n);
3487    /* Now we can overwrite *n : */
3488    Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3489 #ifdef DEBUGGING
3490    stop = next - 1;
3491 #endif
3492    n = nnext;
3493    if (stopnow) break;
3494   }
3495
3496 #ifdef EXPERIMENTAL_INPLACESCAN
3497   if (flags && !NEXT_OFF(n)) {
3498    DEBUG_PEEP("atch", val, depth);
3499    if (reg_off_by_arg[OP(n)]) {
3500     ARG_SET(n, val - n);
3501    }
3502    else {
3503     NEXT_OFF(n) = val - n;
3504    }
3505    stopnow = 1;
3506   }
3507 #endif
3508  }
3509
3510  *min_subtract = 0;
3511  *unfolded_multi_char = FALSE;
3512
3513  /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3514  * can now analyze for sequences of problematic code points.  (Prior to
3515  * this final joining, sequences could have been split over boundaries, and
3516  * hence missed).  The sequences only happen in folding, hence for any
3517  * non-EXACT EXACTish node */
3518  if (OP(scan) != EXACT && OP(scan) != EXACTL) {
3519   U8* s0 = (U8*) STRING(scan);
3520   U8* s = s0;
3521   U8* s_end = s0 + STR_LEN(scan);
3522
3523   int total_count_delta = 0;  /* Total delta number of characters that
3524          multi-char folds expand to */
3525
3526   /* One pass is made over the node's string looking for all the
3527   * possibilities.  To avoid some tests in the loop, there are two main
3528   * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3529   * non-UTF-8 */
3530   if (UTF) {
3531    U8* folded = NULL;
3532
3533    if (OP(scan) == EXACTFL) {
3534     U8 *d;
3535
3536     /* An EXACTFL node would already have been changed to another
3537     * node type unless there is at least one character in it that
3538     * is problematic; likely a character whose fold definition
3539     * won't be known until runtime, and so has yet to be folded.
3540     * For all but the UTF-8 locale, folds are 1-1 in length, but
3541     * to handle the UTF-8 case, we need to create a temporary
3542     * folded copy using UTF-8 locale rules in order to analyze it.
3543     * This is because our macros that look to see if a sequence is
3544     * a multi-char fold assume everything is folded (otherwise the
3545     * tests in those macros would be too complicated and slow).
3546     * Note that here, the non-problematic folds will have already
3547     * been done, so we can just copy such characters.  We actually
3548     * don't completely fold the EXACTFL string.  We skip the
3549     * unfolded multi-char folds, as that would just create work
3550     * below to figure out the size they already are */
3551
3552     Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3553     d = folded;
3554     while (s < s_end) {
3555      STRLEN s_len = UTF8SKIP(s);
3556      if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3557       Copy(s, d, s_len, U8);
3558       d += s_len;
3559      }
3560      else if (is_FOLDS_TO_MULTI_utf8(s)) {
3561       *unfolded_multi_char = TRUE;
3562       Copy(s, d, s_len, U8);
3563       d += s_len;
3564      }
3565      else if (isASCII(*s)) {
3566       *(d++) = toFOLD(*s);
3567      }
3568      else {
3569       STRLEN len;
3570       _to_utf8_fold_flags(s, d, &len, FOLD_FLAGS_FULL);
3571       d += len;
3572      }
3573      s += s_len;
3574     }
3575
3576     /* Point the remainder of the routine to look at our temporary
3577     * folded copy */
3578     s = folded;
3579     s_end = d;
3580    } /* End of creating folded copy of EXACTFL string */
3581
3582    /* Examine the string for a multi-character fold sequence.  UTF-8
3583    * patterns have all characters pre-folded by the time this code is
3584    * executed */
3585    while (s < s_end - 1) /* Can stop 1 before the end, as minimum
3586          length sequence we are looking for is 2 */
3587    {
3588     int count = 0;  /* How many characters in a multi-char fold */
3589     int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
3590     if (! len) {    /* Not a multi-char fold: get next char */
3591      s += UTF8SKIP(s);
3592      continue;
3593     }
3594
3595     /* Nodes with 'ss' require special handling, except for
3596     * EXACTFA-ish for which there is no multi-char fold to this */
3597     if (len == 2 && *s == 's' && *(s+1) == 's'
3598      && OP(scan) != EXACTFA
3599      && OP(scan) != EXACTFA_NO_TRIE)
3600     {
3601      count = 2;
3602      if (OP(scan) != EXACTFL) {
3603       OP(scan) = EXACTFU_SS;
3604      }
3605      s += 2;
3606     }
3607     else { /* Here is a generic multi-char fold. */
3608      U8* multi_end  = s + len;
3609
3610      /* Count how many characters are in it.  In the case of
3611      * /aa, no folds which contain ASCII code points are
3612      * allowed, so check for those, and skip if found. */
3613      if (OP(scan) != EXACTFA && OP(scan) != EXACTFA_NO_TRIE) {
3614       count = utf8_length(s, multi_end);
3615       s = multi_end;
3616      }
3617      else {
3618       while (s < multi_end) {
3619        if (isASCII(*s)) {
3620         s++;
3621         goto next_iteration;
3622        }
3623        else {
3624         s += UTF8SKIP(s);
3625        }
3626        count++;
3627       }
3628      }
3629     }
3630
3631     /* The delta is how long the sequence is minus 1 (1 is how long
3632     * the character that folds to the sequence is) */
3633     total_count_delta += count - 1;
3634    next_iteration: ;
3635    }
3636
3637    /* We created a temporary folded copy of the string in EXACTFL
3638    * nodes.  Therefore we need to be sure it doesn't go below zero,
3639    * as the real string could be shorter */
3640    if (OP(scan) == EXACTFL) {
3641     int total_chars = utf8_length((U8*) STRING(scan),
3642           (U8*) STRING(scan) + STR_LEN(scan));
3643     if (total_count_delta > total_chars) {
3644      total_count_delta = total_chars;
3645     }
3646    }
3647
3648    *min_subtract += total_count_delta;
3649    Safefree(folded);
3650   }
3651   else if (OP(scan) == EXACTFA) {
3652
3653    /* Non-UTF-8 pattern, EXACTFA node.  There can't be a multi-char
3654    * fold to the ASCII range (and there are no existing ones in the
3655    * upper latin1 range).  But, as outlined in the comments preceding
3656    * this function, we need to flag any occurrences of the sharp s.
3657    * This character forbids trie formation (because of added
3658    * complexity) */
3659    while (s < s_end) {
3660     if (*s == LATIN_SMALL_LETTER_SHARP_S) {
3661      OP(scan) = EXACTFA_NO_TRIE;
3662      *unfolded_multi_char = TRUE;
3663      break;
3664     }
3665     s++;
3666     continue;
3667    }
3668   }
3669   else {
3670
3671    /* Non-UTF-8 pattern, not EXACTFA node.  Look for the multi-char
3672    * folds that are all Latin1.  As explained in the comments
3673    * preceding this function, we look also for the sharp s in EXACTF
3674    * and EXACTFL nodes; it can be in the final position.  Otherwise
3675    * we can stop looking 1 byte earlier because have to find at least
3676    * two characters for a multi-fold */
3677    const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
3678        ? s_end
3679        : s_end -1;
3680
3681    while (s < upper) {
3682     int len = is_MULTI_CHAR_FOLD_latin1_safe(s, s_end);
3683     if (! len) {    /* Not a multi-char fold. */
3684      if (*s == LATIN_SMALL_LETTER_SHARP_S
3685       && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
3686      {
3687       *unfolded_multi_char = TRUE;
3688      }
3689      s++;
3690      continue;
3691     }
3692
3693     if (len == 2
3694      && isALPHA_FOLD_EQ(*s, 's')
3695      && isALPHA_FOLD_EQ(*(s+1), 's'))
3696     {
3697
3698      /* EXACTF nodes need to know that the minimum length
3699      * changed so that a sharp s in the string can match this
3700      * ss in the pattern, but they remain EXACTF nodes, as they
3701      * won't match this unless the target string is is UTF-8,
3702      * which we don't know until runtime.  EXACTFL nodes can't
3703      * transform into EXACTFU nodes */
3704      if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
3705       OP(scan) = EXACTFU_SS;
3706      }
3707     }
3708
3709     *min_subtract += len - 1;
3710     s += len;
3711    }
3712   }
3713  }
3714
3715 #ifdef DEBUGGING
3716  /* Allow dumping but overwriting the collection of skipped
3717  * ops and/or strings with fake optimized ops */
3718  n = scan + NODE_SZ_STR(scan);
3719  while (n <= stop) {
3720   OP(n) = OPTIMIZED;
3721   FLAGS(n) = 0;
3722   NEXT_OFF(n) = 0;
3723   n++;
3724  }
3725 #endif
3726  DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
3727  return stopnow;
3728 }
3729
3730 /* REx optimizer.  Converts nodes into quicker variants "in place".
3731    Finds fixed substrings.  */
3732
3733 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
3734    to the position after last scanned or to NULL. */
3735
3736 #define INIT_AND_WITHP \
3737  assert(!and_withp); \
3738  Newx(and_withp,1, regnode_ssc); \
3739  SAVEFREEPV(and_withp)
3740
3741
3742 static void
3743 S_unwind_scan_frames(pTHX_ const void *p)
3744 {
3745  scan_frame *f= (scan_frame *)p;
3746  do {
3747   scan_frame *n= f->next_frame;
3748   Safefree(f);
3749   f= n;
3750  } while (f);
3751 }
3752
3753
3754 STATIC SSize_t
3755 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
3756       SSize_t *minlenp, SSize_t *deltap,
3757       regnode *last,
3758       scan_data_t *data,
3759       I32 stopparen,
3760       U32 recursed_depth,
3761       regnode_ssc *and_withp,
3762       U32 flags, U32 depth)
3763       /* scanp: Start here (read-write). */
3764       /* deltap: Write maxlen-minlen here. */
3765       /* last: Stop before this one. */
3766       /* data: string data about the pattern */
3767       /* stopparen: treat close N as END */
3768       /* recursed: which subroutines have we recursed into */
3769       /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3770 {
3771  /* There must be at least this number of characters to match */
3772  SSize_t min = 0;
3773  I32 pars = 0, code;
3774  regnode *scan = *scanp, *next;
3775  SSize_t delta = 0;
3776  int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3777  int is_inf_internal = 0;  /* The studied chunk is infinite */
3778  I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3779  scan_data_t data_fake;
3780  SV *re_trie_maxbuff = NULL;
3781  regnode *first_non_open = scan;
3782  SSize_t stopmin = SSize_t_MAX;
3783  scan_frame *frame = NULL;
3784  GET_RE_DEBUG_FLAGS_DECL;
3785
3786  PERL_ARGS_ASSERT_STUDY_CHUNK;
3787
3788
3789  if ( depth == 0 ) {
3790   while (first_non_open && OP(first_non_open) == OPEN)
3791    first_non_open=regnext(first_non_open);
3792  }
3793
3794
3795   fake_study_recurse:
3796  DEBUG_r(
3797   RExC_study_chunk_recursed_count++;
3798  );
3799  DEBUG_OPTIMISE_MORE_r(
3800  {
3801   PerlIO_printf(Perl_debug_log,
3802    "%*sstudy_chunk stopparen=%ld recursed_count=%lu depth=%lu recursed_depth=%lu scan=%p last=%p",
3803    (int)(depth*2), "", (long)stopparen,
3804    (unsigned long)RExC_study_chunk_recursed_count,
3805    (unsigned long)depth, (unsigned long)recursed_depth,
3806    scan,
3807    last);
3808   if (recursed_depth) {
3809    U32 i;
3810    U32 j;
3811    for ( j = 0 ; j < recursed_depth ; j++ ) {
3812     for ( i = 0 ; i < (U32)RExC_npar ; i++ ) {
3813      if (
3814       PAREN_TEST(RExC_study_chunk_recursed +
3815         ( j * RExC_study_chunk_recursed_bytes), i )
3816       && (
3817        !j ||
3818        !PAREN_TEST(RExC_study_chunk_recursed +
3819         (( j - 1 ) * RExC_study_chunk_recursed_bytes), i)
3820       )
3821      ) {
3822       PerlIO_printf(Perl_debug_log," %d",(int)i);
3823       break;
3824      }
3825     }
3826     if ( j + 1 < recursed_depth ) {
3827      PerlIO_printf(Perl_debug_log, ",");
3828     }
3829    }
3830   }
3831   PerlIO_printf(Perl_debug_log,"\n");
3832  }
3833  );
3834  while ( scan && OP(scan) != END && scan < last ){
3835   UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3836         node length to get a real minimum (because
3837         the folded version may be shorter) */
3838   bool unfolded_multi_char = FALSE;
3839   /* Peephole optimizer: */
3840   DEBUG_STUDYDATA("Peep:", data, depth);
3841   DEBUG_PEEP("Peep", scan, depth);
3842
3843
3844   /* The reason we do this here we need to deal with things like /(?:f)(?:o)(?:o)/
3845   * which cant be dealt with by the normal EXACT parsing code, as each (?:..) is handled
3846   * by a different invocation of reg() -- Yves
3847   */
3848   JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
3849
3850   /* Follow the next-chain of the current node and optimize
3851   away all the NOTHINGs from it.  */
3852   if (OP(scan) != CURLYX) {
3853    const int max = (reg_off_by_arg[OP(scan)]
3854      ? I32_MAX
3855      /* I32 may be smaller than U16 on CRAYs! */
3856      : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3857    int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3858    int noff;
3859    regnode *n = scan;
3860
3861    /* Skip NOTHING and LONGJMP. */
3862    while ((n = regnext(n))
3863     && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3864      || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3865     && off + noff < max)
3866     off += noff;
3867    if (reg_off_by_arg[OP(scan)])
3868     ARG(scan) = off;
3869    else
3870     NEXT_OFF(scan) = off;
3871   }
3872
3873   /* The principal pseudo-switch.  Cannot be a switch, since we
3874   look into several different things.  */
3875   if ( OP(scan) == DEFINEP ) {
3876    SSize_t minlen = 0;
3877    SSize_t deltanext = 0;
3878    SSize_t fake_last_close = 0;
3879    I32 f = SCF_IN_DEFINE;
3880
3881    StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3882    scan = regnext(scan);
3883    assert( OP(scan) == IFTHEN );
3884    DEBUG_PEEP("expect IFTHEN", scan, depth);
3885
3886    data_fake.last_closep= &fake_last_close;
3887    minlen = *minlenp;
3888    next = regnext(scan);
3889    scan = NEXTOPER(NEXTOPER(scan));
3890    DEBUG_PEEP("scan", scan, depth);
3891    DEBUG_PEEP("next", next, depth);
3892
3893    /* we suppose the run is continuous, last=next...
3894    * NOTE we dont use the return here! */
3895    (void)study_chunk(pRExC_state, &scan, &minlen,
3896        &deltanext, next, &data_fake, stopparen,
3897        recursed_depth, NULL, f, depth+1);
3898
3899    scan = next;
3900   } else
3901   if (
3902    OP(scan) == BRANCH  ||
3903    OP(scan) == BRANCHJ ||
3904    OP(scan) == IFTHEN
3905   ) {
3906    next = regnext(scan);
3907    code = OP(scan);
3908
3909    /* The op(next)==code check below is to see if we
3910    * have "BRANCH-BRANCH", "BRANCHJ-BRANCHJ", "IFTHEN-IFTHEN"
3911    * IFTHEN is special as it might not appear in pairs.
3912    * Not sure whether BRANCH-BRANCHJ is possible, regardless
3913    * we dont handle it cleanly. */
3914    if (OP(next) == code || code == IFTHEN) {
3915     /* NOTE - There is similar code to this block below for
3916     * handling TRIE nodes on a re-study.  If you change stuff here
3917     * check there too. */
3918     SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
3919     regnode_ssc accum;
3920     regnode * const startbranch=scan;
3921
3922     if (flags & SCF_DO_SUBSTR) {
3923      /* Cannot merge strings after this. */
3924      scan_commit(pRExC_state, data, minlenp, is_inf);
3925     }
3926
3927     if (flags & SCF_DO_STCLASS)
3928      ssc_init_zero(pRExC_state, &accum);
3929
3930     while (OP(scan) == code) {
3931      SSize_t deltanext, minnext, fake;
3932      I32 f = 0;
3933      regnode_ssc this_class;
3934
3935      DEBUG_PEEP("Branch", scan, depth);
3936
3937      num++;
3938      StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3939      if (data) {
3940       data_fake.whilem_c = data->whilem_c;
3941       data_fake.last_closep = data->last_closep;
3942      }
3943      else
3944       data_fake.last_closep = &fake;
3945
3946      data_fake.pos_delta = delta;
3947      next = regnext(scan);
3948
3949      scan = NEXTOPER(scan); /* everything */
3950      if (code != BRANCH)    /* everything but BRANCH */
3951       scan = NEXTOPER(scan);
3952
3953      if (flags & SCF_DO_STCLASS) {
3954       ssc_init(pRExC_state, &this_class);
3955       data_fake.start_class = &this_class;
3956       f = SCF_DO_STCLASS_AND;
3957      }
3958      if (flags & SCF_WHILEM_VISITED_POS)
3959       f |= SCF_WHILEM_VISITED_POS;
3960
3961      /* we suppose the run is continuous, last=next...*/
3962      minnext = study_chunk(pRExC_state, &scan, minlenp,
3963          &deltanext, next, &data_fake, stopparen,
3964          recursed_depth, NULL, f,depth+1);
3965
3966      if (min1 > minnext)
3967       min1 = minnext;
3968      if (deltanext == SSize_t_MAX) {
3969       is_inf = is_inf_internal = 1;
3970       max1 = SSize_t_MAX;
3971      } else if (max1 < minnext + deltanext)
3972       max1 = minnext + deltanext;
3973      scan = next;
3974      if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3975       pars++;
3976      if (data_fake.flags & SCF_SEEN_ACCEPT) {
3977       if ( stopmin > minnext)
3978        stopmin = min + min1;
3979       flags &= ~SCF_DO_SUBSTR;
3980       if (data)
3981        data->flags |= SCF_SEEN_ACCEPT;
3982      }
3983      if (data) {
3984       if (data_fake.flags & SF_HAS_EVAL)
3985        data->flags |= SF_HAS_EVAL;
3986       data->whilem_c = data_fake.whilem_c;
3987      }
3988      if (flags & SCF_DO_STCLASS)
3989       ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
3990     }
3991     if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3992      min1 = 0;
3993     if (flags & SCF_DO_SUBSTR) {
3994      data->pos_min += min1;
3995      if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
3996       data->pos_delta = SSize_t_MAX;
3997      else
3998       data->pos_delta += max1 - min1;
3999      if (max1 != min1 || is_inf)
4000       data->longest = &(data->longest_float);
4001     }
4002     min += min1;
4003     if (delta == SSize_t_MAX
4004     || SSize_t_MAX - delta - (max1 - min1) < 0)
4005      delta = SSize_t_MAX;
4006     else
4007      delta += max1 - min1;
4008     if (flags & SCF_DO_STCLASS_OR) {
4009      ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
4010      if (min1) {
4011       ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4012       flags &= ~SCF_DO_STCLASS;
4013      }
4014     }
4015     else if (flags & SCF_DO_STCLASS_AND) {
4016      if (min1) {
4017       ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
4018       flags &= ~SCF_DO_STCLASS;
4019      }
4020      else {
4021       /* Switch to OR mode: cache the old value of
4022       * data->start_class */
4023       INIT_AND_WITHP;
4024       StructCopy(data->start_class, and_withp, regnode_ssc);
4025       flags &= ~SCF_DO_STCLASS_AND;
4026       StructCopy(&accum, data->start_class, regnode_ssc);
4027       flags |= SCF_DO_STCLASS_OR;
4028      }
4029     }
4030
4031     if (PERL_ENABLE_TRIE_OPTIMISATION &&
4032       OP( startbranch ) == BRANCH )
4033     {
4034     /* demq.
4035
4036     Assuming this was/is a branch we are dealing with: 'scan'
4037     now points at the item that follows the branch sequence,
4038     whatever it is. We now start at the beginning of the
4039     sequence and look for subsequences of
4040
4041     BRANCH->EXACT=>x1
4042     BRANCH->EXACT=>x2
4043     tail
4044
4045     which would be constructed from a pattern like
4046     /A|LIST|OF|WORDS/
4047
4048     If we can find such a subsequence we need to turn the first
4049     element into a trie and then add the subsequent branch exact
4050     strings to the trie.
4051
4052     We have two cases
4053
4054      1. patterns where the whole set of branches can be
4055       converted.
4056
4057      2. patterns where only a subset can be converted.
4058
4059     In case 1 we can replace the whole set with a single regop
4060     for the trie. In case 2 we need to keep the start and end
4061     branches so
4062
4063      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
4064      becomes BRANCH TRIE; BRANCH X;
4065
4066     There is an additional case, that being where there is a
4067     common prefix, which gets split out into an EXACT like node
4068     preceding the TRIE node.
4069
4070     If x(1..n)==tail then we can do a simple trie, if not we make
4071     a "jump" trie, such that when we match the appropriate word
4072     we "jump" to the appropriate tail node. Essentially we turn
4073     a nested if into a case structure of sorts.
4074
4075     */
4076
4077      int made=0;
4078      if (!re_trie_maxbuff) {
4079       re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
4080       if (!SvIOK(re_trie_maxbuff))
4081        sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
4082      }
4083      if ( SvIV(re_trie_maxbuff)>=0  ) {
4084       regnode *cur;
4085       regnode *first = (regnode *)NULL;
4086       regnode *last = (regnode *)NULL;
4087       regnode *tail = scan;
4088       U8 trietype = 0;
4089       U32 count=0;
4090
4091       /* var tail is used because there may be a TAIL
4092       regop in the way. Ie, the exacts will point to the
4093       thing following the TAIL, but the last branch will
4094       point at the TAIL. So we advance tail. If we
4095       have nested (?:) we may have to move through several
4096       tails.
4097       */
4098
4099       while ( OP( tail ) == TAIL ) {
4100        /* this is the TAIL generated by (?:) */
4101        tail = regnext( tail );
4102       }
4103
4104
4105       DEBUG_TRIE_COMPILE_r({
4106        regprop(RExC_rx, RExC_mysv, tail, NULL, pRExC_state);
4107        PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
4108        (int)depth * 2 + 2, "",
4109        "Looking for TRIE'able sequences. Tail node is: ",
4110        SvPV_nolen_const( RExC_mysv )
4111        );
4112       });
4113
4114       /*
4115
4116        Step through the branches
4117         cur represents each branch,
4118         noper is the first thing to be matched as part
4119          of that branch
4120         noper_next is the regnext() of that node.
4121
4122        We normally handle a case like this
4123        /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
4124        support building with NOJUMPTRIE, which restricts
4125        the trie logic to structures like /FOO|BAR/.
4126
4127        If noper is a trieable nodetype then the branch is
4128        a possible optimization target. If we are building
4129        under NOJUMPTRIE then we require that noper_next is
4130        the same as scan (our current position in the regex
4131        program).
4132
4133        Once we have two or more consecutive such branches
4134        we can create a trie of the EXACT's contents and
4135        stitch it in place into the program.
4136
4137        If the sequence represents all of the branches in
4138        the alternation we replace the entire thing with a
4139        single TRIE node.
4140
4141        Otherwise when it is a subsequence we need to
4142        stitch it in place and replace only the relevant
4143        branches. This means the first branch has to remain
4144        as it is used by the alternation logic, and its
4145        next pointer, and needs to be repointed at the item
4146        on the branch chain following the last branch we
4147        have optimized away.
4148
4149        This could be either a BRANCH, in which case the
4150        subsequence is internal, or it could be the item
4151        following the branch sequence in which case the
4152        subsequence is at the end (which does not
4153        necessarily mean the first node is the start of the
4154        alternation).
4155
4156        TRIE_TYPE(X) is a define which maps the optype to a
4157        trietype.
4158
4159         optype          |  trietype
4160         ----------------+-----------
4161         NOTHING         | NOTHING
4162         EXACT           | EXACT
4163         EXACTFU         | EXACTFU
4164         EXACTFU_SS      | EXACTFU
4165         EXACTFA         | EXACTFA
4166         EXACTL          | EXACTL
4167         EXACTFLU8       | EXACTFLU8
4168
4169
4170       */
4171 #define TRIE_TYPE(X) ( ( NOTHING == (X) )                                   \
4172      ? NOTHING                                            \
4173      : ( EXACT == (X) )                                   \
4174       ? EXACT                                            \
4175       : ( EXACTFU == (X) || EXACTFU_SS == (X) )          \
4176       ? EXACTFU                                        \
4177       : ( EXACTFA == (X) )                             \
4178        ? EXACTFA                                      \
4179        : ( EXACTL == (X) )                            \
4180        ? EXACTL                                     \
4181        : ( EXACTFLU8 == (X) )                        \
4182         ? EXACTFLU8                                 \
4183         : 0 )
4184
4185       /* dont use tail as the end marker for this traverse */
4186       for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
4187        regnode * const noper = NEXTOPER( cur );
4188        U8 noper_type = OP( noper );
4189        U8 noper_trietype = TRIE_TYPE( noper_type );
4190 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
4191        regnode * const noper_next = regnext( noper );
4192        U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;
4193        U8 noper_next_trietype = (noper_next && noper_next != tail) ? TRIE_TYPE( noper_next_type ) :0;
4194 #endif
4195
4196        DEBUG_TRIE_COMPILE_r({
4197         regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4198         PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
4199         (int)depth * 2 + 2,"", SvPV_nolen_const( RExC_mysv ), REG_NODE_NUM(cur) );
4200
4201         regprop(RExC_rx, RExC_mysv, noper, NULL, pRExC_state);
4202         PerlIO_printf( Perl_debug_log, " -> %s",
4203          SvPV_nolen_const(RExC_mysv));
4204
4205         if ( noper_next ) {
4206         regprop(RExC_rx, RExC_mysv, noper_next, NULL, pRExC_state);
4207         PerlIO_printf( Perl_debug_log,"\t=> %s\t",
4208          SvPV_nolen_const(RExC_mysv));
4209         }
4210         PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d,tt==%s,nt==%s,nnt==%s)\n",
4211         REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur),
4212         PL_reg_name[trietype], PL_reg_name[noper_trietype], PL_reg_name[noper_next_trietype]
4213         );
4214        });
4215
4216        /* Is noper a trieable nodetype that can be merged
4217        * with the current trie (if there is one)? */
4218        if ( noper_trietype
4219         &&
4220         (
4221           ( noper_trietype == NOTHING)
4222           || ( trietype == NOTHING )
4223           || ( trietype == noper_trietype )
4224         )
4225 #ifdef NOJUMPTRIE
4226         && noper_next == tail
4227 #endif
4228         && count < U16_MAX)
4229        {
4230         /* Handle mergable triable node Either we are
4231         * the first node in a new trieable sequence,
4232         * in which case we do some bookkeeping,
4233         * otherwise we update the end pointer. */
4234         if ( !first ) {
4235          first = cur;
4236          if ( noper_trietype == NOTHING ) {
4237 #if !defined(DEBUGGING) && !defined(NOJUMPTRIE)
4238           regnode * const noper_next = regnext( noper );
4239           U8 noper_next_type = (noper_next && noper_next!=tail) ? OP(noper_next) : 0;
4240           U8 noper_next_trietype = noper_next_type ? TRIE_TYPE( noper_next_type ) :0;
4241 #endif
4242
4243           if ( noper_next_trietype ) {
4244            trietype = noper_next_trietype;
4245           } else if (noper_next_type)  {
4246            /* a NOTHING regop is 1 regop wide.
4247            * We need at least two for a trie
4248            * so we can't merge this in */
4249            first = NULL;
4250           }
4251          } else {
4252           trietype = noper_trietype;
4253          }
4254         } else {
4255          if ( trietype == NOTHING )
4256           trietype = noper_trietype;
4257          last = cur;
4258         }
4259         if (first)
4260          count++;
4261        } /* end handle mergable triable node */
4262        else {
4263         /* handle unmergable node -
4264         * noper may either be a triable node which can
4265         * not be tried together with the current trie,
4266         * or a non triable node */
4267         if ( last ) {
4268          /* If last is set and trietype is not
4269          * NOTHING then we have found at least two
4270          * triable branch sequences in a row of a
4271          * similar trietype so we can turn them
4272          * into a trie. If/when we allow NOTHING to
4273          * start a trie sequence this condition
4274          * will be required, and it isn't expensive
4275          * so we leave it in for now. */
4276          if ( trietype && trietype != NOTHING )
4277           make_trie( pRExC_state,
4278             startbranch, first, cur, tail,
4279             count, trietype, depth+1 );
4280          last = NULL; /* note: we clear/update
4281              first, trietype etc below,
4282              so we dont do it here */
4283         }
4284         if ( noper_trietype
4285 #ifdef NOJUMPTRIE
4286          && noper_next == tail
4287 #endif
4288         ){
4289          /* noper is triable, so we can start a new
4290          * trie sequence */
4291          count = 1;
4292          first = cur;
4293          trietype = noper_trietype;
4294         } else if (first) {
4295          /* if we already saw a first but the
4296          * current node is not triable then we have
4297          * to reset the first information. */
4298          count = 0;
4299          first = NULL;
4300          trietype = 0;
4301         }
4302        } /* end handle unmergable node */
4303       } /* loop over branches */
4304       DEBUG_TRIE_COMPILE_r({
4305        regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4306        PerlIO_printf( Perl_debug_log,
4307        "%*s- %s (%d) <SCAN FINISHED>\n",
4308        (int)depth * 2 + 2,
4309        "", SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4310
4311       });
4312       if ( last && trietype ) {
4313        if ( trietype != NOTHING ) {
4314         /* the last branch of the sequence was part of
4315         * a trie, so we have to construct it here
4316         * outside of the loop */
4317         made= make_trie( pRExC_state, startbranch,
4318             first, scan, tail, count,
4319             trietype, depth+1 );
4320 #ifdef TRIE_STUDY_OPT
4321         if ( ((made == MADE_EXACT_TRIE &&
4322          startbranch == first)
4323          || ( first_non_open == first )) &&
4324          depth==0 ) {
4325          flags |= SCF_TRIE_RESTUDY;
4326          if ( startbranch == first
4327           && scan == tail )
4328          {
4329           RExC_seen &=~REG_TOP_LEVEL_BRANCHES_SEEN;
4330          }
4331         }
4332 #endif
4333        } else {
4334         /* at this point we know whatever we have is a
4335         * NOTHING sequence/branch AND if 'startbranch'
4336         * is 'first' then we can turn the whole thing
4337         * into a NOTHING
4338         */
4339         if ( startbranch == first ) {
4340          regnode *opt;
4341          /* the entire thing is a NOTHING sequence,
4342          * something like this: (?:|) So we can
4343          * turn it into a plain NOTHING op. */
4344          DEBUG_TRIE_COMPILE_r({
4345           regprop(RExC_rx, RExC_mysv, cur, NULL, pRExC_state);
4346           PerlIO_printf( Perl_debug_log,
4347           "%*s- %s (%d) <NOTHING BRANCH SEQUENCE>\n", (int)depth * 2 + 2,
4348           "", SvPV_nolen_const( RExC_mysv ),REG_NODE_NUM(cur));
4349
4350          });
4351          OP(startbranch)= NOTHING;
4352          NEXT_OFF(startbranch)= tail - startbranch;
4353          for ( opt= startbranch + 1; opt < tail ; opt++ )
4354           OP(opt)= OPTIMIZED;
4355         }
4356        }
4357       } /* end if ( last) */
4358      } /* TRIE_MAXBUF is non zero */
4359
4360     } /* do trie */
4361
4362    }
4363    else if ( code == BRANCHJ ) {  /* single branch is optimized. */
4364     scan = NEXTOPER(NEXTOPER(scan));
4365    } else   /* single branch is optimized. */
4366     scan = NEXTOPER(scan);
4367    continue;
4368   } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
4369    I32 paren = 0;
4370    regnode *start = NULL;
4371    regnode *end = NULL;
4372    U32 my_recursed_depth= recursed_depth;
4373
4374
4375    if (OP(scan) != SUSPEND) { /* GOSUB/GOSTART */
4376     /* Do setup, note this code has side effects beyond
4377     * the rest of this block. Specifically setting
4378     * RExC_recurse[] must happen at least once during
4379     * study_chunk(). */
4380     if (OP(scan) == GOSUB) {
4381      paren = ARG(scan);
4382      RExC_recurse[ARG2L(scan)] = scan;
4383      start = RExC_open_parens[paren-1];
4384      end   = RExC_close_parens[paren-1];
4385     } else {
4386      start = RExC_rxi->program + 1;
4387      end   = RExC_opend;
4388     }
4389     /* NOTE we MUST always execute the above code, even
4390     * if we do nothing with a GOSUB/GOSTART */
4391     if (
4392      ( flags & SCF_IN_DEFINE )
4393      ||
4394      (
4395       (is_inf_internal || is_inf || (data && data->flags & SF_IS_INF))
4396       &&
4397       ( (flags & (SCF_DO_STCLASS | SCF_DO_SUBSTR)) == 0 )
4398      )
4399     ) {
4400      /* no need to do anything here if we are in a define. */
4401      /* or we are after some kind of infinite construct
4402      * so we can skip recursing into this item.
4403      * Since it is infinite we will not change the maxlen
4404      * or delta, and if we miss something that might raise
4405      * the minlen it will merely pessimise a little.
4406      *
4407      * Iow /(?(DEFINE)(?<foo>foo|food))a+(?&foo)/
4408      * might result in a minlen of 1 and not of 4,
4409      * but this doesn't make us mismatch, just try a bit
4410      * harder than we should.
4411      * */
4412      scan= regnext(scan);
4413      continue;
4414     }
4415
4416     if (
4417      !recursed_depth
4418      ||
4419      !PAREN_TEST(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes), paren)
4420     ) {
4421      /* it is quite possible that there are more efficient ways
4422      * to do this. We maintain a bitmap per level of recursion
4423      * of which patterns we have entered so we can detect if a
4424      * pattern creates a possible infinite loop. When we
4425      * recurse down a level we copy the previous levels bitmap
4426      * down. When we are at recursion level 0 we zero the top
4427      * level bitmap. It would be nice to implement a different
4428      * more efficient way of doing this. In particular the top
4429      * level bitmap may be unnecessary.
4430      */
4431      if (!recursed_depth) {
4432       Zero(RExC_study_chunk_recursed, RExC_study_chunk_recursed_bytes, U8);
4433      } else {
4434       Copy(RExC_study_chunk_recursed + ((recursed_depth-1) * RExC_study_chunk_recursed_bytes),
4435        RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes),
4436        RExC_study_chunk_recursed_bytes, U8);
4437      }
4438      /* we havent recursed into this paren yet, so recurse into it */
4439      DEBUG_STUDYDATA("set:", data,depth);
4440      PAREN_SET(RExC_study_chunk_recursed + (recursed_depth * RExC_study_chunk_recursed_bytes), paren);
4441      my_recursed_depth= recursed_depth + 1;
4442     } else {
4443      DEBUG_STUDYDATA("inf:", data,depth);
4444      /* some form of infinite recursion, assume infinite length
4445      * */
4446      if (flags & SCF_DO_SUBSTR) {
4447       scan_commit(pRExC_state, data, minlenp, is_inf);
4448       data->longest = &(data->longest_float);
4449      }
4450      is_inf = is_inf_internal = 1;
4451      if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4452       ssc_anything(data->start_class);
4453      flags &= ~SCF_DO_STCLASS;
4454
4455      start= NULL; /* reset start so we dont recurse later on. */
4456     }
4457    } else {
4458     paren = stopparen;
4459     start = scan + 2;
4460     end = regnext(scan);
4461    }
4462    if (start) {
4463     scan_frame *newframe;
4464     assert(end);
4465     if (!RExC_frame_last) {
4466      Newxz(newframe, 1, scan_frame);
4467      SAVEDESTRUCTOR_X(S_unwind_scan_frames, newframe);
4468      RExC_frame_head= newframe;
4469      RExC_frame_count++;
4470     } else if (!RExC_frame_last->next_frame) {
4471      Newxz(newframe,1,scan_frame);
4472      RExC_frame_last->next_frame= newframe;
4473      newframe->prev_frame= RExC_frame_last;
4474      RExC_frame_count++;
4475     } else {
4476      newframe= RExC_frame_last->next_frame;
4477     }
4478     RExC_frame_last= newframe;
4479
4480     newframe->next_regnode = regnext(scan);
4481     newframe->last_regnode = last;
4482     newframe->stopparen = stopparen;
4483     newframe->prev_recursed_depth = recursed_depth;
4484     newframe->this_prev_frame= frame;
4485
4486     DEBUG_STUDYDATA("frame-new:",data,depth);
4487     DEBUG_PEEP("fnew", scan, depth);
4488
4489     frame = newframe;
4490     scan =  start;
4491     stopparen = paren;
4492     last = end;
4493     depth = depth + 1;
4494     recursed_depth= my_recursed_depth;
4495
4496     continue;
4497    }
4498   }
4499   else if (OP(scan) == EXACT || OP(scan) == EXACTL) {
4500    SSize_t l = STR_LEN(scan);
4501    UV uc;
4502    if (UTF) {
4503     const U8 * const s = (U8*)STRING(scan);
4504     uc = utf8_to_uvchr_buf(s, s + l, NULL);
4505     l = utf8_length(s, s + l);
4506    } else {
4507     uc = *((U8*)STRING(scan));
4508    }
4509    min += l;
4510    if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
4511     /* The code below prefers earlier match for fixed
4512     offset, later match for variable offset.  */
4513     if (data->last_end == -1) { /* Update the start info. */
4514      data->last_start_min = data->pos_min;
4515      data->last_start_max = is_inf
4516       ? SSize_t_MAX : data->pos_min + data->pos_delta;
4517     }
4518     sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
4519     if (UTF)
4520      SvUTF8_on(data->last_found);
4521     {
4522      SV * const sv = data->last_found;
4523      MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4524       mg_find(sv, PERL_MAGIC_utf8) : NULL;
4525      if (mg && mg->mg_len >= 0)
4526       mg->mg_len += utf8_length((U8*)STRING(scan),
4527            (U8*)STRING(scan)+STR_LEN(scan));
4528     }
4529     data->last_end = data->pos_min + l;
4530     data->pos_min += l; /* As in the first entry. */
4531     data->flags &= ~SF_BEFORE_EOL;
4532    }
4533
4534    /* ANDing the code point leaves at most it, and not in locale, and
4535    * can't match null string */
4536    if (flags & SCF_DO_STCLASS_AND) {
4537     ssc_cp_and(data->start_class, uc);
4538     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4539     ssc_clear_locale(data->start_class);
4540    }
4541    else if (flags & SCF_DO_STCLASS_OR) {
4542     ssc_add_cp(data->start_class, uc);
4543     ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4544
4545     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4546     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4547    }
4548    flags &= ~SCF_DO_STCLASS;
4549   }
4550   else if (PL_regkind[OP(scan)] == EXACT) {
4551    /* But OP != EXACT!, so is EXACTFish */
4552    SSize_t l = STR_LEN(scan);
4553    const U8 * s = (U8*)STRING(scan);
4554
4555    /* Search for fixed substrings supports EXACT only. */
4556    if (flags & SCF_DO_SUBSTR) {
4557     assert(data);
4558     scan_commit(pRExC_state, data, minlenp, is_inf);
4559    }
4560    if (UTF) {
4561     l = utf8_length(s, s + l);
4562    }
4563    if (unfolded_multi_char) {
4564     RExC_seen |= REG_UNFOLDED_MULTI_SEEN;
4565    }
4566    min += l - min_subtract;
4567    assert (min >= 0);
4568    delta += min_subtract;
4569    if (flags & SCF_DO_SUBSTR) {
4570     data->pos_min += l - min_subtract;
4571     if (data->pos_min < 0) {
4572      data->pos_min = 0;
4573     }
4574     data->pos_delta += min_subtract;
4575     if (min_subtract) {
4576      data->longest = &(data->longest_float);
4577     }
4578    }
4579
4580    if (flags & SCF_DO_STCLASS) {
4581     SV* EXACTF_invlist = _make_exactf_invlist(pRExC_state, scan);
4582
4583     assert(EXACTF_invlist);
4584     if (flags & SCF_DO_STCLASS_AND) {
4585      if (OP(scan) != EXACTFL)
4586       ssc_clear_locale(data->start_class);
4587      ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4588      ANYOF_POSIXL_ZERO(data->start_class);
4589      ssc_intersection(data->start_class, EXACTF_invlist, FALSE);
4590     }
4591     else {  /* SCF_DO_STCLASS_OR */
4592      ssc_union(data->start_class, EXACTF_invlist, FALSE);
4593      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4594
4595      /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
4596      ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
4597     }
4598     flags &= ~SCF_DO_STCLASS;
4599     SvREFCNT_dec(EXACTF_invlist);
4600    }
4601   }
4602   else if (REGNODE_VARIES(OP(scan))) {
4603    SSize_t mincount, maxcount, minnext, deltanext, pos_before = 0;
4604    I32 fl = 0, f = flags;
4605    regnode * const oscan = scan;
4606    regnode_ssc this_class;
4607    regnode_ssc *oclass = NULL;
4608    I32 next_is_eval = 0;
4609
4610    switch (PL_regkind[OP(scan)]) {
4611    case WHILEM:  /* End of (?:...)* . */
4612     scan = NEXTOPER(scan);
4613     goto finish;
4614    case PLUS:
4615     if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
4616      next = NEXTOPER(scan);
4617      if (OP(next) == EXACT
4618       || OP(next) == EXACTL
4619       || (flags & SCF_DO_STCLASS))
4620      {
4621       mincount = 1;
4622       maxcount = REG_INFTY;
4623       next = regnext(scan);
4624       scan = NEXTOPER(scan);
4625       goto do_curly;
4626      }
4627     }
4628     if (flags & SCF_DO_SUBSTR)
4629      data->pos_min++;
4630     min++;
4631     /* FALLTHROUGH */
4632    case STAR:
4633     if (flags & SCF_DO_STCLASS) {
4634      mincount = 0;
4635      maxcount = REG_INFTY;
4636      next = regnext(scan);
4637      scan = NEXTOPER(scan);
4638      goto do_curly;
4639     }
4640     if (flags & SCF_DO_SUBSTR) {
4641      scan_commit(pRExC_state, data, minlenp, is_inf);
4642      /* Cannot extend fixed substrings */
4643      data->longest = &(data->longest_float);
4644     }
4645     is_inf = is_inf_internal = 1;
4646     scan = regnext(scan);
4647     goto optimize_curly_tail;
4648    case CURLY:
4649     if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
4650      && (scan->flags == stopparen))
4651     {
4652      mincount = 1;
4653      maxcount = 1;
4654     } else {
4655      mincount = ARG1(scan);
4656      maxcount = ARG2(scan);
4657     }
4658     next = regnext(scan);
4659     if (OP(scan) == CURLYX) {
4660      I32 lp = (data ? *(data->last_closep) : 0);
4661      scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
4662     }
4663     scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
4664     next_is_eval = (OP(scan) == EVAL);
4665    do_curly:
4666     if (flags & SCF_DO_SUBSTR) {
4667      if (mincount == 0)
4668       scan_commit(pRExC_state, data, minlenp, is_inf);
4669      /* Cannot extend fixed substrings */
4670      pos_before = data->pos_min;
4671     }
4672     if (data) {
4673      fl = data->flags;
4674      data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
4675      if (is_inf)
4676       data->flags |= SF_IS_INF;
4677     }
4678     if (flags & SCF_DO_STCLASS) {
4679      ssc_init(pRExC_state, &this_class);
4680      oclass = data->start_class;
4681      data->start_class = &this_class;
4682      f |= SCF_DO_STCLASS_AND;
4683      f &= ~SCF_DO_STCLASS_OR;
4684     }
4685     /* Exclude from super-linear cache processing any {n,m}
4686     regops for which the combination of input pos and regex
4687     pos is not enough information to determine if a match
4688     will be possible.
4689
4690     For example, in the regex /foo(bar\s*){4,8}baz/ with the
4691     regex pos at the \s*, the prospects for a match depend not
4692     only on the input position but also on how many (bar\s*)
4693     repeats into the {4,8} we are. */
4694    if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
4695      f &= ~SCF_WHILEM_VISITED_POS;
4696
4697     /* This will finish on WHILEM, setting scan, or on NULL: */
4698     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
4699         last, data, stopparen, recursed_depth, NULL,
4700         (mincount == 0
4701         ? (f & ~SCF_DO_SUBSTR)
4702         : f)
4703         ,depth+1);
4704
4705     if (flags & SCF_DO_STCLASS)
4706      data->start_class = oclass;
4707     if (mincount == 0 || minnext == 0) {
4708      if (flags & SCF_DO_STCLASS_OR) {
4709       ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4710      }
4711      else if (flags & SCF_DO_STCLASS_AND) {
4712       /* Switch to OR mode: cache the old value of
4713       * data->start_class */
4714       INIT_AND_WITHP;
4715       StructCopy(data->start_class, and_withp, regnode_ssc);
4716       flags &= ~SCF_DO_STCLASS_AND;
4717       StructCopy(&this_class, data->start_class, regnode_ssc);
4718       flags |= SCF_DO_STCLASS_OR;
4719       ANYOF_FLAGS(data->start_class)
4720             |= SSC_MATCHES_EMPTY_STRING;
4721      }
4722     } else {  /* Non-zero len */
4723      if (flags & SCF_DO_STCLASS_OR) {
4724       ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4725       ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
4726      }
4727      else if (flags & SCF_DO_STCLASS_AND)
4728       ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &this_class);
4729      flags &= ~SCF_DO_STCLASS;
4730     }
4731     if (!scan)   /* It was not CURLYX, but CURLY. */
4732      scan = next;
4733     if (!(flags & SCF_TRIE_DOING_RESTUDY)
4734      /* ? quantifier ok, except for (?{ ... }) */
4735      && (next_is_eval || !(mincount == 0 && maxcount == 1))
4736      && (minnext == 0) && (deltanext == 0)
4737      && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
4738      && maxcount <= REG_INFTY/3) /* Complement check for big
4739             count */
4740     {
4741      /* Fatal warnings may leak the regexp without this: */
4742      SAVEFREESV(RExC_rx_sv);
4743      Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),
4744       "Quantifier unexpected on zero-length expression "
4745       "in regex m/%"UTF8f"/",
4746       UTF8fARG(UTF, RExC_end - RExC_precomp,
4747         RExC_precomp));
4748      (void)ReREFCNT_inc(RExC_rx_sv);
4749     }
4750
4751     min += minnext * mincount;
4752     is_inf_internal |= deltanext == SSize_t_MAX
4753       || (maxcount == REG_INFTY && minnext + deltanext > 0);
4754     is_inf |= is_inf_internal;
4755     if (is_inf) {
4756      delta = SSize_t_MAX;
4757     } else {
4758      delta += (minnext + deltanext) * maxcount
4759        - minnext * mincount;
4760     }
4761     /* Try powerful optimization CURLYX => CURLYN. */
4762     if (  OP(oscan) == CURLYX && data
4763      && data->flags & SF_IN_PAR
4764      && !(data->flags & SF_HAS_EVAL)
4765      && !deltanext && minnext == 1 ) {
4766      /* Try to optimize to CURLYN.  */
4767      regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
4768      regnode * const nxt1 = nxt;
4769 #ifdef DEBUGGING
4770      regnode *nxt2;
4771 #endif
4772
4773      /* Skip open. */
4774      nxt = regnext(nxt);
4775      if (!REGNODE_SIMPLE(OP(nxt))
4776       && !(PL_regkind[OP(nxt)] == EXACT
4777        && STR_LEN(nxt) == 1))
4778       goto nogo;
4779 #ifdef DEBUGGING
4780      nxt2 = nxt;
4781 #endif
4782      nxt = regnext(nxt);
4783      if (OP(nxt) != CLOSE)
4784       goto nogo;
4785      if (RExC_open_parens) {
4786       RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4787       RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
4788      }
4789      /* Now we know that nxt2 is the only contents: */
4790      oscan->flags = (U8)ARG(nxt);
4791      OP(oscan) = CURLYN;
4792      OP(nxt1) = NOTHING; /* was OPEN. */
4793
4794 #ifdef DEBUGGING
4795      OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4796      NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
4797      NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
4798      OP(nxt) = OPTIMIZED; /* was CLOSE. */
4799      OP(nxt + 1) = OPTIMIZED; /* was count. */
4800      NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
4801 #endif
4802     }
4803    nogo:
4804
4805     /* Try optimization CURLYX => CURLYM. */
4806     if (  OP(oscan) == CURLYX && data
4807      && !(data->flags & SF_HAS_PAR)
4808      && !(data->flags & SF_HAS_EVAL)
4809      && !deltanext /* atom is fixed width */
4810      && minnext != 0 /* CURLYM can't handle zero width */
4811
4812       /* Nor characters whose fold at run-time may be
4813       * multi-character */
4814      && ! (RExC_seen & REG_UNFOLDED_MULTI_SEEN)
4815     ) {
4816      /* XXXX How to optimize if data == 0? */
4817      /* Optimize to a simpler form.  */
4818      regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
4819      regnode *nxt2;
4820
4821      OP(oscan) = CURLYM;
4822      while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
4823        && (OP(nxt2) != WHILEM))
4824       nxt = nxt2;
4825      OP(nxt2)  = SUCCEED; /* Whas WHILEM */
4826      /* Need to optimize away parenths. */
4827      if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
4828       /* Set the parenth number.  */
4829       regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
4830
4831       oscan->flags = (U8)ARG(nxt);
4832       if (RExC_open_parens) {
4833        RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
4834        RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
4835       }
4836       OP(nxt1) = OPTIMIZED; /* was OPEN. */
4837       OP(nxt) = OPTIMIZED; /* was CLOSE. */
4838
4839 #ifdef DEBUGGING
4840       OP(nxt1 + 1) = OPTIMIZED; /* was count. */
4841       OP(nxt + 1) = OPTIMIZED; /* was count. */
4842       NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
4843       NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
4844 #endif
4845 #if 0
4846       while ( nxt1 && (OP(nxt1) != WHILEM)) {
4847        regnode *nnxt = regnext(nxt1);
4848        if (nnxt == nxt) {
4849         if (reg_off_by_arg[OP(nxt1)])
4850          ARG_SET(nxt1, nxt2 - nxt1);
4851         else if (nxt2 - nxt1 < U16_MAX)
4852          NEXT_OFF(nxt1) = nxt2 - nxt1;
4853         else
4854          OP(nxt) = NOTHING; /* Cannot beautify */
4855        }
4856        nxt1 = nnxt;
4857       }
4858 #endif
4859       /* Optimize again: */
4860       study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
4861          NULL, stopparen, recursed_depth, NULL, 0,depth+1);
4862      }
4863      else
4864       oscan->flags = 0;
4865     }
4866     else if ((OP(oscan) == CURLYX)
4867       && (flags & SCF_WHILEM_VISITED_POS)
4868       /* See the comment on a similar expression above.
4869        However, this time it's not a subexpression
4870        we care about, but the expression itself. */
4871       && (maxcount == REG_INFTY)
4872       && data && ++data->whilem_c < 16) {
4873      /* This stays as CURLYX, we can put the count/of pair. */
4874      /* Find WHILEM (as in regexec.c) */
4875      regnode *nxt = oscan + NEXT_OFF(oscan);
4876
4877      if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
4878       nxt += ARG(nxt);
4879      PREVOPER(nxt)->flags = (U8)(data->whilem_c
4880       | (RExC_whilem_seen << 4)); /* On WHILEM */
4881     }
4882     if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
4883      pars++;
4884     if (flags & SCF_DO_SUBSTR) {
4885      SV *last_str = NULL;
4886      STRLEN last_chrs = 0;
4887      int counted = mincount != 0;
4888
4889      if (data->last_end > 0 && mincount != 0) { /* Ends with a
4890                 string. */
4891       SSize_t b = pos_before >= data->last_start_min
4892        ? pos_before : data->last_start_min;
4893       STRLEN l;
4894       const char * const s = SvPV_const(data->last_found, l);
4895       SSize_t old = b - data->last_start_min;
4896
4897       if (UTF)
4898        old = utf8_hop((U8*)s, old) - (U8*)s;
4899       l -= old;
4900       /* Get the added string: */
4901       last_str = newSVpvn_utf8(s  + old, l, UTF);
4902       last_chrs = UTF ? utf8_length((U8*)(s + old),
4903            (U8*)(s + old + l)) : l;
4904       if (deltanext == 0 && pos_before == b) {
4905        /* What was added is a constant string */
4906        if (mincount > 1) {
4907
4908         SvGROW(last_str, (mincount * l) + 1);
4909         repeatcpy(SvPVX(last_str) + l,
4910           SvPVX_const(last_str), l,
4911           mincount - 1);
4912         SvCUR_set(last_str, SvCUR(last_str) * mincount);
4913         /* Add additional parts. */
4914         SvCUR_set(data->last_found,
4915           SvCUR(data->last_found) - l);
4916         sv_catsv(data->last_found, last_str);
4917         {
4918          SV * sv = data->last_found;
4919          MAGIC *mg =
4920           SvUTF8(sv) && SvMAGICAL(sv) ?
4921           mg_find(sv, PERL_MAGIC_utf8) : NULL;
4922          if (mg && mg->mg_len >= 0)
4923           mg->mg_len += last_chrs * (mincount-1);
4924         }
4925         last_chrs *= mincount;
4926         data->last_end += l * (mincount - 1);
4927        }
4928       } else {
4929        /* start offset must point into the last copy */
4930        data->last_start_min += minnext * (mincount - 1);
4931        data->last_start_max =
4932        is_inf
4933        ? SSize_t_MAX
4934        : data->last_start_max +
4935         (maxcount - 1) * (minnext + data->pos_delta);
4936       }
4937      }
4938      /* It is counted once already... */
4939      data->pos_min += minnext * (mincount - counted);
4940 #if 0
4941 PerlIO_printf(Perl_debug_log, "counted=%"UVuf" deltanext=%"UVuf
4942        " SSize_t_MAX=%"UVuf" minnext=%"UVuf
4943        " maxcount=%"UVuf" mincount=%"UVuf"\n",
4944  (UV)counted, (UV)deltanext, (UV)SSize_t_MAX, (UV)minnext, (UV)maxcount,
4945  (UV)mincount);
4946 if (deltanext != SSize_t_MAX)
4947 PerlIO_printf(Perl_debug_log, "LHS=%"UVuf" RHS=%"UVuf"\n",
4948  (UV)(-counted * deltanext + (minnext + deltanext) * maxcount
4949   - minnext * mincount), (UV)(SSize_t_MAX - data->pos_delta));
4950 #endif
4951      if (deltanext == SSize_t_MAX
4952       || -counted * deltanext + (minnext + deltanext) * maxcount - minnext * mincount >= SSize_t_MAX - data->pos_delta)
4953       data->pos_delta = SSize_t_MAX;
4954      else
4955       data->pos_delta += - counted * deltanext +
4956       (minnext + deltanext) * maxcount - minnext * mincount;
4957      if (mincount != maxcount) {
4958       /* Cannot extend fixed substrings found inside
4959        the group.  */
4960       scan_commit(pRExC_state, data, minlenp, is_inf);
4961       if (mincount && last_str) {
4962        SV * const sv = data->last_found;
4963        MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
4964         mg_find(sv, PERL_MAGIC_utf8) : NULL;
4965
4966        if (mg)
4967         mg->mg_len = -1;
4968        sv_setsv(sv, last_str);
4969        data->last_end = data->pos_min;
4970        data->last_start_min = data->pos_min - last_chrs;
4971        data->last_start_max = is_inf
4972         ? SSize_t_MAX
4973         : data->pos_min + data->pos_delta - last_chrs;
4974       }
4975       data->longest = &(data->longest_float);
4976      }
4977      SvREFCNT_dec(last_str);
4978     }
4979     if (data && (fl & SF_HAS_EVAL))
4980      data->flags |= SF_HAS_EVAL;
4981    optimize_curly_tail:
4982     if (OP(oscan) != CURLYX) {
4983      while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
4984       && NEXT_OFF(next))
4985       NEXT_OFF(oscan) += NEXT_OFF(next);
4986     }
4987     continue;
4988
4989    default:
4990 #ifdef DEBUGGING
4991     Perl_croak(aTHX_ "panic: unexpected varying REx opcode %d",
4992                  OP(scan));
4993 #endif
4994    case REF:
4995    case CLUMP:
4996     if (flags & SCF_DO_SUBSTR) {
4997      /* Cannot expect anything... */
4998      scan_commit(pRExC_state, data, minlenp, is_inf);
4999      data->longest = &(data->longest_float);
5000     }
5001     is_inf = is_inf_internal = 1;
5002     if (flags & SCF_DO_STCLASS_OR) {
5003      if (OP(scan) == CLUMP) {
5004       /* Actually is any start char, but very few code points
5005       * aren't start characters */
5006       ssc_match_all_cp(data->start_class);
5007      }
5008      else {
5009       ssc_anything(data->start_class);
5010      }
5011     }
5012     flags &= ~SCF_DO_STCLASS;
5013     break;
5014    }
5015   }
5016   else if (OP(scan) == LNBREAK) {
5017    if (flags & SCF_DO_STCLASS) {
5018      if (flags & SCF_DO_STCLASS_AND) {
5019      ssc_intersection(data->start_class,
5020          PL_XPosix_ptrs[_CC_VERTSPACE], FALSE);
5021      ssc_clear_locale(data->start_class);
5022      ANYOF_FLAGS(data->start_class)
5023             &= ~SSC_MATCHES_EMPTY_STRING;
5024     }
5025     else if (flags & SCF_DO_STCLASS_OR) {
5026      ssc_union(data->start_class,
5027        PL_XPosix_ptrs[_CC_VERTSPACE],
5028        FALSE);
5029      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5030
5031      /* See commit msg for
5032      * 749e076fceedeb708a624933726e7989f2302f6a */
5033      ANYOF_FLAGS(data->start_class)
5034             &= ~SSC_MATCHES_EMPTY_STRING;
5035     }
5036     flags &= ~SCF_DO_STCLASS;
5037    }
5038    min++;
5039    if (delta != SSize_t_MAX)
5040     delta++;    /* Because of the 2 char string cr-lf */
5041    if (flags & SCF_DO_SUBSTR) {
5042     /* Cannot expect anything... */
5043     scan_commit(pRExC_state, data, minlenp, is_inf);
5044      data->pos_min += 1;
5045     data->pos_delta += 1;
5046     data->longest = &(data->longest_float);
5047     }
5048   }
5049   else if (REGNODE_SIMPLE(OP(scan))) {
5050
5051    if (flags & SCF_DO_SUBSTR) {
5052     scan_commit(pRExC_state, data, minlenp, is_inf);
5053     data->pos_min++;
5054    }
5055    min++;
5056    if (flags & SCF_DO_STCLASS) {
5057     bool invert = 0;
5058     SV* my_invlist = NULL;
5059     U8 namedclass;
5060
5061     /* See commit msg 749e076fceedeb708a624933726e7989f2302f6a */
5062     ANYOF_FLAGS(data->start_class) &= ~SSC_MATCHES_EMPTY_STRING;
5063
5064     /* Some of the logic below assumes that switching
5065     locale on will only add false positives. */
5066     switch (OP(scan)) {
5067
5068     default:
5069 #ifdef DEBUGGING
5070     Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d",
5071                  OP(scan));
5072 #endif
5073     case CANY:
5074     case SANY:
5075      if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5076       ssc_match_all_cp(data->start_class);
5077      break;
5078
5079     case REG_ANY:
5080      {
5081       SV* REG_ANY_invlist = _new_invlist(2);
5082       REG_ANY_invlist = add_cp_to_invlist(REG_ANY_invlist,
5083                '\n');
5084       if (flags & SCF_DO_STCLASS_OR) {
5085        ssc_union(data->start_class,
5086          REG_ANY_invlist,
5087          TRUE /* TRUE => invert, hence all but \n
5088            */
5089          );
5090       }
5091       else if (flags & SCF_DO_STCLASS_AND) {
5092        ssc_intersection(data->start_class,
5093            REG_ANY_invlist,
5094            TRUE  /* TRUE => invert */
5095            );
5096        ssc_clear_locale(data->start_class);
5097       }
5098       SvREFCNT_dec_NN(REG_ANY_invlist);
5099      }
5100      break;
5101
5102     case ANYOFL:
5103     case ANYOF:
5104      if (flags & SCF_DO_STCLASS_AND)
5105       ssc_and(pRExC_state, data->start_class,
5106         (regnode_charclass *) scan);
5107      else
5108       ssc_or(pRExC_state, data->start_class,
5109               (regnode_charclass *) scan);
5110      break;
5111
5112     case NPOSIXL:
5113      invert = 1;
5114      /* FALLTHROUGH */
5115
5116     case POSIXL:
5117      namedclass = classnum_to_namedclass(FLAGS(scan)) + invert;
5118      if (flags & SCF_DO_STCLASS_AND) {
5119       bool was_there = cBOOL(
5120           ANYOF_POSIXL_TEST(data->start_class,
5121                 namedclass));
5122       ANYOF_POSIXL_ZERO(data->start_class);
5123       if (was_there) {    /* Do an AND */
5124        ANYOF_POSIXL_SET(data->start_class, namedclass);
5125       }
5126       /* No individual code points can now match */
5127       data->start_class->invlist
5128             = sv_2mortal(_new_invlist(0));
5129      }
5130      else {
5131       int complement = namedclass + ((invert) ? -1 : 1);
5132
5133       assert(flags & SCF_DO_STCLASS_OR);
5134
5135       /* If the complement of this class was already there,
5136       * the result is that they match all code points,
5137       * (\d + \D == everything).  Remove the classes from
5138       * future consideration.  Locale is not relevant in
5139       * this case */
5140       if (ANYOF_POSIXL_TEST(data->start_class, complement)) {
5141        ssc_match_all_cp(data->start_class);
5142        ANYOF_POSIXL_CLEAR(data->start_class, namedclass);
5143        ANYOF_POSIXL_CLEAR(data->start_class, complement);
5144       }
5145       else {  /* The usual case; just add this class to the
5146         existing set */
5147        ANYOF_POSIXL_SET(data->start_class, namedclass);
5148       }
5149      }
5150      break;
5151
5152     case NPOSIXA:   /* For these, we always know the exact set of
5153         what's matched */
5154      invert = 1;
5155      /* FALLTHROUGH */
5156     case POSIXA:
5157      if (FLAGS(scan) == _CC_ASCII) {
5158       my_invlist = invlist_clone(PL_XPosix_ptrs[_CC_ASCII]);
5159      }
5160      else {
5161       _invlist_intersection(PL_XPosix_ptrs[FLAGS(scan)],
5162            PL_XPosix_ptrs[_CC_ASCII],
5163            &my_invlist);
5164      }
5165      goto join_posix;
5166
5167     case NPOSIXD:
5168     case NPOSIXU:
5169      invert = 1;
5170      /* FALLTHROUGH */
5171     case POSIXD:
5172     case POSIXU:
5173      my_invlist = invlist_clone(PL_XPosix_ptrs[FLAGS(scan)]);
5174
5175      /* NPOSIXD matches all upper Latin1 code points unless the
5176      * target string being matched is UTF-8, which is
5177      * unknowable until match time.  Since we are going to
5178      * invert, we want to get rid of all of them so that the
5179      * inversion will match all */
5180      if (OP(scan) == NPOSIXD) {
5181       _invlist_subtract(my_invlist, PL_UpperLatin1,
5182           &my_invlist);
5183      }
5184
5185     join_posix:
5186
5187      if (flags & SCF_DO_STCLASS_AND) {
5188       ssc_intersection(data->start_class, my_invlist, invert);
5189       ssc_clear_locale(data->start_class);
5190      }
5191      else {
5192       assert(flags & SCF_DO_STCLASS_OR);
5193       ssc_union(data->start_class, my_invlist, invert);
5194      }
5195      SvREFCNT_dec(my_invlist);
5196     }
5197     if (flags & SCF_DO_STCLASS_OR)
5198      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5199     flags &= ~SCF_DO_STCLASS;
5200    }
5201   }
5202   else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
5203    data->flags |= (OP(scan) == MEOL
5204        ? SF_BEFORE_MEOL
5205        : SF_BEFORE_SEOL);
5206    scan_commit(pRExC_state, data, minlenp, is_inf);
5207
5208   }
5209   else if (  PL_regkind[OP(scan)] == BRANCHJ
5210     /* Lookbehind, or need to calculate parens/evals/stclass: */
5211     && (scan->flags || data || (flags & SCF_DO_STCLASS))
5212     && (OP(scan) == IFMATCH || OP(scan) == UNLESSM))
5213   {
5214    if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5215     || OP(scan) == UNLESSM )
5216    {
5217     /* Negative Lookahead/lookbehind
5218     In this case we can't do fixed string optimisation.
5219     */
5220
5221     SSize_t deltanext, minnext, fake = 0;
5222     regnode *nscan;
5223     regnode_ssc intrnl;
5224     int f = 0;
5225
5226     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5227     if (data) {
5228      data_fake.whilem_c = data->whilem_c;
5229      data_fake.last_closep = data->last_closep;
5230     }
5231     else
5232      data_fake.last_closep = &fake;
5233     data_fake.pos_delta = delta;
5234     if ( flags & SCF_DO_STCLASS && !scan->flags
5235      && OP(scan) == IFMATCH ) { /* Lookahead */
5236      ssc_init(pRExC_state, &intrnl);
5237      data_fake.start_class = &intrnl;
5238      f |= SCF_DO_STCLASS_AND;
5239     }
5240     if (flags & SCF_WHILEM_VISITED_POS)
5241      f |= SCF_WHILEM_VISITED_POS;
5242     next = regnext(scan);
5243     nscan = NEXTOPER(NEXTOPER(scan));
5244     minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext,
5245          last, &data_fake, stopparen,
5246          recursed_depth, NULL, f, depth+1);
5247     if (scan->flags) {
5248      if (deltanext) {
5249       FAIL("Variable length lookbehind not implemented");
5250      }
5251      else if (minnext > (I32)U8_MAX) {
5252       FAIL2("Lookbehind longer than %"UVuf" not implemented",
5253        (UV)U8_MAX);
5254      }
5255      scan->flags = (U8)minnext;
5256     }
5257     if (data) {
5258      if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5259       pars++;
5260      if (data_fake.flags & SF_HAS_EVAL)
5261       data->flags |= SF_HAS_EVAL;
5262      data->whilem_c = data_fake.whilem_c;
5263     }
5264     if (f & SCF_DO_STCLASS_AND) {
5265      if (flags & SCF_DO_STCLASS_OR) {
5266       /* OR before, AND after: ideally we would recurse with
5267       * data_fake to get the AND applied by study of the
5268       * remainder of the pattern, and then derecurse;
5269       * *** HACK *** for now just treat as "no information".
5270       * See [perl #56690].
5271       */
5272       ssc_init(pRExC_state, data->start_class);
5273      }  else {
5274       /* AND before and after: combine and continue.  These
5275       * assertions are zero-length, so can match an EMPTY
5276       * string */
5277       ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5278       ANYOF_FLAGS(data->start_class)
5279             |= SSC_MATCHES_EMPTY_STRING;
5280      }
5281     }
5282    }
5283 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
5284    else {
5285     /* Positive Lookahead/lookbehind
5286     In this case we can do fixed string optimisation,
5287     but we must be careful about it. Note in the case of
5288     lookbehind the positions will be offset by the minimum
5289     length of the pattern, something we won't know about
5290     until after the recurse.
5291     */
5292     SSize_t deltanext, fake = 0;
5293     regnode *nscan;
5294     regnode_ssc intrnl;
5295     int f = 0;
5296     /* We use SAVEFREEPV so that when the full compile
5297      is finished perl will clean up the allocated
5298      minlens when it's all done. This way we don't
5299      have to worry about freeing them when we know
5300      they wont be used, which would be a pain.
5301     */
5302     SSize_t *minnextp;
5303     Newx( minnextp, 1, SSize_t );
5304     SAVEFREEPV(minnextp);
5305
5306     if (data) {
5307      StructCopy(data, &data_fake, scan_data_t);
5308      if ((flags & SCF_DO_SUBSTR) && data->last_found) {
5309       f |= SCF_DO_SUBSTR;
5310       if (scan->flags)
5311        scan_commit(pRExC_state, &data_fake, minlenp, is_inf);
5312       data_fake.last_found=newSVsv(data->last_found);
5313      }
5314     }
5315     else
5316      data_fake.last_closep = &fake;
5317     data_fake.flags = 0;
5318     data_fake.pos_delta = delta;
5319     if (is_inf)
5320      data_fake.flags |= SF_IS_INF;
5321     if ( flags & SCF_DO_STCLASS && !scan->flags
5322      && OP(scan) == IFMATCH ) { /* Lookahead */
5323      ssc_init(pRExC_state, &intrnl);
5324      data_fake.start_class = &intrnl;
5325      f |= SCF_DO_STCLASS_AND;
5326     }
5327     if (flags & SCF_WHILEM_VISITED_POS)
5328      f |= SCF_WHILEM_VISITED_POS;
5329     next = regnext(scan);
5330     nscan = NEXTOPER(NEXTOPER(scan));
5331
5332     *minnextp = study_chunk(pRExC_state, &nscan, minnextp,
5333           &deltanext, last, &data_fake,
5334           stopparen, recursed_depth, NULL,
5335           f,depth+1);
5336     if (scan->flags) {
5337      if (deltanext) {
5338       FAIL("Variable length lookbehind not implemented");
5339      }
5340      else if (*minnextp > (I32)U8_MAX) {
5341       FAIL2("Lookbehind longer than %"UVuf" not implemented",
5342        (UV)U8_MAX);
5343      }
5344      scan->flags = (U8)*minnextp;
5345     }
5346
5347     *minnextp += min;
5348
5349     if (f & SCF_DO_STCLASS_AND) {
5350      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &intrnl);
5351      ANYOF_FLAGS(data->start_class) |= SSC_MATCHES_EMPTY_STRING;
5352     }
5353     if (data) {
5354      if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5355       pars++;
5356      if (data_fake.flags & SF_HAS_EVAL)
5357       data->flags |= SF_HAS_EVAL;
5358      data->whilem_c = data_fake.whilem_c;
5359      if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
5360       if (RExC_rx->minlen<*minnextp)
5361        RExC_rx->minlen=*minnextp;
5362       scan_commit(pRExC_state, &data_fake, minnextp, is_inf);
5363       SvREFCNT_dec_NN(data_fake.last_found);
5364
5365       if ( data_fake.minlen_fixed != minlenp )
5366       {
5367        data->offset_fixed= data_fake.offset_fixed;
5368        data->minlen_fixed= data_fake.minlen_fixed;
5369        data->lookbehind_fixed+= scan->flags;
5370       }
5371       if ( data_fake.minlen_float != minlenp )
5372       {
5373        data->minlen_float= data_fake.minlen_float;
5374        data->offset_float_min=data_fake.offset_float_min;
5375        data->offset_float_max=data_fake.offset_float_max;
5376        data->lookbehind_float+= scan->flags;
5377       }
5378      }
5379     }
5380    }
5381 #endif
5382   }
5383   else if (OP(scan) == OPEN) {
5384    if (stopparen != (I32)ARG(scan))
5385     pars++;
5386   }
5387   else if (OP(scan) == CLOSE) {
5388    if (stopparen == (I32)ARG(scan)) {
5389     break;
5390    }
5391    if ((I32)ARG(scan) == is_par) {
5392     next = regnext(scan);
5393
5394     if ( next && (OP(next) != WHILEM) && next < last)
5395      is_par = 0;  /* Disable optimization */
5396    }
5397    if (data)
5398     *(data->last_closep) = ARG(scan);
5399   }
5400   else if (OP(scan) == EVAL) {
5401     if (data)
5402      data->flags |= SF_HAS_EVAL;
5403   }
5404   else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
5405    if (flags & SCF_DO_SUBSTR) {
5406     scan_commit(pRExC_state, data, minlenp, is_inf);
5407     flags &= ~SCF_DO_SUBSTR;
5408    }
5409    if (data && OP(scan)==ACCEPT) {
5410     data->flags |= SCF_SEEN_ACCEPT;
5411     if (stopmin > min)
5412      stopmin = min;
5413    }
5414   }
5415   else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
5416   {
5417     if (flags & SCF_DO_SUBSTR) {
5418      scan_commit(pRExC_state, data, minlenp, is_inf);
5419      data->longest = &(data->longest_float);
5420     }
5421     is_inf = is_inf_internal = 1;
5422     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
5423      ssc_anything(data->start_class);
5424     flags &= ~SCF_DO_STCLASS;
5425   }
5426   else if (OP(scan) == GPOS) {
5427    if (!(RExC_rx->intflags & PREGf_GPOS_FLOAT) &&
5428     !(delta || is_inf || (data && data->pos_delta)))
5429    {
5430     if (!(RExC_rx->intflags & PREGf_ANCH) && (flags & SCF_DO_SUBSTR))
5431      RExC_rx->intflags |= PREGf_ANCH_GPOS;
5432     if (RExC_rx->gofs < (STRLEN)min)
5433      RExC_rx->gofs = min;
5434    } else {
5435     RExC_rx->intflags |= PREGf_GPOS_FLOAT;
5436     RExC_rx->gofs = 0;
5437    }
5438   }
5439 #ifdef TRIE_STUDY_OPT
5440 #ifdef FULL_TRIE_STUDY
5441   else if (PL_regkind[OP(scan)] == TRIE) {
5442    /* NOTE - There is similar code to this block above for handling
5443    BRANCH nodes on the initial study.  If you change stuff here
5444    check there too. */
5445    regnode *trie_node= scan;
5446    regnode *tail= regnext(scan);
5447    reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5448    SSize_t max1 = 0, min1 = SSize_t_MAX;
5449    regnode_ssc accum;
5450
5451    if (flags & SCF_DO_SUBSTR) { /* XXXX Add !SUSPEND? */
5452     /* Cannot merge strings after this. */
5453     scan_commit(pRExC_state, data, minlenp, is_inf);
5454    }
5455    if (flags & SCF_DO_STCLASS)
5456     ssc_init_zero(pRExC_state, &accum);
5457
5458    if (!trie->jump) {
5459     min1= trie->minlen;
5460     max1= trie->maxlen;
5461    } else {
5462     const regnode *nextbranch= NULL;
5463     U32 word;
5464
5465     for ( word=1 ; word <= trie->wordcount ; word++)
5466     {
5467      SSize_t deltanext=0, minnext=0, f = 0, fake;
5468      regnode_ssc this_class;
5469
5470      StructCopy(&zero_scan_data, &data_fake, scan_data_t);
5471      if (data) {
5472       data_fake.whilem_c = data->whilem_c;
5473       data_fake.last_closep = data->last_closep;
5474      }
5475      else
5476       data_fake.last_closep = &fake;
5477      data_fake.pos_delta = delta;
5478      if (flags & SCF_DO_STCLASS) {
5479       ssc_init(pRExC_state, &this_class);
5480       data_fake.start_class = &this_class;
5481       f = SCF_DO_STCLASS_AND;
5482      }
5483      if (flags & SCF_WHILEM_VISITED_POS)
5484       f |= SCF_WHILEM_VISITED_POS;
5485
5486      if (trie->jump[word]) {
5487       if (!nextbranch)
5488        nextbranch = trie_node + trie->jump[0];
5489       scan= trie_node + trie->jump[word];
5490       /* We go from the jump point to the branch that follows
5491       it. Note this means we need the vestigal unused
5492       branches even though they arent otherwise used. */
5493       minnext = study_chunk(pRExC_state, &scan, minlenp,
5494        &deltanext, (regnode *)nextbranch, &data_fake,
5495        stopparen, recursed_depth, NULL, f,depth+1);
5496      }
5497      if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
5498       nextbranch= regnext((regnode*)nextbranch);
5499
5500      if (min1 > (SSize_t)(minnext + trie->minlen))
5501       min1 = minnext + trie->minlen;
5502      if (deltanext == SSize_t_MAX) {
5503       is_inf = is_inf_internal = 1;
5504       max1 = SSize_t_MAX;
5505      } else if (max1 < (SSize_t)(minnext + deltanext + trie->maxlen))
5506       max1 = minnext + deltanext + trie->maxlen;
5507
5508      if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
5509       pars++;
5510      if (data_fake.flags & SCF_SEEN_ACCEPT) {
5511       if ( stopmin > min + min1)
5512        stopmin = min + min1;
5513       flags &= ~SCF_DO_SUBSTR;
5514       if (data)
5515        data->flags |= SCF_SEEN_ACCEPT;
5516      }
5517      if (data) {
5518       if (data_fake.flags & SF_HAS_EVAL)
5519        data->flags |= SF_HAS_EVAL;
5520       data->whilem_c = data_fake.whilem_c;
5521      }
5522      if (flags & SCF_DO_STCLASS)
5523       ssc_or(pRExC_state, &accum, (regnode_charclass *) &this_class);
5524     }
5525    }
5526    if (flags & SCF_DO_SUBSTR) {
5527     data->pos_min += min1;
5528     data->pos_delta += max1 - min1;
5529     if (max1 != min1 || is_inf)
5530      data->longest = &(data->longest_float);
5531    }
5532    min += min1;
5533    if (delta != SSize_t_MAX)
5534     delta += max1 - min1;
5535    if (flags & SCF_DO_STCLASS_OR) {
5536     ssc_or(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5537     if (min1) {
5538      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5539      flags &= ~SCF_DO_STCLASS;
5540     }
5541    }
5542    else if (flags & SCF_DO_STCLASS_AND) {
5543     if (min1) {
5544      ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
5545      flags &= ~SCF_DO_STCLASS;
5546     }
5547     else {
5548      /* Switch to OR mode: cache the old value of
5549      * data->start_class */
5550      INIT_AND_WITHP;
5551      StructCopy(data->start_class, and_withp, regnode_ssc);
5552      flags &= ~SCF_DO_STCLASS_AND;
5553      StructCopy(&accum, data->start_class, regnode_ssc);
5554      flags |= SCF_DO_STCLASS_OR;
5555     }
5556    }
5557    scan= tail;
5558    continue;
5559   }
5560 #else
5561   else if (PL_regkind[OP(scan)] == TRIE) {
5562    reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
5563    U8*bang=NULL;
5564
5565    min += trie->minlen;
5566    delta += (trie->maxlen - trie->minlen);
5567    flags &= ~SCF_DO_STCLASS; /* xxx */
5568    if (flags & SCF_DO_SUBSTR) {
5569     /* Cannot expect anything... */
5570     scan_commit(pRExC_state, data, minlenp, is_inf);
5571      data->pos_min += trie->minlen;
5572      data->pos_delta += (trie->maxlen - trie->minlen);
5573     if (trie->maxlen != trie->minlen)
5574      data->longest = &(data->longest_float);
5575     }
5576     if (trie->jump) /* no more substrings -- for now /grr*/
5577    flags &= ~SCF_DO_SUBSTR;
5578   }
5579 #endif /* old or new */
5580 #endif /* TRIE_STUDY_OPT */
5581
5582   /* Else: zero-length, ignore. */
5583   scan = regnext(scan);
5584  }
5585  /* If we are exiting a recursion we can unset its recursed bit
5586  * and allow ourselves to enter it again - no danger of an
5587  * infinite loop there.
5588  if (stopparen > -1 && recursed) {
5589   DEBUG_STUDYDATA("unset:", data,depth);
5590   PAREN_UNSET( recursed, stopparen);
5591  }
5592  */
5593  if (frame) {
5594   depth = depth - 1;
5595
5596   DEBUG_STUDYDATA("frame-end:",data,depth);
5597   DEBUG_PEEP("fend", scan, depth);
5598
5599   /* restore previous context */
5600   last = frame->last_regnode;
5601   scan = frame->next_regnode;
5602   stopparen = frame->stopparen;
5603   recursed_depth = frame->prev_recursed_depth;
5604
5605   RExC_frame_last = frame->prev_frame;
5606   frame = frame->this_prev_frame;
5607   goto fake_study_recurse;
5608  }
5609
5610   finish:
5611  assert(!frame);
5612  DEBUG_STUDYDATA("pre-fin:",data,depth);
5613
5614  *scanp = scan;
5615  *deltap = is_inf_internal ? SSize_t_MAX : delta;
5616
5617  if (flags & SCF_DO_SUBSTR && is_inf)
5618   data->pos_delta = SSize_t_MAX - data->pos_min;
5619  if (is_par > (I32)U8_MAX)
5620   is_par = 0;
5621  if (is_par && pars==1 && data) {
5622   data->flags |= SF_IN_PAR;
5623   data->flags &= ~SF_HAS_PAR;
5624  }
5625  else if (pars && data) {
5626   data->flags |= SF_HAS_PAR;
5627   data->flags &= ~SF_IN_PAR;
5628  }
5629  if (flags & SCF_DO_STCLASS_OR)
5630   ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
5631  if (flags & SCF_TRIE_RESTUDY)
5632   data->flags |=  SCF_TRIE_RESTUDY;
5633
5634  DEBUG_STUDYDATA("post-fin:",data,depth);
5635
5636  {
5637   SSize_t final_minlen= min < stopmin ? min : stopmin;
5638
5639   if (!(RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)) {
5640    if (final_minlen > SSize_t_MAX - delta)
5641     RExC_maxlen = SSize_t_MAX;
5642    else if (RExC_maxlen < final_minlen + delta)
5643     RExC_maxlen = final_minlen + delta;
5644   }
5645   return final_minlen;
5646  }
5647  NOT_REACHED; /* NOTREACHED */
5648 }
5649
5650 STATIC U32
5651 S_add_data(RExC_state_t* const pRExC_state, const char* const s, const U32 n)
5652 {
5653  U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
5654
5655  PERL_ARGS_ASSERT_ADD_DATA;
5656
5657  Renewc(RExC_rxi->data,
5658   sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
5659   char, struct reg_data);
5660  if(count)
5661   Renew(RExC_rxi->data->what, count + n, U8);
5662  else
5663   Newx(RExC_rxi->data->what, n, U8);
5664  RExC_rxi->data->count = count + n;
5665  Copy(s, RExC_rxi->data->what + count, n, U8);
5666  return count;
5667 }
5668
5669 /*XXX: todo make this not included in a non debugging perl, but appears to be
5670  * used anyway there, in 'use re' */
5671 #ifndef PERL_IN_XSUB_RE
5672 void
5673 Perl_reginitcolors(pTHX)
5674 {
5675  const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
5676  if (s) {
5677   char *t = savepv(s);
5678   int i = 0;
5679   PL_colors[0] = t;
5680   while (++i < 6) {
5681    t = strchr(t, '\t');
5682    if (t) {
5683     *t = '\0';
5684     PL_colors[i] = ++t;
5685    }
5686    else
5687     PL_colors[i] = t = (char *)"";
5688   }
5689  } else {
5690   int i = 0;
5691   while (i < 6)
5692    PL_colors[i++] = (char *)"";
5693  }
5694  PL_colorset = 1;
5695 }
5696 #endif
5697
5698
5699 #ifdef TRIE_STUDY_OPT
5700 #define CHECK_RESTUDY_GOTO_butfirst(dOsomething)            \
5701  STMT_START {                                            \
5702   if (                                                \
5703    (data.flags & SCF_TRIE_RESTUDY)               \
5704    && ! restudied++                              \
5705   ) {                                                 \
5706    dOsomething;                                    \
5707    goto reStudy;                                   \
5708   }                                                   \
5709  } STMT_END
5710 #else
5711 #define CHECK_RESTUDY_GOTO_butfirst
5712 #endif
5713
5714 /*
5715  * pregcomp - compile a regular expression into internal code
5716  *
5717  * Decides which engine's compiler to call based on the hint currently in
5718  * scope
5719  */
5720
5721 #ifndef PERL_IN_XSUB_RE
5722
5723 /* return the currently in-scope regex engine (or the default if none)  */
5724
5725 regexp_engine const *
5726 Perl_current_re_engine(pTHX)
5727 {
5728  if (IN_PERL_COMPILETIME) {
5729   HV * const table = GvHV(PL_hintgv);
5730   SV **ptr;
5731
5732   if (!table || !(PL_hints & HINT_LOCALIZE_HH))
5733    return &reh_regexp_engine;
5734   ptr = hv_fetchs(table, "regcomp", FALSE);
5735   if ( !(ptr && SvIOK(*ptr) && SvIV(*ptr)))
5736    return &reh_regexp_engine;
5737   return INT2PTR(regexp_engine*,SvIV(*ptr));
5738  }
5739  else {
5740   SV *ptr;
5741   if (!PL_curcop->cop_hints_hash)
5742    return &reh_regexp_engine;
5743   ptr = cop_hints_fetch_pvs(PL_curcop, "regcomp", 0);
5744   if ( !(ptr && SvIOK(ptr) && SvIV(ptr)))
5745    return &reh_regexp_engine;
5746   return INT2PTR(regexp_engine*,SvIV(ptr));
5747  }
5748 }
5749
5750
5751 REGEXP *
5752 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
5753 {
5754  regexp_engine const *eng = current_re_engine();
5755  GET_RE_DEBUG_FLAGS_DECL;
5756
5757  PERL_ARGS_ASSERT_PREGCOMP;
5758
5759  /* Dispatch a request to compile a regexp to correct regexp engine. */
5760  DEBUG_COMPILE_r({
5761   PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
5762       PTR2UV(eng));
5763  });
5764  return CALLREGCOMP_ENG(eng, pattern, flags);
5765 }
5766 #endif
5767
5768 /* public(ish) entry point for the perl core's own regex compiling code.
5769  * It's actually a wrapper for Perl_re_op_compile that only takes an SV
5770  * pattern rather than a list of OPs, and uses the internal engine rather
5771  * than the current one */
5772
5773 REGEXP *
5774 Perl_re_compile(pTHX_ SV * const pattern, U32 rx_flags)
5775 {
5776  SV *pat = pattern; /* defeat constness! */
5777  PERL_ARGS_ASSERT_RE_COMPILE;
5778  return Perl_re_op_compile(aTHX_ &pat, 1, NULL,
5779 #ifdef PERL_IN_XSUB_RE
5780         &my_reg_engine,
5781 #else
5782         &reh_regexp_engine,
5783 #endif
5784         NULL, NULL, rx_flags, 0);
5785 }
5786
5787
5788 /* upgrade pattern pat_p of length plen_p to UTF8, and if there are code
5789  * blocks, recalculate the indices. Update pat_p and plen_p in-place to
5790  * point to the realloced string and length.
5791  *
5792  * This is essentially a copy of Perl_bytes_to_utf8() with the code index
5793  * stuff added */
5794
5795 static void
5796 S_pat_upgrade_to_utf8(pTHX_ RExC_state_t * const pRExC_state,
5797      char **pat_p, STRLEN *plen_p, int num_code_blocks)
5798 {
5799  U8 *const src = (U8*)*pat_p;
5800  U8 *dst, *d;
5801  int n=0;
5802  STRLEN s = 0;
5803  bool do_end = 0;
5804  GET_RE_DEBUG_FLAGS_DECL;
5805
5806  DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
5807   "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
5808
5809  Newx(dst, *plen_p * 2 + 1, U8);
5810  d = dst;
5811
5812  while (s < *plen_p) {
5813   append_utf8_from_native_byte(src[s], &d);
5814   if (n < num_code_blocks) {
5815    if (!do_end && pRExC_state->code_blocks[n].start == s) {
5816     pRExC_state->code_blocks[n].start = d - dst - 1;
5817     assert(*(d - 1) == '(');
5818     do_end = 1;
5819    }
5820    else if (do_end && pRExC_state->code_blocks[n].end == s) {
5821     pRExC_state->code_blocks[n].end = d - dst - 1;
5822     assert(*(d - 1) == ')');
5823     do_end = 0;
5824     n++;
5825    }
5826   }
5827   s++;
5828  }
5829  *d = '\0';
5830  *plen_p = d - dst;
5831  *pat_p = (char*) dst;
5832  SAVEFREEPV(*pat_p);
5833  RExC_orig_utf8 = RExC_utf8 = 1;
5834 }
5835
5836
5837
5838 /* S_concat_pat(): concatenate a list of args to the pattern string pat,
5839  * while recording any code block indices, and handling overloading,
5840  * nested qr// objects etc.  If pat is null, it will allocate a new
5841  * string, or just return the first arg, if there's only one.
5842  *
5843  * Returns the malloced/updated pat.
5844  * patternp and pat_count is the array of SVs to be concatted;
5845  * oplist is the optional list of ops that generated the SVs;
5846  * recompile_p is a pointer to a boolean that will be set if
5847  *   the regex will need to be recompiled.
5848  * delim, if non-null is an SV that will be inserted between each element
5849  */
5850
5851 static SV*
5852 S_concat_pat(pTHX_ RExC_state_t * const pRExC_state,
5853     SV *pat, SV ** const patternp, int pat_count,
5854     OP *oplist, bool *recompile_p, SV *delim)
5855 {
5856  SV **svp;
5857  int n = 0;
5858  bool use_delim = FALSE;
5859  bool alloced = FALSE;
5860
5861  /* if we know we have at least two args, create an empty string,
5862  * then concatenate args to that. For no args, return an empty string */
5863  if (!pat && pat_count != 1) {
5864   pat = newSVpvs("");
5865   SAVEFREESV(pat);
5866   alloced = TRUE;
5867  }
5868
5869  for (svp = patternp; svp < patternp + pat_count; svp++) {
5870   SV *sv;
5871   SV *rx  = NULL;
5872   STRLEN orig_patlen = 0;
5873   bool code = 0;
5874   SV *msv = use_delim ? delim : *svp;
5875   if (!msv) msv = &PL_sv_undef;
5876
5877   /* if we've got a delimiter, we go round the loop twice for each
5878   * svp slot (except the last), using the delimiter the second
5879   * time round */
5880   if (use_delim) {
5881    svp--;
5882    use_delim = FALSE;
5883   }
5884   else if (delim)
5885    use_delim = TRUE;
5886
5887   if (SvTYPE(msv) == SVt_PVAV) {
5888    /* we've encountered an interpolated array within
5889    * the pattern, e.g. /...@a..../. Expand the list of elements,
5890    * then recursively append elements.
5891    * The code in this block is based on S_pushav() */
5892
5893    AV *const av = (AV*)msv;
5894    const SSize_t maxarg = AvFILL(av) + 1;
5895    SV **array;
5896
5897    if (oplist) {
5898     assert(oplist->op_type == OP_PADAV
5899      || oplist->op_type == OP_RV2AV);
5900     oplist = OpSIBLING(oplist);
5901    }
5902
5903    if (SvRMAGICAL(av)) {
5904     SSize_t i;
5905
5906     Newx(array, maxarg, SV*);
5907     SAVEFREEPV(array);
5908     for (i=0; i < maxarg; i++) {
5909      SV ** const svp = av_fetch(av, i, FALSE);
5910      array[i] = svp ? *svp : &PL_sv_undef;
5911     }
5912    }
5913    else
5914     array = AvARRAY(av);
5915
5916    pat = S_concat_pat(aTHX_ pRExC_state, pat,
5917         array, maxarg, NULL, recompile_p,
5918         /* $" */
5919         GvSV((gv_fetchpvs("\"", GV_ADDMULTI, SVt_PV))));
5920
5921    continue;
5922   }
5923
5924
5925   /* we make the assumption here that each op in the list of
5926   * op_siblings maps to one SV pushed onto the stack,
5927   * except for code blocks, with have both an OP_NULL and
5928   * and OP_CONST.
5929   * This allows us to match up the list of SVs against the
5930   * list of OPs to find the next code block.
5931   *
5932   * Note that       PUSHMARK PADSV PADSV ..
5933   * is optimised to
5934   *                 PADRANGE PADSV  PADSV  ..
5935   * so the alignment still works. */
5936
5937   if (oplist) {
5938    if (oplist->op_type == OP_NULL
5939     && (oplist->op_flags & OPf_SPECIAL))
5940    {
5941     assert(n < pRExC_state->num_code_blocks);
5942     pRExC_state->code_blocks[n].start = pat ? SvCUR(pat) : 0;
5943     pRExC_state->code_blocks[n].block = oplist;
5944     pRExC_state->code_blocks[n].src_regex = NULL;
5945     n++;
5946     code = 1;
5947     oplist = OpSIBLING(oplist); /* skip CONST */
5948     assert(oplist);
5949    }
5950    oplist = OpSIBLING(oplist);;
5951   }
5952
5953   /* apply magic and QR overloading to arg */
5954
5955   SvGETMAGIC(msv);
5956   if (SvROK(msv) && SvAMAGIC(msv)) {
5957    SV *sv = AMG_CALLunary(msv, regexp_amg);
5958    if (sv) {
5959     if (SvROK(sv))
5960      sv = SvRV(sv);
5961     if (SvTYPE(sv) != SVt_REGEXP)
5962      Perl_croak(aTHX_ "Overloaded qr did not return a REGEXP");
5963     msv = sv;
5964    }
5965   }
5966
5967   /* try concatenation overload ... */
5968   if (pat && (SvAMAGIC(pat) || SvAMAGIC(msv)) &&
5969     (sv = amagic_call(pat, msv, concat_amg, AMGf_assign)))
5970   {
5971    sv_setsv(pat, sv);
5972    /* overloading involved: all bets are off over literal
5973    * code. Pretend we haven't seen it */
5974    pRExC_state->num_code_blocks -= n;
5975    n = 0;
5976   }
5977   else  {
5978    /* ... or failing that, try "" overload */
5979    while (SvAMAGIC(msv)
5980      && (sv = AMG_CALLunary(msv, string_amg))
5981      && sv != msv
5982      &&  !(   SvROK(msv)
5983       && SvROK(sv)
5984       && SvRV(msv) == SvRV(sv))
5985    ) {
5986     msv = sv;
5987     SvGETMAGIC(msv);
5988    }
5989    if (SvROK(msv) && SvTYPE(SvRV(msv)) == SVt_REGEXP)
5990     msv = SvRV(msv);
5991
5992    if (pat) {
5993     /* this is a partially unrolled
5994     *     sv_catsv_nomg(pat, msv);
5995     * that allows us to adjust code block indices if
5996     * needed */
5997     STRLEN dlen;
5998     char *dst = SvPV_force_nomg(pat, dlen);
5999     orig_patlen = dlen;
6000     if (SvUTF8(msv) && !SvUTF8(pat)) {
6001      S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &dst, &dlen, n);
6002      sv_setpvn(pat, dst, dlen);
6003      SvUTF8_on(pat);
6004     }
6005     sv_catsv_nomg(pat, msv);
6006     rx = msv;
6007    }
6008    else
6009     pat = msv;
6010
6011    if (code)
6012     pRExC_state->code_blocks[n-1].end = SvCUR(pat)-1;
6013   }
6014
6015   /* extract any code blocks within any embedded qr//'s */
6016   if (rx && SvTYPE(rx) == SVt_REGEXP
6017    && RX_ENGINE((REGEXP*)rx)->op_comp)
6018   {
6019
6020    RXi_GET_DECL(ReANY((REGEXP *)rx), ri);
6021    if (ri->num_code_blocks) {
6022     int i;
6023     /* the presence of an embedded qr// with code means
6024     * we should always recompile: the text of the
6025     * qr// may not have changed, but it may be a
6026     * different closure than last time */
6027     *recompile_p = 1;
6028     Renew(pRExC_state->code_blocks,
6029      pRExC_state->num_code_blocks + ri->num_code_blocks,
6030      struct reg_code_block);
6031     pRExC_state->num_code_blocks += ri->num_code_blocks;
6032
6033     for (i=0; i < ri->num_code_blocks; i++) {
6034      struct reg_code_block *src, *dst;
6035      STRLEN offset =  orig_patlen
6036       + ReANY((REGEXP *)rx)->pre_prefix;
6037      assert(n < pRExC_state->num_code_blocks);
6038      src = &ri->code_blocks[i];
6039      dst = &pRExC_state->code_blocks[n];
6040      dst->start     = src->start + offset;
6041      dst->end     = src->end   + offset;
6042      dst->block     = src->block;
6043      dst->src_regex  = (REGEXP*) SvREFCNT_inc( (SV*)
6044            src->src_regex
6045             ? src->src_regex
6046             : (REGEXP*)rx);
6047      n++;
6048     }
6049    }
6050   }
6051  }
6052  /* avoid calling magic multiple times on a single element e.g. =~ $qr */
6053  if (alloced)
6054   SvSETMAGIC(pat);
6055
6056  return pat;
6057 }
6058
6059
6060
6061 /* see if there are any run-time code blocks in the pattern.
6062  * False positives are allowed */
6063
6064 static bool
6065 S_has_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6066      char *pat, STRLEN plen)
6067 {
6068  int n = 0;
6069  STRLEN s;
6070
6071  PERL_UNUSED_CONTEXT;
6072
6073  for (s = 0; s < plen; s++) {
6074   if (n < pRExC_state->num_code_blocks
6075    && s == pRExC_state->code_blocks[n].start)
6076   {
6077    s = pRExC_state->code_blocks[n].end;
6078    n++;
6079    continue;
6080   }
6081   /* TODO ideally should handle [..], (#..), /#.../x to reduce false
6082   * positives here */
6083   if (pat[s] == '(' && s+2 <= plen && pat[s+1] == '?' &&
6084    (pat[s+2] == '{'
6085     || (s + 2 <= plen && pat[s+2] == '?' && pat[s+3] == '{'))
6086   )
6087    return 1;
6088  }
6089  return 0;
6090 }
6091
6092 /* Handle run-time code blocks. We will already have compiled any direct
6093  * or indirect literal code blocks. Now, take the pattern 'pat' and make a
6094  * copy of it, but with any literal code blocks blanked out and
6095  * appropriate chars escaped; then feed it into
6096  *
6097  *    eval "qr'modified_pattern'"
6098  *
6099  * For example,
6100  *
6101  *       a\bc(?{"this was literal"})def'ghi\\jkl(?{"this is runtime"})mno
6102  *
6103  * becomes
6104  *
6105  *    qr'a\\bc_______________________def\'ghi\\\\jkl(?{"this is runtime"})mno'
6106  *
6107  * After eval_sv()-ing that, grab any new code blocks from the returned qr
6108  * and merge them with any code blocks of the original regexp.
6109  *
6110  * If the pat is non-UTF8, while the evalled qr is UTF8, don't merge;
6111  * instead, just save the qr and return FALSE; this tells our caller that
6112  * the original pattern needs upgrading to utf8.
6113  */
6114
6115 static bool
6116 S_compile_runtime_code(pTHX_ RExC_state_t * const pRExC_state,
6117  char *pat, STRLEN plen)
6118 {
6119  SV *qr;
6120
6121  GET_RE_DEBUG_FLAGS_DECL;
6122
6123  if (pRExC_state->runtime_code_qr) {
6124   /* this is the second time we've been called; this should
6125   * only happen if the main pattern got upgraded to utf8
6126   * during compilation; re-use the qr we compiled first time
6127   * round (which should be utf8 too)
6128   */
6129   qr = pRExC_state->runtime_code_qr;
6130   pRExC_state->runtime_code_qr = NULL;
6131   assert(RExC_utf8 && SvUTF8(qr));
6132  }
6133  else {
6134   int n = 0;
6135   STRLEN s;
6136   char *p, *newpat;
6137   int newlen = plen + 6; /* allow for "qr''x\0" extra chars */
6138   SV *sv, *qr_ref;
6139   dSP;
6140
6141   /* determine how many extra chars we need for ' and \ escaping */
6142   for (s = 0; s < plen; s++) {
6143    if (pat[s] == '\'' || pat[s] == '\\')
6144     newlen++;
6145   }
6146
6147   Newx(newpat, newlen, char);
6148   p = newpat;
6149   *p++ = 'q'; *p++ = 'r'; *p++ = '\'';
6150
6151   for (s = 0; s < plen; s++) {
6152    if (n < pRExC_state->num_code_blocks
6153     && s == pRExC_state->code_blocks[n].start)
6154    {
6155     /* blank out literal code block */
6156     assert(pat[s] == '(');
6157     while (s <= pRExC_state->code_blocks[n].end) {
6158      *p++ = '_';
6159      s++;
6160     }
6161     s--;
6162     n++;
6163     continue;
6164    }
6165    if (pat[s] == '\'' || pat[s] == '\\')
6166     *p++ = '\\';
6167    *p++ = pat[s];
6168   }
6169   *p++ = '\'';
6170   if (pRExC_state->pm_flags & RXf_PMf_EXTENDED)
6171    *p++ = 'x';
6172   *p++ = '\0';
6173   DEBUG_COMPILE_r({
6174    PerlIO_printf(Perl_debug_log,
6175     "%sre-parsing pattern for runtime code:%s %s\n",
6176     PL_colors[4],PL_colors[5],newpat);
6177   });
6178
6179   sv = newSVpvn_flags(newpat, p-newpat-1, RExC_utf8 ? SVf_UTF8 : 0);
6180   Safefree(newpat);
6181
6182   ENTER;
6183   SAVETMPS;
6184   save_re_context();
6185   PUSHSTACKi(PERLSI_REQUIRE);
6186   /* G_RE_REPARSING causes the toker to collapse \\ into \ when
6187   * parsing qr''; normally only q'' does this. It also alters
6188   * hints handling */
6189   eval_sv(sv, G_SCALAR|G_RE_REPARSING);
6190   SvREFCNT_dec_NN(sv);
6191   SPAGAIN;
6192   qr_ref = POPs;
6193   PUTBACK;
6194   {
6195    SV * const errsv = ERRSV;
6196    if (SvTRUE_NN(errsv))
6197    {
6198     Safefree(pRExC_state->code_blocks);
6199     /* use croak_sv ? */
6200     Perl_croak_nocontext("%"SVf, SVfARG(errsv));
6201    }
6202   }
6203   assert(SvROK(qr_ref));
6204   qr = SvRV(qr_ref);
6205   assert(SvTYPE(qr) == SVt_REGEXP && RX_ENGINE((REGEXP*)qr)->op_comp);
6206   /* the leaving below frees the tmp qr_ref.
6207   * Give qr a life of its own */
6208   SvREFCNT_inc(qr);
6209   POPSTACK;
6210   FREETMPS;
6211   LEAVE;
6212
6213  }
6214
6215  if (!RExC_utf8 && SvUTF8(qr)) {
6216   /* first time through; the pattern got upgraded; save the
6217   * qr for the next time through */
6218   assert(!pRExC_state->runtime_code_qr);
6219   pRExC_state->runtime_code_qr = qr;
6220   return 0;
6221  }
6222
6223
6224  /* extract any code blocks within the returned qr//  */
6225
6226
6227  /* merge the main (r1) and run-time (r2) code blocks into one */
6228  {
6229   RXi_GET_DECL(ReANY((REGEXP *)qr), r2);
6230   struct reg_code_block *new_block, *dst;
6231   RExC_state_t * const r1 = pRExC_state; /* convenient alias */
6232   int i1 = 0, i2 = 0;
6233
6234   if (!r2->num_code_blocks) /* we guessed wrong */
6235   {
6236    SvREFCNT_dec_NN(qr);
6237    return 1;
6238   }
6239
6240   Newx(new_block,
6241    r1->num_code_blocks + r2->num_code_blocks,
6242    struct reg_code_block);
6243   dst = new_block;
6244
6245   while (    i1 < r1->num_code_blocks
6246     || i2 < r2->num_code_blocks)
6247   {
6248    struct reg_code_block *src;
6249    bool is_qr = 0;
6250
6251    if (i1 == r1->num_code_blocks) {
6252     src = &r2->code_blocks[i2++];
6253     is_qr = 1;
6254    }
6255    else if (i2 == r2->num_code_blocks)
6256     src = &r1->code_blocks[i1++];
6257    else if (  r1->code_blocks[i1].start
6258      < r2->code_blocks[i2].start)
6259    {
6260     src = &r1->code_blocks[i1++];
6261     assert(src->end < r2->code_blocks[i2].start);
6262    }
6263    else {
6264     assert(  r1->code_blocks[i1].start
6265      > r2->code_blocks[i2].start);
6266     src = &r2->code_blocks[i2++];
6267     is_qr = 1;
6268     assert(src->end < r1->code_blocks[i1].start);
6269    }
6270
6271    assert(pat[src->start] == '(');
6272    assert(pat[src->end]   == ')');
6273    dst->start     = src->start;
6274    dst->end     = src->end;
6275    dst->block     = src->block;
6276    dst->src_regex  = is_qr ? (REGEXP*) SvREFCNT_inc( (SV*) qr)
6277          : src->src_regex;
6278    dst++;
6279   }
6280   r1->num_code_blocks += r2->num_code_blocks;
6281   Safefree(r1->code_blocks);
6282   r1->code_blocks = new_block;
6283  }
6284
6285  SvREFCNT_dec_NN(qr);
6286  return 1;
6287 }
6288
6289
6290 STATIC bool
6291 S_setup_longest(pTHX_ RExC_state_t *pRExC_state, SV* sv_longest,
6292      SV** rx_utf8, SV** rx_substr, SSize_t* rx_end_shift,
6293      SSize_t lookbehind, SSize_t offset, SSize_t *minlen,
6294      STRLEN longest_length, bool eol, bool meol)
6295 {
6296  /* This is the common code for setting up the floating and fixed length
6297  * string data extracted from Perl_re_op_compile() below.  Returns a boolean
6298  * as to whether succeeded or not */
6299
6300  I32 t;
6301  SSize_t ml;
6302
6303  if (! (longest_length
6304   || (eol /* Can't have SEOL and MULTI */
6305    && (! meol || (RExC_flags & RXf_PMf_MULTILINE)))
6306   )
6307    /* See comments for join_exact for why REG_UNFOLDED_MULTI_SEEN */
6308   || (RExC_seen & REG_UNFOLDED_MULTI_SEEN))
6309  {
6310   return FALSE;
6311  }
6312
6313  /* copy the information about the longest from the reg_scan_data
6314   over to the program. */
6315  if (SvUTF8(sv_longest)) {
6316   *rx_utf8 = sv_longest;
6317   *rx_substr = NULL;
6318  } else {
6319   *rx_substr = sv_longest;
6320   *rx_utf8 = NULL;
6321  }
6322  /* end_shift is how many chars that must be matched that
6323   follow this item. We calculate it ahead of time as once the
6324   lookbehind offset is added in we lose the ability to correctly
6325   calculate it.*/
6326  ml = minlen ? *(minlen) : (SSize_t)longest_length;
6327  *rx_end_shift = ml - offset
6328   - longest_length + (SvTAIL(sv_longest) != 0)
6329   + lookbehind;
6330
6331  t = (eol/* Can't have SEOL and MULTI */
6332   && (! meol || (RExC_flags & RXf_PMf_MULTILINE)));
6333  fbm_compile(sv_longest, t ? FBMcf_TAIL : 0);
6334
6335  return TRUE;
6336 }
6337
6338 /*
6339  * Perl_re_op_compile - the perl internal RE engine's function to compile a
6340  * regular expression into internal code.
6341  * The pattern may be passed either as:
6342  *    a list of SVs (patternp plus pat_count)
6343  *    a list of OPs (expr)
6344  * If both are passed, the SV list is used, but the OP list indicates
6345  * which SVs are actually pre-compiled code blocks
6346  *
6347  * The SVs in the list have magic and qr overloading applied to them (and
6348  * the list may be modified in-place with replacement SVs in the latter
6349  * case).
6350  *
6351  * If the pattern hasn't changed from old_re, then old_re will be
6352  * returned.
6353  *
6354  * eng is the current engine. If that engine has an op_comp method, then
6355  * handle directly (i.e. we assume that op_comp was us); otherwise, just
6356  * do the initial concatenation of arguments and pass on to the external
6357  * engine.
6358  *
6359  * If is_bare_re is not null, set it to a boolean indicating whether the
6360  * arg list reduced (after overloading) to a single bare regex which has
6361  * been returned (i.e. /$qr/).
6362  *
6363  * orig_rx_flags contains RXf_* flags. See perlreapi.pod for more details.
6364  *
6365  * pm_flags contains the PMf_* flags, typically based on those from the
6366  * pm_flags field of the related PMOP. Currently we're only interested in
6367  * PMf_HAS_CV, PMf_IS_QR, PMf_USE_RE_EVAL.
6368  *
6369  * We can't allocate space until we know how big the compiled form will be,
6370  * but we can't compile it (and thus know how big it is) until we've got a
6371  * place to put the code.  So we cheat:  we compile it twice, once with code
6372  * generation turned off and size counting turned on, and once "for real".
6373  * This also means that we don't allocate space until we are sure that the
6374  * thing really will compile successfully, and we never have to move the
6375  * code and thus invalidate pointers into it.  (Note that it has to be in
6376  * one piece because free() must be able to free it all.) [NB: not true in perl]
6377  *
6378  * Beware that the optimization-preparation code in here knows about some
6379  * of the structure of the compiled regexp.  [I'll say.]
6380  */
6381
6382 REGEXP *
6383 Perl_re_op_compile(pTHX_ SV ** const patternp, int pat_count,
6384      OP *expr, const regexp_engine* eng, REGEXP *old_re,
6385      bool *is_bare_re, U32 orig_rx_flags, U32 pm_flags)
6386 {
6387  REGEXP *rx;
6388  struct regexp *r;
6389  regexp_internal *ri;
6390  STRLEN plen;
6391  char *exp;
6392  regnode *scan;
6393  I32 flags;
6394  SSize_t minlen = 0;
6395  U32 rx_flags;
6396  SV *pat;
6397  SV *code_blocksv = NULL;
6398  SV** new_patternp = patternp;
6399
6400  /* these are all flags - maybe they should be turned
6401  * into a single int with different bit masks */
6402  I32 sawlookahead = 0;
6403  I32 sawplus = 0;
6404  I32 sawopen = 0;
6405  I32 sawminmod = 0;
6406
6407  regex_charset initial_charset = get_regex_charset(orig_rx_flags);
6408  bool recompile = 0;
6409  bool runtime_code = 0;
6410  scan_data_t data;
6411  RExC_state_t RExC_state;
6412  RExC_state_t * const pRExC_state = &RExC_state;
6413 #ifdef TRIE_STUDY_OPT
6414  int restudied = 0;
6415  RExC_state_t copyRExC_state;
6416 #endif
6417  GET_RE_DEBUG_FLAGS_DECL;
6418
6419  PERL_ARGS_ASSERT_RE_OP_COMPILE;
6420
6421  DEBUG_r(if (!PL_colorset) reginitcolors());
6422
6423  /* Initialize these here instead of as-needed, as is quick and avoids
6424  * having to test them each time otherwise */
6425  if (! PL_AboveLatin1) {
6426   PL_AboveLatin1 = _new_invlist_C_array(AboveLatin1_invlist);
6427   PL_Latin1 = _new_invlist_C_array(Latin1_invlist);
6428   PL_UpperLatin1 = _new_invlist_C_array(UpperLatin1_invlist);
6429   PL_utf8_foldable = _new_invlist_C_array(_Perl_Any_Folds_invlist);
6430   PL_HasMultiCharFold =
6431      _new_invlist_C_array(_Perl_Folds_To_Multi_Char_invlist);
6432
6433   /* This is calculated here, because the Perl program that generates the
6434   * static global ones doesn't currently have access to
6435   * NUM_ANYOF_CODE_POINTS */
6436   PL_InBitmap = _new_invlist(2);
6437   PL_InBitmap = _add_range_to_invlist(PL_InBitmap, 0,
6438              NUM_ANYOF_CODE_POINTS - 1);
6439  }
6440
6441  pRExC_state->code_blocks = NULL;
6442  pRExC_state->num_code_blocks = 0;
6443
6444  if (is_bare_re)
6445   *is_bare_re = FALSE;
6446
6447  if (expr && (expr->op_type == OP_LIST ||
6448     (expr->op_type == OP_NULL && expr->op_targ == OP_LIST))) {
6449   /* allocate code_blocks if needed */
6450   OP *o;
6451   int ncode = 0;
6452
6453   for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o))
6454    if (o->op_type == OP_NULL && (o->op_flags & OPf_SPECIAL))
6455     ncode++; /* count of DO blocks */
6456   if (ncode) {
6457    pRExC_state->num_code_blocks = ncode;
6458    Newx(pRExC_state->code_blocks, ncode, struct reg_code_block);
6459   }
6460  }
6461
6462  if (!pat_count) {
6463   /* compile-time pattern with just OP_CONSTs and DO blocks */
6464
6465   int n;
6466   OP *o;
6467
6468   /* find how many CONSTs there are */
6469   assert(expr);
6470   n = 0;
6471   if (expr->op_type == OP_CONST)
6472    n = 1;
6473   else
6474    for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6475     if (o->op_type == OP_CONST)
6476      n++;
6477    }
6478
6479   /* fake up an SV array */
6480
6481   assert(!new_patternp);
6482   Newx(new_patternp, n, SV*);
6483   SAVEFREEPV(new_patternp);
6484   pat_count = n;
6485
6486   n = 0;
6487   if (expr->op_type == OP_CONST)
6488    new_patternp[n] = cSVOPx_sv(expr);
6489   else
6490    for (o = cLISTOPx(expr)->op_first; o; o = OpSIBLING(o)) {
6491     if (o->op_type == OP_CONST)
6492      new_patternp[n++] = cSVOPo_sv;
6493    }
6494
6495  }
6496
6497  DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
6498   "Assembling pattern from %d elements%s\n", pat_count,
6499    orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6500
6501  /* set expr to the first arg op */
6502
6503  if (pRExC_state->num_code_blocks
6504   && expr->op_type != OP_CONST)
6505  {
6506    expr = cLISTOPx(expr)->op_first;
6507    assert(   expr->op_type == OP_PUSHMARK
6508     || (expr->op_type == OP_NULL && expr->op_targ == OP_PUSHMARK)
6509     || expr->op_type == OP_PADRANGE);
6510    expr = OpSIBLING(expr);
6511  }
6512
6513  pat = S_concat_pat(aTHX_ pRExC_state, NULL, new_patternp, pat_count,
6514       expr, &recompile, NULL);
6515
6516  /* handle bare (possibly after overloading) regex: foo =~ $re */
6517  {
6518   SV *re = pat;
6519   if (SvROK(re))
6520    re = SvRV(re);
6521   if (SvTYPE(re) == SVt_REGEXP) {
6522    if (is_bare_re)
6523     *is_bare_re = TRUE;
6524    SvREFCNT_inc(re);
6525    Safefree(pRExC_state->code_blocks);
6526    DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
6527     "Precompiled pattern%s\n",
6528      orig_rx_flags & RXf_SPLIT ? " for split" : ""));
6529
6530    return (REGEXP*)re;
6531   }
6532  }
6533
6534  exp = SvPV_nomg(pat, plen);
6535
6536  if (!eng->op_comp) {
6537   if ((SvUTF8(pat) && IN_BYTES)
6538     || SvGMAGICAL(pat) || SvAMAGIC(pat))
6539   {
6540    /* make a temporary copy; either to convert to bytes,
6541    * or to avoid repeating get-magic / overloaded stringify */
6542    pat = newSVpvn_flags(exp, plen, SVs_TEMP |
6543           (IN_BYTES ? 0 : SvUTF8(pat)));
6544   }
6545   Safefree(pRExC_state->code_blocks);
6546   return CALLREGCOMP_ENG(eng, pat, orig_rx_flags);
6547  }
6548
6549  /* ignore the utf8ness if the pattern is 0 length */
6550  RExC_utf8 = RExC_orig_utf8 = (plen == 0 || IN_BYTES) ? 0 : SvUTF8(pat);
6551  RExC_uni_semantics = 0;
6552  RExC_contains_locale = 0;
6553  RExC_contains_i = 0;
6554  RExC_strict = cBOOL(pm_flags & RXf_PMf_STRICT);
6555  pRExC_state->runtime_code_qr = NULL;
6556  RExC_frame_head= NULL;
6557  RExC_frame_last= NULL;
6558  RExC_frame_count= 0;
6559
6560  DEBUG_r({
6561   RExC_mysv1= sv_newmortal();
6562   RExC_mysv2= sv_newmortal();
6563  });
6564  DEBUG_COMPILE_r({
6565    SV *dsv= sv_newmortal();
6566    RE_PV_QUOTED_DECL(s, RExC_utf8, dsv, exp, plen, 60);
6567    PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
6568       PL_colors[4],PL_colors[5],s);
6569   });
6570
6571   redo_first_pass:
6572  /* we jump here if we upgrade the pattern to utf8 and have to
6573  * recompile */
6574
6575  if ((pm_flags & PMf_USE_RE_EVAL)
6576     /* this second condition covers the non-regex literal case,
6577     * i.e.  $foo =~ '(?{})'. */
6578     || (IN_PERL_COMPILETIME && (PL_hints & HINT_RE_EVAL))
6579  )
6580   runtime_code = S_has_runtime_code(aTHX_ pRExC_state, exp, plen);
6581
6582  /* return old regex if pattern hasn't changed */
6583  /* XXX: note in the below we have to check the flags as well as the
6584  * pattern.
6585  *
6586  * Things get a touch tricky as we have to compare the utf8 flag
6587  * independently from the compile flags.  */
6588
6589  if (   old_re
6590   && !recompile
6591   && !!RX_UTF8(old_re) == !!RExC_utf8
6592   && ( RX_COMPFLAGS(old_re) == ( orig_rx_flags & RXf_PMf_FLAGCOPYMASK ) )
6593   && RX_PRECOMP(old_re)
6594   && RX_PRELEN(old_re) == plen
6595   && memEQ(RX_PRECOMP(old_re), exp, plen)
6596   && !runtime_code /* with runtime code, always recompile */ )
6597  {
6598   Safefree(pRExC_state->code_blocks);
6599   return old_re;
6600  }
6601
6602  rx_flags = orig_rx_flags;
6603
6604  if (rx_flags & PMf_FOLD) {
6605   RExC_contains_i = 1;
6606  }
6607  if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
6608
6609   /* Set to use unicode semantics if the pattern is in utf8 and has the
6610   * 'depends' charset specified, as it means unicode when utf8  */
6611   set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
6612  }
6613
6614  RExC_precomp = exp;
6615  RExC_flags = rx_flags;
6616  RExC_pm_flags = pm_flags;
6617
6618  if (runtime_code) {
6619   if (TAINTING_get && TAINT_get)
6620    Perl_croak(aTHX_ "Eval-group in insecure regular expression");
6621
6622   if (!S_compile_runtime_code(aTHX_ pRExC_state, exp, plen)) {
6623    /* whoops, we have a non-utf8 pattern, whilst run-time code
6624    * got compiled as utf8. Try again with a utf8 pattern */
6625    S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
6626          pRExC_state->num_code_blocks);
6627    goto redo_first_pass;
6628   }
6629  }
6630  assert(!pRExC_state->runtime_code_qr);
6631
6632  RExC_sawback = 0;
6633
6634  RExC_seen = 0;
6635  RExC_maxlen = 0;
6636  RExC_in_lookbehind = 0;
6637  RExC_seen_zerolen = *exp == '^' ? -1 : 0;
6638  RExC_extralen = 0;
6639  RExC_override_recoding = 0;
6640 #ifdef EBCDIC
6641  RExC_recode_x_to_native = 0;
6642 #endif
6643  RExC_in_multi_char_class = 0;
6644
6645  /* First pass: determine size, legality. */
6646  RExC_parse = exp;
6647  RExC_start = exp;
6648  RExC_end = exp + plen;
6649  RExC_naughty = 0;
6650  RExC_npar = 1;
6651  RExC_nestroot = 0;
6652  RExC_size = 0L;
6653  RExC_emit = (regnode *) &RExC_emit_dummy;
6654  RExC_whilem_seen = 0;
6655  RExC_open_parens = NULL;
6656  RExC_close_parens = NULL;
6657  RExC_opend = NULL;
6658  RExC_paren_names = NULL;
6659 #ifdef DEBUGGING
6660  RExC_paren_name_list = NULL;
6661 #endif
6662  RExC_recurse = NULL;
6663  RExC_study_chunk_recursed = NULL;
6664  RExC_study_chunk_recursed_bytes= 0;
6665  RExC_recurse_count = 0;
6666  pRExC_state->code_index = 0;
6667
6668  DEBUG_PARSE_r(
6669   PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n");
6670   RExC_lastnum=0;
6671   RExC_lastparse=NULL;
6672  );
6673  /* reg may croak on us, not giving us a chance to free
6674  pRExC_state->code_blocks.  We cannot SAVEFREEPV it now, as we may
6675  need it to survive as long as the regexp (qr/(?{})/).
6676  We must check that code_blocksv is not already set, because we may
6677  have jumped back to restart the sizing pass. */
6678  if (pRExC_state->code_blocks && !code_blocksv) {
6679   code_blocksv = newSV_type(SVt_PV);
6680   SAVEFREESV(code_blocksv);
6681   SvPV_set(code_blocksv, (char *)pRExC_state->code_blocks);
6682   SvLEN_set(code_blocksv, 1); /*sufficient to make sv_clear free it*/
6683  }
6684  if (reg(pRExC_state, 0, &flags,1) == NULL) {
6685   /* It's possible to write a regexp in ascii that represents Unicode
6686   codepoints outside of the byte range, such as via \x{100}. If we
6687   detect such a sequence we have to convert the entire pattern to utf8
6688   and then recompile, as our sizing calculation will have been based
6689   on 1 byte == 1 character, but we will need to use utf8 to encode
6690   at least some part of the pattern, and therefore must convert the whole
6691   thing.
6692   -- dmq */
6693   if (flags & RESTART_UTF8) {
6694    S_pat_upgrade_to_utf8(aTHX_ pRExC_state, &exp, &plen,
6695          pRExC_state->num_code_blocks);
6696    goto redo_first_pass;
6697   }
6698   Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for sizing pass, flags=%#"UVxf"", (UV) flags);
6699  }
6700  if (code_blocksv)
6701   SvLEN_set(code_blocksv,0); /* no you can't have it, sv_clear */
6702
6703  DEBUG_PARSE_r({
6704   PerlIO_printf(Perl_debug_log,
6705    "Required size %"IVdf" nodes\n"
6706    "Starting second pass (creation)\n",
6707    (IV)RExC_size);
6708   RExC_lastnum=0;
6709   RExC_lastparse=NULL;
6710  });
6711
6712  /* The first pass could have found things that force Unicode semantics */
6713  if ((RExC_utf8 || RExC_uni_semantics)
6714   && get_regex_charset(rx_flags) == REGEX_DEPENDS_CHARSET)
6715  {
6716   set_regex_charset(&rx_flags, REGEX_UNICODE_CHARSET);
6717  }
6718
6719  /* Small enough for pointer-storage convention?
6720  If extralen==0, this means that we will not need long jumps. */
6721  if (RExC_size >= 0x10000L && RExC_extralen)
6722   RExC_size += RExC_extralen;
6723  else
6724   RExC_extralen = 0;
6725  if (RExC_whilem_seen > 15)
6726   RExC_whilem_seen = 15;
6727
6728  /* Allocate space and zero-initialize. Note, the two step process
6729  of zeroing when in debug mode, thus anything assigned has to
6730  happen after that */
6731  rx = (REGEXP*) newSV_type(SVt_REGEXP);
6732  r = ReANY(rx);
6733  Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
6734   char, regexp_internal);
6735  if ( r == NULL || ri == NULL )
6736   FAIL("Regexp out of space");
6737 #ifdef DEBUGGING
6738  /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
6739  Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
6740   char);
6741 #else
6742  /* bulk initialize base fields with 0. */
6743  Zero(ri, sizeof(regexp_internal), char);
6744 #endif
6745
6746  /* non-zero initialization begins here */
6747  RXi_SET( r, ri );
6748  r->engine= eng;
6749  r->extflags = rx_flags;
6750  RXp_COMPFLAGS(r) = orig_rx_flags & RXf_PMf_FLAGCOPYMASK;
6751
6752  if (pm_flags & PMf_IS_QR) {
6753   ri->code_blocks = pRExC_state->code_blocks;
6754   ri->num_code_blocks = pRExC_state->num_code_blocks;
6755  }
6756  else
6757  {
6758   int n;
6759   for (n = 0; n < pRExC_state->num_code_blocks; n++)
6760    if (pRExC_state->code_blocks[n].src_regex)
6761     SAVEFREESV(pRExC_state->code_blocks[n].src_regex);
6762   SAVEFREEPV(pRExC_state->code_blocks);
6763  }
6764
6765  {
6766   bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
6767   bool has_charset = (get_regex_charset(r->extflags)
6768              != REGEX_DEPENDS_CHARSET);
6769
6770   /* The caret is output if there are any defaults: if not all the STD
6771   * flags are set, or if no character set specifier is needed */
6772   bool has_default =
6773      (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
6774      || ! has_charset);
6775   bool has_runon = ((RExC_seen & REG_RUN_ON_COMMENT_SEEN)
6776             == REG_RUN_ON_COMMENT_SEEN);
6777   U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
6778        >> RXf_PMf_STD_PMMOD_SHIFT);
6779   const char *fptr = STD_PAT_MODS;        /*"msixn"*/
6780   char *p;
6781   /* Allocate for the worst case, which is all the std flags are turned
6782   * on.  If more precision is desired, we could do a population count of
6783   * the flags set.  This could be done with a small lookup table, or by
6784   * shifting, masking and adding, or even, when available, assembly
6785   * language for a machine-language population count.
6786   * We never output a minus, as all those are defaults, so are
6787   * covered by the caret */
6788   const STRLEN wraplen = plen + has_p + has_runon
6789    + has_default       /* If needs a caret */
6790
6791     /* If needs a character set specifier */
6792    + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
6793    + (sizeof(STD_PAT_MODS) - 1)
6794    + (sizeof("(?:)") - 1);
6795
6796   Newx(p, wraplen + 1, char); /* +1 for the ending NUL */
6797   r->xpv_len_u.xpvlenu_pv = p;
6798   if (RExC_utf8)
6799    SvFLAGS(rx) |= SVf_UTF8;
6800   *p++='('; *p++='?';
6801
6802   /* If a default, cover it using the caret */
6803   if (has_default) {
6804    *p++= DEFAULT_PAT_MOD;
6805   }
6806   if (has_charset) {
6807    STRLEN len;
6808    const char* const name = get_regex_charset_name(r->extflags, &len);
6809    Copy(name, p, len, char);
6810    p += len;
6811   }
6812   if (has_p)
6813    *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
6814   {
6815    char ch;
6816    while((ch = *fptr++)) {
6817     if(reganch & 1)
6818      *p++ = ch;
6819     reganch >>= 1;
6820    }
6821   }
6822
6823   *p++ = ':';
6824   Copy(RExC_precomp, p, plen, char);
6825   assert ((RX_WRAPPED(rx) - p) < 16);
6826   r->pre_prefix = p - RX_WRAPPED(rx);
6827   p += plen;
6828   if (has_runon)
6829    *p++ = '\n';
6830   *p++ = ')';
6831   *p = 0;
6832   SvCUR_set(rx, p - RX_WRAPPED(rx));
6833  }
6834
6835  r->intflags = 0;
6836  r->nparens = RExC_npar - 1; /* set early to validate backrefs */
6837
6838  /* setup various meta data about recursion, this all requires
6839  * RExC_npar to be correctly set, and a bit later on we clear it */
6840  if (RExC_seen & REG_RECURSE_SEEN) {
6841   Newxz(RExC_open_parens, RExC_npar,regnode *);
6842   SAVEFREEPV(RExC_open_parens);
6843   Newxz(RExC_close_parens,RExC_npar,regnode *);
6844   SAVEFREEPV(RExC_close_parens);
6845  }
6846  if (RExC_seen & (REG_RECURSE_SEEN | REG_GOSTART_SEEN)) {
6847   /* Note, RExC_npar is 1 + the number of parens in a pattern.
6848   * So its 1 if there are no parens. */
6849   RExC_study_chunk_recursed_bytes= (RExC_npar >> 3) +
6850           ((RExC_npar & 0x07) != 0);
6851   Newx(RExC_study_chunk_recursed,
6852    RExC_study_chunk_recursed_bytes * RExC_npar, U8);
6853   SAVEFREEPV(RExC_study_chunk_recursed);
6854  }
6855
6856  /* Useful during FAIL. */
6857 #ifdef RE_TRACK_PATTERN_OFFSETS
6858  Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
6859  DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
6860       "%s %"UVuf" bytes for offset annotations.\n",
6861       ri->u.offsets ? "Got" : "Couldn't get",
6862       (UV)((2*RExC_size+1) * sizeof(U32))));
6863 #endif
6864  SetProgLen(ri,RExC_size);
6865  RExC_rx_sv = rx;
6866  RExC_rx = r;
6867  RExC_rxi = ri;
6868  REH_CALL_COMP_BEGIN_HOOK(pRExC_state->rx);
6869
6870  /* Second pass: emit code. */
6871  RExC_flags = rx_flags; /* don't let top level (?i) bleed */
6872  RExC_pm_flags = pm_flags;
6873  RExC_parse = exp;
6874  RExC_end = exp + plen;
6875  RExC_naughty = 0;
6876  RExC_npar = 1;
6877  RExC_emit_start = ri->program;
6878  RExC_emit = ri->program;
6879  RExC_emit_bound = ri->program + RExC_size + 1;
6880  pRExC_state->code_index = 0;
6881
6882  *((char*) RExC_emit++) = (char) REG_MAGIC;
6883  if (reg(pRExC_state, 0, &flags,1) == NULL) {
6884   ReREFCNT_dec(rx);
6885   Perl_croak(aTHX_ "panic: reg returned NULL to re_op_compile for generation pass, flags=%#"UVxf"", (UV) flags);
6886  }
6887  /* XXXX To minimize changes to RE engine we always allocate
6888  3-units-long substrs field. */
6889  Newx(r->substrs, 1, struct reg_substr_data);
6890  if (RExC_recurse_count) {
6891   Newxz(RExC_recurse,RExC_recurse_count,regnode *);
6892   SAVEFREEPV(RExC_recurse);
6893  }
6894
6895   reStudy:
6896  r->minlen = minlen = sawlookahead = sawplus = sawopen = sawminmod = 0;
6897  DEBUG_r(
6898   RExC_study_chunk_recursed_count= 0;
6899  );
6900  Zero(r->substrs, 1, struct reg_substr_data);
6901  if (RExC_study_chunk_recursed) {
6902   Zero(RExC_study_chunk_recursed,
6903    RExC_study_chunk_recursed_bytes * RExC_npar, U8);
6904  }
6905
6906
6907 #ifdef TRIE_STUDY_OPT
6908  if (!restudied) {
6909   StructCopy(&zero_scan_data, &data, scan_data_t);
6910   copyRExC_state = RExC_state;
6911  } else {
6912   U32 seen=RExC_seen;
6913   DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
6914
6915   RExC_state = copyRExC_state;
6916   if (seen & REG_TOP_LEVEL_BRANCHES_SEEN)
6917    RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
6918   else
6919    RExC_seen &= ~REG_TOP_LEVEL_BRANCHES_SEEN;
6920   StructCopy(&zero_scan_data, &data, scan_data_t);
6921  }
6922 #else
6923  StructCopy(&zero_scan_data, &data, scan_data_t);
6924 #endif
6925
6926  /* Dig out information for optimizations. */
6927  r->extflags = RExC_flags; /* was pm_op */
6928  /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
6929
6930  if (UTF)
6931   SvUTF8_on(rx); /* Unicode in it? */
6932  ri->regstclass = NULL;
6933  if (RExC_naughty >= TOO_NAUGHTY) /* Probably an expensive pattern. */
6934   r->intflags |= PREGf_NAUGHTY;
6935  scan = ri->program + 1;  /* First BRANCH. */
6936
6937  /* testing for BRANCH here tells us whether there is "must appear"
6938  data in the pattern. If there is then we can use it for optimisations */
6939  if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)) { /*  Only one top-level choice.
6940             */
6941   SSize_t fake;
6942   STRLEN longest_float_length, longest_fixed_length;
6943   regnode_ssc ch_class; /* pointed to by data */
6944   int stclass_flag;
6945   SSize_t last_close = 0; /* pointed to by data */
6946   regnode *first= scan;
6947   regnode *first_next= regnext(first);
6948   /*
6949   * Skip introductions and multiplicators >= 1
6950   * so that we can extract the 'meat' of the pattern that must
6951   * match in the large if() sequence following.
6952   * NOTE that EXACT is NOT covered here, as it is normally
6953   * picked up by the optimiser separately.
6954   *
6955   * This is unfortunate as the optimiser isnt handling lookahead
6956   * properly currently.
6957   *
6958   */
6959   while ((OP(first) == OPEN && (sawopen = 1)) ||
6960    /* An OR of *one* alternative - should not happen now. */
6961    (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
6962    /* for now we can't handle lookbehind IFMATCH*/
6963    (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
6964    (OP(first) == PLUS) ||
6965    (OP(first) == MINMOD) ||
6966    /* An {n,m} with n>0 */
6967    (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
6968    (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
6969   {
6970     /*
6971     * the only op that could be a regnode is PLUS, all the rest
6972     * will be regnode_1 or regnode_2.
6973     *
6974     * (yves doesn't think this is true)
6975     */
6976     if (OP(first) == PLUS)
6977      sawplus = 1;
6978     else {
6979      if (OP(first) == MINMOD)
6980       sawminmod = 1;
6981      first += regarglen[OP(first)];
6982     }
6983     first = NEXTOPER(first);
6984     first_next= regnext(first);
6985   }
6986
6987   /* Starting-point info. */
6988  again:
6989   DEBUG_PEEP("first:",first,0);
6990   /* Ignore EXACT as we deal with it later. */
6991   if (PL_regkind[OP(first)] == EXACT) {
6992    if (OP(first) == EXACT || OP(first) == EXACTL)
6993     NOOP; /* Empty, get anchored substr later. */
6994    else
6995     ri->regstclass = first;
6996   }
6997 #ifdef TRIE_STCLASS
6998   else if (PL_regkind[OP(first)] == TRIE &&
6999     ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0)
7000   {
7001    /* this can happen only on restudy */
7002    ri->regstclass = construct_ahocorasick_from_trie(pRExC_state, (regnode *)first, 0);
7003   }
7004 #endif
7005   else if (REGNODE_SIMPLE(OP(first)))
7006    ri->regstclass = first;
7007   else if (PL_regkind[OP(first)] == BOUND ||
7008     PL_regkind[OP(first)] == NBOUND)
7009    ri->regstclass = first;
7010   else if (PL_regkind[OP(first)] == BOL) {
7011    r->intflags |= (OP(first) == MBOL
7012       ? PREGf_ANCH_MBOL
7013       : PREGf_ANCH_SBOL);
7014    first = NEXTOPER(first);
7015    goto again;
7016   }
7017   else if (OP(first) == GPOS) {
7018    r->intflags |= PREGf_ANCH_GPOS;
7019    first = NEXTOPER(first);
7020    goto again;
7021   }
7022   else if ((!sawopen || !RExC_sawback) &&
7023    !sawlookahead &&
7024    (OP(first) == STAR &&
7025    PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
7026    !(r->intflags & PREGf_ANCH) && !pRExC_state->num_code_blocks)
7027   {
7028    /* turn .* into ^.* with an implied $*=1 */
7029    const int type =
7030     (OP(NEXTOPER(first)) == REG_ANY)
7031      ? PREGf_ANCH_MBOL
7032      : PREGf_ANCH_SBOL;
7033    r->intflags |= (type | PREGf_IMPLICIT);
7034    first = NEXTOPER(first);
7035    goto again;
7036   }
7037   if (sawplus && !sawminmod && !sawlookahead
7038    && (!sawopen || !RExC_sawback)
7039    && !pRExC_state->num_code_blocks) /* May examine pos and $& */
7040    /* x+ must match at the 1st pos of run of x's */
7041    r->intflags |= PREGf_SKIP;
7042
7043   /* Scan is after the zeroth branch, first is atomic matcher. */
7044 #ifdef TRIE_STUDY_OPT
7045   DEBUG_PARSE_r(
7046    if (!restudied)
7047     PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
7048        (IV)(first - scan + 1))
7049   );
7050 #else
7051   DEBUG_PARSE_r(
7052    PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
7053     (IV)(first - scan + 1))
7054   );
7055 #endif
7056
7057
7058   /*
7059   * If there's something expensive in the r.e., find the
7060   * longest literal string that must appear and make it the
7061   * regmust.  Resolve ties in favor of later strings, since
7062   * the regstart check works with the beginning of the r.e.
7063   * and avoiding duplication strengthens checking.  Not a
7064   * strong reason, but sufficient in the absence of others.
7065   * [Now we resolve ties in favor of the earlier string if
7066   * it happens that c_offset_min has been invalidated, since the
7067   * earlier string may buy us something the later one won't.]
7068   */
7069
7070   data.longest_fixed = newSVpvs("");
7071   data.longest_float = newSVpvs("");
7072   data.last_found = newSVpvs("");
7073   data.longest = &(data.longest_fixed);
7074   ENTER_with_name("study_chunk");
7075   SAVEFREESV(data.longest_fixed);
7076   SAVEFREESV(data.longest_float);
7077   SAVEFREESV(data.last_found);
7078   first = scan;
7079   if (!ri->regstclass) {
7080    ssc_init(pRExC_state, &ch_class);
7081    data.start_class = &ch_class;
7082    stclass_flag = SCF_DO_STCLASS_AND;
7083   } else    /* XXXX Check for BOUND? */
7084    stclass_flag = 0;
7085   data.last_closep = &last_close;
7086
7087   DEBUG_RExC_seen();
7088   minlen = study_chunk(pRExC_state, &first, &minlen, &fake,
7089        scan + RExC_size, /* Up to end */
7090    &data, -1, 0, NULL,
7091    SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag
7092       | (restudied ? SCF_TRIE_DOING_RESTUDY : 0),
7093    0);
7094
7095
7096   CHECK_RESTUDY_GOTO_butfirst(LEAVE_with_name("study_chunk"));
7097
7098
7099   if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
7100    && data.last_start_min == 0 && data.last_end > 0
7101    && !RExC_seen_zerolen
7102    && !(RExC_seen & REG_VERBARG_SEEN)
7103    && !(RExC_seen & REG_GPOS_SEEN)
7104   ){
7105    r->extflags |= RXf_CHECK_ALL;
7106   }
7107   scan_commit(pRExC_state, &data,&minlen,0);
7108
7109   longest_float_length = CHR_SVLEN(data.longest_float);
7110
7111   if (! ((SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
7112     && data.offset_fixed == data.offset_float_min
7113     && SvCUR(data.longest_fixed) == SvCUR(data.longest_float)))
7114    && S_setup_longest (aTHX_ pRExC_state,
7115          data.longest_float,
7116          &(r->float_utf8),
7117          &(r->float_substr),
7118          &(r->float_end_shift),
7119          data.lookbehind_float,
7120          data.offset_float_min,
7121          data.minlen_float,
7122          longest_float_length,
7123          cBOOL(data.flags & SF_FL_BEFORE_EOL),
7124          cBOOL(data.flags & SF_FL_BEFORE_MEOL)))
7125   {
7126    r->float_min_offset = data.offset_float_min - data.lookbehind_float;
7127    r->float_max_offset = data.offset_float_max;
7128    if (data.offset_float_max < SSize_t_MAX) /* Don't offset infinity */
7129     r->float_max_offset -= data.lookbehind_float;
7130    SvREFCNT_inc_simple_void_NN(data.longest_float);
7131   }
7132   else {
7133    r->float_substr = r->float_utf8 = NULL;
7134    longest_float_length = 0;
7135   }
7136
7137   longest_fixed_length = CHR_SVLEN(data.longest_fixed);
7138
7139   if (S_setup_longest (aTHX_ pRExC_state,
7140         data.longest_fixed,
7141         &(r->anchored_utf8),
7142         &(r->anchored_substr),
7143         &(r->anchored_end_shift),
7144         data.lookbehind_fixed,
7145         data.offset_fixed,
7146         data.minlen_fixed,
7147         longest_fixed_length,
7148         cBOOL(data.flags & SF_FIX_BEFORE_EOL),
7149         cBOOL(data.flags & SF_FIX_BEFORE_MEOL)))
7150   {
7151    r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
7152    SvREFCNT_inc_simple_void_NN(data.longest_fixed);
7153   }
7154   else {
7155    r->anchored_substr = r->anchored_utf8 = NULL;
7156    longest_fixed_length = 0;
7157   }
7158   LEAVE_with_name("study_chunk");
7159
7160   if (ri->regstclass
7161    && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
7162    ri->regstclass = NULL;
7163
7164   if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
7165    && stclass_flag
7166    && ! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7167    && is_ssc_worth_it(pRExC_state, data.start_class))
7168   {
7169    const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7170
7171    ssc_finalize(pRExC_state, data.start_class);
7172
7173    Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7174    StructCopy(data.start_class,
7175      (regnode_ssc*)RExC_rxi->data->data[n],
7176      regnode_ssc);
7177    ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7178    r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7179    DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
7180      regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7181      PerlIO_printf(Perl_debug_log,
7182          "synthetic stclass \"%s\".\n",
7183          SvPVX_const(sv));});
7184    data.start_class = NULL;
7185   }
7186
7187   /* A temporary algorithm prefers floated substr to fixed one to dig
7188   * more info. */
7189   if (longest_fixed_length > longest_float_length) {
7190    r->substrs->check_ix = 0;
7191    r->check_end_shift = r->anchored_end_shift;
7192    r->check_substr = r->anchored_substr;
7193    r->check_utf8 = r->anchored_utf8;
7194    r->check_offset_min = r->check_offset_max = r->anchored_offset;
7195    if (r->intflags & (PREGf_ANCH_SBOL|PREGf_ANCH_GPOS))
7196     r->intflags |= PREGf_NOSCAN;
7197   }
7198   else {
7199    r->substrs->check_ix = 1;
7200    r->check_end_shift = r->float_end_shift;
7201    r->check_substr = r->float_substr;
7202    r->check_utf8 = r->float_utf8;
7203    r->check_offset_min = r->float_min_offset;
7204    r->check_offset_max = r->float_max_offset;
7205   }
7206   if ((r->check_substr || r->check_utf8) ) {
7207    r->extflags |= RXf_USE_INTUIT;
7208    if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
7209     r->extflags |= RXf_INTUIT_TAIL;
7210   }
7211   r->substrs->data[0].max_offset = r->substrs->data[0].min_offset;
7212
7213   /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
7214   if ( (STRLEN)minlen < longest_float_length )
7215    minlen= longest_float_length;
7216   if ( (STRLEN)minlen < longest_fixed_length )
7217    minlen= longest_fixed_length;
7218   */
7219  }
7220  else {
7221   /* Several toplevels. Best we can is to set minlen. */
7222   SSize_t fake;
7223   regnode_ssc ch_class;
7224   SSize_t last_close = 0;
7225
7226   DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
7227
7228   scan = ri->program + 1;
7229   ssc_init(pRExC_state, &ch_class);
7230   data.start_class = &ch_class;
7231   data.last_closep = &last_close;
7232
7233   DEBUG_RExC_seen();
7234   minlen = study_chunk(pRExC_state,
7235    &scan, &minlen, &fake, scan + RExC_size, &data, -1, 0, NULL,
7236    SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS|(restudied
7237              ? SCF_TRIE_DOING_RESTUDY
7238              : 0),
7239    0);
7240
7241   CHECK_RESTUDY_GOTO_butfirst(NOOP);
7242
7243   r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
7244     = r->float_substr = r->float_utf8 = NULL;
7245
7246   if (! (ANYOF_FLAGS(data.start_class) & SSC_MATCHES_EMPTY_STRING)
7247    && is_ssc_worth_it(pRExC_state, data.start_class))
7248   {
7249    const U32 n = add_data(pRExC_state, STR_WITH_LEN("f"));
7250
7251    ssc_finalize(pRExC_state, data.start_class);
7252
7253    Newx(RExC_rxi->data->data[n], 1, regnode_ssc);
7254    StructCopy(data.start_class,
7255      (regnode_ssc*)RExC_rxi->data->data[n],
7256      regnode_ssc);
7257    ri->regstclass = (regnode*)RExC_rxi->data->data[n];
7258    r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
7259    DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
7260      regprop(r, sv, (regnode*)data.start_class, NULL, pRExC_state);
7261      PerlIO_printf(Perl_debug_log,
7262          "synthetic stclass \"%s\".\n",
7263          SvPVX_const(sv));});
7264    data.start_class = NULL;
7265   }
7266  }
7267
7268  if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN) {
7269   r->extflags |= RXf_UNBOUNDED_QUANTIFIER_SEEN;
7270   r->maxlen = REG_INFTY;
7271  }
7272  else {
7273   r->maxlen = RExC_maxlen;
7274  }
7275
7276  /* Guard against an embedded (?=) or (?<=) with a longer minlen than
7277  the "real" pattern. */
7278  DEBUG_OPTIMISE_r({
7279   PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf" maxlen:%"IVdf"\n",
7280      (IV)minlen, (IV)r->minlen, (IV)RExC_maxlen);
7281  });
7282  r->minlenret = minlen;
7283  if (r->minlen < minlen)
7284   r->minlen = minlen;
7285
7286  if (RExC_seen & REG_GPOS_SEEN)
7287   r->intflags |= PREGf_GPOS_SEEN;
7288  if (RExC_seen & REG_LOOKBEHIND_SEEN)
7289   r->extflags |= RXf_NO_INPLACE_SUBST; /* inplace might break the
7290             lookbehind */
7291  if (pRExC_state->num_code_blocks)
7292   r->extflags |= RXf_EVAL_SEEN;
7293  if (RExC_seen & REG_CANY_SEEN)
7294   r->intflags |= PREGf_CANY_SEEN;
7295  if (RExC_seen & REG_VERBARG_SEEN)
7296  {
7297   r->intflags |= PREGf_VERBARG_SEEN;
7298   r->extflags |= RXf_NO_INPLACE_SUBST; /* don't understand this! Yves */
7299  }
7300  if (RExC_seen & REG_CUTGROUP_SEEN)
7301   r->intflags |= PREGf_CUTGROUP_SEEN;
7302  if (pm_flags & PMf_USE_RE_EVAL)
7303   r->intflags |= PREGf_USE_RE_EVAL;
7304  if (RExC_paren_names)
7305   RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
7306  else
7307   RXp_PAREN_NAMES(r) = NULL;
7308
7309  /* If we have seen an anchor in our pattern then we set the extflag RXf_IS_ANCHORED
7310  * so it can be used in pp.c */
7311  if (r->intflags & PREGf_ANCH)
7312   r->extflags |= RXf_IS_ANCHORED;
7313
7314
7315  {
7316   /* this is used to identify "special" patterns that might result
7317   * in Perl NOT calling the regex engine and instead doing the match "itself",
7318   * particularly special cases in split//. By having the regex compiler
7319   * do this pattern matching at a regop level (instead of by inspecting the pattern)
7320   * we avoid weird issues with equivalent patterns resulting in different behavior,
7321   * AND we allow non Perl engines to get the same optimizations by the setting the
7322   * flags appropriately - Yves */
7323   regnode *first = ri->program + 1;
7324   U8 fop = OP(first);
7325   regnode *next = regnext(first);
7326   U8 nop = OP(next);
7327
7328   if (PL_regkind[fop] == NOTHING && nop == END)
7329    r->extflags |= RXf_NULL;
7330   else if ((fop == MBOL || (fop == SBOL && !first->flags)) && nop == END)
7331    /* when fop is SBOL first->flags will be true only when it was
7332    * produced by parsing /\A/, and not when parsing /^/. This is
7333    * very important for the split code as there we want to
7334    * treat /^/ as /^/m, but we do not want to treat /\A/ as /^/m.
7335    * See rt #122761 for more details. -- Yves */
7336    r->extflags |= RXf_START_ONLY;
7337   else if (fop == PLUS
7338     && PL_regkind[nop] == POSIXD && FLAGS(next) == _CC_SPACE
7339     && nop == END)
7340    r->extflags |= RXf_WHITE;
7341   else if ( r->extflags & RXf_SPLIT
7342     && (fop == EXACT || fop == EXACTL)
7343     && STR_LEN(first) == 1
7344     && *(STRING(first)) == ' '
7345     && nop == END )
7346    r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);
7347
7348  }
7349
7350  if (RExC_contains_locale) {
7351   RXp_EXTFLAGS(r) |= RXf_TAINTED;
7352  }
7353
7354 #ifdef DEBUGGING
7355  if (RExC_paren_names) {
7356   ri->name_list_idx = add_data( pRExC_state, STR_WITH_LEN("a"));
7357   ri->data->data[ri->name_list_idx]
7358         = (void*)SvREFCNT_inc(RExC_paren_name_list);
7359  } else
7360 #endif
7361   ri->name_list_idx = 0;
7362
7363  if (RExC_recurse_count) {
7364   for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
7365    const regnode *scan = RExC_recurse[RExC_recurse_count-1];
7366    ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
7367   }
7368  }
7369  Newxz(r->offs, RExC_npar, regexp_paren_pair);
7370  /* assume we don't need to swap parens around before we match */
7371  DEBUG_TEST_r({
7372   PerlIO_printf(Perl_debug_log,"study_chunk_recursed_count: %lu\n",
7373    (unsigned long)RExC_study_chunk_recursed_count);
7374  });
7375  DEBUG_DUMP_r({
7376   DEBUG_RExC_seen();
7377   PerlIO_printf(Perl_debug_log,"Final program:\n");
7378   regdump(r);
7379  });
7380 #ifdef RE_TRACK_PATTERN_OFFSETS
7381  DEBUG_OFFSETS_r(if (ri->u.offsets) {
7382   const STRLEN len = ri->u.offsets[0];
7383   STRLEN i;
7384   GET_RE_DEBUG_FLAGS_DECL;
7385   PerlIO_printf(Perl_debug_log,
7386      "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
7387   for (i = 1; i <= len; i++) {
7388    if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
7389     PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
7390     (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
7391    }
7392   PerlIO_printf(Perl_debug_log, "\n");
7393  });
7394 #endif
7395
7396 #ifdef USE_ITHREADS
7397  /* under ithreads the ?pat? PMf_USED flag on the pmop is simulated
7398  * by setting the regexp SV to readonly-only instead. If the
7399  * pattern's been recompiled, the USEDness should remain. */
7400  if (old_re && SvREADONLY(old_re))
7401   SvREADONLY_on(rx);
7402 #endif
7403  return rx;
7404 }
7405
7406
7407 SV*
7408 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
7409      const U32 flags)
7410 {
7411  PERL_ARGS_ASSERT_REG_NAMED_BUFF;
7412
7413  PERL_UNUSED_ARG(value);
7414
7415  if (flags & RXapif_FETCH) {
7416   return reg_named_buff_fetch(rx, key, flags);
7417  } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
7418   Perl_croak_no_modify();
7419   return NULL;
7420  } else if (flags & RXapif_EXISTS) {
7421   return reg_named_buff_exists(rx, key, flags)
7422    ? &PL_sv_yes
7423    : &PL_sv_no;
7424  } else if (flags & RXapif_REGNAMES) {
7425   return reg_named_buff_all(rx, flags);
7426  } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
7427   return reg_named_buff_scalar(rx, flags);
7428  } else {
7429   Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
7430   return NULL;
7431  }
7432 }
7433
7434 SV*
7435 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
7436       const U32 flags)
7437 {
7438  PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
7439  PERL_UNUSED_ARG(lastkey);
7440
7441  if (flags & RXapif_FIRSTKEY)
7442   return reg_named_buff_firstkey(rx, flags);
7443  else if (flags & RXapif_NEXTKEY)
7444   return reg_named_buff_nextkey(rx, flags);
7445  else {
7446   Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter",
7447            (int)flags);
7448   return NULL;
7449  }
7450 }
7451
7452 SV*
7453 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
7454       const U32 flags)
7455 {
7456  AV *retarray = NULL;
7457  SV *ret;
7458  struct regexp *const rx = ReANY(r);
7459
7460  PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
7461
7462  if (flags & RXapif_ALL)
7463   retarray=newAV();
7464
7465  if (rx && RXp_PAREN_NAMES(rx)) {
7466   HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
7467   if (he_str) {
7468    IV i;
7469    SV* sv_dat=HeVAL(he_str);
7470    I32 *nums=(I32*)SvPVX(sv_dat);
7471    for ( i=0; i<SvIVX(sv_dat); i++ ) {
7472     if ((I32)(rx->nparens) >= nums[i]
7473      && rx->offs[nums[i]].start != -1
7474      && rx->offs[nums[i]].end != -1)
7475     {
7476      ret = newSVpvs("");
7477      CALLREG_NUMBUF_FETCH(r,nums[i],ret);
7478      if (!retarray)
7479       return ret;
7480     } else {
7481      if (retarray)
7482       ret = newSVsv(&PL_sv_undef);
7483     }
7484     if (retarray)
7485      av_push(retarray, ret);
7486    }
7487    if (retarray)
7488     return newRV_noinc(MUTABLE_SV(retarray));
7489   }
7490  }
7491  return NULL;
7492 }
7493
7494 bool
7495 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
7496       const U32 flags)
7497 {
7498  struct regexp *const rx = ReANY(r);
7499
7500  PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
7501
7502  if (rx && RXp_PAREN_NAMES(rx)) {
7503   if (flags & RXapif_ALL) {
7504    return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
7505   } else {
7506    SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
7507    if (sv) {
7508     SvREFCNT_dec_NN(sv);
7509     return TRUE;
7510    } else {
7511     return FALSE;
7512    }
7513   }
7514  } else {
7515   return FALSE;
7516  }
7517 }
7518
7519 SV*
7520 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
7521 {
7522  struct regexp *const rx = ReANY(r);
7523
7524  PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
7525
7526  if ( rx && RXp_PAREN_NAMES(rx) ) {
7527   (void)hv_iterinit(RXp_PAREN_NAMES(rx));
7528
7529   return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
7530  } else {
7531   return FALSE;
7532  }
7533 }
7534
7535 SV*
7536 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
7537 {
7538  struct regexp *const rx = ReANY(r);
7539  GET_RE_DEBUG_FLAGS_DECL;
7540
7541  PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
7542
7543  if (rx && RXp_PAREN_NAMES(rx)) {
7544   HV *hv = RXp_PAREN_NAMES(rx);
7545   HE *temphe;
7546   while ( (temphe = hv_iternext_flags(hv,0)) ) {
7547    IV i;
7548    IV parno = 0;
7549    SV* sv_dat = HeVAL(temphe);
7550    I32 *nums = (I32*)SvPVX(sv_dat);
7551    for ( i = 0; i < SvIVX(sv_dat); i++ ) {
7552     if ((I32)(rx->lastparen) >= nums[i] &&
7553      rx->offs[nums[i]].start != -1 &&
7554      rx->offs[nums[i]].end != -1)
7555     {
7556      parno = nums[i];
7557      break;
7558     }
7559    }
7560    if (parno || flags & RXapif_ALL) {
7561     return newSVhek(HeKEY_hek(temphe));
7562    }
7563   }
7564  }
7565  return NULL;
7566 }
7567
7568 SV*
7569 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
7570 {
7571  SV *ret;
7572  AV *av;
7573  SSize_t length;
7574  struct regexp *const rx = ReANY(r);
7575
7576  PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
7577
7578  if (rx && RXp_PAREN_NAMES(rx)) {
7579   if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
7580    return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
7581   } else if (flags & RXapif_ONE) {
7582    ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
7583    av = MUTABLE_AV(SvRV(ret));
7584    length = av_tindex(av);
7585    SvREFCNT_dec_NN(ret);
7586    return newSViv(length + 1);
7587   } else {
7588    Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar",
7589             (int)flags);
7590    return NULL;
7591   }
7592  }
7593  return &PL_sv_undef;
7594 }
7595
7596 SV*
7597 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
7598 {
7599  struct regexp *const rx = ReANY(r);
7600  AV *av = newAV();
7601
7602  PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
7603
7604  if (rx && RXp_PAREN_NAMES(rx)) {
7605   HV *hv= RXp_PAREN_NAMES(rx);
7606   HE *temphe;
7607   (void)hv_iterinit(hv);
7608   while ( (temphe = hv_iternext_flags(hv,0)) ) {
7609    IV i;
7610    IV parno = 0;
7611    SV* sv_dat = HeVAL(temphe);
7612    I32 *nums = (I32*)SvPVX(sv_dat);
7613    for ( i = 0; i < SvIVX(sv_dat); i++ ) {
7614     if ((I32)(rx->lastparen) >= nums[i] &&
7615      rx->offs[nums[i]].start != -1 &&
7616      rx->offs[nums[i]].end != -1)
7617     {
7618      parno = nums[i];
7619      break;
7620     }
7621    }
7622    if (parno || flags & RXapif_ALL) {
7623     av_push(av, newSVhek(HeKEY_hek(temphe)));
7624    }
7625   }
7626  }
7627
7628  return newRV_noinc(MUTABLE_SV(av));
7629 }
7630
7631 void
7632 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
7633        SV * const sv)
7634 {
7635  struct regexp *const rx = ReANY(r);
7636  char *s = NULL;
7637  SSize_t i = 0;
7638  SSize_t s1, t1;
7639  I32 n = paren;
7640
7641  PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
7642
7643  if (      n == RX_BUFF_IDX_CARET_PREMATCH
7644   || n == RX_BUFF_IDX_CARET_FULLMATCH
7645   || n == RX_BUFF_IDX_CARET_POSTMATCH
7646  )
7647  {
7648   bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
7649   if (!keepcopy) {
7650    /* on something like
7651    *    $r = qr/.../;
7652    *    /$qr/p;
7653    * the KEEPCOPY is set on the PMOP rather than the regex */
7654    if (PL_curpm && r == PM_GETRE(PL_curpm))
7655     keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
7656   }
7657   if (!keepcopy)
7658    goto ret_undef;
7659  }
7660
7661  if (!rx->subbeg)
7662   goto ret_undef;
7663
7664  if (n == RX_BUFF_IDX_CARET_FULLMATCH)
7665   /* no need to distinguish between them any more */
7666   n = RX_BUFF_IDX_FULLMATCH;
7667
7668  if ((n == RX_BUFF_IDX_PREMATCH || n == RX_BUFF_IDX_CARET_PREMATCH)
7669   && rx->offs[0].start != -1)
7670  {
7671   /* $`, ${^PREMATCH} */
7672   i = rx->offs[0].start;
7673   s = rx->subbeg;
7674  }
7675  else
7676  if ((n == RX_BUFF_IDX_POSTMATCH || n == RX_BUFF_IDX_CARET_POSTMATCH)
7677   && rx->offs[0].end != -1)
7678  {
7679   /* $', ${^POSTMATCH} */
7680   s = rx->subbeg - rx->suboffset + rx->offs[0].end;
7681   i = rx->sublen + rx->suboffset - rx->offs[0].end;
7682  }
7683  else
7684  if ( 0 <= n && n <= (I32)rx->nparens &&
7685   (s1 = rx->offs[n].start) != -1 &&
7686   (t1 = rx->offs[n].end) != -1)
7687  {
7688   /* $&, ${^MATCH},  $1 ... */
7689   i = t1 - s1;
7690   s = rx->subbeg + s1 - rx->suboffset;
7691  } else {
7692   goto ret_undef;
7693  }
7694
7695  assert(s >= rx->subbeg);
7696  assert((STRLEN)rx->sublen >= (STRLEN)((s - rx->subbeg) + i) );
7697  if (i >= 0) {
7698 #ifdef NO_TAINT_SUPPORT
7699   sv_setpvn(sv, s, i);
7700 #else
7701   const int oldtainted = TAINT_get;
7702   TAINT_NOT;
7703   sv_setpvn(sv, s, i);
7704   TAINT_set(oldtainted);
7705 #endif
7706   if ( (rx->intflags & PREGf_CANY_SEEN)
7707    ? (RXp_MATCH_UTF8(rx)
7708       && (!i || is_utf8_string((U8*)s, i)))
7709    : (RXp_MATCH_UTF8(rx)) )
7710   {
7711    SvUTF8_on(sv);
7712   }
7713   else
7714    SvUTF8_off(sv);
7715   if (TAINTING_get) {
7716    if (RXp_MATCH_TAINTED(rx)) {
7717     if (SvTYPE(sv) >= SVt_PVMG) {
7718      MAGIC* const mg = SvMAGIC(sv);
7719      MAGIC* mgt;
7720      TAINT;
7721      SvMAGIC_set(sv, mg->mg_moremagic);
7722      SvTAINT(sv);
7723      if ((mgt = SvMAGIC(sv))) {
7724       mg->mg_moremagic = mgt;
7725       SvMAGIC_set(sv, mg);
7726      }
7727     } else {
7728      TAINT;
7729      SvTAINT(sv);
7730     }
7731    } else
7732     SvTAINTED_off(sv);
7733   }
7734  } else {
7735  ret_undef:
7736   sv_setsv(sv,&PL_sv_undef);
7737   return;
7738  }
7739 }
7740
7741 void
7742 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
7743               SV const * const value)
7744 {
7745  PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
7746
7747  PERL_UNUSED_ARG(rx);
7748  PERL_UNUSED_ARG(paren);
7749  PERL_UNUSED_ARG(value);
7750
7751  if (!PL_localizing)
7752   Perl_croak_no_modify();
7753 }
7754
7755 I32
7756 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
7757        const I32 paren)
7758 {
7759  struct regexp *const rx = ReANY(r);
7760  I32 i;
7761  I32 s1, t1;
7762
7763  PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
7764
7765  if (   paren == RX_BUFF_IDX_CARET_PREMATCH
7766   || paren == RX_BUFF_IDX_CARET_FULLMATCH
7767   || paren == RX_BUFF_IDX_CARET_POSTMATCH
7768  )
7769  {
7770   bool keepcopy = cBOOL(rx->extflags & RXf_PMf_KEEPCOPY);
7771   if (!keepcopy) {
7772    /* on something like
7773    *    $r = qr/.../;
7774    *    /$qr/p;
7775    * the KEEPCOPY is set on the PMOP rather than the regex */
7776    if (PL_curpm && r == PM_GETRE(PL_curpm))
7777     keepcopy = cBOOL(PL_curpm->op_pmflags & PMf_KEEPCOPY);
7778   }
7779   if (!keepcopy)
7780    goto warn_undef;
7781  }
7782
7783  /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
7784  switch (paren) {
7785  case RX_BUFF_IDX_CARET_PREMATCH: /* ${^PREMATCH} */
7786  case RX_BUFF_IDX_PREMATCH:       /* $` */
7787   if (rx->offs[0].start != -1) {
7788       i = rx->offs[0].start;
7789       if (i > 0) {
7790         s1 = 0;
7791         t1 = i;
7792         goto getlen;
7793       }
7794    }
7795   return 0;
7796
7797  case RX_BUFF_IDX_CARET_POSTMATCH: /* ${^POSTMATCH} */
7798  case RX_BUFF_IDX_POSTMATCH:       /* $' */
7799    if (rx->offs[0].end != -1) {
7800       i = rx->sublen - rx->offs[0].end;
7801       if (i > 0) {
7802         s1 = rx->offs[0].end;
7803         t1 = rx->sublen;
7804         goto getlen;
7805       }
7806    }
7807   return 0;
7808
7809  default: /* $& / ${^MATCH}, $1, $2, ... */
7810    if (paren <= (I32)rx->nparens &&
7811    (s1 = rx->offs[paren].start) != -1 &&
7812    (t1 = rx->offs[paren].end) != -1)
7813    {
7814    i = t1 - s1;
7815    goto getlen;
7816   } else {
7817   warn_undef:
7818    if (ckWARN(WARN_UNINITIALIZED))
7819     report_uninit((const SV *)sv);
7820    return 0;
7821   }
7822  }
7823   getlen:
7824  if (i > 0 && RXp_MATCH_UTF8(rx)) {
7825   const char * const s = rx->subbeg - rx->suboffset + s1;
7826   const U8 *ep;
7827   STRLEN el;
7828
7829   i = t1 - s1;
7830   if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
7831       i = el;
7832  }
7833  return i;
7834 }
7835
7836 SV*
7837 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
7838 {
7839  PERL_ARGS_ASSERT_REG_QR_PACKAGE;
7840   PERL_UNUSED_ARG(rx);
7841   if (0)
7842    return NULL;
7843   else
7844    return newSVpvs("Regexp");
7845 }
7846
7847 /* Scans the name of a named buffer from the pattern.
7848  * If flags is REG_RSN_RETURN_NULL returns null.
7849  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
7850  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
7851  * to the parsed name as looked up in the RExC_paren_names hash.
7852  * If there is an error throws a vFAIL().. type exception.
7853  */
7854
7855 #define REG_RSN_RETURN_NULL    0
7856 #define REG_RSN_RETURN_NAME    1
7857 #define REG_RSN_RETURN_DATA    2
7858
7859 STATIC SV*
7860 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
7861 {
7862  char *name_start = RExC_parse;
7863
7864  PERL_ARGS_ASSERT_REG_SCAN_NAME;
7865
7866  assert (RExC_parse <= RExC_end);
7867  if (RExC_parse == RExC_end) NOOP;
7868  else if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
7869   /* skip IDFIRST by using do...while */
7870   if (UTF)
7871    do {
7872     RExC_parse += UTF8SKIP(RExC_parse);
7873    } while (isWORDCHAR_utf8((U8*)RExC_parse));
7874   else
7875    do {
7876     RExC_parse++;
7877    } while (isWORDCHAR(*RExC_parse));
7878  } else {
7879   RExC_parse++; /* so the <- from the vFAIL is after the offending
7880       character */
7881   vFAIL("Group name must start with a non-digit word character");
7882  }
7883  if ( flags ) {
7884   SV* sv_name
7885    = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
7886        SVs_TEMP | (UTF ? SVf_UTF8 : 0));
7887   if ( flags == REG_RSN_RETURN_NAME)
7888    return sv_name;
7889   else if (flags==REG_RSN_RETURN_DATA) {
7890    HE *he_str = NULL;
7891    SV *sv_dat = NULL;
7892    if ( ! sv_name )      /* should not happen*/
7893     Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
7894    if (RExC_paren_names)
7895     he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
7896    if ( he_str )
7897     sv_dat = HeVAL(he_str);
7898    if ( ! sv_dat )
7899     vFAIL("Reference to nonexistent named group");
7900    return sv_dat;
7901   }
7902   else {
7903    Perl_croak(aTHX_ "panic: bad flag %lx in reg_scan_name",
7904      (unsigned long) flags);
7905   }
7906   NOT_REACHED; /* NOTREACHED */
7907  }
7908  return NULL;
7909 }
7910
7911 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
7912  int num;                                                    \
7913  if (RExC_lastparse!=RExC_parse) {                           \
7914   PerlIO_printf(Perl_debug_log, "%s",                     \
7915    Perl_pv_pretty(aTHX_ RExC_mysv1, RExC_parse,        \
7916     RExC_end - RExC_parse, 16,                      \
7917     "", "",                                         \
7918     PERL_PV_ESCAPE_UNI_DETECT |                     \
7919     PERL_PV_PRETTY_ELLIPSES   |                     \
7920     PERL_PV_PRETTY_LTGT       |                     \
7921     PERL_PV_ESCAPE_RE         |                     \
7922     PERL_PV_PRETTY_EXACTSIZE                        \
7923    )                                                   \
7924   );                                                      \
7925  } else                                                      \
7926   PerlIO_printf(Perl_debug_log,"%16s","");                \
7927                 \
7928  if (SIZE_ONLY)                                              \
7929  num = RExC_size + 1;                                     \
7930  else                                                        \
7931  num=REG_NODE_NUM(RExC_emit);                             \
7932  if (RExC_lastnum!=num)                                      \
7933  PerlIO_printf(Perl_debug_log,"|%4d",num);                \
7934  else                                                        \
7935  PerlIO_printf(Perl_debug_log,"|%4s","");                 \
7936  PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
7937   (int)((depth*2)), "",                                   \
7938   (funcname)                                              \
7939  );                                                          \
7940  RExC_lastnum=num;                                           \
7941  RExC_lastparse=RExC_parse;                                  \
7942 })
7943
7944
7945
7946 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
7947  DEBUG_PARSE_MSG((funcname));                            \
7948  PerlIO_printf(Perl_debug_log,"%4s","\n");               \
7949 })
7950 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
7951  DEBUG_PARSE_MSG((funcname));                            \
7952  PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
7953 })
7954
7955 /* This section of code defines the inversion list object and its methods.  The
7956  * interfaces are highly subject to change, so as much as possible is static to
7957  * this file.  An inversion list is here implemented as a malloc'd C UV array
7958  * as an SVt_INVLIST scalar.
7959  *
7960  * An inversion list for Unicode is an array of code points, sorted by ordinal
7961  * number.  The zeroth element is the first code point in the list.  The 1th
7962  * element is the first element beyond that not in the list.  In other words,
7963  * the first range is
7964  *  invlist[0]..(invlist[1]-1)
7965  * The other ranges follow.  Thus every element whose index is divisible by two
7966  * marks the beginning of a range that is in the list, and every element not
7967  * divisible by two marks the beginning of a range not in the list.  A single
7968  * element inversion list that contains the single code point N generally
7969  * consists of two elements
7970  *  invlist[0] == N
7971  *  invlist[1] == N+1
7972  * (The exception is when N is the highest representable value on the
7973  * machine, in which case the list containing just it would be a single
7974  * element, itself.  By extension, if the last range in the list extends to
7975  * infinity, then the first element of that range will be in the inversion list
7976  * at a position that is divisible by two, and is the final element in the
7977  * list.)
7978  * Taking the complement (inverting) an inversion list is quite simple, if the
7979  * first element is 0, remove it; otherwise add a 0 element at the beginning.
7980  * This implementation reserves an element at the beginning of each inversion
7981  * list to always contain 0; there is an additional flag in the header which
7982  * indicates if the list begins at the 0, or is offset to begin at the next
7983  * element.
7984  *
7985  * More about inversion lists can be found in "Unicode Demystified"
7986  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
7987  * More will be coming when functionality is added later.
7988  *
7989  * The inversion list data structure is currently implemented as an SV pointing
7990  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
7991  * array of UV whose memory management is automatically handled by the existing
7992  * facilities for SV's.
7993  *
7994  * Some of the methods should always be private to the implementation, and some
7995  * should eventually be made public */
7996
7997 /* The header definitions are in F<inline_invlist.c> */
7998
7999 PERL_STATIC_INLINE UV*
8000 S__invlist_array_init(SV* const invlist, const bool will_have_0)
8001 {
8002  /* Returns a pointer to the first element in the inversion list's array.
8003  * This is called upon initialization of an inversion list.  Where the
8004  * array begins depends on whether the list has the code point U+0000 in it
8005  * or not.  The other parameter tells it whether the code that follows this
8006  * call is about to put a 0 in the inversion list or not.  The first
8007  * element is either the element reserved for 0, if TRUE, or the element
8008  * after it, if FALSE */
8009
8010  bool* offset = get_invlist_offset_addr(invlist);
8011  UV* zero_addr = (UV *) SvPVX(invlist);
8012
8013  PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
8014
8015  /* Must be empty */
8016  assert(! _invlist_len(invlist));
8017
8018  *zero_addr = 0;
8019
8020  /* 1^1 = 0; 1^0 = 1 */
8021  *offset = 1 ^ will_have_0;
8022  return zero_addr + *offset;
8023 }
8024
8025 PERL_STATIC_INLINE void
8026 S_invlist_set_len(pTHX_ SV* const invlist, const UV len, const bool offset)
8027 {
8028  /* Sets the current number of elements stored in the inversion list.
8029  * Updates SvCUR correspondingly */
8030  PERL_UNUSED_CONTEXT;
8031  PERL_ARGS_ASSERT_INVLIST_SET_LEN;
8032
8033  assert(SvTYPE(invlist) == SVt_INVLIST);
8034
8035  SvCUR_set(invlist,
8036    (len == 0)
8037    ? 0
8038    : TO_INTERNAL_SIZE(len + offset));
8039  assert(SvLEN(invlist) == 0 || SvCUR(invlist) <= SvLEN(invlist));
8040 }
8041
8042 #ifndef PERL_IN_XSUB_RE
8043
8044 PERL_STATIC_INLINE IV*
8045 S_get_invlist_previous_index_addr(SV* invlist)
8046 {
8047  /* Return the address of the IV that is reserved to hold the cached index
8048  * */
8049  PERL_ARGS_ASSERT_GET_INVLIST_PREVIOUS_INDEX_ADDR;
8050
8051  assert(SvTYPE(invlist) == SVt_INVLIST);
8052
8053  return &(((XINVLIST*) SvANY(invlist))->prev_index);
8054 }
8055
8056 PERL_STATIC_INLINE IV
8057 S_invlist_previous_index(SV* const invlist)
8058 {
8059  /* Returns cached index of previous search */
8060
8061  PERL_ARGS_ASSERT_INVLIST_PREVIOUS_INDEX;
8062
8063  return *get_invlist_previous_index_addr(invlist);
8064 }
8065
8066 PERL_STATIC_INLINE void
8067 S_invlist_set_previous_index(SV* const invlist, const IV index)
8068 {
8069  /* Caches <index> for later retrieval */
8070
8071  PERL_ARGS_ASSERT_INVLIST_SET_PREVIOUS_INDEX;
8072
8073  assert(index == 0 || index < (int) _invlist_len(invlist));
8074
8075  *get_invlist_previous_index_addr(invlist) = index;
8076 }
8077
8078 PERL_STATIC_INLINE void
8079 S_invlist_trim(SV* const invlist)
8080 {
8081  PERL_ARGS_ASSERT_INVLIST_TRIM;
8082
8083  assert(SvTYPE(invlist) == SVt_INVLIST);
8084
8085  /* Change the length of the inversion list to how many entries it currently
8086  * has */
8087  SvPV_shrink_to_cur((SV *) invlist);
8088 }
8089
8090 PERL_STATIC_INLINE bool
8091 S_invlist_is_iterating(SV* const invlist)
8092 {
8093  PERL_ARGS_ASSERT_INVLIST_IS_ITERATING;
8094
8095  return *(get_invlist_iter_addr(invlist)) < (STRLEN) UV_MAX;
8096 }
8097
8098 #endif /* ifndef PERL_IN_XSUB_RE */
8099
8100 PERL_STATIC_INLINE UV
8101 S_invlist_max(SV* const invlist)
8102 {
8103  /* Returns the maximum number of elements storable in the inversion list's
8104  * array, without having to realloc() */
8105
8106  PERL_ARGS_ASSERT_INVLIST_MAX;
8107
8108  assert(SvTYPE(invlist) == SVt_INVLIST);
8109
8110  /* Assumes worst case, in which the 0 element is not counted in the
8111  * inversion list, so subtracts 1 for that */
8112  return SvLEN(invlist) == 0  /* This happens under _new_invlist_C_array */
8113   ? FROM_INTERNAL_SIZE(SvCUR(invlist)) - 1
8114   : FROM_INTERNAL_SIZE(SvLEN(invlist)) - 1;
8115 }
8116
8117 #ifndef PERL_IN_XSUB_RE
8118 SV*
8119 Perl__new_invlist(pTHX_ IV initial_size)
8120 {
8121
8122  /* Return a pointer to a newly constructed inversion list, with enough
8123  * space to store 'initial_size' elements.  If that number is negative, a
8124  * system default is used instead */
8125
8126  SV* new_list;
8127
8128  if (initial_size < 0) {
8129   initial_size = 10;
8130  }
8131
8132  /* Allocate the initial space */
8133  new_list = newSV_type(SVt_INVLIST);
8134
8135  /* First 1 is in case the zero element isn't in the list; second 1 is for
8136  * trailing NUL */
8137  SvGROW(new_list, TO_INTERNAL_SIZE(initial_size + 1) + 1);
8138  invlist_set_len(new_list, 0, 0);
8139
8140  /* Force iterinit() to be used to get iteration to work */
8141  *get_invlist_iter_addr(new_list) = (STRLEN) UV_MAX;
8142
8143  *get_invlist_previous_index_addr(new_list) = 0;
8144
8145  return new_list;
8146 }
8147
8148 SV*
8149 Perl__new_invlist_C_array(pTHX_ const UV* const list)
8150 {
8151  /* Return a pointer to a newly constructed inversion list, initialized to
8152  * point to <list>, which has to be in the exact correct inversion list
8153  * form, including internal fields.  Thus this is a dangerous routine that
8154  * should not be used in the wrong hands.  The passed in 'list' contains
8155  * several header fields at the beginning that are not part of the
8156  * inversion list body proper */
8157
8158  const STRLEN length = (STRLEN) list[0];
8159  const UV version_id =          list[1];
8160  const bool offset   =    cBOOL(list[2]);
8161 #define HEADER_LENGTH 3
8162  /* If any of the above changes in any way, you must change HEADER_LENGTH
8163  * (if appropriate) and regenerate INVLIST_VERSION_ID by running
8164  *      perl -E 'say int(rand 2**31-1)'
8165  */
8166 #define INVLIST_VERSION_ID 148565664 /* This is a combination of a version and
8167           data structure type, so that one being
8168           passed in can be validated to be an
8169           inversion list of the correct vintage.
8170          */
8171
8172  SV* invlist = newSV_type(SVt_INVLIST);
8173
8174  PERL_ARGS_ASSERT__NEW_INVLIST_C_ARRAY;
8175
8176  if (version_id != INVLIST_VERSION_ID) {
8177   Perl_croak(aTHX_ "panic: Incorrect version for previously generated inversion list");
8178  }
8179
8180  /* The generated array passed in includes header elements that aren't part
8181  * of the list proper, so start it just after them */
8182  SvPV_set(invlist, (char *) (list + HEADER_LENGTH));
8183
8184  SvLEN_set(invlist, 0);  /* Means we own the contents, and the system
8185        shouldn't touch it */
8186
8187  *(get_invlist_offset_addr(invlist)) = offset;
8188
8189  /* The 'length' passed to us is the physical number of elements in the
8190  * inversion list.  But if there is an offset the logical number is one
8191  * less than that */
8192  invlist_set_len(invlist, length  - offset, offset);
8193
8194  invlist_set_previous_index(invlist, 0);
8195
8196  /* Initialize the iteration pointer. */
8197  invlist_iterfinish(invlist);
8198
8199  SvREADONLY_on(invlist);
8200
8201  return invlist;
8202 }
8203 #endif /* ifndef PERL_IN_XSUB_RE */
8204
8205 STATIC void
8206 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
8207 {
8208  /* Grow the maximum size of an inversion list */
8209
8210  PERL_ARGS_ASSERT_INVLIST_EXTEND;
8211
8212  assert(SvTYPE(invlist) == SVt_INVLIST);
8213
8214  /* Add one to account for the zero element at the beginning which may not
8215  * be counted by the calling parameters */
8216  SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max + 1));
8217 }
8218
8219 STATIC void
8220 S__append_range_to_invlist(pTHX_ SV* const invlist,
8221         const UV start, const UV end)
8222 {
8223    /* Subject to change or removal.  Append the range from 'start' to 'end' at
8224  * the end of the inversion list.  The range must be above any existing
8225  * ones. */
8226
8227  UV* array;
8228  UV max = invlist_max(invlist);
8229  UV len = _invlist_len(invlist);
8230  bool offset;
8231
8232  PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
8233
8234  if (len == 0) { /* Empty lists must be initialized */
8235   offset = start != 0;
8236   array = _invlist_array_init(invlist, ! offset);
8237  }
8238  else {
8239   /* Here, the existing list is non-empty. The current max entry in the
8240   * list is generally the first value not in the set, except when the
8241   * set extends to the end of permissible values, in which case it is
8242   * the first entry in that final set, and so this call is an attempt to
8243   * append out-of-order */
8244
8245   UV final_element = len - 1;
8246   array = invlist_array(invlist);
8247   if (array[final_element] > start
8248    || ELEMENT_RANGE_MATCHES_INVLIST(final_element))
8249   {
8250    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",
8251      array[final_element], start,
8252      ELEMENT_RANGE_MATCHES_INVLIST(final_element) ? 't' : 'f');
8253   }
8254
8255   /* Here, it is a legal append.  If the new range begins with the first
8256   * value not in the set, it is extending the set, so the new first
8257   * value not in the set is one greater than the newly extended range.
8258   * */
8259   offset = *get_invlist_offset_addr(invlist);
8260   if (array[final_element] == start) {
8261    if (end != UV_MAX) {
8262     array[final_element] = end + 1;
8263    }
8264    else {
8265     /* But if the end is the maximum representable on the machine,
8266     * just let the range that this would extend to have no end */
8267     invlist_set_len(invlist, len - 1, offset);
8268    }
8269    return;
8270   }
8271  }
8272
8273  /* Here the new range doesn't extend any existing set.  Add it */
8274
8275  len += 2; /* Includes an element each for the start and end of range */
8276
8277  /* If wll overflow the existing space, extend, which may cause the array to
8278  * be moved */
8279  if (max < len) {
8280   invlist_extend(invlist, len);
8281
8282   /* Have to set len here to avoid assert failure in invlist_array() */
8283   invlist_set_len(invlist, len, offset);
8284
8285   array = invlist_array(invlist);
8286  }
8287  else {
8288   invlist_set_len(invlist, len, offset);
8289  }
8290
8291  /* The next item on the list starts the range, the one after that is
8292  * one past the new range.  */
8293  array[len - 2] = start;
8294  if (end != UV_MAX) {
8295   array[len - 1] = end + 1;
8296  }
8297  else {
8298   /* But if the end is the maximum representable on the machine, just let
8299   * the range have no end */
8300   invlist_set_len(invlist, len - 1, offset);
8301  }
8302 }
8303
8304 #ifndef PERL_IN_XSUB_RE
8305
8306 IV
8307 Perl__invlist_search(SV* const invlist, const UV cp)
8308 {
8309  /* Searches the inversion list for the entry that contains the input code
8310  * point <cp>.  If <cp> is not in the list, -1 is returned.  Otherwise, the
8311  * return value is the index into the list's array of the range that
8312  * contains <cp> */
8313
8314  IV low = 0;
8315  IV mid;
8316  IV high = _invlist_len(invlist);
8317  const IV highest_element = high - 1;
8318  const UV* array;
8319
8320  PERL_ARGS_ASSERT__INVLIST_SEARCH;
8321
8322  /* If list is empty, return failure. */
8323  if (high == 0) {
8324   return -1;
8325  }
8326
8327  /* (We can't get the array unless we know the list is non-empty) */
8328  array = invlist_array(invlist);
8329
8330  mid = invlist_previous_index(invlist);
8331  assert(mid >=0 && mid <= highest_element);
8332
8333  /* <mid> contains the cache of the result of the previous call to this
8334  * function (0 the first time).  See if this call is for the same result,
8335  * or if it is for mid-1.  This is under the theory that calls to this
8336  * function will often be for related code points that are near each other.
8337  * And benchmarks show that caching gives better results.  We also test
8338  * here if the code point is within the bounds of the list.  These tests
8339  * replace others that would have had to be made anyway to make sure that
8340  * the array bounds were not exceeded, and these give us extra information
8341  * at the same time */
8342  if (cp >= array[mid]) {
8343   if (cp >= array[highest_element]) {
8344    return highest_element;
8345   }
8346
8347   /* Here, array[mid] <= cp < array[highest_element].  This means that
8348   * the final element is not the answer, so can exclude it; it also
8349   * means that <mid> is not the final element, so can refer to 'mid + 1'
8350   * safely */
8351   if (cp < array[mid + 1]) {
8352    return mid;
8353   }
8354   high--;
8355   low = mid + 1;
8356  }
8357  else { /* cp < aray[mid] */
8358   if (cp < array[0]) { /* Fail if outside the array */
8359    return -1;
8360   }
8361   high = mid;
8362   if (cp >= array[mid - 1]) {
8363    goto found_entry;
8364   }
8365  }
8366
8367  /* Binary search.  What we are looking for is <i> such that
8368  * array[i] <= cp < array[i+1]
8369  * The loop below converges on the i+1.  Note that there may not be an
8370  * (i+1)th element in the array, and things work nonetheless */
8371  while (low < high) {
8372   mid = (low + high) / 2;
8373   assert(mid <= highest_element);
8374   if (array[mid] <= cp) { /* cp >= array[mid] */
8375    low = mid + 1;
8376
8377    /* We could do this extra test to exit the loop early.
8378    if (cp < array[low]) {
8379     return mid;
8380    }
8381    */
8382   }
8383   else { /* cp < array[mid] */
8384    high = mid;
8385   }
8386  }
8387
8388   found_entry:
8389  high--;
8390  invlist_set_previous_index(invlist, high);
8391  return high;
8392 }
8393
8394 void
8395 Perl__invlist_populate_swatch(SV* const invlist,
8396        const UV start, const UV end, U8* swatch)
8397 {
8398  /* populates a swatch of a swash the same way swatch_get() does in utf8.c,
8399  * but is used when the swash has an inversion list.  This makes this much
8400  * faster, as it uses a binary search instead of a linear one.  This is
8401  * intimately tied to that function, and perhaps should be in utf8.c,
8402  * except it is intimately tied to inversion lists as well.  It assumes
8403  * that <swatch> is all 0's on input */
8404
8405  UV current = start;
8406  const IV len = _invlist_len(invlist);
8407  IV i;
8408  const UV * array;
8409
8410  PERL_ARGS_ASSERT__INVLIST_POPULATE_SWATCH;
8411
8412  if (len == 0) { /* Empty inversion list */
8413   return;
8414  }
8415
8416  array = invlist_array(invlist);
8417
8418  /* Find which element it is */
8419  i = _invlist_search(invlist, start);
8420
8421  /* We populate from <start> to <end> */
8422  while (current < end) {
8423   UV upper;
8424
8425   /* The inversion list gives the results for every possible code point
8426   * after the first one in the list.  Only those ranges whose index is
8427   * even are ones that the inversion list matches.  For the odd ones,
8428   * and if the initial code point is not in the list, we have to skip
8429   * forward to the next element */
8430   if (i == -1 || ! ELEMENT_RANGE_MATCHES_INVLIST(i)) {
8431    i++;
8432    if (i >= len) { /* Finished if beyond the end of the array */
8433     return;
8434    }
8435    current = array[i];
8436    if (current >= end) {   /* Finished if beyond the end of what we
8437          are populating */
8438     if (LIKELY(end < UV_MAX)) {
8439      return;
8440     }
8441
8442     /* We get here when the upper bound is the maximum
8443     * representable on the machine, and we are looking for just
8444     * that code point.  Have to special case it */
8445     i = len;
8446     goto join_end_of_list;
8447    }
8448   }
8449   assert(current >= start);
8450
8451   /* The current range ends one below the next one, except don't go past
8452   * <end> */
8453   i++;
8454   upper = (i < len && array[i] < end) ? array[i] : end;
8455
8456   /* Here we are in a range that matches.  Populate a bit in the 3-bit U8
8457   * for each code point in it */
8458   for (; current < upper; current++) {
8459    const STRLEN offset = (STRLEN)(current - start);
8460    swatch[offset >> 3] |= 1 << (offset & 7);
8461   }
8462
8463  join_end_of_list:
8464
8465   /* Quit if at the end of the list */
8466   if (i >= len) {
8467
8468    /* But first, have to deal with the highest possible code point on
8469    * the platform.  The previous code assumes that <end> is one
8470    * beyond where we want to populate, but that is impossible at the
8471    * platform's infinity, so have to handle it specially */
8472    if (UNLIKELY(end == UV_MAX && ELEMENT_RANGE_MATCHES_INVLIST(len-1)))
8473    {
8474     const STRLEN offset = (STRLEN)(end - start);
8475     swatch[offset >> 3] |= 1 << (offset & 7);
8476    }
8477    return;
8478   }
8479
8480   /* Advance to the next range, which will be for code points not in the
8481   * inversion list */
8482   current = array[i];
8483  }
8484
8485  return;
8486 }
8487
8488 void
8489 Perl__invlist_union_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
8490           const bool complement_b, SV** output)
8491 {
8492  /* Take the union of two inversion lists and point <output> to it.  *output
8493  * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
8494  * the reference count to that list will be decremented if not already a
8495  * temporary (mortal); otherwise *output will be made correspondingly
8496  * mortal.  The first list, <a>, may be NULL, in which case a copy of the
8497  * second list is returned.  If <complement_b> is TRUE, the union is taken
8498  * of the complement (inversion) of <b> instead of b itself.
8499  *
8500  * The basis for this comes from "Unicode Demystified" Chapter 13 by
8501  * Richard Gillam, published by Addison-Wesley, and explained at some
8502  * length there.  The preface says to incorporate its examples into your
8503  * code at your own risk.
8504  *
8505  * The algorithm is like a merge sort.
8506  *
8507  * XXX A potential performance improvement is to keep track as we go along
8508  * if only one of the inputs contributes to the result, meaning the other
8509  * is a subset of that one.  In that case, we can skip the final copy and
8510  * return the larger of the input lists, but then outside code might need
8511  * to keep track of whether to free the input list or not */
8512
8513  const UV* array_a;    /* a's array */
8514  const UV* array_b;
8515  UV len_a;     /* length of a's array */
8516  UV len_b;
8517
8518  SV* u;   /* the resulting union */
8519  UV* array_u;
8520  UV len_u;
8521
8522  UV i_a = 0;      /* current index into a's array */
8523  UV i_b = 0;
8524  UV i_u = 0;
8525
8526  /* running count, as explained in the algorithm source book; items are
8527  * stopped accumulating and are output when the count changes to/from 0.
8528  * The count is incremented when we start a range that's in the set, and
8529  * decremented when we start a range that's not in the set.  So its range
8530  * is 0 to 2.  Only when the count is zero is something not in the set.
8531  */
8532  UV count = 0;
8533
8534  PERL_ARGS_ASSERT__INVLIST_UNION_MAYBE_COMPLEMENT_2ND;
8535  assert(a != b);
8536
8537  /* If either one is empty, the union is the other one */
8538  if (a == NULL || ((len_a = _invlist_len(a)) == 0)) {
8539   bool make_temp = FALSE; /* Should we mortalize the result? */
8540
8541   if (*output == a) {
8542    if (a != NULL) {
8543     if (! (make_temp = cBOOL(SvTEMP(a)))) {
8544      SvREFCNT_dec_NN(a);
8545     }
8546    }
8547   }
8548   if (*output != b) {
8549    *output = invlist_clone(b);
8550    if (complement_b) {
8551     _invlist_invert(*output);
8552    }
8553   } /* else *output already = b; */
8554
8555   if (make_temp) {
8556    sv_2mortal(*output);
8557   }
8558   return;
8559  }
8560  else if ((len_b = _invlist_len(b)) == 0) {
8561   bool make_temp = FALSE;
8562   if (*output == b) {
8563    if (! (make_temp = cBOOL(SvTEMP(b)))) {
8564     SvREFCNT_dec_NN(b);
8565    }
8566   }
8567
8568   /* The complement of an empty list is a list that has everything in it,
8569   * so the union with <a> includes everything too */
8570   if (complement_b) {
8571    if (a == *output) {
8572     if (! (make_temp = cBOOL(SvTEMP(a)))) {
8573      SvREFCNT_dec_NN(a);
8574     }
8575    }
8576    *output = _new_invlist(1);
8577    _append_range_to_invlist(*output, 0, UV_MAX);
8578   }
8579   else if (*output != a) {
8580    *output = invlist_clone(a);
8581   }
8582   /* else *output already = a; */
8583
8584   if (make_temp) {
8585    sv_2mortal(*output);
8586   }
8587   return;
8588  }
8589
8590  /* Here both lists exist and are non-empty */
8591  array_a = invlist_array(a);
8592  array_b = invlist_array(b);
8593
8594  /* If are to take the union of 'a' with the complement of b, set it
8595  * up so are looking at b's complement. */
8596  if (complement_b) {
8597
8598   /* To complement, we invert: if the first element is 0, remove it.  To
8599   * do this, we just pretend the array starts one later */
8600   if (array_b[0] == 0) {
8601    array_b++;
8602    len_b--;
8603   }
8604   else {
8605
8606    /* But if the first element is not zero, we pretend the list starts
8607    * at the 0 that is always stored immediately before the array. */
8608    array_b--;
8609    len_b++;
8610   }
8611  }
8612
8613  /* Size the union for the worst case: that the sets are completely
8614  * disjoint */
8615  u = _new_invlist(len_a + len_b);
8616
8617  /* Will contain U+0000 if either component does */
8618  array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
8619          || (len_b > 0 && array_b[0] == 0));
8620
8621  /* Go through each list item by item, stopping when exhausted one of
8622  * them */
8623  while (i_a < len_a && i_b < len_b) {
8624   UV cp;     /* The element to potentially add to the union's array */
8625   bool cp_in_set;   /* is it in the the input list's set or not */
8626
8627   /* We need to take one or the other of the two inputs for the union.
8628   * Since we are merging two sorted lists, we take the smaller of the
8629   * next items.  In case of a tie, we take the one that is in its set
8630   * first.  If we took one not in the set first, it would decrement the
8631   * count, possibly to 0 which would cause it to be output as ending the
8632   * range, and the next time through we would take the same number, and
8633   * output it again as beginning the next range.  By doing it the
8634   * opposite way, there is no possibility that the count will be
8635   * momentarily decremented to 0, and thus the two adjoining ranges will
8636   * be seamlessly merged.  (In a tie and both are in the set or both not
8637   * in the set, it doesn't matter which we take first.) */
8638   if (array_a[i_a] < array_b[i_b]
8639    || (array_a[i_a] == array_b[i_b]
8640     && ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
8641   {
8642    cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
8643    cp= array_a[i_a++];
8644   }
8645   else {
8646    cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
8647    cp = array_b[i_b++];
8648   }
8649
8650   /* Here, have chosen which of the two inputs to look at.  Only output
8651   * if the running count changes to/from 0, which marks the
8652   * beginning/end of a range in that's in the set */
8653   if (cp_in_set) {
8654    if (count == 0) {
8655     array_u[i_u++] = cp;
8656    }
8657    count++;
8658   }
8659   else {
8660    count--;
8661    if (count == 0) {
8662     array_u[i_u++] = cp;
8663    }
8664   }
8665  }
8666
8667  /* Here, we are finished going through at least one of the lists, which
8668  * means there is something remaining in at most one.  We check if the list
8669  * that hasn't been exhausted is positioned such that we are in the middle
8670  * of a range in its set or not.  (i_a and i_b point to the element beyond
8671  * the one we care about.) If in the set, we decrement 'count'; if 0, there
8672  * is potentially more to output.
8673  * There are four cases:
8674  * 1) Both weren't in their sets, count is 0, and remains 0.  What's left
8675  *    in the union is entirely from the non-exhausted set.
8676  * 2) Both were in their sets, count is 2.  Nothing further should
8677  *    be output, as everything that remains will be in the exhausted
8678  *    list's set, hence in the union; decrementing to 1 but not 0 insures
8679  *    that
8680  * 3) the exhausted was in its set, non-exhausted isn't, count is 1.
8681  *    Nothing further should be output because the union includes
8682  *    everything from the exhausted set.  Not decrementing ensures that.
8683  * 4) the exhausted wasn't in its set, non-exhausted is, count is 1;
8684  *    decrementing to 0 insures that we look at the remainder of the
8685  *    non-exhausted set */
8686  if ((i_a != len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
8687   || (i_b != len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
8688  {
8689   count--;
8690  }
8691
8692  /* The final length is what we've output so far, plus what else is about to
8693  * be output.  (If 'count' is non-zero, then the input list we exhausted
8694  * has everything remaining up to the machine's limit in its set, and hence
8695  * in the union, so there will be no further output. */
8696  len_u = i_u;
8697  if (count == 0) {
8698   /* At most one of the subexpressions will be non-zero */
8699   len_u += (len_a - i_a) + (len_b - i_b);
8700  }
8701
8702  /* Set result to final length, which can change the pointer to array_u, so
8703  * re-find it */
8704  if (len_u != _invlist_len(u)) {
8705   invlist_set_len(u, len_u, *get_invlist_offset_addr(u));
8706   invlist_trim(u);
8707   array_u = invlist_array(u);
8708  }
8709
8710  /* When 'count' is 0, the list that was exhausted (if one was shorter than
8711  * the other) ended with everything above it not in its set.  That means
8712  * that the remaining part of the union is precisely the same as the
8713  * non-exhausted list, so can just copy it unchanged.  (If both list were
8714  * exhausted at the same time, then the operations below will be both 0.)
8715  */
8716  if (count == 0) {
8717   IV copy_count; /* At most one will have a non-zero copy count */
8718   if ((copy_count = len_a - i_a) > 0) {
8719    Copy(array_a + i_a, array_u + i_u, copy_count, UV);
8720   }
8721   else if ((copy_count = len_b - i_b) > 0) {
8722    Copy(array_b + i_b, array_u + i_u, copy_count, UV);
8723   }
8724  }
8725
8726  /*  We may be removing a reference to one of the inputs.  If so, the output
8727  *  is made mortal if the input was.  (Mortal SVs shouldn't have their ref
8728  *  count decremented) */
8729  if (a == *output || b == *output) {
8730   assert(! invlist_is_iterating(*output));
8731   if ((SvTEMP(*output))) {
8732    sv_2mortal(u);
8733   }
8734   else {
8735    SvREFCNT_dec_NN(*output);
8736   }
8737  }
8738
8739  *output = u;
8740
8741  return;
8742 }
8743
8744 void
8745 Perl__invlist_intersection_maybe_complement_2nd(pTHX_ SV* const a, SV* const b,
8746            const bool complement_b, SV** i)
8747 {
8748  /* Take the intersection of two inversion lists and point <i> to it.  *i
8749  * SHOULD BE DEFINED upon input, and if it points to one of the two lists,
8750  * the reference count to that list will be decremented if not already a
8751  * temporary (mortal); otherwise *i will be made correspondingly mortal.
8752  * The first list, <a>, may be NULL, in which case an empty list is
8753  * returned.  If <complement_b> is TRUE, the result will be the
8754  * intersection of <a> and the complement (or inversion) of <b> instead of
8755  * <b> directly.
8756  *
8757  * The basis for this comes from "Unicode Demystified" Chapter 13 by
8758  * Richard Gillam, published by Addison-Wesley, and explained at some
8759  * length there.  The preface says to incorporate its examples into your
8760  * code at your own risk.  In fact, it had bugs
8761  *
8762  * The algorithm is like a merge sort, and is essentially the same as the
8763  * union above
8764  */
8765
8766  const UV* array_a;  /* a's array */
8767  const UV* array_b;
8768  UV len_a; /* length of a's array */
8769  UV len_b;
8770
8771  SV* r;       /* the resulting intersection */
8772  UV* array_r;
8773  UV len_r;
8774
8775  UV i_a = 0;      /* current index into a's array */
8776  UV i_b = 0;
8777  UV i_r = 0;
8778
8779  /* running count, as explained in the algorithm source book; items are
8780  * stopped accumulating and are output when the count changes to/from 2.
8781  * The count is incremented when we start a range that's in the set, and
8782  * decremented when we start a range that's not in the set.  So its range
8783  * is 0 to 2.  Only when the count is 2 is something in the intersection.
8784  */
8785  UV count = 0;
8786
8787  PERL_ARGS_ASSERT__INVLIST_INTERSECTION_MAYBE_COMPLEMENT_2ND;
8788  assert(a != b);
8789
8790  /* Special case if either one is empty */
8791  len_a = (a == NULL) ? 0 : _invlist_len(a);
8792  if ((len_a == 0) || ((len_b = _invlist_len(b)) == 0)) {
8793   bool make_temp = FALSE;
8794
8795   if (len_a != 0 && complement_b) {
8796
8797    /* Here, 'a' is not empty, therefore from the above 'if', 'b' must
8798    * be empty.  Here, also we are using 'b's complement, which hence
8799    * must be every possible code point.  Thus the intersection is
8800    * simply 'a'. */
8801    if (*i != a) {
8802     if (*i == b) {
8803      if (! (make_temp = cBOOL(SvTEMP(b)))) {
8804       SvREFCNT_dec_NN(b);
8805      }
8806     }
8807
8808     *i = invlist_clone(a);
8809    }
8810    /* else *i is already 'a' */
8811
8812    if (make_temp) {
8813     sv_2mortal(*i);
8814    }
8815    return;
8816   }
8817
8818   /* Here, 'a' or 'b' is empty and not using the complement of 'b'.  The
8819   * intersection must be empty */
8820   if (*i == a) {
8821    if (! (make_temp = cBOOL(SvTEMP(a)))) {
8822     SvREFCNT_dec_NN(a);
8823    }
8824   }
8825   else if (*i == b) {
8826    if (! (make_temp = cBOOL(SvTEMP(b)))) {
8827     SvREFCNT_dec_NN(b);
8828    }
8829   }
8830   *i = _new_invlist(0);
8831   if (make_temp) {
8832    sv_2mortal(*i);
8833   }
8834
8835   return;
8836  }
8837
8838  /* Here both lists exist and are non-empty */
8839  array_a = invlist_array(a);
8840  array_b = invlist_array(b);
8841
8842  /* If are to take the intersection of 'a' with the complement of b, set it
8843  * up so are looking at b's complement. */
8844  if (complement_b) {
8845
8846   /* To complement, we invert: if the first element is 0, remove it.  To
8847   * do this, we just pretend the array starts one later */
8848   if (array_b[0] == 0) {
8849    array_b++;
8850    len_b--;
8851   }
8852   else {
8853
8854    /* But if the first element is not zero, we pretend the list starts
8855    * at the 0 that is always stored immediately before the array. */
8856    array_b--;
8857    len_b++;
8858   }
8859  }
8860
8861  /* Size the intersection for the worst case: that the intersection ends up
8862  * fragmenting everything to be completely disjoint */
8863  r= _new_invlist(len_a + len_b);
8864
8865  /* Will contain U+0000 iff both components do */
8866  array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
8867          && len_b > 0 && array_b[0] == 0);
8868
8869  /* Go through each list item by item, stopping when exhausted one of
8870  * them */
8871  while (i_a < len_a && i_b < len_b) {
8872   UV cp;     /* The element to potentially add to the intersection's
8873      array */
8874   bool cp_in_set; /* Is it in the input list's set or not */
8875
8876   /* We need to take one or the other of the two inputs for the
8877   * intersection.  Since we are merging two sorted lists, we take the
8878   * smaller of the next items.  In case of a tie, we take the one that
8879   * is not in its set first (a difference from the union algorithm).  If
8880   * we took one in the set first, it would increment the count, possibly
8881   * to 2 which would cause it to be output as starting a range in the
8882   * intersection, and the next time through we would take that same
8883   * number, and output it again as ending the set.  By doing it the
8884   * opposite of this, there is no possibility that the count will be
8885   * momentarily incremented to 2.  (In a tie and both are in the set or
8886   * both not in the set, it doesn't matter which we take first.) */
8887   if (array_a[i_a] < array_b[i_b]
8888    || (array_a[i_a] == array_b[i_b]
8889     && ! ELEMENT_RANGE_MATCHES_INVLIST(i_a)))
8890   {
8891    cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_a);
8892    cp= array_a[i_a++];
8893   }
8894   else {
8895    cp_in_set = ELEMENT_RANGE_MATCHES_INVLIST(i_b);
8896    cp= array_b[i_b++];
8897   }
8898
8899   /* Here, have chosen which of the two inputs to look at.  Only output
8900   * if the running count changes to/from 2, which marks the
8901   * beginning/end of a range that's in the intersection */
8902   if (cp_in_set) {
8903    count++;
8904    if (count == 2) {
8905     array_r[i_r++] = cp;
8906    }
8907   }
8908   else {
8909    if (count == 2) {
8910     array_r[i_r++] = cp;
8911    }
8912    count--;
8913   }
8914  }
8915
8916  /* Here, we are finished going through at least one of the lists, which
8917  * means there is something remaining in at most one.  We check if the list
8918  * that has been exhausted is positioned such that we are in the middle
8919  * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
8920  * the ones we care about.)  There are four cases:
8921  * 1) Both weren't in their sets, count is 0, and remains 0.  There's
8922  *    nothing left in the intersection.
8923  * 2) Both were in their sets, count is 2 and perhaps is incremented to
8924  *    above 2.  What should be output is exactly that which is in the
8925  *    non-exhausted set, as everything it has is also in the intersection
8926  *    set, and everything it doesn't have can't be in the intersection
8927  * 3) The exhausted was in its set, non-exhausted isn't, count is 1, and
8928  *    gets incremented to 2.  Like the previous case, the intersection is
8929  *    everything that remains in the non-exhausted set.
8930  * 4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
8931  *    remains 1.  And the intersection has nothing more. */
8932  if ((i_a == len_a && PREV_RANGE_MATCHES_INVLIST(i_a))
8933   || (i_b == len_b && PREV_RANGE_MATCHES_INVLIST(i_b)))
8934  {
8935   count++;
8936  }
8937
8938  /* The final length is what we've output so far plus what else is in the
8939  * intersection.  At most one of the subexpressions below will be non-zero
8940  * */
8941  len_r = i_r;
8942  if (count >= 2) {
8943   len_r += (len_a - i_a) + (len_b - i_b);
8944  }
8945
8946  /* Set result to final length, which can change the pointer to array_r, so
8947  * re-find it */
8948  if (len_r != _invlist_len(r)) {
8949   invlist_set_len(r, len_r, *get_invlist_offset_addr(r));
8950   invlist_trim(r);
8951   array_r = invlist_array(r);
8952  }
8953
8954  /* Finish outputting any remaining */
8955  if (count >= 2) { /* At most one will have a non-zero copy count */
8956   IV copy_count;
8957   if ((copy_count = len_a - i_a) > 0) {
8958    Copy(array_a + i_a, array_r + i_r, copy_count, UV);
8959   }
8960   else if ((copy_count = len_b - i_b) > 0) {
8961    Copy(array_b + i_b, array_r + i_r, copy_count, UV);
8962   }
8963  }
8964
8965  /*  We may be removing a reference to one of the inputs.  If so, the output
8966  *  is made mortal if the input was.  (Mortal SVs shouldn't have their ref
8967  *  count decremented) */
8968  if (a == *i || b == *i) {
8969   assert(! invlist_is_iterating(*i));
8970   if (SvTEMP(*i)) {
8971    sv_2mortal(r);
8972   }
8973   else {
8974    SvREFCNT_dec_NN(*i);
8975   }
8976  }
8977
8978  *i = r;
8979
8980  return;
8981 }
8982
8983 SV*
8984 Perl__add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
8985 {
8986  /* Add the range from 'start' to 'end' inclusive to the inversion list's
8987  * set.  A pointer to the inversion list is returned.  This may actually be
8988  * a new list, in which case the passed in one has been destroyed.  The
8989  * passed-in inversion list can be NULL, in which case a new one is created
8990  * with just the one range in it */
8991
8992  SV* range_invlist;
8993  UV len;
8994
8995  if (invlist == NULL) {
8996   invlist = _new_invlist(2);
8997   len = 0;
8998  }
8999  else {
9000   len = _invlist_len(invlist);
9001  }
9002
9003  /* If comes after the final entry actually in the list, can just append it
9004  * to the end, */
9005  if (len == 0
9006   || (! ELEMENT_RANGE_MATCHES_INVLIST(len - 1)
9007    && start >= invlist_array(invlist)[len - 1]))
9008  {
9009   _append_range_to_invlist(invlist, start, end);
9010   return invlist;
9011  }
9012
9013  /* Here, can't just append things, create and return a new inversion list
9014  * which is the union of this range and the existing inversion list */
9015  range_invlist = _new_invlist(2);
9016  _append_range_to_invlist(range_invlist, start, end);
9017
9018  _invlist_union(invlist, range_invlist, &invlist);
9019
9020  /* The temporary can be freed */
9021  SvREFCNT_dec_NN(range_invlist);
9022
9023  return invlist;
9024 }
9025
9026 SV*
9027 Perl__setup_canned_invlist(pTHX_ const STRLEN size, const UV element0,
9028         UV** other_elements_ptr)
9029 {
9030  /* Create and return an inversion list whose contents are to be populated
9031  * by the caller.  The caller gives the number of elements (in 'size') and
9032  * the very first element ('element0').  This function will set
9033  * '*other_elements_ptr' to an array of UVs, where the remaining elements
9034  * are to be placed.
9035  *
9036  * Obviously there is some trust involved that the caller will properly
9037  * fill in the other elements of the array.
9038  *
9039  * (The first element needs to be passed in, as the underlying code does
9040  * things differently depending on whether it is zero or non-zero) */
9041
9042  SV* invlist = _new_invlist(size);
9043  bool offset;
9044
9045  PERL_ARGS_ASSERT__SETUP_CANNED_INVLIST;
9046
9047  _append_range_to_invlist(invlist, element0, element0);
9048  offset = *get_invlist_offset_addr(invlist);
9049
9050  invlist_set_len(invlist, size, offset);
9051  *other_elements_ptr = invlist_array(invlist) + 1;
9052  return invlist;
9053 }
9054
9055 #endif
9056
9057 PERL_STATIC_INLINE SV*
9058 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
9059  return _add_range_to_invlist(invlist, cp, cp);
9060 }
9061
9062 #ifndef PERL_IN_XSUB_RE
9063 void
9064 Perl__invlist_invert(pTHX_ SV* const invlist)
9065 {
9066  /* Complement the input inversion list.  This adds a 0 if the list didn't
9067  * have a zero; removes it otherwise.  As described above, the data
9068  * structure is set up so that this is very efficient */
9069
9070  PERL_ARGS_ASSERT__INVLIST_INVERT;
9071
9072  assert(! invlist_is_iterating(invlist));
9073
9074  /* The inverse of matching nothing is matching everything */
9075  if (_invlist_len(invlist) == 0) {
9076   _append_range_to_invlist(invlist, 0, UV_MAX);
9077   return;
9078  }
9079
9080  *get_invlist_offset_addr(invlist) = ! *get_invlist_offset_addr(invlist);
9081 }
9082
9083 #endif
9084
9085 PERL_STATIC_INLINE SV*
9086 S_invlist_clone(pTHX_ SV* const invlist)
9087 {
9088
9089  /* Return a new inversion list that is a copy of the input one, which is
9090  * unchanged.  The new list will not be mortal even if the old one was. */
9091
9092  /* Need to allocate extra space to accommodate Perl's addition of a
9093  * trailing NUL to SvPV's, since it thinks they are always strings */
9094  SV* new_invlist = _new_invlist(_invlist_len(invlist) + 1);
9095  STRLEN physical_length = SvCUR(invlist);
9096  bool offset = *(get_invlist_offset_addr(invlist));
9097
9098  PERL_ARGS_ASSERT_INVLIST_CLONE;
9099
9100  *(get_invlist_offset_addr(new_invlist)) = offset;
9101  invlist_set_len(new_invlist, _invlist_len(invlist), offset);
9102  Copy(SvPVX(invlist), SvPVX(new_invlist), physical_length, char);
9103
9104  return new_invlist;
9105 }
9106
9107 PERL_STATIC_INLINE STRLEN*
9108 S_get_invlist_iter_addr(SV* invlist)
9109 {
9110  /* Return the address of the UV that contains the current iteration
9111  * position */
9112
9113  PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
9114
9115  assert(SvTYPE(invlist) == SVt_INVLIST);
9116
9117  return &(((XINVLIST*) SvANY(invlist))->iterator);
9118 }
9119
9120 PERL_STATIC_INLINE void
9121 S_invlist_iterinit(SV* invlist) /* Initialize iterator for invlist */
9122 {
9123  PERL_ARGS_ASSERT_INVLIST_ITERINIT;
9124
9125  *get_invlist_iter_addr(invlist) = 0;
9126 }
9127
9128 PERL_STATIC_INLINE void
9129 S_invlist_iterfinish(SV* invlist)
9130 {
9131  /* Terminate iterator for invlist.  This is to catch development errors.
9132  * Any iteration that is interrupted before completed should call this
9133  * function.  Functions that add code points anywhere else but to the end
9134  * of an inversion list assert that they are not in the middle of an
9135  * iteration.  If they were, the addition would make the iteration
9136  * problematical: if the iteration hadn't reached the place where things
9137  * were being added, it would be ok */
9138
9139  PERL_ARGS_ASSERT_INVLIST_ITERFINISH;
9140
9141  *get_invlist_iter_addr(invlist) = (STRLEN) UV_MAX;
9142 }
9143
9144 STATIC bool
9145 S_invlist_iternext(SV* invlist, UV* start, UV* end)
9146 {
9147  /* An C<invlist_iterinit> call on <invlist> must be used to set this up.
9148  * This call sets in <*start> and <*end>, the next range in <invlist>.
9149  * Returns <TRUE> if successful and the next call will return the next
9150  * range; <FALSE> if was already at the end of the list.  If the latter,
9151  * <*start> and <*end> are unchanged, and the next call to this function
9152  * will start over at the beginning of the list */
9153
9154  STRLEN* pos = get_invlist_iter_addr(invlist);
9155  UV len = _invlist_len(invlist);
9156  UV *array;
9157
9158  PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
9159
9160  if (*pos >= len) {
9161   *pos = (STRLEN) UV_MAX; /* Force iterinit() to be required next time */
9162   return FALSE;
9163  }
9164
9165  array = invlist_array(invlist);
9166
9167  *start = array[(*pos)++];
9168
9169  if (*pos >= len) {
9170   *end = UV_MAX;
9171  }
9172  else {
9173   *end = array[(*pos)++] - 1;
9174  }
9175
9176  return TRUE;
9177 }
9178
9179 PERL_STATIC_INLINE UV
9180 S_invlist_highest(SV* const invlist)
9181 {
9182  /* Returns the highest code point that matches an inversion list.  This API
9183  * has an ambiguity, as it returns 0 under either the highest is actually
9184  * 0, or if the list is empty.  If this distinction matters to you, check
9185  * for emptiness before calling this function */
9186
9187  UV len = _invlist_len(invlist);
9188  UV *array;
9189
9190  PERL_ARGS_ASSERT_INVLIST_HIGHEST;
9191
9192  if (len == 0) {
9193   return 0;
9194  }
9195
9196  array = invlist_array(invlist);
9197
9198  /* The last element in the array in the inversion list always starts a
9199  * range that goes to infinity.  That range may be for code points that are
9200  * matched in the inversion list, or it may be for ones that aren't
9201  * matched.  In the latter case, the highest code point in the set is one
9202  * less than the beginning of this range; otherwise it is the final element
9203  * of this range: infinity */
9204  return (ELEMENT_RANGE_MATCHES_INVLIST(len - 1))
9205   ? UV_MAX
9206   : array[len - 1] - 1;
9207 }
9208
9209 #ifndef PERL_IN_XSUB_RE
9210 SV *
9211 Perl__invlist_contents(pTHX_ SV* const invlist)
9212 {
9213  /* Get the contents of an inversion list into a string SV so that they can
9214  * be printed out.  It uses the format traditionally done for debug tracing
9215  */
9216
9217  UV start, end;
9218  SV* output = newSVpvs("\n");
9219
9220  PERL_ARGS_ASSERT__INVLIST_CONTENTS;
9221
9222  assert(! invlist_is_iterating(invlist));
9223
9224  invlist_iterinit(invlist);
9225  while (invlist_iternext(invlist, &start, &end)) {
9226   if (end == UV_MAX) {
9227    Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\tINFINITY\n", start);
9228   }
9229   else if (end != start) {
9230    Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\t%04"UVXf"\n",
9231      start,       end);
9232   }
9233   else {
9234    Perl_sv_catpvf(aTHX_ output, "%04"UVXf"\n", start);
9235   }
9236  }
9237
9238  return output;
9239 }
9240 #endif
9241
9242 #ifndef PERL_IN_XSUB_RE
9243 void
9244 Perl__invlist_dump(pTHX_ PerlIO *file, I32 level,
9245       const char * const indent, SV* const invlist)
9246 {
9247  /* Designed to be called only by do_sv_dump().  Dumps out the ranges of the
9248  * inversion list 'invlist' to 'file' at 'level'  Each line is prefixed by
9249  * the string 'indent'.  The output looks like this:
9250   [0] 0x000A .. 0x000D
9251   [2] 0x0085
9252   [4] 0x2028 .. 0x2029
9253   [6] 0x3104 .. INFINITY
9254  * This means that the first range of code points matched by the list are
9255  * 0xA through 0xD; the second range contains only the single code point
9256  * 0x85, etc.  An inversion list is an array of UVs.  Two array elements
9257  * are used to define each range (except if the final range extends to
9258  * infinity, only a single element is needed).  The array index of the
9259  * first element for the corresponding range is given in brackets. */
9260
9261  UV start, end;
9262  STRLEN count = 0;
9263
9264  PERL_ARGS_ASSERT__INVLIST_DUMP;
9265
9266  if (invlist_is_iterating(invlist)) {
9267   Perl_dump_indent(aTHX_ level, file,
9268    "%sCan't dump inversion list because is in middle of iterating\n",
9269    indent);
9270   return;
9271  }
9272
9273  invlist_iterinit(invlist);
9274  while (invlist_iternext(invlist, &start, &end)) {
9275   if (end == UV_MAX) {
9276    Perl_dump_indent(aTHX_ level, file,
9277          "%s[%"UVuf"] 0x%04"UVXf" .. INFINITY\n",
9278         indent, (UV)count, start);
9279   }
9280   else if (end != start) {
9281    Perl_dump_indent(aTHX_ level, file,
9282          "%s[%"UVuf"] 0x%04"UVXf" .. 0x%04"UVXf"\n",
9283         indent, (UV)count, start,         end);
9284   }
9285   else {
9286    Perl_dump_indent(aTHX_ level, file, "%s[%"UVuf"] 0x%04"UVXf"\n",
9287            indent, (UV)count, start);
9288   }
9289   count += 2;
9290  }
9291 }
9292
9293 void
9294 Perl__load_PL_utf8_foldclosures (pTHX)
9295 {
9296  assert(! PL_utf8_foldclosures);
9297
9298  /* If the folds haven't been read in, call a fold function
9299  * to force that */
9300  if (! PL_utf8_tofold) {
9301   U8 dummy[UTF8_MAXBYTES_CASE+1];
9302
9303   /* This string is just a short named one above \xff */
9304   to_utf8_fold((U8*) HYPHEN_UTF8, dummy, NULL);
9305   assert(PL_utf8_tofold); /* Verify that worked */
9306  }
9307  PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
9308 }
9309 #endif
9310
9311 #ifdef PERL_ARGS_ASSERT__INVLISTEQ
9312 bool
9313 S__invlistEQ(pTHX_ SV* const a, SV* const b, const bool complement_b)
9314 {
9315  /* Return a boolean as to if the two passed in inversion lists are
9316  * identical.  The final argument, if TRUE, says to take the complement of
9317  * the second inversion list before doing the comparison */
9318
9319  const UV* array_a = invlist_array(a);
9320  const UV* array_b = invlist_array(b);
9321  UV len_a = _invlist_len(a);
9322  UV len_b = _invlist_len(b);
9323
9324  UV i = 0;      /* current index into the arrays */
9325  bool retval = TRUE;     /* Assume are identical until proven otherwise */
9326
9327  PERL_ARGS_ASSERT__INVLISTEQ;
9328
9329  /* If are to compare 'a' with the complement of b, set it
9330  * up so are looking at b's complement. */
9331  if (complement_b) {
9332
9333   /* The complement of nothing is everything, so <a> would have to have
9334   * just one element, starting at zero (ending at infinity) */
9335   if (len_b == 0) {
9336    return (len_a == 1 && array_a[0] == 0);
9337   }
9338   else if (array_b[0] == 0) {
9339
9340    /* Otherwise, to complement, we invert.  Here, the first element is
9341    * 0, just remove it.  To do this, we just pretend the array starts
9342    * one later */
9343
9344    array_b++;
9345    len_b--;
9346   }
9347   else {
9348
9349    /* But if the first element is not zero, we pretend the list starts
9350    * at the 0 that is always stored immediately before the array. */
9351    array_b--;
9352    len_b++;
9353   }
9354  }
9355
9356  /* Make sure that the lengths are the same, as well as the final element
9357  * before looping through the remainder.  (Thus we test the length, final,
9358  * and first elements right off the bat) */
9359  if (len_a != len_b || array_a[len_a-1] != array_b[len_a-1]) {
9360   retval = FALSE;
9361  }
9362  else for (i = 0; i < len_a - 1; i++) {
9363   if (array_a[i] != array_b[i]) {
9364    retval = FALSE;
9365    break;
9366   }
9367  }
9368
9369  return retval;
9370 }
9371 #endif
9372
9373 /*
9374  * As best we can, determine the characters that can match the start of
9375  * the given EXACTF-ish node.
9376  *
9377  * Returns the invlist as a new SV*; it is the caller's responsibility to
9378  * call SvREFCNT_dec() when done with it.
9379  */
9380 STATIC SV*
9381 S__make_exactf_invlist(pTHX_ RExC_state_t *pRExC_state, regnode *node)
9382 {
9383  const U8 * s = (U8*)STRING(node);
9384  SSize_t bytelen = STR_LEN(node);
9385  UV uc;
9386  /* Start out big enough for 2 separate code points */
9387  SV* invlist = _new_invlist(4);
9388
9389  PERL_ARGS_ASSERT__MAKE_EXACTF_INVLIST;
9390
9391  if (! UTF) {
9392   uc = *s;
9393
9394   /* We punt and assume can match anything if the node begins
9395   * with a multi-character fold.  Things are complicated.  For
9396   * example, /ffi/i could match any of:
9397   *  "\N{LATIN SMALL LIGATURE FFI}"
9398   *  "\N{LATIN SMALL LIGATURE FF}I"
9399   *  "F\N{LATIN SMALL LIGATURE FI}"
9400   *  plus several other things; and making sure we have all the
9401   *  possibilities is hard. */
9402   if (is_MULTI_CHAR_FOLD_latin1_safe(s, s + bytelen)) {
9403    invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
9404   }
9405   else {
9406    /* Any Latin1 range character can potentially match any
9407    * other depending on the locale */
9408    if (OP(node) == EXACTFL) {
9409     _invlist_union(invlist, PL_Latin1, &invlist);
9410    }
9411    else {
9412     /* But otherwise, it matches at least itself.  We can
9413     * quickly tell if it has a distinct fold, and if so,
9414     * it matches that as well */
9415     invlist = add_cp_to_invlist(invlist, uc);
9416     if (IS_IN_SOME_FOLD_L1(uc))
9417      invlist = add_cp_to_invlist(invlist, PL_fold_latin1[uc]);
9418    }
9419
9420    /* Some characters match above-Latin1 ones under /i.  This
9421    * is true of EXACTFL ones when the locale is UTF-8 */
9422    if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(uc)
9423     && (! isASCII(uc) || (OP(node) != EXACTFA
9424          && OP(node) != EXACTFA_NO_TRIE)))
9425    {
9426     add_above_Latin1_folds(pRExC_state, (U8) uc, &invlist);
9427    }
9428   }
9429  }
9430  else {  /* Pattern is UTF-8 */
9431   U8 folded[UTF8_MAX_FOLD_CHAR_EXPAND * UTF8_MAXBYTES_CASE + 1] = { '\0' };
9432   STRLEN foldlen = UTF8SKIP(s);
9433   const U8* e = s + bytelen;
9434   SV** listp;
9435
9436   uc = utf8_to_uvchr_buf(s, s + bytelen, NULL);
9437
9438   /* The only code points that aren't folded in a UTF EXACTFish
9439   * node are are the problematic ones in EXACTFL nodes */
9440   if (OP(node) == EXACTFL && is_PROBLEMATIC_LOCALE_FOLDEDS_START_cp(uc)) {
9441    /* We need to check for the possibility that this EXACTFL
9442    * node begins with a multi-char fold.  Therefore we fold
9443    * the first few characters of it so that we can make that
9444    * check */
9445    U8 *d = folded;
9446    int i;
9447
9448    for (i = 0; i < UTF8_MAX_FOLD_CHAR_EXPAND && s < e; i++) {
9449     if (isASCII(*s)) {
9450      *(d++) = (U8) toFOLD(*s);
9451      s++;
9452     }
9453     else {
9454      STRLEN len;
9455      to_utf8_fold(s, d, &len);
9456      d += len;
9457      s += UTF8SKIP(s);
9458     }
9459    }
9460
9461    /* And set up so the code below that looks in this folded
9462    * buffer instead of the node's string */
9463    e = d;
9464    foldlen = UTF8SKIP(folded);
9465    s = folded;
9466   }
9467
9468   /* When we reach here 's' points to the fold of the first
9469   * character(s) of the node; and 'e' points to far enough along
9470   * the folded string to be just past any possible multi-char
9471   * fold. 'foldlen' is the length in bytes of the first
9472   * character in 's'
9473   *
9474   * Unlike the non-UTF-8 case, the macro for determining if a
9475   * string is a multi-char fold requires all the characters to
9476   * already be folded.  This is because of all the complications
9477   * if not.  Note that they are folded anyway, except in EXACTFL
9478   * nodes.  Like the non-UTF case above, we punt if the node
9479   * begins with a multi-char fold  */
9480
9481   if (is_MULTI_CHAR_FOLD_utf8_safe(s, e)) {
9482    invlist = _add_range_to_invlist(invlist, 0, UV_MAX);
9483   }
9484   else {  /* Single char fold */
9485
9486    /* It matches all the things that fold to it, which are
9487    * found in PL_utf8_foldclosures (including itself) */
9488    invlist = add_cp_to_invlist(invlist, uc);
9489    if (! PL_utf8_foldclosures)
9490     _load_PL_utf8_foldclosures();
9491    if ((listp = hv_fetch(PL_utf8_foldclosures,
9492         (char *) s, foldlen, FALSE)))
9493    {
9494     AV* list = (AV*) *listp;
9495     IV k;
9496     for (k = 0; k <= av_tindex(list); k++) {
9497      SV** c_p = av_fetch(list, k, FALSE);
9498      UV c;
9499      assert(c_p);
9500
9501      c = SvUV(*c_p);
9502
9503      /* /aa doesn't allow folds between ASCII and non- */
9504      if ((OP(node) == EXACTFA || OP(node) == EXACTFA_NO_TRIE)
9505       && isASCII(c) != isASCII(uc))
9506      {
9507       continue;
9508      }
9509
9510      invlist = add_cp_to_invlist(invlist, c);
9511     }
9512    }
9513   }
9514  }
9515
9516  return invlist;
9517 }
9518
9519 #undef HEADER_LENGTH
9520 #undef TO_INTERNAL_SIZE
9521 #undef FROM_INTERNAL_SIZE
9522 #undef INVLIST_VERSION_ID
9523
9524 /* End of inversion list object */
9525
9526 STATIC void
9527 S_parse_lparen_question_flags(pTHX_ RExC_state_t *pRExC_state)
9528 {
9529  /* This parses the flags that are in either the '(?foo)' or '(?foo:bar)'
9530  * constructs, and updates RExC_flags with them.  On input, RExC_parse
9531  * should point to the first flag; it is updated on output to point to the
9532  * final ')' or ':'.  There needs to be at least one flag, or this will
9533  * abort */
9534
9535  /* for (?g), (?gc), and (?o) warnings; warning
9536  about (?c) will warn about (?g) -- japhy    */
9537
9538 #define WASTED_O  0x01
9539 #define WASTED_G  0x02
9540 #define WASTED_C  0x04
9541 #define WASTED_GC (WASTED_G|WASTED_C)
9542  I32 wastedflags = 0x00;
9543  U32 posflags = 0, negflags = 0;
9544  U32 *flagsp = &posflags;
9545  char has_charset_modifier = '\0';
9546  regex_charset cs;
9547  bool has_use_defaults = FALSE;
9548  const char* const seqstart = RExC_parse - 1; /* Point to the '?' */
9549  int x_mod_count = 0;
9550
9551  PERL_ARGS_ASSERT_PARSE_LPAREN_QUESTION_FLAGS;
9552
9553  /* '^' as an initial flag sets certain defaults */
9554  if (UCHARAT(RExC_parse) == '^') {
9555   RExC_parse++;
9556   has_use_defaults = TRUE;
9557   STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
9558   set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
9559           ? REGEX_UNICODE_CHARSET
9560           : REGEX_DEPENDS_CHARSET);
9561  }
9562
9563  cs = get_regex_charset(RExC_flags);
9564  if (cs == REGEX_DEPENDS_CHARSET
9565   && (RExC_utf8 || RExC_uni_semantics))
9566  {
9567   cs = REGEX_UNICODE_CHARSET;
9568  }
9569
9570  while (*RExC_parse) {
9571   /* && strchr("iogcmsx", *RExC_parse) */
9572   /* (?g), (?gc) and (?o) are useless here
9573   and must be globally applied -- japhy */
9574   switch (*RExC_parse) {
9575
9576    /* Code for the imsxn flags */
9577    CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp, x_mod_count);
9578
9579    case LOCALE_PAT_MOD:
9580     if (has_charset_modifier) {
9581      goto excess_modifier;
9582     }
9583     else if (flagsp == &negflags) {
9584      goto neg_modifier;
9585     }
9586     cs = REGEX_LOCALE_CHARSET;
9587     has_charset_modifier = LOCALE_PAT_MOD;
9588     break;
9589    case UNICODE_PAT_MOD:
9590     if (has_charset_modifier) {
9591      goto excess_modifier;
9592     }
9593     else if (flagsp == &negflags) {
9594      goto neg_modifier;
9595     }
9596     cs = REGEX_UNICODE_CHARSET;
9597     has_charset_modifier = UNICODE_PAT_MOD;
9598     break;
9599    case ASCII_RESTRICT_PAT_MOD:
9600     if (flagsp == &negflags) {
9601      goto neg_modifier;
9602     }
9603     if (has_charset_modifier) {
9604      if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
9605       goto excess_modifier;
9606      }
9607      /* Doubled modifier implies more restricted */
9608      cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
9609     }
9610     else {
9611      cs = REGEX_ASCII_RESTRICTED_CHARSET;
9612     }
9613     has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
9614     break;
9615    case DEPENDS_PAT_MOD:
9616     if (has_use_defaults) {
9617      goto fail_modifiers;
9618     }
9619     else if (flagsp == &negflags) {
9620      goto neg_modifier;
9621     }
9622     else if (has_charset_modifier) {
9623      goto excess_modifier;
9624     }
9625
9626     /* The dual charset means unicode semantics if the
9627     * pattern (or target, not known until runtime) are
9628     * utf8, or something in the pattern indicates unicode
9629     * semantics */
9630     cs = (RExC_utf8 || RExC_uni_semantics)
9631      ? REGEX_UNICODE_CHARSET
9632      : REGEX_DEPENDS_CHARSET;
9633     has_charset_modifier = DEPENDS_PAT_MOD;
9634     break;
9635    excess_modifier:
9636     RExC_parse++;
9637     if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
9638      vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
9639     }
9640     else if (has_charset_modifier == *(RExC_parse - 1)) {
9641      vFAIL2("Regexp modifier \"%c\" may not appear twice",
9642           *(RExC_parse - 1));
9643     }
9644     else {
9645      vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
9646     }
9647     NOT_REACHED; /*NOTREACHED*/
9648    neg_modifier:
9649     RExC_parse++;
9650     vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"",
9651          *(RExC_parse - 1));
9652     NOT_REACHED; /*NOTREACHED*/
9653    case ONCE_PAT_MOD: /* 'o' */
9654    case GLOBAL_PAT_MOD: /* 'g' */
9655     if (PASS2 && ckWARN(WARN_REGEXP)) {
9656      const I32 wflagbit = *RExC_parse == 'o'
9657           ? WASTED_O
9658           : WASTED_G;
9659      if (! (wastedflags & wflagbit) ) {
9660       wastedflags |= wflagbit;
9661       /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
9662       vWARN5(
9663        RExC_parse + 1,
9664        "Useless (%s%c) - %suse /%c modifier",
9665        flagsp == &negflags ? "?-" : "?",
9666        *RExC_parse,
9667        flagsp == &negflags ? "don't " : "",
9668        *RExC_parse
9669       );
9670      }
9671     }
9672     break;
9673
9674    case CONTINUE_PAT_MOD: /* 'c' */
9675     if (PASS2 && ckWARN(WARN_REGEXP)) {
9676      if (! (wastedflags & WASTED_C) ) {
9677       wastedflags |= WASTED_GC;
9678       /* diag_listed_as: Useless (?-%s) - don't use /%s modifier in regex; marked by <-- HERE in m/%s/ */
9679       vWARN3(
9680        RExC_parse + 1,
9681        "Useless (%sc) - %suse /gc modifier",
9682        flagsp == &negflags ? "?-" : "?",
9683        flagsp == &negflags ? "don't " : ""
9684       );
9685      }
9686     }
9687     break;
9688    case KEEPCOPY_PAT_MOD: /* 'p' */
9689     if (flagsp == &negflags) {
9690      if (PASS2)
9691       ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
9692     } else {
9693      *flagsp |= RXf_PMf_KEEPCOPY;
9694     }
9695     break;
9696    case '-':
9697     /* A flag is a default iff it is following a minus, so
9698     * if there is a minus, it means will be trying to
9699     * re-specify a default which is an error */
9700     if (has_use_defaults || flagsp == &negflags) {
9701      goto fail_modifiers;
9702     }
9703     flagsp = &negflags;
9704     wastedflags = 0;  /* reset so (?g-c) warns twice */
9705     break;
9706    case ':':
9707    case ')':
9708     RExC_flags |= posflags;
9709     RExC_flags &= ~negflags;
9710     set_regex_charset(&RExC_flags, cs);
9711     if (RExC_flags & RXf_PMf_FOLD) {
9712      RExC_contains_i = 1;
9713     }
9714     if (PASS2) {
9715      STD_PMMOD_FLAGS_PARSE_X_WARN(x_mod_count);
9716     }
9717     return;
9718     /*NOTREACHED*/
9719    default:
9720    fail_modifiers:
9721     RExC_parse += SKIP_IF_CHAR(RExC_parse);
9722     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
9723     vFAIL2utf8f("Sequence (%"UTF8f"...) not recognized",
9724      UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
9725     NOT_REACHED; /*NOTREACHED*/
9726   }
9727
9728   ++RExC_parse;
9729  }
9730
9731  if (PASS2) {
9732   STD_PMMOD_FLAGS_PARSE_X_WARN(x_mod_count);
9733  }
9734 }
9735
9736 /*
9737  - reg - regular expression, i.e. main body or parenthesized thing
9738  *
9739  * Caller must absorb opening parenthesis.
9740  *
9741  * Combining parenthesis handling with the base level of regular expression
9742  * is a trifle forced, but the need to tie the tails of the branches to what
9743  * follows makes it hard to avoid.
9744  */
9745 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
9746 #ifdef DEBUGGING
9747 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
9748 #else
9749 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
9750 #endif
9751
9752 /* Returns NULL, setting *flagp to TRYAGAIN at the end of (?) that only sets
9753    flags. Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan
9754    needs to be restarted.
9755    Otherwise would only return NULL if regbranch() returns NULL, which
9756    cannot happen.  */
9757 STATIC regnode *
9758 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
9759  /* paren: Parenthesized? 0=top; 1,2=inside '(': changed to letter.
9760  * 2 is like 1, but indicates that nextchar() has been called to advance
9761  * RExC_parse beyond the '('.  Things like '(?' are indivisible tokens, and
9762  * this flag alerts us to the need to check for that */
9763 {
9764  regnode *ret;  /* Will be the head of the group. */
9765  regnode *br;
9766  regnode *lastbr;
9767  regnode *ender = NULL;
9768  I32 parno = 0;
9769  I32 flags;
9770  U32 oregflags = RExC_flags;
9771  bool have_branch = 0;
9772  bool is_open = 0;
9773  I32 freeze_paren = 0;
9774  I32 after_freeze = 0;
9775  I32 num; /* numeric backreferences */
9776
9777  char * parse_start = RExC_parse; /* MJD */
9778  char * const oregcomp_parse = RExC_parse;
9779
9780  GET_RE_DEBUG_FLAGS_DECL;
9781
9782  PERL_ARGS_ASSERT_REG;
9783  DEBUG_PARSE("reg ");
9784
9785  *flagp = 0;    /* Tentatively. */
9786
9787
9788  /* Make an OPEN node, if parenthesized. */
9789  if (paren) {
9790
9791   /* Under /x, space and comments can be gobbled up between the '(' and
9792   * here (if paren ==2).  The forms '(*VERB' and '(?...' disallow such
9793   * intervening space, as the sequence is a token, and a token should be
9794   * indivisible */
9795   bool has_intervening_patws = paren == 2 && *(RExC_parse - 1) != '(';
9796
9797   if ( *RExC_parse == '*') { /* (*VERB:ARG) */
9798    char *start_verb = RExC_parse;
9799    STRLEN verb_len = 0;
9800    char *start_arg = NULL;
9801    unsigned char op = 0;
9802    int argok = 1;
9803    int internal_argval = 0; /* internal_argval is only useful if
9804           !argok */
9805
9806    if (has_intervening_patws) {
9807     RExC_parse++;
9808     vFAIL("In '(*VERB...)', the '(' and '*' must be adjacent");
9809    }
9810    while ( *RExC_parse && *RExC_parse != ')' ) {
9811     if ( *RExC_parse == ':' ) {
9812      start_arg = RExC_parse + 1;
9813      break;
9814     }
9815     RExC_parse++;
9816    }
9817    ++start_verb;
9818    verb_len = RExC_parse - start_verb;
9819    if ( start_arg ) {
9820     RExC_parse++;
9821     while ( *RExC_parse && *RExC_parse != ')' )
9822      RExC_parse++;
9823     if ( *RExC_parse != ')' )
9824      vFAIL("Unterminated verb pattern argument");
9825     if ( RExC_parse == start_arg )
9826      start_arg = NULL;
9827    } else {
9828     if ( *RExC_parse != ')' )
9829      vFAIL("Unterminated verb pattern");
9830    }
9831
9832    switch ( *start_verb ) {
9833    case 'A':  /* (*ACCEPT) */
9834     if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
9835      op = ACCEPT;
9836      internal_argval = RExC_nestroot;
9837     }
9838     break;
9839    case 'C':  /* (*COMMIT) */
9840     if ( memEQs(start_verb,verb_len,"COMMIT") )
9841      op = COMMIT;
9842     break;
9843    case 'F':  /* (*FAIL) */
9844     if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
9845      op = OPFAIL;
9846      argok = 0;
9847     }
9848     break;
9849    case ':':  /* (*:NAME) */
9850    case 'M':  /* (*MARK:NAME) */
9851     if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
9852      op = MARKPOINT;
9853      argok = -1;
9854     }
9855     break;
9856    case 'P':  /* (*PRUNE) */
9857     if ( memEQs(start_verb,verb_len,"PRUNE") )
9858      op = PRUNE;
9859     break;
9860    case 'S':   /* (*SKIP) */
9861     if ( memEQs(start_verb,verb_len,"SKIP") )
9862      op = SKIP;
9863     break;
9864    case 'T':  /* (*THEN) */
9865     /* [19:06] <TimToady> :: is then */
9866     if ( memEQs(start_verb,verb_len,"THEN") ) {
9867      op = CUTGROUP;
9868      RExC_seen |= REG_CUTGROUP_SEEN;
9869     }
9870     break;
9871    }
9872    if ( ! op ) {
9873     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
9874     vFAIL2utf8f(
9875      "Unknown verb pattern '%"UTF8f"'",
9876      UTF8fARG(UTF, verb_len, start_verb));
9877    }
9878    if ( argok ) {
9879     if ( start_arg && internal_argval ) {
9880      vFAIL3("Verb pattern '%.*s' may not have an argument",
9881       verb_len, start_verb);
9882     } else if ( argok < 0 && !start_arg ) {
9883      vFAIL3("Verb pattern '%.*s' has a mandatory argument",
9884       verb_len, start_verb);
9885     } else {
9886      ret = reganode(pRExC_state, op, internal_argval);
9887      if ( ! internal_argval && ! SIZE_ONLY ) {
9888       if (start_arg) {
9889        SV *sv = newSVpvn( start_arg,
9890            RExC_parse - start_arg);
9891        ARG(ret) = add_data( pRExC_state,
9892             STR_WITH_LEN("S"));
9893        RExC_rxi->data->data[ARG(ret)]=(void*)sv;
9894        ret->flags = 0;
9895       } else {
9896        ret->flags = 1;
9897       }
9898      }
9899     }
9900     if (!internal_argval)
9901      RExC_seen |= REG_VERBARG_SEEN;
9902    } else if ( start_arg ) {
9903     vFAIL3("Verb pattern '%.*s' may not have an argument",
9904       verb_len, start_verb);
9905    } else {
9906     ret = reg_node(pRExC_state, op);
9907    }
9908    nextchar(pRExC_state);
9909    return ret;
9910   }
9911   else if (*RExC_parse == '?') { /* (?...) */
9912    bool is_logical = 0;
9913    const char * const seqstart = RExC_parse;
9914    const char * endptr;
9915    if (has_intervening_patws) {
9916     RExC_parse++;
9917     vFAIL("In '(?...)', the '(' and '?' must be adjacent");
9918    }
9919
9920    RExC_parse++;
9921    paren = *RExC_parse++;
9922    ret = NULL;   /* For look-ahead/behind. */
9923    switch (paren) {
9924
9925    case 'P': /* (?P...) variants for those used to PCRE/Python */
9926     paren = *RExC_parse++;
9927     if ( paren == '<')         /* (?P<...>) named capture */
9928      goto named_capture;
9929     else if (paren == '>') {   /* (?P>name) named recursion */
9930      goto named_recursion;
9931     }
9932     else if (paren == '=') {   /* (?P=...)  named backref */
9933      /* this pretty much dupes the code for \k<NAME> in
9934      * regatom(), if you change this make sure you change that
9935      * */
9936      char* name_start = RExC_parse;
9937      U32 num = 0;
9938      SV *sv_dat = reg_scan_name(pRExC_state,
9939       SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
9940      if (RExC_parse == name_start || *RExC_parse != ')')
9941       /* diag_listed_as: Sequence ?P=... not terminated in regex; marked by <-- HERE in m/%s/ */
9942       vFAIL2("Sequence %.3s... not terminated",parse_start);
9943
9944      if (!SIZE_ONLY) {
9945       num = add_data( pRExC_state, STR_WITH_LEN("S"));
9946       RExC_rxi->data->data[num]=(void*)sv_dat;
9947       SvREFCNT_inc_simple_void(sv_dat);
9948      }
9949      RExC_sawback = 1;
9950      ret = reganode(pRExC_state,
9951         ((! FOLD)
9952          ? NREF
9953          : (ASCII_FOLD_RESTRICTED)
9954          ? NREFFA
9955          : (AT_LEAST_UNI_SEMANTICS)
9956           ? NREFFU
9957           : (LOC)
9958           ? NREFFL
9959           : NREFF),
9960          num);
9961      *flagp |= HASWIDTH;
9962
9963      Set_Node_Offset(ret, parse_start+1);
9964      Set_Node_Cur_Length(ret, parse_start);
9965
9966      nextchar(pRExC_state);
9967      return ret;
9968     }
9969     --RExC_parse;
9970     RExC_parse += SKIP_IF_CHAR(RExC_parse);
9971     /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
9972     vFAIL3("Sequence (%.*s...) not recognized",
9973         RExC_parse-seqstart, seqstart);
9974     NOT_REACHED; /*NOTREACHED*/
9975    case '<':           /* (?<...) */
9976     if (*RExC_parse == '!')
9977      paren = ',';
9978     else if (*RExC_parse != '=')
9979    named_capture:
9980     {               /* (?<...>) */
9981      char *name_start;
9982      SV *svname;
9983      paren= '>';
9984    case '\'':          /* (?'...') */
9985       name_start= RExC_parse;
9986       svname = reg_scan_name(pRExC_state,
9987       SIZE_ONLY    /* reverse test from the others */
9988       ? REG_RSN_RETURN_NAME
9989       : REG_RSN_RETURN_NULL);
9990      if (RExC_parse == name_start || *RExC_parse != paren)
9991       vFAIL2("Sequence (?%c... not terminated",
9992        paren=='>' ? '<' : paren);
9993      if (SIZE_ONLY) {
9994       HE *he_str;
9995       SV *sv_dat = NULL;
9996       if (!svname) /* shouldn't happen */
9997        Perl_croak(aTHX_
9998         "panic: reg_scan_name returned NULL");
9999       if (!RExC_paren_names) {
10000        RExC_paren_names= newHV();
10001        sv_2mortal(MUTABLE_SV(RExC_paren_names));
10002 #ifdef DEBUGGING
10003        RExC_paren_name_list= newAV();
10004        sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
10005 #endif
10006       }
10007       he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
10008       if ( he_str )
10009        sv_dat = HeVAL(he_str);
10010       if ( ! sv_dat ) {
10011        /* croak baby croak */
10012        Perl_croak(aTHX_
10013         "panic: paren_name hash element allocation failed");
10014       } else if ( SvPOK(sv_dat) ) {
10015        /* (?|...) can mean we have dupes so scan to check
10016        its already been stored. Maybe a flag indicating
10017        we are inside such a construct would be useful,
10018        but the arrays are likely to be quite small, so
10019        for now we punt -- dmq */
10020        IV count = SvIV(sv_dat);
10021        I32 *pv = (I32*)SvPVX(sv_dat);
10022        IV i;
10023        for ( i = 0 ; i < count ; i++ ) {
10024         if ( pv[i] == RExC_npar ) {
10025          count = 0;
10026          break;
10027         }
10028        }
10029        if ( count ) {
10030         pv = (I32*)SvGROW(sv_dat,
10031             SvCUR(sv_dat) + sizeof(I32)+1);
10032         SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
10033         pv[count] = RExC_npar;
10034         SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
10035        }
10036       } else {
10037        (void)SvUPGRADE(sv_dat,SVt_PVNV);
10038        sv_setpvn(sv_dat, (char *)&(RExC_npar),
10039                 sizeof(I32));
10040        SvIOK_on(sv_dat);
10041        SvIV_set(sv_dat, 1);
10042       }
10043 #ifdef DEBUGGING
10044       /* Yes this does cause a memory leak in debugging Perls
10045       * */
10046       if (!av_store(RExC_paren_name_list,
10047          RExC_npar, SvREFCNT_inc(svname)))
10048        SvREFCNT_dec_NN(svname);
10049 #endif
10050
10051       /*sv_dump(sv_dat);*/
10052      }
10053      nextchar(pRExC_state);
10054      paren = 1;
10055      goto capturing_parens;
10056     }
10057     RExC_seen |= REG_LOOKBEHIND_SEEN;
10058     RExC_in_lookbehind++;
10059     RExC_parse++;
10060     /* FALLTHROUGH */
10061    case '=':           /* (?=...) */
10062     RExC_seen_zerolen++;
10063     break;
10064    case '!':           /* (?!...) */
10065     RExC_seen_zerolen++;
10066     /* check if we're really just a "FAIL" assertion */
10067     --RExC_parse;
10068     nextchar(pRExC_state);
10069     if (*RExC_parse == ')') {
10070      ret=reg_node(pRExC_state, OPFAIL);
10071      nextchar(pRExC_state);
10072      return ret;
10073     }
10074     break;
10075    case '|':           /* (?|...) */
10076     /* branch reset, behave like a (?:...) except that
10077     buffers in alternations share the same numbers */
10078     paren = ':';
10079     after_freeze = freeze_paren = RExC_npar;
10080     break;
10081    case ':':           /* (?:...) */
10082    case '>':           /* (?>...) */
10083     break;
10084    case '$':           /* (?$...) */
10085    case '@':           /* (?@...) */
10086     vFAIL2("Sequence (?%c...) not implemented", (int)paren);
10087     break;
10088    case '0' :           /* (?0) */
10089    case 'R' :           /* (?R) */
10090     if (*RExC_parse != ')')
10091      FAIL("Sequence (?R) not terminated");
10092     ret = reg_node(pRExC_state, GOSTART);
10093      RExC_seen |= REG_GOSTART_SEEN;
10094     *flagp |= POSTPONED;
10095     nextchar(pRExC_state);
10096     return ret;
10097     /*notreached*/
10098    /* named and numeric backreferences */
10099    case '&':            /* (?&NAME) */
10100     parse_start = RExC_parse - 1;
10101    named_recursion:
10102     {
10103       SV *sv_dat = reg_scan_name(pRExC_state,
10104        SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10105       num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10106     }
10107     if (RExC_parse == RExC_end || *RExC_parse != ')')
10108      vFAIL("Sequence (?&... not terminated");
10109     goto gen_recurse_regop;
10110     /* NOTREACHED */
10111    case '+':
10112     if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10113      RExC_parse++;
10114      vFAIL("Illegal pattern");
10115     }
10116     goto parse_recursion;
10117     /* NOTREACHED*/
10118    case '-': /* (?-1) */
10119     if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
10120      RExC_parse--; /* rewind to let it be handled later */
10121      goto parse_flags;
10122     }
10123     /* FALLTHROUGH */
10124    case '1': case '2': case '3': case '4': /* (?1) */
10125    case '5': case '6': case '7': case '8': case '9':
10126     RExC_parse--;
10127    parse_recursion:
10128     {
10129      bool is_neg = FALSE;
10130      UV unum;
10131      parse_start = RExC_parse - 1; /* MJD */
10132      if (*RExC_parse == '-') {
10133       RExC_parse++;
10134       is_neg = TRUE;
10135      }
10136      if (grok_atoUV(RExC_parse, &unum, &endptr)
10137       && unum <= I32_MAX
10138      ) {
10139       num = (I32)unum;
10140       RExC_parse = (char*)endptr;
10141      } else
10142       num = I32_MAX;
10143      if (is_neg) {
10144       /* Some limit for num? */
10145       num = -num;
10146      }
10147     }
10148     if (*RExC_parse!=')')
10149      vFAIL("Expecting close bracket");
10150
10151    gen_recurse_regop:
10152     if ( paren == '-' ) {
10153      /*
10154      Diagram of capture buffer numbering.
10155      Top line is the normal capture buffer numbers
10156      Bottom line is the negative indexing as from
10157      the X (the (?-2))
10158
10159      +   1 2    3 4 5 X          6 7
10160      /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
10161      -   5 4    3 2 1 X          x x
10162
10163      */
10164      num = RExC_npar + num;
10165      if (num < 1)  {
10166       RExC_parse++;
10167       vFAIL("Reference to nonexistent group");
10168      }
10169     } else if ( paren == '+' ) {
10170      num = RExC_npar + num - 1;
10171     }
10172
10173     ret = reg2Lanode(pRExC_state, GOSUB, num, RExC_recurse_count);
10174     if (!SIZE_ONLY) {
10175      if (num > (I32)RExC_rx->nparens) {
10176       RExC_parse++;
10177       vFAIL("Reference to nonexistent group");
10178      }
10179      RExC_recurse_count++;
10180      DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10181       "%*s%*s Recurse #%"UVuf" to %"IVdf"\n",
10182        22, "|    |", (int)(depth * 2 + 1), "",
10183        (UV)ARG(ret), (IV)ARG2L(ret)));
10184     }
10185     RExC_seen |= REG_RECURSE_SEEN;
10186     Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
10187     Set_Node_Offset(ret, parse_start); /* MJD */
10188
10189     *flagp |= POSTPONED;
10190     nextchar(pRExC_state);
10191     return ret;
10192
10193    /* NOTREACHED */
10194
10195    case '?':           /* (??...) */
10196     is_logical = 1;
10197     if (*RExC_parse != '{') {
10198      RExC_parse += SKIP_IF_CHAR(RExC_parse);
10199      /* diag_listed_as: Sequence (?%s...) not recognized in regex; marked by <-- HERE in m/%s/ */
10200      vFAIL2utf8f(
10201       "Sequence (%"UTF8f"...) not recognized",
10202       UTF8fARG(UTF, RExC_parse-seqstart, seqstart));
10203      NOT_REACHED; /*NOTREACHED*/
10204     }
10205     *flagp |= POSTPONED;
10206     paren = *RExC_parse++;
10207     /* FALLTHROUGH */
10208    case '{':           /* (?{...}) */
10209    {
10210     U32 n = 0;
10211     struct reg_code_block *cb;
10212
10213     RExC_seen_zerolen++;
10214
10215     if (   !pRExC_state->num_code_blocks
10216      || pRExC_state->code_index >= pRExC_state->num_code_blocks
10217      || pRExC_state->code_blocks[pRExC_state->code_index].start
10218       != (STRLEN)((RExC_parse -3 - (is_logical ? 1 : 0))
10219        - RExC_start)
10220     ) {
10221      if (RExC_pm_flags & PMf_USE_RE_EVAL)
10222       FAIL("panic: Sequence (?{...}): no code block found\n");
10223      FAIL("Eval-group not allowed at runtime, use re 'eval'");
10224     }
10225     /* this is a pre-compiled code block (?{...}) */
10226     cb = &pRExC_state->code_blocks[pRExC_state->code_index];
10227     RExC_parse = RExC_start + cb->end;
10228     if (!SIZE_ONLY) {
10229      OP *o = cb->block;
10230      if (cb->src_regex) {
10231       n = add_data(pRExC_state, STR_WITH_LEN("rl"));
10232       RExC_rxi->data->data[n] =
10233        (void*)SvREFCNT_inc((SV*)cb->src_regex);
10234       RExC_rxi->data->data[n+1] = (void*)o;
10235      }
10236      else {
10237       n = add_data(pRExC_state,
10238        (RExC_pm_flags & PMf_HAS_CV) ? "L" : "l", 1);
10239       RExC_rxi->data->data[n] = (void*)o;
10240      }
10241     }
10242     pRExC_state->code_index++;
10243     nextchar(pRExC_state);
10244
10245     if (is_logical) {
10246      regnode *eval;
10247      ret = reg_node(pRExC_state, LOGICAL);
10248
10249      eval = reg2Lanode(pRExC_state, EVAL,
10250          n,
10251
10252          /* for later propagation into (??{})
10253           * return value */
10254          RExC_flags & RXf_PMf_COMPILETIME
10255          );
10256      if (!SIZE_ONLY) {
10257       ret->flags = 2;
10258      }
10259      REGTAIL(pRExC_state, ret, eval);
10260      /* deal with the length of this later - MJD */
10261      return ret;
10262     }
10263     ret = reg2Lanode(pRExC_state, EVAL, n, 0);
10264     Set_Node_Length(ret, RExC_parse - parse_start + 1);
10265     Set_Node_Offset(ret, parse_start);
10266     return ret;
10267    }
10268    case '(':           /* (?(?{...})...) and (?(?=...)...) */
10269    {
10270     int is_define= 0;
10271     const int DEFINE_len = sizeof("DEFINE") - 1;
10272     if (RExC_parse[0] == '?') {        /* (?(?...)) */
10273      if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
10274       || RExC_parse[1] == '<'
10275       || RExC_parse[1] == '{') { /* Lookahead or eval. */
10276       I32 flag;
10277       regnode *tail;
10278
10279       ret = reg_node(pRExC_state, LOGICAL);
10280       if (!SIZE_ONLY)
10281        ret->flags = 1;
10282
10283       tail = reg(pRExC_state, 1, &flag, depth+1);
10284       if (flag & RESTART_UTF8) {
10285        *flagp = RESTART_UTF8;
10286        return NULL;
10287       }
10288       REGTAIL(pRExC_state, ret, tail);
10289       goto insert_if;
10290      }
10291      /* Fall through to ‘Unknown switch condition’ at the
10292      end of the if/else chain. */
10293     }
10294     else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
10295       || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
10296     {
10297      char ch = RExC_parse[0] == '<' ? '>' : '\'';
10298      char *name_start= RExC_parse++;
10299      U32 num = 0;
10300      SV *sv_dat=reg_scan_name(pRExC_state,
10301       SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
10302      if (RExC_parse == name_start || *RExC_parse != ch)
10303       vFAIL2("Sequence (?(%c... not terminated",
10304        (ch == '>' ? '<' : ch));
10305      RExC_parse++;
10306      if (!SIZE_ONLY) {
10307       num = add_data( pRExC_state, STR_WITH_LEN("S"));
10308       RExC_rxi->data->data[num]=(void*)sv_dat;
10309       SvREFCNT_inc_simple_void(sv_dat);
10310      }
10311      ret = reganode(pRExC_state,NGROUPP,num);
10312      goto insert_if_check_paren;
10313     }
10314     else if (RExC_end - RExC_parse >= DEFINE_len
10315       && strnEQ(RExC_parse, "DEFINE", DEFINE_len))
10316     {
10317      ret = reganode(pRExC_state,DEFINEP,0);
10318      RExC_parse += DEFINE_len;
10319      is_define = 1;
10320      goto insert_if_check_paren;
10321     }
10322     else if (RExC_parse[0] == 'R') {
10323      RExC_parse++;
10324      parno = 0;
10325      if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
10326       UV uv;
10327       if (grok_atoUV(RExC_parse, &uv, &endptr)
10328        && uv <= I32_MAX
10329       ) {
10330        parno = (I32)uv;
10331        RExC_parse = (char*)endptr;
10332       }
10333       /* else "Switch condition not recognized" below */
10334      } else if (RExC_parse[0] == '&') {
10335       SV *sv_dat;
10336       RExC_parse++;
10337       sv_dat = reg_scan_name(pRExC_state,
10338        SIZE_ONLY
10339        ? REG_RSN_RETURN_NULL
10340        : REG_RSN_RETURN_DATA);
10341        parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
10342      }
10343      ret = reganode(pRExC_state,INSUBP,parno);
10344      goto insert_if_check_paren;
10345     }
10346     else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
10347      /* (?(1)...) */
10348      char c;
10349      char *tmp;
10350      UV uv;
10351      if (grok_atoUV(RExC_parse, &uv, &endptr)
10352       && uv <= I32_MAX
10353      ) {
10354       parno = (I32)uv;
10355       RExC_parse = (char*)endptr;
10356      }
10357      /* XXX else what? */
10358      ret = reganode(pRExC_state, GROUPP, parno);
10359
10360     insert_if_check_paren:
10361      if (*(tmp = nextchar(pRExC_state)) != ')') {
10362       /* nextchar also skips comments, so undo its work
10363       * and skip over the the next character.
10364       */
10365       RExC_parse = tmp;
10366       RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10367       vFAIL("Switch condition not recognized");
10368      }
10369     insert_if:
10370      REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
10371      br = regbranch(pRExC_state, &flags, 1,depth+1);
10372      if (br == NULL) {
10373       if (flags & RESTART_UTF8) {
10374        *flagp = RESTART_UTF8;
10375        return NULL;
10376       }
10377       FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
10378        (UV) flags);
10379      } else
10380       REGTAIL(pRExC_state, br, reganode(pRExC_state,
10381               LONGJMP, 0));
10382      c = *nextchar(pRExC_state);
10383      if (flags&HASWIDTH)
10384       *flagp |= HASWIDTH;
10385      if (c == '|') {
10386       if (is_define)
10387        vFAIL("(?(DEFINE)....) does not allow branches");
10388
10389       /* Fake one for optimizer.  */
10390       lastbr = reganode(pRExC_state, IFTHEN, 0);
10391
10392       if (!regbranch(pRExC_state, &flags, 1,depth+1)) {
10393        if (flags & RESTART_UTF8) {
10394         *flagp = RESTART_UTF8;
10395         return NULL;
10396        }
10397        FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"",
10398         (UV) flags);
10399       }
10400       REGTAIL(pRExC_state, ret, lastbr);
10401       if (flags&HASWIDTH)
10402        *flagp |= HASWIDTH;
10403       c = *nextchar(pRExC_state);
10404      }
10405      else
10406       lastbr = NULL;
10407      if (c != ')') {
10408       if (RExC_parse>RExC_end)
10409        vFAIL("Switch (?(condition)... not terminated");
10410       else
10411        vFAIL("Switch (?(condition)... contains too many branches");
10412      }
10413      ender = reg_node(pRExC_state, TAIL);
10414      REGTAIL(pRExC_state, br, ender);
10415      if (lastbr) {
10416       REGTAIL(pRExC_state, lastbr, ender);
10417       REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
10418      }
10419      else
10420       REGTAIL(pRExC_state, ret, ender);
10421      RExC_size++; /* XXX WHY do we need this?!!
10422          For large programs it seems to be required
10423          but I can't figure out why. -- dmq*/
10424      return ret;
10425     }
10426     RExC_parse += UTF ? UTF8SKIP(RExC_parse) : 1;
10427     vFAIL("Unknown switch condition (?(...))");
10428    }
10429    case '[':           /* (?[ ... ]) */
10430     return handle_regex_sets(pRExC_state, NULL, flagp, depth,
10431           oregcomp_parse);
10432    case 0:
10433     RExC_parse--; /* for vFAIL to print correctly */
10434     vFAIL("Sequence (? incomplete");
10435     break;
10436    default: /* e.g., (?i) */
10437     --RExC_parse;
10438    parse_flags:
10439     parse_lparen_question_flags(pRExC_state);
10440     if (UCHARAT(RExC_parse) != ':') {
10441      if (*RExC_parse)
10442       nextchar(pRExC_state);
10443      *flagp = TRYAGAIN;
10444      return NULL;
10445     }
10446     paren = ':';
10447     nextchar(pRExC_state);
10448     ret = NULL;
10449     goto parse_rest;
10450    } /* end switch */
10451   }
10452   else if (!(RExC_flags & RXf_PMf_NOCAPTURE)) {   /* (...) */
10453   capturing_parens:
10454    parno = RExC_npar;
10455    RExC_npar++;
10456
10457    ret = reganode(pRExC_state, OPEN, parno);
10458    if (!SIZE_ONLY ){
10459     if (!RExC_nestroot)
10460      RExC_nestroot = parno;
10461     if (RExC_seen & REG_RECURSE_SEEN
10462      && !RExC_open_parens[parno-1])
10463     {
10464      DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10465       "%*s%*s Setting open paren #%"IVdf" to %d\n",
10466       22, "|    |", (int)(depth * 2 + 1), "",
10467       (IV)parno, REG_NODE_NUM(ret)));
10468      RExC_open_parens[parno-1]= ret;
10469     }
10470    }
10471    Set_Node_Length(ret, 1); /* MJD */
10472    Set_Node_Offset(ret, RExC_parse); /* MJD */
10473    is_open = 1;
10474   } else {
10475    /* with RXf_PMf_NOCAPTURE treat (...) as (?:...) */
10476    paren = ':';
10477    ret = NULL;
10478   }
10479  }
10480  else                        /* ! paren */
10481   ret = NULL;
10482
10483    parse_rest:
10484  /* Pick up the branches, linking them together. */
10485  parse_start = RExC_parse;   /* MJD */
10486  br = regbranch(pRExC_state, &flags, 1,depth+1);
10487
10488  /*     branch_len = (paren != 0); */
10489
10490  if (br == NULL) {
10491   if (flags & RESTART_UTF8) {
10492    *flagp = RESTART_UTF8;
10493    return NULL;
10494   }
10495   FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
10496  }
10497  if (*RExC_parse == '|') {
10498   if (!SIZE_ONLY && RExC_extralen) {
10499    reginsert(pRExC_state, BRANCHJ, br, depth+1);
10500   }
10501   else {                  /* MJD */
10502    reginsert(pRExC_state, BRANCH, br, depth+1);
10503    Set_Node_Length(br, paren != 0);
10504    Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
10505   }
10506   have_branch = 1;
10507   if (SIZE_ONLY)
10508    RExC_extralen += 1;  /* For BRANCHJ-BRANCH. */
10509  }
10510  else if (paren == ':') {
10511   *flagp |= flags&SIMPLE;
10512  }
10513  if (is_open) {    /* Starts with OPEN. */
10514   REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
10515  }
10516  else if (paren != '?')  /* Not Conditional */
10517   ret = br;
10518  *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
10519  lastbr = br;
10520  while (*RExC_parse == '|') {
10521   if (!SIZE_ONLY && RExC_extralen) {
10522    ender = reganode(pRExC_state, LONGJMP,0);
10523
10524    /* Append to the previous. */
10525    REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
10526   }
10527   if (SIZE_ONLY)
10528    RExC_extralen += 2;  /* Account for LONGJMP. */
10529   nextchar(pRExC_state);
10530   if (freeze_paren) {
10531    if (RExC_npar > after_freeze)
10532     after_freeze = RExC_npar;
10533    RExC_npar = freeze_paren;
10534   }
10535   br = regbranch(pRExC_state, &flags, 0, depth+1);
10536
10537   if (br == NULL) {
10538    if (flags & RESTART_UTF8) {
10539     *flagp = RESTART_UTF8;
10540     return NULL;
10541    }
10542    FAIL2("panic: regbranch returned NULL, flags=%#"UVxf"", (UV) flags);
10543   }
10544   REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
10545   lastbr = br;
10546   *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
10547  }
10548
10549  if (have_branch || paren != ':') {
10550   /* Make a closing node, and hook it on the end. */
10551   switch (paren) {
10552   case ':':
10553    ender = reg_node(pRExC_state, TAIL);
10554    break;
10555   case 1: case 2:
10556    ender = reganode(pRExC_state, CLOSE, parno);
10557    if (!SIZE_ONLY && RExC_seen & REG_RECURSE_SEEN) {
10558     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
10559       "%*s%*s Setting close paren #%"IVdf" to %d\n",
10560       22, "|    |", (int)(depth * 2 + 1), "", (IV)parno, REG_NODE_NUM(ender)));
10561     RExC_close_parens[parno-1]= ender;
10562     if (RExC_nestroot == parno)
10563      RExC_nestroot = 0;
10564    }
10565    Set_Node_Offset(ender,RExC_parse+1); /* MJD */
10566    Set_Node_Length(ender,1); /* MJD */
10567    break;
10568   case '<':
10569   case ',':
10570   case '=':
10571   case '!':
10572    *flagp &= ~HASWIDTH;
10573    /* FALLTHROUGH */
10574   case '>':
10575    ender = reg_node(pRExC_state, SUCCEED);
10576    break;
10577   case 0:
10578    ender = reg_node(pRExC_state, END);
10579    if (!SIZE_ONLY) {
10580     assert(!RExC_opend); /* there can only be one! */
10581     RExC_opend = ender;
10582    }
10583    break;
10584   }
10585   DEBUG_PARSE_r(if (!SIZE_ONLY) {
10586    DEBUG_PARSE_MSG("lsbr");
10587    regprop(RExC_rx, RExC_mysv1, lastbr, NULL, pRExC_state);
10588    regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
10589    PerlIO_printf(Perl_debug_log, "~ tying lastbr %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
10590       SvPV_nolen_const(RExC_mysv1),
10591       (IV)REG_NODE_NUM(lastbr),
10592       SvPV_nolen_const(RExC_mysv2),
10593       (IV)REG_NODE_NUM(ender),
10594       (IV)(ender - lastbr)
10595    );
10596   });
10597   REGTAIL(pRExC_state, lastbr, ender);
10598
10599   if (have_branch && !SIZE_ONLY) {
10600    char is_nothing= 1;
10601    if (depth==1)
10602     RExC_seen |= REG_TOP_LEVEL_BRANCHES_SEEN;
10603
10604    /* Hook the tails of the branches to the closing node. */
10605    for (br = ret; br; br = regnext(br)) {
10606     const U8 op = PL_regkind[OP(br)];
10607     if (op == BRANCH) {
10608      REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
10609      if ( OP(NEXTOPER(br)) != NOTHING
10610       || regnext(NEXTOPER(br)) != ender)
10611       is_nothing= 0;
10612     }
10613     else if (op == BRANCHJ) {
10614      REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
10615      /* for now we always disable this optimisation * /
10616      if ( OP(NEXTOPER(NEXTOPER(br))) != NOTHING
10617       || regnext(NEXTOPER(NEXTOPER(br))) != ender)
10618      */
10619       is_nothing= 0;
10620     }
10621    }
10622    if (is_nothing) {
10623     br= PL_regkind[OP(ret)] != BRANCH ? regnext(ret) : ret;
10624     DEBUG_PARSE_r(if (!SIZE_ONLY) {
10625      DEBUG_PARSE_MSG("NADA");
10626      regprop(RExC_rx, RExC_mysv1, ret, NULL, pRExC_state);
10627      regprop(RExC_rx, RExC_mysv2, ender, NULL, pRExC_state);
10628      PerlIO_printf(Perl_debug_log, "~ converting ret %s (%"IVdf") to ender %s (%"IVdf") offset %"IVdf"\n",
10629         SvPV_nolen_const(RExC_mysv1),
10630         (IV)REG_NODE_NUM(ret),
10631         SvPV_nolen_const(RExC_mysv2),
10632         (IV)REG_NODE_NUM(ender),
10633         (IV)(ender - ret)
10634      );
10635     });
10636     OP(br)= NOTHING;
10637     if (OP(ender) == TAIL) {
10638      NEXT_OFF(br)= 0;
10639      RExC_emit= br + 1;
10640     } else {
10641      regnode *opt;
10642      for ( opt= br + 1; opt < ender ; opt++ )
10643       OP(opt)= OPTIMIZED;
10644      NEXT_OFF(br)= ender - br;
10645     }
10646    }
10647   }
10648  }
10649
10650  {
10651   const char *p;
10652   static const char parens[] = "=!<,>";
10653
10654   if (paren && (p = strchr(parens, paren))) {
10655    U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
10656    int flag = (p - parens) > 1;
10657
10658    if (paren == '>')
10659     node = SUSPEND, flag = 0;
10660    reginsert(pRExC_state, node,ret, depth+1);
10661    Set_Node_Cur_Length(ret, parse_start);
10662    Set_Node_Offset(ret, parse_start + 1);
10663    ret->flags = flag;
10664    REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
10665   }
10666  }
10667
10668  /* Check for proper termination. */
10669  if (paren) {
10670   /* restore original flags, but keep (?p) */
10671   RExC_flags = oregflags | (RExC_flags & RXf_PMf_KEEPCOPY);
10672   if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
10673    RExC_parse = oregcomp_parse;
10674    vFAIL("Unmatched (");
10675   }
10676  }
10677  else if (!paren && RExC_parse < RExC_end) {
10678   if (*RExC_parse == ')') {
10679    RExC_parse++;
10680    vFAIL("Unmatched )");
10681   }
10682   else
10683    FAIL("Junk on end of regexp"); /* "Can't happen". */
10684   NOT_REACHED; /* NOTREACHED */
10685  }
10686
10687  if (RExC_in_lookbehind) {
10688   RExC_in_lookbehind--;
10689  }
10690  if (after_freeze > RExC_npar)
10691   RExC_npar = after_freeze;
10692  return(ret);
10693 }
10694
10695 /*
10696  - regbranch - one alternative of an | operator
10697  *
10698  * Implements the concatenation operator.
10699  *
10700  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10701  * restarted.
10702  */
10703 STATIC regnode *
10704 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
10705 {
10706  regnode *ret;
10707  regnode *chain = NULL;
10708  regnode *latest;
10709  I32 flags = 0, c = 0;
10710  GET_RE_DEBUG_FLAGS_DECL;
10711
10712  PERL_ARGS_ASSERT_REGBRANCH;
10713
10714  DEBUG_PARSE("brnc");
10715
10716  if (first)
10717   ret = NULL;
10718  else {
10719   if (!SIZE_ONLY && RExC_extralen)
10720    ret = reganode(pRExC_state, BRANCHJ,0);
10721   else {
10722    ret = reg_node(pRExC_state, BRANCH);
10723    Set_Node_Length(ret, 1);
10724   }
10725  }
10726
10727  if (!first && SIZE_ONLY)
10728   RExC_extralen += 1;   /* BRANCHJ */
10729
10730  *flagp = WORST;   /* Tentatively. */
10731
10732  RExC_parse--;
10733  nextchar(pRExC_state);
10734  while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
10735   flags &= ~TRYAGAIN;
10736   latest = regpiece(pRExC_state, &flags,depth+1);
10737   if (latest == NULL) {
10738    if (flags & TRYAGAIN)
10739     continue;
10740    if (flags & RESTART_UTF8) {
10741     *flagp = RESTART_UTF8;
10742     return NULL;
10743    }
10744    FAIL2("panic: regpiece returned NULL, flags=%#"UVxf"", (UV) flags);
10745   }
10746   else if (ret == NULL)
10747    ret = latest;
10748   *flagp |= flags&(HASWIDTH|POSTPONED);
10749   if (chain == NULL)  /* First piece. */
10750    *flagp |= flags&SPSTART;
10751   else {
10752    /* FIXME adding one for every branch after the first is probably
10753    * excessive now we have TRIE support. (hv) */
10754    MARK_NAUGHTY(1);
10755    REGTAIL(pRExC_state, chain, latest);
10756   }
10757   chain = latest;
10758   c++;
10759  }
10760  if (chain == NULL) { /* Loop ran zero times. */
10761   chain = reg_node(pRExC_state, NOTHING);
10762   if (ret == NULL)
10763    ret = chain;
10764  }
10765  if (c == 1) {
10766   *flagp |= flags&SIMPLE;
10767  }
10768
10769  return ret;
10770 }
10771
10772 /*
10773  - regpiece - something followed by possible [*+?]
10774  *
10775  * Note that the branching code sequences used for ? and the general cases
10776  * of * and + are somewhat optimized:  they use the same NOTHING node as
10777  * both the endmarker for their branch list and the body of the last branch.
10778  * It might seem that this node could be dispensed with entirely, but the
10779  * endmarker role is not redundant.
10780  *
10781  * Returns NULL, setting *flagp to TRYAGAIN if regatom() returns NULL with
10782  * TRYAGAIN.
10783  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
10784  * restarted.
10785  */
10786 STATIC regnode *
10787 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
10788 {
10789  regnode *ret;
10790  char op;
10791  char *next;
10792  I32 flags;
10793  const char * const origparse = RExC_parse;
10794  I32 min;
10795  I32 max = REG_INFTY;
10796 #ifdef RE_TRACK_PATTERN_OFFSETS
10797  char *parse_start;
10798 #endif
10799  const char *maxpos = NULL;
10800  UV uv;
10801
10802  /* Save the original in case we change the emitted regop to a FAIL. */
10803  regnode * const orig_emit = RExC_emit;
10804
10805  GET_RE_DEBUG_FLAGS_DECL;
10806
10807  PERL_ARGS_ASSERT_REGPIECE;
10808
10809  DEBUG_PARSE("piec");
10810
10811  ret = regatom(pRExC_state, &flags,depth+1);
10812  if (ret == NULL) {
10813   if (flags & (TRYAGAIN|RESTART_UTF8))
10814    *flagp |= flags & (TRYAGAIN|RESTART_UTF8);
10815   else
10816    FAIL2("panic: regatom returned NULL, flags=%#"UVxf"", (UV) flags);
10817   return(NULL);
10818  }
10819
10820  op = *RExC_parse;
10821
10822  if (op == '{' && regcurly(RExC_parse)) {
10823   maxpos = NULL;
10824 #ifdef RE_TRACK_PATTERN_OFFSETS
10825   parse_start = RExC_parse; /* MJD */
10826 #endif
10827   next = RExC_parse + 1;
10828   while (isDIGIT(*next) || *next == ',') {
10829    if (*next == ',') {
10830     if (maxpos)
10831      break;
10832     else
10833      maxpos = next;
10834    }
10835    next++;
10836   }
10837   if (*next == '}') {  /* got one */
10838    const char* endptr;
10839    if (!maxpos)
10840     maxpos = next;
10841    RExC_parse++;
10842    if (isDIGIT(*RExC_parse)) {
10843     if (!grok_atoUV(RExC_parse, &uv, &endptr))
10844      vFAIL("Invalid quantifier in {,}");
10845     if (uv >= REG_INFTY)
10846      vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
10847     min = (I32)uv;
10848    } else {
10849     min = 0;
10850    }
10851    if (*maxpos == ',')
10852     maxpos++;
10853    else
10854     maxpos = RExC_parse;
10855    if (isDIGIT(*maxpos)) {
10856     if (!grok_atoUV(maxpos, &uv, &endptr))
10857      vFAIL("Invalid quantifier in {,}");
10858     if (uv >= REG_INFTY)
10859      vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
10860     max = (I32)uv;
10861    } else {
10862     max = REG_INFTY;  /* meaning "infinity" */
10863    }
10864    RExC_parse = next;
10865    nextchar(pRExC_state);
10866    if (max < min) {    /* If can't match, warn and optimize to fail
10867         unconditionally */
10868     if (SIZE_ONLY) {
10869
10870      /* We can't back off the size because we have to reserve
10871      * enough space for all the things we are about to throw
10872      * away, but we can shrink it by the ammount we are about
10873      * to re-use here */
10874      RExC_size = PREVOPER(RExC_size) - regarglen[(U8)OPFAIL];
10875     }
10876     else {
10877      ckWARNreg(RExC_parse, "Quantifier {n,m} with n > m can't match");
10878      RExC_emit = orig_emit;
10879     }
10880     ret = reg_node(pRExC_state, OPFAIL);
10881     return ret;
10882    }
10883    else if (min == max
10884      && RExC_parse < RExC_end
10885      && (*RExC_parse == '?' || *RExC_parse == '+'))
10886    {
10887     if (PASS2) {
10888      ckWARN2reg(RExC_parse + 1,
10889        "Useless use of greediness modifier '%c'",
10890        *RExC_parse);
10891     }
10892     /* Absorb the modifier, so later code doesn't see nor use
10893      * it */
10894     nextchar(pRExC_state);
10895    }
10896
10897   do_curly:
10898    if ((flags&SIMPLE)) {
10899     MARK_NAUGHTY_EXP(2, 2);
10900     reginsert(pRExC_state, CURLY, ret, depth+1);
10901     Set_Node_Offset(ret, parse_start+1); /* MJD */
10902     Set_Node_Cur_Length(ret, parse_start);
10903    }
10904    else {
10905     regnode * const w = reg_node(pRExC_state, WHILEM);
10906
10907     w->flags = 0;
10908     REGTAIL(pRExC_state, ret, w);
10909     if (!SIZE_ONLY && RExC_extralen) {
10910      reginsert(pRExC_state, LONGJMP,ret, depth+1);
10911      reginsert(pRExC_state, NOTHING,ret, depth+1);
10912      NEXT_OFF(ret) = 3; /* Go over LONGJMP. */
10913     }
10914     reginsert(pRExC_state, CURLYX,ret, depth+1);
10915         /* MJD hk */
10916     Set_Node_Offset(ret, parse_start+1);
10917     Set_Node_Length(ret,
10918         op == '{' ? (RExC_parse - parse_start) : 1);
10919
10920     if (!SIZE_ONLY && RExC_extralen)
10921      NEXT_OFF(ret) = 3; /* Go over NOTHING to LONGJMP. */
10922     REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
10923     if (SIZE_ONLY)
10924      RExC_whilem_seen++, RExC_extralen += 3;
10925     MARK_NAUGHTY_EXP(1, 4);     /* compound interest */
10926    }
10927    ret->flags = 0;
10928
10929    if (min > 0)
10930     *flagp = WORST;
10931    if (max > 0)
10932     *flagp |= HASWIDTH;
10933    if (!SIZE_ONLY) {
10934     ARG1_SET(ret, (U16)min);
10935     ARG2_SET(ret, (U16)max);
10936    }
10937    if (max == REG_INFTY)
10938     RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10939
10940    goto nest_check;
10941   }
10942  }
10943
10944  if (!ISMULT1(op)) {
10945   *flagp = flags;
10946   return(ret);
10947  }
10948
10949 #if 0    /* Now runtime fix should be reliable. */
10950
10951  /* if this is reinstated, don't forget to put this back into perldiag:
10952
10953    =item Regexp *+ operand could be empty at {#} in regex m/%s/
10954
10955   (F) The part of the regexp subject to either the * or + quantifier
10956   could match an empty string. The {#} shows in the regular
10957   expression about where the problem was discovered.
10958
10959  */
10960
10961  if (!(flags&HASWIDTH) && op != '?')
10962  vFAIL("Regexp *+ operand could be empty");
10963 #endif
10964
10965 #ifdef RE_TRACK_PATTERN_OFFSETS
10966  parse_start = RExC_parse;
10967 #endif
10968  nextchar(pRExC_state);
10969
10970  *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
10971
10972  if (op == '*' && (flags&SIMPLE)) {
10973   reginsert(pRExC_state, STAR, ret, depth+1);
10974   ret->flags = 0;
10975   MARK_NAUGHTY(4);
10976   RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10977  }
10978  else if (op == '*') {
10979   min = 0;
10980   goto do_curly;
10981  }
10982  else if (op == '+' && (flags&SIMPLE)) {
10983   reginsert(pRExC_state, PLUS, ret, depth+1);
10984   ret->flags = 0;
10985   MARK_NAUGHTY(3);
10986   RExC_seen |= REG_UNBOUNDED_QUANTIFIER_SEEN;
10987  }
10988  else if (op == '+') {
10989   min = 1;
10990   goto do_curly;
10991  }
10992  else if (op == '?') {
10993   min = 0; max = 1;
10994   goto do_curly;
10995  }
10996   nest_check:
10997  if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
10998   SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
10999   ckWARN2reg(RExC_parse,
11000     "%"UTF8f" matches null string many times",
11001     UTF8fARG(UTF, (RExC_parse >= origparse
11002         ? RExC_parse - origparse
11003         : 0),
11004     origparse));
11005   (void)ReREFCNT_inc(RExC_rx_sv);
11006  }
11007
11008  if (RExC_parse < RExC_end && *RExC_parse == '?') {
11009   nextchar(pRExC_state);
11010   reginsert(pRExC_state, MINMOD, ret, depth+1);
11011   REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
11012  }
11013  else
11014  if (RExC_parse < RExC_end && *RExC_parse == '+') {
11015   regnode *ender;
11016   nextchar(pRExC_state);
11017   ender = reg_node(pRExC_state, SUCCEED);
11018   REGTAIL(pRExC_state, ret, ender);
11019   reginsert(pRExC_state, SUSPEND, ret, depth+1);
11020   ret->flags = 0;
11021   ender = reg_node(pRExC_state, TAIL);
11022   REGTAIL(pRExC_state, ret, ender);
11023  }
11024
11025  if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
11026   RExC_parse++;
11027   vFAIL("Nested quantifiers");
11028  }
11029
11030  return(ret);
11031 }
11032
11033 STATIC bool
11034 S_grok_bslash_N(pTHX_ RExC_state_t *pRExC_state,
11035     regnode ** node_p,
11036     UV * code_point_p,
11037     int * cp_count,
11038     I32 * flagp,
11039     const U32 depth
11040  )
11041 {
11042  /* This routine teases apart the various meanings of \N and returns
11043   * accordingly.  The input parameters constrain which meaning(s) is/are valid
11044   * in the current context.
11045   *
11046   * Exactly one of <node_p> and <code_point_p> must be non-NULL.
11047   *
11048   * If <code_point_p> is not NULL, the context is expecting the result to be a
11049   * single code point.  If this \N instance turns out to a single code point,
11050   * the function returns TRUE and sets *code_point_p to that code point.
11051   *
11052   * If <node_p> is not NULL, the context is expecting the result to be one of
11053   * the things representable by a regnode.  If this \N instance turns out to be
11054   * one such, the function generates the regnode, returns TRUE and sets *node_p
11055   * to point to that regnode.
11056   *
11057   * If this instance of \N isn't legal in any context, this function will
11058   * generate a fatal error and not return.
11059   *
11060   * On input, RExC_parse should point to the first char following the \N at the
11061   * time of the call.  On successful return, RExC_parse will have been updated
11062   * to point to just after the sequence identified by this routine.  Also
11063   * *flagp has been updated as needed.
11064   *
11065   * When there is some problem with the current context and this \N instance,
11066   * the function returns FALSE, without advancing RExC_parse, nor setting
11067   * *node_p, nor *code_point_p, nor *flagp.
11068   *
11069   * If <cp_count> is not NULL, the caller wants to know the length (in code
11070   * points) that this \N sequence matches.  This is set even if the function
11071   * returns FALSE, as detailed below.
11072   *
11073   * There are 5 possibilities here, as detailed in the next 5 paragraphs.
11074   *
11075   * Probably the most common case is for the \N to specify a single code point.
11076   * *cp_count will be set to 1, and *code_point_p will be set to that code
11077   * point.
11078   *
11079   * Another possibility is for the input to be an empty \N{}, which for
11080   * backwards compatibility we accept.  *cp_count will be set to 0. *node_p
11081   * will be set to a generated NOTHING node.
11082   *
11083   * Still another possibility is for the \N to mean [^\n]. *cp_count will be
11084   * set to 0. *node_p will be set to a generated REG_ANY node.
11085   *
11086   * The fourth possibility is that \N resolves to a sequence of more than one
11087   * code points.  *cp_count will be set to the number of code points in the
11088   * sequence. *node_p * will be set to a generated node returned by this
11089   * function calling S_reg().
11090   *
11091   * The final possibility, which happens only when the fourth one would
11092   * otherwise be in effect, is that one of those code points requires the
11093   * pattern to be recompiled as UTF-8.  The function returns FALSE, and sets
11094   * the RESTART_UTF8 flag in *flagp.  When this happens, the caller needs to
11095   * desist from continuing parsing, and return this information to its caller.
11096   * This is not set for when there is only one code point, as this can be
11097   * called as part of an ANYOF node, and they can store above-Latin1 code
11098   * points without the pattern having to be in UTF-8.
11099   *
11100   * For non-single-quoted regexes, the tokenizer has resolved character and
11101   * sequence names inside \N{...} into their Unicode values, normalizing the
11102   * result into what we should see here: '\N{U+c1.c2...}', where c1... are the
11103   * hex-represented code points in the sequence.  This is done there because
11104   * the names can vary based on what charnames pragma is in scope at the time,
11105   * so we need a way to take a snapshot of what they resolve to at the time of
11106   * the original parse. [perl #56444].
11107   *
11108   * That parsing is skipped for single-quoted regexes, so we may here get
11109   * '\N{NAME}'.  This is a fatal error.  These names have to be resolved by the
11110   * parser.  But if the single-quoted regex is something like '\N{U+41}', that
11111   * is legal and handled here.  The code point is Unicode, and has to be
11112   * translated into the native character set for non-ASCII platforms.
11113   * the tokenizer passes the \N sequence through unchanged; this code will not
11114   * attempt to determine this nor expand those, instead raising a syntax error.
11115   */
11116
11117  char * endbrace;    /* points to '}' following the name */
11118  char *endchar; /* Points to '.' or '}' ending cur char in the input
11119       stream */
11120  char* p;            /* Temporary */
11121
11122  GET_RE_DEBUG_FLAGS_DECL;
11123
11124  PERL_ARGS_ASSERT_GROK_BSLASH_N;
11125
11126  GET_RE_DEBUG_FLAGS;
11127
11128  assert(cBOOL(node_p) ^ cBOOL(code_point_p));  /* Exactly one should be set */
11129  assert(! (node_p && cp_count));               /* At most 1 should be set */
11130
11131  if (cp_count) {     /* Initialize return for the most common case */
11132   *cp_count = 1;
11133  }
11134
11135  /* The [^\n] meaning of \N ignores spaces and comments under the /x
11136  * modifier.  The other meanings do not, so use a temporary until we find
11137  * out which we are being called with */
11138  p = (RExC_flags & RXf_PMf_EXTENDED)
11139   ? regpatws(pRExC_state, RExC_parse,
11140         TRUE) /* means recognize comments */
11141   : RExC_parse;
11142
11143  /* Disambiguate between \N meaning a named character versus \N meaning
11144  * [^\n].  The latter is assumed when the {...} following the \N is a legal
11145  * quantifier, or there is no a '{' at all */
11146  if (*p != '{' || regcurly(p)) {
11147   RExC_parse = p;
11148   if (cp_count) {
11149    *cp_count = -1;
11150   }
11151
11152   if (! node_p) {
11153    return FALSE;
11154   }
11155   RExC_parse--;   /* Need to back off so nextchar() doesn't skip the
11156       current char */
11157   nextchar(pRExC_state);
11158   *node_p = reg_node(pRExC_state, REG_ANY);
11159   *flagp |= HASWIDTH|SIMPLE;
11160   MARK_NAUGHTY(1);
11161   Set_Node_Length(*node_p, 1); /* MJD */
11162   return TRUE;
11163  }
11164
11165  /* Here, we have decided it should be a named character or sequence */
11166
11167  /* The test above made sure that the next real character is a '{', but
11168  * under the /x modifier, it could be separated by space (or a comment and
11169  * \n) and this is not allowed (for consistency with \x{...} and the
11170  * tokenizer handling of \N{NAME}). */
11171  if (*RExC_parse != '{') {
11172   vFAIL("Missing braces on \\N{}");
11173  }
11174
11175  RExC_parse++; /* Skip past the '{' */
11176
11177  if (! (endbrace = strchr(RExC_parse, '}'))  /* no trailing brace */
11178   || ! (endbrace == RExC_parse  /* nothing between the {} */
11179    || (endbrace - RExC_parse >= 2 /* U+ (bad hex is checked... */
11180     && strnEQ(RExC_parse, "U+", 2)))) /* ... below for a better
11181              error msg) */
11182  {
11183   if (endbrace) RExC_parse = endbrace; /* position msg's '<--HERE' */
11184   vFAIL("\\N{NAME} must be resolved by the lexer");
11185  }
11186
11187  RExC_uni_semantics = 1; /* Unicode named chars imply Unicode semantics */
11188
11189  if (endbrace == RExC_parse) {   /* empty: \N{} */
11190   if (cp_count) {
11191    *cp_count = 0;
11192   }
11193   nextchar(pRExC_state);
11194   if (! node_p) {
11195    return FALSE;
11196   }
11197
11198   *node_p = reg_node(pRExC_state,NOTHING);
11199   return TRUE;
11200  }
11201
11202  RExC_parse += 2; /* Skip past the 'U+' */
11203
11204  endchar = RExC_parse + strcspn(RExC_parse, ".}");
11205
11206  /* Code points are separated by dots.  If none, there is only one code
11207  * point, and is terminated by the brace */
11208
11209  if (endchar >= endbrace) {
11210   STRLEN length_of_hex;
11211   I32 grok_hex_flags;
11212
11213   /* Here, exactly one code point.  If that isn't what is wanted, fail */
11214   if (! code_point_p) {
11215    RExC_parse = p;
11216    return FALSE;
11217   }
11218
11219   /* Convert code point from hex */
11220   length_of_hex = (STRLEN)(endchar - RExC_parse);
11221   grok_hex_flags = PERL_SCAN_ALLOW_UNDERSCORES
11222       | PERL_SCAN_DISALLOW_PREFIX
11223
11224        /* No errors in the first pass (See [perl
11225        * #122671].)  We let the code below find the
11226        * errors when there are multiple chars. */
11227       | ((SIZE_ONLY)
11228        ? PERL_SCAN_SILENT_ILLDIGIT
11229        : 0);
11230
11231   /* This routine is the one place where both single- and double-quotish
11232   * \N{U+xxxx} are evaluated.  The value is a Unicode code point which
11233   * must be converted to native. */
11234   *code_point_p = UNI_TO_NATIVE(grok_hex(RExC_parse,
11235           &length_of_hex,
11236           &grok_hex_flags,
11237           NULL));
11238
11239   /* The tokenizer should have guaranteed validity, but it's possible to
11240   * bypass it by using single quoting, so check.  Don't do the check
11241   * here when there are multiple chars; we do it below anyway. */
11242   if (length_of_hex == 0
11243    || length_of_hex != (STRLEN)(endchar - RExC_parse) )
11244   {
11245    RExC_parse += length_of_hex; /* Includes all the valid */
11246    RExC_parse += (RExC_orig_utf8) /* point to after 1st invalid */
11247        ? UTF8SKIP(RExC_parse)
11248        : 1;
11249    /* Guard against malformed utf8 */
11250    if (RExC_parse >= endchar) {
11251     RExC_parse = endchar;
11252    }
11253    vFAIL("Invalid hexadecimal number in \\N{U+...}");
11254   }
11255
11256   RExC_parse = endbrace + 1;
11257   return TRUE;
11258  }
11259  else {  /* Is a multiple character sequence */
11260   SV * substitute_parse;
11261   STRLEN len;
11262   char *orig_end = RExC_end;
11263   I32 flags;
11264
11265   /* Count the code points, if desired, in the sequence */
11266   if (cp_count) {
11267    *cp_count = 0;
11268    while (RExC_parse < endbrace) {
11269     /* Point to the beginning of the next character in the sequence. */
11270     RExC_parse = endchar + 1;
11271     endchar = RExC_parse + strcspn(RExC_parse, ".}");
11272     (*cp_count)++;
11273    }
11274   }
11275
11276   /* Fail if caller doesn't want to handle a multi-code-point sequence.
11277   * But don't backup up the pointer if the caller want to know how many
11278   * code points there are (they can then handle things) */
11279   if (! node_p) {
11280    if (! cp_count) {
11281     RExC_parse = p;
11282    }
11283    return FALSE;
11284   }
11285
11286   /* What is done here is to convert this to a sub-pattern of the form
11287   * \x{char1}\x{char2}...  and then call reg recursively to parse it
11288   * (enclosing in "(?: ... )" ).  That way, it retains its atomicness,
11289   * while not having to worry about special handling that some code
11290   * points may have. */
11291
11292   substitute_parse = newSVpvs("?:");
11293
11294   while (RExC_parse < endbrace) {
11295
11296    /* Convert to notation the rest of the code understands */
11297    sv_catpv(substitute_parse, "\\x{");
11298    sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
11299    sv_catpv(substitute_parse, "}");
11300
11301    /* Point to the beginning of the next character in the sequence. */
11302    RExC_parse = endchar + 1;
11303    endchar = RExC_parse + strcspn(RExC_parse, ".}");
11304
11305   }
11306   sv_catpv(substitute_parse, ")");
11307
11308   RExC_parse = SvPV(substitute_parse, len);
11309
11310   /* Don't allow empty number */
11311   if (len < (STRLEN) 8) {
11312    RExC_parse = endbrace;
11313    vFAIL("Invalid hexadecimal number in \\N{U+...}");
11314   }
11315   RExC_end = RExC_parse + len;
11316
11317   /* The values are Unicode, and therefore not subject to recoding, but
11318   * have to be converted to native on a non-Unicode (meaning non-ASCII)
11319   * platform. */
11320   RExC_override_recoding = 1;
11321 #ifdef EBCDIC
11322   RExC_recode_x_to_native = 1;
11323 #endif
11324
11325   if (node_p) {
11326    if (!(*node_p = reg(pRExC_state, 1, &flags, depth+1))) {
11327     if (flags & RESTART_UTF8) {
11328      *flagp = RESTART_UTF8;
11329      return FALSE;
11330     }
11331     FAIL2("panic: reg returned NULL to grok_bslash_N, flags=%#"UVxf"",
11332      (UV) flags);
11333    }
11334    *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
11335   }
11336
11337   /* Restore the saved values */
11338   RExC_parse = endbrace;
11339   RExC_end = orig_end;
11340   RExC_override_recoding = 0;
11341 #ifdef EBCDIC
11342   RExC_recode_x_to_native = 0;
11343 #endif
11344
11345   SvREFCNT_dec_NN(substitute_parse);
11346   nextchar(pRExC_state);
11347
11348   return TRUE;
11349  }
11350 }
11351
11352
11353 /*
11354  * reg_recode
11355  *
11356  * It returns the code point in utf8 for the value in *encp.
11357  *    value: a code value in the source encoding
11358  *    encp:  a pointer to an Encode object
11359  *
11360  * If the result from Encode is not a single character,
11361  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
11362  */
11363 STATIC UV
11364 S_reg_recode(pTHX_ const char value, SV **encp)
11365 {
11366  STRLEN numlen = 1;
11367  SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
11368  const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
11369  const STRLEN newlen = SvCUR(sv);
11370  UV uv = UNICODE_REPLACEMENT;
11371
11372  PERL_ARGS_ASSERT_REG_RECODE;
11373
11374  if (newlen)
11375   uv = SvUTF8(sv)
11376    ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
11377    : *(U8*)s;
11378
11379  if (!newlen || numlen != newlen) {
11380   uv = UNICODE_REPLACEMENT;
11381   *encp = NULL;
11382  }
11383  return uv;
11384 }
11385
11386 PERL_STATIC_INLINE U8
11387 S_compute_EXACTish(RExC_state_t *pRExC_state)
11388 {
11389  U8 op;
11390
11391  PERL_ARGS_ASSERT_COMPUTE_EXACTISH;
11392
11393  if (! FOLD) {
11394   return (LOC)
11395     ? EXACTL
11396     : EXACT;
11397  }
11398
11399  op = get_regex_charset(RExC_flags);
11400  if (op >= REGEX_ASCII_RESTRICTED_CHARSET) {
11401   op--; /* /a is same as /u, and map /aa's offset to what /a's would have
11402     been, so there is no hole */
11403  }
11404
11405  return op + EXACTF;
11406 }
11407
11408 PERL_STATIC_INLINE void
11409 S_alloc_maybe_populate_EXACT(pTHX_ RExC_state_t *pRExC_state,
11410       regnode *node, I32* flagp, STRLEN len, UV code_point,
11411       bool downgradable)
11412 {
11413  /* This knows the details about sizing an EXACTish node, setting flags for
11414  * it (by setting <*flagp>, and potentially populating it with a single
11415  * character.
11416  *
11417  * If <len> (the length in bytes) is non-zero, this function assumes that
11418  * the node has already been populated, and just does the sizing.  In this
11419  * case <code_point> should be the final code point that has already been
11420  * placed into the node.  This value will be ignored except that under some
11421  * circumstances <*flagp> is set based on it.
11422  *
11423  * If <len> is zero, the function assumes that the node is to contain only
11424  * the single character given by <code_point> and calculates what <len>
11425  * should be.  In pass 1, it sizes the node appropriately.  In pass 2, it
11426  * additionally will populate the node's STRING with <code_point> or its
11427  * fold if folding.
11428  *
11429  * In both cases <*flagp> is appropriately set
11430  *
11431  * It knows that under FOLD, the Latin Sharp S and UTF characters above
11432  * 255, must be folded (the former only when the rules indicate it can
11433  * match 'ss')
11434  *
11435  * When it does the populating, it looks at the flag 'downgradable'.  If
11436  * true with a node that folds, it checks if the single code point
11437  * participates in a fold, and if not downgrades the node to an EXACT.
11438  * This helps the optimizer */
11439
11440  bool len_passed_in = cBOOL(len != 0);
11441  U8 character[UTF8_MAXBYTES_CASE+1];
11442
11443  PERL_ARGS_ASSERT_ALLOC_MAYBE_POPULATE_EXACT;
11444
11445  /* Don't bother to check for downgrading in PASS1, as it doesn't make any
11446  * sizing difference, and is extra work that is thrown away */
11447  if (downgradable && ! PASS2) {
11448   downgradable = FALSE;
11449  }
11450
11451  if (! len_passed_in) {
11452   if (UTF) {
11453    if (UVCHR_IS_INVARIANT(code_point)) {
11454     if (LOC || ! FOLD) {    /* /l defers folding until runtime */
11455      *character = (U8) code_point;
11456     }
11457     else { /* Here is /i and not /l. (toFOLD() is defined on just
11458       ASCII, which isn't the same thing as INVARIANT on
11459       EBCDIC, but it works there, as the extra invariants
11460       fold to themselves) */
11461      *character = toFOLD((U8) code_point);
11462
11463      /* We can downgrade to an EXACT node if this character
11464      * isn't a folding one.  Note that this assumes that
11465      * nothing above Latin1 folds to some other invariant than
11466      * one of these alphabetics; otherwise we would also have
11467      * to check:
11468      *  && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
11469      *      || ASCII_FOLD_RESTRICTED))
11470      */
11471      if (downgradable && PL_fold[code_point] == code_point) {
11472       OP(node) = EXACT;
11473      }
11474     }
11475     len = 1;
11476    }
11477    else if (FOLD && (! LOC
11478        || ! is_PROBLEMATIC_LOCALE_FOLD_cp(code_point)))
11479    {   /* Folding, and ok to do so now */
11480     UV folded = _to_uni_fold_flags(
11481         code_point,
11482         character,
11483         &len,
11484         FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
11485              ? FOLD_FLAGS_NOMIX_ASCII
11486              : 0));
11487     if (downgradable
11488      && folded == code_point /* This quickly rules out many
11489            cases, avoiding the
11490            _invlist_contains_cp() overhead
11491            for those.  */
11492      && ! _invlist_contains_cp(PL_utf8_foldable, code_point))
11493     {
11494      OP(node) = (LOC)
11495        ? EXACTL
11496        : EXACT;
11497     }
11498    }
11499    else if (code_point <= MAX_UTF8_TWO_BYTE) {
11500
11501     /* Not folding this cp, and can output it directly */
11502     *character = UTF8_TWO_BYTE_HI(code_point);
11503     *(character + 1) = UTF8_TWO_BYTE_LO(code_point);
11504     len = 2;
11505    }
11506    else {
11507     uvchr_to_utf8( character, code_point);
11508     len = UTF8SKIP(character);
11509    }
11510   } /* Else pattern isn't UTF8.  */
11511   else if (! FOLD) {
11512    *character = (U8) code_point;
11513    len = 1;
11514   } /* Else is folded non-UTF8 */
11515   else if (LIKELY(code_point != LATIN_SMALL_LETTER_SHARP_S)) {
11516
11517    /* We don't fold any non-UTF8 except possibly the Sharp s  (see
11518    * comments at join_exact()); */
11519    *character = (U8) code_point;
11520    len = 1;
11521
11522    /* Can turn into an EXACT node if we know the fold at compile time,
11523    * and it folds to itself and doesn't particpate in other folds */
11524    if (downgradable
11525     && ! LOC
11526     && PL_fold_latin1[code_point] == code_point
11527     && (! HAS_NONLATIN1_FOLD_CLOSURE(code_point)
11528      || (isASCII(code_point) && ASCII_FOLD_RESTRICTED)))
11529    {
11530     OP(node) = EXACT;
11531    }
11532   } /* else is Sharp s.  May need to fold it */
11533   else if (AT_LEAST_UNI_SEMANTICS && ! ASCII_FOLD_RESTRICTED) {
11534    *character = 's';
11535    *(character + 1) = 's';
11536    len = 2;
11537   }
11538   else {
11539    *character = LATIN_SMALL_LETTER_SHARP_S;
11540    len = 1;
11541   }
11542  }
11543
11544  if (SIZE_ONLY) {
11545   RExC_size += STR_SZ(len);
11546  }
11547  else {
11548   RExC_emit += STR_SZ(len);
11549   STR_LEN(node) = len;
11550   if (! len_passed_in) {
11551    Copy((char *) character, STRING(node), len, char);
11552   }
11553  }
11554
11555  *flagp |= HASWIDTH;
11556
11557  /* A single character node is SIMPLE, except for the special-cased SHARP S
11558  * under /di. */
11559  if ((len == 1 || (UTF && len == UNISKIP(code_point)))
11560   && (code_point != LATIN_SMALL_LETTER_SHARP_S
11561    || ! FOLD || ! DEPENDS_SEMANTICS))
11562  {
11563   *flagp |= SIMPLE;
11564  }
11565
11566  /* The OP may not be well defined in PASS1 */
11567  if (PASS2 && OP(node) == EXACTFL) {
11568   RExC_contains_locale = 1;
11569  }
11570 }
11571
11572
11573 /* Parse backref decimal value, unless it's too big to sensibly be a backref,
11574  * in which case return I32_MAX (rather than possibly 32-bit wrapping) */
11575
11576 static I32
11577 S_backref_value(char *p)
11578 {
11579  const char* endptr;
11580  UV val;
11581  if (grok_atoUV(p, &val, &endptr) && val <= I32_MAX)
11582   return (I32)val;
11583  return I32_MAX;
11584 }
11585
11586
11587 /*
11588  - regatom - the lowest level
11589
11590    Try to identify anything special at the start of the pattern. If there
11591    is, then handle it as required. This may involve generating a single regop,
11592    such as for an assertion; or it may involve recursing, such as to
11593    handle a () structure.
11594
11595    If the string doesn't start with something special then we gobble up
11596    as much literal text as we can.
11597
11598    Once we have been able to handle whatever type of thing started the
11599    sequence, we return.
11600
11601    Note: we have to be careful with escapes, as they can be both literal
11602    and special, and in the case of \10 and friends, context determines which.
11603
11604    A summary of the code structure is:
11605
11606    switch (first_byte) {
11607   cases for each special:
11608    handle this special;
11609    break;
11610   case '\\':
11611    switch (2nd byte) {
11612     cases for each unambiguous special:
11613      handle this special;
11614      break;
11615     cases for each ambigous special/literal:
11616      disambiguate;
11617      if (special)  handle here
11618      else goto defchar;
11619     default: // unambiguously literal:
11620      goto defchar;
11621    }
11622   default:  // is a literal char
11623    // FALL THROUGH
11624   defchar:
11625    create EXACTish node for literal;
11626    while (more input and node isn't full) {
11627     switch (input_byte) {
11628     cases for each special;
11629      make sure parse pointer is set so that the next call to
11630       regatom will see this special first
11631      goto loopdone; // EXACTish node terminated by prev. char
11632     default:
11633      append char to EXACTISH node;
11634     }
11635     get next input byte;
11636    }
11637   loopdone:
11638    }
11639    return the generated node;
11640
11641    Specifically there are two separate switches for handling
11642    escape sequences, with the one for handling literal escapes requiring
11643    a dummy entry for all of the special escapes that are actually handled
11644    by the other.
11645
11646    Returns NULL, setting *flagp to TRYAGAIN if reg() returns NULL with
11647    TRYAGAIN.
11648    Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs to be
11649    restarted.
11650    Otherwise does not return NULL.
11651 */
11652
11653 STATIC regnode *
11654 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
11655 {
11656  regnode *ret = NULL;
11657  I32 flags = 0;
11658  char *parse_start = RExC_parse;
11659  U8 op;
11660  int invert = 0;
11661  U8 arg;
11662
11663  GET_RE_DEBUG_FLAGS_DECL;
11664
11665  *flagp = WORST;  /* Tentatively. */
11666
11667  DEBUG_PARSE("atom");
11668
11669  PERL_ARGS_ASSERT_REGATOM;
11670
11671   tryagain:
11672  switch ((U8)*RExC_parse) {
11673  case '^':
11674   RExC_seen_zerolen++;
11675   nextchar(pRExC_state);
11676   if (RExC_flags & RXf_PMf_MULTILINE)
11677    ret = reg_node(pRExC_state, MBOL);
11678   else
11679    ret = reg_node(pRExC_state, SBOL);
11680   Set_Node_Length(ret, 1); /* MJD */
11681   break;
11682  case '$':
11683   nextchar(pRExC_state);
11684   if (*RExC_parse)
11685    RExC_seen_zerolen++;
11686   if (RExC_flags & RXf_PMf_MULTILINE)
11687    ret = reg_node(pRExC_state, MEOL);
11688   else
11689    ret = reg_node(pRExC_state, SEOL);
11690   Set_Node_Length(ret, 1); /* MJD */
11691   break;
11692  case '.':
11693   nextchar(pRExC_state);
11694   if (RExC_flags & RXf_PMf_SINGLELINE)
11695    ret = reg_node(pRExC_state, SANY);
11696   else
11697    ret = reg_node(pRExC_state, REG_ANY);
11698   *flagp |= HASWIDTH|SIMPLE;
11699   MARK_NAUGHTY(1);
11700   Set_Node_Length(ret, 1); /* MJD */
11701   break;
11702  case '[':
11703  {
11704   char * const oregcomp_parse = ++RExC_parse;
11705   ret = regclass(pRExC_state, flagp,depth+1,
11706      FALSE, /* means parse the whole char class */
11707      TRUE, /* allow multi-char folds */
11708      FALSE, /* don't silence non-portable warnings. */
11709      (bool) RExC_strict,
11710      NULL);
11711   if (*RExC_parse != ']') {
11712    RExC_parse = oregcomp_parse;
11713    vFAIL("Unmatched [");
11714   }
11715   if (ret == NULL) {
11716    if (*flagp & RESTART_UTF8)
11717     return NULL;
11718    FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
11719     (UV) *flagp);
11720   }
11721   nextchar(pRExC_state);
11722   Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
11723   break;
11724  }
11725  case '(':
11726   nextchar(pRExC_state);
11727   ret = reg(pRExC_state, 2, &flags,depth+1);
11728   if (ret == NULL) {
11729     if (flags & TRYAGAIN) {
11730      if (RExC_parse == RExC_end) {
11731       /* Make parent create an empty node if needed. */
11732       *flagp |= TRYAGAIN;
11733       return(NULL);
11734      }
11735      goto tryagain;
11736     }
11737     if (flags & RESTART_UTF8) {
11738      *flagp = RESTART_UTF8;
11739      return NULL;
11740     }
11741     FAIL2("panic: reg returned NULL to regatom, flags=%#"UVxf"",
11742                 (UV) flags);
11743   }
11744   *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
11745   break;
11746  case '|':
11747  case ')':
11748   if (flags & TRYAGAIN) {
11749    *flagp |= TRYAGAIN;
11750    return NULL;
11751   }
11752   vFAIL("Internal urp");
11753         /* Supposed to be caught earlier. */
11754   break;
11755  case '?':
11756  case '+':
11757  case '*':
11758   RExC_parse++;
11759   vFAIL("Quantifier follows nothing");
11760   break;
11761  case '\\':
11762   /* Special Escapes
11763
11764   This switch handles escape sequences that resolve to some kind
11765   of special regop and not to literal text. Escape sequnces that
11766   resolve to literal text are handled below in the switch marked
11767   "Literal Escapes".
11768
11769   Every entry in this switch *must* have a corresponding entry
11770   in the literal escape switch. However, the opposite is not
11771   required, as the default for this switch is to jump to the
11772   literal text handling code.
11773   */
11774   switch ((U8)*++RExC_parse) {
11775   /* Special Escapes */
11776   case 'A':
11777    RExC_seen_zerolen++;
11778    ret = reg_node(pRExC_state, SBOL);
11779    /* SBOL is shared with /^/ so we set the flags so we can tell
11780    * /\A/ from /^/ in split. We check ret because first pass we
11781    * have no regop struct to set the flags on. */
11782    if (PASS2)
11783     ret->flags = 1;
11784    *flagp |= SIMPLE;
11785    goto finish_meta_pat;
11786   case 'G':
11787    ret = reg_node(pRExC_state, GPOS);
11788    RExC_seen |= REG_GPOS_SEEN;
11789    *flagp |= SIMPLE;
11790    goto finish_meta_pat;
11791   case 'K':
11792    RExC_seen_zerolen++;
11793    ret = reg_node(pRExC_state, KEEPS);
11794    *flagp |= SIMPLE;
11795    /* XXX:dmq : disabling in-place substitution seems to
11796    * be necessary here to avoid cases of memory corruption, as
11797    * with: C<$_="x" x 80; s/x\K/y/> -- rgs
11798    */
11799    RExC_seen |= REG_LOOKBEHIND_SEEN;
11800    goto finish_meta_pat;
11801   case 'Z':
11802    ret = reg_node(pRExC_state, SEOL);
11803    *flagp |= SIMPLE;
11804    RExC_seen_zerolen++;  /* Do not optimize RE away */
11805    goto finish_meta_pat;
11806   case 'z':
11807    ret = reg_node(pRExC_state, EOS);
11808    *flagp |= SIMPLE;
11809    RExC_seen_zerolen++;  /* Do not optimize RE away */
11810    goto finish_meta_pat;
11811   case 'C':
11812    ret = reg_node(pRExC_state, CANY);
11813    RExC_seen |= REG_CANY_SEEN;
11814    *flagp |= HASWIDTH|SIMPLE;
11815    if (PASS2) {
11816     ckWARNdep(RExC_parse+1, "\\C is deprecated");
11817    }
11818    goto finish_meta_pat;
11819   case 'X':
11820    ret = reg_node(pRExC_state, CLUMP);
11821    *flagp |= HASWIDTH;
11822    goto finish_meta_pat;
11823
11824   case 'W':
11825    invert = 1;
11826    /* FALLTHROUGH */
11827   case 'w':
11828    arg = ANYOF_WORDCHAR;
11829    goto join_posix;
11830
11831   case 'B':
11832    invert = 1;
11833    /* FALLTHROUGH */
11834   case 'b':
11835   {
11836    regex_charset charset = get_regex_charset(RExC_flags);
11837
11838    RExC_seen_zerolen++;
11839    RExC_seen |= REG_LOOKBEHIND_SEEN;
11840    op = BOUND + charset;
11841
11842    if (op == BOUNDL) {
11843     RExC_contains_locale = 1;
11844    }
11845
11846    ret = reg_node(pRExC_state, op);
11847    *flagp |= SIMPLE;
11848    if (*(RExC_parse + 1) != '{') {
11849     FLAGS(ret) = TRADITIONAL_BOUND;
11850     if (PASS2 && op > BOUNDA) {  /* /aa is same as /a */
11851      OP(ret) = BOUNDA;
11852     }
11853    }
11854    else {
11855     STRLEN length;
11856     char name = *RExC_parse;
11857     char * endbrace;
11858     RExC_parse += 2;
11859     endbrace = strchr(RExC_parse, '}');
11860
11861     if (! endbrace) {
11862      vFAIL2("Missing right brace on \\%c{}", name);
11863     }
11864     /* XXX Need to decide whether to take spaces or not.  Should be
11865     * consistent with \p{}, but that currently is SPACE, which
11866     * means vertical too, which seems wrong
11867     * while (isBLANK(*RExC_parse)) {
11868      RExC_parse++;
11869     }*/
11870     if (endbrace == RExC_parse) {
11871      RExC_parse++;  /* After the '}' */
11872      vFAIL2("Empty \\%c{}", name);
11873     }
11874     length = endbrace - RExC_parse;
11875     /*while (isBLANK(*(RExC_parse + length - 1))) {
11876      length--;
11877     }*/
11878     switch (*RExC_parse) {
11879      case 'g':
11880       if (length != 1
11881        && (length != 3 || strnNE(RExC_parse + 1, "cb", 2)))
11882       {
11883        goto bad_bound_type;
11884       }
11885       FLAGS(ret) = GCB_BOUND;
11886       break;
11887      case 's':
11888       if (length != 2 || *(RExC_parse + 1) != 'b') {
11889        goto bad_bound_type;
11890       }
11891       FLAGS(ret) = SB_BOUND;
11892       break;
11893      case 'w':
11894       if (length != 2 || *(RExC_parse + 1) != 'b') {
11895        goto bad_bound_type;
11896       }
11897       FLAGS(ret) = WB_BOUND;
11898       break;
11899      default:
11900      bad_bound_type:
11901       RExC_parse = endbrace;
11902       vFAIL2utf8f(
11903        "'%"UTF8f"' is an unknown bound type",
11904        UTF8fARG(UTF, length, endbrace - length));
11905       NOT_REACHED; /*NOTREACHED*/
11906     }
11907     RExC_parse = endbrace;
11908     RExC_uni_semantics = 1;
11909
11910     if (PASS2 && op >= BOUNDA) {  /* /aa is same as /a */
11911      OP(ret) = BOUNDU;
11912      length += 4;
11913
11914      /* Don't have to worry about UTF-8, in this message because
11915      * to get here the contents of the \b must be ASCII */
11916      ckWARN4reg(RExC_parse + 1,  /* Include the '}' in msg */
11917        "Using /u for '%.*s' instead of /%s",
11918        (unsigned) length,
11919        endbrace - length + 1,
11920        (charset == REGEX_ASCII_RESTRICTED_CHARSET)
11921        ? ASCII_RESTRICT_PAT_MODS
11922        : ASCII_MORE_RESTRICT_PAT_MODS);
11923     }
11924    }
11925
11926    if (PASS2 && invert) {
11927     OP(ret) += NBOUND - BOUND;
11928    }
11929    goto finish_meta_pat;
11930   }
11931
11932   case 'D':
11933    invert = 1;
11934    /* FALLTHROUGH */
11935   case 'd':
11936    arg = ANYOF_DIGIT;
11937    if (! DEPENDS_SEMANTICS) {
11938     goto join_posix;
11939    }
11940
11941    /* \d doesn't have any matches in the upper Latin1 range, hence /d
11942    * is equivalent to /u.  Changing to /u saves some branches at
11943    * runtime */
11944    op = POSIXU;
11945    goto join_posix_op_known;
11946
11947   case 'R':
11948    ret = reg_node(pRExC_state, LNBREAK);
11949    *flagp |= HASWIDTH|SIMPLE;
11950    goto finish_meta_pat;
11951
11952   case 'H':
11953    invert = 1;
11954    /* FALLTHROUGH */
11955   case 'h':
11956    arg = ANYOF_BLANK;
11957    op = POSIXU;
11958    goto join_posix_op_known;
11959
11960   case 'V':
11961    invert = 1;
11962    /* FALLTHROUGH */
11963   case 'v':
11964    arg = ANYOF_VERTWS;
11965    op = POSIXU;
11966    goto join_posix_op_known;
11967
11968   case 'S':
11969    invert = 1;
11970    /* FALLTHROUGH */
11971   case 's':
11972    arg = ANYOF_SPACE;
11973
11974   join_posix:
11975
11976    op = POSIXD + get_regex_charset(RExC_flags);
11977    if (op > POSIXA) {  /* /aa is same as /a */
11978     op = POSIXA;
11979    }
11980    else if (op == POSIXL) {
11981     RExC_contains_locale = 1;
11982    }
11983
11984   join_posix_op_known:
11985
11986    if (invert) {
11987     op += NPOSIXD - POSIXD;
11988    }
11989
11990    ret = reg_node(pRExC_state, op);
11991    if (! SIZE_ONLY) {
11992     FLAGS(ret) = namedclass_to_classnum(arg);
11993    }
11994
11995    *flagp |= HASWIDTH|SIMPLE;
11996    /* FALLTHROUGH */
11997
11998   finish_meta_pat:
11999    nextchar(pRExC_state);
12000    Set_Node_Length(ret, 2); /* MJD */
12001    break;
12002   case 'p':
12003   case 'P':
12004    {
12005 #ifdef DEBUGGING
12006     char* parse_start = RExC_parse - 2;
12007 #endif
12008
12009     RExC_parse--;
12010
12011     ret = regclass(pRExC_state, flagp,depth+1,
12012        TRUE, /* means just parse this element */
12013        FALSE, /* don't allow multi-char folds */
12014        FALSE, /* don't silence non-portable warnings.
12015           It would be a bug if these returned
12016           non-portables */
12017        (bool) RExC_strict,
12018        NULL);
12019     /* regclass() can only return RESTART_UTF8 if multi-char folds
12020     are allowed.  */
12021     if (!ret)
12022      FAIL2("panic: regclass returned NULL to regatom, flags=%#"UVxf"",
12023       (UV) *flagp);
12024
12025     RExC_parse--;
12026
12027     Set_Node_Offset(ret, parse_start + 2);
12028     Set_Node_Cur_Length(ret, parse_start);
12029     nextchar(pRExC_state);
12030    }
12031    break;
12032   case 'N':
12033    /* Handle \N, \N{} and \N{NAMED SEQUENCE} (the latter meaning the
12034    * \N{...} evaluates to a sequence of more than one code points).
12035    * The function call below returns a regnode, which is our result.
12036    * The parameters cause it to fail if the \N{} evaluates to a
12037    * single code point; we handle those like any other literal.  The
12038    * reason that the multicharacter case is handled here and not as
12039    * part of the EXACtish code is because of quantifiers.  In
12040    * /\N{BLAH}+/, the '+' applies to the whole thing, and doing it
12041    * this way makes that Just Happen. dmq.
12042    * join_exact() will join this up with adjacent EXACTish nodes
12043    * later on, if appropriate. */
12044    ++RExC_parse;
12045    if (grok_bslash_N(pRExC_state,
12046        &ret,     /* Want a regnode returned */
12047        NULL,     /* Fail if evaluates to a single code
12048           point */
12049        NULL,     /* Don't need a count of how many code
12050           points */
12051        flagp,
12052        depth)
12053    ) {
12054     break;
12055    }
12056
12057    if (*flagp & RESTART_UTF8)
12058     return NULL;
12059    RExC_parse--;
12060    goto defchar;
12061
12062   case 'k':    /* Handle \k<NAME> and \k'NAME' */
12063  parse_named_seq:
12064   {
12065    char ch= RExC_parse[1];
12066    if (ch != '<' && ch != '\'' && ch != '{') {
12067     RExC_parse++;
12068     /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
12069     vFAIL2("Sequence %.2s... not terminated",parse_start);
12070    } else {
12071     /* this pretty much dupes the code for (?P=...) in reg(), if
12072     you change this make sure you change that */
12073     char* name_start = (RExC_parse += 2);
12074     U32 num = 0;
12075     SV *sv_dat = reg_scan_name(pRExC_state,
12076      SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
12077     ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
12078     if (RExC_parse == name_start || *RExC_parse != ch)
12079      /* diag_listed_as: Sequence \%s... not terminated in regex; marked by <-- HERE in m/%s/ */
12080      vFAIL2("Sequence %.3s... not terminated",parse_start);
12081
12082     if (!SIZE_ONLY) {
12083      num = add_data( pRExC_state, STR_WITH_LEN("S"));
12084      RExC_rxi->data->data[num]=(void*)sv_dat;
12085      SvREFCNT_inc_simple_void(sv_dat);
12086     }
12087
12088     RExC_sawback = 1;
12089     ret = reganode(pRExC_state,
12090        ((! FOLD)
12091         ? NREF
12092         : (ASCII_FOLD_RESTRICTED)
12093         ? NREFFA
12094         : (AT_LEAST_UNI_SEMANTICS)
12095          ? NREFFU
12096          : (LOC)
12097          ? NREFFL
12098          : NREFF),
12099         num);
12100     *flagp |= HASWIDTH;
12101
12102     /* override incorrect value set in reganode MJD */
12103     Set_Node_Offset(ret, parse_start+1);
12104     Set_Node_Cur_Length(ret, parse_start);
12105     nextchar(pRExC_state);
12106
12107    }
12108    break;
12109   }
12110   case 'g':
12111   case '1': case '2': case '3': case '4':
12112   case '5': case '6': case '7': case '8': case '9':
12113    {
12114     I32 num;
12115     bool hasbrace = 0;
12116
12117     if (*RExC_parse == 'g') {
12118      bool isrel = 0;
12119
12120      RExC_parse++;
12121      if (*RExC_parse == '{') {
12122       RExC_parse++;
12123       hasbrace = 1;
12124      }
12125      if (*RExC_parse == '-') {
12126       RExC_parse++;
12127       isrel = 1;
12128      }
12129      if (hasbrace && !isDIGIT(*RExC_parse)) {
12130       if (isrel) RExC_parse--;
12131       RExC_parse -= 2;
12132       goto parse_named_seq;
12133      }
12134
12135      num = S_backref_value(RExC_parse);
12136      if (num == 0)
12137       vFAIL("Reference to invalid group 0");
12138      else if (num == I32_MAX) {
12139       if (isDIGIT(*RExC_parse))
12140        vFAIL("Reference to nonexistent group");
12141       else
12142        vFAIL("Unterminated \\g... pattern");
12143      }
12144
12145      if (isrel) {
12146       num = RExC_npar - num;
12147       if (num < 1)
12148        vFAIL("Reference to nonexistent or unclosed group");
12149      }
12150     }
12151     else {
12152      num = S_backref_value(RExC_parse);
12153      /* bare \NNN might be backref or octal - if it is larger
12154      * than or equal RExC_npar then it is assumed to be an
12155      * octal escape. Note RExC_npar is +1 from the actual
12156      * number of parens. */
12157      /* Note we do NOT check if num == I32_MAX here, as that is
12158      * handled by the RExC_npar check */
12159
12160      if (
12161       /* any numeric escape < 10 is always a backref */
12162       num > 9
12163       /* any numeric escape < RExC_npar is a backref */
12164       && num >= RExC_npar
12165       /* cannot be an octal escape if it starts with 8 */
12166       && *RExC_parse != '8'
12167       /* cannot be an octal escape it it starts with 9 */
12168       && *RExC_parse != '9'
12169      )
12170      {
12171       /* Probably not a backref, instead likely to be an
12172       * octal character escape, e.g. \35 or \777.
12173       * The above logic should make it obvious why using
12174       * octal escapes in patterns is problematic. - Yves */
12175       goto defchar;
12176      }
12177     }
12178
12179     /* At this point RExC_parse points at a numeric escape like
12180     * \12 or \88 or something similar, which we should NOT treat
12181     * as an octal escape. It may or may not be a valid backref
12182     * escape. For instance \88888888 is unlikely to be a valid
12183     * backref. */
12184     {
12185 #ifdef RE_TRACK_PATTERN_OFFSETS
12186      char * const parse_start = RExC_parse - 1; /* MJD */
12187 #endif
12188      while (isDIGIT(*RExC_parse))
12189       RExC_parse++;
12190      if (hasbrace) {
12191       if (*RExC_parse != '}')
12192        vFAIL("Unterminated \\g{...} pattern");
12193       RExC_parse++;
12194      }
12195      if (!SIZE_ONLY) {
12196       if (num > (I32)RExC_rx->nparens)
12197        vFAIL("Reference to nonexistent group");
12198      }
12199      RExC_sawback = 1;
12200      ret = reganode(pRExC_state,
12201         ((! FOLD)
12202          ? REF
12203          : (ASCII_FOLD_RESTRICTED)
12204          ? REFFA
12205          : (AT_LEAST_UNI_SEMANTICS)
12206           ? REFFU
12207           : (LOC)
12208           ? REFFL
12209           : REFF),
12210          num);
12211      *flagp |= HASWIDTH;
12212
12213      /* override incorrect value set in reganode MJD */
12214      Set_Node_Offset(ret, parse_start+1);
12215      Set_Node_Cur_Length(ret, parse_start);
12216      RExC_parse--;
12217      nextchar(pRExC_state);
12218     }
12219    }
12220    break;
12221   case '\0':
12222    if (RExC_parse >= RExC_end)
12223     FAIL("Trailing \\");
12224    /* FALLTHROUGH */
12225   default:
12226    /* Do not generate "unrecognized" warnings here, we fall
12227    back into the quick-grab loop below */
12228    parse_start--;
12229    goto defchar;
12230   }
12231   break;
12232
12233  case '#':
12234   if (RExC_flags & RXf_PMf_EXTENDED) {
12235    RExC_parse = reg_skipcomment( pRExC_state, RExC_parse );
12236    if (RExC_parse < RExC_end)
12237     goto tryagain;
12238   }
12239   /* FALLTHROUGH */
12240
12241  default:
12242
12243    parse_start = RExC_parse - 1;
12244
12245    RExC_parse++;
12246
12247   defchar: {
12248    STRLEN len = 0;
12249    UV ender = 0;
12250    char *p;
12251    char *s;
12252 #define MAX_NODE_STRING_SIZE 127
12253    char foldbuf[MAX_NODE_STRING_SIZE+UTF8_MAXBYTES_CASE];
12254    char *s0;
12255    U8 upper_parse = MAX_NODE_STRING_SIZE;
12256    U8 node_type = compute_EXACTish(pRExC_state);
12257    bool next_is_quantifier;
12258    char * oldp = NULL;
12259
12260    /* We can convert EXACTF nodes to EXACTFU if they contain only
12261    * characters that match identically regardless of the target
12262    * string's UTF8ness.  The reason to do this is that EXACTF is not
12263    * trie-able, EXACTFU is.
12264    *
12265    * Similarly, we can convert EXACTFL nodes to EXACTFU if they
12266    * contain only above-Latin1 characters (hence must be in UTF8),
12267    * which don't participate in folds with Latin1-range characters,
12268    * as the latter's folds aren't known until runtime.  (We don't
12269    * need to figure this out until pass 2) */
12270    bool maybe_exactfu = PASS2
12271        && (node_type == EXACTF || node_type == EXACTFL);
12272
12273    /* If a folding node contains only code points that don't
12274    * participate in folds, it can be changed into an EXACT node,
12275    * which allows the optimizer more things to look for */
12276    bool maybe_exact;
12277
12278    ret = reg_node(pRExC_state, node_type);
12279
12280    /* In pass1, folded, we use a temporary buffer instead of the
12281    * actual node, as the node doesn't exist yet */
12282    s = (SIZE_ONLY && FOLD) ? foldbuf : STRING(ret);
12283
12284    s0 = s;
12285
12286   reparse:
12287
12288    /* We do the EXACTFish to EXACT node only if folding.  (And we
12289    * don't need to figure this out until pass 2) */
12290    maybe_exact = FOLD && PASS2;
12291
12292    /* XXX The node can hold up to 255 bytes, yet this only goes to
12293    * 127.  I (khw) do not know why.  Keeping it somewhat less than
12294    * 255 allows us to not have to worry about overflow due to
12295    * converting to utf8 and fold expansion, but that value is
12296    * 255-UTF8_MAXBYTES_CASE.  join_exact() may join adjacent nodes
12297    * split up by this limit into a single one using the real max of
12298    * 255.  Even at 127, this breaks under rare circumstances.  If
12299    * folding, we do not want to split a node at a character that is a
12300    * non-final in a multi-char fold, as an input string could just
12301    * happen to want to match across the node boundary.  The join
12302    * would solve that problem if the join actually happens.  But a
12303    * series of more than two nodes in a row each of 127 would cause
12304    * the first join to succeed to get to 254, but then there wouldn't
12305    * be room for the next one, which could at be one of those split
12306    * multi-char folds.  I don't know of any fool-proof solution.  One
12307    * could back off to end with only a code point that isn't such a
12308    * non-final, but it is possible for there not to be any in the
12309    * entire node. */
12310    for (p = RExC_parse - 1;
12311     len < upper_parse && p < RExC_end;
12312     len++)
12313    {
12314     oldp = p;
12315
12316     if (RExC_flags & RXf_PMf_EXTENDED)
12317      p = regpatws(pRExC_state, p,
12318           TRUE); /* means recognize comments */
12319     switch ((U8)*p) {
12320     case '^':
12321     case '$':
12322     case '.':
12323     case '[':
12324     case '(':
12325     case ')':
12326     case '|':
12327      goto loopdone;
12328     case '\\':
12329      /* Literal Escapes Switch
12330
12331      This switch is meant to handle escape sequences that
12332      resolve to a literal character.
12333
12334      Every escape sequence that represents something
12335      else, like an assertion or a char class, is handled
12336      in the switch marked 'Special Escapes' above in this
12337      routine, but also has an entry here as anything that
12338      isn't explicitly mentioned here will be treated as
12339      an unescaped equivalent literal.
12340      */
12341
12342      switch ((U8)*++p) {
12343      /* These are all the special escapes. */
12344      case 'A':             /* Start assertion */
12345      case 'b': case 'B':   /* Word-boundary assertion*/
12346      case 'C':             /* Single char !DANGEROUS! */
12347      case 'd': case 'D':   /* digit class */
12348      case 'g': case 'G':   /* generic-backref, pos assertion */
12349      case 'h': case 'H':   /* HORIZWS */
12350      case 'k': case 'K':   /* named backref, keep marker */
12351      case 'p': case 'P':   /* Unicode property */
12352        case 'R':   /* LNBREAK */
12353      case 's': case 'S':   /* space class */
12354      case 'v': case 'V':   /* VERTWS */
12355      case 'w': case 'W':   /* word class */
12356      case 'X':             /* eXtended Unicode "combining
12357            character sequence" */
12358      case 'z': case 'Z':   /* End of line/string assertion */
12359       --p;
12360       goto loopdone;
12361
12362      /* Anything after here is an escape that resolves to a
12363      literal. (Except digits, which may or may not)
12364      */
12365      case 'n':
12366       ender = '\n';
12367       p++;
12368       break;
12369      case 'N': /* Handle a single-code point named character. */
12370       RExC_parse = p + 1;
12371       if (! grok_bslash_N(pRExC_state,
12372            NULL,   /* Fail if evaluates to
12373              anything other than a
12374              single code point */
12375            &ender, /* The returned single code
12376              point */
12377            NULL,   /* Don't need a count of
12378              how many code points */
12379            flagp,
12380            depth)
12381       ) {
12382        if (*flagp & RESTART_UTF8)
12383         FAIL("panic: grok_bslash_N set RESTART_UTF8");
12384
12385        /* Here, it wasn't a single code point.  Go close
12386        * up this EXACTish node.  The switch() prior to
12387        * this switch handles the other cases */
12388        RExC_parse = p = oldp;
12389        goto loopdone;
12390       }
12391       p = RExC_parse;
12392       if (ender > 0xff) {
12393        REQUIRE_UTF8;
12394       }
12395       break;
12396      case 'r':
12397       ender = '\r';
12398       p++;
12399       break;
12400      case 't':
12401       ender = '\t';
12402       p++;
12403       break;
12404      case 'f':
12405       ender = '\f';
12406       p++;
12407       break;
12408      case 'e':
12409       ender = ESC_NATIVE;
12410       p++;
12411       break;
12412      case 'a':
12413       ender = '\a';
12414       p++;
12415       break;
12416      case 'o':
12417       {
12418        UV result;
12419        const char* error_msg;
12420
12421        bool valid = grok_bslash_o(&p,
12422              &result,
12423              &error_msg,
12424              PASS2, /* out warnings */
12425              (bool) RExC_strict,
12426              TRUE, /* Output warnings
12427                 for non-
12428                 portables */
12429              UTF);
12430        if (! valid) {
12431         RExC_parse = p; /* going to die anyway; point
12432             to exact spot of failure */
12433         vFAIL(error_msg);
12434        }
12435        ender = result;
12436        if (IN_ENCODING && ender < 0x100) {
12437         goto recode_encoding;
12438        }
12439        if (ender > 0xff) {
12440         REQUIRE_UTF8;
12441        }
12442        break;
12443       }
12444      case 'x':
12445       {
12446        UV result = UV_MAX; /* initialize to erroneous
12447             value */
12448        const char* error_msg;
12449
12450        bool valid = grok_bslash_x(&p,
12451              &result,
12452              &error_msg,
12453              PASS2, /* out warnings */
12454              (bool) RExC_strict,
12455              TRUE, /* Silence warnings
12456                 for non-
12457                 portables */
12458              UTF);
12459        if (! valid) {
12460         RExC_parse = p; /* going to die anyway; point
12461             to exact spot of failure */
12462         vFAIL(error_msg);
12463        }
12464        ender = result;
12465
12466        if (ender < 0x100) {
12467 #ifdef EBCDIC
12468         if (RExC_recode_x_to_native) {
12469          ender = LATIN1_TO_NATIVE(ender);
12470         }
12471         else
12472 #endif
12473         if (IN_ENCODING) {
12474          goto recode_encoding;
12475         }
12476        }
12477        else {
12478         REQUIRE_UTF8;
12479        }
12480        break;
12481       }
12482      case 'c':
12483       p++;
12484       ender = grok_bslash_c(*p++, PASS2);
12485       break;
12486      case '8': case '9': /* must be a backreference */
12487       --p;
12488       /* we have an escape like \8 which cannot be an octal escape
12489       * so we exit the loop, and let the outer loop handle this
12490       * escape which may or may not be a legitimate backref. */
12491       goto loopdone;
12492      case '1': case '2': case '3':case '4':
12493      case '5': case '6': case '7':
12494       /* When we parse backslash escapes there is ambiguity
12495       * between backreferences and octal escapes. Any escape
12496       * from \1 - \9 is a backreference, any multi-digit
12497       * escape which does not start with 0 and which when
12498       * evaluated as decimal could refer to an already
12499       * parsed capture buffer is a back reference. Anything
12500       * else is octal.
12501       *
12502       * Note this implies that \118 could be interpreted as
12503       * 118 OR as "\11" . "8" depending on whether there
12504       * were 118 capture buffers defined already in the
12505       * pattern.  */
12506
12507       /* NOTE, RExC_npar is 1 more than the actual number of
12508       * parens we have seen so far, hence the < RExC_npar below. */
12509
12510       if ( !isDIGIT(p[1]) || S_backref_value(p) < RExC_npar)
12511       {  /* Not to be treated as an octal constant, go
12512         find backref */
12513        --p;
12514        goto loopdone;
12515       }
12516       /* FALLTHROUGH */
12517      case '0':
12518       {
12519        I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
12520        STRLEN numlen = 3;
12521        ender = grok_oct(p, &numlen, &flags, NULL);
12522        if (ender > 0xff) {
12523         REQUIRE_UTF8;
12524        }
12525        p += numlen;
12526        if (PASS2   /* like \08, \178 */
12527         && numlen < 3
12528         && p < RExC_end
12529         && isDIGIT(*p) && ckWARN(WARN_REGEXP))
12530        {
12531         reg_warn_non_literal_string(
12532           p + 1,
12533           form_short_octal_warning(p, numlen));
12534        }
12535       }
12536       if (IN_ENCODING && ender < 0x100)
12537        goto recode_encoding;
12538       break;
12539      recode_encoding:
12540       if (! RExC_override_recoding) {
12541        SV* enc = _get_encoding();
12542        ender = reg_recode((const char)(U8)ender, &enc);
12543        if (!enc && PASS2)
12544         ckWARNreg(p, "Invalid escape in the specified encoding");
12545        REQUIRE_UTF8;
12546       }
12547       break;
12548      case '\0':
12549       if (p >= RExC_end)
12550        FAIL("Trailing \\");
12551       /* FALLTHROUGH */
12552      default:
12553       if (!SIZE_ONLY&& isALPHANUMERIC(*p)) {
12554        /* Include any { following the alpha to emphasize
12555        * that it could be part of an escape at some point
12556        * in the future */
12557        int len = (isALPHA(*p) && *(p + 1) == '{') ? 2 : 1;
12558        ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
12559       }
12560       goto normal_default;
12561      } /* End of switch on '\' */
12562      break;
12563     case '{':
12564      /* Currently we don't warn when the lbrace is at the start
12565      * of a construct.  This catches it in the middle of a
12566      * literal string, or when its the first thing after
12567      * something like "\b" */
12568      if (! SIZE_ONLY
12569       && (len || (p > RExC_start && isALPHA_A(*(p -1)))))
12570      {
12571       ckWARNregdep(p + 1, "Unescaped left brace in regex is deprecated, passed through");
12572      }
12573      /*FALLTHROUGH*/
12574     default:    /* A literal character */
12575     normal_default:
12576      if (UTF8_IS_START(*p) && UTF) {
12577       STRLEN numlen;
12578       ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
12579            &numlen, UTF8_ALLOW_DEFAULT);
12580       p += numlen;
12581      }
12582      else
12583       ender = (U8) *p++;
12584      break;
12585     } /* End of switch on the literal */
12586
12587     /* Here, have looked at the literal character and <ender>
12588     * contains its ordinal, <p> points to the character after it
12589     */
12590
12591     if ( RExC_flags & RXf_PMf_EXTENDED)
12592      p = regpatws(pRExC_state, p,
12593           TRUE); /* means recognize comments */
12594
12595     /* If the next thing is a quantifier, it applies to this
12596     * character only, which means that this character has to be in
12597     * its own node and can't just be appended to the string in an
12598     * existing node, so if there are already other characters in
12599     * the node, close the node with just them, and set up to do
12600     * this character again next time through, when it will be the
12601     * only thing in its new node */
12602     if ((next_is_quantifier = (p < RExC_end && ISMULT2(p))) && len)
12603     {
12604      p = oldp;
12605      goto loopdone;
12606     }
12607
12608     if (! FOLD) {  /* The simple case, just append the literal */
12609
12610      /* In the sizing pass, we need only the size of the
12611      * character we are appending, hence we can delay getting
12612      * its representation until PASS2. */
12613      if (SIZE_ONLY) {
12614       if (UTF) {
12615        const STRLEN unilen = UNISKIP(ender);
12616        s += unilen;
12617
12618        /* We have to subtract 1 just below (and again in
12619        * the corresponding PASS2 code) because the loop
12620        * increments <len> each time, as all but this path
12621        * (and one other) through it add a single byte to
12622        * the EXACTish node.  But these paths would change
12623        * len to be the correct final value, so cancel out
12624        * the increment that follows */
12625        len += unilen - 1;
12626       }
12627       else {
12628        s++;
12629       }
12630      } else { /* PASS2 */
12631      not_fold_common:
12632       if (UTF) {
12633        U8 * new_s = uvchr_to_utf8((U8*)s, ender);
12634        len += (char *) new_s - s - 1;
12635        s = (char *) new_s;
12636       }
12637       else {
12638        *(s++) = (char) ender;
12639       }
12640      }
12641     }
12642     else if (LOC && is_PROBLEMATIC_LOCALE_FOLD_cp(ender)) {
12643
12644      /* Here are folding under /l, and the code point is
12645      * problematic.  First, we know we can't simplify things */
12646      maybe_exact = FALSE;
12647      maybe_exactfu = FALSE;
12648
12649      /* A problematic code point in this context means that its
12650      * fold isn't known until runtime, so we can't fold it now.
12651      * (The non-problematic code points are the above-Latin1
12652      * ones that fold to also all above-Latin1.  Their folds
12653      * don't vary no matter what the locale is.) But here we
12654      * have characters whose fold depends on the locale.
12655      * Unlike the non-folding case above, we have to keep track
12656      * of these in the sizing pass, so that we can make sure we
12657      * don't split too-long nodes in the middle of a potential
12658      * multi-char fold.  And unlike the regular fold case
12659      * handled in the else clauses below, we don't actually
12660      * fold and don't have special cases to consider.  What we
12661      * do for both passes is the PASS2 code for non-folding */
12662      goto not_fold_common;
12663     }
12664     else /* A regular FOLD code point */
12665      if (! ( UTF
12666       /* See comments for join_exact() as to why we fold this
12667       * non-UTF at compile time */
12668       || (node_type == EXACTFU
12669        && ender == LATIN_SMALL_LETTER_SHARP_S)))
12670     {
12671      /* Here, are folding and are not UTF-8 encoded; therefore
12672      * the character must be in the range 0-255, and is not /l
12673      * (Not /l because we already handled these under /l in
12674      * is_PROBLEMATIC_LOCALE_FOLD_cp) */
12675      if (IS_IN_SOME_FOLD_L1(ender)) {
12676       maybe_exact = FALSE;
12677
12678       /* See if the character's fold differs between /d and
12679       * /u.  This includes the multi-char fold SHARP S to
12680       * 'ss' */
12681       if (maybe_exactfu
12682        && (PL_fold[ender] != PL_fold_latin1[ender]
12683         || ender == LATIN_SMALL_LETTER_SHARP_S
12684         || (len > 0
12685         && isALPHA_FOLD_EQ(ender, 's')
12686         && isALPHA_FOLD_EQ(*(s-1), 's'))))
12687       {
12688        maybe_exactfu = FALSE;
12689       }
12690      }
12691
12692      /* Even when folding, we store just the input character, as
12693      * we have an array that finds its fold quickly */
12694      *(s++) = (char) ender;
12695     }
12696     else {  /* FOLD and UTF */
12697      /* Unlike the non-fold case, we do actually have to
12698      * calculate the results here in pass 1.  This is for two
12699      * reasons, the folded length may be longer than the
12700      * unfolded, and we have to calculate how many EXACTish
12701      * nodes it will take; and we may run out of room in a node
12702      * in the middle of a potential multi-char fold, and have
12703      * to back off accordingly.  */
12704
12705      UV folded;
12706      if (isASCII_uni(ender)) {
12707       folded = toFOLD(ender);
12708       *(s)++ = (U8) folded;
12709      }
12710      else {
12711       STRLEN foldlen;
12712
12713       folded = _to_uni_fold_flags(
12714          ender,
12715          (U8 *) s,
12716          &foldlen,
12717          FOLD_FLAGS_FULL | ((ASCII_FOLD_RESTRICTED)
12718               ? FOLD_FLAGS_NOMIX_ASCII
12719               : 0));
12720       s += foldlen;
12721
12722       /* The loop increments <len> each time, as all but this
12723       * path (and one other) through it add a single byte to
12724       * the EXACTish node.  But this one has changed len to
12725       * be the correct final value, so subtract one to
12726       * cancel out the increment that follows */
12727       len += foldlen - 1;
12728      }
12729      /* If this node only contains non-folding code points so
12730      * far, see if this new one is also non-folding */
12731      if (maybe_exact) {
12732       if (folded != ender) {
12733        maybe_exact = FALSE;
12734       }
12735       else {
12736        /* Here the fold is the original; we have to check
12737        * further to see if anything folds to it */
12738        if (_invlist_contains_cp(PL_utf8_foldable,
12739               ender))
12740        {
12741         maybe_exact = FALSE;
12742        }
12743       }
12744      }
12745      ender = folded;
12746     }
12747
12748     if (next_is_quantifier) {
12749
12750      /* Here, the next input is a quantifier, and to get here,
12751      * the current character is the only one in the node.
12752      * Also, here <len> doesn't include the final byte for this
12753      * character */
12754      len++;
12755      goto loopdone;
12756     }
12757
12758    } /* End of loop through literal characters */
12759
12760    /* Here we have either exhausted the input or ran out of room in
12761    * the node.  (If we encountered a character that can't be in the
12762    * node, transfer is made directly to <loopdone>, and so we
12763    * wouldn't have fallen off the end of the loop.)  In the latter
12764    * case, we artificially have to split the node into two, because
12765    * we just don't have enough space to hold everything.  This
12766    * creates a problem if the final character participates in a
12767    * multi-character fold in the non-final position, as a match that
12768    * should have occurred won't, due to the way nodes are matched,
12769    * and our artificial boundary.  So back off until we find a non-
12770    * problematic character -- one that isn't at the beginning or
12771    * middle of such a fold.  (Either it doesn't participate in any
12772    * folds, or appears only in the final position of all the folds it
12773    * does participate in.)  A better solution with far fewer false
12774    * positives, and that would fill the nodes more completely, would
12775    * be to actually have available all the multi-character folds to
12776    * test against, and to back-off only far enough to be sure that
12777    * this node isn't ending with a partial one.  <upper_parse> is set
12778    * further below (if we need to reparse the node) to include just
12779    * up through that final non-problematic character that this code
12780    * identifies, so when it is set to less than the full node, we can
12781    * skip the rest of this */
12782    if (FOLD && p < RExC_end && upper_parse == MAX_NODE_STRING_SIZE) {
12783
12784     const STRLEN full_len = len;
12785
12786     assert(len >= MAX_NODE_STRING_SIZE);
12787
12788     /* Here, <s> points to the final byte of the final character.
12789     * Look backwards through the string until find a non-
12790     * problematic character */
12791
12792     if (! UTF) {
12793
12794      /* This has no multi-char folds to non-UTF characters */
12795      if (ASCII_FOLD_RESTRICTED) {
12796       goto loopdone;
12797      }
12798
12799      while (--s >= s0 && IS_NON_FINAL_FOLD(*s)) { }
12800      len = s - s0 + 1;
12801     }
12802     else {
12803      if (!  PL_NonL1NonFinalFold) {
12804       PL_NonL1NonFinalFold = _new_invlist_C_array(
12805           NonL1_Perl_Non_Final_Folds_invlist);
12806      }
12807
12808      /* Point to the first byte of the final character */
12809      s = (char *) utf8_hop((U8 *) s, -1);
12810
12811      while (s >= s0) {   /* Search backwards until find
12812           non-problematic char */
12813       if (UTF8_IS_INVARIANT(*s)) {
12814
12815        /* There are no ascii characters that participate
12816        * in multi-char folds under /aa.  In EBCDIC, the
12817        * non-ascii invariants are all control characters,
12818        * so don't ever participate in any folds. */
12819        if (ASCII_FOLD_RESTRICTED
12820         || ! IS_NON_FINAL_FOLD(*s))
12821        {
12822         break;
12823        }
12824       }
12825       else if (UTF8_IS_DOWNGRADEABLE_START(*s)) {
12826        if (! IS_NON_FINAL_FOLD(TWO_BYTE_UTF8_TO_NATIVE(
12827                 *s, *(s+1))))
12828        {
12829         break;
12830        }
12831       }
12832       else if (! _invlist_contains_cp(
12833           PL_NonL1NonFinalFold,
12834           valid_utf8_to_uvchr((U8 *) s, NULL)))
12835       {
12836        break;
12837       }
12838
12839       /* Here, the current character is problematic in that
12840       * it does occur in the non-final position of some
12841       * fold, so try the character before it, but have to
12842       * special case the very first byte in the string, so
12843       * we don't read outside the string */
12844       s = (s == s0) ? s -1 : (char *) utf8_hop((U8 *) s, -1);
12845      } /* End of loop backwards through the string */
12846
12847      /* If there were only problematic characters in the string,
12848      * <s> will point to before s0, in which case the length
12849      * should be 0, otherwise include the length of the
12850      * non-problematic character just found */
12851      len = (s < s0) ? 0 : s - s0 + UTF8SKIP(s);
12852     }
12853
12854     /* Here, have found the final character, if any, that is
12855     * non-problematic as far as ending the node without splitting
12856     * it across a potential multi-char fold.  <len> contains the
12857     * number of bytes in the node up-to and including that
12858     * character, or is 0 if there is no such character, meaning
12859     * the whole node contains only problematic characters.  In
12860     * this case, give up and just take the node as-is.  We can't
12861     * do any better */
12862     if (len == 0) {
12863      len = full_len;
12864
12865      /* If the node ends in an 's' we make sure it stays EXACTF,
12866      * as if it turns into an EXACTFU, it could later get
12867      * joined with another 's' that would then wrongly match
12868      * the sharp s */
12869      if (maybe_exactfu && isALPHA_FOLD_EQ(ender, 's'))
12870      {
12871       maybe_exactfu = FALSE;
12872      }
12873     } else {
12874
12875      /* Here, the node does contain some characters that aren't
12876      * problematic.  If one such is the final character in the
12877      * node, we are done */
12878      if (len == full_len) {
12879       goto loopdone;
12880      }
12881      else if (len + ((UTF) ? UTF8SKIP(s) : 1) == full_len) {
12882
12883       /* If the final character is problematic, but the
12884       * penultimate is not, back-off that last character to
12885       * later start a new node with it */
12886       p = oldp;
12887       goto loopdone;
12888      }
12889
12890      /* Here, the final non-problematic character is earlier
12891      * in the input than the penultimate character.  What we do
12892      * is reparse from the beginning, going up only as far as
12893      * this final ok one, thus guaranteeing that the node ends
12894      * in an acceptable character.  The reason we reparse is
12895      * that we know how far in the character is, but we don't
12896      * know how to correlate its position with the input parse.
12897      * An alternate implementation would be to build that
12898      * correlation as we go along during the original parse,
12899      * but that would entail extra work for every node, whereas
12900      * this code gets executed only when the string is too
12901      * large for the node, and the final two characters are
12902      * problematic, an infrequent occurrence.  Yet another
12903      * possible strategy would be to save the tail of the
12904      * string, and the next time regatom is called, initialize
12905      * with that.  The problem with this is that unless you
12906      * back off one more character, you won't be guaranteed
12907      * regatom will get called again, unless regbranch,
12908      * regpiece ... are also changed.  If you do back off that
12909      * extra character, so that there is input guaranteed to
12910      * force calling regatom, you can't handle the case where
12911      * just the first character in the node is acceptable.  I
12912      * (khw) decided to try this method which doesn't have that
12913      * pitfall; if performance issues are found, we can do a
12914      * combination of the current approach plus that one */
12915      upper_parse = len;
12916      len = 0;
12917      s = s0;
12918      goto reparse;
12919     }
12920    }   /* End of verifying node ends with an appropriate char */
12921
12922   loopdone:   /* Jumped to when encounters something that shouldn't be
12923       in the node */
12924
12925    /* I (khw) don't know if you can get here with zero length, but the
12926    * old code handled this situation by creating a zero-length EXACT
12927    * node.  Might as well be NOTHING instead */
12928    if (len == 0) {
12929     OP(ret) = NOTHING;
12930    }
12931    else {
12932     if (FOLD) {
12933      /* If 'maybe_exact' is still set here, means there are no
12934      * code points in the node that participate in folds;
12935      * similarly for 'maybe_exactfu' and code points that match
12936      * differently depending on UTF8ness of the target string
12937      * (for /u), or depending on locale for /l */
12938      if (maybe_exact) {
12939       OP(ret) = (LOC)
12940         ? EXACTL
12941         : EXACT;
12942      }
12943      else if (maybe_exactfu) {
12944       OP(ret) = (LOC)
12945         ? EXACTFLU8
12946         : EXACTFU;
12947      }
12948     }
12949     alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, len, ender,
12950           FALSE /* Don't look to see if could
12951              be turned into an EXACT
12952              node, as we have already
12953              computed that */
12954           );
12955    }
12956
12957    RExC_parse = p - 1;
12958    Set_Node_Cur_Length(ret, parse_start);
12959    nextchar(pRExC_state);
12960    {
12961     /* len is STRLEN which is unsigned, need to copy to signed */
12962     IV iv = len;
12963     if (iv < 0)
12964      vFAIL("Internal disaster");
12965    }
12966
12967   } /* End of label 'defchar:' */
12968   break;
12969  } /* End of giant switch on input character */
12970
12971  return(ret);
12972 }
12973
12974 STATIC char *
12975 S_regpatws(RExC_state_t *pRExC_state, char *p , const bool recognize_comment )
12976 {
12977  /* Returns the next non-pattern-white space, non-comment character (the
12978  * latter only if 'recognize_comment is true) in the string p, which is
12979  * ended by RExC_end.  See also reg_skipcomment */
12980  const char *e = RExC_end;
12981
12982  PERL_ARGS_ASSERT_REGPATWS;
12983
12984  while (p < e) {
12985   STRLEN len;
12986   if ((len = is_PATWS_safe(p, e, UTF))) {
12987    p += len;
12988   }
12989   else if (recognize_comment && *p == '#') {
12990    p = reg_skipcomment(pRExC_state, p);
12991   }
12992   else
12993    break;
12994  }
12995  return p;
12996 }
12997
12998 STATIC void
12999 S_populate_ANYOF_from_invlist(pTHX_ regnode *node, SV** invlist_ptr)
13000 {
13001  /* Uses the inversion list '*invlist_ptr' to populate the ANYOF 'node'.  It
13002  * sets up the bitmap and any flags, removing those code points from the
13003  * inversion list, setting it to NULL should it become completely empty */
13004
13005  PERL_ARGS_ASSERT_POPULATE_ANYOF_FROM_INVLIST;
13006  assert(PL_regkind[OP(node)] == ANYOF);
13007
13008  ANYOF_BITMAP_ZERO(node);
13009  if (*invlist_ptr) {
13010
13011   /* This gets set if we actually need to modify things */
13012   bool change_invlist = FALSE;
13013
13014   UV start, end;
13015
13016   /* Start looking through *invlist_ptr */
13017   invlist_iterinit(*invlist_ptr);
13018   while (invlist_iternext(*invlist_ptr, &start, &end)) {
13019    UV high;
13020    int i;
13021
13022    if (end == UV_MAX && start <= NUM_ANYOF_CODE_POINTS) {
13023     ANYOF_FLAGS(node) |= ANYOF_MATCHES_ALL_ABOVE_BITMAP;
13024    }
13025    else if (end >= NUM_ANYOF_CODE_POINTS) {
13026     ANYOF_FLAGS(node) |= ANYOF_HAS_UTF8_NONBITMAP_MATCHES;
13027    }
13028
13029    /* Quit if are above what we should change */
13030    if (start >= NUM_ANYOF_CODE_POINTS) {
13031     break;
13032    }
13033
13034    change_invlist = TRUE;
13035
13036    /* Set all the bits in the range, up to the max that we are doing */
13037    high = (end < NUM_ANYOF_CODE_POINTS - 1)
13038     ? end
13039     : NUM_ANYOF_CODE_POINTS - 1;
13040    for (i = start; i <= (int) high; i++) {
13041     if (! ANYOF_BITMAP_TEST(node, i)) {
13042      ANYOF_BITMAP_SET(node, i);
13043     }
13044    }
13045   }
13046   invlist_iterfinish(*invlist_ptr);
13047
13048   /* Done with loop; remove any code points that are in the bitmap from
13049   * *invlist_ptr; similarly for code points above the bitmap if we have
13050   * a flag to match all of them anyways */
13051   if (change_invlist) {
13052    _invlist_subtract(*invlist_ptr, PL_InBitmap, invlist_ptr);
13053   }
13054   if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
13055    _invlist_intersection(*invlist_ptr, PL_InBitmap, invlist_ptr);
13056   }
13057
13058   /* If have completely emptied it, remove it completely */
13059   if (_invlist_len(*invlist_ptr) == 0) {
13060    SvREFCNT_dec_NN(*invlist_ptr);
13061    *invlist_ptr = NULL;
13062   }
13063  }
13064 }
13065
13066 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
13067    Character classes ([:foo:]) can also be negated ([:^foo:]).
13068    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
13069    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
13070    but trigger failures because they are currently unimplemented. */
13071
13072 #define POSIXCC_DONE(c)   ((c) == ':')
13073 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
13074 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
13075
13076 PERL_STATIC_INLINE I32
13077 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value, const bool strict)
13078 {
13079  I32 namedclass = OOB_NAMEDCLASS;
13080
13081  PERL_ARGS_ASSERT_REGPPOSIXCC;
13082
13083  if (value == '[' && RExC_parse + 1 < RExC_end &&
13084   /* I smell either [: or [= or [. -- POSIX has been here, right? */
13085   POSIXCC(UCHARAT(RExC_parse)))
13086  {
13087   const char c = UCHARAT(RExC_parse);
13088   char* const s = RExC_parse++;
13089
13090   while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
13091    RExC_parse++;
13092   if (RExC_parse == RExC_end) {
13093    if (strict) {
13094
13095     /* Try to give a better location for the error (than the end of
13096     * the string) by looking for the matching ']' */
13097     RExC_parse = s;
13098     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
13099      RExC_parse++;
13100     }
13101     vFAIL2("Unmatched '%c' in POSIX class", c);
13102    }
13103    /* Grandfather lone [:, [=, [. */
13104    RExC_parse = s;
13105   }
13106   else {
13107    const char* const t = RExC_parse++; /* skip over the c */
13108    assert(*t == c);
13109
13110    if (UCHARAT(RExC_parse) == ']') {
13111     const char *posixcc = s + 1;
13112     RExC_parse++; /* skip over the ending ] */
13113
13114     if (*s == ':') {
13115      const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
13116      const I32 skip = t - posixcc;
13117
13118      /* Initially switch on the length of the name.  */
13119      switch (skip) {
13120      case 4:
13121       if (memEQ(posixcc, "word", 4)) /* this is not POSIX,
13122               this is the Perl \w
13123               */
13124        namedclass = ANYOF_WORDCHAR;
13125       break;
13126      case 5:
13127       /* Names all of length 5.  */
13128       /* alnum alpha ascii blank cntrl digit graph lower
13129       print punct space upper  */
13130       /* Offset 4 gives the best switch position.  */
13131       switch (posixcc[4]) {
13132       case 'a':
13133        if (memEQ(posixcc, "alph", 4)) /* alpha */
13134         namedclass = ANYOF_ALPHA;
13135        break;
13136       case 'e':
13137        if (memEQ(posixcc, "spac", 4)) /* space */
13138         namedclass = ANYOF_SPACE;
13139        break;
13140       case 'h':
13141        if (memEQ(posixcc, "grap", 4)) /* graph */
13142         namedclass = ANYOF_GRAPH;
13143        break;
13144       case 'i':
13145        if (memEQ(posixcc, "asci", 4)) /* ascii */
13146         namedclass = ANYOF_ASCII;
13147        break;
13148       case 'k':
13149        if (memEQ(posixcc, "blan", 4)) /* blank */
13150         namedclass = ANYOF_BLANK;
13151        break;
13152       case 'l':
13153        if (memEQ(posixcc, "cntr", 4)) /* cntrl */
13154         namedclass = ANYOF_CNTRL;
13155        break;
13156       case 'm':
13157        if (memEQ(posixcc, "alnu", 4)) /* alnum */
13158         namedclass = ANYOF_ALPHANUMERIC;
13159        break;
13160       case 'r':
13161        if (memEQ(posixcc, "lowe", 4)) /* lower */
13162         namedclass = (FOLD) ? ANYOF_CASED : ANYOF_LOWER;
13163        else if (memEQ(posixcc, "uppe", 4)) /* upper */
13164         namedclass = (FOLD) ? ANYOF_CASED : ANYOF_UPPER;
13165        break;
13166       case 't':
13167        if (memEQ(posixcc, "digi", 4)) /* digit */
13168         namedclass = ANYOF_DIGIT;
13169        else if (memEQ(posixcc, "prin", 4)) /* print */
13170         namedclass = ANYOF_PRINT;
13171        else if (memEQ(posixcc, "punc", 4)) /* punct */
13172         namedclass = ANYOF_PUNCT;
13173        break;
13174       }
13175       break;
13176      case 6:
13177       if (memEQ(posixcc, "xdigit", 6))
13178        namedclass = ANYOF_XDIGIT;
13179       break;
13180      }
13181
13182      if (namedclass == OOB_NAMEDCLASS)
13183       vFAIL2utf8f(
13184        "POSIX class [:%"UTF8f":] unknown",
13185        UTF8fARG(UTF, t - s - 1, s + 1));
13186
13187      /* The #defines are structured so each complement is +1 to
13188      * the normal one */
13189      if (complement) {
13190       namedclass++;
13191      }
13192      assert (posixcc[skip] == ':');
13193      assert (posixcc[skip+1] == ']');
13194     } else if (!SIZE_ONLY) {
13195      /* [[=foo=]] and [[.foo.]] are still future. */
13196
13197      /* adjust RExC_parse so the warning shows after
13198      the class closes */
13199      while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
13200       RExC_parse++;
13201      vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
13202     }
13203    } else {
13204     /* Maternal grandfather:
13205     * "[:" ending in ":" but not in ":]" */
13206     if (strict) {
13207      vFAIL("Unmatched '[' in POSIX class");
13208     }
13209
13210     /* Grandfather lone [:, [=, [. */
13211     RExC_parse = s;
13212    }
13213   }
13214  }
13215
13216  return namedclass;
13217 }
13218
13219 STATIC bool
13220 S_could_it_be_a_POSIX_class(RExC_state_t *pRExC_state)
13221 {
13222  /* This applies some heuristics at the current parse position (which should
13223  * be at a '[') to see if what follows might be intended to be a [:posix:]
13224  * class.  It returns true if it really is a posix class, of course, but it
13225  * also can return true if it thinks that what was intended was a posix
13226  * class that didn't quite make it.
13227  *
13228  * It will return true for
13229  *      [:alphanumerics:
13230  *      [:alphanumerics]  (as long as the ] isn't followed immediately by a
13231  *                         ')' indicating the end of the (?[
13232  *      [:any garbage including %^&$ punctuation:]
13233  *
13234  * This is designed to be called only from S_handle_regex_sets; it could be
13235  * easily adapted to be called from the spot at the beginning of regclass()
13236  * that checks to see in a normal bracketed class if the surrounding []
13237  * have been omitted ([:word:] instead of [[:word:]]).  But doing so would
13238  * change long-standing behavior, so I (khw) didn't do that */
13239  char* p = RExC_parse + 1;
13240  char first_char = *p;
13241
13242  PERL_ARGS_ASSERT_COULD_IT_BE_A_POSIX_CLASS;
13243
13244  assert(*(p - 1) == '[');
13245
13246  if (! POSIXCC(first_char)) {
13247   return FALSE;
13248  }
13249
13250  p++;
13251  while (p < RExC_end && isWORDCHAR(*p)) p++;
13252
13253  if (p >= RExC_end) {
13254   return FALSE;
13255  }
13256
13257  if (p - RExC_parse > 2    /* Got at least 1 word character */
13258   && (*p == first_char
13259    || (*p == ']' && p + 1 < RExC_end && *(p + 1) != ')')))
13260  {
13261   return TRUE;
13262  }
13263
13264  p = (char *) memchr(RExC_parse, ']', RExC_end - RExC_parse);
13265
13266  return (p
13267    && p - RExC_parse > 2 /* [:] evaluates to colon;
13268          [::] is a bad posix class. */
13269    && first_char == *(p - 1));
13270 }
13271
13272 STATIC unsigned  int
13273 S_regex_set_precedence(const U8 my_operator) {
13274
13275  /* Returns the precedence in the (?[...]) construct of the input operator,
13276  * specified by its character representation.  The precedence follows
13277  * general Perl rules, but it extends this so that ')' and ']' have (low)
13278  * precedence even though they aren't really operators */
13279
13280  switch (my_operator) {
13281   case '!':
13282    return 5;
13283   case '&':
13284    return 4;
13285   case '^':
13286   case '|':
13287   case '+':
13288   case '-':
13289    return 3;
13290   case ')':
13291    return 2;
13292   case ']':
13293    return 1;
13294  }
13295
13296  NOT_REACHED; /* NOTREACHED */
13297  return 0;   /* Silence compiler warning */
13298 }
13299
13300 STATIC regnode *
13301 S_handle_regex_sets(pTHX_ RExC_state_t *pRExC_state, SV** return_invlist,
13302      I32 *flagp, U32 depth,
13303      char * const oregcomp_parse)
13304 {
13305  /* Handle the (?[...]) construct to do set operations */
13306
13307  U8 curchar;                     /* Current character being parsed */
13308  UV start, end;             /* End points of code point ranges */
13309  SV* final = NULL;               /* The end result inversion list */
13310  SV* result_string;              /* 'final' stringified */
13311  AV* stack;                      /* stack of operators and operands not yet
13312          resolved */
13313  AV* fence_stack = NULL;         /* A stack containing the positions in
13314          'stack' of where the undealt-with left
13315          parens would be if they were actually
13316          put there */
13317  IV fence = 0;                   /* Position of where most recent undealt-
13318          with left paren in stack is; -1 if none.
13319          */
13320  STRLEN len;                     /* Temporary */
13321  regnode* node;                  /* Temporary, and final regnode returned by
13322          this function */
13323  const bool save_fold = FOLD;    /* Temporary */
13324  char *save_end, *save_parse;    /* Temporaries */
13325
13326  GET_RE_DEBUG_FLAGS_DECL;
13327
13328  PERL_ARGS_ASSERT_HANDLE_REGEX_SETS;
13329
13330  if (LOC) {  /* XXX could make valid in UTF-8 locales */
13331   vFAIL("(?[...]) not valid in locale");
13332  }
13333  RExC_uni_semantics = 1;     /* The use of this operator implies /u.  This
13334         is required so that the compile time values
13335         are valid in all runtime cases */
13336
13337  /* This will return only an ANYOF regnode, or (unlikely) something smaller
13338  * (such as EXACT).  Thus we can skip most everything if just sizing.  We
13339  * call regclass to handle '[]' so as to not have to reinvent its parsing
13340  * rules here (throwing away the size it computes each time).  And, we exit
13341  * upon an unescaped ']' that isn't one ending a regclass.  To do both
13342  * these things, we need to realize that something preceded by a backslash
13343  * is escaped, so we have to keep track of backslashes */
13344  if (SIZE_ONLY) {
13345   UV depth = 0; /* how many nested (?[...]) constructs */
13346
13347   while (RExC_parse < RExC_end) {
13348    SV* current = NULL;
13349    RExC_parse = regpatws(pRExC_state, RExC_parse,
13350           TRUE); /* means recognize comments */
13351    switch (*RExC_parse) {
13352     case '?':
13353      if (RExC_parse[1] == '[') depth++, RExC_parse++;
13354      /* FALLTHROUGH */
13355     default:
13356      break;
13357     case '\\':
13358      /* Skip the next byte (which could cause us to end up in
13359      * the middle of a UTF-8 character, but since none of those
13360      * are confusable with anything we currently handle in this
13361      * switch (invariants all), it's safe.  We'll just hit the
13362      * default: case next time and keep on incrementing until
13363      * we find one of the invariants we do handle. */
13364      RExC_parse++;
13365      break;
13366     case '[':
13367     {
13368      /* If this looks like it is a [:posix:] class, leave the
13369      * parse pointer at the '[' to fool regclass() into
13370      * thinking it is part of a '[[:posix:]]'.  That function
13371      * will use strict checking to force a syntax error if it
13372      * doesn't work out to a legitimate class */
13373      bool is_posix_class
13374          = could_it_be_a_POSIX_class(pRExC_state);
13375      if (! is_posix_class) {
13376       RExC_parse++;
13377      }
13378
13379      /* regclass() can only return RESTART_UTF8 if multi-char
13380      folds are allowed.  */
13381      if (!regclass(pRExC_state, flagp,depth+1,
13382         is_posix_class, /* parse the whole char
13383              class only if not a
13384              posix class */
13385         FALSE, /* don't allow multi-char folds */
13386         TRUE, /* silence non-portable warnings. */
13387         TRUE, /* strict */
13388         &current
13389         ))
13390       FAIL2("panic: regclass returned NULL to handle_sets, "
13391        "flags=%#"UVxf"", (UV) *flagp);
13392
13393      /* function call leaves parse pointing to the ']', except
13394      * if we faked it */
13395      if (is_posix_class) {
13396       RExC_parse--;
13397      }
13398
13399      SvREFCNT_dec(current);   /* In case it returned something */
13400      break;
13401     }
13402
13403     case ']':
13404      if (depth--) break;
13405      RExC_parse++;
13406      if (RExC_parse < RExC_end
13407       && *RExC_parse == ')')
13408      {
13409       node = reganode(pRExC_state, ANYOF, 0);
13410       RExC_size += ANYOF_SKIP;
13411       nextchar(pRExC_state);
13412       Set_Node_Length(node,
13413         RExC_parse - oregcomp_parse + 1); /* MJD */
13414       return node;
13415      }
13416      goto no_close;
13417    }
13418    RExC_parse++;
13419   }
13420
13421  no_close:
13422   FAIL("Syntax error in (?[...])");
13423  }
13424
13425  /* Pass 2 only after this. */
13426  Perl_ck_warner_d(aTHX_
13427   packWARN(WARN_EXPERIMENTAL__REGEX_SETS),
13428   "The regex_sets feature is experimental" REPORT_LOCATION,
13429    UTF8fARG(UTF, (RExC_parse - RExC_precomp), RExC_precomp),
13430    UTF8fARG(UTF,
13431      RExC_end - RExC_start - (RExC_parse - RExC_precomp),
13432      RExC_precomp + (RExC_parse - RExC_precomp)));
13433
13434  /* Everything in this construct is a metacharacter.  Operands begin with
13435  * either a '\' (for an escape sequence), or a '[' for a bracketed
13436  * character class.  Any other character should be an operator, or
13437  * parenthesis for grouping.  Both types of operands are handled by calling
13438  * regclass() to parse them.  It is called with a parameter to indicate to
13439  * return the computed inversion list.  The parsing here is implemented via
13440  * a stack.  Each entry on the stack is a single character representing one
13441  * of the operators; or else a pointer to an operand inversion list. */
13442
13443 #define IS_OPERAND(a)  (! SvIOK(a))
13444
13445  /* The stack is kept in Łukasiewicz order.  (That's pronounced similar
13446  * to luke-a-shave-itch (or -itz), but people who didn't want to bother
13447  * with prounouncing it called it Reverse Polish instead, but now that YOU
13448  * know how to prounounce it you can use the correct term, thus giving due
13449  * credit to the person who invented it, and impressing your geek friends.
13450  * Wikipedia says that the pronounciation of "Ł" has been changing so that
13451  * it is now more like an English initial W (as in wonk) than an L.)
13452  *
13453  * This means that, for example, 'a | b & c' is stored on the stack as
13454  *
13455  * c  [4]
13456  * b  [3]
13457  * &  [2]
13458  * a  [1]
13459  * |  [0]
13460  *
13461  * where the numbers in brackets give the stack [array] element number.
13462  * In this implementation, parentheses are not stored on the stack.
13463  * Instead a '(' creates a "fence" so that the part of the stack below the
13464  * fence is invisible except to the corresponding ')' (this allows us to
13465  * replace testing for parens, by using instead subtraction of the fence
13466  * position).  As new operands are processed they are pushed onto the stack
13467  * (except as noted in the next paragraph).  New operators of higher
13468  * precedence than the current final one are inserted on the stack before
13469  * the lhs operand (so that when the rhs is pushed next, everything will be
13470  * in the correct positions shown above.  When an operator of equal or
13471  * lower precedence is encountered in parsing, all the stacked operations
13472  * of equal or higher precedence are evaluated, leaving the result as the
13473  * top entry on the stack.  This makes higher precedence operations
13474  * evaluate before lower precedence ones, and causes operations of equal
13475  * precedence to left associate.
13476  *
13477  * The only unary operator '!' is immediately pushed onto the stack when
13478  * encountered.  When an operand is encountered, if the top of the stack is
13479  * a '!", the complement is immediately performed, and the '!' popped.  The
13480  * resulting value is treated as a new operand, and the logic in the
13481  * previous paragraph is executed.  Thus in the expression
13482  *      [a] + ! [b]
13483  * the stack looks like
13484  *
13485  * !
13486  * a
13487  * +
13488  *
13489  * as 'b' gets parsed, the latter gets evaluated to '!b', and the stack
13490  * becomes
13491  *
13492  * !b
13493  * a
13494  * +
13495  *
13496  * A ')' is treated as an operator with lower precedence than all the
13497  * aforementioned ones, which causes all operations on the stack above the
13498  * corresponding '(' to be evaluated down to a single resultant operand.
13499  * Then the fence for the '(' is removed, and the operand goes through the
13500  * algorithm above, without the fence.
13501  *
13502  * A separate stack is kept of the fence positions, so that the position of
13503  * the latest so-far unbalanced '(' is at the top of it.
13504  *
13505  * The ']' ending the construct is treated as the lowest operator of all,
13506  * so that everything gets evaluated down to a single operand, which is the
13507  * result */
13508
13509  sv_2mortal((SV *)(stack = newAV()));
13510  sv_2mortal((SV *)(fence_stack = newAV()));
13511
13512  while (RExC_parse < RExC_end) {
13513   I32 top_index;              /* Index of top-most element in 'stack' */
13514   SV** top_ptr;               /* Pointer to top 'stack' element */
13515   SV* current = NULL;         /* To contain the current inversion list
13516          operand */
13517   SV* only_to_avoid_leaks;
13518
13519   /* Skip white space */
13520   RExC_parse = regpatws(pRExC_state, RExC_parse,
13521     TRUE /* means recognize comments */ );
13522   if (RExC_parse >= RExC_end) {
13523    Perl_croak(aTHX_ "panic: Read past end of '(?[ ])'");
13524   }
13525
13526   curchar = UCHARAT(RExC_parse);
13527
13528 redo_curchar:
13529
13530   top_index = av_tindex(stack);
13531
13532   switch (curchar) {
13533    SV** stacked_ptr;       /* Ptr to something already on 'stack' */
13534    char stacked_operator;  /* The topmost operator on the 'stack'. */
13535    SV* lhs;                /* Operand to the left of the operator */
13536    SV* rhs;                /* Operand to the right of the operator */
13537    SV* fence_ptr;          /* Pointer to top element of the fence
13538          stack */
13539
13540    case '(':
13541
13542     if (RExC_parse < RExC_end && (UCHARAT(RExC_parse + 1) == '?'))
13543     {
13544      /* If is a '(?', could be an embedded '(?flags:(?[...])'.
13545      * This happens when we have some thing like
13546      *
13547      *   my $thai_or_lao = qr/(?[ \p{Thai} + \p{Lao} ])/;
13548      *   ...
13549      *   qr/(?[ \p{Digit} & $thai_or_lao ])/;
13550      *
13551      * Here we would be handling the interpolated
13552      * '$thai_or_lao'.  We handle this by a recursive call to
13553      * ourselves which returns the inversion list the
13554      * interpolated expression evaluates to.  We use the flags
13555      * from the interpolated pattern. */
13556      U32 save_flags = RExC_flags;
13557      const char * save_parse;
13558
13559      RExC_parse += 2;        /* Skip past the '(?' */
13560      save_parse = RExC_parse;
13561
13562      /* Parse any flags for the '(?' */
13563      parse_lparen_question_flags(pRExC_state);
13564
13565      if (RExC_parse == save_parse  /* Makes sure there was at
13566              least one flag (or else
13567              this embedding wasn't
13568              compiled) */
13569       || RExC_parse >= RExC_end - 4
13570       || UCHARAT(RExC_parse) != ':'
13571       || UCHARAT(++RExC_parse) != '('
13572       || UCHARAT(++RExC_parse) != '?'
13573       || UCHARAT(++RExC_parse) != '[')
13574      {
13575
13576       /* In combination with the above, this moves the
13577       * pointer to the point just after the first erroneous
13578       * character (or if there are no flags, to where they
13579       * should have been) */
13580       if (RExC_parse >= RExC_end - 4) {
13581        RExC_parse = RExC_end;
13582       }
13583       else if (RExC_parse != save_parse) {
13584        RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13585       }
13586       vFAIL("Expecting '(?flags:(?[...'");
13587      }
13588
13589      /* Recurse, with the meat of the embedded expression */
13590      RExC_parse++;
13591      (void) handle_regex_sets(pRExC_state, &current, flagp,
13592              depth+1, oregcomp_parse);
13593
13594      /* Here, 'current' contains the embedded expression's
13595      * inversion list, and RExC_parse points to the trailing
13596      * ']'; the next character should be the ')' */
13597      RExC_parse++;
13598      assert(RExC_parse < RExC_end && UCHARAT(RExC_parse) == ')');
13599
13600      /* Then the ')' matching the original '(' handled by this
13601      * case: statement */
13602      RExC_parse++;
13603      assert(RExC_parse < RExC_end && UCHARAT(RExC_parse) == ')');
13604
13605      RExC_parse++;
13606      RExC_flags = save_flags;
13607      goto handle_operand;
13608     }
13609
13610     /* A regular '('.  Look behind for illegal syntax */
13611     if (top_index - fence >= 0) {
13612      /* If the top entry on the stack is an operator, it had
13613      * better be a '!', otherwise the entry below the top
13614      * operand should be an operator */
13615      if ( ! (top_ptr = av_fetch(stack, top_index, FALSE))
13616       || (! IS_OPERAND(*top_ptr) && SvUV(*top_ptr) != '!')
13617       || top_index - fence < 1
13618       || ! (stacked_ptr = av_fetch(stack,
13619              top_index - 1,
13620              FALSE))
13621       || IS_OPERAND(*stacked_ptr))
13622      {
13623       RExC_parse++;
13624       vFAIL("Unexpected '(' with no preceding operator");
13625      }
13626     }
13627
13628     /* Stack the position of this undealt-with left paren */
13629     fence = top_index + 1;
13630     av_push(fence_stack, newSViv(fence));
13631     break;
13632
13633    case '\\':
13634     /* regclass() can only return RESTART_UTF8 if multi-char
13635     folds are allowed.  */
13636     if (!regclass(pRExC_state, flagp,depth+1,
13637        TRUE, /* means parse just the next thing */
13638        FALSE, /* don't allow multi-char folds */
13639        FALSE, /* don't silence non-portable warnings.  */
13640        TRUE,  /* strict */
13641        &current))
13642     {
13643      FAIL2("panic: regclass returned NULL to handle_sets, "
13644       "flags=%#"UVxf"", (UV) *flagp);
13645     }
13646
13647     /* regclass() will return with parsing just the \ sequence,
13648     * leaving the parse pointer at the next thing to parse */
13649     RExC_parse--;
13650     goto handle_operand;
13651
13652    case '[':   /* Is a bracketed character class */
13653    {
13654     bool is_posix_class = could_it_be_a_POSIX_class(pRExC_state);
13655
13656     if (! is_posix_class) {
13657      RExC_parse++;
13658     }
13659
13660     /* regclass() can only return RESTART_UTF8 if multi-char
13661     folds are allowed.  */
13662     if(!regclass(pRExC_state, flagp,depth+1,
13663        is_posix_class, /* parse the whole char class
13664             only if not a posix class */
13665        FALSE, /* don't allow multi-char folds */
13666        FALSE, /* don't silence non-portable warnings.  */
13667        TRUE,   /* strict */
13668        &current
13669        ))
13670     {
13671      FAIL2("panic: regclass returned NULL to handle_sets, "
13672       "flags=%#"UVxf"", (UV) *flagp);
13673     }
13674
13675     /* function call leaves parse pointing to the ']', except if we
13676     * faked it */
13677     if (is_posix_class) {
13678      RExC_parse--;
13679     }
13680
13681     goto handle_operand;
13682    }
13683
13684    case ']':
13685     if (top_index >= 1) {
13686      goto join_operators;
13687     }
13688
13689     /* Only a single operand on the stack: are done */
13690     goto done;
13691
13692    case ')':
13693     if (av_tindex(fence_stack) < 0) {
13694      RExC_parse++;
13695      vFAIL("Unexpected ')'");
13696     }
13697
13698     /* If at least two thing on the stack, treat this as an
13699     * operator */
13700     if (top_index - fence >= 1) {
13701      goto join_operators;
13702     }
13703
13704     /* Here only a single thing on the fenced stack, and there is a
13705     * fence.  Get rid of it */
13706     fence_ptr = av_pop(fence_stack);
13707     assert(fence_ptr);
13708     fence = SvIV(fence_ptr) - 1;
13709     SvREFCNT_dec_NN(fence_ptr);
13710     fence_ptr = NULL;
13711
13712     if (fence < 0) {
13713      fence = 0;
13714     }
13715
13716     /* Having gotten rid of the fence, we pop the operand at the
13717     * stack top and process it as a newly encountered operand */
13718     current = av_pop(stack);
13719     assert(IS_OPERAND(current));
13720     goto handle_operand;
13721
13722    case '&':
13723    case '|':
13724    case '+':
13725    case '-':
13726    case '^':
13727
13728     /* These binary operators should have a left operand already
13729     * parsed */
13730     if (   top_index - fence < 0
13731      || top_index - fence == 1
13732      || ( ! (top_ptr = av_fetch(stack, top_index, FALSE)))
13733      || ! IS_OPERAND(*top_ptr))
13734     {
13735      goto unexpected_binary;
13736     }
13737
13738     /* If only the one operand is on the part of the stack visible
13739     * to us, we just place this operator in the proper position */
13740     if (top_index - fence < 2) {
13741
13742      /* Place the operator before the operand */
13743
13744      SV* lhs = av_pop(stack);
13745      av_push(stack, newSVuv(curchar));
13746      av_push(stack, lhs);
13747      break;
13748     }
13749
13750     /* But if there is something else on the stack, we need to
13751     * process it before this new operator if and only if the
13752     * stacked operation has equal or higher precedence than the
13753     * new one */
13754
13755    join_operators:
13756
13757     /* The operator on the stack is supposed to be below both its
13758     * operands */
13759     if (   ! (stacked_ptr = av_fetch(stack, top_index - 2, FALSE))
13760      || IS_OPERAND(*stacked_ptr))
13761     {
13762      /* But if not, it's legal and indicates we are completely
13763      * done if and only if we're currently processing a ']',
13764      * which should be the final thing in the expression */
13765      if (curchar == ']') {
13766       goto done;
13767      }
13768
13769     unexpected_binary:
13770      RExC_parse++;
13771      vFAIL2("Unexpected binary operator '%c' with no "
13772       "preceding operand", curchar);
13773     }
13774     stacked_operator = (char) SvUV(*stacked_ptr);
13775
13776     if (regex_set_precedence(curchar)
13777      > regex_set_precedence(stacked_operator))
13778     {
13779      /* Here, the new operator has higher precedence than the
13780      * stacked one.  This means we need to add the new one to
13781      * the stack to await its rhs operand (and maybe more
13782      * stuff).  We put it before the lhs operand, leaving
13783      * untouched the stacked operator and everything below it
13784      * */
13785      lhs = av_pop(stack);
13786      assert(IS_OPERAND(lhs));
13787
13788      av_push(stack, newSVuv(curchar));
13789      av_push(stack, lhs);
13790      break;
13791     }
13792
13793     /* Here, the new operator has equal or lower precedence than
13794     * what's already there.  This means the operation already
13795     * there should be performed now, before the new one. */
13796     rhs = av_pop(stack);
13797     lhs = av_pop(stack);
13798
13799     assert(IS_OPERAND(rhs));
13800     assert(IS_OPERAND(lhs));
13801
13802     switch (stacked_operator) {
13803      case '&':
13804       _invlist_intersection(lhs, rhs, &rhs);
13805       break;
13806
13807      case '|':
13808      case '+':
13809       _invlist_union(lhs, rhs, &rhs);
13810       break;
13811
13812      case '-':
13813       _invlist_subtract(lhs, rhs, &rhs);
13814       break;
13815
13816      case '^':   /* The union minus the intersection */
13817      {
13818       SV* i = NULL;
13819       SV* u = NULL;
13820       SV* element;
13821
13822       _invlist_union(lhs, rhs, &u);
13823       _invlist_intersection(lhs, rhs, &i);
13824       /* _invlist_subtract will overwrite rhs
13825        without freeing what it already contains */
13826       element = rhs;
13827       _invlist_subtract(u, i, &rhs);
13828       SvREFCNT_dec_NN(i);
13829       SvREFCNT_dec_NN(u);
13830       SvREFCNT_dec_NN(element);
13831       break;
13832      }
13833     }
13834     SvREFCNT_dec(lhs);
13835
13836     /* Here, the higher precedence operation has been done, and the
13837     * result is in 'rhs'.  We overwrite the stacked operator with
13838     * the result.  Then we redo this code to either push the new
13839     * operator onto the stack or perform any higher precedence
13840     * stacked operation */
13841     only_to_avoid_leaks = av_pop(stack);
13842     SvREFCNT_dec(only_to_avoid_leaks);
13843     av_push(stack, rhs);
13844     goto redo_curchar;
13845
13846    case '!':   /* Highest priority, right associative, so just push
13847       onto stack */
13848     av_push(stack, newSVuv(curchar));
13849     break;
13850
13851    default:
13852     RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13853     vFAIL("Unexpected character");
13854
13855   handle_operand:
13856
13857    /* Here 'current' is the operand.  If something is already on the
13858    * stack, we have to check if it is a !. */
13859    top_index = av_tindex(stack);   /* Code above may have altered the
13860            * stack in the time since we
13861            * earlier set 'top_index'. */
13862    if (top_index - fence >= 0) {
13863     /* If the top entry on the stack is an operator, it had better
13864     * be a '!', otherwise the entry below the top operand should
13865     * be an operator */
13866     top_ptr = av_fetch(stack, top_index, FALSE);
13867     assert(top_ptr);
13868     if (! IS_OPERAND(*top_ptr)) {
13869
13870      /* The only permissible operator at the top of the stack is
13871      * '!', which is applied immediately to this operand. */
13872      curchar = (char) SvUV(*top_ptr);
13873      if (curchar != '!') {
13874       SvREFCNT_dec(current);
13875       vFAIL2("Unexpected binary operator '%c' with no "
13876         "preceding operand", curchar);
13877      }
13878
13879      _invlist_invert(current);
13880
13881      only_to_avoid_leaks = av_pop(stack);
13882      SvREFCNT_dec(only_to_avoid_leaks);
13883      top_index = av_tindex(stack);
13884
13885      /* And we redo with the inverted operand.  This allows
13886      * handling multiple ! in a row */
13887      goto handle_operand;
13888     }
13889       /* Single operand is ok only for the non-binary ')'
13890       * operator */
13891     else if ((top_index - fence == 0 && curchar != ')')
13892       || (top_index - fence > 0
13893        && (! (stacked_ptr = av_fetch(stack,
13894               top_index - 1,
13895               FALSE))
13896         || IS_OPERAND(*stacked_ptr))))
13897     {
13898      SvREFCNT_dec(current);
13899      vFAIL("Operand with no preceding operator");
13900     }
13901    }
13902
13903    /* Here there was nothing on the stack or the top element was
13904    * another operand.  Just add this new one */
13905    av_push(stack, current);
13906
13907   } /* End of switch on next parse token */
13908
13909   RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
13910  } /* End of loop parsing through the construct */
13911
13912   done:
13913  if (av_tindex(fence_stack) >= 0) {
13914   vFAIL("Unmatched (");
13915  }
13916
13917  if (av_tindex(stack) < 0   /* Was empty */
13918   || ((final = av_pop(stack)) == NULL)
13919   || ! IS_OPERAND(final)
13920   || av_tindex(stack) >= 0)  /* More left on stack */
13921  {
13922   SvREFCNT_dec(final);
13923   vFAIL("Incomplete expression within '(?[ ])'");
13924  }
13925
13926  /* Here, 'final' is the resultant inversion list from evaluating the
13927  * expression.  Return it if so requested */
13928  if (return_invlist) {
13929   *return_invlist = final;
13930   return END;
13931  }
13932
13933  /* Otherwise generate a resultant node, based on 'final'.  regclass() is
13934  * expecting a string of ranges and individual code points */
13935  invlist_iterinit(final);
13936  result_string = newSVpvs("");
13937  while (invlist_iternext(final, &start, &end)) {
13938   if (start == end) {
13939    Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}", start);
13940   }
13941   else {
13942    Perl_sv_catpvf(aTHX_ result_string, "\\x{%"UVXf"}-\\x{%"UVXf"}",
13943              start,          end);
13944   }
13945  }
13946
13947  /* About to generate an ANYOF (or similar) node from the inversion list we
13948  * have calculated */
13949  save_parse = RExC_parse;
13950  RExC_parse = SvPV(result_string, len);
13951  save_end = RExC_end;
13952  RExC_end = RExC_parse + len;
13953
13954  /* We turn off folding around the call, as the class we have constructed
13955  * already has all folding taken into consideration, and we don't want
13956  * regclass() to add to that */
13957  RExC_flags &= ~RXf_PMf_FOLD;
13958  /* regclass() can only return RESTART_UTF8 if multi-char folds are allowed.
13959  */
13960  node = regclass(pRExC_state, flagp,depth+1,
13961      FALSE, /* means parse the whole char class */
13962      FALSE, /* don't allow multi-char folds */
13963      TRUE, /* silence non-portable warnings.  The above may very
13964        well have generated non-portable code points, but
13965        they're valid on this machine */
13966      FALSE, /* similarly, no need for strict */
13967      NULL
13968     );
13969  if (!node)
13970   FAIL2("panic: regclass returned NULL to handle_sets, flags=%#"UVxf,
13971      PTR2UV(flagp));
13972  if (save_fold) {
13973   RExC_flags |= RXf_PMf_FOLD;
13974  }
13975  RExC_parse = save_parse + 1;
13976  RExC_end = save_end;
13977  SvREFCNT_dec_NN(final);
13978  SvREFCNT_dec_NN(result_string);
13979
13980  nextchar(pRExC_state);
13981  Set_Node_Length(node, RExC_parse - oregcomp_parse + 1); /* MJD */
13982  return node;
13983 }
13984 #undef IS_OPERAND
13985
13986 STATIC void
13987 S_add_above_Latin1_folds(pTHX_ RExC_state_t *pRExC_state, const U8 cp, SV** invlist)
13988 {
13989  /* This hard-codes the Latin1/above-Latin1 folding rules, so that an
13990  * innocent-looking character class, like /[ks]/i won't have to go out to
13991  * disk to find the possible matches.
13992  *
13993  * This should be called only for a Latin1-range code points, cp, which is
13994  * known to be involved in a simple fold with other code points above
13995  * Latin1.  It would give false results if /aa has been specified.
13996  * Multi-char folds are outside the scope of this, and must be handled
13997  * specially.
13998  *
13999  * XXX It would be better to generate these via regen, in case a new
14000  * version of the Unicode standard adds new mappings, though that is not
14001  * really likely, and may be caught by the default: case of the switch
14002  * below. */
14003
14004  PERL_ARGS_ASSERT_ADD_ABOVE_LATIN1_FOLDS;
14005
14006  assert(HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(cp));
14007
14008  switch (cp) {
14009   case 'k':
14010   case 'K':
14011   *invlist =
14012    add_cp_to_invlist(*invlist, KELVIN_SIGN);
14013    break;
14014   case 's':
14015   case 'S':
14016   *invlist = add_cp_to_invlist(*invlist, LATIN_SMALL_LETTER_LONG_S);
14017    break;
14018   case MICRO_SIGN:
14019   *invlist = add_cp_to_invlist(*invlist, GREEK_CAPITAL_LETTER_MU);
14020   *invlist = add_cp_to_invlist(*invlist, GREEK_SMALL_LETTER_MU);
14021    break;
14022   case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
14023   case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
14024   *invlist = add_cp_to_invlist(*invlist, ANGSTROM_SIGN);
14025    break;
14026   case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
14027   *invlist = add_cp_to_invlist(*invlist,
14028           LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
14029    break;
14030   case LATIN_SMALL_LETTER_SHARP_S:
14031   *invlist = add_cp_to_invlist(*invlist, LATIN_CAPITAL_LETTER_SHARP_S);
14032    break;
14033   default:
14034    /* Use deprecated warning to increase the chances of this being
14035    * output */
14036    if (PASS2) {
14037     ckWARN2reg_d(RExC_parse, "Perl folding rules are not up-to-date for 0x%02X; please use the perlbug utility to report;", cp);
14038    }
14039    break;
14040  }
14041 }
14042
14043 STATIC AV *
14044 S_add_multi_match(pTHX_ AV* multi_char_matches, SV* multi_string, const STRLEN cp_count)
14045 {
14046  /* This adds the string scalar <multi_string> to the array
14047  * <multi_char_matches>.  <multi_string> is known to have exactly
14048  * <cp_count> code points in it.  This is used when constructing a
14049  * bracketed character class and we find something that needs to match more
14050  * than a single character.
14051  *
14052  * <multi_char_matches> is actually an array of arrays.  Each top-level
14053  * element is an array that contains all the strings known so far that are
14054  * the same length.  And that length (in number of code points) is the same
14055  * as the index of the top-level array.  Hence, the [2] element is an
14056  * array, each element thereof is a string containing TWO code points;
14057  * while element [3] is for strings of THREE characters, and so on.  Since
14058  * this is for multi-char strings there can never be a [0] nor [1] element.
14059  *
14060  * When we rewrite the character class below, we will do so such that the
14061  * longest strings are written first, so that it prefers the longest
14062  * matching strings first.  This is done even if it turns out that any
14063  * quantifier is non-greedy, out of this programmer's (khw) laziness.  Tom
14064  * Christiansen has agreed that this is ok.  This makes the test for the
14065  * ligature 'ffi' come before the test for 'ff', for example */
14066
14067  AV* this_array;
14068  AV** this_array_ptr;
14069
14070  PERL_ARGS_ASSERT_ADD_MULTI_MATCH;
14071
14072  if (! multi_char_matches) {
14073   multi_char_matches = newAV();
14074  }
14075
14076  if (av_exists(multi_char_matches, cp_count)) {
14077   this_array_ptr = (AV**) av_fetch(multi_char_matches, cp_count, FALSE);
14078   this_array = *this_array_ptr;
14079  }
14080  else {
14081   this_array = newAV();
14082   av_store(multi_char_matches, cp_count,
14083     (SV*) this_array);
14084  }
14085  av_push(this_array, multi_string);
14086
14087  return multi_char_matches;
14088 }
14089
14090 /* The names of properties whose definitions are not known at compile time are
14091  * stored in this SV, after a constant heading.  So if the length has been
14092  * changed since initialization, then there is a run-time definition. */
14093 #define HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION                            \
14094           (SvCUR(listsv) != initial_listsv_len)
14095
14096 STATIC regnode *
14097 S_regclass(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth,
14098     const bool stop_at_1,  /* Just parse the next thing, don't
14099           look for a full character class */
14100     bool allow_multi_folds,
14101     const bool silence_non_portable,   /* Don't output warnings
14102              about too large
14103              characters */
14104     const bool strict,
14105     SV** ret_invlist  /* Return an inversion list, not a node */
14106   )
14107 {
14108  /* parse a bracketed class specification.  Most of these will produce an
14109  * ANYOF node; but something like [a] will produce an EXACT node; [aA], an
14110  * EXACTFish node; [[:ascii:]], a POSIXA node; etc.  It is more complex
14111  * under /i with multi-character folds: it will be rewritten following the
14112  * paradigm of this example, where the <multi-fold>s are characters which
14113  * fold to multiple character sequences:
14114  *      /[abc\x{multi-fold1}def\x{multi-fold2}ghi]/i
14115  * gets effectively rewritten as:
14116  *      /(?:\x{multi-fold1}|\x{multi-fold2}|[abcdefghi]/i
14117  * reg() gets called (recursively) on the rewritten version, and this
14118  * function will return what it constructs.  (Actually the <multi-fold>s
14119  * aren't physically removed from the [abcdefghi], it's just that they are
14120  * ignored in the recursion by means of a flag:
14121  * <RExC_in_multi_char_class>.)
14122  *
14123  * ANYOF nodes contain a bit map for the first NUM_ANYOF_CODE_POINTS
14124  * characters, with the corresponding bit set if that character is in the
14125  * list.  For characters above this, a range list or swash is used.  There
14126  * are extra bits for \w, etc. in locale ANYOFs, as what these match is not
14127  * determinable at compile time
14128  *
14129  * Returns NULL, setting *flagp to RESTART_UTF8 if the sizing scan needs
14130  * to be restarted.  This can only happen if ret_invlist is non-NULL.
14131  */
14132
14133  UV prevvalue = OOB_UNICODE, save_prevvalue = OOB_UNICODE;
14134  IV range = 0;
14135  UV value = OOB_UNICODE, save_value = OOB_UNICODE;
14136  regnode *ret;
14137  STRLEN numlen;
14138  IV namedclass = OOB_NAMEDCLASS;
14139  char *rangebegin = NULL;
14140  bool need_class = 0;
14141  SV *listsv = NULL;
14142  STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
14143          than just initialized.  */
14144  SV* properties = NULL;    /* Code points that match \p{} \P{} */
14145  SV* posixes = NULL;     /* Code points that match classes like [:word:],
14146        extended beyond the Latin1 range.  These have to
14147        be kept separate from other code points for much
14148        of this function because their handling  is
14149        different under /i, and for most classes under
14150        /d as well */
14151  SV* nposixes = NULL;    /* Similarly for [:^word:].  These are kept
14152        separate for a while from the non-complemented
14153        versions because of complications with /d
14154        matching */
14155  SV* simple_posixes = NULL; /* But under some conditions, the classes can be
14156         treated more simply than the general case,
14157         leading to less compilation and execution
14158         work */
14159  UV element_count = 0;   /* Number of distinct elements in the class.
14160        Optimizations may be possible if this is tiny */
14161  AV * multi_char_matches = NULL; /* Code points that fold to more than one
14162          character; used under /i */
14163  UV n;
14164  char * stop_ptr = RExC_end;    /* where to stop parsing */
14165  const bool skip_white = cBOOL(ret_invlist); /* ignore unescaped white
14166             space? */
14167
14168  /* Unicode properties are stored in a swash; this holds the current one
14169  * being parsed.  If this swash is the only above-latin1 component of the
14170  * character class, an optimization is to pass it directly on to the
14171  * execution engine.  Otherwise, it is set to NULL to indicate that there
14172  * are other things in the class that have to be dealt with at execution
14173  * time */
14174  SV* swash = NULL;  /* Code points that match \p{} \P{} */
14175
14176  /* Set if a component of this character class is user-defined; just passed
14177  * on to the engine */
14178  bool has_user_defined_property = FALSE;
14179
14180  /* inversion list of code points this node matches only when the target
14181  * string is in UTF-8.  (Because is under /d) */
14182  SV* depends_list = NULL;
14183
14184  /* Inversion list of code points this node matches regardless of things
14185  * like locale, folding, utf8ness of the target string */
14186  SV* cp_list = NULL;
14187
14188  /* Like cp_list, but code points on this list need to be checked for things
14189  * that fold to/from them under /i */
14190  SV* cp_foldable_list = NULL;
14191
14192  /* Like cp_list, but code points on this list are valid only when the
14193  * runtime locale is UTF-8 */
14194  SV* only_utf8_locale_list = NULL;
14195
14196  /* In a range, if one of the endpoints is non-character-set portable,
14197  * meaning that it hard-codes a code point that may mean a different
14198  * charactger in ASCII vs. EBCDIC, as opposed to, say, a literal 'A' or a
14199  * mnemonic '\t' which each mean the same character no matter which
14200  * character set the platform is on. */
14201  unsigned int non_portable_endpoint = 0;
14202
14203  /* Is the range unicode? which means on a platform that isn't 1-1 native
14204  * to Unicode (i.e. non-ASCII), each code point in it should be considered
14205  * to be a Unicode value.  */
14206  bool unicode_range = FALSE;
14207  bool invert = FALSE;    /* Is this class to be complemented */
14208
14209  bool warn_super = ALWAYS_WARN_SUPER;
14210
14211  regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
14212   case we need to change the emitted regop to an EXACT. */
14213  const char * orig_parse = RExC_parse;
14214  const SSize_t orig_size = RExC_size;
14215  bool posixl_matches_all = FALSE; /* Does /l class have both e.g. \W,\w ? */
14216  GET_RE_DEBUG_FLAGS_DECL;
14217
14218  PERL_ARGS_ASSERT_REGCLASS;
14219 #ifndef DEBUGGING
14220  PERL_UNUSED_ARG(depth);
14221 #endif
14222
14223  DEBUG_PARSE("clas");
14224
14225  /* Assume we are going to generate an ANYOF node. */
14226  ret = reganode(pRExC_state,
14227     (LOC)
14228      ? ANYOFL
14229      : ANYOF,
14230     0);
14231
14232  if (SIZE_ONLY) {
14233   RExC_size += ANYOF_SKIP;
14234   listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
14235  }
14236  else {
14237   ANYOF_FLAGS(ret) = 0;
14238
14239   RExC_emit += ANYOF_SKIP;
14240   listsv = newSVpvs_flags("# comment\n", SVs_TEMP);
14241   initial_listsv_len = SvCUR(listsv);
14242   SvTEMP_off(listsv); /* Grr, TEMPs and mortals are conflated.  */
14243  }
14244
14245  if (skip_white) {
14246   RExC_parse = regpatws(pRExC_state, RExC_parse,
14247        FALSE /* means don't recognize comments */ );
14248  }
14249
14250  if (UCHARAT(RExC_parse) == '^') { /* Complement of range. */
14251   RExC_parse++;
14252   invert = TRUE;
14253   allow_multi_folds = FALSE;
14254   MARK_NAUGHTY(1);
14255   if (skip_white) {
14256    RExC_parse = regpatws(pRExC_state, RExC_parse,
14257         FALSE /* means don't recognize comments */ );
14258   }
14259  }
14260
14261  /* Check that they didn't say [:posix:] instead of [[:posix:]] */
14262  if (!SIZE_ONLY && RExC_parse < RExC_end && POSIXCC(UCHARAT(RExC_parse))) {
14263   const char *s = RExC_parse;
14264   const char  c = *s++;
14265
14266   if (*s == '^') {
14267    s++;
14268   }
14269   while (isWORDCHAR(*s))
14270    s++;
14271   if (*s && c == *s && s[1] == ']') {
14272    SAVEFREESV(RExC_rx_sv);
14273    ckWARN3reg(s+2,
14274      "POSIX syntax [%c %c] belongs inside character classes",
14275      c, c);
14276    (void)ReREFCNT_inc(RExC_rx_sv);
14277   }
14278  }
14279
14280  /* If the caller wants us to just parse a single element, accomplish this
14281  * by faking the loop ending condition */
14282  if (stop_at_1 && RExC_end > RExC_parse) {
14283   stop_ptr = RExC_parse + 1;
14284  }
14285
14286  /* allow 1st char to be ']' (allowing it to be '-' is dealt with later) */
14287  if (UCHARAT(RExC_parse) == ']')
14288   goto charclassloop;
14289
14290  while (1) {
14291   if  (RExC_parse >= stop_ptr) {
14292    break;
14293   }
14294
14295   if (skip_white) {
14296    RExC_parse = regpatws(pRExC_state, RExC_parse,
14297         FALSE /* means don't recognize comments */ );
14298   }
14299
14300   if  (UCHARAT(RExC_parse) == ']') {
14301    break;
14302   }
14303
14304  charclassloop:
14305
14306   namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
14307   save_value = value;
14308   save_prevvalue = prevvalue;
14309
14310   if (!range) {
14311    rangebegin = RExC_parse;
14312    element_count++;
14313    non_portable_endpoint = 0;
14314   }
14315   if (UTF) {
14316    value = utf8n_to_uvchr((U8*)RExC_parse,
14317         RExC_end - RExC_parse,
14318         &numlen, UTF8_ALLOW_DEFAULT);
14319    RExC_parse += numlen;
14320   }
14321   else
14322    value = UCHARAT(RExC_parse++);
14323
14324   if (value == '['
14325    && RExC_parse < RExC_end
14326    && POSIXCC(UCHARAT(RExC_parse)))
14327   {
14328    namedclass = regpposixcc(pRExC_state, value, strict);
14329   }
14330   else if (value == '\\') {
14331    /* Is a backslash; get the code point of the char after it */
14332    if (UTF && ! UTF8_IS_INVARIANT(UCHARAT(RExC_parse))) {
14333     value = utf8n_to_uvchr((U8*)RExC_parse,
14334         RExC_end - RExC_parse,
14335         &numlen, UTF8_ALLOW_DEFAULT);
14336     RExC_parse += numlen;
14337    }
14338    else
14339     value = UCHARAT(RExC_parse++);
14340
14341    /* Some compilers cannot handle switching on 64-bit integer
14342    * values, therefore value cannot be an UV.  Yes, this will
14343    * be a problem later if we want switch on Unicode.
14344    * A similar issue a little bit later when switching on
14345    * namedclass. --jhi */
14346
14347    /* If the \ is escaping white space when white space is being
14348    * skipped, it means that that white space is wanted literally, and
14349    * is already in 'value'.  Otherwise, need to translate the escape
14350    * into what it signifies. */
14351    if (! skip_white || ! is_PATWS_cp(value)) switch ((I32)value) {
14352
14353    case 'w': namedclass = ANYOF_WORDCHAR; break;
14354    case 'W': namedclass = ANYOF_NWORDCHAR; break;
14355    case 's': namedclass = ANYOF_SPACE; break;
14356    case 'S': namedclass = ANYOF_NSPACE; break;
14357    case 'd': namedclass = ANYOF_DIGIT; break;
14358    case 'D': namedclass = ANYOF_NDIGIT; break;
14359    case 'v': namedclass = ANYOF_VERTWS; break;
14360    case 'V': namedclass = ANYOF_NVERTWS; break;
14361    case 'h': namedclass = ANYOF_HORIZWS; break;
14362    case 'H': namedclass = ANYOF_NHORIZWS; break;
14363    case 'N':  /* Handle \N{NAME} in class */
14364     {
14365      const char * const backslash_N_beg = RExC_parse - 2;
14366      int cp_count;
14367
14368      if (! grok_bslash_N(pRExC_state,
14369           NULL,      /* No regnode */
14370           &value,    /* Yes single value */
14371           &cp_count, /* Multiple code pt count */
14372           flagp,
14373           depth)
14374      ) {
14375
14376       if (*flagp & RESTART_UTF8)
14377        FAIL("panic: grok_bslash_N set RESTART_UTF8");
14378
14379       if (cp_count < 0) {
14380        vFAIL("\\N in a character class must be a named character: \\N{...}");
14381       }
14382       else if (cp_count == 0) {
14383        if (strict) {
14384         RExC_parse++;   /* Position after the "}" */
14385         vFAIL("Zero length \\N{}");
14386        }
14387        else if (PASS2) {
14388         ckWARNreg(RExC_parse,
14389           "Ignoring zero length \\N{} in character class");
14390        }
14391       }
14392       else { /* cp_count > 1 */
14393        if (! RExC_in_multi_char_class) {
14394         if (invert || range || *RExC_parse == '-') {
14395          if (strict) {
14396           RExC_parse--;
14397           vFAIL("\\N{} in inverted character class or as a range end-point is restricted to one character");
14398          }
14399          else if (PASS2) {
14400           ckWARNreg(RExC_parse, "Using just the first character returned by \\N{} in character class");
14401          }
14402          break; /* <value> contains the first code
14403            point. Drop out of the switch to
14404            process it */
14405         }
14406         else {
14407          SV * multi_char_N = newSVpvn(backslash_N_beg,
14408             RExC_parse - backslash_N_beg);
14409          multi_char_matches
14410           = add_multi_match(multi_char_matches,
14411               multi_char_N,
14412               cp_count);
14413         }
14414        }
14415       } /* End of cp_count != 1 */
14416
14417       /* This element should not be processed further in this
14418       * class */
14419       element_count--;
14420       value = save_value;
14421       prevvalue = save_prevvalue;
14422       continue;   /* Back to top of loop to get next char */
14423      }
14424
14425      /* Here, is a single code point, and <value> contains it */
14426      unicode_range = TRUE;   /* \N{} are Unicode */
14427     }
14428     break;
14429    case 'p':
14430    case 'P':
14431     {
14432     char *e;
14433
14434     /* We will handle any undefined properties ourselves */
14435     U8 swash_init_flags = _CORE_SWASH_INIT_RETURN_IF_UNDEF
14436          /* And we actually would prefer to get
14437           * the straight inversion list of the
14438           * swash, since we will be accessing it
14439           * anyway, to save a little time */
14440          |_CORE_SWASH_INIT_ACCEPT_INVLIST;
14441
14442     if (RExC_parse >= RExC_end)
14443      vFAIL2("Empty \\%c{}", (U8)value);
14444     if (*RExC_parse == '{') {
14445      const U8 c = (U8)value;
14446      e = strchr(RExC_parse++, '}');
14447      if (!e)
14448       vFAIL2("Missing right brace on \\%c{}", c);
14449      while (isSPACE(*RExC_parse))
14450       RExC_parse++;
14451      if (e == RExC_parse)
14452       vFAIL2("Empty \\%c{}", c);
14453      n = e - RExC_parse;
14454      while (isSPACE(*(RExC_parse + n - 1)))
14455       n--;
14456     }
14457     else {
14458      e = RExC_parse;
14459      n = 1;
14460     }
14461     if (!SIZE_ONLY) {
14462      SV* invlist;
14463      char* name;
14464
14465      if (UCHARAT(RExC_parse) == '^') {
14466       RExC_parse++;
14467       n--;
14468       /* toggle.  (The rhs xor gets the single bit that
14469       * differs between P and p; the other xor inverts just
14470       * that bit) */
14471       value ^= 'P' ^ 'p';
14472
14473       while (isSPACE(*RExC_parse)) {
14474        RExC_parse++;
14475        n--;
14476       }
14477      }
14478      /* Try to get the definition of the property into
14479      * <invlist>.  If /i is in effect, the effective property
14480      * will have its name be <__NAME_i>.  The design is
14481      * discussed in commit
14482      * 2f833f5208e26b208886e51e09e2c072b5eabb46 */
14483      name = savepv(Perl_form(aTHX_
14484           "%s%.*s%s\n",
14485           (FOLD) ? "__" : "",
14486           (int)n,
14487           RExC_parse,
14488           (FOLD) ? "_i" : ""
14489         ));
14490
14491      /* Look up the property name, and get its swash and
14492      * inversion list, if the property is found  */
14493      if (swash) {
14494       SvREFCNT_dec_NN(swash);
14495      }
14496      swash = _core_swash_init("utf8", name, &PL_sv_undef,
14497            1, /* binary */
14498            0, /* not tr/// */
14499            NULL, /* No inversion list */
14500            &swash_init_flags
14501            );
14502      if (! swash || ! (invlist = _get_swash_invlist(swash))) {
14503       HV* curpkg = (IN_PERL_COMPILETIME)
14504          ? PL_curstash
14505          : CopSTASH(PL_curcop);
14506       if (swash) {
14507        SvREFCNT_dec_NN(swash);
14508        swash = NULL;
14509       }
14510
14511       /* Here didn't find it.  It could be a user-defined
14512       * property that will be available at run-time.  If we
14513       * accept only compile-time properties, is an error;
14514       * otherwise add it to the list for run-time look up */
14515       if (ret_invlist) {
14516        RExC_parse = e + 1;
14517        vFAIL2utf8f(
14518         "Property '%"UTF8f"' is unknown",
14519         UTF8fARG(UTF, n, name));
14520       }
14521
14522       /* If the property name doesn't already have a package
14523       * name, add the current one to it so that it can be
14524       * referred to outside it. [perl #121777] */
14525       if (curpkg && ! instr(name, "::")) {
14526        char* pkgname = HvNAME(curpkg);
14527        if (strNE(pkgname, "main")) {
14528         char* full_name = Perl_form(aTHX_
14529                "%s::%s",
14530                pkgname,
14531                name);
14532         n = strlen(full_name);
14533         Safefree(name);
14534         name = savepvn(full_name, n);
14535        }
14536       }
14537       Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%"UTF8f"\n",
14538           (value == 'p' ? '+' : '!'),
14539           UTF8fARG(UTF, n, name));
14540       has_user_defined_property = TRUE;
14541
14542       /* We don't know yet, so have to assume that the
14543       * property could match something in the Latin1 range,
14544       * hence something that isn't utf8.  Note that this
14545       * would cause things in <depends_list> to match
14546       * inappropriately, except that any \p{}, including
14547       * this one forces Unicode semantics, which means there
14548       * is no <depends_list> */
14549       ANYOF_FLAGS(ret)
14550          |= ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES;
14551      }
14552      else {
14553
14554       /* Here, did get the swash and its inversion list.  If
14555       * the swash is from a user-defined property, then this
14556       * whole character class should be regarded as such */
14557       if (swash_init_flags
14558        & _CORE_SWASH_INIT_USER_DEFINED_PROPERTY)
14559       {
14560        has_user_defined_property = TRUE;
14561       }
14562       else if
14563        /* We warn on matching an above-Unicode code point
14564        * if the match would return true, except don't
14565        * warn for \p{All}, which has exactly one element
14566        * = 0 */
14567        (_invlist_contains_cp(invlist, 0x110000)
14568         && (! (_invlist_len(invlist) == 1
14569          && *invlist_array(invlist) == 0)))
14570       {
14571        warn_super = TRUE;
14572       }
14573
14574
14575       /* Invert if asking for the complement */
14576       if (value == 'P') {
14577        _invlist_union_complement_2nd(properties,
14578               invlist,
14579               &properties);
14580
14581        /* The swash can't be used as-is, because we've
14582        * inverted things; delay removing it to here after
14583        * have copied its invlist above */
14584        SvREFCNT_dec_NN(swash);
14585        swash = NULL;
14586       }
14587       else {
14588        _invlist_union(properties, invlist, &properties);
14589       }
14590      }
14591      Safefree(name);
14592     }
14593     RExC_parse = e + 1;
14594     namedclass = ANYOF_UNIPROP;  /* no official name, but it's
14595             named */
14596
14597     /* \p means they want Unicode semantics */
14598     RExC_uni_semantics = 1;
14599     }
14600     break;
14601    case 'n': value = '\n';   break;
14602    case 'r': value = '\r';   break;
14603    case 't': value = '\t';   break;
14604    case 'f': value = '\f';   break;
14605    case 'b': value = '\b';   break;
14606    case 'e': value = ESC_NATIVE;             break;
14607    case 'a': value = '\a';                   break;
14608    case 'o':
14609     RExC_parse--; /* function expects to be pointed at the 'o' */
14610     {
14611      const char* error_msg;
14612      bool valid = grok_bslash_o(&RExC_parse,
14613            &value,
14614            &error_msg,
14615            PASS2,   /* warnings only in
14616               pass 2 */
14617            strict,
14618            silence_non_portable,
14619            UTF);
14620      if (! valid) {
14621       vFAIL(error_msg);
14622      }
14623     }
14624     non_portable_endpoint++;
14625     if (IN_ENCODING && value < 0x100) {
14626      goto recode_encoding;
14627     }
14628     break;
14629    case 'x':
14630     RExC_parse--; /* function expects to be pointed at the 'x' */
14631     {
14632      const char* error_msg;
14633      bool valid = grok_bslash_x(&RExC_parse,
14634            &value,
14635            &error_msg,
14636            PASS2, /* Output warnings */
14637            strict,
14638            silence_non_portable,
14639            UTF);
14640      if (! valid) {
14641       vFAIL(error_msg);
14642      }
14643     }
14644     non_portable_endpoint++;
14645     if (IN_ENCODING && value < 0x100)
14646      goto recode_encoding;
14647     break;
14648    case 'c':
14649     value = grok_bslash_c(*RExC_parse++, PASS2);
14650     non_portable_endpoint++;
14651     break;
14652    case '0': case '1': case '2': case '3': case '4':
14653    case '5': case '6': case '7':
14654     {
14655      /* Take 1-3 octal digits */
14656      I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
14657      numlen = (strict) ? 4 : 3;
14658      value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
14659      RExC_parse += numlen;
14660      if (numlen != 3) {
14661       if (strict) {
14662        RExC_parse += (UTF) ? UTF8SKIP(RExC_parse) : 1;
14663        vFAIL("Need exactly 3 octal digits");
14664       }
14665       else if (! SIZE_ONLY /* like \08, \178 */
14666         && numlen < 3
14667         && RExC_parse < RExC_end
14668         && isDIGIT(*RExC_parse)
14669         && ckWARN(WARN_REGEXP))
14670       {
14671        SAVEFREESV(RExC_rx_sv);
14672        reg_warn_non_literal_string(
14673         RExC_parse + 1,
14674         form_short_octal_warning(RExC_parse, numlen));
14675        (void)ReREFCNT_inc(RExC_rx_sv);
14676       }
14677      }
14678      non_portable_endpoint++;
14679      if (IN_ENCODING && value < 0x100)
14680       goto recode_encoding;
14681      break;
14682     }
14683    recode_encoding:
14684     if (! RExC_override_recoding) {
14685      SV* enc = _get_encoding();
14686      value = reg_recode((const char)(U8)value, &enc);
14687      if (!enc) {
14688       if (strict) {
14689        vFAIL("Invalid escape in the specified encoding");
14690       }
14691       else if (PASS2) {
14692        ckWARNreg(RExC_parse,
14693         "Invalid escape in the specified encoding");
14694       }
14695      }
14696      break;
14697     }
14698    default:
14699     /* Allow \_ to not give an error */
14700     if (!SIZE_ONLY && isWORDCHAR(value) && value != '_') {
14701      if (strict) {
14702       vFAIL2("Unrecognized escape \\%c in character class",
14703        (int)value);
14704      }
14705      else {
14706       SAVEFREESV(RExC_rx_sv);
14707       ckWARN2reg(RExC_parse,
14708        "Unrecognized escape \\%c in character class passed through",
14709        (int)value);
14710       (void)ReREFCNT_inc(RExC_rx_sv);
14711      }
14712     }
14713     break;
14714    }   /* End of switch on char following backslash */
14715   } /* end of handling backslash escape sequences */
14716
14717   /* Here, we have the current token in 'value' */
14718
14719   if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
14720    U8 classnum;
14721
14722    /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
14723    * literal, as is the character that began the false range, i.e.
14724    * the 'a' in the examples */
14725    if (range) {
14726     if (!SIZE_ONLY) {
14727      const int w = (RExC_parse >= rangebegin)
14728         ? RExC_parse - rangebegin
14729         : 0;
14730      if (strict) {
14731       vFAIL2utf8f(
14732        "False [] range \"%"UTF8f"\"",
14733        UTF8fARG(UTF, w, rangebegin));
14734      }
14735      else {
14736       SAVEFREESV(RExC_rx_sv); /* in case of fatal warnings */
14737       ckWARN2reg(RExC_parse,
14738        "False [] range \"%"UTF8f"\"",
14739        UTF8fARG(UTF, w, rangebegin));
14740       (void)ReREFCNT_inc(RExC_rx_sv);
14741       cp_list = add_cp_to_invlist(cp_list, '-');
14742       cp_foldable_list = add_cp_to_invlist(cp_foldable_list,
14743                prevvalue);
14744      }
14745     }
14746
14747     range = 0; /* this was not a true range */
14748     element_count += 2; /* So counts for three values */
14749    }
14750
14751    classnum = namedclass_to_classnum(namedclass);
14752
14753    if (LOC && namedclass < ANYOF_POSIXL_MAX
14754 #ifndef HAS_ISASCII
14755     && classnum != _CC_ASCII
14756 #endif
14757    ) {
14758     /* What the Posix classes (like \w, [:space:]) match in locale
14759     * isn't knowable under locale until actual match time.  Room
14760     * must be reserved (one time per outer bracketed class) to
14761     * store such classes.  The space will contain a bit for each
14762     * named class that is to be matched against.  This isn't
14763     * needed for \p{} and pseudo-classes, as they are not affected
14764     * by locale, and hence are dealt with separately */
14765     if (! need_class) {
14766      need_class = 1;
14767      if (SIZE_ONLY) {
14768       RExC_size += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
14769      }
14770      else {
14771       RExC_emit += ANYOF_POSIXL_SKIP - ANYOF_SKIP;
14772      }
14773      ANYOF_FLAGS(ret) |= ANYOF_MATCHES_POSIXL;
14774      ANYOF_POSIXL_ZERO(ret);
14775     }
14776
14777     /* Coverity thinks it is possible for this to be negative; both
14778     * jhi and khw think it's not, but be safer */
14779     assert(! (ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
14780      || (namedclass + ((namedclass % 2) ? -1 : 1)) >= 0);
14781
14782     /* See if it already matches the complement of this POSIX
14783     * class */
14784     if ((ANYOF_FLAGS(ret) & ANYOF_MATCHES_POSIXL)
14785      && ANYOF_POSIXL_TEST(ret, namedclass + ((namedclass % 2)
14786                ? -1
14787                : 1)))
14788     {
14789      posixl_matches_all = TRUE;
14790      break;  /* No need to continue.  Since it matches both
14791        e.g., \w and \W, it matches everything, and the
14792        bracketed class can be optimized into qr/./s */
14793     }
14794
14795     /* Add this class to those that should be checked at runtime */
14796     ANYOF_POSIXL_SET(ret, namedclass);
14797
14798     /* The above-Latin1 characters are not subject to locale rules.
14799     * Just add them, in the second pass, to the
14800     * unconditionally-matched list */
14801     if (! SIZE_ONLY) {
14802      SV* scratch_list = NULL;
14803
14804      /* Get the list of the above-Latin1 code points this
14805      * matches */
14806      _invlist_intersection_maybe_complement_2nd(PL_AboveLatin1,
14807           PL_XPosix_ptrs[classnum],
14808
14809           /* Odd numbers are complements, like
14810           * NDIGIT, NASCII, ... */
14811           namedclass % 2 != 0,
14812           &scratch_list);
14813      /* Checking if 'cp_list' is NULL first saves an extra
14814      * clone.  Its reference count will be decremented at the
14815      * next union, etc, or if this is the only instance, at the
14816      * end of the routine */
14817      if (! cp_list) {
14818       cp_list = scratch_list;
14819      }
14820      else {
14821       _invlist_union(cp_list, scratch_list, &cp_list);
14822       SvREFCNT_dec_NN(scratch_list);
14823      }
14824      continue;   /* Go get next character */
14825     }
14826    }
14827    else if (! SIZE_ONLY) {
14828
14829     /* Here, not in pass1 (in that pass we skip calculating the
14830     * contents of this class), and is /l, or is a POSIX class for
14831     * which /l doesn't matter (or is a Unicode property, which is
14832     * skipped here). */
14833     if (namedclass >= ANYOF_POSIXL_MAX) {  /* If a special class */
14834      if (namedclass != ANYOF_UNIPROP) { /* UNIPROP = \p and \P */
14835
14836       /* Here, should be \h, \H, \v, or \V.  None of /d, /i
14837       * nor /l make a difference in what these match,
14838       * therefore we just add what they match to cp_list. */
14839       if (classnum != _CC_VERTSPACE) {
14840        assert(   namedclass == ANYOF_HORIZWS
14841         || namedclass == ANYOF_NHORIZWS);
14842
14843        /* It turns out that \h is just a synonym for
14844        * XPosixBlank */
14845        classnum = _CC_BLANK;
14846       }
14847
14848       _invlist_union_maybe_complement_2nd(
14849         cp_list,
14850         PL_XPosix_ptrs[classnum],
14851         namedclass % 2 != 0,    /* Complement if odd
14852               (NHORIZWS, NVERTWS)
14853               */
14854         &cp_list);
14855      }
14856     }
14857     else if (UNI_SEMANTICS
14858       || classnum == _CC_ASCII
14859       || (DEPENDS_SEMANTICS && (classnum == _CC_DIGIT
14860             || classnum == _CC_XDIGIT)))
14861     {
14862      /* We usually have to worry about /d and /a affecting what
14863      * POSIX classes match, with special code needed for /d
14864      * because we won't know until runtime what all matches.
14865      * But there is no extra work needed under /u, and
14866      * [:ascii:] is unaffected by /a and /d; and :digit: and
14867      * :xdigit: don't have runtime differences under /d.  So we
14868      * can special case these, and avoid some extra work below,
14869      * and at runtime. */
14870      _invlist_union_maybe_complement_2nd(
14871              simple_posixes,
14872              PL_XPosix_ptrs[classnum],
14873              namedclass % 2 != 0,
14874              &simple_posixes);
14875     }
14876     else {  /* Garden variety class.  If is NUPPER, NALPHA, ...
14877       complement and use nposixes */
14878      SV** posixes_ptr = namedclass % 2 == 0
14879          ? &posixes
14880          : &nposixes;
14881      _invlist_union_maybe_complement_2nd(
14882              *posixes_ptr,
14883              PL_XPosix_ptrs[classnum],
14884              namedclass % 2 != 0,
14885              posixes_ptr);
14886     }
14887    }
14888   } /* end of namedclass \blah */
14889
14890   if (skip_white) {
14891    RExC_parse = regpatws(pRExC_state, RExC_parse,
14892         FALSE /* means don't recognize comments */ );
14893   }
14894
14895   /* If 'range' is set, 'value' is the ending of a range--check its
14896   * validity.  (If value isn't a single code point in the case of a
14897   * range, we should have figured that out above in the code that
14898   * catches false ranges).  Later, we will handle each individual code
14899   * point in the range.  If 'range' isn't set, this could be the
14900   * beginning of a range, so check for that by looking ahead to see if
14901   * the next real character to be processed is the range indicator--the
14902   * minus sign */
14903
14904   if (range) {
14905 #ifdef EBCDIC
14906    /* For unicode ranges, we have to test that the Unicode as opposed
14907    * to the native values are not decreasing.  (Above 255, there is
14908    * no difference between native and Unicode) */
14909    if (unicode_range && prevvalue < 255 && value < 255) {
14910     if (NATIVE_TO_LATIN1(prevvalue) > NATIVE_TO_LATIN1(value)) {
14911      goto backwards_range;
14912     }
14913    }
14914    else
14915 #endif
14916    if (prevvalue > value) /* b-a */ {
14917     int w;
14918 #ifdef EBCDIC
14919    backwards_range:
14920 #endif
14921     w = RExC_parse - rangebegin;
14922     vFAIL2utf8f(
14923      "Invalid [] range \"%"UTF8f"\"",
14924      UTF8fARG(UTF, w, rangebegin));
14925     NOT_REACHED; /* NOTREACHED */
14926    }
14927   }
14928   else {
14929    prevvalue = value; /* save the beginning of the potential range */
14930    if (! stop_at_1     /* Can't be a range if parsing just one thing */
14931     && *RExC_parse == '-')
14932    {
14933     char* next_char_ptr = RExC_parse + 1;
14934     if (skip_white) {   /* Get the next real char after the '-' */
14935      next_char_ptr = regpatws(pRExC_state,
14936            RExC_parse + 1,
14937            FALSE); /* means don't recognize
14938               comments */
14939     }
14940
14941     /* If the '-' is at the end of the class (just before the ']',
14942     * it is a literal minus; otherwise it is a range */
14943     if (next_char_ptr < RExC_end && *next_char_ptr != ']') {
14944      RExC_parse = next_char_ptr;
14945
14946      /* a bad range like \w-, [:word:]- ? */
14947      if (namedclass > OOB_NAMEDCLASS) {
14948       if (strict || (PASS2 && ckWARN(WARN_REGEXP))) {
14949        const int w = RExC_parse >= rangebegin
14950           ?  RExC_parse - rangebegin
14951           : 0;
14952        if (strict) {
14953         vFAIL4("False [] range \"%*.*s\"",
14954          w, w, rangebegin);
14955        }
14956        else if (PASS2) {
14957         vWARN4(RExC_parse,
14958          "False [] range \"%*.*s\"",
14959          w, w, rangebegin);
14960        }
14961       }
14962       if (!SIZE_ONLY) {
14963        cp_list = add_cp_to_invlist(cp_list, '-');
14964       }
14965       element_count++;
14966      } else
14967       range = 1; /* yeah, it's a range! */
14968      continue; /* but do it the next time */
14969     }
14970    }
14971   }
14972
14973   if (namedclass > OOB_NAMEDCLASS) {
14974    continue;
14975   }
14976
14977   /* Here, we have a single value this time through the loop, and
14978   * <prevvalue> is the beginning of the range, if any; or <value> if
14979   * not. */
14980
14981   /* non-Latin1 code point implies unicode semantics.  Must be set in
14982   * pass1 so is there for the whole of pass 2 */
14983   if (value > 255) {
14984    RExC_uni_semantics = 1;
14985   }
14986
14987   /* Ready to process either the single value, or the completed range.
14988   * For single-valued non-inverted ranges, we consider the possibility
14989   * of multi-char folds.  (We made a conscious decision to not do this
14990   * for the other cases because it can often lead to non-intuitive
14991   * results.  For example, you have the peculiar case that:
14992   *  "s s" =~ /^[^\xDF]+$/i => Y
14993   *  "ss"  =~ /^[^\xDF]+$/i => N
14994   *
14995   * See [perl #89750] */
14996   if (FOLD && allow_multi_folds && value == prevvalue) {
14997    if (value == LATIN_SMALL_LETTER_SHARP_S
14998     || (value > 255 && _invlist_contains_cp(PL_HasMultiCharFold,
14999               value)))
15000    {
15001     /* Here <value> is indeed a multi-char fold.  Get what it is */
15002
15003     U8 foldbuf[UTF8_MAXBYTES_CASE];
15004     STRLEN foldlen;
15005
15006     UV folded = _to_uni_fold_flags(
15007         value,
15008         foldbuf,
15009         &foldlen,
15010         FOLD_FLAGS_FULL | (ASCII_FOLD_RESTRICTED
15011             ? FOLD_FLAGS_NOMIX_ASCII
15012             : 0)
15013         );
15014
15015     /* Here, <folded> should be the first character of the
15016     * multi-char fold of <value>, with <foldbuf> containing the
15017     * whole thing.  But, if this fold is not allowed (because of
15018     * the flags), <fold> will be the same as <value>, and should
15019     * be processed like any other character, so skip the special
15020     * handling */
15021     if (folded != value) {
15022
15023      /* Skip if we are recursed, currently parsing the class
15024      * again.  Otherwise add this character to the list of
15025      * multi-char folds. */
15026      if (! RExC_in_multi_char_class) {
15027       STRLEN cp_count = utf8_length(foldbuf,
15028              foldbuf + foldlen);
15029       SV* multi_fold = sv_2mortal(newSVpvs(""));
15030
15031       Perl_sv_catpvf(aTHX_ multi_fold, "\\x{%"UVXf"}", value);
15032
15033       multi_char_matches
15034           = add_multi_match(multi_char_matches,
15035               multi_fold,
15036               cp_count);
15037
15038      }
15039
15040      /* This element should not be processed further in this
15041      * class */
15042      element_count--;
15043      value = save_value;
15044      prevvalue = save_prevvalue;
15045      continue;
15046     }
15047    }
15048   }
15049
15050   if (strict && PASS2 && ckWARN(WARN_REGEXP)) {
15051    if (range) {
15052
15053     /* If the range starts above 255, everything is portable and
15054     * likely to be so for any forseeable character set, so don't
15055     * warn. */
15056     if (unicode_range && non_portable_endpoint && prevvalue < 256) {
15057      vWARN(RExC_parse, "Both or neither range ends should be Unicode");
15058     }
15059     else if (prevvalue != value) {
15060
15061      /* Under strict, ranges that stop and/or end in an ASCII
15062      * printable should have each end point be a portable value
15063      * for it (preferably like 'A', but we don't warn if it is
15064      * a (portable) Unicode name or code point), and the range
15065      * must be be all digits or all letters of the same case.
15066      * Otherwise, the range is non-portable and unclear as to
15067      * what it contains */
15068      if ((isPRINT_A(prevvalue) || isPRINT_A(value))
15069       && (non_portable_endpoint
15070        || ! ((isDIGIT_A(prevvalue) && isDIGIT_A(value))
15071         || (isLOWER_A(prevvalue) && isLOWER_A(value))
15072         || (isUPPER_A(prevvalue) && isUPPER_A(value)))))
15073      {
15074       vWARN(RExC_parse, "Ranges of ASCII printables should be some subset of \"0-9\", \"A-Z\", or \"a-z\"");
15075      }
15076      else if (prevvalue >= 0x660) { /* ARABIC_INDIC_DIGIT_ZERO */
15077
15078       /* But the nature of Unicode and languages mean we
15079       * can't do the same checks for above-ASCII ranges,
15080       * except in the case of digit ones.  These should
15081       * contain only digits from the same group of 10.  The
15082       * ASCII case is handled just above.  0x660 is the
15083       * first digit character beyond ASCII.  Hence here, the
15084       * range could be a range of digits.  Find out.  */
15085       IV index_start = _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
15086               prevvalue);
15087       IV index_final = _invlist_search(PL_XPosix_ptrs[_CC_DIGIT],
15088               value);
15089
15090       /* If the range start and final points are in the same
15091       * inversion list element, it means that either both
15092       * are not digits, or both are digits in a consecutive
15093       * sequence of digits.  (So far, Unicode has kept all
15094       * such sequences as distinct groups of 10, but assert
15095       * to make sure).  If the end points are not in the
15096       * same element, neither should be a digit. */
15097       if (index_start == index_final) {
15098        assert(! ELEMENT_RANGE_MATCHES_INVLIST(index_start)
15099        || (invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start+1]
15100        - invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15101        == 10)
15102        /* But actually Unicode did have one group of 11
15103         * 'digits' in 5.2, so in case we are operating
15104         * on that version, let that pass */
15105        || (invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start+1]
15106        - invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15107         == 11
15108        && invlist_array(PL_XPosix_ptrs[_CC_DIGIT])[index_start]
15109         == 0x19D0)
15110        );
15111       }
15112       else if ((index_start >= 0
15113         && ELEMENT_RANGE_MATCHES_INVLIST(index_start))
15114         || (index_final >= 0
15115          && ELEMENT_RANGE_MATCHES_INVLIST(index_final)))
15116       {
15117        vWARN(RExC_parse, "Ranges of digits should be from the same group of 10");
15118       }
15119      }
15120     }
15121    }
15122    if ((! range || prevvalue == value) && non_portable_endpoint) {
15123     if (isPRINT_A(value)) {
15124      char literal[3];
15125      unsigned d = 0;
15126      if (isBACKSLASHED_PUNCT(value)) {
15127       literal[d++] = '\\';
15128      }
15129      literal[d++] = (char) value;
15130      literal[d++] = '\0';
15131
15132      vWARN4(RExC_parse,
15133       "\"%.*s\" is more clearly written simply as \"%s\"",
15134       (int) (RExC_parse - rangebegin),
15135       rangebegin,
15136       literal
15137       );
15138     }
15139     else if isMNEMONIC_CNTRL(value) {
15140      vWARN4(RExC_parse,
15141       "\"%.*s\" is more clearly written simply as \"%s\"",
15142       (int) (RExC_parse - rangebegin),
15143       rangebegin,
15144       cntrl_to_mnemonic((char) value)
15145       );
15146     }
15147    }
15148   }
15149
15150   /* Deal with this element of the class */
15151   if (! SIZE_ONLY) {
15152
15153 #ifndef EBCDIC
15154    cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15155              prevvalue, value);
15156 #else
15157    /* On non-ASCII platforms, for ranges that span all of 0..255, and
15158    * ones that don't require special handling, we can just add the
15159    * range like we do for ASCII platforms */
15160    if ((UNLIKELY(prevvalue == 0) && value >= 255)
15161     || ! (prevvalue < 256
15162      && (unicode_range
15163       || (! non_portable_endpoint
15164        && ((isLOWER_A(prevvalue) && isLOWER_A(value))
15165         || (isUPPER_A(prevvalue)
15166          && isUPPER_A(value)))))))
15167    {
15168     cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15169               prevvalue, value);
15170    }
15171    else {
15172     /* Here, requires special handling.  This can be because it is
15173     * a range whose code points are considered to be Unicode, and
15174     * so must be individually translated into native, or because
15175     * its a subrange of 'A-Z' or 'a-z' which each aren't
15176     * contiguous in EBCDIC, but we have defined them to include
15177     * only the "expected" upper or lower case ASCII alphabetics.
15178     * Subranges above 255 are the same in native and Unicode, so
15179     * can be added as a range */
15180     U8 start = NATIVE_TO_LATIN1(prevvalue);
15181     unsigned j;
15182     U8 end = (value < 256) ? NATIVE_TO_LATIN1(value) : 255;
15183     for (j = start; j <= end; j++) {
15184      cp_foldable_list = add_cp_to_invlist(cp_foldable_list, LATIN1_TO_NATIVE(j));
15185     }
15186     if (value > 255) {
15187      cp_foldable_list = _add_range_to_invlist(cp_foldable_list,
15188                256, value);
15189     }
15190    }
15191 #endif
15192   }
15193
15194   range = 0; /* this range (if it was one) is done now */
15195  } /* End of loop through all the text within the brackets */
15196
15197  /* If anything in the class expands to more than one character, we have to
15198  * deal with them by building up a substitute parse string, and recursively
15199  * calling reg() on it, instead of proceeding */
15200  if (multi_char_matches) {
15201   SV * substitute_parse = newSVpvn_flags("?:", 2, SVs_TEMP);
15202   I32 cp_count;
15203   STRLEN len;
15204   char *save_end = RExC_end;
15205   char *save_parse = RExC_parse;
15206   bool first_time = TRUE;     /* First multi-char occurrence doesn't get
15207          a "|" */
15208   I32 reg_flags;
15209
15210   assert(! invert);
15211 #if 0   /* Have decided not to deal with multi-char folds in inverted classes,
15212   because too confusing */
15213   if (invert) {
15214    sv_catpv(substitute_parse, "(?:");
15215   }
15216 #endif
15217
15218   /* Look at the longest folds first */
15219   for (cp_count = av_tindex(multi_char_matches); cp_count > 0; cp_count--) {
15220
15221    if (av_exists(multi_char_matches, cp_count)) {
15222     AV** this_array_ptr;
15223     SV* this_sequence;
15224
15225     this_array_ptr = (AV**) av_fetch(multi_char_matches,
15226             cp_count, FALSE);
15227     while ((this_sequence = av_pop(*this_array_ptr)) !=
15228                 &PL_sv_undef)
15229     {
15230      if (! first_time) {
15231       sv_catpv(substitute_parse, "|");
15232      }
15233      first_time = FALSE;
15234
15235      sv_catpv(substitute_parse, SvPVX(this_sequence));
15236     }
15237    }
15238   }
15239
15240   /* If the character class contains anything else besides these
15241   * multi-character folds, have to include it in recursive parsing */
15242   if (element_count) {
15243    sv_catpv(substitute_parse, "|[");
15244    sv_catpvn(substitute_parse, orig_parse, RExC_parse - orig_parse);
15245    sv_catpv(substitute_parse, "]");
15246   }
15247
15248   sv_catpv(substitute_parse, ")");
15249 #if 0
15250   if (invert) {
15251    /* This is a way to get the parse to skip forward a whole named
15252    * sequence instead of matching the 2nd character when it fails the
15253    * first */
15254    sv_catpv(substitute_parse, "(*THEN)(*SKIP)(*FAIL)|.)");
15255   }
15256 #endif
15257
15258   RExC_parse = SvPV(substitute_parse, len);
15259   RExC_end = RExC_parse + len;
15260   RExC_in_multi_char_class = 1;
15261   RExC_override_recoding = 1;
15262   RExC_emit = (regnode *)orig_emit;
15263
15264   ret = reg(pRExC_state, 1, &reg_flags, depth+1);
15265
15266   *flagp |= reg_flags&(HASWIDTH|SIMPLE|SPSTART|POSTPONED|RESTART_UTF8);
15267
15268   RExC_parse = save_parse;
15269   RExC_end = save_end;
15270   RExC_in_multi_char_class = 0;
15271   RExC_override_recoding = 0;
15272   SvREFCNT_dec_NN(multi_char_matches);
15273   return ret;
15274  }
15275
15276  /* Here, we've gone through the entire class and dealt with multi-char
15277  * folds.  We are now in a position that we can do some checks to see if we
15278  * can optimize this ANYOF node into a simpler one, even in Pass 1.
15279  * Currently we only do two checks:
15280  * 1) is in the unlikely event that the user has specified both, eg. \w and
15281  *    \W under /l, then the class matches everything.  (This optimization
15282  *    is done only to make the optimizer code run later work.)
15283  * 2) if the character class contains only a single element (including a
15284  *    single range), we see if there is an equivalent node for it.
15285  * Other checks are possible */
15286  if (! ret_invlist   /* Can't optimize if returning the constructed
15287       inversion list */
15288   && (UNLIKELY(posixl_matches_all) || element_count == 1))
15289  {
15290   U8 op = END;
15291   U8 arg = 0;
15292
15293   if (UNLIKELY(posixl_matches_all)) {
15294    op = SANY;
15295   }
15296   else if (namedclass > OOB_NAMEDCLASS) { /* this is a named class, like
15297             \w or [:digit:] or \p{foo}
15298             */
15299
15300    /* All named classes are mapped into POSIXish nodes, with its FLAG
15301    * argument giving which class it is */
15302    switch ((I32)namedclass) {
15303     case ANYOF_UNIPROP:
15304      break;
15305
15306     /* These don't depend on the charset modifiers.  They always
15307     * match under /u rules */
15308     case ANYOF_NHORIZWS:
15309     case ANYOF_HORIZWS:
15310      namedclass = ANYOF_BLANK + namedclass - ANYOF_HORIZWS;
15311      /* FALLTHROUGH */
15312
15313     case ANYOF_NVERTWS:
15314     case ANYOF_VERTWS:
15315      op = POSIXU;
15316      goto join_posix;
15317
15318     /* The actual POSIXish node for all the rest depends on the
15319     * charset modifier.  The ones in the first set depend only on
15320     * ASCII or, if available on this platform, also locale */
15321     case ANYOF_ASCII:
15322     case ANYOF_NASCII:
15323 #ifdef HAS_ISASCII
15324      op = (LOC) ? POSIXL : POSIXA;
15325 #else
15326      op = POSIXA;
15327 #endif
15328      goto join_posix;
15329
15330     /* The following don't have any matches in the upper Latin1
15331     * range, hence /d is equivalent to /u for them.  Making it /u
15332     * saves some branches at runtime */
15333     case ANYOF_DIGIT:
15334     case ANYOF_NDIGIT:
15335     case ANYOF_XDIGIT:
15336     case ANYOF_NXDIGIT:
15337      if (! DEPENDS_SEMANTICS) {
15338       goto treat_as_default;
15339      }
15340
15341      op = POSIXU;
15342      goto join_posix;
15343
15344     /* The following change to CASED under /i */
15345     case ANYOF_LOWER:
15346     case ANYOF_NLOWER:
15347     case ANYOF_UPPER:
15348     case ANYOF_NUPPER:
15349      if (FOLD) {
15350       namedclass = ANYOF_CASED + (namedclass % 2);
15351      }
15352      /* FALLTHROUGH */
15353
15354     /* The rest have more possibilities depending on the charset.
15355     * We take advantage of the enum ordering of the charset
15356     * modifiers to get the exact node type, */
15357     default:
15358     treat_as_default:
15359      op = POSIXD + get_regex_charset(RExC_flags);
15360      if (op > POSIXA) { /* /aa is same as /a */
15361       op = POSIXA;
15362      }
15363
15364     join_posix:
15365      /* The odd numbered ones are the complements of the
15366      * next-lower even number one */
15367      if (namedclass % 2 == 1) {
15368       invert = ! invert;
15369       namedclass--;
15370      }
15371      arg = namedclass_to_classnum(namedclass);
15372      break;
15373    }
15374   }
15375   else if (value == prevvalue) {
15376
15377    /* Here, the class consists of just a single code point */
15378
15379    if (invert) {
15380     if (! LOC && value == '\n') {
15381      op = REG_ANY; /* Optimize [^\n] */
15382      *flagp |= HASWIDTH|SIMPLE;
15383      MARK_NAUGHTY(1);
15384     }
15385    }
15386    else if (value < 256 || UTF) {
15387
15388     /* Optimize a single value into an EXACTish node, but not if it
15389     * would require converting the pattern to UTF-8. */
15390     op = compute_EXACTish(pRExC_state);
15391    }
15392   } /* Otherwise is a range */
15393   else if (! LOC) {   /* locale could vary these */
15394    if (prevvalue == '0') {
15395     if (value == '9') {
15396      arg = _CC_DIGIT;
15397      op = POSIXA;
15398     }
15399    }
15400    else if (! FOLD || ASCII_FOLD_RESTRICTED) {
15401     /* We can optimize A-Z or a-z, but not if they could match
15402     * something like the KELVIN SIGN under /i. */
15403     if (prevvalue == 'A') {
15404      if (value == 'Z'
15405 #ifdef EBCDIC
15406       && ! non_portable_endpoint
15407 #endif
15408      ) {
15409       arg = (FOLD) ? _CC_ALPHA : _CC_UPPER;
15410       op = POSIXA;
15411      }
15412     }
15413     else if (prevvalue == 'a') {
15414      if (value == 'z'
15415 #ifdef EBCDIC
15416       && ! non_portable_endpoint
15417 #endif
15418      ) {
15419       arg = (FOLD) ? _CC_ALPHA : _CC_LOWER;
15420       op = POSIXA;
15421      }
15422     }
15423    }
15424   }
15425
15426   /* Here, we have changed <op> away from its initial value iff we found
15427   * an optimization */
15428   if (op != END) {
15429
15430    /* Throw away this ANYOF regnode, and emit the calculated one,
15431    * which should correspond to the beginning, not current, state of
15432    * the parse */
15433    const char * cur_parse = RExC_parse;
15434    RExC_parse = (char *)orig_parse;
15435    if ( SIZE_ONLY) {
15436     if (! LOC) {
15437
15438      /* To get locale nodes to not use the full ANYOF size would
15439      * require moving the code above that writes the portions
15440      * of it that aren't in other nodes to after this point.
15441      * e.g.  ANYOF_POSIXL_SET */
15442      RExC_size = orig_size;
15443     }
15444    }
15445    else {
15446     RExC_emit = (regnode *)orig_emit;
15447     if (PL_regkind[op] == POSIXD) {
15448      if (op == POSIXL) {
15449       RExC_contains_locale = 1;
15450      }
15451      if (invert) {
15452       op += NPOSIXD - POSIXD;
15453      }
15454     }
15455    }
15456
15457    ret = reg_node(pRExC_state, op);
15458
15459    if (PL_regkind[op] == POSIXD || PL_regkind[op] == NPOSIXD) {
15460     if (! SIZE_ONLY) {
15461      FLAGS(ret) = arg;
15462     }
15463     *flagp |= HASWIDTH|SIMPLE;
15464    }
15465    else if (PL_regkind[op] == EXACT) {
15466     alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
15467           TRUE /* downgradable to EXACT */
15468           );
15469    }
15470
15471    RExC_parse = (char *) cur_parse;
15472
15473    SvREFCNT_dec(posixes);
15474    SvREFCNT_dec(nposixes);
15475    SvREFCNT_dec(simple_posixes);
15476    SvREFCNT_dec(cp_list);
15477    SvREFCNT_dec(cp_foldable_list);
15478    return ret;
15479   }
15480  }
15481
15482  if (SIZE_ONLY)
15483   return ret;
15484  /****** !SIZE_ONLY (Pass 2) AFTER HERE *********/
15485
15486  /* If folding, we calculate all characters that could fold to or from the
15487  * ones already on the list */
15488  if (cp_foldable_list) {
15489   if (FOLD) {
15490    UV start, end; /* End points of code point ranges */
15491
15492    SV* fold_intersection = NULL;
15493    SV** use_list;
15494
15495    /* Our calculated list will be for Unicode rules.  For locale
15496    * matching, we have to keep a separate list that is consulted at
15497    * runtime only when the locale indicates Unicode rules.  For
15498    * non-locale, we just use to the general list */
15499    if (LOC) {
15500     use_list = &only_utf8_locale_list;
15501    }
15502    else {
15503     use_list = &cp_list;
15504    }
15505
15506    /* Only the characters in this class that participate in folds need
15507    * be checked.  Get the intersection of this class and all the
15508    * possible characters that are foldable.  This can quickly narrow
15509    * down a large class */
15510    _invlist_intersection(PL_utf8_foldable, cp_foldable_list,
15511         &fold_intersection);
15512
15513    /* The folds for all the Latin1 characters are hard-coded into this
15514    * program, but we have to go out to disk to get the others. */
15515    if (invlist_highest(cp_foldable_list) >= 256) {
15516
15517     /* This is a hash that for a particular fold gives all
15518     * characters that are involved in it */
15519     if (! PL_utf8_foldclosures) {
15520      _load_PL_utf8_foldclosures();
15521     }
15522    }
15523
15524    /* Now look at the foldable characters in this class individually */
15525    invlist_iterinit(fold_intersection);
15526    while (invlist_iternext(fold_intersection, &start, &end)) {
15527     UV j;
15528
15529     /* Look at every character in the range */
15530     for (j = start; j <= end; j++) {
15531      U8 foldbuf[UTF8_MAXBYTES_CASE+1];
15532      STRLEN foldlen;
15533      SV** listp;
15534
15535      if (j < 256) {
15536
15537       if (IS_IN_SOME_FOLD_L1(j)) {
15538
15539        /* ASCII is always matched; non-ASCII is matched
15540        * only under Unicode rules (which could happen
15541        * under /l if the locale is a UTF-8 one */
15542        if (isASCII(j) || ! DEPENDS_SEMANTICS) {
15543         *use_list = add_cp_to_invlist(*use_list,
15544                PL_fold_latin1[j]);
15545        }
15546        else {
15547         depends_list =
15548         add_cp_to_invlist(depends_list,
15549             PL_fold_latin1[j]);
15550        }
15551       }
15552
15553       if (HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(j)
15554        && (! isASCII(j) || ! ASCII_FOLD_RESTRICTED))
15555       {
15556        add_above_Latin1_folds(pRExC_state,
15557             (U8) j,
15558             use_list);
15559       }
15560       continue;
15561      }
15562
15563      /* Here is an above Latin1 character.  We don't have the
15564      * rules hard-coded for it.  First, get its fold.  This is
15565      * the simple fold, as the multi-character folds have been
15566      * handled earlier and separated out */
15567      _to_uni_fold_flags(j, foldbuf, &foldlen,
15568               (ASCII_FOLD_RESTRICTED)
15569               ? FOLD_FLAGS_NOMIX_ASCII
15570               : 0);
15571
15572      /* Single character fold of above Latin1.  Add everything in
15573      * its fold closure to the list that this node should match.
15574      * The fold closures data structure is a hash with the keys
15575      * being the UTF-8 of every character that is folded to, like
15576      * 'k', and the values each an array of all code points that
15577      * fold to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ].
15578      * Multi-character folds are not included */
15579      if ((listp = hv_fetch(PL_utf8_foldclosures,
15580           (char *) foldbuf, foldlen, FALSE)))
15581      {
15582       AV* list = (AV*) *listp;
15583       IV k;
15584       for (k = 0; k <= av_tindex(list); k++) {
15585        SV** c_p = av_fetch(list, k, FALSE);
15586        UV c;
15587        assert(c_p);
15588
15589        c = SvUV(*c_p);
15590
15591        /* /aa doesn't allow folds between ASCII and non- */
15592        if ((ASCII_FOLD_RESTRICTED
15593         && (isASCII(c) != isASCII(j))))
15594        {
15595         continue;
15596        }
15597
15598        /* Folds under /l which cross the 255/256 boundary
15599        * are added to a separate list.  (These are valid
15600        * only when the locale is UTF-8.) */
15601        if (c < 256 && LOC) {
15602         *use_list = add_cp_to_invlist(*use_list, c);
15603         continue;
15604        }
15605
15606        if (isASCII(c) || c > 255 || AT_LEAST_UNI_SEMANTICS)
15607        {
15608         cp_list = add_cp_to_invlist(cp_list, c);
15609        }
15610        else {
15611         /* Similarly folds involving non-ascii Latin1
15612         * characters under /d are added to their list */
15613         depends_list = add_cp_to_invlist(depends_list,
15614                 c);
15615        }
15616       }
15617      }
15618     }
15619    }
15620    SvREFCNT_dec_NN(fold_intersection);
15621   }
15622
15623   /* Now that we have finished adding all the folds, there is no reason
15624   * to keep the foldable list separate */
15625   _invlist_union(cp_list, cp_foldable_list, &cp_list);
15626   SvREFCNT_dec_NN(cp_foldable_list);
15627  }
15628
15629  /* And combine the result (if any) with any inversion list from posix
15630  * classes.  The lists are kept separate up to now because we don't want to
15631  * fold the classes (folding of those is automatically handled by the swash
15632  * fetching code) */
15633  if (simple_posixes) {
15634   _invlist_union(cp_list, simple_posixes, &cp_list);
15635   SvREFCNT_dec_NN(simple_posixes);
15636  }
15637  if (posixes || nposixes) {
15638   if (posixes && AT_LEAST_ASCII_RESTRICTED) {
15639    /* Under /a and /aa, nothing above ASCII matches these */
15640    _invlist_intersection(posixes,
15641         PL_XPosix_ptrs[_CC_ASCII],
15642         &posixes);
15643   }
15644   if (nposixes) {
15645    if (DEPENDS_SEMANTICS) {
15646     /* Under /d, everything in the upper half of the Latin1 range
15647     * matches these complements */
15648     ANYOF_FLAGS(ret) |= ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII;
15649    }
15650    else if (AT_LEAST_ASCII_RESTRICTED) {
15651     /* Under /a and /aa, everything above ASCII matches these
15652     * complements */
15653     _invlist_union_complement_2nd(nposixes,
15654            PL_XPosix_ptrs[_CC_ASCII],
15655            &nposixes);
15656    }
15657    if (posixes) {
15658     _invlist_union(posixes, nposixes, &posixes);
15659     SvREFCNT_dec_NN(nposixes);
15660    }
15661    else {
15662     posixes = nposixes;
15663    }
15664   }
15665   if (! DEPENDS_SEMANTICS) {
15666    if (cp_list) {
15667     _invlist_union(cp_list, posixes, &cp_list);
15668     SvREFCNT_dec_NN(posixes);
15669    }
15670    else {
15671     cp_list = posixes;
15672    }
15673   }
15674   else {
15675    /* Under /d, we put into a separate list the Latin1 things that
15676    * match only when the target string is utf8 */
15677    SV* nonascii_but_latin1_properties = NULL;
15678    _invlist_intersection(posixes, PL_UpperLatin1,
15679         &nonascii_but_latin1_properties);
15680    _invlist_subtract(posixes, nonascii_but_latin1_properties,
15681        &posixes);
15682    if (cp_list) {
15683     _invlist_union(cp_list, posixes, &cp_list);
15684     SvREFCNT_dec_NN(posixes);
15685    }
15686    else {
15687     cp_list = posixes;
15688    }
15689
15690    if (depends_list) {
15691     _invlist_union(depends_list, nonascii_but_latin1_properties,
15692        &depends_list);
15693     SvREFCNT_dec_NN(nonascii_but_latin1_properties);
15694    }
15695    else {
15696     depends_list = nonascii_but_latin1_properties;
15697    }
15698   }
15699  }
15700
15701  /* And combine the result (if any) with any inversion list from properties.
15702  * The lists are kept separate up to now so that we can distinguish the two
15703  * in regards to matching above-Unicode.  A run-time warning is generated
15704  * if a Unicode property is matched against a non-Unicode code point. But,
15705  * we allow user-defined properties to match anything, without any warning,
15706  * and we also suppress the warning if there is a portion of the character
15707  * class that isn't a Unicode property, and which matches above Unicode, \W
15708  * or [\x{110000}] for example.
15709  * (Note that in this case, unlike the Posix one above, there is no
15710  * <depends_list>, because having a Unicode property forces Unicode
15711  * semantics */
15712  if (properties) {
15713   if (cp_list) {
15714
15715    /* If it matters to the final outcome, see if a non-property
15716    * component of the class matches above Unicode.  If so, the
15717    * warning gets suppressed.  This is true even if just a single
15718    * such code point is specified, as though not strictly correct if
15719    * another such code point is matched against, the fact that they
15720    * are using above-Unicode code points indicates they should know
15721    * the issues involved */
15722    if (warn_super) {
15723     warn_super = ! (invert
15724        ^ (invlist_highest(cp_list) > PERL_UNICODE_MAX));
15725    }
15726
15727    _invlist_union(properties, cp_list, &cp_list);
15728    SvREFCNT_dec_NN(properties);
15729   }
15730   else {
15731    cp_list = properties;
15732   }
15733
15734   if (warn_super) {
15735    ANYOF_FLAGS(ret) |= ANYOF_WARN_SUPER;
15736   }
15737  }
15738
15739  /* Here, we have calculated what code points should be in the character
15740  * class.
15741  *
15742  * Now we can see about various optimizations.  Fold calculation (which we
15743  * did above) needs to take place before inversion.  Otherwise /[^k]/i
15744  * would invert to include K, which under /i would match k, which it
15745  * shouldn't.  Therefore we can't invert folded locale now, as it won't be
15746  * folded until runtime */
15747
15748  /* If we didn't do folding, it's because some information isn't available
15749  * until runtime; set the run-time fold flag for these.  (We don't have to
15750  * worry about properties folding, as that is taken care of by the swash
15751  * fetching).  We know to set the flag if we have a non-NULL list for UTF-8
15752  * locales, or the class matches at least one 0-255 range code point */
15753  if (LOC && FOLD) {
15754   if (only_utf8_locale_list) {
15755    ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
15756   }
15757   else if (cp_list) { /* Look to see if there a 0-255 code point is in
15758        the list */
15759    UV start, end;
15760    invlist_iterinit(cp_list);
15761    if (invlist_iternext(cp_list, &start, &end) && start < 256) {
15762     ANYOF_FLAGS(ret) |= ANYOF_LOC_FOLD;
15763    }
15764    invlist_iterfinish(cp_list);
15765   }
15766  }
15767
15768  /* Optimize inverted simple patterns (e.g. [^a-z]) when everything is known
15769  * at compile time.  Besides not inverting folded locale now, we can't
15770  * invert if there are things such as \w, which aren't known until runtime
15771  * */
15772  if (cp_list
15773   && invert
15774   && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
15775   && ! depends_list
15776   && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
15777  {
15778   _invlist_invert(cp_list);
15779
15780   /* Any swash can't be used as-is, because we've inverted things */
15781   if (swash) {
15782    SvREFCNT_dec_NN(swash);
15783    swash = NULL;
15784   }
15785
15786   /* Clear the invert flag since have just done it here */
15787   invert = FALSE;
15788  }
15789
15790  if (ret_invlist) {
15791   assert(cp_list);
15792
15793   *ret_invlist = cp_list;
15794   SvREFCNT_dec(swash);
15795
15796   /* Discard the generated node */
15797   if (SIZE_ONLY) {
15798    RExC_size = orig_size;
15799   }
15800   else {
15801    RExC_emit = orig_emit;
15802   }
15803   return orig_emit;
15804  }
15805
15806  /* Some character classes are equivalent to other nodes.  Such nodes take
15807  * up less room and generally fewer operations to execute than ANYOF nodes.
15808  * Above, we checked for and optimized into some such equivalents for
15809  * certain common classes that are easy to test.  Getting to this point in
15810  * the code means that the class didn't get optimized there.  Since this
15811  * code is only executed in Pass 2, it is too late to save space--it has
15812  * been allocated in Pass 1, and currently isn't given back.  But turning
15813  * things into an EXACTish node can allow the optimizer to join it to any
15814  * adjacent such nodes.  And if the class is equivalent to things like /./,
15815  * expensive run-time swashes can be avoided.  Now that we have more
15816  * complete information, we can find things necessarily missed by the
15817  * earlier code.  I (khw) am not sure how much to look for here.  It would
15818  * be easy, but perhaps too slow, to check any candidates against all the
15819  * node types they could possibly match using _invlistEQ(). */
15820
15821  if (cp_list
15822   && ! invert
15823   && ! depends_list
15824   && ! (ANYOF_FLAGS(ret) & (ANYOF_LOCALE_FLAGS))
15825   && ! HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
15826
15827   /* We don't optimize if we are supposed to make sure all non-Unicode
15828    * code points raise a warning, as only ANYOF nodes have this check.
15829    * */
15830   && ! ((ANYOF_FLAGS(ret) & ANYOF_WARN_SUPER) && ALWAYS_WARN_SUPER))
15831  {
15832   UV start, end;
15833   U8 op = END;  /* The optimzation node-type */
15834   const char * cur_parse= RExC_parse;
15835
15836   invlist_iterinit(cp_list);
15837   if (! invlist_iternext(cp_list, &start, &end)) {
15838
15839    /* Here, the list is empty.  This happens, for example, when a
15840    * Unicode property is the only thing in the character class, and
15841    * it doesn't match anything.  (perluniprops.pod notes such
15842    * properties) */
15843    op = OPFAIL;
15844    *flagp |= HASWIDTH|SIMPLE;
15845   }
15846   else if (start == end) {    /* The range is a single code point */
15847    if (! invlist_iternext(cp_list, &start, &end)
15848
15849      /* Don't do this optimization if it would require changing
15850      * the pattern to UTF-8 */
15851     && (start < 256 || UTF))
15852    {
15853     /* Here, the list contains a single code point.  Can optimize
15854     * into an EXACTish node */
15855
15856     value = start;
15857
15858     if (! FOLD) {
15859      op = (LOC)
15860       ? EXACTL
15861       : EXACT;
15862     }
15863     else if (LOC) {
15864
15865      /* A locale node under folding with one code point can be
15866      * an EXACTFL, as its fold won't be calculated until
15867      * runtime */
15868      op = EXACTFL;
15869     }
15870     else {
15871
15872      /* Here, we are generally folding, but there is only one
15873      * code point to match.  If we have to, we use an EXACT
15874      * node, but it would be better for joining with adjacent
15875      * nodes in the optimization pass if we used the same
15876      * EXACTFish node that any such are likely to be.  We can
15877      * do this iff the code point doesn't participate in any
15878      * folds.  For example, an EXACTF of a colon is the same as
15879      * an EXACT one, since nothing folds to or from a colon. */
15880      if (value < 256) {
15881       if (IS_IN_SOME_FOLD_L1(value)) {
15882        op = EXACT;
15883       }
15884      }
15885      else {
15886       if (_invlist_contains_cp(PL_utf8_foldable, value)) {
15887        op = EXACT;
15888       }
15889      }
15890
15891      /* If we haven't found the node type, above, it means we
15892      * can use the prevailing one */
15893      if (op == END) {
15894       op = compute_EXACTish(pRExC_state);
15895      }
15896     }
15897    }
15898   }
15899   else if (start == 0) {
15900    if (end == UV_MAX) {
15901     op = SANY;
15902     *flagp |= HASWIDTH|SIMPLE;
15903     MARK_NAUGHTY(1);
15904    }
15905    else if (end == '\n' - 1
15906      && invlist_iternext(cp_list, &start, &end)
15907      && start == '\n' + 1 && end == UV_MAX)
15908    {
15909     op = REG_ANY;
15910     *flagp |= HASWIDTH|SIMPLE;
15911     MARK_NAUGHTY(1);
15912    }
15913   }
15914   invlist_iterfinish(cp_list);
15915
15916   if (op != END) {
15917    RExC_parse = (char *)orig_parse;
15918    RExC_emit = (regnode *)orig_emit;
15919
15920    ret = reg_node(pRExC_state, op);
15921
15922    RExC_parse = (char *)cur_parse;
15923
15924    if (PL_regkind[op] == EXACT) {
15925     alloc_maybe_populate_EXACT(pRExC_state, ret, flagp, 0, value,
15926           TRUE /* downgradable to EXACT */
15927           );
15928    }
15929
15930    SvREFCNT_dec_NN(cp_list);
15931    return ret;
15932   }
15933  }
15934
15935  /* Here, <cp_list> contains all the code points we can determine at
15936  * compile time that match under all conditions.  Go through it, and
15937  * for things that belong in the bitmap, put them there, and delete from
15938  * <cp_list>.  While we are at it, see if everything above 255 is in the
15939  * list, and if so, set a flag to speed up execution */
15940
15941  populate_ANYOF_from_invlist(ret, &cp_list);
15942
15943  if (invert) {
15944   ANYOF_FLAGS(ret) |= ANYOF_INVERT;
15945  }
15946
15947  /* Here, the bitmap has been populated with all the Latin1 code points that
15948  * always match.  Can now add to the overall list those that match only
15949  * when the target string is UTF-8 (<depends_list>). */
15950  if (depends_list) {
15951   if (cp_list) {
15952    _invlist_union(cp_list, depends_list, &cp_list);
15953    SvREFCNT_dec_NN(depends_list);
15954   }
15955   else {
15956    cp_list = depends_list;
15957   }
15958   ANYOF_FLAGS(ret) |= ANYOF_HAS_UTF8_NONBITMAP_MATCHES;
15959  }
15960
15961  /* If there is a swash and more than one element, we can't use the swash in
15962  * the optimization below. */
15963  if (swash && element_count > 1) {
15964   SvREFCNT_dec_NN(swash);
15965   swash = NULL;
15966  }
15967
15968  /* Note that the optimization of using 'swash' if it is the only thing in
15969  * the class doesn't have us change swash at all, so it can include things
15970  * that are also in the bitmap; otherwise we have purposely deleted that
15971  * duplicate information */
15972  set_ANYOF_arg(pRExC_state, ret, cp_list,
15973     (HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION)
15974     ? listsv : NULL,
15975     only_utf8_locale_list,
15976     swash, has_user_defined_property);
15977
15978  *flagp |= HASWIDTH|SIMPLE;
15979
15980  if (ANYOF_FLAGS(ret) & ANYOF_LOCALE_FLAGS) {
15981   RExC_contains_locale = 1;
15982  }
15983
15984  return ret;
15985 }
15986
15987 #undef HAS_NONLOCALE_RUNTIME_PROPERTY_DEFINITION
15988
15989 STATIC void
15990 S_set_ANYOF_arg(pTHX_ RExC_state_t* const pRExC_state,
15991     regnode* const node,
15992     SV* const cp_list,
15993     SV* const runtime_defns,
15994     SV* const only_utf8_locale_list,
15995     SV* const swash,
15996     const bool has_user_defined_property)
15997 {
15998  /* Sets the arg field of an ANYOF-type node 'node', using information about
15999  * the node passed-in.  If there is nothing outside the node's bitmap, the
16000  * arg is set to ANYOF_ONLY_HAS_BITMAP.  Otherwise, it sets the argument to
16001  * the count returned by add_data(), having allocated and stored an array,
16002  * av, that that count references, as follows:
16003  *  av[0] stores the character class description in its textual form.
16004  *        This is used later (regexec.c:Perl_regclass_swash()) to
16005  *        initialize the appropriate swash, and is also useful for dumping
16006  *        the regnode.  This is set to &PL_sv_undef if the textual
16007  *        description is not needed at run-time (as happens if the other
16008  *        elements completely define the class)
16009  *  av[1] if &PL_sv_undef, is a placeholder to later contain the swash
16010  *        computed from av[0].  But if no further computation need be done,
16011  *        the swash is stored here now (and av[0] is &PL_sv_undef).
16012  *  av[2] stores the inversion list of code points that match only if the
16013  *        current locale is UTF-8
16014  *  av[3] stores the cp_list inversion list for use in addition or instead
16015  *        of av[0]; used only if cp_list exists and av[1] is &PL_sv_undef.
16016  *        (Otherwise everything needed is already in av[0] and av[1])
16017  *  av[4] is set if any component of the class is from a user-defined
16018  *        property; used only if av[3] exists */
16019
16020  UV n;
16021
16022  PERL_ARGS_ASSERT_SET_ANYOF_ARG;
16023
16024  if (! cp_list && ! runtime_defns && ! only_utf8_locale_list) {
16025   assert(! (ANYOF_FLAGS(node)
16026     & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16027      |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES)));
16028   ARG_SET(node, ANYOF_ONLY_HAS_BITMAP);
16029  }
16030  else {
16031   AV * const av = newAV();
16032   SV *rv;
16033
16034   assert(ANYOF_FLAGS(node)
16035    & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16036     |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES|ANYOF_LOC_FOLD));
16037
16038   av_store(av, 0, (runtime_defns)
16039       ? SvREFCNT_inc(runtime_defns) : &PL_sv_undef);
16040   if (swash) {
16041    assert(cp_list);
16042    av_store(av, 1, swash);
16043    SvREFCNT_dec_NN(cp_list);
16044   }
16045   else {
16046    av_store(av, 1, &PL_sv_undef);
16047    if (cp_list) {
16048     av_store(av, 3, cp_list);
16049     av_store(av, 4, newSVuv(has_user_defined_property));
16050    }
16051   }
16052
16053   if (only_utf8_locale_list) {
16054    av_store(av, 2, only_utf8_locale_list);
16055   }
16056   else {
16057    av_store(av, 2, &PL_sv_undef);
16058   }
16059
16060   rv = newRV_noinc(MUTABLE_SV(av));
16061   n = add_data(pRExC_state, STR_WITH_LEN("s"));
16062   RExC_rxi->data->data[n] = (void*)rv;
16063   ARG_SET(node, n);
16064  }
16065 }
16066
16067 #if !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION)
16068 SV *
16069 Perl__get_regclass_nonbitmap_data(pTHX_ const regexp *prog,
16070           const regnode* node,
16071           bool doinit,
16072           SV** listsvp,
16073           SV** only_utf8_locale_ptr,
16074           SV*  exclude_list)
16075
16076 {
16077  /* For internal core use only.
16078  * Returns the swash for the input 'node' in the regex 'prog'.
16079  * If <doinit> is 'true', will attempt to create the swash if not already
16080  *   done.
16081  * If <listsvp> is non-null, will return the printable contents of the
16082  *    swash.  This can be used to get debugging information even before the
16083  *    swash exists, by calling this function with 'doinit' set to false, in
16084  *    which case the components that will be used to eventually create the
16085  *    swash are returned  (in a printable form).
16086  * If <exclude_list> is not NULL, it is an inversion list of things to
16087  *    exclude from what's returned in <listsvp>.
16088  * Tied intimately to how S_set_ANYOF_arg sets up the data structure.  Note
16089  * that, in spite of this function's name, the swash it returns may include
16090  * the bitmap data as well */
16091
16092  SV *sw  = NULL;
16093  SV *si  = NULL;         /* Input swash initialization string */
16094  SV*  invlist = NULL;
16095
16096  RXi_GET_DECL(prog,progi);
16097  const struct reg_data * const data = prog ? progi->data : NULL;
16098
16099  PERL_ARGS_ASSERT__GET_REGCLASS_NONBITMAP_DATA;
16100
16101  assert(ANYOF_FLAGS(node)
16102   & (ANYOF_HAS_UTF8_NONBITMAP_MATCHES
16103   |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES|ANYOF_LOC_FOLD));
16104
16105  if (data && data->count) {
16106   const U32 n = ARG(node);
16107
16108   if (data->what[n] == 's') {
16109    SV * const rv = MUTABLE_SV(data->data[n]);
16110    AV * const av = MUTABLE_AV(SvRV(rv));
16111    SV **const ary = AvARRAY(av);
16112    U8 swash_init_flags = _CORE_SWASH_INIT_ACCEPT_INVLIST;
16113
16114    si = *ary; /* ary[0] = the string to initialize the swash with */
16115
16116    /* Elements 3 and 4 are either both present or both absent. [3] is
16117    * any inversion list generated at compile time; [4] indicates if
16118    * that inversion list has any user-defined properties in it. */
16119    if (av_tindex(av) >= 2) {
16120     if (only_utf8_locale_ptr
16121      && ary[2]
16122      && ary[2] != &PL_sv_undef)
16123     {
16124      *only_utf8_locale_ptr = ary[2];
16125     }
16126     else {
16127      assert(only_utf8_locale_ptr);
16128      *only_utf8_locale_ptr = NULL;
16129     }
16130
16131     if (av_tindex(av) >= 3) {
16132      invlist = ary[3];
16133      if (SvUV(ary[4])) {
16134       swash_init_flags |= _CORE_SWASH_INIT_USER_DEFINED_PROPERTY;
16135      }
16136     }
16137     else {
16138      invlist = NULL;
16139     }
16140    }
16141
16142    /* Element [1] is reserved for the set-up swash.  If already there,
16143    * return it; if not, create it and store it there */
16144    if (ary[1] && SvROK(ary[1])) {
16145     sw = ary[1];
16146    }
16147    else if (doinit && ((si && si != &PL_sv_undef)
16148         || (invlist && invlist != &PL_sv_undef))) {
16149     assert(si);
16150     sw = _core_swash_init("utf8", /* the utf8 package */
16151          "", /* nameless */
16152          si,
16153          1, /* binary */
16154          0, /* not from tr/// */
16155          invlist,
16156          &swash_init_flags);
16157     (void)av_store(av, 1, sw);
16158    }
16159   }
16160  }
16161
16162  /* If requested, return a printable version of what this swash matches */
16163  if (listsvp) {
16164   SV* matches_string = newSVpvs("");
16165
16166   /* The swash should be used, if possible, to get the data, as it
16167   * contains the resolved data.  But this function can be called at
16168   * compile-time, before everything gets resolved, in which case we
16169   * return the currently best available information, which is the string
16170   * that will eventually be used to do that resolving, 'si' */
16171   if ((! sw || (invlist = _get_swash_invlist(sw)) == NULL)
16172    && (si && si != &PL_sv_undef))
16173   {
16174    sv_catsv(matches_string, si);
16175   }
16176
16177   /* Add the inversion list to whatever we have.  This may have come from
16178   * the swash, or from an input parameter */
16179   if (invlist) {
16180    if (exclude_list) {
16181     SV* clone = invlist_clone(invlist);
16182     _invlist_subtract(clone, exclude_list, &clone);
16183     sv_catsv(matches_string, _invlist_contents(clone));
16184     SvREFCNT_dec_NN(clone);
16185    }
16186    else {
16187     sv_catsv(matches_string, _invlist_contents(invlist));
16188    }
16189   }
16190   *listsvp = matches_string;
16191  }
16192
16193  return sw;
16194 }
16195 #endif /* !defined(PERL_IN_XSUB_RE) || defined(PLUGGABLE_RE_EXTENSION) */
16196
16197 /* reg_skipcomment()
16198
16199    Absorbs an /x style # comment from the input stream,
16200    returning a pointer to the first character beyond the comment, or if the
16201    comment terminates the pattern without anything following it, this returns
16202    one past the final character of the pattern (in other words, RExC_end) and
16203    sets the REG_RUN_ON_COMMENT_SEEN flag.
16204
16205    Note it's the callers responsibility to ensure that we are
16206    actually in /x mode
16207
16208 */
16209
16210 PERL_STATIC_INLINE char*
16211 S_reg_skipcomment(RExC_state_t *pRExC_state, char* p)
16212 {
16213  PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
16214
16215  assert(*p == '#');
16216
16217  while (p < RExC_end) {
16218   if (*(++p) == '\n') {
16219    return p+1;
16220   }
16221  }
16222
16223  /* we ran off the end of the pattern without ending the comment, so we have
16224  * to add an \n when wrapping */
16225  RExC_seen |= REG_RUN_ON_COMMENT_SEEN;
16226  return p;
16227 }
16228
16229 /* nextchar()
16230
16231    Advances the parse position, and optionally absorbs
16232    "whitespace" from the inputstream.
16233
16234    Without /x "whitespace" means (?#...) style comments only,
16235    with /x this means (?#...) and # comments and whitespace proper.
16236
16237    Returns the RExC_parse point from BEFORE the scan occurs.
16238
16239    This is the /x friendly way of saying RExC_parse++.
16240 */
16241
16242 STATIC char*
16243 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
16244 {
16245  char* const retval = RExC_parse++;
16246
16247  PERL_ARGS_ASSERT_NEXTCHAR;
16248
16249  for (;;) {
16250   if (RExC_end - RExC_parse >= 3
16251    && *RExC_parse == '('
16252    && RExC_parse[1] == '?'
16253    && RExC_parse[2] == '#')
16254   {
16255    while (*RExC_parse != ')') {
16256     if (RExC_parse == RExC_end)
16257      FAIL("Sequence (?#... not terminated");
16258     RExC_parse++;
16259    }
16260    RExC_parse++;
16261    continue;
16262   }
16263   if (RExC_flags & RXf_PMf_EXTENDED) {
16264    char * p = regpatws(pRExC_state, RExC_parse,
16265           TRUE); /* means recognize comments */
16266    if (p != RExC_parse) {
16267     RExC_parse = p;
16268     continue;
16269    }
16270   }
16271   return retval;
16272  }
16273 }
16274
16275 STATIC regnode *
16276 S_regnode_guts(pTHX_ RExC_state_t *pRExC_state, const U8 op, const STRLEN extra_size, const char* const name)
16277 {
16278  /* Allocate a regnode for 'op' and returns it, with 'extra_size' extra
16279  * space.  In pass1, it aligns and increments RExC_size; in pass2,
16280  * RExC_emit */
16281
16282  regnode * const ret = RExC_emit;
16283  GET_RE_DEBUG_FLAGS_DECL;
16284
16285  PERL_ARGS_ASSERT_REGNODE_GUTS;
16286
16287  assert(extra_size >= regarglen[op]);
16288
16289  if (SIZE_ONLY) {
16290   SIZE_ALIGN(RExC_size);
16291   RExC_size += 1 + extra_size;
16292   return(ret);
16293  }
16294  if (RExC_emit >= RExC_emit_bound)
16295   Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d, %p>=%p",
16296     op, (void*)RExC_emit, (void*)RExC_emit_bound);
16297
16298  NODE_ALIGN_FILL(ret);
16299 #ifndef RE_TRACK_PATTERN_OFFSETS
16300  PERL_UNUSED_ARG(name);
16301 #else
16302  if (RExC_offsets) {         /* MJD */
16303   MJD_OFFSET_DEBUG(
16304    ("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n",
16305    name, __LINE__,
16306    PL_reg_name[op],
16307    (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0]
16308     ? "Overwriting end of array!\n" : "OK",
16309    (UV)(RExC_emit - RExC_emit_start),
16310    (UV)(RExC_parse - RExC_start),
16311    (UV)RExC_offsets[0]));
16312   Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
16313  }
16314 #endif
16315  return(ret);
16316 }
16317
16318 /*
16319 - reg_node - emit a node
16320 */
16321 STATIC regnode *   /* Location. */
16322 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
16323 {
16324  regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg_node");
16325
16326  PERL_ARGS_ASSERT_REG_NODE;
16327
16328  assert(regarglen[op] == 0);
16329
16330  if (PASS2) {
16331   regnode *ptr = ret;
16332   FILL_ADVANCE_NODE(ptr, op);
16333  REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 1);
16334   RExC_emit = ptr;
16335  }
16336  return(ret);
16337 }
16338
16339 /*
16340 - reganode - emit a node with an argument
16341 */
16342 STATIC regnode *   /* Location. */
16343 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
16344 {
16345  regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reganode");
16346
16347  PERL_ARGS_ASSERT_REGANODE;
16348
16349  assert(regarglen[op] == 1);
16350
16351  if (PASS2) {
16352   regnode *ptr = ret;
16353   FILL_ADVANCE_NODE_ARG(ptr, op, arg);
16354  REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 2);
16355   RExC_emit = ptr;
16356  }
16357  return(ret);
16358 }
16359
16360 STATIC regnode *
16361 S_reg2Lanode(pTHX_ RExC_state_t *pRExC_state, const U8 op, const U32 arg1, const I32 arg2)
16362 {
16363  /* emit a node with U32 and I32 arguments */
16364
16365  regnode * const ret = regnode_guts(pRExC_state, op, regarglen[op], "reg2Lanode");
16366
16367  PERL_ARGS_ASSERT_REG2LANODE;
16368
16369  assert(regarglen[op] == 2);
16370
16371  if (PASS2) {
16372   regnode *ptr = ret;
16373   FILL_ADVANCE_NODE_2L_ARG(ptr, op, arg1, arg2);
16374   RExC_emit = ptr;
16375  }
16376  return(ret);
16377 }
16378
16379 /*
16380 - reginsert - insert an operator in front of already-emitted operand
16381 *
16382 * Means relocating the operand.
16383 */
16384 STATIC void
16385 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
16386 {
16387  regnode *src;
16388  regnode *dst;
16389  regnode *place;
16390  const int offset = regarglen[(U8)op];
16391  const int size = NODE_STEP_REGNODE + offset;
16392  GET_RE_DEBUG_FLAGS_DECL;
16393
16394  PERL_ARGS_ASSERT_REGINSERT;
16395  PERL_UNUSED_CONTEXT;
16396  PERL_UNUSED_ARG(depth);
16397 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
16398  DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
16399  if (SIZE_ONLY) {
16400   RExC_size += size;
16401   return;
16402  }
16403
16404  src = RExC_emit;
16405  RExC_emit += size;
16406  dst = RExC_emit;
16407  if (RExC_open_parens) {
16408   int paren;
16409   /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
16410   for ( paren=0 ; paren < RExC_npar ; paren++ ) {
16411    if ( RExC_open_parens[paren] >= opnd ) {
16412     /*DEBUG_PARSE_FMT("open"," - %d",size);*/
16413     RExC_open_parens[paren] += size;
16414    } else {
16415     /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
16416    }
16417    if ( RExC_close_parens[paren] >= opnd ) {
16418     /*DEBUG_PARSE_FMT("close"," - %d",size);*/
16419     RExC_close_parens[paren] += size;
16420    } else {
16421     /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
16422    }
16423   }
16424  }
16425
16426  while (src > opnd) {
16427   StructCopy(--src, --dst, regnode);
16428 #ifdef RE_TRACK_PATTERN_OFFSETS
16429   if (RExC_offsets) {     /* MJD 20010112 */
16430    MJD_OFFSET_DEBUG(
16431     ("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
16432     "reg_insert",
16433     __LINE__,
16434     PL_reg_name[op],
16435     (UV)(dst - RExC_emit_start) > RExC_offsets[0]
16436      ? "Overwriting end of array!\n" : "OK",
16437     (UV)(src - RExC_emit_start),
16438     (UV)(dst - RExC_emit_start),
16439     (UV)RExC_offsets[0]));
16440    Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
16441    Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
16442   }
16443 #endif
16444  }
16445
16446
16447  place = opnd;  /* Op node, where operand used to be. */
16448 #ifdef RE_TRACK_PATTERN_OFFSETS
16449  if (RExC_offsets) {         /* MJD */
16450   MJD_OFFSET_DEBUG(
16451    ("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n",
16452    "reginsert",
16453    __LINE__,
16454    PL_reg_name[op],
16455    (UV)(place - RExC_emit_start) > RExC_offsets[0]
16456    ? "Overwriting end of array!\n" : "OK",
16457    (UV)(place - RExC_emit_start),
16458    (UV)(RExC_parse - RExC_start),
16459    (UV)RExC_offsets[0]));
16460   Set_Node_Offset(place, RExC_parse);
16461   Set_Node_Length(place, 1);
16462  }
16463 #endif
16464  src = NEXTOPER(place);
16465  FILL_ADVANCE_NODE(place, op);
16466  REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (place) - 1);
16467  Zero(src, offset, regnode);
16468 }
16469
16470 /*
16471 - regtail - set the next-pointer at the end of a node chain of p to val.
16472 - SEE ALSO: regtail_study
16473 */
16474 /* TODO: All three parms should be const */
16475 STATIC void
16476 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p,
16477     const regnode *val,U32 depth)
16478 {
16479  regnode *scan;
16480  GET_RE_DEBUG_FLAGS_DECL;
16481
16482  PERL_ARGS_ASSERT_REGTAIL;
16483 #ifndef DEBUGGING
16484  PERL_UNUSED_ARG(depth);
16485 #endif
16486
16487  if (SIZE_ONLY)
16488   return;
16489
16490  /* Find last node. */
16491  scan = p;
16492  for (;;) {
16493   regnode * const temp = regnext(scan);
16494   DEBUG_PARSE_r({
16495    DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
16496    regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
16497    PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
16498     SvPV_nolen_const(RExC_mysv), REG_NODE_NUM(scan),
16499      (temp == NULL ? "->" : ""),
16500      (temp == NULL ? PL_reg_name[OP(val)] : "")
16501    );
16502   });
16503   if (temp == NULL)
16504    break;
16505   scan = temp;
16506  }
16507
16508  if (reg_off_by_arg[OP(scan)]) {
16509   ARG_SET(scan, val - scan);
16510  }
16511  else {
16512   NEXT_OFF(scan) = val - scan;
16513  }
16514 }
16515
16516 #ifdef DEBUGGING
16517 /*
16518 - regtail_study - set the next-pointer at the end of a node chain of p to val.
16519 - Look for optimizable sequences at the same time.
16520 - currently only looks for EXACT chains.
16521
16522 This is experimental code. The idea is to use this routine to perform
16523 in place optimizations on branches and groups as they are constructed,
16524 with the long term intention of removing optimization from study_chunk so
16525 that it is purely analytical.
16526
16527 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
16528 to control which is which.
16529
16530 */
16531 /* TODO: All four parms should be const */
16532
16533 STATIC U8
16534 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p,
16535      const regnode *val,U32 depth)
16536 {
16537  regnode *scan;
16538  U8 exact = PSEUDO;
16539 #ifdef EXPERIMENTAL_INPLACESCAN
16540  I32 min = 0;
16541 #endif
16542  GET_RE_DEBUG_FLAGS_DECL;
16543
16544  PERL_ARGS_ASSERT_REGTAIL_STUDY;
16545
16546
16547  if (SIZE_ONLY)
16548   return exact;
16549
16550  /* Find last node. */
16551
16552  scan = p;
16553  for (;;) {
16554   regnode * const temp = regnext(scan);
16555 #ifdef EXPERIMENTAL_INPLACESCAN
16556   if (PL_regkind[OP(scan)] == EXACT) {
16557    bool unfolded_multi_char; /* Unexamined in this routine */
16558    if (join_exact(pRExC_state, scan, &min,
16559       &unfolded_multi_char, 1, val, depth+1))
16560     return EXACT;
16561   }
16562 #endif
16563   if ( exact ) {
16564    switch (OP(scan)) {
16565     case EXACT:
16566     case EXACTL:
16567     case EXACTF:
16568     case EXACTFA_NO_TRIE:
16569     case EXACTFA:
16570     case EXACTFU:
16571     case EXACTFLU8:
16572     case EXACTFU_SS:
16573     case EXACTFL:
16574       if( exact == PSEUDO )
16575        exact= OP(scan);
16576       else if ( exact != OP(scan) )
16577        exact= 0;
16578     case NOTHING:
16579      break;
16580     default:
16581      exact= 0;
16582    }
16583   }
16584   DEBUG_PARSE_r({
16585    DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
16586    regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
16587    PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
16588     SvPV_nolen_const(RExC_mysv),
16589     REG_NODE_NUM(scan),
16590     PL_reg_name[exact]);
16591   });
16592   if (temp == NULL)
16593    break;
16594   scan = temp;
16595  }
16596  DEBUG_PARSE_r({
16597   DEBUG_PARSE_MSG("");
16598   regprop(RExC_rx, RExC_mysv, val, NULL, pRExC_state);
16599   PerlIO_printf(Perl_debug_log,
16600      "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
16601      SvPV_nolen_const(RExC_mysv),
16602      (IV)REG_NODE_NUM(val),
16603      (IV)(val - scan)
16604   );
16605  });
16606  if (reg_off_by_arg[OP(scan)]) {
16607   ARG_SET(scan, val - scan);
16608  }
16609  else {
16610   NEXT_OFF(scan) = val - scan;
16611  }
16612
16613  return exact;
16614 }
16615 #endif
16616
16617 /*
16618  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
16619  */
16620 #ifdef DEBUGGING
16621
16622 static void
16623 S_regdump_intflags(pTHX_ const char *lead, const U32 flags)
16624 {
16625  int bit;
16626  int set=0;
16627
16628  ASSUME(REG_INTFLAGS_NAME_SIZE <= sizeof(flags)*8);
16629
16630  for (bit=0; bit<REG_INTFLAGS_NAME_SIZE; bit++) {
16631   if (flags & (1<<bit)) {
16632    if (!set++ && lead)
16633     PerlIO_printf(Perl_debug_log, "%s",lead);
16634    PerlIO_printf(Perl_debug_log, "%s ",PL_reg_intflags_name[bit]);
16635   }
16636  }
16637  if (lead)  {
16638   if (set)
16639    PerlIO_printf(Perl_debug_log, "\n");
16640   else
16641    PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
16642  }
16643 }
16644
16645 static void
16646 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
16647 {
16648  int bit;
16649  int set=0;
16650  regex_charset cs;
16651
16652  ASSUME(REG_EXTFLAGS_NAME_SIZE <= sizeof(flags)*8);
16653
16654  for (bit=0; bit<REG_EXTFLAGS_NAME_SIZE; bit++) {
16655   if (flags & (1<<bit)) {
16656    if ((1<<bit) & RXf_PMf_CHARSET) { /* Output separately, below */
16657     continue;
16658    }
16659    if (!set++ && lead)
16660     PerlIO_printf(Perl_debug_log, "%s",lead);
16661    PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
16662   }
16663  }
16664  if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
16665    if (!set++ && lead) {
16666     PerlIO_printf(Perl_debug_log, "%s",lead);
16667    }
16668    switch (cs) {
16669     case REGEX_UNICODE_CHARSET:
16670      PerlIO_printf(Perl_debug_log, "UNICODE");
16671      break;
16672     case REGEX_LOCALE_CHARSET:
16673      PerlIO_printf(Perl_debug_log, "LOCALE");
16674      break;
16675     case REGEX_ASCII_RESTRICTED_CHARSET:
16676      PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
16677      break;
16678     case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
16679      PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
16680      break;
16681     default:
16682      PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
16683      break;
16684    }
16685  }
16686  if (lead)  {
16687   if (set)
16688    PerlIO_printf(Perl_debug_log, "\n");
16689   else
16690    PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
16691  }
16692 }
16693 #endif
16694
16695 void
16696 Perl_regdump(pTHX_ const regexp *r)
16697 {
16698 #ifdef DEBUGGING
16699  SV * const sv = sv_newmortal();
16700  SV *dsv= sv_newmortal();
16701  RXi_GET_DECL(r,ri);
16702  GET_RE_DEBUG_FLAGS_DECL;
16703
16704  PERL_ARGS_ASSERT_REGDUMP;
16705
16706  (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
16707
16708  /* Header fields of interest. */
16709  if (r->anchored_substr) {
16710   RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr),
16711    RE_SV_DUMPLEN(r->anchored_substr), 30);
16712   PerlIO_printf(Perl_debug_log,
16713      "anchored %s%s at %"IVdf" ",
16714      s, RE_SV_TAIL(r->anchored_substr),
16715      (IV)r->anchored_offset);
16716  } else if (r->anchored_utf8) {
16717   RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8),
16718    RE_SV_DUMPLEN(r->anchored_utf8), 30);
16719   PerlIO_printf(Perl_debug_log,
16720      "anchored utf8 %s%s at %"IVdf" ",
16721      s, RE_SV_TAIL(r->anchored_utf8),
16722      (IV)r->anchored_offset);
16723  }
16724  if (r->float_substr) {
16725   RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr),
16726    RE_SV_DUMPLEN(r->float_substr), 30);
16727   PerlIO_printf(Perl_debug_log,
16728      "floating %s%s at %"IVdf"..%"UVuf" ",
16729      s, RE_SV_TAIL(r->float_substr),
16730      (IV)r->float_min_offset, (UV)r->float_max_offset);
16731  } else if (r->float_utf8) {
16732   RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8),
16733    RE_SV_DUMPLEN(r->float_utf8), 30);
16734   PerlIO_printf(Perl_debug_log,
16735      "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
16736      s, RE_SV_TAIL(r->float_utf8),
16737      (IV)r->float_min_offset, (UV)r->float_max_offset);
16738  }
16739  if (r->check_substr || r->check_utf8)
16740   PerlIO_printf(Perl_debug_log,
16741      (const char *)
16742      (r->check_substr == r->float_substr
16743      && r->check_utf8 == r->float_utf8
16744      ? "(checking floating" : "(checking anchored"));
16745  if (r->intflags & PREGf_NOSCAN)
16746   PerlIO_printf(Perl_debug_log, " noscan");
16747  if (r->extflags & RXf_CHECK_ALL)
16748   PerlIO_printf(Perl_debug_log, " isall");
16749  if (r->check_substr || r->check_utf8)
16750   PerlIO_printf(Perl_debug_log, ") ");
16751
16752  if (ri->regstclass) {
16753   regprop(r, sv, ri->regstclass, NULL, NULL);
16754   PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
16755  }
16756  if (r->intflags & PREGf_ANCH) {
16757   PerlIO_printf(Perl_debug_log, "anchored");
16758   if (r->intflags & PREGf_ANCH_MBOL)
16759    PerlIO_printf(Perl_debug_log, "(MBOL)");
16760   if (r->intflags & PREGf_ANCH_SBOL)
16761    PerlIO_printf(Perl_debug_log, "(SBOL)");
16762   if (r->intflags & PREGf_ANCH_GPOS)
16763    PerlIO_printf(Perl_debug_log, "(GPOS)");
16764   PerlIO_putc(Perl_debug_log, ' ');
16765  }
16766  if (r->intflags & PREGf_GPOS_SEEN)
16767   PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
16768  if (r->intflags & PREGf_SKIP)
16769   PerlIO_printf(Perl_debug_log, "plus ");
16770  if (r->intflags & PREGf_IMPLICIT)
16771   PerlIO_printf(Perl_debug_log, "implicit ");
16772  PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
16773  if (r->extflags & RXf_EVAL_SEEN)
16774   PerlIO_printf(Perl_debug_log, "with eval ");
16775  PerlIO_printf(Perl_debug_log, "\n");
16776  DEBUG_FLAGS_r({
16777   regdump_extflags("r->extflags: ",r->extflags);
16778   regdump_intflags("r->intflags: ",r->intflags);
16779  });
16780 #else
16781  PERL_ARGS_ASSERT_REGDUMP;
16782  PERL_UNUSED_CONTEXT;
16783  PERL_UNUSED_ARG(r);
16784 #endif /* DEBUGGING */
16785 }
16786
16787 /*
16788 - regprop - printable representation of opcode, with run time support
16789 */
16790
16791 void
16792 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o, const regmatch_info *reginfo, const RExC_state_t *pRExC_state)
16793 {
16794 #ifdef DEBUGGING
16795  int k;
16796
16797  /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
16798  static const char * const anyofs[] = {
16799 #if _CC_WORDCHAR != 0 || _CC_DIGIT != 1 || _CC_ALPHA != 2 || _CC_LOWER != 3 \
16800  || _CC_UPPER != 4 || _CC_PUNCT != 5 || _CC_PRINT != 6                   \
16801  || _CC_ALPHANUMERIC != 7 || _CC_GRAPH != 8 || _CC_CASED != 9            \
16802  || _CC_SPACE != 10 || _CC_BLANK != 11 || _CC_XDIGIT != 12               \
16803  || _CC_CNTRL != 13 || _CC_ASCII != 14 || _CC_VERTSPACE != 15
16804   #error Need to adjust order of anyofs[]
16805 #endif
16806   "\\w",
16807   "\\W",
16808   "\\d",
16809   "\\D",
16810   "[:alpha:]",
16811   "[:^alpha:]",
16812   "[:lower:]",
16813   "[:^lower:]",
16814   "[:upper:]",
16815   "[:^upper:]",
16816   "[:punct:]",
16817   "[:^punct:]",
16818   "[:print:]",
16819   "[:^print:]",
16820   "[:alnum:]",
16821   "[:^alnum:]",
16822   "[:graph:]",
16823   "[:^graph:]",
16824   "[:cased:]",
16825   "[:^cased:]",
16826   "\\s",
16827   "\\S",
16828   "[:blank:]",
16829   "[:^blank:]",
16830   "[:xdigit:]",
16831   "[:^xdigit:]",
16832   "[:cntrl:]",
16833   "[:^cntrl:]",
16834   "[:ascii:]",
16835   "[:^ascii:]",
16836   "\\v",
16837   "\\V"
16838  };
16839  RXi_GET_DECL(prog,progi);
16840  GET_RE_DEBUG_FLAGS_DECL;
16841
16842  PERL_ARGS_ASSERT_REGPROP;
16843
16844  sv_setpvn(sv, "", 0);
16845
16846  if (OP(o) > REGNODE_MAX)  /* regnode.type is unsigned */
16847   /* It would be nice to FAIL() here, but this may be called from
16848   regexec.c, and it would be hard to supply pRExC_state. */
16849   Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
16850            (int)OP(o), (int)REGNODE_MAX);
16851  sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
16852
16853  k = PL_regkind[OP(o)];
16854
16855  if (k == EXACT) {
16856   sv_catpvs(sv, " ");
16857   /* Using is_utf8_string() (via PERL_PV_UNI_DETECT)
16858   * is a crude hack but it may be the best for now since
16859   * we have no flag "this EXACTish node was UTF-8"
16860   * --jhi */
16861   pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
16862     PERL_PV_ESCAPE_UNI_DETECT |
16863     PERL_PV_ESCAPE_NONASCII   |
16864     PERL_PV_PRETTY_ELLIPSES   |
16865     PERL_PV_PRETTY_LTGT       |
16866     PERL_PV_PRETTY_NOCLEAR
16867     );
16868  } else if (k == TRIE) {
16869   /* print the details of the trie in dumpuntil instead, as
16870   * progi->data isn't available here */
16871   const char op = OP(o);
16872   const U32 n = ARG(o);
16873   const reg_ac_data * const ac = IS_TRIE_AC(op) ?
16874    (reg_ac_data *)progi->data->data[n] :
16875    NULL;
16876   const reg_trie_data * const trie
16877    = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
16878
16879   Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
16880   DEBUG_TRIE_COMPILE_r(
16881   Perl_sv_catpvf(aTHX_ sv,
16882    "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
16883    (UV)trie->startstate,
16884    (IV)trie->statecount-1, /* -1 because of the unused 0 element */
16885    (UV)trie->wordcount,
16886    (UV)trie->minlen,
16887    (UV)trie->maxlen,
16888    (UV)TRIE_CHARCOUNT(trie),
16889    (UV)trie->uniquecharcount
16890   );
16891   );
16892   if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
16893    sv_catpvs(sv, "[");
16894    (void) put_charclass_bitmap_innards(sv,
16895             (IS_ANYOF_TRIE(op))
16896             ? ANYOF_BITMAP(o)
16897             : TRIE_BITMAP(trie),
16898             NULL);
16899    sv_catpvs(sv, "]");
16900   }
16901
16902  } else if (k == CURLY) {
16903   if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
16904    Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
16905   Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
16906  }
16907  else if (k == WHILEM && o->flags)   /* Ordinal/of */
16908   Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
16909  else if (k == REF || k == OPEN || k == CLOSE
16910    || k == GROUPP || OP(o)==ACCEPT)
16911  {
16912   AV *name_list= NULL;
16913   Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o)); /* Parenth number */
16914   if ( RXp_PAREN_NAMES(prog) ) {
16915    name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
16916   } else if ( pRExC_state ) {
16917    name_list= RExC_paren_name_list;
16918   }
16919   if (name_list) {
16920    if ( k != REF || (OP(o) < NREF)) {
16921     SV **name= av_fetch(name_list, ARG(o), 0 );
16922     if (name)
16923      Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16924    }
16925    else {
16926     SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
16927     I32 *nums=(I32*)SvPVX(sv_dat);
16928     SV **name= av_fetch(name_list, nums[0], 0 );
16929     I32 n;
16930     if (name) {
16931      for ( n=0; n<SvIVX(sv_dat); n++ ) {
16932       Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
16933          (n ? "," : ""), (IV)nums[n]);
16934      }
16935      Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16936     }
16937    }
16938   }
16939   if ( k == REF && reginfo) {
16940    U32 n = ARG(o);  /* which paren pair */
16941    I32 ln = prog->offs[n].start;
16942    if (prog->lastparen < n || ln == -1)
16943     Perl_sv_catpvf(aTHX_ sv, ": FAIL");
16944    else if (ln == prog->offs[n].end)
16945     Perl_sv_catpvf(aTHX_ sv, ": ACCEPT - EMPTY STRING");
16946    else {
16947     const char *s = reginfo->strbeg + ln;
16948     Perl_sv_catpvf(aTHX_ sv, ": ");
16949     Perl_pv_pretty( aTHX_ sv, s, prog->offs[n].end - prog->offs[n].start, 32, 0, 0,
16950      PERL_PV_ESCAPE_UNI_DETECT|PERL_PV_PRETTY_NOCLEAR|PERL_PV_PRETTY_ELLIPSES|PERL_PV_PRETTY_QUOTE );
16951    }
16952   }
16953  } else if (k == GOSUB) {
16954   AV *name_list= NULL;
16955   if ( RXp_PAREN_NAMES(prog) ) {
16956    name_list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
16957   } else if ( pRExC_state ) {
16958    name_list= RExC_paren_name_list;
16959   }
16960
16961   /* Paren and offset */
16962   Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o));
16963   if (name_list) {
16964    SV **name= av_fetch(name_list, ARG(o), 0 );
16965    if (name)
16966     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
16967   }
16968  }
16969  else if (k == VERB) {
16970   if (!o->flags)
16971    Perl_sv_catpvf(aTHX_ sv, ":%"SVf,
16972       SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
16973  } else if (k == LOGICAL)
16974   /* 2: embedded, otherwise 1 */
16975   Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);
16976  else if (k == ANYOF) {
16977   const U8 flags = ANYOF_FLAGS(o);
16978   int do_sep = 0;
16979   SV* bitmap_invlist;  /* Will hold what the bit map contains */
16980
16981
16982   if (OP(o) == ANYOFL)
16983    sv_catpvs(sv, "{loc}");
16984   if (flags & ANYOF_LOC_FOLD)
16985    sv_catpvs(sv, "{i}");
16986   Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
16987   if (flags & ANYOF_INVERT)
16988    sv_catpvs(sv, "^");
16989
16990   /* output what the standard cp 0-NUM_ANYOF_CODE_POINTS-1 bitmap matches
16991   * */
16992   do_sep = put_charclass_bitmap_innards(sv, ANYOF_BITMAP(o),
16993                &bitmap_invlist);
16994
16995   /* output any special charclass tests (used entirely under use
16996   * locale) * */
16997   if (ANYOF_POSIXL_TEST_ANY_SET(o)) {
16998    int i;
16999    for (i = 0; i < ANYOF_POSIXL_MAX; i++) {
17000     if (ANYOF_POSIXL_TEST(o,i)) {
17001      sv_catpv(sv, anyofs[i]);
17002      do_sep = 1;
17003     }
17004    }
17005   }
17006
17007   if ((flags & (ANYOF_MATCHES_ALL_ABOVE_BITMAP
17008      |ANYOF_HAS_UTF8_NONBITMAP_MATCHES
17009      |ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES
17010      |ANYOF_LOC_FOLD)))
17011   {
17012    if (do_sep) {
17013     Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]);
17014     if (flags & ANYOF_INVERT)
17015      /*make sure the invert info is in each */
17016      sv_catpvs(sv, "^");
17017    }
17018
17019    if (flags & ANYOF_MATCHES_ALL_NON_UTF8_NON_ASCII) {
17020     sv_catpvs(sv, "{non-utf8-latin1-all}");
17021    }
17022
17023    if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP)
17024     sv_catpvs(sv, "{above_bitmap_all}");
17025
17026    if (ARG(o) != ANYOF_ONLY_HAS_BITMAP) {
17027     SV *lv; /* Set if there is something outside the bit map. */
17028     bool byte_output = FALSE;   /* If something has been output */
17029     SV *only_utf8_locale;
17030
17031     /* Get the stuff that wasn't in the bitmap.  'bitmap_invlist'
17032     * is used to guarantee that nothing in the bitmap gets
17033     * returned */
17034     (void) _get_regclass_nonbitmap_data(prog, o, FALSE,
17035              &lv, &only_utf8_locale,
17036              bitmap_invlist);
17037     if (lv && lv != &PL_sv_undef) {
17038      char *s = savesvpv(lv);
17039      char * const origs = s;
17040
17041      while (*s && *s != '\n')
17042       s++;
17043
17044      if (*s == '\n') {
17045       const char * const t = ++s;
17046
17047       if (flags & ANYOF_HAS_NONBITMAP_NON_UTF8_MATCHES) {
17048        sv_catpvs(sv, "{outside bitmap}");
17049       }
17050       else {
17051        sv_catpvs(sv, "{utf8}");
17052       }
17053
17054       if (byte_output) {
17055        sv_catpvs(sv, " ");
17056       }
17057
17058       while (*s) {
17059        if (*s == '\n') {
17060
17061         /* Truncate very long output */
17062         if (s - origs > 256) {
17063          Perl_sv_catpvf(aTHX_ sv,
17064             "%.*s...",
17065             (int) (s - origs - 1),
17066             t);
17067          goto out_dump;
17068         }
17069         *s = ' ';
17070        }
17071        else if (*s == '\t') {
17072         *s = '-';
17073        }
17074        s++;
17075       }
17076       if (s[-1] == ' ')
17077        s[-1] = 0;
17078
17079       sv_catpv(sv, t);
17080      }
17081
17082     out_dump:
17083
17084      Safefree(origs);
17085      SvREFCNT_dec_NN(lv);
17086     }
17087
17088     if ((flags & ANYOF_LOC_FOLD)
17089      && only_utf8_locale
17090      && only_utf8_locale != &PL_sv_undef)
17091     {
17092      UV start, end;
17093      int max_entries = 256;
17094
17095      sv_catpvs(sv, "{utf8 locale}");
17096      invlist_iterinit(only_utf8_locale);
17097      while (invlist_iternext(only_utf8_locale,
17098            &start, &end)) {
17099       put_range(sv, start, end, FALSE);
17100       max_entries --;
17101       if (max_entries < 0) {
17102        sv_catpvs(sv, "...");
17103        break;
17104       }
17105      }
17106      invlist_iterfinish(only_utf8_locale);
17107     }
17108    }
17109   }
17110   SvREFCNT_dec(bitmap_invlist);
17111
17112
17113   Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
17114  }
17115  else if (k == POSIXD || k == NPOSIXD) {
17116   U8 index = FLAGS(o) * 2;
17117   if (index < C_ARRAY_LENGTH(anyofs)) {
17118    if (*anyofs[index] != '[')  {
17119     sv_catpv(sv, "[");
17120    }
17121    sv_catpv(sv, anyofs[index]);
17122    if (*anyofs[index] != '[')  {
17123     sv_catpv(sv, "]");
17124    }
17125   }
17126   else {
17127    Perl_sv_catpvf(aTHX_ sv, "[illegal type=%d])", index);
17128   }
17129  }
17130  else if (k == BOUND || k == NBOUND) {
17131   /* Must be synced with order of 'bound_type' in regcomp.h */
17132   const char * const bounds[] = {
17133    "",      /* Traditional */
17134    "{gcb}",
17135    "{sb}",
17136    "{wb}"
17137   };
17138   sv_catpv(sv, bounds[FLAGS(o)]);
17139  }
17140  else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
17141   Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
17142  else if (OP(o) == SBOL)
17143   Perl_sv_catpvf(aTHX_ sv, " /%s/", o->flags ? "\\A" : "^");
17144 #else
17145  PERL_UNUSED_CONTEXT;
17146  PERL_UNUSED_ARG(sv);
17147  PERL_UNUSED_ARG(o);
17148  PERL_UNUSED_ARG(prog);
17149  PERL_UNUSED_ARG(reginfo);
17150  PERL_UNUSED_ARG(pRExC_state);
17151 #endif /* DEBUGGING */
17152 }
17153
17154
17155
17156 SV *
17157 Perl_re_intuit_string(pTHX_ REGEXP * const r)
17158 {    /* Assume that RE_INTUIT is set */
17159  struct regexp *const prog = ReANY(r);
17160  GET_RE_DEBUG_FLAGS_DECL;
17161
17162  PERL_ARGS_ASSERT_RE_INTUIT_STRING;
17163  PERL_UNUSED_CONTEXT;
17164
17165  DEBUG_COMPILE_r(
17166   {
17167    const char * const s = SvPV_nolen_const(RX_UTF8(r)
17168      ? prog->check_utf8 : prog->check_substr);
17169
17170    if (!PL_colorset) reginitcolors();
17171    PerlIO_printf(Perl_debug_log,
17172      "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
17173      PL_colors[4],
17174      RX_UTF8(r) ? "utf8 " : "",
17175      PL_colors[5],PL_colors[0],
17176      s,
17177      PL_colors[1],
17178      (strlen(s) > 60 ? "..." : ""));
17179   } );
17180
17181  /* use UTF8 check substring if regexp pattern itself is in UTF8 */
17182  return RX_UTF8(r) ? prog->check_utf8 : prog->check_substr;
17183 }
17184
17185 /*
17186    pregfree()
17187
17188    handles refcounting and freeing the perl core regexp structure. When
17189    it is necessary to actually free the structure the first thing it
17190    does is call the 'free' method of the regexp_engine associated to
17191    the regexp, allowing the handling of the void *pprivate; member
17192    first. (This routine is not overridable by extensions, which is why
17193    the extensions free is called first.)
17194
17195    See regdupe and regdupe_internal if you change anything here.
17196 */
17197 #ifndef PERL_IN_XSUB_RE
17198 void
17199 Perl_pregfree(pTHX_ REGEXP *r)
17200 {
17201  SvREFCNT_dec(r);
17202 }
17203
17204 void
17205 Perl_pregfree2(pTHX_ REGEXP *rx)
17206 {
17207  struct regexp *const r = ReANY(rx);
17208  GET_RE_DEBUG_FLAGS_DECL;
17209
17210  PERL_ARGS_ASSERT_PREGFREE2;
17211
17212  if (r->mother_re) {
17213   ReREFCNT_dec(r->mother_re);
17214  } else {
17215   CALLREGFREE_PVT(rx); /* free the private data */
17216   SvREFCNT_dec(RXp_PAREN_NAMES(r));
17217   Safefree(r->xpv_len_u.xpvlenu_pv);
17218  }
17219  if (r->substrs) {
17220   SvREFCNT_dec(r->anchored_substr);
17221   SvREFCNT_dec(r->anchored_utf8);
17222   SvREFCNT_dec(r->float_substr);
17223   SvREFCNT_dec(r->float_utf8);
17224   Safefree(r->substrs);
17225  }
17226  RX_MATCH_COPY_FREE(rx);
17227 #ifdef PERL_ANY_COW
17228  SvREFCNT_dec(r->saved_copy);
17229 #endif
17230  Safefree(r->offs);
17231  SvREFCNT_dec(r->qr_anoncv);
17232  rx->sv_u.svu_rx = 0;
17233 }
17234
17235 /*  reg_temp_copy()
17236
17237  This is a hacky workaround to the structural issue of match results
17238  being stored in the regexp structure which is in turn stored in
17239  PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
17240  could be PL_curpm in multiple contexts, and could require multiple
17241  result sets being associated with the pattern simultaneously, such
17242  as when doing a recursive match with (??{$qr})
17243
17244  The solution is to make a lightweight copy of the regexp structure
17245  when a qr// is returned from the code executed by (??{$qr}) this
17246  lightweight copy doesn't actually own any of its data except for
17247  the starp/end and the actual regexp structure itself.
17248
17249 */
17250
17251
17252 REGEXP *
17253 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
17254 {
17255  struct regexp *ret;
17256  struct regexp *const r = ReANY(rx);
17257  const bool islv = ret_x && SvTYPE(ret_x) == SVt_PVLV;
17258
17259  PERL_ARGS_ASSERT_REG_TEMP_COPY;
17260
17261  if (!ret_x)
17262   ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
17263  else {
17264   SvOK_off((SV *)ret_x);
17265   if (islv) {
17266    /* For PVLVs, SvANY points to the xpvlv body while sv_u points
17267    to the regexp.  (For SVt_REGEXPs, sv_upgrade has already
17268    made both spots point to the same regexp body.) */
17269    REGEXP *temp = (REGEXP *)newSV_type(SVt_REGEXP);
17270    assert(!SvPVX(ret_x));
17271    ret_x->sv_u.svu_rx = temp->sv_any;
17272    temp->sv_any = NULL;
17273    SvFLAGS(temp) = (SvFLAGS(temp) & ~SVTYPEMASK) | SVt_NULL;
17274    SvREFCNT_dec_NN(temp);
17275    /* SvCUR still resides in the xpvlv struct, so the regexp copy-
17276    ing below will not set it. */
17277    SvCUR_set(ret_x, SvCUR(rx));
17278   }
17279  }
17280  /* This ensures that SvTHINKFIRST(sv) is true, and hence that
17281  sv_force_normal(sv) is called.  */
17282  SvFAKE_on(ret_x);
17283  ret = ReANY(ret_x);
17284
17285  SvFLAGS(ret_x) |= SvUTF8(rx);
17286  /* We share the same string buffer as the original regexp, on which we
17287  hold a reference count, incremented when mother_re is set below.
17288  The string pointer is copied here, being part of the regexp struct.
17289  */
17290  memcpy(&(ret->xpv_cur), &(r->xpv_cur),
17291   sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
17292  if (r->offs) {
17293   const I32 npar = r->nparens+1;
17294   Newx(ret->offs, npar, regexp_paren_pair);
17295   Copy(r->offs, ret->offs, npar, regexp_paren_pair);
17296  }
17297  if (r->substrs) {
17298   Newx(ret->substrs, 1, struct reg_substr_data);
17299   StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
17300
17301   SvREFCNT_inc_void(ret->anchored_substr);
17302   SvREFCNT_inc_void(ret->anchored_utf8);
17303   SvREFCNT_inc_void(ret->float_substr);
17304   SvREFCNT_inc_void(ret->float_utf8);
17305
17306   /* check_substr and check_utf8, if non-NULL, point to either their
17307   anchored or float namesakes, and don't hold a second reference.  */
17308  }
17309  RX_MATCH_COPIED_off(ret_x);
17310 #ifdef PERL_ANY_COW
17311  ret->saved_copy = NULL;
17312 #endif
17313  ret->mother_re = ReREFCNT_inc(r->mother_re ? r->mother_re : rx);
17314  SvREFCNT_inc_void(ret->qr_anoncv);
17315
17316  return ret_x;
17317 }
17318 #endif
17319
17320 /* regfree_internal()
17321
17322    Free the private data in a regexp. This is overloadable by
17323    extensions. Perl takes care of the regexp structure in pregfree(),
17324    this covers the *pprivate pointer which technically perl doesn't
17325    know about, however of course we have to handle the
17326    regexp_internal structure when no extension is in use.
17327
17328    Note this is called before freeing anything in the regexp
17329    structure.
17330  */
17331
17332 void
17333 Perl_regfree_internal(pTHX_ REGEXP * const rx)
17334 {
17335  struct regexp *const r = ReANY(rx);
17336  RXi_GET_DECL(r,ri);
17337  GET_RE_DEBUG_FLAGS_DECL;
17338
17339  PERL_ARGS_ASSERT_REGFREE_INTERNAL;
17340
17341  DEBUG_COMPILE_r({
17342   if (!PL_colorset)
17343    reginitcolors();
17344   {
17345    SV *dsv= sv_newmortal();
17346    RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
17347     dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
17348    PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n",
17349     PL_colors[4],PL_colors[5],s);
17350   }
17351  });
17352 #ifdef RE_TRACK_PATTERN_OFFSETS
17353  if (ri->u.offsets)
17354   Safefree(ri->u.offsets);             /* 20010421 MJD */
17355 #endif
17356  if (ri->code_blocks) {
17357   int n;
17358   for (n = 0; n < ri->num_code_blocks; n++)
17359    SvREFCNT_dec(ri->code_blocks[n].src_regex);
17360   Safefree(ri->code_blocks);
17361  }
17362
17363  if (ri->data) {
17364   int n = ri->data->count;
17365
17366   while (--n >= 0) {
17367   /* If you add a ->what type here, update the comment in regcomp.h */
17368    switch (ri->data->what[n]) {
17369    case 'a':
17370    case 'r':
17371    case 's':
17372    case 'S':
17373    case 'u':
17374     SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
17375     break;
17376    case 'f':
17377     Safefree(ri->data->data[n]);
17378     break;
17379    case 'l':
17380    case 'L':
17381     break;
17382    case 'T':
17383     { /* Aho Corasick add-on structure for a trie node.
17384      Used in stclass optimization only */
17385      U32 refcount;
17386      reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
17387 #ifdef USE_ITHREADS
17388      dVAR;
17389 #endif
17390      OP_REFCNT_LOCK;
17391      refcount = --aho->refcount;
17392      OP_REFCNT_UNLOCK;
17393      if ( !refcount ) {
17394       PerlMemShared_free(aho->states);
17395       PerlMemShared_free(aho->fail);
17396       /* do this last!!!! */
17397       PerlMemShared_free(ri->data->data[n]);
17398       /* we should only ever get called once, so
17399       * assert as much, and also guard the free
17400       * which /might/ happen twice. At the least
17401       * it will make code anlyzers happy and it
17402       * doesn't cost much. - Yves */
17403       assert(ri->regstclass);
17404       if (ri->regstclass) {
17405        PerlMemShared_free(ri->regstclass);
17406        ri->regstclass = 0;
17407       }
17408      }
17409     }
17410     break;
17411    case 't':
17412     {
17413      /* trie structure. */
17414      U32 refcount;
17415      reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
17416 #ifdef USE_ITHREADS
17417      dVAR;
17418 #endif
17419      OP_REFCNT_LOCK;
17420      refcount = --trie->refcount;
17421      OP_REFCNT_UNLOCK;
17422      if ( !refcount ) {
17423       PerlMemShared_free(trie->charmap);
17424       PerlMemShared_free(trie->states);
17425       PerlMemShared_free(trie->trans);
17426       if (trie->bitmap)
17427        PerlMemShared_free(trie->bitmap);
17428       if (trie->jump)
17429        PerlMemShared_free(trie->jump);
17430       PerlMemShared_free(trie->wordinfo);
17431       /* do this last!!!! */
17432       PerlMemShared_free(ri->data->data[n]);
17433      }
17434     }
17435     break;
17436    default:
17437     Perl_croak(aTHX_ "panic: regfree data code '%c'",
17438              ri->data->what[n]);
17439    }
17440   }
17441   Safefree(ri->data->what);
17442   Safefree(ri->data);
17443  }
17444
17445  Safefree(ri);
17446 }
17447
17448 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
17449 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
17450 #define SAVEPVN(p,n) ((p) ? savepvn(p,n) : NULL)
17451
17452 /*
17453    re_dup - duplicate a regexp.
17454
17455    This routine is expected to clone a given regexp structure. It is only
17456    compiled under USE_ITHREADS.
17457
17458    After all of the core data stored in struct regexp is duplicated
17459    the regexp_engine.dupe method is used to copy any private data
17460    stored in the *pprivate pointer. This allows extensions to handle
17461    any duplication it needs to do.
17462
17463    See pregfree() and regfree_internal() if you change anything here.
17464 */
17465 #if defined(USE_ITHREADS)
17466 #ifndef PERL_IN_XSUB_RE
17467 void
17468 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
17469 {
17470  dVAR;
17471  I32 npar;
17472  const struct regexp *r = ReANY(sstr);
17473  struct regexp *ret = ReANY(dstr);
17474
17475  PERL_ARGS_ASSERT_RE_DUP_GUTS;
17476
17477  npar = r->nparens+1;
17478  Newx(ret->offs, npar, regexp_paren_pair);
17479  Copy(r->offs, ret->offs, npar, regexp_paren_pair);
17480
17481  if (ret->substrs) {
17482   /* Do it this way to avoid reading from *r after the StructCopy().
17483   That way, if any of the sv_dup_inc()s dislodge *r from the L1
17484   cache, it doesn't matter.  */
17485   const bool anchored = r->check_substr
17486    ? r->check_substr == r->anchored_substr
17487    : r->check_utf8 == r->anchored_utf8;
17488   Newx(ret->substrs, 1, struct reg_substr_data);
17489   StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
17490
17491   ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
17492   ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
17493   ret->float_substr = sv_dup_inc(ret->float_substr, param);
17494   ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
17495
17496   /* check_substr and check_utf8, if non-NULL, point to either their
17497   anchored or float namesakes, and don't hold a second reference.  */
17498
17499   if (ret->check_substr) {
17500    if (anchored) {
17501     assert(r->check_utf8 == r->anchored_utf8);
17502     ret->check_substr = ret->anchored_substr;
17503     ret->check_utf8 = ret->anchored_utf8;
17504    } else {
17505     assert(r->check_substr == r->float_substr);
17506     assert(r->check_utf8 == r->float_utf8);
17507     ret->check_substr = ret->float_substr;
17508     ret->check_utf8 = ret->float_utf8;
17509    }
17510   } else if (ret->check_utf8) {
17511    if (anchored) {
17512     ret->check_utf8 = ret->anchored_utf8;
17513    } else {
17514     ret->check_utf8 = ret->float_utf8;
17515    }
17516   }
17517  }
17518
17519  RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
17520  ret->qr_anoncv = MUTABLE_CV(sv_dup_inc((const SV *)ret->qr_anoncv, param));
17521
17522  if (ret->pprivate)
17523   RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
17524
17525  if (RX_MATCH_COPIED(dstr))
17526   ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
17527  else
17528   ret->subbeg = NULL;
17529 #ifdef PERL_ANY_COW
17530  ret->saved_copy = NULL;
17531 #endif
17532
17533  /* Whether mother_re be set or no, we need to copy the string.  We
17534  cannot refrain from copying it when the storage points directly to
17535  our mother regexp, because that's
17536    1: a buffer in a different thread
17537    2: something we no longer hold a reference on
17538    so we need to copy it locally.  */
17539  RX_WRAPPED(dstr) = SAVEPVN(RX_WRAPPED(sstr), SvCUR(sstr)+1);
17540  ret->mother_re   = NULL;
17541 }
17542 #endif /* PERL_IN_XSUB_RE */
17543
17544 /*
17545    regdupe_internal()
17546
17547    This is the internal complement to regdupe() which is used to copy
17548    the structure pointed to by the *pprivate pointer in the regexp.
17549    This is the core version of the extension overridable cloning hook.
17550    The regexp structure being duplicated will be copied by perl prior
17551    to this and will be provided as the regexp *r argument, however
17552    with the /old/ structures pprivate pointer value. Thus this routine
17553    may override any copying normally done by perl.
17554
17555    It returns a pointer to the new regexp_internal structure.
17556 */
17557
17558 void *
17559 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
17560 {
17561  dVAR;
17562  struct regexp *const r = ReANY(rx);
17563  regexp_internal *reti;
17564  int len;
17565  RXi_GET_DECL(r,ri);
17566
17567  PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
17568
17569  len = ProgLen(ri);
17570
17571  Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode),
17572   char, regexp_internal);
17573  Copy(ri->program, reti->program, len+1, regnode);
17574
17575  reti->num_code_blocks = ri->num_code_blocks;
17576  if (ri->code_blocks) {
17577   int n;
17578   Newxc(reti->code_blocks, ri->num_code_blocks, struct reg_code_block,
17579     struct reg_code_block);
17580   Copy(ri->code_blocks, reti->code_blocks, ri->num_code_blocks,
17581     struct reg_code_block);
17582   for (n = 0; n < ri->num_code_blocks; n++)
17583    reti->code_blocks[n].src_regex = (REGEXP*)
17584      sv_dup_inc((SV*)(ri->code_blocks[n].src_regex), param);
17585  }
17586  else
17587   reti->code_blocks = NULL;
17588
17589  reti->regstclass = NULL;
17590
17591  if (ri->data) {
17592   struct reg_data *d;
17593   const int count = ri->data->count;
17594   int i;
17595
17596   Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
17597     char, struct reg_data);
17598   Newx(d->what, count, U8);
17599
17600   d->count = count;
17601   for (i = 0; i < count; i++) {
17602    d->what[i] = ri->data->what[i];
17603    switch (d->what[i]) {
17604     /* see also regcomp.h and regfree_internal() */
17605    case 'a': /* actually an AV, but the dup function is identical.  */
17606    case 'r':
17607    case 's':
17608    case 'S':
17609    case 'u': /* actually an HV, but the dup function is identical.  */
17610     d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
17611     break;
17612    case 'f':
17613     /* This is cheating. */
17614     Newx(d->data[i], 1, regnode_ssc);
17615     StructCopy(ri->data->data[i], d->data[i], regnode_ssc);
17616     reti->regstclass = (regnode*)d->data[i];
17617     break;
17618    case 'T':
17619     /* Trie stclasses are readonly and can thus be shared
17620     * without duplication. We free the stclass in pregfree
17621     * when the corresponding reg_ac_data struct is freed.
17622     */
17623     reti->regstclass= ri->regstclass;
17624     /* FALLTHROUGH */
17625    case 't':
17626     OP_REFCNT_LOCK;
17627     ((reg_trie_data*)ri->data->data[i])->refcount++;
17628     OP_REFCNT_UNLOCK;
17629     /* FALLTHROUGH */
17630    case 'l':
17631    case 'L':
17632     d->data[i] = ri->data->data[i];
17633     break;
17634    default:
17635     Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'",
17636               ri->data->what[i]);
17637    }
17638   }
17639
17640   reti->data = d;
17641  }
17642  else
17643   reti->data = NULL;
17644
17645  reti->name_list_idx = ri->name_list_idx;
17646
17647 #ifdef RE_TRACK_PATTERN_OFFSETS
17648  if (ri->u.offsets) {
17649   Newx(reti->u.offsets, 2*len+1, U32);
17650   Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
17651  }
17652 #else
17653  SetProgLen(reti,len);
17654 #endif
17655
17656  return (void*)reti;
17657 }
17658
17659 #endif    /* USE_ITHREADS */
17660
17661 #ifndef PERL_IN_XSUB_RE
17662
17663 /*
17664  - regnext - dig the "next" pointer out of a node
17665  */
17666 regnode *
17667 Perl_regnext(pTHX_ regnode *p)
17668 {
17669  I32 offset;
17670
17671  if (!p)
17672   return(NULL);
17673
17674  if (OP(p) > REGNODE_MAX) {  /* regnode.type is unsigned */
17675   Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d",
17676             (int)OP(p), (int)REGNODE_MAX);
17677  }
17678
17679  offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
17680  if (offset == 0)
17681   return(NULL);
17682
17683  return(p+offset);
17684 }
17685 #endif
17686
17687 STATIC void
17688 S_re_croak2(pTHX_ bool utf8, const char* pat1,const char* pat2,...)
17689 {
17690  va_list args;
17691  STRLEN l1 = strlen(pat1);
17692  STRLEN l2 = strlen(pat2);
17693  char buf[512];
17694  SV *msv;
17695  const char *message;
17696
17697  PERL_ARGS_ASSERT_RE_CROAK2;
17698
17699  if (l1 > 510)
17700   l1 = 510;
17701  if (l1 + l2 > 510)
17702   l2 = 510 - l1;
17703  Copy(pat1, buf, l1 , char);
17704  Copy(pat2, buf + l1, l2 , char);
17705  buf[l1 + l2] = '\n';
17706  buf[l1 + l2 + 1] = '\0';
17707  va_start(args, pat2);
17708  msv = vmess(buf, &args);
17709  va_end(args);
17710  message = SvPV_const(msv,l1);
17711  if (l1 > 512)
17712   l1 = 512;
17713  Copy(message, buf, l1 , char);
17714  /* l1-1 to avoid \n */
17715  Perl_croak(aTHX_ "%"UTF8f, UTF8fARG(utf8, l1-1, buf));
17716 }
17717
17718 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
17719
17720 #ifndef PERL_IN_XSUB_RE
17721 void
17722 Perl_save_re_context(pTHX)
17723 {
17724  I32 nparens = -1;
17725  I32 i;
17726
17727  /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
17728
17729  if (PL_curpm) {
17730   const REGEXP * const rx = PM_GETRE(PL_curpm);
17731   if (rx)
17732    nparens = RX_NPARENS(rx);
17733  }
17734
17735  /* RT #124109. This is a complete hack; in the SWASHNEW case we know
17736  * that PL_curpm will be null, but that utf8.pm and the modules it
17737  * loads will only use $1..$3.
17738  * The t/porting/re_context.t test file checks this assumption.
17739  */
17740  if (nparens == -1)
17741   nparens = 3;
17742
17743  for (i = 1; i <= nparens; i++) {
17744   char digits[TYPE_CHARS(long)];
17745   const STRLEN len = my_snprintf(digits, sizeof(digits),
17746          "%lu", (long)i);
17747   GV *const *const gvp
17748    = (GV**)hv_fetch(PL_defstash, digits, len, 0);
17749
17750   if (gvp) {
17751    GV * const gv = *gvp;
17752    if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
17753     save_scalar(gv);
17754   }
17755  }
17756 }
17757 #endif
17758
17759 #ifdef DEBUGGING
17760
17761 STATIC void
17762 S_put_code_point(pTHX_ SV *sv, UV c)
17763 {
17764  PERL_ARGS_ASSERT_PUT_CODE_POINT;
17765
17766  if (c > 255) {
17767   Perl_sv_catpvf(aTHX_ sv, "\\x{%04"UVXf"}", c);
17768  }
17769  else if (isPRINT(c)) {
17770   const char string = (char) c;
17771   if (isBACKSLASHED_PUNCT(c))
17772    sv_catpvs(sv, "\\");
17773   sv_catpvn(sv, &string, 1);
17774  }
17775  else {
17776   const char * const mnemonic = cntrl_to_mnemonic((char) c);
17777   if (mnemonic) {
17778    Perl_sv_catpvf(aTHX_ sv, "%s", mnemonic);
17779   }
17780   else {
17781    Perl_sv_catpvf(aTHX_ sv, "\\x{%02X}", (U8) c);
17782   }
17783  }
17784 }
17785
17786 #define MAX_PRINT_A MAX_PRINT_A_FOR_USE_ONLY_BY_REGCOMP_DOT_C
17787
17788 STATIC void
17789 S_put_range(pTHX_ SV *sv, UV start, const UV end, const bool allow_literals)
17790 {
17791  /* Appends to 'sv' a displayable version of the range of code points from
17792  * 'start' to 'end'.  It assumes that only ASCII printables are displayable
17793  * as-is (though some of these will be escaped by put_code_point()). */
17794
17795  const unsigned int min_range_count = 3;
17796
17797  assert(start <= end);
17798
17799  PERL_ARGS_ASSERT_PUT_RANGE;
17800
17801  while (start <= end) {
17802   UV this_end;
17803   const char * format;
17804
17805   if (end - start < min_range_count) {
17806
17807    /* Individual chars in short ranges */
17808    for (; start <= end; start++) {
17809     put_code_point(sv, start);
17810    }
17811    break;
17812   }
17813
17814   /* If permitted by the input options, and there is a possibility that
17815   * this range contains a printable literal, look to see if there is
17816   * one.  */
17817   if (allow_literals && start <= MAX_PRINT_A) {
17818
17819    /* If the range begin isn't an ASCII printable, effectively split
17820    * the range into two parts:
17821    *  1) the portion before the first such printable,
17822    *  2) the rest
17823    * and output them separately. */
17824    if (! isPRINT_A(start)) {
17825     UV temp_end = start + 1;
17826
17827     /* There is no point looking beyond the final possible
17828     * printable, in MAX_PRINT_A */
17829     UV max = MIN(end, MAX_PRINT_A);
17830
17831     while (temp_end <= max && ! isPRINT_A(temp_end)) {
17832      temp_end++;
17833     }
17834
17835     /* Here, temp_end points to one beyond the first printable if
17836     * found, or to one beyond 'max' if not.  If none found, make
17837     * sure that we use the entire range */
17838     if (temp_end > MAX_PRINT_A) {
17839      temp_end = end + 1;
17840     }
17841
17842     /* Output the first part of the split range, the part that
17843     * doesn't have printables, with no looking for literals
17844     * (otherwise we would infinitely recurse) */
17845     put_range(sv, start, temp_end - 1, FALSE);
17846
17847     /* The 2nd part of the range (if any) starts here. */
17848     start = temp_end;
17849
17850     /* We continue instead of dropping down because even if the 2nd
17851     * part is non-empty, it could be so short that we want to
17852     * output it specially, as tested for at the top of this loop.
17853     * */
17854     continue;
17855    }
17856
17857    /* Here, 'start' is a printable ASCII.  If it is an alphanumeric,
17858    * output a sub-range of just the digits or letters, then process
17859    * the remaining portion as usual. */
17860    if (isALPHANUMERIC_A(start)) {
17861     UV mask = (isDIGIT_A(start))
17862       ? _CC_DIGIT
17863        : isUPPER_A(start)
17864        ? _CC_UPPER
17865        : _CC_LOWER;
17866     UV temp_end = start + 1;
17867
17868     /* Find the end of the sub-range that includes just the
17869     * characters in the same class as the first character in it */
17870     while (temp_end <= end && _generic_isCC_A(temp_end, mask)) {
17871      temp_end++;
17872     }
17873     temp_end--;
17874
17875     /* For short ranges, don't duplicate the code above to output
17876     * them; just call recursively */
17877     if (temp_end - start < min_range_count) {
17878      put_range(sv, start, temp_end, FALSE);
17879     }
17880     else {  /* Output as a range */
17881      put_code_point(sv, start);
17882      sv_catpvs(sv, "-");
17883      put_code_point(sv, temp_end);
17884     }
17885     start = temp_end + 1;
17886     continue;
17887    }
17888
17889    /* We output any other printables as individual characters */
17890    if (isPUNCT_A(start) || isSPACE_A(start)) {
17891     while (start <= end && (isPUNCT_A(start)
17892           || isSPACE_A(start)))
17893     {
17894      put_code_point(sv, start);
17895      start++;
17896     }
17897     continue;
17898    }
17899   } /* End of looking for literals */
17900
17901   /* Here is not to output as a literal.  Some control characters have
17902   * mnemonic names.  Split off any of those at the beginning and end of
17903   * the range to print mnemonically.  It isn't possible for many of
17904   * these to be in a row, so this won't overwhelm with output */
17905   while (isMNEMONIC_CNTRL(start) && start <= end) {
17906    put_code_point(sv, start);
17907    start++;
17908   }
17909   if (start < end && isMNEMONIC_CNTRL(end)) {
17910
17911    /* Here, the final character in the range has a mnemonic name.
17912    * Work backwards from the end to find the final non-mnemonic */
17913    UV temp_end = end - 1;
17914    while (isMNEMONIC_CNTRL(temp_end)) {
17915     temp_end--;
17916    }
17917
17918    /* And separately output the range that doesn't have mnemonics */
17919    put_range(sv, start, temp_end, FALSE);
17920
17921    /* Then output the mnemonic trailing controls */
17922    start = temp_end + 1;
17923    while (start <= end) {
17924     put_code_point(sv, start);
17925     start++;
17926    }
17927    break;
17928   }
17929
17930   /* As a final resort, output the range or subrange as hex. */
17931
17932   this_end = (end < NUM_ANYOF_CODE_POINTS)
17933      ? end
17934      : NUM_ANYOF_CODE_POINTS - 1;
17935   format = (this_end < 256)
17936     ? "\\x{%02"UVXf"}-\\x{%02"UVXf"}"
17937     : "\\x{%04"UVXf"}-\\x{%04"UVXf"}";
17938   GCC_DIAG_IGNORE(-Wformat-nonliteral);
17939   Perl_sv_catpvf(aTHX_ sv, format, start, this_end);
17940   GCC_DIAG_RESTORE;
17941   break;
17942  }
17943 }
17944
17945 STATIC bool
17946 S_put_charclass_bitmap_innards(pTHX_ SV *sv, char *bitmap, SV** bitmap_invlist)
17947 {
17948  /* Appends to 'sv' a displayable version of the innards of the bracketed
17949  * character class whose bitmap is 'bitmap';  Returns 'TRUE' if it actually
17950  * output anything, and bitmap_invlist, if not NULL, will point to an
17951  * inversion list of what is in the bit map */
17952
17953  int i;
17954  UV start, end;
17955  unsigned int punct_count = 0;
17956  SV* invlist = NULL;
17957  SV** invlist_ptr;   /* Temporary, in case bitmap_invlist is NULL */
17958  bool allow_literals = TRUE;
17959
17960  PERL_ARGS_ASSERT_PUT_CHARCLASS_BITMAP_INNARDS;
17961
17962  invlist_ptr = (bitmap_invlist) ? bitmap_invlist : &invlist;
17963
17964  /* Worst case is exactly every-other code point is in the list */
17965  *invlist_ptr = _new_invlist(NUM_ANYOF_CODE_POINTS / 2);
17966
17967  /* Convert the bit map to an inversion list, keeping track of how many
17968  * ASCII puncts are set, including an extra amount for the backslashed
17969  * ones.  */
17970  for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
17971   if (BITMAP_TEST(bitmap, i)) {
17972    *invlist_ptr = add_cp_to_invlist(*invlist_ptr, i);
17973    if (isPUNCT_A(i)) {
17974     punct_count++;
17975     if isBACKSLASHED_PUNCT(i) {
17976      punct_count++;
17977     }
17978    }
17979   }
17980  }
17981
17982  /* Nothing to output */
17983  if (_invlist_len(*invlist_ptr) == 0) {
17984   SvREFCNT_dec(invlist);
17985   return FALSE;
17986  }
17987
17988  /* Generally, it is more readable if printable characters are output as
17989  * literals, but if a range (nearly) spans all of them, it's best to output
17990  * it as a single range.  This code will use a single range if all but 2
17991  * printables are in it */
17992  invlist_iterinit(*invlist_ptr);
17993  while (invlist_iternext(*invlist_ptr, &start, &end)) {
17994
17995   /* If range starts beyond final printable, it doesn't have any in it */
17996   if (start > MAX_PRINT_A) {
17997    break;
17998   }
17999
18000   /* In both ASCII and EBCDIC, a SPACE is the lowest printable.  To span
18001   * all but two, the range must start and end no later than 2 from
18002   * either end */
18003   if (start < ' ' + 2 && end > MAX_PRINT_A - 2) {
18004    if (end > MAX_PRINT_A) {
18005     end = MAX_PRINT_A;
18006    }
18007    if (start < ' ') {
18008     start = ' ';
18009    }
18010    if (end - start >= MAX_PRINT_A - ' ' - 2) {
18011     allow_literals = FALSE;
18012    }
18013    break;
18014   }
18015  }
18016  invlist_iterfinish(*invlist_ptr);
18017
18018  /* The legibility of the output depends mostly on how many punctuation
18019  * characters are output.  There are 32 possible ASCII ones, and some have
18020  * an additional backslash, bringing it to currently 36, so if any more
18021  * than 18 are to be output, we can instead output it as its complement,
18022  * yielding fewer puncts, and making it more legible.  But give some weight
18023  * to the fact that outputting it as a complement is less legible than a
18024  * straight output, so don't complement unless we are somewhat over the 18
18025  * mark */
18026  if (allow_literals && punct_count > 22) {
18027   sv_catpvs(sv, "^");
18028
18029   /* Add everything remaining to the list, so when we invert it just
18030   * below, it will be excluded */
18031   _invlist_union_complement_2nd(*invlist_ptr, PL_InBitmap, invlist_ptr);
18032   _invlist_invert(*invlist_ptr);
18033  }
18034
18035  /* Here we have figured things out.  Output each range */
18036  invlist_iterinit(*invlist_ptr);
18037  while (invlist_iternext(*invlist_ptr, &start, &end)) {
18038   if (start >= NUM_ANYOF_CODE_POINTS) {
18039    break;
18040   }
18041   put_range(sv, start, end, allow_literals);
18042  }
18043  invlist_iterfinish(*invlist_ptr);
18044
18045  return TRUE;
18046 }
18047
18048 #define CLEAR_OPTSTART \
18049  if (optstart) STMT_START {                                               \
18050   DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,                       \
18051        " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
18052   optstart=NULL;                                                       \
18053  } STMT_END
18054
18055 #define DUMPUNTIL(b,e)                                                       \
18056      CLEAR_OPTSTART;                                          \
18057      node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
18058
18059 STATIC const regnode *
18060 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
18061    const regnode *last, const regnode *plast,
18062    SV* sv, I32 indent, U32 depth)
18063 {
18064  U8 op = PSEUDO; /* Arbitrary non-END op. */
18065  const regnode *next;
18066  const regnode *optstart= NULL;
18067
18068  RXi_GET_DECL(r,ri);
18069  GET_RE_DEBUG_FLAGS_DECL;
18070
18071  PERL_ARGS_ASSERT_DUMPUNTIL;
18072
18073 #ifdef DEBUG_DUMPUNTIL
18074  PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
18075   last ? last-start : 0,plast ? plast-start : 0);
18076 #endif
18077
18078  if (plast && plast < last)
18079   last= plast;
18080
18081  while (PL_regkind[op] != END && (!last || node < last)) {
18082   assert(node);
18083   /* While that wasn't END last time... */
18084   NODE_ALIGN(node);
18085   op = OP(node);
18086   if (op == CLOSE || op == WHILEM)
18087    indent--;
18088   next = regnext((regnode *)node);
18089
18090   /* Where, what. */
18091   if (OP(node) == OPTIMIZED) {
18092    if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
18093     optstart = node;
18094    else
18095     goto after_print;
18096   } else
18097    CLEAR_OPTSTART;
18098
18099   regprop(r, sv, node, NULL, NULL);
18100   PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
18101      (int)(2*indent + 1), "", SvPVX_const(sv));
18102
18103   if (OP(node) != OPTIMIZED) {
18104    if (next == NULL)  /* Next ptr. */
18105     PerlIO_printf(Perl_debug_log, " (0)");
18106    else if (PL_regkind[(U8)op] == BRANCH
18107      && PL_regkind[OP(next)] != BRANCH )
18108     PerlIO_printf(Perl_debug_log, " (FAIL)");
18109    else
18110     PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
18111    (void)PerlIO_putc(Perl_debug_log, '\n');
18112   }
18113
18114  after_print:
18115   if (PL_regkind[(U8)op] == BRANCHJ) {
18116    assert(next);
18117    {
18118     const regnode *nnode = (OP(next) == LONGJMP
18119          ? regnext((regnode *)next)
18120          : next);
18121     if (last && nnode > last)
18122      nnode = last;
18123     DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
18124    }
18125   }
18126   else if (PL_regkind[(U8)op] == BRANCH) {
18127    assert(next);
18128    DUMPUNTIL(NEXTOPER(node), next);
18129   }
18130   else if ( PL_regkind[(U8)op]  == TRIE ) {
18131    const regnode *this_trie = node;
18132    const char op = OP(node);
18133    const U32 n = ARG(node);
18134    const reg_ac_data * const ac = op>=AHOCORASICK ?
18135    (reg_ac_data *)ri->data->data[n] :
18136    NULL;
18137    const reg_trie_data * const trie =
18138     (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
18139 #ifdef DEBUGGING
18140    AV *const trie_words
18141       = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
18142 #endif
18143    const regnode *nextbranch= NULL;
18144    I32 word_idx;
18145    sv_setpvs(sv, "");
18146    for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
18147     SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
18148
18149     PerlIO_printf(Perl_debug_log, "%*s%s ",
18150     (int)(2*(indent+3)), "",
18151      elem_ptr
18152      ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr),
18153         SvCUR(*elem_ptr), 60,
18154         PL_colors[0], PL_colors[1],
18155         (SvUTF8(*elem_ptr)
18156         ? PERL_PV_ESCAPE_UNI
18157         : 0)
18158         | PERL_PV_PRETTY_ELLIPSES
18159         | PERL_PV_PRETTY_LTGT
18160        )
18161      : "???"
18162     );
18163     if (trie->jump) {
18164      U16 dist= trie->jump[word_idx+1];
18165      PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
18166        (UV)((dist ? this_trie + dist : next) - start));
18167      if (dist) {
18168       if (!nextbranch)
18169        nextbranch= this_trie + trie->jump[0];
18170       DUMPUNTIL(this_trie + dist, nextbranch);
18171      }
18172      if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
18173       nextbranch= regnext((regnode *)nextbranch);
18174     } else {
18175      PerlIO_printf(Perl_debug_log, "\n");
18176     }
18177    }
18178    if (last && next > last)
18179     node= last;
18180    else
18181     node= next;
18182   }
18183   else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
18184    DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
18185      NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
18186   }
18187   else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
18188    assert(next);
18189    DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
18190   }
18191   else if ( op == PLUS || op == STAR) {
18192    DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
18193   }
18194   else if (PL_regkind[(U8)op] == ANYOF) {
18195    /* arglen 1 + class block */
18196    node += 1 + ((ANYOF_FLAGS(node) & ANYOF_MATCHES_POSIXL)
18197       ? ANYOF_POSIXL_SKIP
18198       : ANYOF_SKIP);
18199    node = NEXTOPER(node);
18200   }
18201   else if (PL_regkind[(U8)op] == EXACT) {
18202    /* Literal string, where present. */
18203    node += NODE_SZ_STR(node) - 1;
18204    node = NEXTOPER(node);
18205   }
18206   else {
18207    node = NEXTOPER(node);
18208    node += regarglen[(U8)op];
18209   }
18210   if (op == CURLYX || op == OPEN)
18211    indent++;
18212  }
18213  CLEAR_OPTSTART;
18214 #ifdef DEBUG_DUMPUNTIL
18215  PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
18216 #endif
18217  return node;
18218 }
18219
18220 #endif /* DEBUGGING */
18221
18222 /*
18223  * ex: set ts=8 sts=4 sw=4 et:
18224  */