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