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