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