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