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