This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Only allow punct delimiter for regex subpattern
[perl5.git] / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #define REG_COMP_C
78 #ifdef PERL_IN_XSUB_RE
79 #  include "re_comp.h"
80 EXTERN_C const struct regexp_engine my_reg_engine;
81 #else
82 #  include "regcomp.h"
83 #endif
84
85 #include "dquote_inline.h"
86 #include "invlist_inline.h"
87 #include "unicode_constants.h"
88
89 #define HAS_NONLATIN1_FOLD_CLOSURE(i) \
90  _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
91 #define HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE(i) \
92  _HAS_NONLATIN1_SIMPLE_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)
93 #define IS_NON_FINAL_FOLD(c) _IS_NON_FINAL_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
94 #define IS_IN_SOME_FOLD_L1(c) _IS_IN_SOME_FOLD_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
95
96 #ifndef STATIC
97 #define STATIC  static
98 #endif
99
100 /* this is a chain of data about sub patterns we are processing that
101    need to be handled separately/specially in study_chunk. Its so
102    we can simulate recursion without losing state.  */
103 struct scan_frame;
104 typedef struct scan_frame {
105     regnode *last_regnode;      /* last node to process in this frame */
106     regnode *next_regnode;      /* next node to process when last is reached */
107     U32 prev_recursed_depth;
108     I32 stopparen;              /* what stopparen do we use */
109
110     struct scan_frame *this_prev_frame; /* this previous frame */
111     struct scan_frame *prev_frame;      /* previous frame */
112     struct scan_frame *next_frame;      /* next frame */
113 } scan_frame;
114
115 /* Certain characters are output as a sequence with the first being a
116  * backslash. */
117 #define isBACKSLASHED_PUNCT(c)  strchr("-[]\\^", c)
118
119
120 struct RExC_state_t {
121     U32         flags;                  /* RXf_* are we folding, multilining? */
122     U32         pm_flags;               /* PMf_* stuff from the calling PMOP */
123     char        *precomp;               /* uncompiled string. */
124     char        *precomp_end;           /* pointer to end of uncompiled string. */
125     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
126     regexp      *rx;                    /* perl core regexp structure */
127     regexp_internal     *rxi;           /* internal data for regexp object
128                                            pprivate field */
129     char        *start;                 /* Start of input for compile */
130     char        *end;                   /* End of input for compile */
131     char        *parse;                 /* Input-scan pointer. */
132     char        *copy_start;            /* start of copy of input within
133                                            constructed parse string */
134     char        *save_copy_start;       /* Provides one level of saving
135                                            and restoring 'copy_start' */
136     char        *copy_start_in_input;   /* Position in input string
137                                            corresponding to copy_start */
138     SSize_t     whilem_seen;            /* number of WHILEM in this expr */
139     regnode     *emit_start;            /* Start of emitted-code area */
140     regnode_offset emit;                /* Code-emit pointer */
141     I32         naughty;                /* How bad is this pattern? */
142     I32         sawback;                /* Did we see \1, ...? */
143     U32         seen;
144     SSize_t     size;                   /* Number of regnode equivalents in
145                                            pattern */
146
147     /* position beyond 'precomp' of the warning message furthest away from
148      * 'precomp'.  During the parse, no warnings are raised for any problems
149      * earlier in the parse than this position.  This works if warnings are
150      * raised the first time a given spot is parsed, and if only one
151      * independent warning is raised for any given spot */
152     Size_t      latest_warn_offset;
153
154     I32         npar;                   /* Capture buffer count so far in the
155                                            parse, (OPEN) plus one. ("par" 0 is
156                                            the whole pattern)*/
157     I32         total_par;              /* During initial parse, is either 0,
158                                            or -1; the latter indicating a
159                                            reparse is needed.  After that pass,
160                                            it is what 'npar' became after the
161                                            pass.  Hence, it being > 0 indicates
162                                            we are in a reparse situation */
163     I32         nestroot;               /* root parens we are in - used by
164                                            accept */
165     I32         seen_zerolen;
166     regnode_offset *open_parens;        /* offsets to open parens */
167     regnode_offset *close_parens;       /* offsets to close parens */
168     I32      parens_buf_size;           /* #slots malloced open/close_parens */
169     regnode     *end_op;                /* END node in program */
170     I32         utf8;           /* whether the pattern is utf8 or not */
171     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
172                                 /* XXX use this for future optimisation of case
173                                  * where pattern must be upgraded to utf8. */
174     I32         uni_semantics;  /* If a d charset modifier should use unicode
175                                    rules, even if the pattern is not in
176                                    utf8 */
177     HV          *paren_names;           /* Paren names */
178
179     regnode     **recurse;              /* Recurse regops */
180     I32         recurse_count;          /* Number of recurse regops we have generated */
181     U8          *study_chunk_recursed;  /* bitmap of which subs we have moved
182                                            through */
183     U32         study_chunk_recursed_bytes;  /* bytes in bitmap */
184     I32         in_lookbehind;
185     I32         in_lookahead;
186     I32         contains_locale;
187     I32         override_recoding;
188     I32         recode_x_to_native;
189     I32         in_multi_char_class;
190     struct reg_code_blocks *code_blocks;/* positions of literal (?{})
191                                             within pattern */
192     int         code_index;             /* next code_blocks[] slot */
193     SSize_t     maxlen;                        /* mininum possible number of chars in string to match */
194     scan_frame *frame_head;
195     scan_frame *frame_last;
196     U32         frame_count;
197     AV         *warn_text;
198     HV         *unlexed_names;
199 #ifdef ADD_TO_REGEXEC
200     char        *starttry;              /* -Dr: where regtry was called. */
201 #define RExC_starttry   (pRExC_state->starttry)
202 #endif
203     SV          *runtime_code_qr;       /* qr with the runtime code blocks */
204 #ifdef DEBUGGING
205     const char  *lastparse;
206     I32         lastnum;
207     AV          *paren_name_list;       /* idx -> name */
208     U32         study_chunk_recursed_count;
209     SV          *mysv1;
210     SV          *mysv2;
211
212 #define RExC_lastparse  (pRExC_state->lastparse)
213 #define RExC_lastnum    (pRExC_state->lastnum)
214 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
215 #define RExC_study_chunk_recursed_count    (pRExC_state->study_chunk_recursed_count)
216 #define RExC_mysv       (pRExC_state->mysv1)
217 #define RExC_mysv1      (pRExC_state->mysv1)
218 #define RExC_mysv2      (pRExC_state->mysv2)
219
220 #endif
221     bool        seen_d_op;
222     bool        strict;
223     bool        study_started;
224     bool        in_script_run;
225     bool        use_BRANCHJ;
226 };
227
228 #define RExC_flags      (pRExC_state->flags)
229 #define RExC_pm_flags   (pRExC_state->pm_flags)
230 #define RExC_precomp    (pRExC_state->precomp)
231 #define RExC_copy_start_in_input (pRExC_state->copy_start_in_input)
232 #define RExC_copy_start_in_constructed  (pRExC_state->copy_start)
233 #define RExC_save_copy_start_in_constructed  (pRExC_state->save_copy_start)
234 #define RExC_precomp_end (pRExC_state->precomp_end)
235 #define RExC_rx_sv      (pRExC_state->rx_sv)
236 #define RExC_rx         (pRExC_state->rx)
237 #define RExC_rxi        (pRExC_state->rxi)
238 #define RExC_start      (pRExC_state->start)
239 #define RExC_end        (pRExC_state->end)
240 #define RExC_parse      (pRExC_state->parse)
241 #define RExC_latest_warn_offset (pRExC_state->latest_warn_offset )
242 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
243 #define RExC_seen_d_op (pRExC_state->seen_d_op) /* Seen something that differs
244                                                    under /d from /u ? */
245
246 #ifdef RE_TRACK_PATTERN_OFFSETS
247 #  define RExC_offsets  (RExC_rxi->u.offsets) /* I am not like the
248                                                          others */
249 #endif
250 #define RExC_emit       (pRExC_state->emit)
251 #define RExC_emit_start (pRExC_state->emit_start)
252 #define RExC_sawback    (pRExC_state->sawback)
253 #define RExC_seen       (pRExC_state->seen)
254 #define RExC_size       (pRExC_state->size)
255 #define RExC_maxlen        (pRExC_state->maxlen)
256 #define RExC_npar       (pRExC_state->npar)
257 #define RExC_total_parens       (pRExC_state->total_par)
258 #define RExC_parens_buf_size    (pRExC_state->parens_buf_size)
259 #define RExC_nestroot   (pRExC_state->nestroot)
260 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
261 #define RExC_utf8       (pRExC_state->utf8)
262 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
263 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
264 #define RExC_open_parens        (pRExC_state->open_parens)
265 #define RExC_close_parens       (pRExC_state->close_parens)
266 #define RExC_end_op     (pRExC_state->end_op)
267 #define RExC_paren_names        (pRExC_state->paren_names)
268 #define RExC_recurse    (pRExC_state->recurse)
269 #define RExC_recurse_count      (pRExC_state->recurse_count)
270 #define RExC_study_chunk_recursed        (pRExC_state->study_chunk_recursed)
271 #define RExC_study_chunk_recursed_bytes  \
272                                    (pRExC_state->study_chunk_recursed_bytes)
273 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
274 #define RExC_in_lookahead       (pRExC_state->in_lookahead)
275 #define RExC_contains_locale    (pRExC_state->contains_locale)
276 #define RExC_recode_x_to_native (pRExC_state->recode_x_to_native)
277
278 #ifdef EBCDIC
279 #  define SET_recode_x_to_native(x)                                         \
280                     STMT_START { RExC_recode_x_to_native = (x); } STMT_END
281 #else
282 #  define SET_recode_x_to_native(x) NOOP
283 #endif
284
285 #define RExC_in_multi_char_class (pRExC_state->in_multi_char_class)
286 #define RExC_frame_head (pRExC_state->frame_head)
287 #define RExC_frame_last (pRExC_state->frame_last)
288 #define RExC_frame_count (pRExC_state->frame_count)
289 #define RExC_strict (pRExC_state->strict)
290 #define RExC_study_started      (pRExC_state->study_started)
291 #define RExC_warn_text (pRExC_state->warn_text)
292 #define RExC_in_script_run      (pRExC_state->in_script_run)
293 #define RExC_use_BRANCHJ        (pRExC_state->use_BRANCHJ)
294 #define RExC_unlexed_names (pRExC_state->unlexed_names)
295
296 /* Heuristic check on the complexity of the pattern: if TOO_NAUGHTY, we set
297  * a flag to disable back-off on the fixed/floating substrings - if it's
298  * a high complexity pattern we assume the benefit of avoiding a full match
299  * is worth the cost of checking for the substrings even if they rarely help.
300  */
301 #define RExC_naughty    (pRExC_state->naughty)
302 #define TOO_NAUGHTY (10)
303 #define MARK_NAUGHTY(add) \
304     if (RExC_naughty < TOO_NAUGHTY) \
305         RExC_naughty += (add)
306 #define MARK_NAUGHTY_EXP(exp, add) \
307     if (RExC_naughty < TOO_NAUGHTY) \
308         RExC_naughty += RExC_naughty / (exp) + (add)
309
310 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
311 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
312         ((*s) == '{' && regcurly(s)))
313
314 /*
315  * Flags to be passed up and down.
316  */
317 #define WORST           0       /* Worst case. */
318 #define HASWIDTH        0x01    /* Known to not match null strings, could match
319                                    non-null ones. */
320
321 /* Simple enough to be STAR/PLUS operand; in an EXACTish node must be a single
322  * character.  (There needs to be a case: in the switch statement in regexec.c
323  * for any node marked SIMPLE.)  Note that this is not the same thing as
324  * REGNODE_SIMPLE */
325 #define SIMPLE          0x02
326 #define SPSTART         0x04    /* Starts with * or + */
327 #define POSTPONED       0x08    /* (?1),(?&name), (??{...}) or similar */
328 #define TRYAGAIN        0x10    /* Weeded out a declaration. */
329 #define RESTART_PARSE   0x20    /* Need to redo the parse */
330 #define NEED_UTF8       0x40    /* In conjunction with RESTART_PARSE, need to
331                                    calcuate sizes as UTF-8 */
332
333 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
334
335 /* whether trie related optimizations are enabled */
336 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
337 #define TRIE_STUDY_OPT
338 #define FULL_TRIE_STUDY
339 #define TRIE_STCLASS
340 #endif
341
342
343
344 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
345 #define PBITVAL(paren) (1 << ((paren) & 7))
346 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
347 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
348 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
349
350 #define REQUIRE_UTF8(flagp) STMT_START {                                   \
351                                      if (!UTF) {                           \
352                                          *flagp = RESTART_PARSE|NEED_UTF8; \
353                                          return 0;                         \
354                                      }                                     \
355                              } STMT_END
356
357 /* Change from /d into /u rules, and restart the parse.  RExC_uni_semantics is
358  * a flag that indicates we need to override /d with /u as a result of
359  * something in the pattern.  It should only be used in regards to calling
360  * set_regex_charset() or get_regex_charset() */
361 #define REQUIRE_UNI_RULES(flagp, restart_retval)                            \
362     STMT_START {                                                            \
363             if (DEPENDS_SEMANTICS) {                                        \
364                 set_regex_charset(&RExC_flags, REGEX_UNICODE_CHARSET);      \
365                 RExC_uni_semantics = 1;                                     \
366                 if (RExC_seen_d_op && LIKELY(! IN_PARENS_PASS)) {           \
367                     /* No need to restart the parse if we haven't seen      \
368                      * anything that differs between /u and /d, and no need \
369                      * to restart immediately if we're going to reparse     \
370                      * anyway to count parens */                            \
371                     *flagp |= RESTART_PARSE;                                \
372                     return restart_retval;                                  \
373                 }                                                           \
374             }                                                               \
375     } STMT_END
376
377 #define REQUIRE_BRANCHJ(flagp, restart_retval)                              \
378     STMT_START {                                                            \
379                 RExC_use_BRANCHJ = 1;                                       \
380                 *flagp |= RESTART_PARSE;                                    \
381                 return restart_retval;                                      \
382     } STMT_END
383
384 /* Until we have completed the parse, we leave RExC_total_parens at 0 or
385  * less.  After that, it must always be positive, because the whole re is
386  * considered to be surrounded by virtual parens.  Setting it to negative
387  * indicates there is some construct that needs to know the actual number of
388  * parens to be properly handled.  And that means an extra pass will be
389  * required after we've counted them all */
390 #define ALL_PARENS_COUNTED (RExC_total_parens > 0)
391 #define REQUIRE_PARENS_PASS                                                 \
392     STMT_START {  /* No-op if have completed a pass */                      \
393                     if (! ALL_PARENS_COUNTED) RExC_total_parens = -1;       \
394     } STMT_END
395 #define IN_PARENS_PASS (RExC_total_parens < 0)
396
397
398 /* This is used to return failure (zero) early from the calling function if
399  * various flags in 'flags' are set.  Two flags always cause a return:
400  * 'RESTART_PARSE' and 'NEED_UTF8'.   'extra' can be used to specify any
401  * additional flags that should cause a return; 0 if none.  If the return will
402  * be done, '*flagp' is first set to be all of the flags that caused the
403  * return. */
404 #define RETURN_FAIL_ON_RESTART_OR_FLAGS(flags,flagp,extra)                  \
405     STMT_START {                                                            \
406             if ((flags) & (RESTART_PARSE|NEED_UTF8|(extra))) {              \
407                 *(flagp) = (flags) & (RESTART_PARSE|NEED_UTF8|(extra));     \
408                 return 0;                                                   \
409             }                                                               \
410     } STMT_END
411
412 #define MUST_RESTART(flags) ((flags) & (RESTART_PARSE))
413
414 #define RETURN_FAIL_ON_RESTART(flags,flagp)                                 \
415                         RETURN_FAIL_ON_RESTART_OR_FLAGS( flags, flagp, 0)
416 #define RETURN_FAIL_ON_RESTART_FLAGP(flagp)                                 \
417                                     if (MUST_RESTART(*(flagp))) return 0
418
419 /* This converts the named class defined in regcomp.h to its equivalent class
420  * number defined in handy.h. */
421 #define namedclass_to_classnum(class)  ((int) ((class) / 2))
422 #define classnum_to_namedclass(classnum)  ((classnum) * 2)
423
424 #define _invlist_union_complement_2nd(a, b, output) \
425                         _invlist_union_maybe_complement_2nd(a, b, TRUE, output)
426 #define _invlist_intersection_complement_2nd(a, b, output) \
427                  _invlist_intersection_maybe_complement_2nd(a, b, TRUE, output)
428
429 /* We add a marker if we are deferring expansion of a potential user-defined
430  * property until it is needed at runtime the first time it is encountered in a
431  * pattern match.  This marker that shouldn't conflict with any that could be
432  * in a legal name is appended to its name to indicate this.  There is a string
433  * and character form */
434 #define DEFERRED_PROP_EXPANSION_MARKERs  "~"
435 #define DEFERRED_PROP_EXPANSION_MARKERc  '~'
436
437 /* About scan_data_t.
438
439   During optimisation we recurse through the regexp program performing
440   various inplace (keyhole style) optimisations. In addition study_chunk
441   and scan_commit populate this data structure with information about
442   what strings MUST appear in the pattern. We look for the longest
443   string that must appear at a fixed location, and we look for the
444   longest string that may appear at a floating location. So for instance
445   in the pattern:
446
447     /FOO[xX]A.*B[xX]BAR/
448
449   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
450   strings (because they follow a .* construct). study_chunk will identify
451   both FOO and BAR as being the longest fixed and floating strings respectively.
452
453   The strings can be composites, for instance
454
455      /(f)(o)(o)/
456
457   will result in a composite fixed substring 'foo'.
458
459   For each string some basic information is maintained:
460
461   - min_offset
462     This is the position the string must appear at, or not before.
463     It also implicitly (when combined with minlenp) tells us how many
464     characters must match before the string we are searching for.
465     Likewise when combined with minlenp and the length of the string it
466     tells us how many characters must appear after the string we have
467     found.
468
469   - max_offset
470     Only used for floating strings. This is the rightmost point that
471     the string can appear at. If set to SSize_t_MAX it indicates that the
472     string can occur infinitely far to the right.
473     For fixed strings, it is equal to min_offset.
474
475   - minlenp
476     A pointer to the minimum number of characters of the pattern that the
477     string was found inside. This is important as in the case of positive
478     lookahead or positive lookbehind we can have multiple patterns
479     involved. Consider
480
481     /(?=FOO).*F/
482
483     The minimum length of the pattern overall is 3, the minimum length
484     of the lookahead part is 3, but the minimum length of the part that
485     will actually match is 1. So 'FOO's minimum length is 3, but the
486     minimum length for the F is 1. This is important as the minimum length
487     is used to determine offsets in front of and behind the string being
488     looked for.  Since strings can be composites this is the length of the
489     pattern at the time it was committed with a scan_commit. Note that
490     the length is calculated by study_chunk, so that the minimum lengths
491     are not known until the full pattern has been compiled, thus the
492     pointer to the value.
493
494   - lookbehind
495
496     In the case of lookbehind the string being searched for can be
497     offset past the start point of the final matching string.
498     If this value was just blithely removed from the min_offset it would
499     invalidate some of the calculations for how many chars must match
500     before or after (as they are derived from min_offset and minlen and
501     the length of the string being searched for).
502     When the final pattern is compiled and the data is moved from the
503     scan_data_t structure into the regexp structure the information
504     about lookbehind is factored in, with the information that would
505     have been lost precalculated in the end_shift field for the
506     associated string.
507
508   The fields pos_min and pos_delta are used to store the minimum offset
509   and the delta to the maximum offset at the current point in the pattern.
510
511 */
512
513 struct scan_data_substrs {
514     SV      *str;       /* longest substring found in pattern */
515     SSize_t min_offset; /* earliest point in string it can appear */
516     SSize_t max_offset; /* latest point in string it can appear */
517     SSize_t *minlenp;   /* pointer to the minlen relevant to the string */
518     SSize_t lookbehind; /* is the pos of the string modified by LB */
519     I32 flags;          /* per substring SF_* and SCF_* flags */
520 };
521
522 typedef struct scan_data_t {
523     /*I32 len_min;      unused */
524     /*I32 len_delta;    unused */
525     SSize_t pos_min;
526     SSize_t pos_delta;
527     SV *last_found;
528     SSize_t last_end;       /* min value, <0 unless valid. */
529     SSize_t last_start_min;
530     SSize_t last_start_max;
531     U8      cur_is_floating; /* whether the last_* values should be set as
532                               * the next fixed (0) or floating (1)
533                               * substring */
534
535     /* [0] is longest fixed substring so far, [1] is longest float so far */
536     struct scan_data_substrs  substrs[2];
537
538     I32 flags;             /* common SF_* and SCF_* flags */
539     I32 whilem_c;
540     SSize_t *last_closep;
541     regnode_ssc *start_class;
542 } scan_data_t;
543
544 /*
545  * Forward declarations for pregcomp()'s friends.
546  */
547
548 static const scan_data_t zero_scan_data = {
549     0, 0, NULL, 0, 0, 0, 0,
550     {
551         { NULL, 0, 0, 0, 0, 0 },
552         { NULL, 0, 0, 0, 0, 0 },
553     },
554     0, 0, NULL, NULL
555 };
556
557 /* study flags */
558
559 #define SF_BEFORE_SEOL          0x0001
560 #define SF_BEFORE_MEOL          0x0002
561 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
562
563 #define SF_IS_INF               0x0040
564 #define SF_HAS_PAR              0x0080
565 #define SF_IN_PAR               0x0100
566 #define SF_HAS_EVAL             0x0200
567
568
569 /* SCF_DO_SUBSTR is the flag that tells the regexp analyzer to track the
570  * longest substring in the pattern. When it is not set the optimiser keeps
571  * track of position, but does not keep track of the actual strings seen,
572  *
573  * So for instance /foo/ will be parsed with SCF_DO_SUBSTR being true, but
574  * /foo/i will not.
575  *
576  * Similarly, /foo.*(blah|erm|huh).*fnorble/ will have "foo" and "fnorble"
577  * parsed with SCF_DO_SUBSTR on, but while processing the (...) it will be
578  * turned off because of the alternation (BRANCH). */
579 #define SCF_DO_SUBSTR           0x0400
580
581 #define SCF_DO_STCLASS_AND      0x0800
582 #define SCF_DO_STCLASS_OR       0x1000
583 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
584 #define SCF_WHILEM_VISITED_POS  0x2000
585
586 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
587 #define SCF_SEEN_ACCEPT         0x8000
588 #define SCF_TRIE_DOING_RESTUDY 0x10000
589 #define SCF_IN_DEFINE          0x20000
590
591
592
593
594 #define UTF cBOOL(RExC_utf8)
595
596 /* The enums for all these are ordered so things work out correctly */
597 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
598 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags)                    \
599                                                      == REGEX_DEPENDS_CHARSET)
600 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
601 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags)                \
602                                                      >= REGEX_UNICODE_CHARSET)
603 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags)                      \
604                                             == REGEX_ASCII_RESTRICTED_CHARSET)
605 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags)             \
606                                             >= REGEX_ASCII_RESTRICTED_CHARSET)
607 #define ASCII_FOLD_RESTRICTED (get_regex_charset(RExC_flags)                 \
608                                         == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
609
610 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
611
612 /* For programs that want to be strictly Unicode compatible by dying if any
613  * attempt is made to match a non-Unicode code point against a Unicode
614  * property.  */
615 #define ALWAYS_WARN_SUPER  ckDEAD(packWARN(WARN_NON_UNICODE))
616
617 #define OOB_NAMEDCLASS          -1
618
619 /* There is no code point that is out-of-bounds, so this is problematic.  But
620  * its only current use is to initialize a variable that is always set before
621  * looked at. */
622 #define OOB_UNICODE             0xDEADBEEF
623
624 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
625
626
627 /* length of regex to show in messages that don't mark a position within */
628 #define RegexLengthToShowInErrorMessages 127
629
630 /*
631  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
632  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
633  * op/pragma/warn/regcomp.
634  */
635 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
636 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
637
638 #define REPORT_LOCATION " in regex; marked by " MARKER1    \
639                         " in m/%" UTF8f MARKER2 "%" UTF8f "/"
640
641 /* The code in this file in places uses one level of recursion with parsing
642  * rebased to an alternate string constructed by us in memory.  This can take
643  * the form of something that is completely different from the input, or
644  * something that uses the input as part of the alternate.  In the first case,
645  * there should be no possibility of an error, as we are in complete control of
646  * the alternate string.  But in the second case we don't completely control
647  * the input portion, so there may be errors in that.  Here's an example:
648  *      /[abc\x{DF}def]/ui
649  * is handled specially because \x{df} folds to a sequence of more than one
650  * character: 'ss'.  What is done is to create and parse an alternate string,
651  * which looks like this:
652  *      /(?:\x{DF}|[abc\x{DF}def])/ui
653  * where it uses the input unchanged in the middle of something it constructs,
654  * which is a branch for the DF outside the character class, and clustering
655  * parens around the whole thing. (It knows enough to skip the DF inside the
656  * class while in this substitute parse.) 'abc' and 'def' may have errors that
657  * need to be reported.  The general situation looks like this:
658  *
659  *                                       |<------- identical ------>|
660  *              sI                       tI               xI       eI
661  * Input:       ---------------------------------------------------------------
662  * Constructed:         ---------------------------------------------------
663  *                      sC               tC               xC       eC     EC
664  *                                       |<------- identical ------>|
665  *
666  * sI..eI   is the portion of the input pattern we are concerned with here.
667  * sC..EC   is the constructed substitute parse string.
668  *  sC..tC  is constructed by us
669  *  tC..eC  is an exact duplicate of the portion of the input pattern tI..eI.
670  *          In the diagram, these are vertically aligned.
671  *  eC..EC  is also constructed by us.
672  * xC       is the position in the substitute parse string where we found a
673  *          problem.
674  * xI       is the position in the original pattern corresponding to xC.
675  *
676  * We want to display a message showing the real input string.  Thus we need to
677  * translate from xC to xI.  We know that xC >= tC, since the portion of the
678  * string sC..tC has been constructed by us, and so shouldn't have errors.  We
679  * get:
680  *      xI = tI + (xC - tC)
681  *
682  * When the substitute parse is constructed, the code needs to set:
683  *      RExC_start (sC)
684  *      RExC_end (eC)
685  *      RExC_copy_start_in_input  (tI)
686  *      RExC_copy_start_in_constructed (tC)
687  * and restore them when done.
688  *
689  * During normal processing of the input pattern, both
690  * 'RExC_copy_start_in_input' and 'RExC_copy_start_in_constructed' are set to
691  * sI, so that xC equals xI.
692  */
693
694 #define sI              RExC_precomp
695 #define eI              RExC_precomp_end
696 #define sC              RExC_start
697 #define eC              RExC_end
698 #define tI              RExC_copy_start_in_input
699 #define tC              RExC_copy_start_in_constructed
700 #define xI(xC)          (tI + (xC - tC))
701 #define xI_offset(xC)   (xI(xC) - sI)
702
703 #define REPORT_LOCATION_ARGS(xC)                                            \
704     UTF8fARG(UTF,                                                           \
705              (xI(xC) > eI) /* Don't run off end */                          \
706               ? eI - sI   /* Length before the <--HERE */                   \
707               : ((xI_offset(xC) >= 0)                                       \
708                  ? xI_offset(xC)                                            \
709                  : (Perl_croak(aTHX_ "panic: %s: %d: negative offset: %"    \
710                                     IVdf " trying to output message for "   \
711                                     " pattern %.*s",                        \
712                                     __FILE__, __LINE__, (IV) xI_offset(xC), \
713                                     ((int) (eC - sC)), sC), 0)),            \
714              sI),         /* The input pattern printed up to the <--HERE */ \
715     UTF8fARG(UTF,                                                           \
716              (xI(xC) > eI) ? 0 : eI - xI(xC), /* Length after <--HERE */    \
717              (xI(xC) > eI) ? eI : xI(xC))     /* pattern after <--HERE */
718
719 /* Used to point after bad bytes for an error message, but avoid skipping
720  * past a nul byte. */
721 #define SKIP_IF_CHAR(s, e) (!*(s) ? 0 : UTF ? UTF8_SAFE_SKIP(s, e) : 1)
722
723 /* Set up to clean up after our imminent demise */
724 #define PREPARE_TO_DIE                                                      \
725     STMT_START {                                                            \
726         if (RExC_rx_sv)                                                     \
727             SAVEFREESV(RExC_rx_sv);                                         \
728         if (RExC_open_parens)                                               \
729             SAVEFREEPV(RExC_open_parens);                                   \
730         if (RExC_close_parens)                                              \
731             SAVEFREEPV(RExC_close_parens);                                  \
732     } STMT_END
733
734 /*
735  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
736  * arg. Show regex, up to a maximum length. If it's too long, chop and add
737  * "...".
738  */
739 #define _FAIL(code) STMT_START {                                        \
740     const char *ellipses = "";                                          \
741     IV len = RExC_precomp_end - RExC_precomp;                           \
742                                                                         \
743     PREPARE_TO_DIE;                                                     \
744     if (len > RegexLengthToShowInErrorMessages) {                       \
745         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
746         len = RegexLengthToShowInErrorMessages - 10;                    \
747         ellipses = "...";                                               \
748     }                                                                   \
749     code;                                                               \
750 } STMT_END
751
752 #define FAIL(msg) _FAIL(                            \
753     Perl_croak(aTHX_ "%s in regex m/%" UTF8f "%s/",         \
754             msg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
755
756 #define FAIL2(msg,arg) _FAIL(                       \
757     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
758             arg, UTF8fARG(UTF, len, RExC_precomp), ellipses))
759
760 #define FAIL3(msg,arg1,arg2) _FAIL(                         \
761     Perl_croak(aTHX_ msg " in regex m/%" UTF8f "%s/",       \
762      arg1, arg2, UTF8fARG(UTF, len, RExC_precomp), ellipses))
763
764 /*
765  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
766  */
767 #define Simple_vFAIL(m) STMT_START {                                    \
768     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
769             m, REPORT_LOCATION_ARGS(RExC_parse));                       \
770 } STMT_END
771
772 /*
773  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
774  */
775 #define vFAIL(m) STMT_START {                           \
776     PREPARE_TO_DIE;                                     \
777     Simple_vFAIL(m);                                    \
778 } STMT_END
779
780 /*
781  * Like Simple_vFAIL(), but accepts two arguments.
782  */
783 #define Simple_vFAIL2(m,a1) STMT_START {                        \
784     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,              \
785                       REPORT_LOCATION_ARGS(RExC_parse));        \
786 } STMT_END
787
788 /*
789  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
790  */
791 #define vFAIL2(m,a1) STMT_START {                       \
792     PREPARE_TO_DIE;                                     \
793     Simple_vFAIL2(m, a1);                               \
794 } STMT_END
795
796
797 /*
798  * Like Simple_vFAIL(), but accepts three arguments.
799  */
800 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
801     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,          \
802             REPORT_LOCATION_ARGS(RExC_parse));                  \
803 } STMT_END
804
805 /*
806  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
807  */
808 #define vFAIL3(m,a1,a2) STMT_START {                    \
809     PREPARE_TO_DIE;                                     \
810     Simple_vFAIL3(m, a1, a2);                           \
811 } STMT_END
812
813 /*
814  * Like Simple_vFAIL(), but accepts four arguments.
815  */
816 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
817     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2, a3,      \
818             REPORT_LOCATION_ARGS(RExC_parse));                  \
819 } STMT_END
820
821 #define vFAIL4(m,a1,a2,a3) STMT_START {                 \
822     PREPARE_TO_DIE;                                     \
823     Simple_vFAIL4(m, a1, a2, a3);                       \
824 } STMT_END
825
826 /* A specialized version of vFAIL2 that works with UTF8f */
827 #define vFAIL2utf8f(m, a1) STMT_START {             \
828     PREPARE_TO_DIE;                                 \
829     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1,  \
830             REPORT_LOCATION_ARGS(RExC_parse));      \
831 } STMT_END
832
833 #define vFAIL3utf8f(m, a1, a2) STMT_START {             \
834     PREPARE_TO_DIE;                                     \
835     S_re_croak2(aTHX_ UTF, m, REPORT_LOCATION, a1, a2,  \
836             REPORT_LOCATION_ARGS(RExC_parse));          \
837 } STMT_END
838
839 /* Setting this to NULL is a signal to not output warnings */
840 #define TURN_OFF_WARNINGS_IN_SUBSTITUTE_PARSE                               \
841     STMT_START {                                                            \
842       RExC_save_copy_start_in_constructed  = RExC_copy_start_in_constructed;\
843       RExC_copy_start_in_constructed = NULL;                                \
844     } STMT_END
845 #define RESTORE_WARNINGS                                                    \
846     RExC_copy_start_in_constructed = RExC_save_copy_start_in_constructed
847
848 /* Since a warning can be generated multiple times as the input is reparsed, we
849  * output it the first time we come to that point in the parse, but suppress it
850  * otherwise.  'RExC_copy_start_in_constructed' being NULL is a flag to not
851  * generate any warnings */
852 #define TO_OUTPUT_WARNINGS(loc)                                         \
853   (   RExC_copy_start_in_constructed                                    \
854    && ((xI(loc)) - RExC_precomp) > (Ptrdiff_t) RExC_latest_warn_offset)
855
856 /* After we've emitted a warning, we save the position in the input so we don't
857  * output it again */
858 #define UPDATE_WARNINGS_LOC(loc)                                        \
859     STMT_START {                                                        \
860         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
861             RExC_latest_warn_offset = MAX(sI, MIN(eI, xI(loc)))         \
862                                                        - RExC_precomp;  \
863         }                                                               \
864     } STMT_END
865
866 /* 'warns' is the output of the packWARNx macro used in 'code' */
867 #define _WARN_HELPER(loc, warns, code)                                  \
868     STMT_START {                                                        \
869         if (! RExC_copy_start_in_constructed) {                         \
870             Perl_croak( aTHX_ "panic! %s: %d: Tried to warn when none"  \
871                               " expected at '%s'",                      \
872                               __FILE__, __LINE__, loc);                 \
873         }                                                               \
874         if (TO_OUTPUT_WARNINGS(loc)) {                                  \
875             if (ckDEAD(warns))                                          \
876                 PREPARE_TO_DIE;                                         \
877             code;                                                       \
878             UPDATE_WARNINGS_LOC(loc);                                   \
879         }                                                               \
880     } STMT_END
881
882 /* m is not necessarily a "literal string", in this macro */
883 #define reg_warn_non_literal_string(loc, m)                             \
884     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
885                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
886                                        "%s" REPORT_LOCATION,            \
887                                   m, REPORT_LOCATION_ARGS(loc)))
888
889 #define ckWARNreg(loc,m)                                                \
890     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
891                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
892                                           m REPORT_LOCATION,            \
893                                           REPORT_LOCATION_ARGS(loc)))
894
895 #define vWARN(loc, m)                                                   \
896     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
897                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
898                                        m REPORT_LOCATION,               \
899                                        REPORT_LOCATION_ARGS(loc)))      \
900
901 #define vWARN_dep(loc, m)                                               \
902     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
903                       Perl_warner(aTHX_ packWARN(WARN_DEPRECATED),      \
904                                        m REPORT_LOCATION,               \
905                                        REPORT_LOCATION_ARGS(loc)))
906
907 #define ckWARNdep(loc,m)                                                \
908     _WARN_HELPER(loc, packWARN(WARN_DEPRECATED),                        \
909                       Perl_ck_warner_d(aTHX_ packWARN(WARN_DEPRECATED), \
910                                             m REPORT_LOCATION,          \
911                                             REPORT_LOCATION_ARGS(loc)))
912
913 #define ckWARNregdep(loc,m)                                                 \
914     _WARN_HELPER(loc, packWARN2(WARN_DEPRECATED, WARN_REGEXP),              \
915                       Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED,     \
916                                                       WARN_REGEXP),         \
917                                              m REPORT_LOCATION,             \
918                                              REPORT_LOCATION_ARGS(loc)))
919
920 #define ckWARN2reg_d(loc,m, a1)                                             \
921     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
922                       Perl_ck_warner_d(aTHX_ packWARN(WARN_REGEXP),         \
923                                             m REPORT_LOCATION,              \
924                                             a1, REPORT_LOCATION_ARGS(loc)))
925
926 #define ckWARN2reg(loc, m, a1)                                              \
927     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
928                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
929                                           m REPORT_LOCATION,                \
930                                           a1, REPORT_LOCATION_ARGS(loc)))
931
932 #define vWARN3(loc, m, a1, a2)                                              \
933     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
934                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),              \
935                                        m REPORT_LOCATION,                   \
936                                        a1, a2, REPORT_LOCATION_ARGS(loc)))
937
938 #define ckWARN3reg(loc, m, a1, a2)                                          \
939     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                                \
940                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),           \
941                                           m REPORT_LOCATION,                \
942                                           a1, a2,                           \
943                                           REPORT_LOCATION_ARGS(loc)))
944
945 #define vWARN4(loc, m, a1, a2, a3)                                      \
946     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
947                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
948                                        m REPORT_LOCATION,               \
949                                        a1, a2, a3,                      \
950                                        REPORT_LOCATION_ARGS(loc)))
951
952 #define ckWARN4reg(loc, m, a1, a2, a3)                                  \
953     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
954                       Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),       \
955                                           m REPORT_LOCATION,            \
956                                           a1, a2, a3,                   \
957                                           REPORT_LOCATION_ARGS(loc)))
958
959 #define vWARN5(loc, m, a1, a2, a3, a4)                                  \
960     _WARN_HELPER(loc, packWARN(WARN_REGEXP),                            \
961                       Perl_warner(aTHX_ packWARN(WARN_REGEXP),          \
962                                        m REPORT_LOCATION,               \
963                                        a1, a2, a3, a4,                  \
964                                        REPORT_LOCATION_ARGS(loc)))
965
966 #define ckWARNexperimental(loc, class, m)                               \
967     _WARN_HELPER(loc, packWARN(class),                                  \
968                       Perl_ck_warner_d(aTHX_ packWARN(class),           \
969                                             m REPORT_LOCATION,          \
970                                             REPORT_LOCATION_ARGS(loc)))
971
972 /* Convert between a pointer to a node and its offset from the beginning of the
973  * program */
974 #define REGNODE_p(offset)    (RExC_emit_start + (offset))
975 #define REGNODE_OFFSET(node) ((node) - RExC_emit_start)
976
977 /* Macros for recording node offsets.   20001227 mjd@plover.com
978  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
979  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
980  * Element 0 holds the number n.
981  * Position is 1 indexed.
982  */
983 #ifndef RE_TRACK_PATTERN_OFFSETS
984 #define Set_Node_Offset_To_R(offset,byte)
985 #define Set_Node_Offset(node,byte)
986 #define Set_Cur_Node_Offset
987 #define Set_Node_Length_To_R(node,len)
988 #define Set_Node_Length(node,len)
989 #define Set_Node_Cur_Length(node,start)
990 #define Node_Offset(n)
991 #define Node_Length(n)
992 #define Set_Node_Offset_Length(node,offset,len)
993 #define ProgLen(ri) ri->u.proglen
994 #define SetProgLen(ri,x) ri->u.proglen = x
995 #define Track_Code(code)
996 #else
997 #define ProgLen(ri) ri->u.offsets[0]
998 #define SetProgLen(ri,x) ri->u.offsets[0] = x
999 #define Set_Node_Offset_To_R(offset,byte) STMT_START {                  \
1000         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
1001                     __LINE__, (int)(offset), (int)(byte)));             \
1002         if((offset) < 0) {                                              \
1003             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
1004                                          (int)(offset));                \
1005         } else {                                                        \
1006             RExC_offsets[2*(offset)-1] = (byte);                        \
1007         }                                                               \
1008 } STMT_END
1009
1010 #define Set_Node_Offset(node,byte)                                      \
1011     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (byte)-RExC_start)
1012 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
1013
1014 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
1015         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
1016                 __LINE__, (int)(node), (int)(len)));                    \
1017         if((node) < 0) {                                                \
1018             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
1019                                          (int)(node));                  \
1020         } else {                                                        \
1021             RExC_offsets[2*(node)] = (len);                             \
1022         }                                                               \
1023 } STMT_END
1024
1025 #define Set_Node_Length(node,len) \
1026     Set_Node_Length_To_R(REGNODE_OFFSET(node), len)
1027 #define Set_Node_Cur_Length(node, start)                \
1028     Set_Node_Length(node, RExC_parse - start)
1029
1030 /* Get offsets and lengths */
1031 #define Node_Offset(n) (RExC_offsets[2*(REGNODE_OFFSET(n))-1])
1032 #define Node_Length(n) (RExC_offsets[2*(REGNODE_OFFSET(n))])
1033
1034 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
1035     Set_Node_Offset_To_R(REGNODE_OFFSET(node), (offset));       \
1036     Set_Node_Length_To_R(REGNODE_OFFSET(node), (len));  \
1037 } STMT_END
1038
1039 #define Track_Code(code) STMT_START { code } STMT_END
1040 #endif
1041
1042 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
1043 #define EXPERIMENTAL_INPLACESCAN
1044 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
1045
1046 #ifdef DEBUGGING
1047 int
1048 Perl_re_printf(pTHX_ const char *fmt, ...)
1049 {
1050     va_list ap;
1051     int result;
1052     PerlIO *f= Perl_debug_log;
1053     PERL_ARGS_ASSERT_RE_PRINTF;
1054     va_start(ap, fmt);
1055     result = PerlIO_vprintf(f, fmt, ap);
1056     va_end(ap);
1057     return result;
1058 }
1059
1060 int
1061 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
1062 {
1063     va_list ap;
1064     int result;
1065     PerlIO *f= Perl_debug_log;
1066     PERL_ARGS_ASSERT_RE_INDENTF;
1067     va_start(ap, depth);
1068     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
1069     result = PerlIO_vprintf(f, fmt, ap);
1070     va_end(ap);
1071     return result;
1072 }
1073 #endif /* DEBUGGING */
1074
1075 #define DEBUG_RExC_seen()                                                   \
1076         DEBUG_OPTIMISE_MORE_r({                                             \
1077             Perl_re_printf( aTHX_ "RExC_seen: ");                           \
1078                                                                             \
1079             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
1080                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                \
1081                                                                             \
1082             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
1083                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");              \
1084                                                                             \
1085             if (RExC_seen & REG_GPOS_SEEN)                                  \
1086                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                    \
1087                                                                             \
1088             if (RExC_seen & REG_RECURSE_SEEN)                               \
1089                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                 \
1090                                                                             \
1091             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
1092                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");      \
1093                                                                             \
1094             if (RExC_seen & REG_VERBARG_SEEN)                               \
1095                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                 \
1096                                                                             \
1097             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
1098                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                \
1099                                                                             \
1100             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
1101                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");          \
1102                                                                             \
1103             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
1104                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");          \
1105                                                                             \
1106             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
1107                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");    \
1108                                                                             \
1109             Perl_re_printf( aTHX_ "\n");                                    \
1110         });
1111
1112 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
1113   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
1114
1115
1116 #ifdef DEBUGGING
1117 static void
1118 S_debug_show_study_flags(pTHX_ U32 flags, const char *open_str,
1119                                     const char *close_str)
1120 {
1121     if (!flags)
1122         return;
1123
1124     Perl_re_printf( aTHX_  "%s", open_str);
1125     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_SEOL);
1126     DEBUG_SHOW_STUDY_FLAG(flags, SF_BEFORE_MEOL);
1127     DEBUG_SHOW_STUDY_FLAG(flags, SF_IS_INF);
1128     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_PAR);
1129     DEBUG_SHOW_STUDY_FLAG(flags, SF_IN_PAR);
1130     DEBUG_SHOW_STUDY_FLAG(flags, SF_HAS_EVAL);
1131     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_SUBSTR);
1132     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_AND);
1133     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS_OR);
1134     DEBUG_SHOW_STUDY_FLAG(flags, SCF_DO_STCLASS);
1135     DEBUG_SHOW_STUDY_FLAG(flags, SCF_WHILEM_VISITED_POS);
1136     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_RESTUDY);
1137     DEBUG_SHOW_STUDY_FLAG(flags, SCF_SEEN_ACCEPT);
1138     DEBUG_SHOW_STUDY_FLAG(flags, SCF_TRIE_DOING_RESTUDY);
1139     DEBUG_SHOW_STUDY_FLAG(flags, SCF_IN_DEFINE);
1140     Perl_re_printf( aTHX_  "%s", close_str);
1141 }
1142
1143
1144 static void
1145 S_debug_studydata(pTHX_ const char *where, scan_data_t *data,
1146                     U32 depth, int is_inf)
1147 {
1148     GET_RE_DEBUG_FLAGS_DECL;
1149
1150     DEBUG_OPTIMISE_MORE_r({
1151         if (!data)
1152             return;
1153         Perl_re_indentf(aTHX_  "%s: Pos:%" IVdf "/%" IVdf " Flags: 0x%" UVXf,
1154             depth,
1155             where,
1156             (IV)data->pos_min,
1157             (IV)data->pos_delta,
1158             (UV)data->flags
1159         );
1160
1161         S_debug_show_study_flags(aTHX_ data->flags," [","]");
1162
1163         Perl_re_printf( aTHX_
1164             " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",
1165             (IV)data->whilem_c,
1166             (IV)(data->last_closep ? *((data)->last_closep) : -1),
1167             is_inf ? "INF " : ""
1168         );
1169
1170         if (data->last_found) {
1171             int i;
1172             Perl_re_printf(aTHX_
1173                 "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf,
1174                     SvPVX_const(data->last_found),
1175                     (IV)data->last_end,
1176                     (IV)data->last_start_min,
1177                     (IV)data->last_start_max
1178             );
1179
1180             for (i = 0; i < 2; i++) {
1181                 Perl_re_printf(aTHX_
1182                     " %s%s: '%s' @ %" IVdf "/%" IVdf,
1183                     data->cur_is_floating == i ? "*" : "",
1184                     i ? "Float" : "Fixed",
1185                     SvPVX_const(data->substrs[i].str),
1186                     (IV)data->substrs[i].min_offset,
1187                     (IV)data->substrs[i].max_offset
1188                 );
1189                 S_debug_show_study_flags(aTHX_ data->substrs[i].flags," [","]");
1190             }
1191         }
1192
1193         Perl_re_printf( aTHX_ "\n");
1194     });
1195 }
1196
1197
1198 static void
1199 S_debug_peep(pTHX_ const char *str, const RExC_state_t *pRExC_state,
1200                 regnode *scan, U32 depth, U32 flags)
1201 {
1202     GET_RE_DEBUG_FLAGS_DECL;
1203
1204     DEBUG_OPTIMISE_r({
1205         regnode *Next;
1206
1207         if (!scan)
1208             return;
1209         Next = regnext(scan);
1210         regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);
1211         Perl_re_indentf( aTHX_   "%s>%3d: %s (%d)",
1212             depth,
1213             str,
1214             REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),
1215             Next ? (REG_NODE_NUM(Next)) : 0 );
1216         S_debug_show_study_flags(aTHX_ flags," [ ","]");
1217         Perl_re_printf( aTHX_  "\n");
1218    });
1219 }
1220
1221
1222 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) \
1223                     S_debug_studydata(aTHX_ where, data, depth, is_inf)
1224
1225 #  define DEBUG_PEEP(str, scan, depth, flags)   \
1226                     S_debug_peep(aTHX_ str, pRExC_state, scan, depth, flags)
1227
1228 #else
1229 #  define DEBUG_STUDYDATA(where, data, depth, is_inf) NOOP
1230 #  define DEBUG_PEEP(str, scan, depth, flags)         NOOP
1231 #endif
1232
1233
1234 /* =========================================================
1235  * BEGIN edit_distance stuff.
1236  *
1237  * This calculates how many single character changes of any type are needed to
1238  * transform a string into another one.  It is taken from version 3.1 of
1239  *
1240  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1241  */
1242
1243 /* Our unsorted dictionary linked list.   */
1244 /* Note we use UVs, not chars. */
1245
1246 struct dictionary{
1247   UV key;
1248   UV value;
1249   struct dictionary* next;
1250 };
1251 typedef struct dictionary item;
1252
1253
1254 PERL_STATIC_INLINE item*
1255 push(UV key, item* curr)
1256 {
1257     item* head;
1258     Newx(head, 1, item);
1259     head->key = key;
1260     head->value = 0;
1261     head->next = curr;
1262     return head;
1263 }
1264
1265
1266 PERL_STATIC_INLINE item*
1267 find(item* head, UV key)
1268 {
1269     item* iterator = head;
1270     while (iterator){
1271         if (iterator->key == key){
1272             return iterator;
1273         }
1274         iterator = iterator->next;
1275     }
1276
1277     return NULL;
1278 }
1279
1280 PERL_STATIC_INLINE item*
1281 uniquePush(item* head, UV key)
1282 {
1283     item* iterator = head;
1284
1285     while (iterator){
1286         if (iterator->key == key) {
1287             return head;
1288         }
1289         iterator = iterator->next;
1290     }
1291
1292     return push(key, head);
1293 }
1294
1295 PERL_STATIC_INLINE void
1296 dict_free(item* head)
1297 {
1298     item* iterator = head;
1299
1300     while (iterator) {
1301         item* temp = iterator;
1302         iterator = iterator->next;
1303         Safefree(temp);
1304     }
1305
1306     head = NULL;
1307 }
1308
1309 /* End of Dictionary Stuff */
1310
1311 /* All calculations/work are done here */
1312 STATIC int
1313 S_edit_distance(const UV* src,
1314                 const UV* tgt,
1315                 const STRLEN x,             /* length of src[] */
1316                 const STRLEN y,             /* length of tgt[] */
1317                 const SSize_t maxDistance
1318 )
1319 {
1320     item *head = NULL;
1321     UV swapCount, swapScore, targetCharCount, i, j;
1322     UV *scores;
1323     UV score_ceil = x + y;
1324
1325     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1326
1327     /* intialize matrix start values */
1328     Newx(scores, ( (x + 2) * (y + 2)), UV);
1329     scores[0] = score_ceil;
1330     scores[1 * (y + 2) + 0] = score_ceil;
1331     scores[0 * (y + 2) + 1] = score_ceil;
1332     scores[1 * (y + 2) + 1] = 0;
1333     head = uniquePush(uniquePush(head, src[0]), tgt[0]);
1334
1335     /* work loops    */
1336     /* i = src index */
1337     /* j = tgt index */
1338     for (i=1;i<=x;i++) {
1339         if (i < x)
1340             head = uniquePush(head, src[i]);
1341         scores[(i+1) * (y + 2) + 1] = i;
1342         scores[(i+1) * (y + 2) + 0] = score_ceil;
1343         swapCount = 0;
1344
1345         for (j=1;j<=y;j++) {
1346             if (i == 1) {
1347                 if(j < y)
1348                 head = uniquePush(head, tgt[j]);
1349                 scores[1 * (y + 2) + (j + 1)] = j;
1350                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1351             }
1352
1353             targetCharCount = find(head, tgt[j-1])->value;
1354             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1355
1356             if (src[i-1] != tgt[j-1]){
1357                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(swapScore,(MIN(scores[i * (y + 2) + j], MIN(scores[(i+1) * (y + 2) + j], scores[i * (y + 2) + (j + 1)])) + 1));
1358             }
1359             else {
1360                 swapCount = j;
1361                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1362             }
1363         }
1364
1365         find(head, src[i-1])->value = i;
1366     }
1367
1368     {
1369         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1370         dict_free(head);
1371         Safefree(scores);
1372         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1373     }
1374 }
1375
1376 /* END of edit_distance() stuff
1377  * ========================================================= */
1378
1379 /* is c a control character for which we have a mnemonic? */
1380 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1381
1382 STATIC const char *
1383 S_cntrl_to_mnemonic(const U8 c)
1384 {
1385     /* Returns the mnemonic string that represents character 'c', if one
1386      * exists; NULL otherwise.  The only ones that exist for the purposes of
1387      * this routine are a few control characters */
1388
1389     switch (c) {
1390         case '\a':       return "\\a";
1391         case '\b':       return "\\b";
1392         case ESC_NATIVE: return "\\e";
1393         case '\f':       return "\\f";
1394         case '\n':       return "\\n";
1395         case '\r':       return "\\r";
1396         case '\t':       return "\\t";
1397     }
1398
1399     return NULL;
1400 }
1401
1402 /* Mark that we cannot extend a found fixed substring at this point.
1403    Update the longest found anchored substring or the longest found
1404    floating substrings if needed. */
1405
1406 STATIC void
1407 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1408                     SSize_t *minlenp, int is_inf)
1409 {
1410     const STRLEN l = CHR_SVLEN(data->last_found);
1411     SV * const longest_sv = data->substrs[data->cur_is_floating].str;
1412     const STRLEN old_l = CHR_SVLEN(longest_sv);
1413     GET_RE_DEBUG_FLAGS_DECL;
1414
1415     PERL_ARGS_ASSERT_SCAN_COMMIT;
1416
1417     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1418         const U8 i = data->cur_is_floating;
1419         SvSetMagicSV(longest_sv, data->last_found);
1420         data->substrs[i].min_offset = l ? data->last_start_min : data->pos_min;
1421
1422         if (!i) /* fixed */
1423             data->substrs[0].max_offset = data->substrs[0].min_offset;
1424         else { /* float */
1425             data->substrs[1].max_offset = (l
1426                           ? data->last_start_max
1427                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1428                                          ? SSize_t_MAX
1429                                          : data->pos_min + data->pos_delta));
1430             if (is_inf
1431                  || (STRLEN)data->substrs[1].max_offset > (STRLEN)SSize_t_MAX)
1432                 data->substrs[1].max_offset = SSize_t_MAX;
1433         }
1434
1435         if (data->flags & SF_BEFORE_EOL)
1436             data->substrs[i].flags |= (data->flags & SF_BEFORE_EOL);
1437         else
1438             data->substrs[i].flags &= ~SF_BEFORE_EOL;
1439         data->substrs[i].minlenp = minlenp;
1440         data->substrs[i].lookbehind = 0;
1441     }
1442
1443     SvCUR_set(data->last_found, 0);
1444     {
1445         SV * const sv = data->last_found;
1446         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1447             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1448             if (mg)
1449                 mg->mg_len = 0;
1450         }
1451     }
1452     data->last_end = -1;
1453     data->flags &= ~SF_BEFORE_EOL;
1454     DEBUG_STUDYDATA("commit", data, 0, is_inf);
1455 }
1456
1457 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1458  * list that describes which code points it matches */
1459
1460 STATIC void
1461 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1462 {
1463     /* Set the SSC 'ssc' to match an empty string or any code point */
1464
1465     PERL_ARGS_ASSERT_SSC_ANYTHING;
1466
1467     assert(is_ANYOF_SYNTHETIC(ssc));
1468
1469     /* mortalize so won't leak */
1470     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1471     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1472 }
1473
1474 STATIC int
1475 S_ssc_is_anything(const regnode_ssc *ssc)
1476 {
1477     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1478      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1479      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1480      * in any way, so there's no point in using it */
1481
1482     UV start, end;
1483     bool ret;
1484
1485     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1486
1487     assert(is_ANYOF_SYNTHETIC(ssc));
1488
1489     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1490         return FALSE;
1491     }
1492
1493     /* See if the list consists solely of the range 0 - Infinity */
1494     invlist_iterinit(ssc->invlist);
1495     ret = invlist_iternext(ssc->invlist, &start, &end)
1496           && start == 0
1497           && end == UV_MAX;
1498
1499     invlist_iterfinish(ssc->invlist);
1500
1501     if (ret) {
1502         return TRUE;
1503     }
1504
1505     /* If e.g., both \w and \W are set, matches everything */
1506     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1507         int i;
1508         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1509             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1510                 return TRUE;
1511             }
1512         }
1513     }
1514
1515     return FALSE;
1516 }
1517
1518 STATIC void
1519 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1520 {
1521     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1522      * string, any code point, or any posix class under locale */
1523
1524     PERL_ARGS_ASSERT_SSC_INIT;
1525
1526     Zero(ssc, 1, regnode_ssc);
1527     set_ANYOF_SYNTHETIC(ssc);
1528     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1529     ssc_anything(ssc);
1530
1531     /* If any portion of the regex is to operate under locale rules that aren't
1532      * fully known at compile time, initialization includes it.  The reason
1533      * this isn't done for all regexes is that the optimizer was written under
1534      * the assumption that locale was all-or-nothing.  Given the complexity and
1535      * lack of documentation in the optimizer, and that there are inadequate
1536      * test cases for locale, many parts of it may not work properly, it is
1537      * safest to avoid locale unless necessary. */
1538     if (RExC_contains_locale) {
1539         ANYOF_POSIXL_SETALL(ssc);
1540     }
1541     else {
1542         ANYOF_POSIXL_ZERO(ssc);
1543     }
1544 }
1545
1546 STATIC int
1547 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1548                         const regnode_ssc *ssc)
1549 {
1550     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1551      * to the list of code points matched, and locale posix classes; hence does
1552      * not check its flags) */
1553
1554     UV start, end;
1555     bool ret;
1556
1557     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1558
1559     assert(is_ANYOF_SYNTHETIC(ssc));
1560
1561     invlist_iterinit(ssc->invlist);
1562     ret = invlist_iternext(ssc->invlist, &start, &end)
1563           && start == 0
1564           && end == UV_MAX;
1565
1566     invlist_iterfinish(ssc->invlist);
1567
1568     if (! ret) {
1569         return FALSE;
1570     }
1571
1572     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1573         return FALSE;
1574     }
1575
1576     return TRUE;
1577 }
1578
1579 #define INVLIST_INDEX 0
1580 #define ONLY_LOCALE_MATCHES_INDEX 1
1581 #define DEFERRED_USER_DEFINED_INDEX 2
1582
1583 STATIC SV*
1584 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1585                                const regnode_charclass* const node)
1586 {
1587     /* Returns a mortal inversion list defining which code points are matched
1588      * by 'node', which is of type ANYOF.  Handles complementing the result if
1589      * appropriate.  If some code points aren't knowable at this time, the
1590      * returned list must, and will, contain every code point that is a
1591      * possibility. */
1592
1593     dVAR;
1594     SV* invlist = NULL;
1595     SV* only_utf8_locale_invlist = NULL;
1596     unsigned int i;
1597     const U32 n = ARG(node);
1598     bool new_node_has_latin1 = FALSE;
1599     const U8 flags = (inRANGE(OP(node), ANYOFH, ANYOFRb))
1600                       ? 0
1601                       : ANYOF_FLAGS(node);
1602
1603     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1604
1605     /* Look at the data structure created by S_set_ANYOF_arg() */
1606     if (n != ANYOF_ONLY_HAS_BITMAP) {
1607         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1608         AV * const av = MUTABLE_AV(SvRV(rv));
1609         SV **const ary = AvARRAY(av);
1610         assert(RExC_rxi->data->what[n] == 's');
1611
1612         if (av_tindex_skip_len_mg(av) >= DEFERRED_USER_DEFINED_INDEX) {
1613
1614             /* Here there are things that won't be known until runtime -- we
1615              * have to assume it could be anything */
1616             invlist = sv_2mortal(_new_invlist(1));
1617             return _add_range_to_invlist(invlist, 0, UV_MAX);
1618         }
1619         else if (ary[INVLIST_INDEX]) {
1620
1621             /* Use the node's inversion list */
1622             invlist = sv_2mortal(invlist_clone(ary[INVLIST_INDEX], NULL));
1623         }
1624
1625         /* Get the code points valid only under UTF-8 locales */
1626         if (   (flags & ANYOFL_FOLD)
1627             &&  av_tindex_skip_len_mg(av) >= ONLY_LOCALE_MATCHES_INDEX)
1628         {
1629             only_utf8_locale_invlist = ary[ONLY_LOCALE_MATCHES_INDEX];
1630         }
1631     }
1632
1633     if (! invlist) {
1634         invlist = sv_2mortal(_new_invlist(0));
1635     }
1636
1637     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1638      * code points, and an inversion list for the others, but if there are code
1639      * points that should match only conditionally on the target string being
1640      * UTF-8, those are placed in the inversion list, and not the bitmap.
1641      * Since there are circumstances under which they could match, they are
1642      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1643      * to exclude them here, so that when we invert below, the end result
1644      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1645      * have to do this here before we add the unconditionally matched code
1646      * points */
1647     if (flags & ANYOF_INVERT) {
1648         _invlist_intersection_complement_2nd(invlist,
1649                                              PL_UpperLatin1,
1650                                              &invlist);
1651     }
1652
1653     /* Add in the points from the bit map */
1654     if (! inRANGE(OP(node), ANYOFH, ANYOFRb)) {
1655         for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1656             if (ANYOF_BITMAP_TEST(node, i)) {
1657                 unsigned int start = i++;
1658
1659                 for (;    i < NUM_ANYOF_CODE_POINTS
1660                        && ANYOF_BITMAP_TEST(node, i); ++i)
1661                 {
1662                     /* empty */
1663                 }
1664                 invlist = _add_range_to_invlist(invlist, start, i-1);
1665                 new_node_has_latin1 = TRUE;
1666             }
1667         }
1668     }
1669
1670     /* If this can match all upper Latin1 code points, have to add them
1671      * as well.  But don't add them if inverting, as when that gets done below,
1672      * it would exclude all these characters, including the ones it shouldn't
1673      * that were added just above */
1674     if (! (flags & ANYOF_INVERT) && OP(node) == ANYOFD
1675         && (flags & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1676     {
1677         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1678     }
1679
1680     /* Similarly for these */
1681     if (flags & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1682         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1683     }
1684
1685     if (flags & ANYOF_INVERT) {
1686         _invlist_invert(invlist);
1687     }
1688     else if (flags & ANYOFL_FOLD) {
1689         if (new_node_has_latin1) {
1690
1691             /* Under /li, any 0-255 could fold to any other 0-255, depending on
1692              * the locale.  We can skip this if there are no 0-255 at all. */
1693             _invlist_union(invlist, PL_Latin1, &invlist);
1694
1695             invlist = add_cp_to_invlist(invlist, LATIN_SMALL_LETTER_DOTLESS_I);
1696             invlist = add_cp_to_invlist(invlist, LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE);
1697         }
1698         else {
1699             if (_invlist_contains_cp(invlist, LATIN_SMALL_LETTER_DOTLESS_I)) {
1700                 invlist = add_cp_to_invlist(invlist, 'I');
1701             }
1702             if (_invlist_contains_cp(invlist,
1703                                         LATIN_CAPITAL_LETTER_I_WITH_DOT_ABOVE))
1704             {
1705                 invlist = add_cp_to_invlist(invlist, 'i');
1706             }
1707         }
1708     }
1709
1710     /* Similarly add the UTF-8 locale possible matches.  These have to be
1711      * deferred until after the non-UTF-8 locale ones are taken care of just
1712      * above, or it leads to wrong results under ANYOF_INVERT */
1713     if (only_utf8_locale_invlist) {
1714         _invlist_union_maybe_complement_2nd(invlist,
1715                                             only_utf8_locale_invlist,
1716                                             flags & ANYOF_INVERT,
1717                                             &invlist);
1718     }
1719
1720     return invlist;
1721 }
1722
1723 /* These two functions currently do the exact same thing */
1724 #define ssc_init_zero           ssc_init
1725
1726 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1727 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1728
1729 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1730  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1731  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1732
1733 STATIC void
1734 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1735                 const regnode_charclass *and_with)
1736 {
1737     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1738      * another SSC or a regular ANYOF class.  Can create false positives. */
1739
1740     SV* anded_cp_list;
1741     U8  and_with_flags = inRANGE(OP(and_with), ANYOFH, ANYOFRb)
1742                           ? 0
1743                           : ANYOF_FLAGS(and_with);
1744     U8  anded_flags;
1745
1746     PERL_ARGS_ASSERT_SSC_AND;
1747
1748     assert(is_ANYOF_SYNTHETIC(ssc));
1749
1750     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1751      * the code point inversion list and just the relevant flags */
1752     if (is_ANYOF_SYNTHETIC(and_with)) {
1753         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1754         anded_flags = and_with_flags;
1755
1756         /* XXX This is a kludge around what appears to be deficiencies in the
1757          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1758          * there are paths through the optimizer where it doesn't get weeded
1759          * out when it should.  And if we don't make some extra provision for
1760          * it like the code just below, it doesn't get added when it should.
1761          * This solution is to add it only when AND'ing, which is here, and
1762          * only when what is being AND'ed is the pristine, original node
1763          * matching anything.  Thus it is like adding it to ssc_anything() but
1764          * only when the result is to be AND'ed.  Probably the same solution
1765          * could be adopted for the same problem we have with /l matching,
1766          * which is solved differently in S_ssc_init(), and that would lead to
1767          * fewer false positives than that solution has.  But if this solution
1768          * creates bugs, the consequences are only that a warning isn't raised
1769          * that should be; while the consequences for having /l bugs is
1770          * incorrect matches */
1771         if (ssc_is_anything((regnode_ssc *)and_with)) {
1772             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1773         }
1774     }
1775     else {
1776         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1777         if (OP(and_with) == ANYOFD) {
1778             anded_flags = and_with_flags & ANYOF_COMMON_FLAGS;
1779         }
1780         else {
1781             anded_flags = and_with_flags
1782             &( ANYOF_COMMON_FLAGS
1783               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1784               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1785             if (ANYOFL_UTF8_LOCALE_REQD(and_with_flags)) {
1786                 anded_flags &=
1787                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1788             }
1789         }
1790     }
1791
1792     ANYOF_FLAGS(ssc) &= anded_flags;
1793
1794     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1795      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1796      * 'and_with' may be inverted.  When not inverted, we have the situation of
1797      * computing:
1798      *  (C1 | P1) & (C2 | P2)
1799      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1800      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1801      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1802      *                    <=  ((C1 & C2) | P1 | P2)
1803      * Alternatively, the last few steps could be:
1804      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1805      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1806      *                    <=  (C1 | C2 | (P1 & P2))
1807      * We favor the second approach if either P1 or P2 is non-empty.  This is
1808      * because these components are a barrier to doing optimizations, as what
1809      * they match cannot be known until the moment of matching as they are
1810      * dependent on the current locale, 'AND"ing them likely will reduce or
1811      * eliminate them.
1812      * But we can do better if we know that C1,P1 are in their initial state (a
1813      * frequent occurrence), each matching everything:
1814      *  (<everything>) & (C2 | P2) =  C2 | P2
1815      * Similarly, if C2,P2 are in their initial state (again a frequent
1816      * occurrence), the result is a no-op
1817      *  (C1 | P1) & (<everything>) =  C1 | P1
1818      *
1819      * Inverted, we have
1820      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1821      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1822      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1823      * */
1824
1825     if ((and_with_flags & ANYOF_INVERT)
1826         && ! is_ANYOF_SYNTHETIC(and_with))
1827     {
1828         unsigned int i;
1829
1830         ssc_intersection(ssc,
1831                          anded_cp_list,
1832                          FALSE /* Has already been inverted */
1833                          );
1834
1835         /* If either P1 or P2 is empty, the intersection will be also; can skip
1836          * the loop */
1837         if (! (and_with_flags & ANYOF_MATCHES_POSIXL)) {
1838             ANYOF_POSIXL_ZERO(ssc);
1839         }
1840         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1841
1842             /* Note that the Posix class component P from 'and_with' actually
1843              * looks like:
1844              *      P = Pa | Pb | ... | Pn
1845              * where each component is one posix class, such as in [\w\s].
1846              * Thus
1847              *      ~P = ~(Pa | Pb | ... | Pn)
1848              *         = ~Pa & ~Pb & ... & ~Pn
1849              *        <= ~Pa | ~Pb | ... | ~Pn
1850              * The last is something we can easily calculate, but unfortunately
1851              * is likely to have many false positives.  We could do better
1852              * in some (but certainly not all) instances if two classes in
1853              * P have known relationships.  For example
1854              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1855              * So
1856              *      :lower: & :print: = :lower:
1857              * And similarly for classes that must be disjoint.  For example,
1858              * since \s and \w can have no elements in common based on rules in
1859              * the POSIX standard,
1860              *      \w & ^\S = nothing
1861              * Unfortunately, some vendor locales do not meet the Posix
1862              * standard, in particular almost everything by Microsoft.
1863              * The loop below just changes e.g., \w into \W and vice versa */
1864
1865             regnode_charclass_posixl temp;
1866             int add = 1;    /* To calculate the index of the complement */
1867
1868             Zero(&temp, 1, regnode_charclass_posixl);
1869             ANYOF_POSIXL_ZERO(&temp);
1870             for (i = 0; i < ANYOF_MAX; i++) {
1871                 assert(i % 2 != 0
1872                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1873                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1874
1875                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1876                     ANYOF_POSIXL_SET(&temp, i + add);
1877                 }
1878                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1879             }
1880             ANYOF_POSIXL_AND(&temp, ssc);
1881
1882         } /* else ssc already has no posixes */
1883     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1884          in its initial state */
1885     else if (! is_ANYOF_SYNTHETIC(and_with)
1886              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1887     {
1888         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1889          * copy it over 'ssc' */
1890         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1891             if (is_ANYOF_SYNTHETIC(and_with)) {
1892                 StructCopy(and_with, ssc, regnode_ssc);
1893             }
1894             else {
1895                 ssc->invlist = anded_cp_list;
1896                 ANYOF_POSIXL_ZERO(ssc);
1897                 if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1898                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1899                 }
1900             }
1901         }
1902         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1903                  || (and_with_flags & ANYOF_MATCHES_POSIXL))
1904         {
1905             /* One or the other of P1, P2 is non-empty. */
1906             if (and_with_flags & ANYOF_MATCHES_POSIXL) {
1907                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1908             }
1909             ssc_union(ssc, anded_cp_list, FALSE);
1910         }
1911         else { /* P1 = P2 = empty */
1912             ssc_intersection(ssc, anded_cp_list, FALSE);
1913         }
1914     }
1915 }
1916
1917 STATIC void
1918 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1919                const regnode_charclass *or_with)
1920 {
1921     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1922      * another SSC or a regular ANYOF class.  Can create false positives if
1923      * 'or_with' is to be inverted. */
1924
1925     SV* ored_cp_list;
1926     U8 ored_flags;
1927     U8  or_with_flags = inRANGE(OP(or_with), ANYOFH, ANYOFRb)
1928                          ? 0
1929                          : ANYOF_FLAGS(or_with);
1930
1931     PERL_ARGS_ASSERT_SSC_OR;
1932
1933     assert(is_ANYOF_SYNTHETIC(ssc));
1934
1935     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1936      * the code point inversion list and just the relevant flags */
1937     if (is_ANYOF_SYNTHETIC(or_with)) {
1938         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1939         ored_flags = or_with_flags;
1940     }
1941     else {
1942         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1943         ored_flags = or_with_flags & ANYOF_COMMON_FLAGS;
1944         if (OP(or_with) != ANYOFD) {
1945             ored_flags
1946             |= or_with_flags
1947              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1948                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1949             if (ANYOFL_UTF8_LOCALE_REQD(or_with_flags)) {
1950                 ored_flags |=
1951                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1952             }
1953         }
1954     }
1955
1956     ANYOF_FLAGS(ssc) |= ored_flags;
1957
1958     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1959      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1960      * 'or_with' may be inverted.  When not inverted, we have the simple
1961      * situation of computing:
1962      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1963      * If P1|P2 yields a situation with both a class and its complement are
1964      * set, like having both \w and \W, this matches all code points, and we
1965      * can delete these from the P component of the ssc going forward.  XXX We
1966      * might be able to delete all the P components, but I (khw) am not certain
1967      * about this, and it is better to be safe.
1968      *
1969      * Inverted, we have
1970      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1971      *                         <=  (C1 | P1) | ~C2
1972      *                         <=  (C1 | ~C2) | P1
1973      * (which results in actually simpler code than the non-inverted case)
1974      * */
1975
1976     if ((or_with_flags & ANYOF_INVERT)
1977         && ! is_ANYOF_SYNTHETIC(or_with))
1978     {
1979         /* We ignore P2, leaving P1 going forward */
1980     }   /* else  Not inverted */
1981     else if (or_with_flags & ANYOF_MATCHES_POSIXL) {
1982         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1983         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1984             unsigned int i;
1985             for (i = 0; i < ANYOF_MAX; i += 2) {
1986                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1987                 {
1988                     ssc_match_all_cp(ssc);
1989                     ANYOF_POSIXL_CLEAR(ssc, i);
1990                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1991                 }
1992             }
1993         }
1994     }
1995
1996     ssc_union(ssc,
1997               ored_cp_list,
1998               FALSE /* Already has been inverted */
1999               );
2000 }
2001
2002 PERL_STATIC_INLINE void
2003 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
2004 {
2005     PERL_ARGS_ASSERT_SSC_UNION;
2006
2007     assert(is_ANYOF_SYNTHETIC(ssc));
2008
2009     _invlist_union_maybe_complement_2nd(ssc->invlist,
2010                                         invlist,
2011                                         invert2nd,
2012                                         &ssc->invlist);
2013 }
2014
2015 PERL_STATIC_INLINE void
2016 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
2017                          SV* const invlist,
2018                          const bool invert2nd)
2019 {
2020     PERL_ARGS_ASSERT_SSC_INTERSECTION;
2021
2022     assert(is_ANYOF_SYNTHETIC(ssc));
2023
2024     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
2025                                                invlist,
2026                                                invert2nd,
2027                                                &ssc->invlist);
2028 }
2029
2030 PERL_STATIC_INLINE void
2031 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
2032 {
2033     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
2034
2035     assert(is_ANYOF_SYNTHETIC(ssc));
2036
2037     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
2038 }
2039
2040 PERL_STATIC_INLINE void
2041 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
2042 {
2043     /* AND just the single code point 'cp' into the SSC 'ssc' */
2044
2045     SV* cp_list = _new_invlist(2);
2046
2047     PERL_ARGS_ASSERT_SSC_CP_AND;
2048
2049     assert(is_ANYOF_SYNTHETIC(ssc));
2050
2051     cp_list = add_cp_to_invlist(cp_list, cp);
2052     ssc_intersection(ssc, cp_list,
2053                      FALSE /* Not inverted */
2054                      );
2055     SvREFCNT_dec_NN(cp_list);
2056 }
2057
2058 PERL_STATIC_INLINE void
2059 S_ssc_clear_locale(regnode_ssc *ssc)
2060 {
2061     /* Set the SSC 'ssc' to not match any locale things */
2062     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
2063
2064     assert(is_ANYOF_SYNTHETIC(ssc));
2065
2066     ANYOF_POSIXL_ZERO(ssc);
2067     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
2068 }
2069
2070 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
2071
2072 STATIC bool
2073 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
2074 {
2075     /* The synthetic start class is used to hopefully quickly winnow down
2076      * places where a pattern could start a match in the target string.  If it
2077      * doesn't really narrow things down that much, there isn't much point to
2078      * having the overhead of using it.  This function uses some very crude
2079      * heuristics to decide if to use the ssc or not.
2080      *
2081      * It returns TRUE if 'ssc' rules out more than half what it considers to
2082      * be the "likely" possible matches, but of course it doesn't know what the
2083      * actual things being matched are going to be; these are only guesses
2084      *
2085      * For /l matches, it assumes that the only likely matches are going to be
2086      *      in the 0-255 range, uniformly distributed, so half of that is 127
2087      * For /a and /d matches, it assumes that the likely matches will be just
2088      *      the ASCII range, so half of that is 63
2089      * For /u and there isn't anything matching above the Latin1 range, it
2090      *      assumes that that is the only range likely to be matched, and uses
2091      *      half that as the cut-off: 127.  If anything matches above Latin1,
2092      *      it assumes that all of Unicode could match (uniformly), except for
2093      *      non-Unicode code points and things in the General Category "Other"
2094      *      (unassigned, private use, surrogates, controls and formats).  This
2095      *      is a much large number. */
2096
2097     U32 count = 0;      /* Running total of number of code points matched by
2098                            'ssc' */
2099     UV start, end;      /* Start and end points of current range in inversion
2100                            XXX outdated.  UTF-8 locales are common, what about invert? list */
2101     const U32 max_code_points = (LOC)
2102                                 ?  256
2103                                 : ((  ! UNI_SEMANTICS
2104                                     ||  invlist_highest(ssc->invlist) < 256)
2105                                   ? 128
2106                                   : NON_OTHER_COUNT);
2107     const U32 max_match = max_code_points / 2;
2108
2109     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
2110
2111     invlist_iterinit(ssc->invlist);
2112     while (invlist_iternext(ssc->invlist, &start, &end)) {
2113         if (start >= max_code_points) {
2114             break;
2115         }
2116         end = MIN(end, max_code_points - 1);
2117         count += end - start + 1;
2118         if (count >= max_match) {
2119             invlist_iterfinish(ssc->invlist);
2120             return FALSE;
2121         }
2122     }
2123
2124     return TRUE;
2125 }
2126
2127
2128 STATIC void
2129 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
2130 {
2131     /* The inversion list in the SSC is marked mortal; now we need a more
2132      * permanent copy, which is stored the same way that is done in a regular
2133      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
2134      * map */
2135
2136     SV* invlist = invlist_clone(ssc->invlist, NULL);
2137
2138     PERL_ARGS_ASSERT_SSC_FINALIZE;
2139
2140     assert(is_ANYOF_SYNTHETIC(ssc));
2141
2142     /* The code in this file assumes that all but these flags aren't relevant
2143      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
2144      * by the time we reach here */
2145     assert(! (ANYOF_FLAGS(ssc)
2146         & ~( ANYOF_COMMON_FLAGS
2147             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
2148             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
2149
2150     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
2151
2152     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist, NULL, NULL);
2153     SvREFCNT_dec(invlist);
2154
2155     /* Make sure is clone-safe */
2156     ssc->invlist = NULL;
2157
2158     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
2159         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
2160         OP(ssc) = ANYOFPOSIXL;
2161     }
2162     else if (RExC_contains_locale) {
2163         OP(ssc) = ANYOFL;
2164     }
2165
2166     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
2167 }
2168
2169 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
2170 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
2171 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
2172 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
2173                                ? (TRIE_LIST_CUR( idx ) - 1)           \
2174                                : 0 )
2175
2176
2177 #ifdef DEBUGGING
2178 /*
2179    dump_trie(trie,widecharmap,revcharmap)
2180    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
2181    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
2182
2183    These routines dump out a trie in a somewhat readable format.
2184    The _interim_ variants are used for debugging the interim
2185    tables that are used to generate the final compressed
2186    representation which is what dump_trie expects.
2187
2188    Part of the reason for their existence is to provide a form
2189    of documentation as to how the different representations function.
2190
2191 */
2192
2193 /*
2194   Dumps the final compressed table form of the trie to Perl_debug_log.
2195   Used for debugging make_trie().
2196 */
2197
2198 STATIC void
2199 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
2200             AV *revcharmap, U32 depth)
2201 {
2202     U32 state;
2203     SV *sv=sv_newmortal();
2204     int colwidth= widecharmap ? 6 : 4;
2205     U16 word;
2206     GET_RE_DEBUG_FLAGS_DECL;
2207
2208     PERL_ARGS_ASSERT_DUMP_TRIE;
2209
2210     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
2211         depth+1, "Match","Base","Ofs" );
2212
2213     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
2214         SV ** const tmp = av_fetch( revcharmap, state, 0);
2215         if ( tmp ) {
2216             Perl_re_printf( aTHX_  "%*s",
2217                 colwidth,
2218                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2219                             PL_colors[0], PL_colors[1],
2220                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2221                             PERL_PV_ESCAPE_FIRSTCHAR
2222                 )
2223             );
2224         }
2225     }
2226     Perl_re_printf( aTHX_  "\n");
2227     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2228
2229     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2230         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2231     Perl_re_printf( aTHX_  "\n");
2232
2233     for( state = 1 ; state < trie->statecount ; state++ ) {
2234         const U32 base = trie->states[ state ].trans.base;
2235
2236         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2237
2238         if ( trie->states[ state ].wordnum ) {
2239             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2240         } else {
2241             Perl_re_printf( aTHX_  "%6s", "" );
2242         }
2243
2244         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2245
2246         if ( base ) {
2247             U32 ofs = 0;
2248
2249             while( ( base + ofs  < trie->uniquecharcount ) ||
2250                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2251                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2252                                                                     != state))
2253                     ofs++;
2254
2255             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2256
2257             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2258                 if ( ( base + ofs >= trie->uniquecharcount )
2259                         && ( base + ofs - trie->uniquecharcount
2260                                                         < trie->lasttrans )
2261                         && trie->trans[ base + ofs
2262                                     - trie->uniquecharcount ].check == state )
2263                 {
2264                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2265                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2266                    );
2267                 } else {
2268                     Perl_re_printf( aTHX_  "%*s", colwidth,"   ." );
2269                 }
2270             }
2271
2272             Perl_re_printf( aTHX_  "]");
2273
2274         }
2275         Perl_re_printf( aTHX_  "\n" );
2276     }
2277     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2278                                 depth);
2279     for (word=1; word <= trie->wordcount; word++) {
2280         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2281             (int)word, (int)(trie->wordinfo[word].prev),
2282             (int)(trie->wordinfo[word].len));
2283     }
2284     Perl_re_printf( aTHX_  "\n" );
2285 }
2286 /*
2287   Dumps a fully constructed but uncompressed trie in list form.
2288   List tries normally only are used for construction when the number of
2289   possible chars (trie->uniquecharcount) is very high.
2290   Used for debugging make_trie().
2291 */
2292 STATIC void
2293 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2294                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2295                          U32 depth)
2296 {
2297     U32 state;
2298     SV *sv=sv_newmortal();
2299     int colwidth= widecharmap ? 6 : 4;
2300     GET_RE_DEBUG_FLAGS_DECL;
2301
2302     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2303
2304     /* print out the table precompression.  */
2305     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2306             depth+1 );
2307     Perl_re_indentf( aTHX_  "%s",
2308             depth+1, "------:-----+-----------------\n" );
2309
2310     for( state=1 ; state < next_alloc ; state ++ ) {
2311         U16 charid;
2312
2313         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2314             depth+1, (UV)state  );
2315         if ( ! trie->states[ state ].wordnum ) {
2316             Perl_re_printf( aTHX_  "%5s| ","");
2317         } else {
2318             Perl_re_printf( aTHX_  "W%4x| ",
2319                 trie->states[ state ].wordnum
2320             );
2321         }
2322         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2323             SV ** const tmp = av_fetch( revcharmap,
2324                                         TRIE_LIST_ITEM(state, charid).forid, 0);
2325             if ( tmp ) {
2326                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2327                     colwidth,
2328                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2329                               colwidth,
2330                               PL_colors[0], PL_colors[1],
2331                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2332                               | PERL_PV_ESCAPE_FIRSTCHAR
2333                     ) ,
2334                     TRIE_LIST_ITEM(state, charid).forid,
2335                     (UV)TRIE_LIST_ITEM(state, charid).newstate
2336                 );
2337                 if (!(charid % 10))
2338                     Perl_re_printf( aTHX_  "\n%*s| ",
2339                         (int)((depth * 2) + 14), "");
2340             }
2341         }
2342         Perl_re_printf( aTHX_  "\n");
2343     }
2344 }
2345
2346 /*
2347   Dumps a fully constructed but uncompressed trie in table form.
2348   This is the normal DFA style state transition table, with a few
2349   twists to facilitate compression later.
2350   Used for debugging make_trie().
2351 */
2352 STATIC void
2353 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2354                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2355                           U32 depth)
2356 {
2357     U32 state;
2358     U16 charid;
2359     SV *sv=sv_newmortal();
2360     int colwidth= widecharmap ? 6 : 4;
2361     GET_RE_DEBUG_FLAGS_DECL;
2362
2363     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2364
2365     /*
2366        print out the table precompression so that we can do a visual check
2367        that they are identical.
2368      */
2369
2370     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2371
2372     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2373         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2374         if ( tmp ) {
2375             Perl_re_printf( aTHX_  "%*s",
2376                 colwidth,
2377                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2378                             PL_colors[0], PL_colors[1],
2379                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2380                             PERL_PV_ESCAPE_FIRSTCHAR
2381                 )
2382             );
2383         }
2384     }
2385
2386     Perl_re_printf( aTHX_ "\n");
2387     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2388
2389     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2390         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2391     }
2392
2393     Perl_re_printf( aTHX_  "\n" );
2394
2395     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2396
2397         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2398             depth+1,
2399             (UV)TRIE_NODENUM( state ) );
2400
2401         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2402             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2403             if (v)
2404                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2405             else
2406                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2407         }
2408         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2409             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2410                                             (UV)trie->trans[ state ].check );
2411         } else {
2412             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2413                                             (UV)trie->trans[ state ].check,
2414             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2415         }
2416     }
2417 }
2418
2419 #endif
2420
2421
2422 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2423   startbranch: the first branch in the whole branch sequence
2424   first      : start branch of sequence of branch-exact nodes.
2425                May be the same as startbranch
2426   last       : Thing following the last branch.
2427                May be the same as tail.
2428   tail       : item following the branch sequence
2429   count      : words in the sequence
2430   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2431   depth      : indent depth
2432
2433 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2434
2435 A trie is an N'ary tree where the branches are determined by digital
2436 decomposition of the key. IE, at the root node you look up the 1st character and
2437 follow that branch repeat until you find the end of the branches. Nodes can be
2438 marked as "accepting" meaning they represent a complete word. Eg:
2439
2440   /he|she|his|hers/
2441
2442 would convert into the following structure. Numbers represent states, letters
2443 following numbers represent valid transitions on the letter from that state, if
2444 the number is in square brackets it represents an accepting state, otherwise it
2445 will be in parenthesis.
2446
2447       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2448       |    |
2449       |   (2)
2450       |    |
2451      (1)   +-i->(6)-+-s->[7]
2452       |
2453       +-s->(3)-+-h->(4)-+-e->[5]
2454
2455       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2456
2457 This shows that when matching against the string 'hers' we will begin at state 1
2458 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2459 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2460 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2461 single traverse. We store a mapping from accepting to state to which word was
2462 matched, and then when we have multiple possibilities we try to complete the
2463 rest of the regex in the order in which they occurred in the alternation.
2464
2465 The only prior NFA like behaviour that would be changed by the TRIE support is
2466 the silent ignoring of duplicate alternations which are of the form:
2467
2468  / (DUPE|DUPE) X? (?{ ... }) Y /x
2469
2470 Thus EVAL blocks following a trie may be called a different number of times with
2471 and without the optimisation. With the optimisations dupes will be silently
2472 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2473 the following demonstrates:
2474
2475  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2476
2477 which prints out 'word' three times, but
2478
2479  'words'=~/(word|word|word)(?{ print $1 })S/
2480
2481 which doesnt print it out at all. This is due to other optimisations kicking in.
2482
2483 Example of what happens on a structural level:
2484
2485 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2486
2487    1: CURLYM[1] {1,32767}(18)
2488    5:   BRANCH(8)
2489    6:     EXACT <ac>(16)
2490    8:   BRANCH(11)
2491    9:     EXACT <ad>(16)
2492   11:   BRANCH(14)
2493   12:     EXACT <ab>(16)
2494   16:   SUCCEED(0)
2495   17:   NOTHING(18)
2496   18: END(0)
2497
2498 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2499 and should turn into:
2500
2501    1: CURLYM[1] {1,32767}(18)
2502    5:   TRIE(16)
2503         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2504           <ac>
2505           <ad>
2506           <ab>
2507   16:   SUCCEED(0)
2508   17:   NOTHING(18)
2509   18: END(0)
2510
2511 Cases where tail != last would be like /(?foo|bar)baz/:
2512
2513    1: BRANCH(4)
2514    2:   EXACT <foo>(8)
2515    4: BRANCH(7)
2516    5:   EXACT <bar>(8)
2517    7: TAIL(8)
2518    8: EXACT <baz>(10)
2519   10: END(0)
2520
2521 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2522 and would end up looking like:
2523
2524     1: TRIE(8)
2525       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2526         <foo>
2527         <bar>
2528    7: TAIL(8)
2529    8: EXACT <baz>(10)
2530   10: END(0)
2531
2532     d = uvchr_to_utf8_flags(d, uv, 0);
2533
2534 is the recommended Unicode-aware way of saying
2535
2536     *(d++) = uv;
2537 */
2538
2539 #define TRIE_STORE_REVCHAR(val)                                            \
2540     STMT_START {                                                           \
2541         if (UTF) {                                                         \
2542             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2543             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2544             unsigned char *const kapow = uvchr_to_utf8(flrbbbbb, val);     \
2545             *kapow = '\0';                                                 \
2546             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2547             SvPOK_on(zlopp);                                               \
2548             SvUTF8_on(zlopp);                                              \
2549             av_push(revcharmap, zlopp);                                    \
2550         } else {                                                           \
2551             char ooooff = (char)val;                                           \
2552             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2553         }                                                                  \
2554         } STMT_END
2555
2556 /* This gets the next character from the input, folding it if not already
2557  * folded. */
2558 #define TRIE_READ_CHAR STMT_START {                                           \
2559     wordlen++;                                                                \
2560     if ( UTF ) {                                                              \
2561         /* if it is UTF then it is either already folded, or does not need    \
2562          * folding */                                                         \
2563         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2564     }                                                                         \
2565     else if (folder == PL_fold_latin1) {                                      \
2566         /* This folder implies Unicode rules, which in the range expressible  \
2567          *  by not UTF is the lower case, with the two exceptions, one of     \
2568          *  which should have been taken care of before calling this */       \
2569         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2570         uvc = toLOWER_L1(*uc);                                                \
2571         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2572         len = 1;                                                              \
2573     } else {                                                                  \
2574         /* raw data, will be folded later if needed */                        \
2575         uvc = (U32)*uc;                                                       \
2576         len = 1;                                                              \
2577     }                                                                         \
2578 } STMT_END
2579
2580
2581
2582 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2583     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2584         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2585         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2586         TRIE_LIST_LEN( state ) = ging;                          \
2587     }                                                           \
2588     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2589     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2590     TRIE_LIST_CUR( state )++;                                   \
2591 } STMT_END
2592
2593 #define TRIE_LIST_NEW(state) STMT_START {                       \
2594     Newx( trie->states[ state ].trans.list,                     \
2595         4, reg_trie_trans_le );                                 \
2596      TRIE_LIST_CUR( state ) = 1;                                \
2597      TRIE_LIST_LEN( state ) = 4;                                \
2598 } STMT_END
2599
2600 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2601     U16 dupe= trie->states[ state ].wordnum;                    \
2602     regnode * const noper_next = regnext( noper );              \
2603                                                                 \
2604     DEBUG_r({                                                   \
2605         /* store the word for dumping */                        \
2606         SV* tmp;                                                \
2607         if (OP(noper) != NOTHING)                               \
2608             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2609         else                                                    \
2610             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2611         av_push( trie_words, tmp );                             \
2612     });                                                         \
2613                                                                 \
2614     curword++;                                                  \
2615     trie->wordinfo[curword].prev   = 0;                         \
2616     trie->wordinfo[curword].len    = wordlen;                   \
2617     trie->wordinfo[curword].accept = state;                     \
2618                                                                 \
2619     if ( noper_next < tail ) {                                  \
2620         if (!trie->jump)                                        \
2621             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2622                                                  sizeof(U16) ); \
2623         trie->jump[curword] = (U16)(noper_next - convert);      \
2624         if (!jumper)                                            \
2625             jumper = noper_next;                                \
2626         if (!nextbranch)                                        \
2627             nextbranch= regnext(cur);                           \
2628     }                                                           \
2629                                                                 \
2630     if ( dupe ) {                                               \
2631         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2632         /* chain, so that when the bits of chain are later    */\
2633         /* linked together, the dups appear in the chain      */\
2634         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2635         trie->wordinfo[dupe].prev = curword;                    \
2636     } else {                                                    \
2637         /* we haven't inserted this word yet.                */ \
2638         trie->states[ state ].wordnum = curword;                \
2639     }                                                           \
2640 } STMT_END
2641
2642
2643 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2644      ( ( base + charid >=  ucharcount                                   \
2645          && base + charid < ubound                                      \
2646          && state == trie->trans[ base - ucharcount + charid ].check    \
2647          && trie->trans[ base - ucharcount + charid ].next )            \
2648            ? trie->trans[ base - ucharcount + charid ].next             \
2649            : ( state==1 ? special : 0 )                                 \
2650       )
2651
2652 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2653 STMT_START {                                                \
2654     TRIE_BITMAP_SET(trie, uvc);                             \
2655     /* store the folded codepoint */                        \
2656     if ( folder )                                           \
2657         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2658                                                             \
2659     if ( !UTF ) {                                           \
2660         /* store first byte of utf8 representation of */    \
2661         /* variant codepoints */                            \
2662         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2663             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2664         }                                                   \
2665     }                                                       \
2666 } STMT_END
2667 #define MADE_TRIE       1
2668 #define MADE_JUMP_TRIE  2
2669 #define MADE_EXACT_TRIE 4
2670
2671 STATIC I32
2672 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2673                   regnode *first, regnode *last, regnode *tail,
2674                   U32 word_count, U32 flags, U32 depth)
2675 {
2676     /* first pass, loop through and scan words */
2677     reg_trie_data *trie;
2678     HV *widecharmap = NULL;
2679     AV *revcharmap = newAV();
2680     regnode *cur;
2681     STRLEN len = 0;
2682     UV uvc = 0;
2683     U16 curword = 0;
2684     U32 next_alloc = 0;
2685     regnode *jumper = NULL;
2686     regnode *nextbranch = NULL;
2687     regnode *convert = NULL;
2688     U32 *prev_states; /* temp array mapping each state to previous one */
2689     /* we just use folder as a flag in utf8 */
2690     const U8 * folder = NULL;
2691
2692     /* in the below add_data call we are storing either 'tu' or 'tuaa'
2693      * which stands for one trie structure, one hash, optionally followed
2694      * by two arrays */
2695 #ifdef DEBUGGING
2696     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuaa"));
2697     AV *trie_words = NULL;
2698     /* along with revcharmap, this only used during construction but both are
2699      * useful during debugging so we store them in the struct when debugging.
2700      */
2701 #else
2702     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2703     STRLEN trie_charcount=0;
2704 #endif
2705     SV *re_trie_maxbuff;
2706     GET_RE_DEBUG_FLAGS_DECL;
2707
2708     PERL_ARGS_ASSERT_MAKE_TRIE;
2709 #ifndef DEBUGGING
2710     PERL_UNUSED_ARG(depth);
2711 #endif
2712
2713     switch (flags) {
2714         case EXACT: case EXACT_REQ8: case EXACTL: break;
2715         case EXACTFAA:
2716         case EXACTFUP:
2717         case EXACTFU:
2718         case EXACTFLU8: folder = PL_fold_latin1; break;
2719         case EXACTF:  folder = PL_fold; break;
2720         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2721     }
2722
2723     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2724     trie->refcount = 1;
2725     trie->startstate = 1;
2726     trie->wordcount = word_count;
2727     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2728     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2729     if (flags == EXACT || flags == EXACT_REQ8 || flags == EXACTL)
2730         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2731     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2732                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2733
2734     DEBUG_r({
2735         trie_words = newAV();
2736     });
2737
2738     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, GV_ADD);
2739     assert(re_trie_maxbuff);
2740     if (!SvIOK(re_trie_maxbuff)) {
2741         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2742     }
2743     DEBUG_TRIE_COMPILE_r({
2744         Perl_re_indentf( aTHX_
2745           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2746           depth+1,
2747           REG_NODE_NUM(startbranch), REG_NODE_NUM(first),
2748           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2749     });
2750
2751    /* Find the node we are going to overwrite */
2752     if ( first == startbranch && OP( last ) != BRANCH ) {
2753         /* whole branch chain */
2754         convert = first;
2755     } else {
2756         /* branch sub-chain */
2757         convert = NEXTOPER( first );
2758     }
2759
2760     /*  -- First loop and Setup --
2761
2762        We first traverse the branches and scan each word to determine if it
2763        contains widechars, and how many unique chars there are, this is
2764        important as we have to build a table with at least as many columns as we
2765        have unique chars.
2766
2767        We use an array of integers to represent the character codes 0..255
2768        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2769        the native representation of the character value as the key and IV's for
2770        the coded index.
2771
2772        *TODO* If we keep track of how many times each character is used we can
2773        remap the columns so that the table compression later on is more
2774        efficient in terms of memory by ensuring the most common value is in the
2775        middle and the least common are on the outside.  IMO this would be better
2776        than a most to least common mapping as theres a decent chance the most
2777        common letter will share a node with the least common, meaning the node
2778        will not be compressible. With a middle is most common approach the worst
2779        case is when we have the least common nodes twice.
2780
2781      */
2782
2783     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2784         regnode *noper = NEXTOPER( cur );
2785         const U8 *uc;
2786         const U8 *e;
2787         int foldlen = 0;
2788         U32 wordlen      = 0;         /* required init */
2789         STRLEN minchars = 0;
2790         STRLEN maxchars = 0;
2791         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2792                                                bitmap?*/
2793
2794         if (OP(noper) == NOTHING) {
2795             /* skip past a NOTHING at the start of an alternation
2796              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2797              */
2798             regnode *noper_next= regnext(noper);
2799             if (noper_next < tail)
2800                 noper= noper_next;
2801         }
2802
2803         if (    noper < tail
2804             && (    OP(noper) == flags
2805                 || (flags == EXACT && OP(noper) == EXACT_REQ8)
2806                 || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
2807                                          || OP(noper) == EXACTFUP))))
2808         {
2809             uc= (U8*)STRING(noper);
2810             e= uc + STR_LEN(noper);
2811         } else {
2812             trie->minlen= 0;
2813             continue;
2814         }
2815
2816
2817         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2818             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2819                                           regardless of encoding */
2820             if (OP( noper ) == EXACTFUP) {
2821                 /* false positives are ok, so just set this */
2822                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2823             }
2824         }
2825
2826         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2827                                            branch */
2828             TRIE_CHARCOUNT(trie)++;
2829             TRIE_READ_CHAR;
2830
2831             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2832              * is in effect.  Under /i, this character can match itself, or
2833              * anything that folds to it.  If not under /i, it can match just
2834              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2835              * all fold to k, and all are single characters.   But some folds
2836              * expand to more than one character, so for example LATIN SMALL
2837              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2838              * the string beginning at 'uc' is 'ffi', it could be matched by
2839              * three characters, or just by the one ligature character. (It
2840              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2841              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2842              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2843              * match.)  The trie needs to know the minimum and maximum number
2844              * of characters that could match so that it can use size alone to
2845              * quickly reject many match attempts.  The max is simple: it is
2846              * the number of folded characters in this branch (since a fold is
2847              * never shorter than what folds to it. */
2848
2849             maxchars++;
2850
2851             /* And the min is equal to the max if not under /i (indicated by
2852              * 'folder' being NULL), or there are no multi-character folds.  If
2853              * there is a multi-character fold, the min is incremented just
2854              * once, for the character that folds to the sequence.  Each
2855              * character in the sequence needs to be added to the list below of
2856              * characters in the trie, but we count only the first towards the
2857              * min number of characters needed.  This is done through the
2858              * variable 'foldlen', which is returned by the macros that look
2859              * for these sequences as the number of bytes the sequence
2860              * occupies.  Each time through the loop, we decrement 'foldlen' by
2861              * how many bytes the current char occupies.  Only when it reaches
2862              * 0 do we increment 'minchars' or look for another multi-character
2863              * sequence. */
2864             if (folder == NULL) {
2865                 minchars++;
2866             }
2867             else if (foldlen > 0) {
2868                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2869             }
2870             else {
2871                 minchars++;
2872
2873                 /* See if *uc is the beginning of a multi-character fold.  If
2874                  * so, we decrement the length remaining to look at, to account
2875                  * for the current character this iteration.  (We can use 'uc'
2876                  * instead of the fold returned by TRIE_READ_CHAR because for
2877                  * non-UTF, the latin1_safe macro is smart enough to account
2878                  * for all the unfolded characters, and because for UTF, the
2879                  * string will already have been folded earlier in the
2880                  * compilation process */
2881                 if (UTF) {
2882                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2883                         foldlen -= UTF8SKIP(uc);
2884                     }
2885                 }
2886                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2887                     foldlen--;
2888                 }
2889             }
2890
2891             /* The current character (and any potential folds) should be added
2892              * to the possible matching characters for this position in this
2893              * branch */
2894             if ( uvc < 256 ) {
2895                 if ( folder ) {
2896                     U8 folded= folder[ (U8) uvc ];
2897                     if ( !trie->charmap[ folded ] ) {
2898                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2899                         TRIE_STORE_REVCHAR( folded );
2900                     }
2901                 }
2902                 if ( !trie->charmap[ uvc ] ) {
2903                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2904                     TRIE_STORE_REVCHAR( uvc );
2905                 }
2906                 if ( set_bit ) {
2907                     /* store the codepoint in the bitmap, and its folded
2908                      * equivalent. */
2909                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2910                     set_bit = 0; /* We've done our bit :-) */
2911                 }
2912             } else {
2913
2914                 /* XXX We could come up with the list of code points that fold
2915                  * to this using PL_utf8_foldclosures, except not for
2916                  * multi-char folds, as there may be multiple combinations
2917                  * there that could work, which needs to wait until runtime to
2918                  * resolve (The comment about LIGATURE FFI above is such an
2919                  * example */
2920
2921                 SV** svpp;
2922                 if ( !widecharmap )
2923                     widecharmap = newHV();
2924
2925                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2926
2927                 if ( !svpp )
2928                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2929
2930                 if ( !SvTRUE( *svpp ) ) {
2931                     sv_setiv( *svpp, ++trie->uniquecharcount );
2932                     TRIE_STORE_REVCHAR(uvc);
2933                 }
2934             }
2935         } /* end loop through characters in this branch of the trie */
2936
2937         /* We take the min and max for this branch and combine to find the min
2938          * and max for all branches processed so far */
2939         if( cur == first ) {
2940             trie->minlen = minchars;
2941             trie->maxlen = maxchars;
2942         } else if (minchars < trie->minlen) {
2943             trie->minlen = minchars;
2944         } else if (maxchars > trie->maxlen) {
2945             trie->maxlen = maxchars;
2946         }
2947     } /* end first pass */
2948     DEBUG_TRIE_COMPILE_r(
2949         Perl_re_indentf( aTHX_
2950                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2951                 depth+1,
2952                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2953                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2954                 (int)trie->minlen, (int)trie->maxlen )
2955     );
2956
2957     /*
2958         We now know what we are dealing with in terms of unique chars and
2959         string sizes so we can calculate how much memory a naive
2960         representation using a flat table  will take. If it's over a reasonable
2961         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2962         conservative but potentially much slower representation using an array
2963         of lists.
2964
2965         At the end we convert both representations into the same compressed
2966         form that will be used in regexec.c for matching with. The latter
2967         is a form that cannot be used to construct with but has memory
2968         properties similar to the list form and access properties similar
2969         to the table form making it both suitable for fast searches and
2970         small enough that its feasable to store for the duration of a program.
2971
2972         See the comment in the code where the compressed table is produced
2973         inplace from the flat tabe representation for an explanation of how
2974         the compression works.
2975
2976     */
2977
2978
2979     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2980     prev_states[1] = 0;
2981
2982     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2983                                                     > SvIV(re_trie_maxbuff) )
2984     {
2985         /*
2986             Second Pass -- Array Of Lists Representation
2987
2988             Each state will be represented by a list of charid:state records
2989             (reg_trie_trans_le) the first such element holds the CUR and LEN
2990             points of the allocated array. (See defines above).
2991
2992             We build the initial structure using the lists, and then convert
2993             it into the compressed table form which allows faster lookups
2994             (but cant be modified once converted).
2995         */
2996
2997         STRLEN transcount = 1;
2998
2999         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
3000             depth+1));
3001
3002         trie->states = (reg_trie_state *)
3003             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3004                                   sizeof(reg_trie_state) );
3005         TRIE_LIST_NEW(1);
3006         next_alloc = 2;
3007
3008         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3009
3010             regnode *noper   = NEXTOPER( cur );
3011             U32 state        = 1;         /* required init */
3012             U16 charid       = 0;         /* sanity init */
3013             U32 wordlen      = 0;         /* required init */
3014
3015             if (OP(noper) == NOTHING) {
3016                 regnode *noper_next= regnext(noper);
3017                 if (noper_next < tail)
3018                     noper= noper_next;
3019             }
3020
3021             if (    noper < tail
3022                 && (    OP(noper) == flags
3023                     || (flags == EXACT && OP(noper) == EXACT_REQ8)
3024                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
3025                                              || OP(noper) == EXACTFUP))))
3026             {
3027                 const U8 *uc= (U8*)STRING(noper);
3028                 const U8 *e= uc + STR_LEN(noper);
3029
3030                 for ( ; uc < e ; uc += len ) {
3031
3032                     TRIE_READ_CHAR;
3033
3034                     if ( uvc < 256 ) {
3035                         charid = trie->charmap[ uvc ];
3036                     } else {
3037                         SV** const svpp = hv_fetch( widecharmap,
3038                                                     (char*)&uvc,
3039                                                     sizeof( UV ),
3040                                                     0);
3041                         if ( !svpp ) {
3042                             charid = 0;
3043                         } else {
3044                             charid=(U16)SvIV( *svpp );
3045                         }
3046                     }
3047                     /* charid is now 0 if we dont know the char read, or
3048                      * nonzero if we do */
3049                     if ( charid ) {
3050
3051                         U16 check;
3052                         U32 newstate = 0;
3053
3054                         charid--;
3055                         if ( !trie->states[ state ].trans.list ) {
3056                             TRIE_LIST_NEW( state );
3057                         }
3058                         for ( check = 1;
3059                               check <= TRIE_LIST_USED( state );
3060                               check++ )
3061                         {
3062                             if ( TRIE_LIST_ITEM( state, check ).forid
3063                                                                     == charid )
3064                             {
3065                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
3066                                 break;
3067                             }
3068                         }
3069                         if ( ! newstate ) {
3070                             newstate = next_alloc++;
3071                             prev_states[newstate] = state;
3072                             TRIE_LIST_PUSH( state, charid, newstate );
3073                             transcount++;
3074                         }
3075                         state = newstate;
3076                     } else {
3077                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3078                     }
3079                 }
3080             }
3081             TRIE_HANDLE_WORD(state);
3082
3083         } /* end second pass */
3084
3085         /* next alloc is the NEXT state to be allocated */
3086         trie->statecount = next_alloc;
3087         trie->states = (reg_trie_state *)
3088             PerlMemShared_realloc( trie->states,
3089                                    next_alloc
3090                                    * sizeof(reg_trie_state) );
3091
3092         /* and now dump it out before we compress it */
3093         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
3094                                                          revcharmap, next_alloc,
3095                                                          depth+1)
3096         );
3097
3098         trie->trans = (reg_trie_trans *)
3099             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
3100         {
3101             U32 state;
3102             U32 tp = 0;
3103             U32 zp = 0;
3104
3105
3106             for( state=1 ; state < next_alloc ; state ++ ) {
3107                 U32 base=0;
3108
3109                 /*
3110                 DEBUG_TRIE_COMPILE_MORE_r(
3111                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
3112                 );
3113                 */
3114
3115                 if (trie->states[state].trans.list) {
3116                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
3117                     U16 maxid=minid;
3118                     U16 idx;
3119
3120                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3121                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
3122                         if ( forid < minid ) {
3123                             minid=forid;
3124                         } else if ( forid > maxid ) {
3125                             maxid=forid;
3126                         }
3127                     }
3128                     if ( transcount < tp + maxid - minid + 1) {
3129                         transcount *= 2;
3130                         trie->trans = (reg_trie_trans *)
3131                             PerlMemShared_realloc( trie->trans,
3132                                                      transcount
3133                                                      * sizeof(reg_trie_trans) );
3134                         Zero( trie->trans + (transcount / 2),
3135                               transcount / 2,
3136                               reg_trie_trans );
3137                     }
3138                     base = trie->uniquecharcount + tp - minid;
3139                     if ( maxid == minid ) {
3140                         U32 set = 0;
3141                         for ( ; zp < tp ; zp++ ) {
3142                             if ( ! trie->trans[ zp ].next ) {
3143                                 base = trie->uniquecharcount + zp - minid;
3144                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
3145                                                                    1).newstate;
3146                                 trie->trans[ zp ].check = state;
3147                                 set = 1;
3148                                 break;
3149                             }
3150                         }
3151                         if ( !set ) {
3152                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
3153                                                                    1).newstate;
3154                             trie->trans[ tp ].check = state;
3155                             tp++;
3156                             zp = tp;
3157                         }
3158                     } else {
3159                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
3160                             const U32 tid = base
3161                                            - trie->uniquecharcount
3162                                            + TRIE_LIST_ITEM( state, idx ).forid;
3163                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
3164                                                                 idx ).newstate;
3165                             trie->trans[ tid ].check = state;
3166                         }
3167                         tp += ( maxid - minid + 1 );
3168                     }
3169                     Safefree(trie->states[ state ].trans.list);
3170                 }
3171                 /*
3172                 DEBUG_TRIE_COMPILE_MORE_r(
3173                     Perl_re_printf( aTHX_  " base: %d\n",base);
3174                 );
3175                 */
3176                 trie->states[ state ].trans.base=base;
3177             }
3178             trie->lasttrans = tp + 1;
3179         }
3180     } else {
3181         /*
3182            Second Pass -- Flat Table Representation.
3183
3184            we dont use the 0 slot of either trans[] or states[] so we add 1 to
3185            each.  We know that we will need Charcount+1 trans at most to store
3186            the data (one row per char at worst case) So we preallocate both
3187            structures assuming worst case.
3188
3189            We then construct the trie using only the .next slots of the entry
3190            structs.
3191
3192            We use the .check field of the first entry of the node temporarily
3193            to make compression both faster and easier by keeping track of how
3194            many non zero fields are in the node.
3195
3196            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
3197            transition.
3198
3199            There are two terms at use here: state as a TRIE_NODEIDX() which is
3200            a number representing the first entry of the node, and state as a
3201            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
3202            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
3203            if there are 2 entrys per node. eg:
3204
3205              A B       A B
3206           1. 2 4    1. 3 7
3207           2. 0 3    3. 0 5
3208           3. 0 0    5. 0 0
3209           4. 0 0    7. 0 0
3210
3211            The table is internally in the right hand, idx form. However as we
3212            also have to deal with the states array which is indexed by nodenum
3213            we have to use TRIE_NODENUM() to convert.
3214
3215         */
3216         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
3217             depth+1));
3218
3219         trie->trans = (reg_trie_trans *)
3220             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
3221                                   * trie->uniquecharcount + 1,
3222                                   sizeof(reg_trie_trans) );
3223         trie->states = (reg_trie_state *)
3224             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
3225                                   sizeof(reg_trie_state) );
3226         next_alloc = trie->uniquecharcount + 1;
3227
3228
3229         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
3230
3231             regnode *noper   = NEXTOPER( cur );
3232
3233             U32 state        = 1;         /* required init */
3234
3235             U16 charid       = 0;         /* sanity init */
3236             U32 accept_state = 0;         /* sanity init */
3237
3238             U32 wordlen      = 0;         /* required init */
3239
3240             if (OP(noper) == NOTHING) {
3241                 regnode *noper_next= regnext(noper);
3242                 if (noper_next < tail)
3243                     noper= noper_next;
3244             }
3245
3246             if (    noper < tail
3247                 && (    OP(noper) == flags
3248                     || (flags == EXACT && OP(noper) == EXACT_REQ8)
3249                     || (flags == EXACTFU && (   OP(noper) == EXACTFU_REQ8
3250                                              || OP(noper) == EXACTFUP))))
3251             {
3252                 const U8 *uc= (U8*)STRING(noper);
3253                 const U8 *e= uc + STR_LEN(noper);
3254
3255                 for ( ; uc < e ; uc += len ) {
3256
3257                     TRIE_READ_CHAR;
3258
3259                     if ( uvc < 256 ) {
3260                         charid = trie->charmap[ uvc ];
3261                     } else {
3262                         SV* const * const svpp = hv_fetch( widecharmap,
3263                                                            (char*)&uvc,
3264                                                            sizeof( UV ),
3265                                                            0);
3266                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3267                     }
3268                     if ( charid ) {
3269                         charid--;
3270                         if ( !trie->trans[ state + charid ].next ) {
3271                             trie->trans[ state + charid ].next = next_alloc;
3272                             trie->trans[ state ].check++;
3273                             prev_states[TRIE_NODENUM(next_alloc)]
3274                                     = TRIE_NODENUM(state);
3275                             next_alloc += trie->uniquecharcount;
3276                         }
3277                         state = trie->trans[ state + charid ].next;
3278                     } else {
3279                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3280                     }
3281                     /* charid is now 0 if we dont know the char read, or
3282                      * nonzero if we do */
3283                 }
3284             }
3285             accept_state = TRIE_NODENUM( state );
3286             TRIE_HANDLE_WORD(accept_state);
3287
3288         } /* end second pass */
3289
3290         /* and now dump it out before we compress it */
3291         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3292                                                           revcharmap,
3293                                                           next_alloc, depth+1));
3294
3295         {
3296         /*
3297            * Inplace compress the table.*
3298
3299            For sparse data sets the table constructed by the trie algorithm will
3300            be mostly 0/FAIL transitions or to put it another way mostly empty.
3301            (Note that leaf nodes will not contain any transitions.)
3302
3303            This algorithm compresses the tables by eliminating most such
3304            transitions, at the cost of a modest bit of extra work during lookup:
3305
3306            - Each states[] entry contains a .base field which indicates the
3307            index in the state[] array wheres its transition data is stored.
3308
3309            - If .base is 0 there are no valid transitions from that node.
3310
3311            - If .base is nonzero then charid is added to it to find an entry in
3312            the trans array.
3313
3314            -If trans[states[state].base+charid].check!=state then the
3315            transition is taken to be a 0/Fail transition. Thus if there are fail
3316            transitions at the front of the node then the .base offset will point
3317            somewhere inside the previous nodes data (or maybe even into a node
3318            even earlier), but the .check field determines if the transition is
3319            valid.
3320
3321            XXX - wrong maybe?
3322            The following process inplace converts the table to the compressed
3323            table: We first do not compress the root node 1,and mark all its
3324            .check pointers as 1 and set its .base pointer as 1 as well. This
3325            allows us to do a DFA construction from the compressed table later,
3326            and ensures that any .base pointers we calculate later are greater
3327            than 0.
3328
3329            - We set 'pos' to indicate the first entry of the second node.
3330
3331            - We then iterate over the columns of the node, finding the first and
3332            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3333            and set the .check pointers accordingly, and advance pos
3334            appropriately and repreat for the next node. Note that when we copy
3335            the next pointers we have to convert them from the original
3336            NODEIDX form to NODENUM form as the former is not valid post
3337            compression.
3338
3339            - If a node has no transitions used we mark its base as 0 and do not
3340            advance the pos pointer.
3341
3342            - If a node only has one transition we use a second pointer into the
3343            structure to fill in allocated fail transitions from other states.
3344            This pointer is independent of the main pointer and scans forward
3345            looking for null transitions that are allocated to a state. When it
3346            finds one it writes the single transition into the "hole".  If the
3347            pointer doesnt find one the single transition is appended as normal.
3348
3349            - Once compressed we can Renew/realloc the structures to release the
3350            excess space.
3351
3352            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3353            specifically Fig 3.47 and the associated pseudocode.
3354
3355            demq
3356         */
3357         const U32 laststate = TRIE_NODENUM( next_alloc );
3358         U32 state, charid;
3359         U32 pos = 0, zp=0;
3360         trie->statecount = laststate;
3361
3362         for ( state = 1 ; state < laststate ; state++ ) {
3363             U8 flag = 0;
3364             const U32 stateidx = TRIE_NODEIDX( state );
3365             const U32 o_used = trie->trans[ stateidx ].check;
3366             U32 used = trie->trans[ stateidx ].check;
3367             trie->trans[ stateidx ].check = 0;
3368
3369             for ( charid = 0;
3370                   used && charid < trie->uniquecharcount;
3371                   charid++ )
3372             {
3373                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3374                     if ( trie->trans[ stateidx + charid ].next ) {
3375                         if (o_used == 1) {
3376                             for ( ; zp < pos ; zp++ ) {
3377                                 if ( ! trie->trans[ zp ].next ) {
3378                                     break;
3379                                 }
3380                             }
3381                             trie->states[ state ].trans.base
3382                                                     = zp
3383                                                       + trie->uniquecharcount
3384                                                       - charid ;
3385                             trie->trans[ zp ].next
3386                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3387                                                              + charid ].next );
3388                             trie->trans[ zp ].check = state;
3389                             if ( ++zp > pos ) pos = zp;
3390                             break;
3391                         }
3392                         used--;
3393                     }
3394                     if ( !flag ) {
3395                         flag = 1;
3396                         trie->states[ state ].trans.base
3397                                        = pos + trie->uniquecharcount - charid ;
3398                     }
3399                     trie->trans[ pos ].next
3400                         = SAFE_TRIE_NODENUM(
3401                                        trie->trans[ stateidx + charid ].next );
3402                     trie->trans[ pos ].check = state;
3403                     pos++;
3404                 }
3405             }
3406         }
3407         trie->lasttrans = pos + 1;
3408         trie->states = (reg_trie_state *)
3409             PerlMemShared_realloc( trie->states, laststate
3410                                    * sizeof(reg_trie_state) );
3411         DEBUG_TRIE_COMPILE_MORE_r(
3412             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3413                 depth+1,
3414                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3415                        + 1 ),
3416                 (IV)next_alloc,
3417                 (IV)pos,
3418                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3419             );
3420
3421         } /* end table compress */
3422     }
3423     DEBUG_TRIE_COMPILE_MORE_r(
3424             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3425                 depth+1,
3426                 (UV)trie->statecount,
3427                 (UV)trie->lasttrans)
3428     );
3429     /* resize the trans array to remove unused space */
3430     trie->trans = (reg_trie_trans *)
3431         PerlMemShared_realloc( trie->trans, trie->lasttrans
3432                                * sizeof(reg_trie_trans) );
3433
3434     {   /* Modify the program and insert the new TRIE node */
3435         U8 nodetype =(U8)(flags & 0xFF);
3436         char *str=NULL;
3437
3438 #ifdef DEBUGGING
3439         regnode *optimize = NULL;
3440 #ifdef RE_TRACK_PATTERN_OFFSETS
3441
3442         U32 mjd_offset = 0;
3443         U32 mjd_nodelen = 0;
3444 #endif /* RE_TRACK_PATTERN_OFFSETS */
3445 #endif /* DEBUGGING */
3446         /*
3447            This means we convert either the first branch or the first Exact,
3448            depending on whether the thing following (in 'last') is a branch
3449            or not and whther first is the startbranch (ie is it a sub part of
3450            the alternation or is it the whole thing.)
3451            Assuming its a sub part we convert the EXACT otherwise we convert
3452            the whole branch sequence, including the first.
3453          */
3454         /* Find the node we are going to overwrite */
3455         if ( first != startbranch || OP( last ) == BRANCH ) {
3456             /* branch sub-chain */
3457             NEXT_OFF( first ) = (U16)(last - first);
3458 #ifdef RE_TRACK_PATTERN_OFFSETS
3459             DEBUG_r({
3460                 mjd_offset= Node_Offset((convert));
3461                 mjd_nodelen= Node_Length((convert));
3462             });
3463 #endif
3464             /* whole branch chain */
3465         }
3466 #ifdef RE_TRACK_PATTERN_OFFSETS
3467         else {
3468             DEBUG_r({
3469                 const  regnode *nop = NEXTOPER( convert );
3470                 mjd_offset= Node_Offset((nop));
3471                 mjd_nodelen= Node_Length((nop));
3472             });
3473         }
3474         DEBUG_OPTIMISE_r(
3475             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3476                 depth+1,
3477                 (UV)mjd_offset, (UV)mjd_nodelen)
3478         );
3479 #endif
3480         /* But first we check to see if there is a common prefix we can
3481            split out as an EXACT and put in front of the TRIE node.  */
3482         trie->startstate= 1;
3483         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3484             /* we want to find the first state that has more than
3485              * one transition, if that state is not the first state
3486              * then we have a common prefix which we can remove.
3487              */
3488             U32 state;
3489             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3490                 U32 ofs = 0;
3491                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3492                                        transition, -1 means none */
3493                 U32 count = 0;
3494                 const U32 base = trie->states[ state ].trans.base;
3495
3496                 /* does this state terminate an alternation? */
3497                 if ( trie->states[state].wordnum )
3498                         count = 1;
3499
3500                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3501                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3502                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3503                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3504                     {
3505                         if ( ++count > 1 ) {
3506                             /* we have more than one transition */
3507                             SV **tmp;
3508                             U8 *ch;
3509                             /* if this is the first state there is no common prefix
3510                              * to extract, so we can exit */
3511                             if ( state == 1 ) break;
3512                             tmp = av_fetch( revcharmap, ofs, 0);
3513                             ch = (U8*)SvPV_nolen_const( *tmp );
3514
3515                             /* if we are on count 2 then we need to initialize the
3516                              * bitmap, and store the previous char if there was one
3517                              * in it*/
3518                             if ( count == 2 ) {
3519                                 /* clear the bitmap */
3520                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3521                                 DEBUG_OPTIMISE_r(
3522                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3523                                         depth+1,
3524                                         (UV)state));
3525                                 if (first_ofs >= 0) {
3526                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3527                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3528
3529                                     TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3530                                     DEBUG_OPTIMISE_r(
3531                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3532                                     );
3533                                 }
3534                             }
3535                             /* store the current firstchar in the bitmap */
3536                             TRIE_BITMAP_SET_FOLDED(trie,*ch, folder);
3537                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3538                         }
3539                         first_ofs = ofs;
3540                     }
3541                 }
3542                 if ( count == 1 ) {
3543                     /* This state has only one transition, its transition is part
3544                      * of a common prefix - we need to concatenate the char it
3545                      * represents to what we have so far. */
3546                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3547                     STRLEN len;
3548                     char *ch = SvPV( *tmp, len );
3549                     DEBUG_OPTIMISE_r({
3550                         SV *sv=sv_newmortal();
3551                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3552                             depth+1,
3553                             (UV)state, (UV)first_ofs,
3554                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3555                                 PL_colors[0], PL_colors[1],
3556                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3557                                 PERL_PV_ESCAPE_FIRSTCHAR
3558                             )
3559                         );
3560                     });
3561                     if ( state==1 ) {
3562                         OP( convert ) = nodetype;
3563                         str=STRING(convert);
3564                         setSTR_LEN(convert, 0);
3565                     }
3566                     setSTR_LEN(convert, STR_LEN(convert) + len);
3567                     while (len--)
3568                         *str++ = *ch++;
3569                 } else {
3570 #ifdef DEBUGGING
3571                     if (state>1)
3572                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3573 #endif
3574                     break;
3575                 }
3576             }
3577             trie->prefixlen = (state-1);
3578             if (str) {
3579                 regnode *n = convert+NODE_SZ_STR(convert);
3580                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3581                 trie->startstate = state;
3582                 trie->minlen -= (state - 1);
3583                 trie->maxlen -= (state - 1);
3584 #ifdef DEBUGGING
3585                /* At least the UNICOS C compiler choked on this
3586                 * being argument to DEBUG_r(), so let's just have
3587                 * it right here. */
3588                if (
3589 #ifdef PERL_EXT_RE_BUILD
3590                    1
3591 #else
3592                    DEBUG_r_TEST
3593 #endif
3594                    ) {
3595                    regnode *fix = convert;
3596                    U32 word = trie->wordcount;
3597 #ifdef RE_TRACK_PATTERN_OFFSETS
3598                    mjd_nodelen++;
3599 #endif
3600                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3601                    while( ++fix < n ) {
3602                        Set_Node_Offset_Length(fix, 0, 0);
3603                    }
3604                    while (word--) {
3605                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3606                        if (tmp) {
3607                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3608                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3609                            else
3610                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3611                        }
3612                    }
3613                }
3614 #endif
3615                 if (trie->maxlen) {
3616                     convert = n;
3617                 } else {
3618                     NEXT_OFF(convert) = (U16)(tail - convert);
3619                     DEBUG_r(optimize= n);
3620                 }
3621             }
3622         }
3623         if (!jumper)
3624             jumper = last;
3625         if ( trie->maxlen ) {
3626             NEXT_OFF( convert ) = (U16)(tail - convert);
3627             ARG_SET( convert, data_slot );
3628             /* Store the offset to the first unabsorbed branch in
3629                jump[0], which is otherwise unused by the jump logic.
3630                We use this when dumping a trie and during optimisation. */
3631             if (trie->jump)
3632                 trie->jump[0] = (U16)(nextbranch - convert);
3633
3634             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3635              *   and there is a bitmap
3636              *   and the first "jump target" node we found leaves enough room
3637              * then convert the TRIE node into a TRIEC node, with the bitmap
3638              * embedded inline in the opcode - this is hypothetically faster.
3639              */
3640             if ( !trie->states[trie->startstate].wordnum
3641                  && trie->bitmap
3642                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3643             {
3644                 OP( convert ) = TRIEC;
3645                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3646                 PerlMemShared_free(trie->bitmap);
3647                 trie->bitmap= NULL;
3648             } else
3649                 OP( convert ) = TRIE;
3650
3651             /* store the type in the flags */
3652             convert->flags = nodetype;
3653             DEBUG_r({
3654             optimize = convert
3655                       + NODE_STEP_REGNODE
3656                       + regarglen[ OP( convert ) ];
3657             });
3658             /* XXX We really should free up the resource in trie now,
3659                    as we won't use them - (which resources?) dmq */
3660         }
3661         /* needed for dumping*/
3662         DEBUG_r(if (optimize) {
3663             regnode *opt = convert;
3664
3665             while ( ++opt < optimize) {
3666                 Set_Node_Offset_Length(opt, 0, 0);
3667             }
3668             /*
3669                 Try to clean up some of the debris left after the
3670                 optimisation.
3671              */
3672             while( optimize < jumper ) {
3673                 Track_Code( mjd_nodelen += Node_Length((optimize)); );
3674                 OP( optimize ) = OPTIMIZED;
3675                 Set_Node_Offset_Length(optimize, 0, 0);
3676                 optimize++;
3677             }
3678             Set_Node_Offset_Length(convert, mjd_offset, mjd_nodelen);
3679         });
3680     } /* end node insert */
3681
3682     /*  Finish populating the prev field of the wordinfo array.  Walk back
3683      *  from each accept state until we find another accept state, and if
3684      *  so, point the first word's .prev field at the second word. If the
3685      *  second already has a .prev field set, stop now. This will be the
3686      *  case either if we've already processed that word's accept state,
3687      *  or that state had multiple words, and the overspill words were
3688      *  already linked up earlier.
3689      */
3690     {
3691         U16 word;
3692         U32 state;
3693         U16 prev;
3694
3695         for (word=1; word <= trie->wordcount; word++) {
3696             prev = 0;
3697             if (trie->wordinfo[word].prev)
3698                 continue;
3699             state = trie->wordinfo[word].accept;
3700             while (state) {
3701                 state = prev_states[state];
3702                 if (!state)
3703                     break;
3704                 prev = trie->states[state].wordnum;
3705                 if (prev)
3706                     break;
3707             }
3708             trie->wordinfo[word].prev = prev;
3709         }
3710         Safefree(prev_states);
3711     }
3712
3713
3714     /* and now dump out the compressed format */
3715     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3716
3717     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3718 #ifdef DEBUGGING
3719     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3720     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3721 #else
3722     SvREFCNT_dec_NN(revcharmap);
3723 #endif
3724     return trie->jump
3725            ? MADE_JUMP_TRIE
3726            : trie->startstate>1
3727              ? MADE_EXACT_TRIE
3728              : MADE_TRIE;
3729 }
3730
3731 STATIC regnode *
3732 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3733 {
3734 /* The Trie is constructed and compressed now so we can build a fail array if
3735  * it's needed
3736
3737    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3738    3.32 in the
3739    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3740    Ullman 1985/88
3741    ISBN 0-201-10088-6
3742
3743    We find the fail state for each state in the trie, this state is the longest
3744    proper suffix of the current state's 'word' that is also a proper prefix of
3745    another word in our trie. State 1 represents the word '' and is thus the
3746    default fail state. This allows the DFA not to have to restart after its
3747    tried and failed a word at a given point, it simply continues as though it
3748    had been matching the other word in the first place.
3749    Consider
3750       'abcdgu'=~/abcdefg|cdgu/
3751    When we get to 'd' we are still matching the first word, we would encounter
3752    'g' which would fail, which would bring us to the state representing 'd' in
3753    the second word where we would try 'g' and succeed, proceeding to match
3754    'cdgu'.
3755  */
3756  /* add a fail transition */
3757     const U32 trie_offset = ARG(source);
3758     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3759     U32 *q;
3760     const U32 ucharcount = trie->uniquecharcount;
3761     const U32 numstates = trie->statecount;
3762     const U32 ubound = trie->lasttrans + ucharcount;
3763     U32 q_read = 0;
3764     U32 q_write = 0;
3765     U32 charid;
3766     U32 base = trie->states[ 1 ].trans.base;
3767     U32 *fail;
3768     reg_ac_data *aho;
3769     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3770     regnode *stclass;
3771     GET_RE_DEBUG_FLAGS_DECL;
3772
3773     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3774     PERL_UNUSED_CONTEXT;
3775 #ifndef DEBUGGING
3776     PERL_UNUSED_ARG(depth);
3777 #endif
3778
3779     if ( OP(source) == TRIE ) {
3780         struct regnode_1 *op = (struct regnode_1 *)
3781             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3782         StructCopy(source, op, struct regnode_1);
3783         stclass = (regnode *)op;
3784     } else {
3785         struct regnode_charclass *op = (struct regnode_charclass *)
3786             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3787         StructCopy(source, op, struct regnode_charclass);
3788         stclass = (regnode *)op;
3789     }
3790     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3791
3792     ARG_SET( stclass, data_slot );
3793     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3794     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3795     aho->trie=trie_offset;
3796     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3797     Copy( trie->states, aho->states, numstates, reg_trie_state );
3798     Newx( q, numstates, U32);
3799     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3800     aho->refcount = 1;
3801     fail = aho->fail;
3802     /* initialize fail[0..1] to be 1 so that we always have
3803        a valid final fail state */
3804     fail[ 0 ] = fail[ 1 ] = 1;
3805
3806     for ( charid = 0; charid < ucharcount ; charid++ ) {
3807         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3808         if ( newstate ) {
3809             q[ q_write ] = newstate;
3810             /* set to point at the root */
3811             fail[ q[ q_write++ ] ]=1;
3812         }
3813     }
3814     while ( q_read < q_write) {
3815         const U32 cur = q[ q_read++ % numstates ];
3816         base = trie->states[ cur ].trans.base;
3817
3818         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3819             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3820             if (ch_state) {
3821                 U32 fail_state = cur;
3822                 U32 fail_base;
3823                 do {
3824                     fail_state = fail[ fail_state ];
3825                     fail_base = aho->states[ fail_state ].trans.base;
3826                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3827
3828                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3829                 fail[ ch_state ] = fail_state;
3830                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3831                 {
3832                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3833                 }
3834                 q[ q_write++ % numstates] = ch_state;
3835             }
3836         }
3837     }
3838     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3839        when we fail in state 1, this allows us to use the
3840        charclass scan to find a valid start char. This is based on the principle
3841        that theres a good chance the string being searched contains lots of stuff
3842        that cant be a start char.
3843      */
3844     fail[ 0 ] = fail[ 1 ] = 0;
3845     DEBUG_TRIE_COMPILE_r({
3846         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3847                       depth, (UV)numstates
3848         );
3849         for( q_read=1; q_read<numstates; q_read++ ) {
3850             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3851         }
3852         Perl_re_printf( aTHX_  "\n");
3853     });
3854     Safefree(q);
3855     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3856     return stclass;
3857 }
3858
3859
3860 /* The below joins as many adjacent EXACTish nodes as possible into a single
3861  * one.  The regop may be changed if the node(s) contain certain sequences that
3862  * require special handling.  The joining is only done if:
3863  * 1) there is room in the current conglomerated node to entirely contain the
3864  *    next one.
3865  * 2) they are compatible node types
3866  *
3867  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3868  * these get optimized out
3869  *
3870  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3871  * as possible, even if that means splitting an existing node so that its first
3872  * part is moved to the preceeding node.  This would maximise the efficiency of
3873  * memEQ during matching.
3874  *
3875  * If a node is to match under /i (folded), the number of characters it matches
3876  * can be different than its character length if it contains a multi-character
3877  * fold.  *min_subtract is set to the total delta number of characters of the
3878  * input nodes.
3879  *
3880  * And *unfolded_multi_char is set to indicate whether or not the node contains
3881  * an unfolded multi-char fold.  This happens when it won't be known until
3882  * runtime whether the fold is valid or not; namely
3883  *  1) for EXACTF nodes that contain LATIN SMALL LETTER SHARP S, as only if the
3884  *      target string being matched against turns out to be UTF-8 is that fold
3885  *      valid; or
3886  *  2) for EXACTFL nodes whose folding rules depend on the locale in force at
3887  *      runtime.
3888  * (Multi-char folds whose components are all above the Latin1 range are not
3889  * run-time locale dependent, and have already been folded by the time this
3890  * function is called.)
3891  *
3892  * This is as good a place as any to discuss the design of handling these
3893  * multi-character fold sequences.  It's been wrong in Perl for a very long
3894  * time.  There are three code points in Unicode whose multi-character folds
3895  * were long ago discovered to mess things up.  The previous designs for
3896  * dealing with these involved assigning a special node for them.  This
3897  * approach doesn't always work, as evidenced by this example:
3898  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3899  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3900  * would match just the \xDF, it won't be able to handle the case where a
3901  * successful match would have to cross the node's boundary.  The new approach
3902  * that hopefully generally solves the problem generates an EXACTFUP node
3903  * that is "sss" in this case.
3904  *
3905  * It turns out that there are problems with all multi-character folds, and not
3906  * just these three.  Now the code is general, for all such cases.  The
3907  * approach taken is:
3908  * 1)   This routine examines each EXACTFish node that could contain multi-
3909  *      character folded sequences.  Since a single character can fold into
3910  *      such a sequence, the minimum match length for this node is less than
3911  *      the number of characters in the node.  This routine returns in
3912  *      *min_subtract how many characters to subtract from the the actual
3913  *      length of the string to get a real minimum match length; it is 0 if
3914  *      there are no multi-char foldeds.  This delta is used by the caller to
3915  *      adjust the min length of the match, and the delta between min and max,
3916  *      so that the optimizer doesn't reject these possibilities based on size
3917  *      constraints.
3918  *
3919  * 2)   For the sequence involving the LATIN SMALL LETTER SHARP S (U+00DF)
3920  *      under /u, we fold it to 'ss' in regatom(), and in this routine, after
3921  *      joining, we scan for occurrences of the sequence 'ss' in non-UTF-8
3922  *      EXACTFU nodes.  The node type of such nodes is then changed to
3923  *      EXACTFUP, indicating it is problematic, and needs careful handling.
3924  *      (The procedures in step 1) above are sufficient to handle this case in
3925  *      UTF-8 encoded nodes.)  The reason this is problematic is that this is
3926  *      the only case where there is a possible fold length change in non-UTF-8
3927  *      patterns.  By reserving a special node type for problematic cases, the
3928  *      far more common regular EXACTFU nodes can be processed faster.
3929  *      regexec.c takes advantage of this.
3930  *
3931  *      EXACTFUP has been created as a grab-bag for (hopefully uncommon)
3932  *      problematic cases.   These all only occur when the pattern is not
3933  *      UTF-8.  In addition to the 'ss' sequence where there is a possible fold
3934  *      length change, it handles the situation where the string cannot be
3935  *      entirely folded.  The strings in an EXACTFish node are folded as much
3936  *      as possible during compilation in regcomp.c.  This saves effort in
3937  *      regex matching.  By using an EXACTFUP node when it is not possible to
3938  *      fully fold at compile time, regexec.c can know that everything in an
3939  *      EXACTFU node is folded, so folding can be skipped at runtime.  The only
3940  *      case where folding in EXACTFU nodes can't be done at compile time is
3941  *      the presumably uncommon MICRO SIGN, when the pattern isn't UTF-8.  This
3942  *      is because its fold requires UTF-8 to represent.  Thus EXACTFUP nodes
3943  *      handle two very different cases.  Alternatively, there could have been
3944  *      a node type where there are length changes, one for unfolded, and one
3945  *      for both.  If yet another special case needed to be created, the number
3946  *      of required node types would have to go to 7.  khw figures that even
3947  *      though there are plenty of node types to spare, that the maintenance
3948  *      cost wasn't worth the small speedup of doing it that way, especially
3949  *      since he thinks the MICRO SIGN is rarely encountered in practice.
3950  *
3951  *      There are other cases where folding isn't done at compile time, but
3952  *      none of them are under /u, and hence not for EXACTFU nodes.  The folds
3953  *      in EXACTFL nodes aren't known until runtime, and vary as the locale
3954  *      changes.  Some folds in EXACTF depend on if the runtime target string
3955  *      is UTF-8 or not.  (regatom() will create an EXACTFU node even under /di
3956  *      when no fold in it depends on the UTF-8ness of the target string.)
3957  *
3958  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3959  *      validity of the fold won't be known until runtime, and so must remain
3960  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFAA
3961  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3962  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3963  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3964  *      The reason this is a problem is that the optimizer part of regexec.c
3965  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3966  *      that a character in the pattern corresponds to at most a single
3967  *      character in the target string.  (And I do mean character, and not byte
3968  *      here, unlike other parts of the documentation that have never been
3969  *      updated to account for multibyte Unicode.)  Sharp s in EXACTF and
3970  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFAA
3971  *      nodes it can match "\x{17F}\x{17F}".  These, along with other ones in
3972  *      EXACTFL nodes, violate the assumption, and they are the only instances
3973  *      where it is violated.  I'm reluctant to try to change the assumption,
3974  *      as the code involved is impenetrable to me (khw), so instead the code
3975  *      here punts.  This routine examines EXACTFL nodes, and (when the pattern
3976  *      isn't UTF-8) EXACTF and EXACTFAA for such unfolded folds, and returns a
3977  *      boolean indicating whether or not the node contains such a fold.  When
3978  *      it is true, the caller sets a flag that later causes the optimizer in
3979  *      this file to not set values for the floating and fixed string lengths,
3980  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3981  *      assumption.  Thus, there is no optimization based on string lengths for
3982  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3983  *      EXACTF and EXACTFAA nodes that contain the sharp s.  (The reason the
3984  *      assumption is wrong only in these cases is that all other non-UTF-8
3985  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3986  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3987  *      EXACTF nodes because we don't know at compile time if it ac