This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
update size after Renew
[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 ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
822     __ASSERT_(PASS2) Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP),        \
823                                           m REPORT_LOCATION,            \
824                                           a1, a2, a3,                   \
825                                           REPORT_LOCATION_ARGS(loc));   \
826 } STMT_END
827
828 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
829     __ASSERT_(PASS2) Perl_warner(aTHX_ packWARN(WARN_REGEXP),           \
830                                        m REPORT_LOCATION,               \
831                                        a1, a2, a3, a4,                  \
832                                        REPORT_LOCATION_ARGS(loc));      \
833 } STMT_END
834
835 /* Macros for recording node offsets.   20001227 mjd@plover.com
836  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
837  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
838  * Element 0 holds the number n.
839  * Position is 1 indexed.
840  */
841 #ifndef RE_TRACK_PATTERN_OFFSETS
842 #define Set_Node_Offset_To_R(node,byte)
843 #define Set_Node_Offset(node,byte)
844 #define Set_Cur_Node_Offset
845 #define Set_Node_Length_To_R(node,len)
846 #define Set_Node_Length(node,len)
847 #define Set_Node_Cur_Length(node,start)
848 #define Node_Offset(n)
849 #define Node_Length(n)
850 #define Set_Node_Offset_Length(node,offset,len)
851 #define ProgLen(ri) ri->u.proglen
852 #define SetProgLen(ri,x) ri->u.proglen = x
853 #else
854 #define ProgLen(ri) ri->u.offsets[0]
855 #define SetProgLen(ri,x) ri->u.offsets[0] = x
856 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
857     if (! SIZE_ONLY) {                                                  \
858         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
859                     __LINE__, (int)(node), (int)(byte)));               \
860         if((node) < 0) {                                                \
861             Perl_croak(aTHX_ "value of node is %d in Offset macro",     \
862                                          (int)(node));                  \
863         } else {                                                        \
864             RExC_offsets[2*(node)-1] = (byte);                          \
865         }                                                               \
866     }                                                                   \
867 } STMT_END
868
869 #define Set_Node_Offset(node,byte) \
870     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
871 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
872
873 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
874     if (! SIZE_ONLY) {                                                  \
875         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
876                 __LINE__, (int)(node), (int)(len)));                    \
877         if((node) < 0) {                                                \
878             Perl_croak(aTHX_ "value of node is %d in Length macro",     \
879                                          (int)(node));                  \
880         } else {                                                        \
881             RExC_offsets[2*(node)] = (len);                             \
882         }                                                               \
883     }                                                                   \
884 } STMT_END
885
886 #define Set_Node_Length(node,len) \
887     Set_Node_Length_To_R((node)-RExC_emit_start, len)
888 #define Set_Node_Cur_Length(node, start)                \
889     Set_Node_Length(node, RExC_parse - start)
890
891 /* Get offsets and lengths */
892 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
893 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
894
895 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
896     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
897     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
898 } STMT_END
899 #endif
900
901 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
902 #define EXPERIMENTAL_INPLACESCAN
903 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
904
905 #ifdef DEBUGGING
906 int
907 Perl_re_printf(pTHX_ const char *fmt, ...)
908 {
909     va_list ap;
910     int result;
911     PerlIO *f= Perl_debug_log;
912     PERL_ARGS_ASSERT_RE_PRINTF;
913     va_start(ap, fmt);
914     result = PerlIO_vprintf(f, fmt, ap);
915     va_end(ap);
916     return result;
917 }
918
919 int
920 Perl_re_indentf(pTHX_ const char *fmt, U32 depth, ...)
921 {
922     va_list ap;
923     int result;
924     PerlIO *f= Perl_debug_log;
925     PERL_ARGS_ASSERT_RE_INDENTF;
926     va_start(ap, depth);
927     PerlIO_printf(f, "%*s", ( (int)depth % 20 ) * 2, "");
928     result = PerlIO_vprintf(f, fmt, ap);
929     va_end(ap);
930     return result;
931 }
932 #endif /* DEBUGGING */
933
934 #define DEBUG_RExC_seen()                                                   \
935         DEBUG_OPTIMISE_MORE_r({                                             \
936             Perl_re_printf( aTHX_ "RExC_seen: ");                                       \
937                                                                             \
938             if (RExC_seen & REG_ZERO_LEN_SEEN)                              \
939                 Perl_re_printf( aTHX_ "REG_ZERO_LEN_SEEN ");                            \
940                                                                             \
941             if (RExC_seen & REG_LOOKBEHIND_SEEN)                            \
942                 Perl_re_printf( aTHX_ "REG_LOOKBEHIND_SEEN ");                          \
943                                                                             \
944             if (RExC_seen & REG_GPOS_SEEN)                                  \
945                 Perl_re_printf( aTHX_ "REG_GPOS_SEEN ");                                \
946                                                                             \
947             if (RExC_seen & REG_RECURSE_SEEN)                               \
948                 Perl_re_printf( aTHX_ "REG_RECURSE_SEEN ");                             \
949                                                                             \
950             if (RExC_seen & REG_TOP_LEVEL_BRANCHES_SEEN)                    \
951                 Perl_re_printf( aTHX_ "REG_TOP_LEVEL_BRANCHES_SEEN ");                  \
952                                                                             \
953             if (RExC_seen & REG_VERBARG_SEEN)                               \
954                 Perl_re_printf( aTHX_ "REG_VERBARG_SEEN ");                             \
955                                                                             \
956             if (RExC_seen & REG_CUTGROUP_SEEN)                              \
957                 Perl_re_printf( aTHX_ "REG_CUTGROUP_SEEN ");                            \
958                                                                             \
959             if (RExC_seen & REG_RUN_ON_COMMENT_SEEN)                        \
960                 Perl_re_printf( aTHX_ "REG_RUN_ON_COMMENT_SEEN ");                      \
961                                                                             \
962             if (RExC_seen & REG_UNFOLDED_MULTI_SEEN)                        \
963                 Perl_re_printf( aTHX_ "REG_UNFOLDED_MULTI_SEEN ");                      \
964                                                                             \
965             if (RExC_seen & REG_UNBOUNDED_QUANTIFIER_SEEN)                  \
966                 Perl_re_printf( aTHX_ "REG_UNBOUNDED_QUANTIFIER_SEEN ");                \
967                                                                             \
968             Perl_re_printf( aTHX_ "\n");                                                \
969         });
970
971 #define DEBUG_SHOW_STUDY_FLAG(flags,flag) \
972   if ((flags) & flag) Perl_re_printf( aTHX_  "%s ", #flag)
973
974 #define DEBUG_SHOW_STUDY_FLAGS(flags,open_str,close_str)                    \
975     if ( ( flags ) ) {                                                      \
976         Perl_re_printf( aTHX_  "%s", open_str);                                         \
977         DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_SEOL);                     \
978         DEBUG_SHOW_STUDY_FLAG(flags,SF_FL_BEFORE_MEOL);                     \
979         DEBUG_SHOW_STUDY_FLAG(flags,SF_IS_INF);                             \
980         DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_PAR);                            \
981         DEBUG_SHOW_STUDY_FLAG(flags,SF_IN_PAR);                             \
982         DEBUG_SHOW_STUDY_FLAG(flags,SF_HAS_EVAL);                           \
983         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_SUBSTR);                         \
984         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_AND);                    \
985         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS_OR);                     \
986         DEBUG_SHOW_STUDY_FLAG(flags,SCF_DO_STCLASS);                        \
987         DEBUG_SHOW_STUDY_FLAG(flags,SCF_WHILEM_VISITED_POS);                \
988         DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_RESTUDY);                      \
989         DEBUG_SHOW_STUDY_FLAG(flags,SCF_SEEN_ACCEPT);                       \
990         DEBUG_SHOW_STUDY_FLAG(flags,SCF_TRIE_DOING_RESTUDY);                \
991         DEBUG_SHOW_STUDY_FLAG(flags,SCF_IN_DEFINE);                         \
992         Perl_re_printf( aTHX_  "%s", close_str);                                        \
993     }
994
995
996 #define DEBUG_STUDYDATA(str,data,depth)                              \
997 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
998     Perl_re_indentf( aTHX_  "" str "Pos:%" IVdf "/%" IVdf            \
999         " Flags: 0x%" UVXf,                                          \
1000         depth,                                                       \
1001         (IV)((data)->pos_min),                                       \
1002         (IV)((data)->pos_delta),                                     \
1003         (UV)((data)->flags)                                          \
1004     );                                                               \
1005     DEBUG_SHOW_STUDY_FLAGS((data)->flags," [ ","]");                 \
1006     Perl_re_printf( aTHX_                                            \
1007         " Whilem_c: %" IVdf " Lcp: %" IVdf " %s",                    \
1008         (IV)((data)->whilem_c),                                      \
1009         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
1010         is_inf ? "INF " : ""                                         \
1011     );                                                               \
1012     if ((data)->last_found)                                          \
1013         Perl_re_printf( aTHX_                                        \
1014             "Last:'%s' %" IVdf ":%" IVdf "/%" IVdf                   \
1015             " %sFixed:'%s' @ %" IVdf                                 \
1016             " %sFloat: '%s' @ %" IVdf "/%" IVdf,                     \
1017             SvPVX_const((data)->last_found),                         \
1018             (IV)((data)->last_end),                                  \
1019             (IV)((data)->last_start_min),                            \
1020             (IV)((data)->last_start_max),                            \
1021             ((data)->longest &&                                      \
1022              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
1023             SvPVX_const((data)->longest_fixed),                      \
1024             (IV)((data)->offset_fixed),                              \
1025             ((data)->longest &&                                      \
1026              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
1027             SvPVX_const((data)->longest_float),                      \
1028             (IV)((data)->offset_float_min),                          \
1029             (IV)((data)->offset_float_max)                           \
1030         );                                                           \
1031     Perl_re_printf( aTHX_ "\n");                                                 \
1032 });
1033
1034
1035 /* =========================================================
1036  * BEGIN edit_distance stuff.
1037  *
1038  * This calculates how many single character changes of any type are needed to
1039  * transform a string into another one.  It is taken from version 3.1 of
1040  *
1041  * https://metacpan.org/pod/Text::Levenshtein::Damerau::XS
1042  */
1043
1044 /* Our unsorted dictionary linked list.   */
1045 /* Note we use UVs, not chars. */
1046
1047 struct dictionary{
1048   UV key;
1049   UV value;
1050   struct dictionary* next;
1051 };
1052 typedef struct dictionary item;
1053
1054
1055 PERL_STATIC_INLINE item*
1056 push(UV key,item* curr)
1057 {
1058     item* head;
1059     Newxz(head, 1, item);
1060     head->key = key;
1061     head->value = 0;
1062     head->next = curr;
1063     return head;
1064 }
1065
1066
1067 PERL_STATIC_INLINE item*
1068 find(item* head, UV key)
1069 {
1070     item* iterator = head;
1071     while (iterator){
1072         if (iterator->key == key){
1073             return iterator;
1074         }
1075         iterator = iterator->next;
1076     }
1077
1078     return NULL;
1079 }
1080
1081 PERL_STATIC_INLINE item*
1082 uniquePush(item* head,UV key)
1083 {
1084     item* iterator = head;
1085
1086     while (iterator){
1087         if (iterator->key == key) {
1088             return head;
1089         }
1090         iterator = iterator->next;
1091     }
1092
1093     return push(key,head);
1094 }
1095
1096 PERL_STATIC_INLINE void
1097 dict_free(item* head)
1098 {
1099     item* iterator = head;
1100
1101     while (iterator) {
1102         item* temp = iterator;
1103         iterator = iterator->next;
1104         Safefree(temp);
1105     }
1106
1107     head = NULL;
1108 }
1109
1110 /* End of Dictionary Stuff */
1111
1112 /* All calculations/work are done here */
1113 STATIC int
1114 S_edit_distance(const UV* src,
1115                 const UV* tgt,
1116                 const STRLEN x,             /* length of src[] */
1117                 const STRLEN y,             /* length of tgt[] */
1118                 const SSize_t maxDistance
1119 )
1120 {
1121     item *head = NULL;
1122     UV swapCount,swapScore,targetCharCount,i,j;
1123     UV *scores;
1124     UV score_ceil = x + y;
1125
1126     PERL_ARGS_ASSERT_EDIT_DISTANCE;
1127
1128     /* intialize matrix start values */
1129     Newxz(scores, ( (x + 2) * (y + 2)), UV);
1130     scores[0] = score_ceil;
1131     scores[1 * (y + 2) + 0] = score_ceil;
1132     scores[0 * (y + 2) + 1] = score_ceil;
1133     scores[1 * (y + 2) + 1] = 0;
1134     head = uniquePush(uniquePush(head,src[0]),tgt[0]);
1135
1136     /* work loops    */
1137     /* i = src index */
1138     /* j = tgt index */
1139     for (i=1;i<=x;i++) {
1140         if (i < x)
1141             head = uniquePush(head,src[i]);
1142         scores[(i+1) * (y + 2) + 1] = i;
1143         scores[(i+1) * (y + 2) + 0] = score_ceil;
1144         swapCount = 0;
1145
1146         for (j=1;j<=y;j++) {
1147             if (i == 1) {
1148                 if(j < y)
1149                 head = uniquePush(head,tgt[j]);
1150                 scores[1 * (y + 2) + (j + 1)] = j;
1151                 scores[0 * (y + 2) + (j + 1)] = score_ceil;
1152             }
1153
1154             targetCharCount = find(head,tgt[j-1])->value;
1155             swapScore = scores[targetCharCount * (y + 2) + swapCount] + i - targetCharCount - 1 + j - swapCount;
1156
1157             if (src[i-1] != tgt[j-1]){
1158                 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));
1159             }
1160             else {
1161                 swapCount = j;
1162                 scores[(i+1) * (y + 2) + (j + 1)] = MIN(scores[i * (y + 2) + j], swapScore);
1163             }
1164         }
1165
1166         find(head,src[i-1])->value = i;
1167     }
1168
1169     {
1170         IV score = scores[(x+1) * (y + 2) + (y + 1)];
1171         dict_free(head);
1172         Safefree(scores);
1173         return (maxDistance != 0 && maxDistance < score)?(-1):score;
1174     }
1175 }
1176
1177 /* END of edit_distance() stuff
1178  * ========================================================= */
1179
1180 /* is c a control character for which we have a mnemonic? */
1181 #define isMNEMONIC_CNTRL(c) _IS_MNEMONIC_CNTRL_ONLY_FOR_USE_BY_REGCOMP_DOT_C(c)
1182
1183 STATIC const char *
1184 S_cntrl_to_mnemonic(const U8 c)
1185 {
1186     /* Returns the mnemonic string that represents character 'c', if one
1187      * exists; NULL otherwise.  The only ones that exist for the purposes of
1188      * this routine are a few control characters */
1189
1190     switch (c) {
1191         case '\a':       return "\\a";
1192         case '\b':       return "\\b";
1193         case ESC_NATIVE: return "\\e";
1194         case '\f':       return "\\f";
1195         case '\n':       return "\\n";
1196         case '\r':       return "\\r";
1197         case '\t':       return "\\t";
1198     }
1199
1200     return NULL;
1201 }
1202
1203 /* Mark that we cannot extend a found fixed substring at this point.
1204    Update the longest found anchored substring and the longest found
1205    floating substrings if needed. */
1206
1207 STATIC void
1208 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data,
1209                     SSize_t *minlenp, int is_inf)
1210 {
1211     const STRLEN l = CHR_SVLEN(data->last_found);
1212     const STRLEN old_l = CHR_SVLEN(*data->longest);
1213     GET_RE_DEBUG_FLAGS_DECL;
1214
1215     PERL_ARGS_ASSERT_SCAN_COMMIT;
1216
1217     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
1218         SvSetMagicSV(*data->longest, data->last_found);
1219         if (*data->longest == data->longest_fixed) {
1220             data->offset_fixed = l ? data->last_start_min : data->pos_min;
1221             if (data->flags & SF_BEFORE_EOL)
1222                 data->flags
1223                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
1224             else
1225                 data->flags &= ~SF_FIX_BEFORE_EOL;
1226             data->minlen_fixed=minlenp;
1227             data->lookbehind_fixed=0;
1228         }
1229         else { /* *data->longest == data->longest_float */
1230             data->offset_float_min = l ? data->last_start_min : data->pos_min;
1231             data->offset_float_max = (l
1232                           ? data->last_start_max
1233                           : (data->pos_delta > SSize_t_MAX - data->pos_min
1234                                          ? SSize_t_MAX
1235                                          : data->pos_min + data->pos_delta));
1236             if (is_inf
1237                  || (STRLEN)data->offset_float_max > (STRLEN)SSize_t_MAX)
1238                 data->offset_float_max = SSize_t_MAX;
1239             if (data->flags & SF_BEFORE_EOL)
1240                 data->flags
1241                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
1242             else
1243                 data->flags &= ~SF_FL_BEFORE_EOL;
1244             data->minlen_float=minlenp;
1245             data->lookbehind_float=0;
1246         }
1247     }
1248     SvCUR_set(data->last_found, 0);
1249     {
1250         SV * const sv = data->last_found;
1251         if (SvUTF8(sv) && SvMAGICAL(sv)) {
1252             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
1253             if (mg)
1254                 mg->mg_len = 0;
1255         }
1256     }
1257     data->last_end = -1;
1258     data->flags &= ~SF_BEFORE_EOL;
1259     DEBUG_STUDYDATA("commit: ",data,0);
1260 }
1261
1262 /* An SSC is just a regnode_charclass_posix with an extra field: the inversion
1263  * list that describes which code points it matches */
1264
1265 STATIC void
1266 S_ssc_anything(pTHX_ regnode_ssc *ssc)
1267 {
1268     /* Set the SSC 'ssc' to match an empty string or any code point */
1269
1270     PERL_ARGS_ASSERT_SSC_ANYTHING;
1271
1272     assert(is_ANYOF_SYNTHETIC(ssc));
1273
1274     /* mortalize so won't leak */
1275     ssc->invlist = sv_2mortal(_add_range_to_invlist(NULL, 0, UV_MAX));
1276     ANYOF_FLAGS(ssc) |= SSC_MATCHES_EMPTY_STRING;  /* Plus matches empty */
1277 }
1278
1279 STATIC int
1280 S_ssc_is_anything(const regnode_ssc *ssc)
1281 {
1282     /* Returns TRUE if the SSC 'ssc' can match the empty string and any code
1283      * point; FALSE otherwise.  Thus, this is used to see if using 'ssc' buys
1284      * us anything: if the function returns TRUE, 'ssc' hasn't been restricted
1285      * in any way, so there's no point in using it */
1286
1287     UV start, end;
1288     bool ret;
1289
1290     PERL_ARGS_ASSERT_SSC_IS_ANYTHING;
1291
1292     assert(is_ANYOF_SYNTHETIC(ssc));
1293
1294     if (! (ANYOF_FLAGS(ssc) & SSC_MATCHES_EMPTY_STRING)) {
1295         return FALSE;
1296     }
1297
1298     /* See if the list consists solely of the range 0 - Infinity */
1299     invlist_iterinit(ssc->invlist);
1300     ret = invlist_iternext(ssc->invlist, &start, &end)
1301           && start == 0
1302           && end == UV_MAX;
1303
1304     invlist_iterfinish(ssc->invlist);
1305
1306     if (ret) {
1307         return TRUE;
1308     }
1309
1310     /* If e.g., both \w and \W are set, matches everything */
1311     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1312         int i;
1313         for (i = 0; i < ANYOF_POSIXL_MAX; i += 2) {
1314             if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i+1)) {
1315                 return TRUE;
1316             }
1317         }
1318     }
1319
1320     return FALSE;
1321 }
1322
1323 STATIC void
1324 S_ssc_init(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc)
1325 {
1326     /* Initializes the SSC 'ssc'.  This includes setting it to match an empty
1327      * string, any code point, or any posix class under locale */
1328
1329     PERL_ARGS_ASSERT_SSC_INIT;
1330
1331     Zero(ssc, 1, regnode_ssc);
1332     set_ANYOF_SYNTHETIC(ssc);
1333     ARG_SET(ssc, ANYOF_ONLY_HAS_BITMAP);
1334     ssc_anything(ssc);
1335
1336     /* If any portion of the regex is to operate under locale rules that aren't
1337      * fully known at compile time, initialization includes it.  The reason
1338      * this isn't done for all regexes is that the optimizer was written under
1339      * the assumption that locale was all-or-nothing.  Given the complexity and
1340      * lack of documentation in the optimizer, and that there are inadequate
1341      * test cases for locale, many parts of it may not work properly, it is
1342      * safest to avoid locale unless necessary. */
1343     if (RExC_contains_locale) {
1344         ANYOF_POSIXL_SETALL(ssc);
1345     }
1346     else {
1347         ANYOF_POSIXL_ZERO(ssc);
1348     }
1349 }
1350
1351 STATIC int
1352 S_ssc_is_cp_posixl_init(const RExC_state_t *pRExC_state,
1353                         const regnode_ssc *ssc)
1354 {
1355     /* Returns TRUE if the SSC 'ssc' is in its initial state with regard only
1356      * to the list of code points matched, and locale posix classes; hence does
1357      * not check its flags) */
1358
1359     UV start, end;
1360     bool ret;
1361
1362     PERL_ARGS_ASSERT_SSC_IS_CP_POSIXL_INIT;
1363
1364     assert(is_ANYOF_SYNTHETIC(ssc));
1365
1366     invlist_iterinit(ssc->invlist);
1367     ret = invlist_iternext(ssc->invlist, &start, &end)
1368           && start == 0
1369           && end == UV_MAX;
1370
1371     invlist_iterfinish(ssc->invlist);
1372
1373     if (! ret) {
1374         return FALSE;
1375     }
1376
1377     if (RExC_contains_locale && ! ANYOF_POSIXL_SSC_TEST_ALL_SET(ssc)) {
1378         return FALSE;
1379     }
1380
1381     return TRUE;
1382 }
1383
1384 STATIC SV*
1385 S_get_ANYOF_cp_list_for_ssc(pTHX_ const RExC_state_t *pRExC_state,
1386                                const regnode_charclass* const node)
1387 {
1388     /* Returns a mortal inversion list defining which code points are matched
1389      * by 'node', which is of type ANYOF.  Handles complementing the result if
1390      * appropriate.  If some code points aren't knowable at this time, the
1391      * returned list must, and will, contain every code point that is a
1392      * possibility. */
1393
1394     SV* invlist = NULL;
1395     SV* only_utf8_locale_invlist = NULL;
1396     unsigned int i;
1397     const U32 n = ARG(node);
1398     bool new_node_has_latin1 = FALSE;
1399
1400     PERL_ARGS_ASSERT_GET_ANYOF_CP_LIST_FOR_SSC;
1401
1402     /* Look at the data structure created by S_set_ANYOF_arg() */
1403     if (n != ANYOF_ONLY_HAS_BITMAP) {
1404         SV * const rv = MUTABLE_SV(RExC_rxi->data->data[n]);
1405         AV * const av = MUTABLE_AV(SvRV(rv));
1406         SV **const ary = AvARRAY(av);
1407         assert(RExC_rxi->data->what[n] == 's');
1408
1409         if (ary[1] && ary[1] != &PL_sv_undef) { /* Has compile-time swash */
1410             invlist = sv_2mortal(invlist_clone(_get_swash_invlist(ary[1])));
1411         }
1412         else if (ary[0] && ary[0] != &PL_sv_undef) {
1413
1414             /* Here, no compile-time swash, and there are things that won't be
1415              * known until runtime -- we have to assume it could be anything */
1416             invlist = sv_2mortal(_new_invlist(1));
1417             return _add_range_to_invlist(invlist, 0, UV_MAX);
1418         }
1419         else if (ary[3] && ary[3] != &PL_sv_undef) {
1420
1421             /* Here no compile-time swash, and no run-time only data.  Use the
1422              * node's inversion list */
1423             invlist = sv_2mortal(invlist_clone(ary[3]));
1424         }
1425
1426         /* Get the code points valid only under UTF-8 locales */
1427         if ((ANYOF_FLAGS(node) & ANYOFL_FOLD)
1428             && ary[2] && ary[2] != &PL_sv_undef)
1429         {
1430             only_utf8_locale_invlist = ary[2];
1431         }
1432     }
1433
1434     if (! invlist) {
1435         invlist = sv_2mortal(_new_invlist(0));
1436     }
1437
1438     /* An ANYOF node contains a bitmap for the first NUM_ANYOF_CODE_POINTS
1439      * code points, and an inversion list for the others, but if there are code
1440      * points that should match only conditionally on the target string being
1441      * UTF-8, those are placed in the inversion list, and not the bitmap.
1442      * Since there are circumstances under which they could match, they are
1443      * included in the SSC.  But if the ANYOF node is to be inverted, we have
1444      * to exclude them here, so that when we invert below, the end result
1445      * actually does include them.  (Think about "\xe0" =~ /[^\xc0]/di;).  We
1446      * have to do this here before we add the unconditionally matched code
1447      * points */
1448     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1449         _invlist_intersection_complement_2nd(invlist,
1450                                              PL_UpperLatin1,
1451                                              &invlist);
1452     }
1453
1454     /* Add in the points from the bit map */
1455     for (i = 0; i < NUM_ANYOF_CODE_POINTS; i++) {
1456         if (ANYOF_BITMAP_TEST(node, i)) {
1457             unsigned int start = i++;
1458
1459             for (; i < NUM_ANYOF_CODE_POINTS && ANYOF_BITMAP_TEST(node, i); ++i) {
1460                 /* empty */
1461             }
1462             invlist = _add_range_to_invlist(invlist, start, i-1);
1463             new_node_has_latin1 = TRUE;
1464         }
1465     }
1466
1467     /* If this can match all upper Latin1 code points, have to add them
1468      * as well.  But don't add them if inverting, as when that gets done below,
1469      * it would exclude all these characters, including the ones it shouldn't
1470      * that were added just above */
1471     if (! (ANYOF_FLAGS(node) & ANYOF_INVERT) && OP(node) == ANYOFD
1472         && (ANYOF_FLAGS(node) & ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER))
1473     {
1474         _invlist_union(invlist, PL_UpperLatin1, &invlist);
1475     }
1476
1477     /* Similarly for these */
1478     if (ANYOF_FLAGS(node) & ANYOF_MATCHES_ALL_ABOVE_BITMAP) {
1479         _invlist_union_complement_2nd(invlist, PL_InBitmap, &invlist);
1480     }
1481
1482     if (ANYOF_FLAGS(node) & ANYOF_INVERT) {
1483         _invlist_invert(invlist);
1484     }
1485     else if (new_node_has_latin1 && ANYOF_FLAGS(node) & ANYOFL_FOLD) {
1486
1487         /* Under /li, any 0-255 could fold to any other 0-255, depending on the
1488          * locale.  We can skip this if there are no 0-255 at all. */
1489         _invlist_union(invlist, PL_Latin1, &invlist);
1490     }
1491
1492     /* Similarly add the UTF-8 locale possible matches.  These have to be
1493      * deferred until after the non-UTF-8 locale ones are taken care of just
1494      * above, or it leads to wrong results under ANYOF_INVERT */
1495     if (only_utf8_locale_invlist) {
1496         _invlist_union_maybe_complement_2nd(invlist,
1497                                             only_utf8_locale_invlist,
1498                                             ANYOF_FLAGS(node) & ANYOF_INVERT,
1499                                             &invlist);
1500     }
1501
1502     return invlist;
1503 }
1504
1505 /* These two functions currently do the exact same thing */
1506 #define ssc_init_zero           ssc_init
1507
1508 #define ssc_add_cp(ssc, cp)   ssc_add_range((ssc), (cp), (cp))
1509 #define ssc_match_all_cp(ssc) ssc_add_range(ssc, 0, UV_MAX)
1510
1511 /* 'AND' a given class with another one.  Can create false positives.  'ssc'
1512  * should not be inverted.  'and_with->flags & ANYOF_MATCHES_POSIXL' should be
1513  * 0 if 'and_with' is a regnode_charclass instead of a regnode_ssc. */
1514
1515 STATIC void
1516 S_ssc_and(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1517                 const regnode_charclass *and_with)
1518 {
1519     /* Accumulate into SSC 'ssc' its 'AND' with 'and_with', which is either
1520      * another SSC or a regular ANYOF class.  Can create false positives. */
1521
1522     SV* anded_cp_list;
1523     U8  anded_flags;
1524
1525     PERL_ARGS_ASSERT_SSC_AND;
1526
1527     assert(is_ANYOF_SYNTHETIC(ssc));
1528
1529     /* 'and_with' is used as-is if it too is an SSC; otherwise have to extract
1530      * the code point inversion list and just the relevant flags */
1531     if (is_ANYOF_SYNTHETIC(and_with)) {
1532         anded_cp_list = ((regnode_ssc *)and_with)->invlist;
1533         anded_flags = ANYOF_FLAGS(and_with);
1534
1535         /* XXX This is a kludge around what appears to be deficiencies in the
1536          * optimizer.  If we make S_ssc_anything() add in the WARN_SUPER flag,
1537          * there are paths through the optimizer where it doesn't get weeded
1538          * out when it should.  And if we don't make some extra provision for
1539          * it like the code just below, it doesn't get added when it should.
1540          * This solution is to add it only when AND'ing, which is here, and
1541          * only when what is being AND'ed is the pristine, original node
1542          * matching anything.  Thus it is like adding it to ssc_anything() but
1543          * only when the result is to be AND'ed.  Probably the same solution
1544          * could be adopted for the same problem we have with /l matching,
1545          * which is solved differently in S_ssc_init(), and that would lead to
1546          * fewer false positives than that solution has.  But if this solution
1547          * creates bugs, the consequences are only that a warning isn't raised
1548          * that should be; while the consequences for having /l bugs is
1549          * incorrect matches */
1550         if (ssc_is_anything((regnode_ssc *)and_with)) {
1551             anded_flags |= ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER;
1552         }
1553     }
1554     else {
1555         anded_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, and_with);
1556         if (OP(and_with) == ANYOFD) {
1557             anded_flags = ANYOF_FLAGS(and_with) & ANYOF_COMMON_FLAGS;
1558         }
1559         else {
1560             anded_flags = ANYOF_FLAGS(and_with)
1561             &( ANYOF_COMMON_FLAGS
1562               |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1563               |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1564             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(and_with))) {
1565                 anded_flags &=
1566                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1567             }
1568         }
1569     }
1570
1571     ANYOF_FLAGS(ssc) &= anded_flags;
1572
1573     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1574      * C2 is the list of code points in 'and-with'; P2, its posix classes.
1575      * 'and_with' may be inverted.  When not inverted, we have the situation of
1576      * computing:
1577      *  (C1 | P1) & (C2 | P2)
1578      *                     =  (C1 & (C2 | P2)) | (P1 & (C2 | P2))
1579      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1580      *                    <=  ((C1 & C2) |       P2)) | ( P1       | (P1 & P2))
1581      *                    <=  ((C1 & C2) | P1 | P2)
1582      * Alternatively, the last few steps could be:
1583      *                     =  ((C1 & C2) | (C1 & P2)) | ((P1 & C2) | (P1 & P2))
1584      *                    <=  ((C1 & C2) |  C1      ) | (      C2  | (P1 & P2))
1585      *                    <=  (C1 | C2 | (P1 & P2))
1586      * We favor the second approach if either P1 or P2 is non-empty.  This is
1587      * because these components are a barrier to doing optimizations, as what
1588      * they match cannot be known until the moment of matching as they are
1589      * dependent on the current locale, 'AND"ing them likely will reduce or
1590      * eliminate them.
1591      * But we can do better if we know that C1,P1 are in their initial state (a
1592      * frequent occurrence), each matching everything:
1593      *  (<everything>) & (C2 | P2) =  C2 | P2
1594      * Similarly, if C2,P2 are in their initial state (again a frequent
1595      * occurrence), the result is a no-op
1596      *  (C1 | P1) & (<everything>) =  C1 | P1
1597      *
1598      * Inverted, we have
1599      *  (C1 | P1) & ~(C2 | P2)  =  (C1 | P1) & (~C2 & ~P2)
1600      *                          =  (C1 & (~C2 & ~P2)) | (P1 & (~C2 & ~P2))
1601      *                         <=  (C1 & ~C2) | (P1 & ~P2)
1602      * */
1603
1604     if ((ANYOF_FLAGS(and_with) & ANYOF_INVERT)
1605         && ! is_ANYOF_SYNTHETIC(and_with))
1606     {
1607         unsigned int i;
1608
1609         ssc_intersection(ssc,
1610                          anded_cp_list,
1611                          FALSE /* Has already been inverted */
1612                          );
1613
1614         /* If either P1 or P2 is empty, the intersection will be also; can skip
1615          * the loop */
1616         if (! (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL)) {
1617             ANYOF_POSIXL_ZERO(ssc);
1618         }
1619         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1620
1621             /* Note that the Posix class component P from 'and_with' actually
1622              * looks like:
1623              *      P = Pa | Pb | ... | Pn
1624              * where each component is one posix class, such as in [\w\s].
1625              * Thus
1626              *      ~P = ~(Pa | Pb | ... | Pn)
1627              *         = ~Pa & ~Pb & ... & ~Pn
1628              *        <= ~Pa | ~Pb | ... | ~Pn
1629              * The last is something we can easily calculate, but unfortunately
1630              * is likely to have many false positives.  We could do better
1631              * in some (but certainly not all) instances if two classes in
1632              * P have known relationships.  For example
1633              *      :lower: <= :alpha: <= :alnum: <= \w <= :graph: <= :print:
1634              * So
1635              *      :lower: & :print: = :lower:
1636              * And similarly for classes that must be disjoint.  For example,
1637              * since \s and \w can have no elements in common based on rules in
1638              * the POSIX standard,
1639              *      \w & ^\S = nothing
1640              * Unfortunately, some vendor locales do not meet the Posix
1641              * standard, in particular almost everything by Microsoft.
1642              * The loop below just changes e.g., \w into \W and vice versa */
1643
1644             regnode_charclass_posixl temp;
1645             int add = 1;    /* To calculate the index of the complement */
1646
1647             ANYOF_POSIXL_ZERO(&temp);
1648             for (i = 0; i < ANYOF_MAX; i++) {
1649                 assert(i % 2 != 0
1650                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)
1651                        || ! ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i + 1));
1652
1653                 if (ANYOF_POSIXL_TEST((regnode_charclass_posixl*) and_with, i)) {
1654                     ANYOF_POSIXL_SET(&temp, i + add);
1655                 }
1656                 add = 0 - add; /* 1 goes to -1; -1 goes to 1 */
1657             }
1658             ANYOF_POSIXL_AND(&temp, ssc);
1659
1660         } /* else ssc already has no posixes */
1661     } /* else: Not inverted.  This routine is a no-op if 'and_with' is an SSC
1662          in its initial state */
1663     else if (! is_ANYOF_SYNTHETIC(and_with)
1664              || ! ssc_is_cp_posixl_init(pRExC_state, (regnode_ssc *)and_with))
1665     {
1666         /* But if 'ssc' is in its initial state, the result is just 'and_with';
1667          * copy it over 'ssc' */
1668         if (ssc_is_cp_posixl_init(pRExC_state, ssc)) {
1669             if (is_ANYOF_SYNTHETIC(and_with)) {
1670                 StructCopy(and_with, ssc, regnode_ssc);
1671             }
1672             else {
1673                 ssc->invlist = anded_cp_list;
1674                 ANYOF_POSIXL_ZERO(ssc);
1675                 if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1676                     ANYOF_POSIXL_OR((regnode_charclass_posixl*) and_with, ssc);
1677                 }
1678             }
1679         }
1680         else if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)
1681                  || (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL))
1682         {
1683             /* One or the other of P1, P2 is non-empty. */
1684             if (ANYOF_FLAGS(and_with) & ANYOF_MATCHES_POSIXL) {
1685                 ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1686             }
1687             ssc_union(ssc, anded_cp_list, FALSE);
1688         }
1689         else { /* P1 = P2 = empty */
1690             ssc_intersection(ssc, anded_cp_list, FALSE);
1691         }
1692     }
1693 }
1694
1695 STATIC void
1696 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1697                const regnode_charclass *or_with)
1698 {
1699     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1700      * another SSC or a regular ANYOF class.  Can create false positives if
1701      * 'or_with' is to be inverted. */
1702
1703     SV* ored_cp_list;
1704     U8 ored_flags;
1705
1706     PERL_ARGS_ASSERT_SSC_OR;
1707
1708     assert(is_ANYOF_SYNTHETIC(ssc));
1709
1710     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1711      * the code point inversion list and just the relevant flags */
1712     if (is_ANYOF_SYNTHETIC(or_with)) {
1713         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1714         ored_flags = ANYOF_FLAGS(or_with);
1715     }
1716     else {
1717         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state, or_with);
1718         ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1719         if (OP(or_with) != ANYOFD) {
1720             ored_flags
1721             |= ANYOF_FLAGS(or_with)
1722              & ( ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1723                 |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP);
1724             if (ANYOFL_UTF8_LOCALE_REQD(ANYOF_FLAGS(or_with))) {
1725                 ored_flags |=
1726                     ANYOFL_SHARED_UTF8_LOCALE_fold_HAS_MATCHES_nonfold_REQD;
1727             }
1728         }
1729     }
1730
1731     ANYOF_FLAGS(ssc) |= ored_flags;
1732
1733     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1734      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1735      * 'or_with' may be inverted.  When not inverted, we have the simple
1736      * situation of computing:
1737      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1738      * If P1|P2 yields a situation with both a class and its complement are
1739      * set, like having both \w and \W, this matches all code points, and we
1740      * can delete these from the P component of the ssc going forward.  XXX We
1741      * might be able to delete all the P components, but I (khw) am not certain
1742      * about this, and it is better to be safe.
1743      *
1744      * Inverted, we have
1745      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1746      *                         <=  (C1 | P1) | ~C2
1747      *                         <=  (C1 | ~C2) | P1
1748      * (which results in actually simpler code than the non-inverted case)
1749      * */
1750
1751     if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1752         && ! is_ANYOF_SYNTHETIC(or_with))
1753     {
1754         /* We ignore P2, leaving P1 going forward */
1755     }   /* else  Not inverted */
1756     else if (ANYOF_FLAGS(or_with) & ANYOF_MATCHES_POSIXL) {
1757         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1758         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1759             unsigned int i;
1760             for (i = 0; i < ANYOF_MAX; i += 2) {
1761                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1762                 {
1763                     ssc_match_all_cp(ssc);
1764                     ANYOF_POSIXL_CLEAR(ssc, i);
1765                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1766                 }
1767             }
1768         }
1769     }
1770
1771     ssc_union(ssc,
1772               ored_cp_list,
1773               FALSE /* Already has been inverted */
1774               );
1775 }
1776
1777 PERL_STATIC_INLINE void
1778 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1779 {
1780     PERL_ARGS_ASSERT_SSC_UNION;
1781
1782     assert(is_ANYOF_SYNTHETIC(ssc));
1783
1784     _invlist_union_maybe_complement_2nd(ssc->invlist,
1785                                         invlist,
1786                                         invert2nd,
1787                                         &ssc->invlist);
1788 }
1789
1790 PERL_STATIC_INLINE void
1791 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1792                          SV* const invlist,
1793                          const bool invert2nd)
1794 {
1795     PERL_ARGS_ASSERT_SSC_INTERSECTION;
1796
1797     assert(is_ANYOF_SYNTHETIC(ssc));
1798
1799     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1800                                                invlist,
1801                                                invert2nd,
1802                                                &ssc->invlist);
1803 }
1804
1805 PERL_STATIC_INLINE void
1806 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1807 {
1808     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1809
1810     assert(is_ANYOF_SYNTHETIC(ssc));
1811
1812     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1813 }
1814
1815 PERL_STATIC_INLINE void
1816 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1817 {
1818     /* AND just the single code point 'cp' into the SSC 'ssc' */
1819
1820     SV* cp_list = _new_invlist(2);
1821
1822     PERL_ARGS_ASSERT_SSC_CP_AND;
1823
1824     assert(is_ANYOF_SYNTHETIC(ssc));
1825
1826     cp_list = add_cp_to_invlist(cp_list, cp);
1827     ssc_intersection(ssc, cp_list,
1828                      FALSE /* Not inverted */
1829                      );
1830     SvREFCNT_dec_NN(cp_list);
1831 }
1832
1833 PERL_STATIC_INLINE void
1834 S_ssc_clear_locale(regnode_ssc *ssc)
1835 {
1836     /* Set the SSC 'ssc' to not match any locale things */
1837     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1838
1839     assert(is_ANYOF_SYNTHETIC(ssc));
1840
1841     ANYOF_POSIXL_ZERO(ssc);
1842     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1843 }
1844
1845 #define NON_OTHER_COUNT   NON_OTHER_COUNT_FOR_USE_ONLY_BY_REGCOMP_DOT_C
1846
1847 STATIC bool
1848 S_is_ssc_worth_it(const RExC_state_t * pRExC_state, const regnode_ssc * ssc)
1849 {
1850     /* The synthetic start class is used to hopefully quickly winnow down
1851      * places where a pattern could start a match in the target string.  If it
1852      * doesn't really narrow things down that much, there isn't much point to
1853      * having the overhead of using it.  This function uses some very crude
1854      * heuristics to decide if to use the ssc or not.
1855      *
1856      * It returns TRUE if 'ssc' rules out more than half what it considers to
1857      * be the "likely" possible matches, but of course it doesn't know what the
1858      * actual things being matched are going to be; these are only guesses
1859      *
1860      * For /l matches, it assumes that the only likely matches are going to be
1861      *      in the 0-255 range, uniformly distributed, so half of that is 127
1862      * For /a and /d matches, it assumes that the likely matches will be just
1863      *      the ASCII range, so half of that is 63
1864      * For /u and there isn't anything matching above the Latin1 range, it
1865      *      assumes that that is the only range likely to be matched, and uses
1866      *      half that as the cut-off: 127.  If anything matches above Latin1,
1867      *      it assumes that all of Unicode could match (uniformly), except for
1868      *      non-Unicode code points and things in the General Category "Other"
1869      *      (unassigned, private use, surrogates, controls and formats).  This
1870      *      is a much large number. */
1871
1872     U32 count = 0;      /* Running total of number of code points matched by
1873                            'ssc' */
1874     UV start, end;      /* Start and end points of current range in inversion
1875                            list */
1876     const U32 max_code_points = (LOC)
1877                                 ?  256
1878                                 : ((   ! UNI_SEMANTICS
1879                                      || invlist_highest(ssc->invlist) < 256)
1880                                   ? 128
1881                                   : NON_OTHER_COUNT);
1882     const U32 max_match = max_code_points / 2;
1883
1884     PERL_ARGS_ASSERT_IS_SSC_WORTH_IT;
1885
1886     invlist_iterinit(ssc->invlist);
1887     while (invlist_iternext(ssc->invlist, &start, &end)) {
1888         if (start >= max_code_points) {
1889             break;
1890         }
1891         end = MIN(end, max_code_points - 1);
1892         count += end - start + 1;
1893         if (count >= max_match) {
1894             invlist_iterfinish(ssc->invlist);
1895             return FALSE;
1896         }
1897     }
1898
1899     return TRUE;
1900 }
1901
1902
1903 STATIC void
1904 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1905 {
1906     /* The inversion list in the SSC is marked mortal; now we need a more
1907      * permanent copy, which is stored the same way that is done in a regular
1908      * ANYOF node, with the first NUM_ANYOF_CODE_POINTS code points in a bit
1909      * map */
1910
1911     SV* invlist = invlist_clone(ssc->invlist);
1912
1913     PERL_ARGS_ASSERT_SSC_FINALIZE;
1914
1915     assert(is_ANYOF_SYNTHETIC(ssc));
1916
1917     /* The code in this file assumes that all but these flags aren't relevant
1918      * to the SSC, except SSC_MATCHES_EMPTY_STRING, which should be cleared
1919      * by the time we reach here */
1920     assert(! (ANYOF_FLAGS(ssc)
1921         & ~( ANYOF_COMMON_FLAGS
1922             |ANYOF_SHARED_d_MATCHES_ALL_NON_UTF8_NON_ASCII_non_d_WARN_SUPER
1923             |ANYOF_SHARED_d_UPPER_LATIN1_UTF8_STRING_MATCHES_non_d_RUNTIME_USER_PROP)));
1924
1925     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1926
1927     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1928                                 NULL, NULL, NULL, FALSE);
1929
1930     /* Make sure is clone-safe */
1931     ssc->invlist = NULL;
1932
1933     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1934         ANYOF_FLAGS(ssc) |= ANYOF_MATCHES_POSIXL;
1935     }
1936
1937     if (RExC_contains_locale) {
1938         OP(ssc) = ANYOFL;
1939     }
1940
1941     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
1942 }
1943
1944 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1945 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1946 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1947 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
1948                                ? (TRIE_LIST_CUR( idx ) - 1)           \
1949                                : 0 )
1950
1951
1952 #ifdef DEBUGGING
1953 /*
1954    dump_trie(trie,widecharmap,revcharmap)
1955    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1956    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1957
1958    These routines dump out a trie in a somewhat readable format.
1959    The _interim_ variants are used for debugging the interim
1960    tables that are used to generate the final compressed
1961    representation which is what dump_trie expects.
1962
1963    Part of the reason for their existence is to provide a form
1964    of documentation as to how the different representations function.
1965
1966 */
1967
1968 /*
1969   Dumps the final compressed table form of the trie to Perl_debug_log.
1970   Used for debugging make_trie().
1971 */
1972
1973 STATIC void
1974 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1975             AV *revcharmap, U32 depth)
1976 {
1977     U32 state;
1978     SV *sv=sv_newmortal();
1979     int colwidth= widecharmap ? 6 : 4;
1980     U16 word;
1981     GET_RE_DEBUG_FLAGS_DECL;
1982
1983     PERL_ARGS_ASSERT_DUMP_TRIE;
1984
1985     Perl_re_indentf( aTHX_  "Char : %-6s%-6s%-4s ",
1986         depth+1, "Match","Base","Ofs" );
1987
1988     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1989         SV ** const tmp = av_fetch( revcharmap, state, 0);
1990         if ( tmp ) {
1991             Perl_re_printf( aTHX_  "%*s",
1992                 colwidth,
1993                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1994                             PL_colors[0], PL_colors[1],
1995                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1996                             PERL_PV_ESCAPE_FIRSTCHAR
1997                 )
1998             );
1999         }
2000     }
2001     Perl_re_printf( aTHX_  "\n");
2002     Perl_re_indentf( aTHX_ "State|-----------------------", depth+1);
2003
2004     for( state = 0 ; state < trie->uniquecharcount ; state++ )
2005         Perl_re_printf( aTHX_  "%.*s", colwidth, "--------");
2006     Perl_re_printf( aTHX_  "\n");
2007
2008     for( state = 1 ; state < trie->statecount ; state++ ) {
2009         const U32 base = trie->states[ state ].trans.base;
2010
2011         Perl_re_indentf( aTHX_  "#%4" UVXf "|", depth+1, (UV)state);
2012
2013         if ( trie->states[ state ].wordnum ) {
2014             Perl_re_printf( aTHX_  " W%4X", trie->states[ state ].wordnum );
2015         } else {
2016             Perl_re_printf( aTHX_  "%6s", "" );
2017         }
2018
2019         Perl_re_printf( aTHX_  " @%4" UVXf " ", (UV)base );
2020
2021         if ( base ) {
2022             U32 ofs = 0;
2023
2024             while( ( base + ofs  < trie->uniquecharcount ) ||
2025                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
2026                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
2027                                                                     != state))
2028                     ofs++;
2029
2030             Perl_re_printf( aTHX_  "+%2" UVXf "[ ", (UV)ofs);
2031
2032             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2033                 if ( ( base + ofs >= trie->uniquecharcount )
2034                         && ( base + ofs - trie->uniquecharcount
2035                                                         < trie->lasttrans )
2036                         && trie->trans[ base + ofs
2037                                     - trie->uniquecharcount ].check == state )
2038                 {
2039                    Perl_re_printf( aTHX_  "%*" UVXf, colwidth,
2040                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next
2041                    );
2042                 } else {
2043                     Perl_re_printf( aTHX_  "%*s",colwidth,"   ." );
2044                 }
2045             }
2046
2047             Perl_re_printf( aTHX_  "]");
2048
2049         }
2050         Perl_re_printf( aTHX_  "\n" );
2051     }
2052     Perl_re_indentf( aTHX_  "word_info N:(prev,len)=",
2053                                 depth);
2054     for (word=1; word <= trie->wordcount; word++) {
2055         Perl_re_printf( aTHX_  " %d:(%d,%d)",
2056             (int)word, (int)(trie->wordinfo[word].prev),
2057             (int)(trie->wordinfo[word].len));
2058     }
2059     Perl_re_printf( aTHX_  "\n" );
2060 }
2061 /*
2062   Dumps a fully constructed but uncompressed trie in list form.
2063   List tries normally only are used for construction when the number of
2064   possible chars (trie->uniquecharcount) is very high.
2065   Used for debugging make_trie().
2066 */
2067 STATIC void
2068 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
2069                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
2070                          U32 depth)
2071 {
2072     U32 state;
2073     SV *sv=sv_newmortal();
2074     int colwidth= widecharmap ? 6 : 4;
2075     GET_RE_DEBUG_FLAGS_DECL;
2076
2077     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
2078
2079     /* print out the table precompression.  */
2080     Perl_re_indentf( aTHX_  "State :Word | Transition Data\n",
2081             depth+1 );
2082     Perl_re_indentf( aTHX_  "%s",
2083             depth+1, "------:-----+-----------------\n" );
2084
2085     for( state=1 ; state < next_alloc ; state ++ ) {
2086         U16 charid;
2087
2088         Perl_re_indentf( aTHX_  " %4" UVXf " :",
2089             depth+1, (UV)state  );
2090         if ( ! trie->states[ state ].wordnum ) {
2091             Perl_re_printf( aTHX_  "%5s| ","");
2092         } else {
2093             Perl_re_printf( aTHX_  "W%4x| ",
2094                 trie->states[ state ].wordnum
2095             );
2096         }
2097         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
2098             SV ** const tmp = av_fetch( revcharmap,
2099                                         TRIE_LIST_ITEM(state,charid).forid, 0);
2100             if ( tmp ) {
2101                 Perl_re_printf( aTHX_  "%*s:%3X=%4" UVXf " | ",
2102                     colwidth,
2103                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
2104                               colwidth,
2105                               PL_colors[0], PL_colors[1],
2106                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
2107                               | PERL_PV_ESCAPE_FIRSTCHAR
2108                     ) ,
2109                     TRIE_LIST_ITEM(state,charid).forid,
2110                     (UV)TRIE_LIST_ITEM(state,charid).newstate
2111                 );
2112                 if (!(charid % 10))
2113                     Perl_re_printf( aTHX_  "\n%*s| ",
2114                         (int)((depth * 2) + 14), "");
2115             }
2116         }
2117         Perl_re_printf( aTHX_  "\n");
2118     }
2119 }
2120
2121 /*
2122   Dumps a fully constructed but uncompressed trie in table form.
2123   This is the normal DFA style state transition table, with a few
2124   twists to facilitate compression later.
2125   Used for debugging make_trie().
2126 */
2127 STATIC void
2128 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
2129                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
2130                           U32 depth)
2131 {
2132     U32 state;
2133     U16 charid;
2134     SV *sv=sv_newmortal();
2135     int colwidth= widecharmap ? 6 : 4;
2136     GET_RE_DEBUG_FLAGS_DECL;
2137
2138     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
2139
2140     /*
2141        print out the table precompression so that we can do a visual check
2142        that they are identical.
2143      */
2144
2145     Perl_re_indentf( aTHX_  "Char : ", depth+1 );
2146
2147     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2148         SV ** const tmp = av_fetch( revcharmap, charid, 0);
2149         if ( tmp ) {
2150             Perl_re_printf( aTHX_  "%*s",
2151                 colwidth,
2152                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
2153                             PL_colors[0], PL_colors[1],
2154                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2155                             PERL_PV_ESCAPE_FIRSTCHAR
2156                 )
2157             );
2158         }
2159     }
2160
2161     Perl_re_printf( aTHX_ "\n");
2162     Perl_re_indentf( aTHX_  "State+-", depth+1 );
2163
2164     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
2165         Perl_re_printf( aTHX_  "%.*s", colwidth,"--------");
2166     }
2167
2168     Perl_re_printf( aTHX_  "\n" );
2169
2170     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
2171
2172         Perl_re_indentf( aTHX_  "%4" UVXf " : ",
2173             depth+1,
2174             (UV)TRIE_NODENUM( state ) );
2175
2176         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
2177             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
2178             if (v)
2179                 Perl_re_printf( aTHX_  "%*" UVXf, colwidth, v );
2180             else
2181                 Perl_re_printf( aTHX_  "%*s", colwidth, "." );
2182         }
2183         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
2184             Perl_re_printf( aTHX_  " (%4" UVXf ")\n",
2185                                             (UV)trie->trans[ state ].check );
2186         } else {
2187             Perl_re_printf( aTHX_  " (%4" UVXf ") W%4X\n",
2188                                             (UV)trie->trans[ state ].check,
2189             trie->states[ TRIE_NODENUM( state ) ].wordnum );
2190         }
2191     }
2192 }
2193
2194 #endif
2195
2196
2197 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
2198   startbranch: the first branch in the whole branch sequence
2199   first      : start branch of sequence of branch-exact nodes.
2200                May be the same as startbranch
2201   last       : Thing following the last branch.
2202                May be the same as tail.
2203   tail       : item following the branch sequence
2204   count      : words in the sequence
2205   flags      : currently the OP() type we will be building one of /EXACT(|F|FA|FU|FU_SS|L|FLU8)/
2206   depth      : indent depth
2207
2208 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
2209
2210 A trie is an N'ary tree where the branches are determined by digital
2211 decomposition of the key. IE, at the root node you look up the 1st character and
2212 follow that branch repeat until you find the end of the branches. Nodes can be
2213 marked as "accepting" meaning they represent a complete word. Eg:
2214
2215   /he|she|his|hers/
2216
2217 would convert into the following structure. Numbers represent states, letters
2218 following numbers represent valid transitions on the letter from that state, if
2219 the number is in square brackets it represents an accepting state, otherwise it
2220 will be in parenthesis.
2221
2222       +-h->+-e->[3]-+-r->(8)-+-s->[9]
2223       |    |
2224       |   (2)
2225       |    |
2226      (1)   +-i->(6)-+-s->[7]
2227       |
2228       +-s->(3)-+-h->(4)-+-e->[5]
2229
2230       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
2231
2232 This shows that when matching against the string 'hers' we will begin at state 1
2233 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
2234 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
2235 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
2236 single traverse. We store a mapping from accepting to state to which word was
2237 matched, and then when we have multiple possibilities we try to complete the
2238 rest of the regex in the order in which they occurred in the alternation.
2239
2240 The only prior NFA like behaviour that would be changed by the TRIE support is
2241 the silent ignoring of duplicate alternations which are of the form:
2242
2243  / (DUPE|DUPE) X? (?{ ... }) Y /x
2244
2245 Thus EVAL blocks following a trie may be called a different number of times with
2246 and without the optimisation. With the optimisations dupes will be silently
2247 ignored. This inconsistent behaviour of EVAL type nodes is well established as
2248 the following demonstrates:
2249
2250  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
2251
2252 which prints out 'word' three times, but
2253
2254  'words'=~/(word|word|word)(?{ print $1 })S/
2255
2256 which doesnt print it out at all. This is due to other optimisations kicking in.
2257
2258 Example of what happens on a structural level:
2259
2260 The regexp /(ac|ad|ab)+/ will produce the following debug output:
2261
2262    1: CURLYM[1] {1,32767}(18)
2263    5:   BRANCH(8)
2264    6:     EXACT <ac>(16)
2265    8:   BRANCH(11)
2266    9:     EXACT <ad>(16)
2267   11:   BRANCH(14)
2268   12:     EXACT <ab>(16)
2269   16:   SUCCEED(0)
2270   17:   NOTHING(18)
2271   18: END(0)
2272
2273 This would be optimizable with startbranch=5, first=5, last=16, tail=16
2274 and should turn into:
2275
2276    1: CURLYM[1] {1,32767}(18)
2277    5:   TRIE(16)
2278         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
2279           <ac>
2280           <ad>
2281           <ab>
2282   16:   SUCCEED(0)
2283   17:   NOTHING(18)
2284   18: END(0)
2285
2286 Cases where tail != last would be like /(?foo|bar)baz/:
2287
2288    1: BRANCH(4)
2289    2:   EXACT <foo>(8)
2290    4: BRANCH(7)
2291    5:   EXACT <bar>(8)
2292    7: TAIL(8)
2293    8: EXACT <baz>(10)
2294   10: END(0)
2295
2296 which would be optimizable with startbranch=1, first=1, last=7, tail=8
2297 and would end up looking like:
2298
2299     1: TRIE(8)
2300       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
2301         <foo>
2302         <bar>
2303    7: TAIL(8)
2304    8: EXACT <baz>(10)
2305   10: END(0)
2306
2307     d = uvchr_to_utf8_flags(d, uv, 0);
2308
2309 is the recommended Unicode-aware way of saying
2310
2311     *(d++) = uv;
2312 */
2313
2314 #define TRIE_STORE_REVCHAR(val)                                            \
2315     STMT_START {                                                           \
2316         if (UTF) {                                                         \
2317             SV *zlopp = newSV(UTF8_MAXBYTES);                              \
2318             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
2319             unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
2320             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
2321             SvPOK_on(zlopp);                                               \
2322             SvUTF8_on(zlopp);                                              \
2323             av_push(revcharmap, zlopp);                                    \
2324         } else {                                                           \
2325             char ooooff = (char)val;                                           \
2326             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
2327         }                                                                  \
2328         } STMT_END
2329
2330 /* This gets the next character from the input, folding it if not already
2331  * folded. */
2332 #define TRIE_READ_CHAR STMT_START {                                           \
2333     wordlen++;                                                                \
2334     if ( UTF ) {                                                              \
2335         /* if it is UTF then it is either already folded, or does not need    \
2336          * folding */                                                         \
2337         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
2338     }                                                                         \
2339     else if (folder == PL_fold_latin1) {                                      \
2340         /* This folder implies Unicode rules, which in the range expressible  \
2341          *  by not UTF is the lower case, with the two exceptions, one of     \
2342          *  which should have been taken care of before calling this */       \
2343         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
2344         uvc = toLOWER_L1(*uc);                                                \
2345         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
2346         len = 1;                                                              \
2347     } else {                                                                  \
2348         /* raw data, will be folded later if needed */                        \
2349         uvc = (U32)*uc;                                                       \
2350         len = 1;                                                              \
2351     }                                                                         \
2352 } STMT_END
2353
2354
2355
2356 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
2357     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
2358         U32 ging = TRIE_LIST_LEN( state ) * 2;                  \
2359         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
2360         TRIE_LIST_LEN( state ) = ging;                          \
2361     }                                                           \
2362     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
2363     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
2364     TRIE_LIST_CUR( state )++;                                   \
2365 } STMT_END
2366
2367 #define TRIE_LIST_NEW(state) STMT_START {                       \
2368     Newxz( trie->states[ state ].trans.list,               \
2369         4, reg_trie_trans_le );                                 \
2370      TRIE_LIST_CUR( state ) = 1;                                \
2371      TRIE_LIST_LEN( state ) = 4;                                \
2372 } STMT_END
2373
2374 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
2375     U16 dupe= trie->states[ state ].wordnum;                    \
2376     regnode * const noper_next = regnext( noper );              \
2377                                                                 \
2378     DEBUG_r({                                                   \
2379         /* store the word for dumping */                        \
2380         SV* tmp;                                                \
2381         if (OP(noper) != NOTHING)                               \
2382             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
2383         else                                                    \
2384             tmp = newSVpvn_utf8( "", 0, UTF );                  \
2385         av_push( trie_words, tmp );                             \
2386     });                                                         \
2387                                                                 \
2388     curword++;                                                  \
2389     trie->wordinfo[curword].prev   = 0;                         \
2390     trie->wordinfo[curword].len    = wordlen;                   \
2391     trie->wordinfo[curword].accept = state;                     \
2392                                                                 \
2393     if ( noper_next < tail ) {                                  \
2394         if (!trie->jump)                                        \
2395             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
2396                                                  sizeof(U16) ); \
2397         trie->jump[curword] = (U16)(noper_next - convert);      \
2398         if (!jumper)                                            \
2399             jumper = noper_next;                                \
2400         if (!nextbranch)                                        \
2401             nextbranch= regnext(cur);                           \
2402     }                                                           \
2403                                                                 \
2404     if ( dupe ) {                                               \
2405         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
2406         /* chain, so that when the bits of chain are later    */\
2407         /* linked together, the dups appear in the chain      */\
2408         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
2409         trie->wordinfo[dupe].prev = curword;                    \
2410     } else {                                                    \
2411         /* we haven't inserted this word yet.                */ \
2412         trie->states[ state ].wordnum = curword;                \
2413     }                                                           \
2414 } STMT_END
2415
2416
2417 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
2418      ( ( base + charid >=  ucharcount                                   \
2419          && base + charid < ubound                                      \
2420          && state == trie->trans[ base - ucharcount + charid ].check    \
2421          && trie->trans[ base - ucharcount + charid ].next )            \
2422            ? trie->trans[ base - ucharcount + charid ].next             \
2423            : ( state==1 ? special : 0 )                                 \
2424       )
2425
2426 #define TRIE_BITMAP_SET_FOLDED(trie, uvc, folder)           \
2427 STMT_START {                                                \
2428     TRIE_BITMAP_SET(trie, uvc);                             \
2429     /* store the folded codepoint */                        \
2430     if ( folder )                                           \
2431         TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);           \
2432                                                             \
2433     if ( !UTF ) {                                           \
2434         /* store first byte of utf8 representation of */    \
2435         /* variant codepoints */                            \
2436         if (! UVCHR_IS_INVARIANT(uvc)) {                    \
2437             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));   \
2438         }                                                   \
2439     }                                                       \
2440 } STMT_END
2441 #define MADE_TRIE       1
2442 #define MADE_JUMP_TRIE  2
2443 #define MADE_EXACT_TRIE 4
2444
2445 STATIC I32
2446 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
2447                   regnode *first, regnode *last, regnode *tail,
2448                   U32 word_count, U32 flags, U32 depth)
2449 {
2450     /* first pass, loop through and scan words */
2451     reg_trie_data *trie;
2452     HV *widecharmap = NULL;
2453     AV *revcharmap = newAV();
2454     regnode *cur;
2455     STRLEN len = 0;
2456     UV uvc = 0;
2457     U16 curword = 0;
2458     U32 next_alloc = 0;
2459     regnode *jumper = NULL;
2460     regnode *nextbranch = NULL;
2461     regnode *convert = NULL;
2462     U32 *prev_states; /* temp array mapping each state to previous one */
2463     /* we just use folder as a flag in utf8 */
2464     const U8 * folder = NULL;
2465
2466 #ifdef DEBUGGING
2467     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuuu"));
2468     AV *trie_words = NULL;
2469     /* along with revcharmap, this only used during construction but both are
2470      * useful during debugging so we store them in the struct when debugging.
2471      */
2472 #else
2473     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
2474     STRLEN trie_charcount=0;
2475 #endif
2476     SV *re_trie_maxbuff;
2477     GET_RE_DEBUG_FLAGS_DECL;
2478
2479     PERL_ARGS_ASSERT_MAKE_TRIE;
2480 #ifndef DEBUGGING
2481     PERL_UNUSED_ARG(depth);
2482 #endif
2483
2484     switch (flags) {
2485         case EXACT: case EXACTL: break;
2486         case EXACTFA:
2487         case EXACTFU_SS:
2488         case EXACTFU:
2489         case EXACTFLU8: folder = PL_fold_latin1; break;
2490         case EXACTF:  folder = PL_fold; break;
2491         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
2492     }
2493
2494     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
2495     trie->refcount = 1;
2496     trie->startstate = 1;
2497     trie->wordcount = word_count;
2498     RExC_rxi->data->data[ data_slot ] = (void*)trie;
2499     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
2500     if (flags == EXACT || flags == EXACTL)
2501         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
2502     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2503                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2504
2505     DEBUG_r({
2506         trie_words = newAV();
2507     });
2508
2509     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2510     assert(re_trie_maxbuff);
2511     if (!SvIOK(re_trie_maxbuff)) {
2512         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2513     }
2514     DEBUG_TRIE_COMPILE_r({
2515         Perl_re_indentf( aTHX_
2516           "make_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2517           depth+1,
2518           REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2519           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2520     });
2521
2522    /* Find the node we are going to overwrite */
2523     if ( first == startbranch && OP( last ) != BRANCH ) {
2524         /* whole branch chain */
2525         convert = first;
2526     } else {
2527         /* branch sub-chain */
2528         convert = NEXTOPER( first );
2529     }
2530
2531     /*  -- First loop and Setup --
2532
2533        We first traverse the branches and scan each word to determine if it
2534        contains widechars, and how many unique chars there are, this is
2535        important as we have to build a table with at least as many columns as we
2536        have unique chars.
2537
2538        We use an array of integers to represent the character codes 0..255
2539        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2540        the native representation of the character value as the key and IV's for
2541        the coded index.
2542
2543        *TODO* If we keep track of how many times each character is used we can
2544        remap the columns so that the table compression later on is more
2545        efficient in terms of memory by ensuring the most common value is in the
2546        middle and the least common are on the outside.  IMO this would be better
2547        than a most to least common mapping as theres a decent chance the most
2548        common letter will share a node with the least common, meaning the node
2549        will not be compressible. With a middle is most common approach the worst
2550        case is when we have the least common nodes twice.
2551
2552      */
2553
2554     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2555         regnode *noper = NEXTOPER( cur );
2556         const U8 *uc;
2557         const U8 *e;
2558         int foldlen = 0;
2559         U32 wordlen      = 0;         /* required init */
2560         STRLEN minchars = 0;
2561         STRLEN maxchars = 0;
2562         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2563                                                bitmap?*/
2564
2565         if (OP(noper) == NOTHING) {
2566             /* skip past a NOTHING at the start of an alternation
2567              * eg, /(?:)a|(?:b)/ should be the same as /a|b/
2568              */
2569             regnode *noper_next= regnext(noper);
2570             if (noper_next < tail)
2571                 noper= noper_next;
2572         }
2573
2574         if ( noper < tail &&
2575                 (
2576                     OP(noper) == flags ||
2577                     (
2578                         flags == EXACTFU &&
2579                         OP(noper) == EXACTFU_SS
2580                     )
2581                 )
2582         ) {
2583             uc= (U8*)STRING(noper);
2584             e= uc + STR_LEN(noper);
2585         } else {
2586             trie->minlen= 0;
2587             continue;
2588         }
2589
2590
2591         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2592             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2593                                           regardless of encoding */
2594             if (OP( noper ) == EXACTFU_SS) {
2595                 /* false positives are ok, so just set this */
2596                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2597             }
2598         }
2599
2600         for ( ; uc < e ; uc += len ) {  /* Look at each char in the current
2601                                            branch */
2602             TRIE_CHARCOUNT(trie)++;
2603             TRIE_READ_CHAR;
2604
2605             /* TRIE_READ_CHAR returns the current character, or its fold if /i
2606              * is in effect.  Under /i, this character can match itself, or
2607              * anything that folds to it.  If not under /i, it can match just
2608              * itself.  Most folds are 1-1, for example k, K, and KELVIN SIGN
2609              * all fold to k, and all are single characters.   But some folds
2610              * expand to more than one character, so for example LATIN SMALL
2611              * LIGATURE FFI folds to the three character sequence 'ffi'.  If
2612              * the string beginning at 'uc' is 'ffi', it could be matched by
2613              * three characters, or just by the one ligature character. (It
2614              * could also be matched by two characters: LATIN SMALL LIGATURE FF
2615              * followed by 'i', or by 'f' followed by LATIN SMALL LIGATURE FI).
2616              * (Of course 'I' and/or 'F' instead of 'i' and 'f' can also
2617              * match.)  The trie needs to know the minimum and maximum number
2618              * of characters that could match so that it can use size alone to
2619              * quickly reject many match attempts.  The max is simple: it is
2620              * the number of folded characters in this branch (since a fold is
2621              * never shorter than what folds to it. */
2622
2623             maxchars++;
2624
2625             /* And the min is equal to the max if not under /i (indicated by
2626              * 'folder' being NULL), or there are no multi-character folds.  If
2627              * there is a multi-character fold, the min is incremented just
2628              * once, for the character that folds to the sequence.  Each
2629              * character in the sequence needs to be added to the list below of
2630              * characters in the trie, but we count only the first towards the
2631              * min number of characters needed.  This is done through the
2632              * variable 'foldlen', which is returned by the macros that look
2633              * for these sequences as the number of bytes the sequence
2634              * occupies.  Each time through the loop, we decrement 'foldlen' by
2635              * how many bytes the current char occupies.  Only when it reaches
2636              * 0 do we increment 'minchars' or look for another multi-character
2637              * sequence. */
2638             if (folder == NULL) {
2639                 minchars++;
2640             }
2641             else if (foldlen > 0) {
2642                 foldlen -= (UTF) ? UTF8SKIP(uc) : 1;
2643             }
2644             else {
2645                 minchars++;
2646
2647                 /* See if *uc is the beginning of a multi-character fold.  If
2648                  * so, we decrement the length remaining to look at, to account
2649                  * for the current character this iteration.  (We can use 'uc'
2650                  * instead of the fold returned by TRIE_READ_CHAR because for
2651                  * non-UTF, the latin1_safe macro is smart enough to account
2652                  * for all the unfolded characters, and because for UTF, the
2653                  * string will already have been folded earlier in the
2654                  * compilation process */
2655                 if (UTF) {
2656                     if ((foldlen = is_MULTI_CHAR_FOLD_utf8_safe(uc, e))) {
2657                         foldlen -= UTF8SKIP(uc);
2658                     }
2659                 }
2660                 else if ((foldlen = is_MULTI_CHAR_FOLD_latin1_safe(uc, e))) {
2661                     foldlen--;
2662                 }
2663             }
2664
2665             /* The current character (and any potential folds) should be added
2666              * to the possible matching characters for this position in this
2667              * branch */
2668             if ( uvc < 256 ) {
2669                 if ( folder ) {
2670                     U8 folded= folder[ (U8) uvc ];
2671                     if ( !trie->charmap[ folded ] ) {
2672                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2673                         TRIE_STORE_REVCHAR( folded );
2674                     }
2675                 }
2676                 if ( !trie->charmap[ uvc ] ) {
2677                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2678                     TRIE_STORE_REVCHAR( uvc );
2679                 }
2680                 if ( set_bit ) {
2681                     /* store the codepoint in the bitmap, and its folded
2682                      * equivalent. */
2683                     TRIE_BITMAP_SET_FOLDED(trie, uvc, folder);
2684                     set_bit = 0; /* We've done our bit :-) */
2685                 }
2686             } else {
2687
2688                 /* XXX We could come up with the list of code points that fold
2689                  * to this using PL_utf8_foldclosures, except not for
2690                  * multi-char folds, as there may be multiple combinations
2691                  * there that could work, which needs to wait until runtime to
2692                  * resolve (The comment about LIGATURE FFI above is such an
2693                  * example */
2694
2695                 SV** svpp;
2696                 if ( !widecharmap )
2697                     widecharmap = newHV();
2698
2699                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2700
2701                 if ( !svpp )
2702                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%" UVXf, uvc );
2703
2704                 if ( !SvTRUE( *svpp ) ) {
2705                     sv_setiv( *svpp, ++trie->uniquecharcount );
2706                     TRIE_STORE_REVCHAR(uvc);
2707                 }
2708             }
2709         } /* end loop through characters in this branch of the trie */
2710
2711         /* We take the min and max for this branch and combine to find the min
2712          * and max for all branches processed so far */
2713         if( cur == first ) {
2714             trie->minlen = minchars;
2715             trie->maxlen = maxchars;
2716         } else if (minchars < trie->minlen) {
2717             trie->minlen = minchars;
2718         } else if (maxchars > trie->maxlen) {
2719             trie->maxlen = maxchars;
2720         }
2721     } /* end first pass */
2722     DEBUG_TRIE_COMPILE_r(
2723         Perl_re_indentf( aTHX_
2724                 "TRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2725                 depth+1,
2726                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2727                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2728                 (int)trie->minlen, (int)trie->maxlen )
2729     );
2730
2731     /*
2732         We now know what we are dealing with in terms of unique chars and
2733         string sizes so we can calculate how much memory a naive
2734         representation using a flat table  will take. If it's over a reasonable
2735         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2736         conservative but potentially much slower representation using an array
2737         of lists.
2738
2739         At the end we convert both representations into the same compressed
2740         form that will be used in regexec.c for matching with. The latter
2741         is a form that cannot be used to construct with but has memory
2742         properties similar to the list form and access properties similar
2743         to the table form making it both suitable for fast searches and
2744         small enough that its feasable to store for the duration of a program.
2745
2746         See the comment in the code where the compressed table is produced
2747         inplace from the flat tabe representation for an explanation of how
2748         the compression works.
2749
2750     */
2751
2752
2753     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2754     prev_states[1] = 0;
2755
2756     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2757                                                     > SvIV(re_trie_maxbuff) )
2758     {
2759         /*
2760             Second Pass -- Array Of Lists Representation
2761
2762             Each state will be represented by a list of charid:state records
2763             (reg_trie_trans_le) the first such element holds the CUR and LEN
2764             points of the allocated array. (See defines above).
2765
2766             We build the initial structure using the lists, and then convert
2767             it into the compressed table form which allows faster lookups
2768             (but cant be modified once converted).
2769         */
2770
2771         STRLEN transcount = 1;
2772
2773         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using list compiler\n",
2774             depth+1));
2775
2776         trie->states = (reg_trie_state *)
2777             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2778                                   sizeof(reg_trie_state) );
2779         TRIE_LIST_NEW(1);
2780         next_alloc = 2;
2781
2782         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2783
2784             regnode *noper   = NEXTOPER( cur );
2785             U32 state        = 1;         /* required init */
2786             U16 charid       = 0;         /* sanity init */
2787             U32 wordlen      = 0;         /* required init */
2788
2789             if (OP(noper) == NOTHING) {
2790                 regnode *noper_next= regnext(noper);
2791                 if (noper_next < tail)
2792                     noper= noper_next;
2793             }
2794
2795             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
2796                 const U8 *uc= (U8*)STRING(noper);
2797                 const U8 *e= uc + STR_LEN(noper);
2798
2799                 for ( ; uc < e ; uc += len ) {
2800
2801                     TRIE_READ_CHAR;
2802
2803                     if ( uvc < 256 ) {
2804                         charid = trie->charmap[ uvc ];
2805                     } else {
2806                         SV** const svpp = hv_fetch( widecharmap,
2807                                                     (char*)&uvc,
2808                                                     sizeof( UV ),
2809                                                     0);
2810                         if ( !svpp ) {
2811                             charid = 0;
2812                         } else {
2813                             charid=(U16)SvIV( *svpp );
2814                         }
2815                     }
2816                     /* charid is now 0 if we dont know the char read, or
2817                      * nonzero if we do */
2818                     if ( charid ) {
2819
2820                         U16 check;
2821                         U32 newstate = 0;
2822
2823                         charid--;
2824                         if ( !trie->states[ state ].trans.list ) {
2825                             TRIE_LIST_NEW( state );
2826                         }
2827                         for ( check = 1;
2828                               check <= TRIE_LIST_USED( state );
2829                               check++ )
2830                         {
2831                             if ( TRIE_LIST_ITEM( state, check ).forid
2832                                                                     == charid )
2833                             {
2834                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2835                                 break;
2836                             }
2837                         }
2838                         if ( ! newstate ) {
2839                             newstate = next_alloc++;
2840                             prev_states[newstate] = state;
2841                             TRIE_LIST_PUSH( state, charid, newstate );
2842                             transcount++;
2843                         }
2844                         state = newstate;
2845                     } else {
2846                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
2847                     }
2848                 }
2849             }
2850             TRIE_HANDLE_WORD(state);
2851
2852         } /* end second pass */
2853
2854         /* next alloc is the NEXT state to be allocated */
2855         trie->statecount = next_alloc;
2856         trie->states = (reg_trie_state *)
2857             PerlMemShared_realloc( trie->states,
2858                                    next_alloc
2859                                    * sizeof(reg_trie_state) );
2860
2861         /* and now dump it out before we compress it */
2862         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2863                                                          revcharmap, next_alloc,
2864                                                          depth+1)
2865         );
2866
2867         trie->trans = (reg_trie_trans *)
2868             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2869         {
2870             U32 state;
2871             U32 tp = 0;
2872             U32 zp = 0;
2873
2874
2875             for( state=1 ; state < next_alloc ; state ++ ) {
2876                 U32 base=0;
2877
2878                 /*
2879                 DEBUG_TRIE_COMPILE_MORE_r(
2880                     Perl_re_printf( aTHX_  "tp: %d zp: %d ",tp,zp)
2881                 );
2882                 */
2883
2884                 if (trie->states[state].trans.list) {
2885                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2886                     U16 maxid=minid;
2887                     U16 idx;
2888
2889                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2890                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2891                         if ( forid < minid ) {
2892                             minid=forid;
2893                         } else if ( forid > maxid ) {
2894                             maxid=forid;
2895                         }
2896                     }
2897                     if ( transcount < tp + maxid - minid + 1) {
2898                         transcount *= 2;
2899                         trie->trans = (reg_trie_trans *)
2900                             PerlMemShared_realloc( trie->trans,
2901                                                      transcount
2902                                                      * sizeof(reg_trie_trans) );
2903                         Zero( trie->trans + (transcount / 2),
2904                               transcount / 2,
2905                               reg_trie_trans );
2906                     }
2907                     base = trie->uniquecharcount + tp - minid;
2908                     if ( maxid == minid ) {
2909                         U32 set = 0;
2910                         for ( ; zp < tp ; zp++ ) {
2911                             if ( ! trie->trans[ zp ].next ) {
2912                                 base = trie->uniquecharcount + zp - minid;
2913                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2914                                                                    1).newstate;
2915                                 trie->trans[ zp ].check = state;
2916                                 set = 1;
2917                                 break;
2918                             }
2919                         }
2920                         if ( !set ) {
2921                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2922                                                                    1).newstate;
2923                             trie->trans[ tp ].check = state;
2924                             tp++;
2925                             zp = tp;
2926                         }
2927                     } else {
2928                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2929                             const U32 tid = base
2930                                            - trie->uniquecharcount
2931                                            + TRIE_LIST_ITEM( state, idx ).forid;
2932                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2933                                                                 idx ).newstate;
2934                             trie->trans[ tid ].check = state;
2935                         }
2936                         tp += ( maxid - minid + 1 );
2937                     }
2938                     Safefree(trie->states[ state ].trans.list);
2939                 }
2940                 /*
2941                 DEBUG_TRIE_COMPILE_MORE_r(
2942                     Perl_re_printf( aTHX_  " base: %d\n",base);
2943                 );
2944                 */
2945                 trie->states[ state ].trans.base=base;
2946             }
2947             trie->lasttrans = tp + 1;
2948         }
2949     } else {
2950         /*
2951            Second Pass -- Flat Table Representation.
2952
2953            we dont use the 0 slot of either trans[] or states[] so we add 1 to
2954            each.  We know that we will need Charcount+1 trans at most to store
2955            the data (one row per char at worst case) So we preallocate both
2956            structures assuming worst case.
2957
2958            We then construct the trie using only the .next slots of the entry
2959            structs.
2960
2961            We use the .check field of the first entry of the node temporarily
2962            to make compression both faster and easier by keeping track of how
2963            many non zero fields are in the node.
2964
2965            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
2966            transition.
2967
2968            There are two terms at use here: state as a TRIE_NODEIDX() which is
2969            a number representing the first entry of the node, and state as a
2970            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
2971            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
2972            if there are 2 entrys per node. eg:
2973
2974              A B       A B
2975           1. 2 4    1. 3 7
2976           2. 0 3    3. 0 5
2977           3. 0 0    5. 0 0
2978           4. 0 0    7. 0 0
2979
2980            The table is internally in the right hand, idx form. However as we
2981            also have to deal with the states array which is indexed by nodenum
2982            we have to use TRIE_NODENUM() to convert.
2983
2984         */
2985         DEBUG_TRIE_COMPILE_MORE_r( Perl_re_indentf( aTHX_  "Compiling trie using table compiler\n",
2986             depth+1));
2987
2988         trie->trans = (reg_trie_trans *)
2989             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2990                                   * trie->uniquecharcount + 1,
2991                                   sizeof(reg_trie_trans) );
2992         trie->states = (reg_trie_state *)
2993             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2994                                   sizeof(reg_trie_state) );
2995         next_alloc = trie->uniquecharcount + 1;
2996
2997
2998         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2999
3000             regnode *noper   = NEXTOPER( cur );
3001
3002             U32 state        = 1;         /* required init */
3003
3004             U16 charid       = 0;         /* sanity init */
3005             U32 accept_state = 0;         /* sanity init */
3006
3007             U32 wordlen      = 0;         /* required init */
3008
3009             if (OP(noper) == NOTHING) {
3010                 regnode *noper_next= regnext(noper);
3011                 if (noper_next < tail)
3012                     noper= noper_next;
3013             }
3014
3015             if ( noper < tail && ( OP(noper) == flags || ( flags == EXACTFU && OP(noper) == EXACTFU_SS ) ) ) {
3016                 const U8 *uc= (U8*)STRING(noper);
3017                 const U8 *e= uc + STR_LEN(noper);
3018
3019                 for ( ; uc < e ; uc += len ) {
3020
3021                     TRIE_READ_CHAR;
3022
3023                     if ( uvc < 256 ) {
3024                         charid = trie->charmap[ uvc ];
3025                     } else {
3026                         SV* const * const svpp = hv_fetch( widecharmap,
3027                                                            (char*)&uvc,
3028                                                            sizeof( UV ),
3029                                                            0);
3030                         charid = svpp ? (U16)SvIV(*svpp) : 0;
3031                     }
3032                     if ( charid ) {
3033                         charid--;
3034                         if ( !trie->trans[ state + charid ].next ) {
3035                             trie->trans[ state + charid ].next = next_alloc;
3036                             trie->trans[ state ].check++;
3037                             prev_states[TRIE_NODENUM(next_alloc)]
3038                                     = TRIE_NODENUM(state);
3039                             next_alloc += trie->uniquecharcount;
3040                         }
3041                         state = trie->trans[ state + charid ].next;
3042                     } else {
3043                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %" IVdf, uvc );
3044                     }
3045                     /* charid is now 0 if we dont know the char read, or
3046                      * nonzero if we do */
3047                 }
3048             }
3049             accept_state = TRIE_NODENUM( state );
3050             TRIE_HANDLE_WORD(accept_state);
3051
3052         } /* end second pass */
3053
3054         /* and now dump it out before we compress it */
3055         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
3056                                                           revcharmap,
3057                                                           next_alloc, depth+1));
3058
3059         {
3060         /*
3061            * Inplace compress the table.*
3062
3063            For sparse data sets the table constructed by the trie algorithm will
3064            be mostly 0/FAIL transitions or to put it another way mostly empty.
3065            (Note that leaf nodes will not contain any transitions.)
3066
3067            This algorithm compresses the tables by eliminating most such
3068            transitions, at the cost of a modest bit of extra work during lookup:
3069
3070            - Each states[] entry contains a .base field which indicates the
3071            index in the state[] array wheres its transition data is stored.
3072
3073            - If .base is 0 there are no valid transitions from that node.
3074
3075            - If .base is nonzero then charid is added to it to find an entry in
3076            the trans array.
3077
3078            -If trans[states[state].base+charid].check!=state then the
3079            transition is taken to be a 0/Fail transition. Thus if there are fail
3080            transitions at the front of the node then the .base offset will point
3081            somewhere inside the previous nodes data (or maybe even into a node
3082            even earlier), but the .check field determines if the transition is
3083            valid.
3084
3085            XXX - wrong maybe?
3086            The following process inplace converts the table to the compressed
3087            table: We first do not compress the root node 1,and mark all its
3088            .check pointers as 1 and set its .base pointer as 1 as well. This
3089            allows us to do a DFA construction from the compressed table later,
3090            and ensures that any .base pointers we calculate later are greater
3091            than 0.
3092
3093            - We set 'pos' to indicate the first entry of the second node.
3094
3095            - We then iterate over the columns of the node, finding the first and
3096            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
3097            and set the .check pointers accordingly, and advance pos
3098            appropriately and repreat for the next node. Note that when we copy
3099            the next pointers we have to convert them from the original
3100            NODEIDX form to NODENUM form as the former is not valid post
3101            compression.
3102
3103            - If a node has no transitions used we mark its base as 0 and do not
3104            advance the pos pointer.
3105
3106            - If a node only has one transition we use a second pointer into the
3107            structure to fill in allocated fail transitions from other states.
3108            This pointer is independent of the main pointer and scans forward
3109            looking for null transitions that are allocated to a state. When it
3110            finds one it writes the single transition into the "hole".  If the
3111            pointer doesnt find one the single transition is appended as normal.
3112
3113            - Once compressed we can Renew/realloc the structures to release the
3114            excess space.
3115
3116            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
3117            specifically Fig 3.47 and the associated pseudocode.
3118
3119            demq
3120         */
3121         const U32 laststate = TRIE_NODENUM( next_alloc );
3122         U32 state, charid;
3123         U32 pos = 0, zp=0;
3124         trie->statecount = laststate;
3125
3126         for ( state = 1 ; state < laststate ; state++ ) {
3127             U8 flag = 0;
3128             const U32 stateidx = TRIE_NODEIDX( state );
3129             const U32 o_used = trie->trans[ stateidx ].check;
3130             U32 used = trie->trans[ stateidx ].check;
3131             trie->trans[ stateidx ].check = 0;
3132
3133             for ( charid = 0;
3134                   used && charid < trie->uniquecharcount;
3135                   charid++ )
3136             {
3137                 if ( flag || trie->trans[ stateidx + charid ].next ) {
3138                     if ( trie->trans[ stateidx + charid ].next ) {
3139                         if (o_used == 1) {
3140                             for ( ; zp < pos ; zp++ ) {
3141                                 if ( ! trie->trans[ zp ].next ) {
3142                                     break;
3143                                 }
3144                             }
3145                             trie->states[ state ].trans.base
3146                                                     = zp
3147                                                       + trie->uniquecharcount
3148                                                       - charid ;
3149                             trie->trans[ zp ].next
3150                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
3151                                                              + charid ].next );
3152                             trie->trans[ zp ].check = state;
3153                             if ( ++zp > pos ) pos = zp;
3154                             break;
3155                         }
3156                         used--;
3157                     }
3158                     if ( !flag ) {
3159                         flag = 1;
3160                         trie->states[ state ].trans.base
3161                                        = pos + trie->uniquecharcount - charid ;
3162                     }
3163                     trie->trans[ pos ].next
3164                         = SAFE_TRIE_NODENUM(
3165                                        trie->trans[ stateidx + charid ].next );
3166                     trie->trans[ pos ].check = state;
3167                     pos++;
3168                 }
3169             }
3170         }
3171         trie->lasttrans = pos + 1;
3172         trie->states = (reg_trie_state *)
3173             PerlMemShared_realloc( trie->states, laststate
3174                                    * sizeof(reg_trie_state) );
3175         DEBUG_TRIE_COMPILE_MORE_r(
3176             Perl_re_indentf( aTHX_  "Alloc: %d Orig: %" IVdf " elements, Final:%" IVdf ". Savings of %%%5.2f\n",
3177                 depth+1,
3178                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
3179                        + 1 ),
3180                 (IV)next_alloc,
3181                 (IV)pos,
3182                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
3183             );
3184
3185         } /* end table compress */
3186     }
3187     DEBUG_TRIE_COMPILE_MORE_r(
3188             Perl_re_indentf( aTHX_  "Statecount:%" UVxf " Lasttrans:%" UVxf "\n",
3189                 depth+1,
3190                 (UV)trie->statecount,
3191                 (UV)trie->lasttrans)
3192     );
3193     /* resize the trans array to remove unused space */
3194     trie->trans = (reg_trie_trans *)
3195         PerlMemShared_realloc( trie->trans, trie->lasttrans
3196                                * sizeof(reg_trie_trans) );
3197
3198     {   /* Modify the program and insert the new TRIE node */
3199         U8 nodetype =(U8)(flags & 0xFF);
3200         char *str=NULL;
3201
3202 #ifdef DEBUGGING
3203         regnode *optimize = NULL;
3204 #ifdef RE_TRACK_PATTERN_OFFSETS
3205
3206         U32 mjd_offset = 0;
3207         U32 mjd_nodelen = 0;
3208 #endif /* RE_TRACK_PATTERN_OFFSETS */
3209 #endif /* DEBUGGING */
3210         /*
3211            This means we convert either the first branch or the first Exact,
3212            depending on whether the thing following (in 'last') is a branch
3213            or not and whther first is the startbranch (ie is it a sub part of
3214            the alternation or is it the whole thing.)
3215            Assuming its a sub part we convert the EXACT otherwise we convert
3216            the whole branch sequence, including the first.
3217          */
3218         /* Find the node we are going to overwrite */
3219         if ( first != startbranch || OP( last ) == BRANCH ) {
3220             /* branch sub-chain */
3221             NEXT_OFF( first ) = (U16)(last - first);
3222 #ifdef RE_TRACK_PATTERN_OFFSETS
3223             DEBUG_r({
3224                 mjd_offset= Node_Offset((convert));
3225                 mjd_nodelen= Node_Length((convert));
3226             });
3227 #endif
3228             /* whole branch chain */
3229         }
3230 #ifdef RE_TRACK_PATTERN_OFFSETS
3231         else {
3232             DEBUG_r({
3233                 const  regnode *nop = NEXTOPER( convert );
3234                 mjd_offset= Node_Offset((nop));
3235                 mjd_nodelen= Node_Length((nop));
3236             });
3237         }
3238         DEBUG_OPTIMISE_r(
3239             Perl_re_indentf( aTHX_  "MJD offset:%" UVuf " MJD length:%" UVuf "\n",
3240                 depth+1,
3241                 (UV)mjd_offset, (UV)mjd_nodelen)
3242         );
3243 #endif
3244         /* But first we check to see if there is a common prefix we can
3245            split out as an EXACT and put in front of the TRIE node.  */
3246         trie->startstate= 1;
3247         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
3248             /* we want to find the first state that has more than
3249              * one transition, if that state is not the first state
3250              * then we have a common prefix which we can remove.
3251              */
3252             U32 state;
3253             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
3254                 U32 ofs = 0;
3255                 I32 first_ofs = -1; /* keeps track of the ofs of the first
3256                                        transition, -1 means none */
3257                 U32 count = 0;
3258                 const U32 base = trie->states[ state ].trans.base;
3259
3260                 /* does this state terminate an alternation? */
3261                 if ( trie->states[state].wordnum )
3262                         count = 1;
3263
3264                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
3265                     if ( ( base + ofs >= trie->uniquecharcount ) &&
3266                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
3267                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
3268                     {
3269                         if ( ++count > 1 ) {
3270                             /* we have more than one transition */
3271                             SV **tmp;
3272                             U8 *ch;
3273                             /* if this is the first state there is no common prefix
3274                              * to extract, so we can exit */
3275                             if ( state == 1 ) break;
3276                             tmp = av_fetch( revcharmap, ofs, 0);
3277                             ch = (U8*)SvPV_nolen_const( *tmp );
3278
3279                             /* if we are on count 2 then we need to initialize the
3280                              * bitmap, and store the previous char if there was one
3281                              * in it*/
3282                             if ( count == 2 ) {
3283                                 /* clear the bitmap */
3284                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
3285                                 DEBUG_OPTIMISE_r(
3286                                     Perl_re_indentf( aTHX_  "New Start State=%" UVuf " Class: [",
3287                                         depth+1,
3288                                         (UV)state));
3289                                 if (first_ofs >= 0) {
3290                                     SV ** const tmp = av_fetch( revcharmap, first_ofs, 0);
3291                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
3292
3293                                     TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3294                                     DEBUG_OPTIMISE_r(
3295                                         Perl_re_printf( aTHX_  "%s", (char*)ch)
3296                                     );
3297                                 }
3298                             }
3299                             /* store the current firstchar in the bitmap */
3300                             TRIE_BITMAP_SET_FOLDED(trie,*ch,folder);
3301                             DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "%s", ch));
3302                         }
3303                         first_ofs = ofs;
3304                     }
3305                 }
3306                 if ( count == 1 ) {
3307                     /* This state has only one transition, its transition is part
3308                      * of a common prefix - we need to concatenate the char it
3309                      * represents to what we have so far. */
3310                     SV **tmp = av_fetch( revcharmap, first_ofs, 0);
3311                     STRLEN len;
3312                     char *ch = SvPV( *tmp, len );
3313                     DEBUG_OPTIMISE_r({
3314                         SV *sv=sv_newmortal();
3315                         Perl_re_indentf( aTHX_  "Prefix State: %" UVuf " Ofs:%" UVuf " Char='%s'\n",
3316                             depth+1,
3317                             (UV)state, (UV)first_ofs,
3318                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
3319                                 PL_colors[0], PL_colors[1],
3320                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
3321                                 PERL_PV_ESCAPE_FIRSTCHAR
3322                             )
3323                         );
3324                     });
3325                     if ( state==1 ) {
3326                         OP( convert ) = nodetype;
3327                         str=STRING(convert);
3328                         STR_LEN(convert)=0;
3329                     }
3330                     STR_LEN(convert) += len;
3331                     while (len--)
3332                         *str++ = *ch++;
3333                 } else {
3334 #ifdef DEBUGGING
3335                     if (state>1)
3336                         DEBUG_OPTIMISE_r(Perl_re_printf( aTHX_ "]\n"));
3337 #endif
3338                     break;
3339                 }
3340             }
3341             trie->prefixlen = (state-1);
3342             if (str) {
3343                 regnode *n = convert+NODE_SZ_STR(convert);
3344                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
3345                 trie->startstate = state;
3346                 trie->minlen -= (state - 1);
3347                 trie->maxlen -= (state - 1);
3348 #ifdef DEBUGGING
3349                /* At least the UNICOS C compiler choked on this
3350                 * being argument to DEBUG_r(), so let's just have
3351                 * it right here. */
3352                if (
3353 #ifdef PERL_EXT_RE_BUILD
3354                    1
3355 #else
3356                    DEBUG_r_TEST
3357 #endif
3358                    ) {
3359                    regnode *fix = convert;
3360                    U32 word = trie->wordcount;
3361                    mjd_nodelen++;
3362                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
3363                    while( ++fix < n ) {
3364                        Set_Node_Offset_Length(fix, 0, 0);
3365                    }
3366                    while (word--) {
3367                        SV ** const tmp = av_fetch( trie_words, word, 0 );
3368                        if (tmp) {
3369                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
3370                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
3371                            else
3372                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
3373                        }
3374                    }
3375                }
3376 #endif
3377                 if (trie->maxlen) {
3378                     convert = n;
3379                 } else {
3380                     NEXT_OFF(convert) = (U16)(tail - convert);
3381                     DEBUG_r(optimize= n);
3382                 }
3383             }
3384         }
3385         if (!jumper)
3386             jumper = last;
3387         if ( trie->maxlen ) {
3388             NEXT_OFF( convert ) = (U16)(tail - convert);
3389             ARG_SET( convert, data_slot );
3390             /* Store the offset to the first unabsorbed branch in
3391                jump[0], which is otherwise unused by the jump logic.
3392                We use this when dumping a trie and during optimisation. */
3393             if (trie->jump)
3394                 trie->jump[0] = (U16)(nextbranch - convert);
3395
3396             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
3397              *   and there is a bitmap
3398              *   and the first "jump target" node we found leaves enough room
3399              * then convert the TRIE node into a TRIEC node, with the bitmap
3400              * embedded inline in the opcode - this is hypothetically faster.
3401              */
3402             if ( !trie->states[trie->startstate].wordnum
3403                  && trie->bitmap
3404                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
3405             {
3406                 OP( convert ) = TRIEC;
3407                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
3408                 PerlMemShared_free(trie->bitmap);
3409                 trie->bitmap= NULL;
3410             } else
3411                 OP( convert ) = TRIE;
3412
3413             /* store the type in the flags */
3414             convert->flags = nodetype;
3415             DEBUG_r({
3416             optimize = convert
3417                       + NODE_STEP_REGNODE
3418                       + regarglen[ OP( convert ) ];
3419             });
3420             /* XXX We really should free up the resource in trie now,
3421                    as we won't use them - (which resources?) dmq */
3422         }
3423         /* needed for dumping*/
3424         DEBUG_r(if (optimize) {
3425             regnode *opt = convert;
3426
3427             while ( ++opt < optimize) {
3428                 Set_Node_Offset_Length(opt,0,0);
3429             }
3430             /*
3431                 Try to clean up some of the debris left after the
3432                 optimisation.
3433              */
3434             while( optimize < jumper ) {
3435                 mjd_nodelen += Node_Length((optimize));
3436                 OP( optimize ) = OPTIMIZED;
3437                 Set_Node_Offset_Length(optimize,0,0);
3438                 optimize++;
3439             }
3440             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
3441         });
3442     } /* end node insert */
3443
3444     /*  Finish populating the prev field of the wordinfo array.  Walk back
3445      *  from each accept state until we find another accept state, and if
3446      *  so, point the first word's .prev field at the second word. If the
3447      *  second already has a .prev field set, stop now. This will be the
3448      *  case either if we've already processed that word's accept state,
3449      *  or that state had multiple words, and the overspill words were
3450      *  already linked up earlier.
3451      */
3452     {
3453         U16 word;
3454         U32 state;
3455         U16 prev;
3456
3457         for (word=1; word <= trie->wordcount; word++) {
3458             prev = 0;
3459             if (trie->wordinfo[word].prev)
3460                 continue;
3461             state = trie->wordinfo[word].accept;
3462             while (state) {
3463                 state = prev_states[state];
3464                 if (!state)
3465                     break;
3466                 prev = trie->states[state].wordnum;
3467                 if (prev)
3468                     break;
3469             }
3470             trie->wordinfo[word].prev = prev;
3471         }
3472         Safefree(prev_states);
3473     }
3474
3475
3476     /* and now dump out the compressed format */
3477     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
3478
3479     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
3480 #ifdef DEBUGGING
3481     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
3482     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
3483 #else
3484     SvREFCNT_dec_NN(revcharmap);
3485 #endif
3486     return trie->jump
3487            ? MADE_JUMP_TRIE
3488            : trie->startstate>1
3489              ? MADE_EXACT_TRIE
3490              : MADE_TRIE;
3491 }
3492
3493 STATIC regnode *
3494 S_construct_ahocorasick_from_trie(pTHX_ RExC_state_t *pRExC_state, regnode *source, U32 depth)
3495 {
3496 /* The Trie is constructed and compressed now so we can build a fail array if
3497  * it's needed
3498
3499    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
3500    3.32 in the
3501    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
3502    Ullman 1985/88
3503    ISBN 0-201-10088-6
3504
3505    We find the fail state for each state in the trie, this state is the longest
3506    proper suffix of the current state's 'word' that is also a proper prefix of
3507    another word in our trie. State 1 represents the word '' and is thus the
3508    default fail state. This allows the DFA not to have to restart after its
3509    tried and failed a word at a given point, it simply continues as though it
3510    had been matching the other word in the first place.
3511    Consider
3512       'abcdgu'=~/abcdefg|cdgu/
3513    When we get to 'd' we are still matching the first word, we would encounter
3514    'g' which would fail, which would bring us to the state representing 'd' in
3515    the second word where we would try 'g' and succeed, proceeding to match
3516    'cdgu'.
3517  */
3518  /* add a fail transition */
3519     const U32 trie_offset = ARG(source);
3520     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
3521     U32 *q;
3522     const U32 ucharcount = trie->uniquecharcount;
3523     const U32 numstates = trie->statecount;
3524     const U32 ubound = trie->lasttrans + ucharcount;
3525     U32 q_read = 0;
3526     U32 q_write = 0;
3527     U32 charid;
3528     U32 base = trie->states[ 1 ].trans.base;
3529     U32 *fail;
3530     reg_ac_data *aho;
3531     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
3532     regnode *stclass;
3533     GET_RE_DEBUG_FLAGS_DECL;
3534
3535     PERL_ARGS_ASSERT_CONSTRUCT_AHOCORASICK_FROM_TRIE;
3536     PERL_UNUSED_CONTEXT;
3537 #ifndef DEBUGGING
3538     PERL_UNUSED_ARG(depth);
3539 #endif
3540
3541     if ( OP(source) == TRIE ) {
3542         struct regnode_1 *op = (struct regnode_1 *)
3543             PerlMemShared_calloc(1, sizeof(struct regnode_1));
3544         StructCopy(source,op,struct regnode_1);
3545         stclass = (regnode *)op;
3546     } else {
3547         struct regnode_charclass *op = (struct regnode_charclass *)
3548             PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
3549         StructCopy(source,op,struct regnode_charclass);
3550         stclass = (regnode *)op;
3551     }
3552     OP(stclass)+=2; /* convert the TRIE type to its AHO-CORASICK equivalent */
3553
3554     ARG_SET( stclass, data_slot );
3555     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3556     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3557     aho->trie=trie_offset;
3558     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3559     Copy( trie->states, aho->states, numstates, reg_trie_state );
3560     Newxz( q, numstates, U32);
3561     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3562     aho->refcount = 1;
3563     fail = aho->fail;
3564     /* initialize fail[0..1] to be 1 so that we always have
3565        a valid final fail state */
3566     fail[ 0 ] = fail[ 1 ] = 1;
3567
3568     for ( charid = 0; charid < ucharcount ; charid++ ) {
3569         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3570         if ( newstate ) {
3571             q[ q_write ] = newstate;
3572             /* set to point at the root */
3573             fail[ q[ q_write++ ] ]=1;
3574         }
3575     }
3576     while ( q_read < q_write) {
3577         const U32 cur = q[ q_read++ % numstates ];
3578         base = trie->states[ cur ].trans.base;
3579
3580         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3581             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3582             if (ch_state) {
3583                 U32 fail_state = cur;
3584                 U32 fail_base;
3585                 do {
3586                     fail_state = fail[ fail_state ];
3587                     fail_base = aho->states[ fail_state ].trans.base;
3588                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3589
3590                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3591                 fail[ ch_state ] = fail_state;
3592                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3593                 {
3594                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3595                 }
3596                 q[ q_write++ % numstates] = ch_state;
3597             }
3598         }
3599     }
3600     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3601        when we fail in state 1, this allows us to use the
3602        charclass scan to find a valid start char. This is based on the principle
3603        that theres a good chance the string being searched contains lots of stuff
3604        that cant be a start char.
3605      */
3606     fail[ 0 ] = fail[ 1 ] = 0;
3607     DEBUG_TRIE_COMPILE_r({
3608         Perl_re_indentf( aTHX_  "Stclass Failtable (%" UVuf " states): 0",
3609                       depth, (UV)numstates
3610         );
3611         for( q_read=1; q_read<numstates; q_read++ ) {
3612             Perl_re_printf( aTHX_  ", %" UVuf, (UV)fail[q_read]);
3613         }
3614         Perl_re_printf( aTHX_  "\n");
3615     });
3616     Safefree(q);
3617     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3618     return stclass;
3619 }
3620
3621
3622 #define DEBUG_PEEP(str,scan,depth)         \
3623     DEBUG_OPTIMISE_r({if (scan){           \
3624        regnode *Next = regnext(scan);      \
3625        regprop(RExC_rx, RExC_mysv, scan, NULL, pRExC_state);\
3626        Perl_re_indentf( aTHX_  "" str ">%3d: %s (%d)", \
3627            depth, REG_NODE_NUM(scan), SvPV_nolen_const(RExC_mysv),\
3628            Next ? (REG_NODE_NUM(Next)) : 0 );\
3629        DEBUG_SHOW_STUDY_FLAGS(flags," [ ","]");\
3630        Perl_re_printf( aTHX_  "\n");                   \
3631    }});
3632
3633 /* The below joins as many adjacent EXACTish nodes as possible into a single
3634  * one.  The regop may be changed if the node(s) contain certain sequences that
3635  * require special handling.  The joining is only done if:
3636  * 1) there is room in the current conglomerated node to entirely contain the
3637  *    next one.
3638  * 2) they are the exact same node type
3639  *
3640  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3641  * these get optimized out
3642  *
3643  * XXX khw thinks this should be enhanced to fill EXACT (at least) nodes as full
3644  * as possible, even if that means splitting an existing node so that its first
3645  * part is moved to the preceeding node.  This would maximise the efficiency of
3646  * memEQ during matching.  Elsewhere in this file, khw proposes splitting
3647  * EXACTFish nodes into portions that don't change under folding vs those that
3648  * do.  Those portions that don't change may be the only things in the pattern that
3649  * could be used to find fixed and floating strings.
3650  *
3651  * If a node is to match under /i (folded), the number of characters it matches
3652  * can be different than its character length if it contains a multi-character
3653  * fold.  *min_subtract is set to the total delta number of characters of the
3654  * input nodes.
3655  *
3656  * And *unfolded_multi_char is set to indicate whether or not the node contains
3657  * an unfolded multi-char fold.  This happens when whether the fold is valid or
3658  * not won't be known until runtime; namely for EXACTF nodes that contain LATIN
3659  * SMALL LETTER SHARP S, as only if the target string being matched against
3660  * turns out to be UTF-8 is that fold valid; and also for EXACTFL nodes whose
3661  * folding rules depend on the locale in force at runtime.  (Multi-char folds
3662  * whose components are all above the Latin1 range are not run-time locale
3663  * dependent, and have already been folded by the time this function is
3664  * called.)
3665  *
3666  * This is as good a place as any to discuss the design of handling these
3667  * multi-character fold sequences.  It's been wrong in Perl for a very long
3668  * time.  There are three code points in Unicode whose multi-character folds
3669  * were long ago discovered to mess things up.  The previous designs for
3670  * dealing with these involved assigning a special node for them.  This
3671  * approach doesn't always work, as evidenced by this example:
3672  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3673  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3674  * would match just the \xDF, it won't be able to handle the case where a
3675  * successful match would have to cross the node's boundary.  The new approach
3676  * that hopefully generally solves the problem generates an EXACTFU_SS node
3677  * that is "sss" in this case.
3678  *
3679  * It turns out that there are problems with all multi-character folds, and not
3680  * just these three.  Now the code is general, for all such cases.  The
3681  * approach taken is:
3682  * 1)   This routine examines each EXACTFish node that could contain multi-
3683  *      character folded sequences.  Since a single character can fold into
3684  *      such a sequence, the minimum match length for this node is less than
3685  *      the number of characters in the node.  This routine returns in
3686  *      *min_subtract how many characters to subtract from the the actual
3687  *      length of the string to get a real minimum match length; it is 0 if
3688  *      there are no multi-char foldeds.  This delta is used by the caller to
3689  *      adjust the min length of the match, and the delta between min and max,
3690  *      so that the optimizer doesn't reject these possibilities based on size
3691  *      constraints.
3692  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3693  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3694  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3695  *      there is a possible fold length change.  That means that a regular
3696  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3697  *      with length changes, and so can be processed faster.  regexec.c takes
3698  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3699  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3700  *      known until runtime).  This saves effort in regex matching.  However,
3701  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3702  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3703  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3704  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3705  *      possibilities for the non-UTF8 patterns are quite simple, except for
3706  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3707  *      members of a fold-pair, and arrays are set up for all of them so that
3708  *      the other member of the pair can be found quickly.  Code elsewhere in
3709  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3710  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3711  *      described in the next item.
3712  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3713  *      validity of the fold won't be known until runtime, and so must remain
3714  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFA
3715  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3716  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3717  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3718  *      The reason this is a problem is that the optimizer part of regexec.c
3719  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3720  *      that a character in the pattern corresponds to at most a single
3721  *      character in the target string.  (And I do mean character, and not byte
3722  *      here, unlike other parts of the documentation that have never been
3723  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3724  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFA nodes
3725  *      it can match "\x{17F}\x{17F}".  These, along with other ones in EXACTFL
3726  *      nodes, violate the assumption, and they are the only instances where it
3727  *      is violated.  I'm reluctant to try to change the assumption, as the
3728  *      code involved is impenetrable to me (khw), so instead the code here
3729  *      punts.  This routine examines EXACTFL nodes, and (when the pattern
3730  *      isn't UTF-8) EXACTF and EXACTFA for such unfolded folds, and returns a
3731  *      boolean indicating whether or not the node contains such a fold.  When
3732  *      it is true, the caller sets a flag that later causes the optimizer in
3733  *      this file to not set values for the floating and fixed string lengths,
3734  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3735  *      assumption.  Thus, there is no optimization based on string lengths for
3736  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3737  *      EXACTF and EXACTFA nodes that contain the sharp s.  (The reason the
3738  *      assumption is wrong only in these cases is that all other non-UTF-8
3739  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3740  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3741  *      EXACTF nodes because we don't know at compile time if it actually
3742  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3743  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3744  *      always matches; and EXACTFA where it never does.  In an EXACTFA node in
3745  *      a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3746  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3747  *      string would require the pattern to be forced into UTF-8, the overhead
3748  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3749  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3750  *      locale.)
3751  *
3752  *      Similarly, the code that generates tries doesn't currently handle
3753  *      not-already-folded multi-char folds, and it looks like a pain to change
3754  *      that.  Therefore, trie generation of EXACTFA nodes with the sharp s
3755  *      doesn't work.  Instead, such an EXACTFA is turned into a new regnode,
3756  *      EXACTFA_NO_TRIE, which the trie code knows not to handle.  Most people
3757  *      using /iaa matching will be doing so almost entirely with ASCII
3758  *      strings, so this should rarely be encountered in practice */
3759
3760 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3761     if (PL_regkind[OP(scan)] == EXACT) \
3762         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3763
3764 STATIC U32
3765 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3766                    UV *min_subtract, bool *unfolded_multi_char,
3767                    U32 flags,regnode *val, U32 depth)
3768 {
3769     /* Merge several consecutive EXACTish nodes into one. */
3770     regnode *n = regnext(scan);
3771     U32 stringok = 1;
3772     regnode *next = scan + NODE_SZ_STR(scan);
3773     U32 merged = 0;
3774     U32 stopnow = 0;
3775 #ifdef DEBUGGING
3776     regnode *stop = scan;
3777     GET_RE_DEBUG_FLAGS_DECL;
3778 #else
3779     PERL_UNUSED_ARG(depth);
3780 #endif
3781
3782     PERL_ARGS_ASSERT_JOIN_EXACT;
3783 #ifndef EXPERIMENTAL_INPLACESCAN
3784     PERL_UNUSED_ARG(flags);
3785     PERL_UNUSED_ARG(val);
3786 #endif
3787     DEBUG_PEEP("join",scan,depth);
3788
3789     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3790      * EXACT ones that are mergeable to the current one. */
3791     while (n
3792            && (PL_regkind[OP(n)] == NOTHING
3793                || (stringok && OP(n) == OP(scan)))
3794            && NEXT_OFF(n)
3795            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3796     {
3797
3798         if (OP(n) == TAIL || n > next)
3799             stringok = 0;
3800         if (PL_regkind[OP(n)] == NOTHING) {
3801             DEBUG_PEEP("skip:",n,depth);
3802             NEXT_OFF(scan) += NEXT_OFF(n);
3803             next = n + NODE_STEP_REGNODE;
3804 #ifdef DEBUGGING
3805             if (stringok)
3806                 stop = n;
3807 #endif
3808             n = regnext(n);
3809         }
3810         else if (stringok) {
3811             const unsigned int oldl = STR_LEN(scan);
3812             regnode * const nnext = regnext(n);
3813
3814             /* XXX I (khw) kind of doubt that this works on platforms (should
3815              * Perl ever run on one) where U8_MAX is above 255 because of lots
3816              * of other assumptions */
3817             /* Don't join if the sum can't fit into a single node */
3818             if (oldl + STR_LEN(n) > U8_MAX)
3819                 break;
3820
3821             DEBUG_PEEP("merg",n,depth);
3822             merged++;
3823
3824             NEXT_OFF(scan) += NEXT_OFF(n);
3825             STR_LEN(scan) += STR_LEN(n);
3826             next = n + NODE_SZ_STR(n);
3827             /* Now we can overwrite *n : */
3828             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3829 #ifdef DEBUGGING
3830             stop = next - 1;
3831 #endif
3832             n = nnext;
3833             if (stopnow) break;
3834         }
3835
3836 #ifdef EXPERIMENTAL_INPLACESCAN
3837         if (flags && !NEXT_OFF(n)) {
3838             DEBUG_PEEP("atch", val, depth);
3839             if (reg_off_by_arg[OP(n)]) {
3840                 ARG_SET(n, val - n);
3841             }
3842             else {
3843                 NEXT_OFF(n) = val - n;
3844             }
3845             stopnow = 1;
3846         }
3847 #endif
3848     }
3849
3850     *min_subtract = 0;
3851     *unfolded_multi_char = FALSE;
3852
3853     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3854      * can now analyze for sequences of problematic code points.  (Prior to
3855      * this final joining, sequences could have been split over boundaries, and
3856      * hence missed).  The sequences only happen in folding, hence for any
3857      * non-EXACT EXACTish node */
3858     if (OP(scan) != EXACT && OP(scan) != EXACTL) {
3859         U8* s0 = (U8*) STRING(scan);
3860         U8* s = s0;
3861         U8* s_end = s0 + STR_LEN(scan);
3862
3863         int total_count_delta = 0;  /* Total delta number of characters that
3864                                        multi-char folds expand to */
3865
3866         /* One pass is made over the node's string looking for all the
3867          * possibilities.  To avoid some tests in the loop, there are two main
3868          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3869          * non-UTF-8 */
3870         if (UTF) {
3871             U8* folded = NULL;
3872
3873             if (OP(scan) == EXACTFL) {
3874                 U8 *d;
3875
3876                 /* An EXACTFL node would already have been changed to another
3877                  * node type unless there is at least one character in it that
3878                  * is problematic; likely a character whose fold definition
3879                  * won't be known until runtime, and so has yet to be folded.
3880                  * For all but the UTF-8 locale, folds are 1-1 in length, but
3881                  * to handle the UTF-8 case, we need to create a temporary
3882                  * folded copy using UTF-8 locale rules in order to analyze it.
3883                  * This is because our macros that look to see if a sequence is
3884                  * a multi-char fold assume everything is folded (otherwise the
3885                  * tests in those macros would be too complicated and slow).
3886                  * Note that here, the non-problematic folds will have already
3887                  * been done, so we can just copy such characters.  We actually
3888                  * don't completely fold the EXACTFL string.  We skip the
3889                  * unfolded multi-char folds, as that would just create work
3890                  * below to figure out the size they already are */
3891
3892                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3893                 d = folded;
3894                 while (s < s_end) {
3895                     STRLEN s_len = UTF8SKIP(s);
3896                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3897                         Copy(s, d, s_len, U8);
3898                         d += s_len;
3899                     }
3900                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
3901                         *unfolded_multi_char = TRUE;
3902                         Copy(s, d, s_len, U8);
3903                         d += s_len;
3904                     }
3905                     else if (isASCII(*s)) {
3906                         *(d++) = toFOLD(*s);
3907                     }
3908                     else {
3909                         STRLEN len;
3910                         _toFOLD_utf8_flags(s, s_end, d, &len, FOLD_FLAGS_FULL);
3911                         d += len;
3912                     }
3913                     s += s_len;
3914                 }
3915
3916                 /* Point the remainder of the routine to look at our temporary
3917                  * folded copy */
3918                 s = folded;
3919                 s_end = d;
3920             } /* End of creating folded copy of EXACTFL string */
3921
3922             /* Examine the string for a multi-character fold sequence.  UTF-8
3923              * patterns have all characters pre-folded by the time this code is
3924              * executed */
3925             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
3926                                      length sequence we are looking for is 2 */
3927             {
3928                 int count = 0;  /* How many characters in a multi-char fold */
3929                 int len = is_MULTI_CHAR_FOLD_utf8_safe(s, s_end);
3930                 if (! len) {    /* Not a multi-char fold: get next char */
3931                     s += UTF8SKIP(s);
3932                     continue;
3933                 }
3934
3935                 /* Nodes with 'ss' require special handling, except for
3936                  * EXACTFA-ish for which there is no multi-char fold to this */
3937                 if (len == 2 && *s == 's' && *(s+1) == 's'
3938                     && OP(scan) != EXACTFA
3939                     && OP(scan) != EXACTFA_NO_TRIE)
3940                 {
3941                     count = 2;
3942                     if (OP(scan) != EXACTFL) {
3943                         OP(scan) = EXACTFU_SS;
3944                     }
3945                     s += 2;
3946                 }
3947                 else { /* Here is a generic multi-char fold. */
3948                     U8* multi_end  = s + len;
3949
3950                     /* Count how many characters are in it.  In the case of
3951                      * /aa, no folds which contain ASCII code points are
3952                      * allowed, so check for those, and skip if found. */
3953                     if (OP(scan) != EXACTFA && OP(scan) != EXACTFA_NO_TRIE) {
3954                         count = utf8_length(s, multi_end);
3955                         s = multi_end;
3956                     }
3957                     else {
3958                         while (s < multi_end) {
3959                             if (isASCII(*s)) {
3960                                 s++;
3961                                 goto next_iteration;
3962                             }
3963                             else {
3964                                 s += UTF8SKIP(s);
3965                             }
3966                             count++;
3967                         }
3968                     }
3969                 }
3970
3971                 /* The delta is how long the sequence is minus 1 (1 is how long
3972                  * the character that folds to the sequence is) */
3973                 total_count_delta += count - 1;
3974               next_iteration: ;
3975             }
3976
3977             /* We created a temporary folded copy of the string in EXACTFL
3978              * nodes.  Therefore we need to be sure it doesn't go below zero,
3