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