This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
c59c155fec5848258a60efe3cf73358628b30699
[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             ANYOF_POSIXL_AND((regnode_charclass_posixl*) and_with, ssc);
1275             ssc_union(ssc, anded_cp_list, FALSE);
1276         }
1277         else { /* P1 = P2 = empty */
1278             ssc_intersection(ssc, anded_cp_list, FALSE);
1279         }
1280     }
1281 }
1282
1283 STATIC void
1284 S_ssc_or(pTHX_ const RExC_state_t *pRExC_state, regnode_ssc *ssc,
1285                const regnode_charclass *or_with)
1286 {
1287     /* Accumulate into SSC 'ssc' its 'OR' with 'or_with', which is either
1288      * another SSC or a regular ANYOF class.  Can create false positives if
1289      * 'or_with' is to be inverted. */
1290
1291     SV* ored_cp_list;
1292     U8 ored_flags;
1293
1294     PERL_ARGS_ASSERT_SSC_OR;
1295
1296     assert(is_ANYOF_SYNTHETIC(ssc));
1297
1298     /* 'or_with' is used as-is if it too is an SSC; otherwise have to extract
1299      * the code point inversion list and just the relevant flags */
1300     if (is_ANYOF_SYNTHETIC(or_with)) {
1301         ored_cp_list = ((regnode_ssc*) or_with)->invlist;
1302         ored_flags = ANYOF_FLAGS(or_with);
1303     }
1304     else {
1305         ored_cp_list = get_ANYOF_cp_list_for_ssc(pRExC_state,
1306                                      (regnode_charclass_posixl*) or_with);
1307         ored_flags = ANYOF_FLAGS(or_with) & ANYOF_COMMON_FLAGS;
1308     }
1309
1310     ANYOF_FLAGS(ssc) |= ored_flags;
1311
1312     /* Below, C1 is the list of code points in 'ssc'; P1, its posix classes.
1313      * C2 is the list of code points in 'or-with'; P2, its posix classes.
1314      * 'or_with' may be inverted.  When not inverted, we have the simple
1315      * situation of computing:
1316      *  (C1 | P1) | (C2 | P2)  =  (C1 | C2) | (P1 | P2)
1317      * If P1|P2 yields a situation with both a class and its complement are
1318      * set, like having both \w and \W, this matches all code points, and we
1319      * can delete these from the P component of the ssc going forward.  XXX We
1320      * might be able to delete all the P components, but I (khw) am not certain
1321      * about this, and it is better to be safe.
1322      *
1323      * Inverted, we have
1324      *  (C1 | P1) | ~(C2 | P2)  =  (C1 | P1) | (~C2 & ~P2)
1325      *                         <=  (C1 | P1) | ~C2
1326      *                         <=  (C1 | ~C2) | P1
1327      * (which results in actually simpler code than the non-inverted case)
1328      * */
1329
1330     if ((ANYOF_FLAGS(or_with) & ANYOF_INVERT)
1331         && ! is_ANYOF_SYNTHETIC(or_with))
1332     {
1333         /* We ignore P2, leaving P1 going forward */
1334     }
1335     else {  /* Not inverted */
1336         ANYOF_POSIXL_OR((regnode_charclass_posixl*)or_with, ssc);
1337         if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1338             unsigned int i;
1339             for (i = 0; i < ANYOF_MAX; i += 2) {
1340                 if (ANYOF_POSIXL_TEST(ssc, i) && ANYOF_POSIXL_TEST(ssc, i + 1))
1341                 {
1342                     ssc_match_all_cp(ssc);
1343                     ANYOF_POSIXL_CLEAR(ssc, i);
1344                     ANYOF_POSIXL_CLEAR(ssc, i+1);
1345                 }
1346             }
1347         }
1348     }
1349
1350     ssc_union(ssc,
1351               ored_cp_list,
1352               FALSE /* Already has been inverted */
1353               );
1354 }
1355
1356 PERL_STATIC_INLINE void
1357 S_ssc_union(pTHX_ regnode_ssc *ssc, SV* const invlist, const bool invert2nd)
1358 {
1359     PERL_ARGS_ASSERT_SSC_UNION;
1360
1361     assert(is_ANYOF_SYNTHETIC(ssc));
1362
1363     _invlist_union_maybe_complement_2nd(ssc->invlist,
1364                                         invlist,
1365                                         invert2nd,
1366                                         &ssc->invlist);
1367 }
1368
1369 PERL_STATIC_INLINE void
1370 S_ssc_intersection(pTHX_ regnode_ssc *ssc,
1371                          SV* const invlist,
1372                          const bool invert2nd)
1373 {
1374     PERL_ARGS_ASSERT_SSC_INTERSECTION;
1375
1376     assert(is_ANYOF_SYNTHETIC(ssc));
1377
1378     _invlist_intersection_maybe_complement_2nd(ssc->invlist,
1379                                                invlist,
1380                                                invert2nd,
1381                                                &ssc->invlist);
1382 }
1383
1384 PERL_STATIC_INLINE void
1385 S_ssc_add_range(pTHX_ regnode_ssc *ssc, const UV start, const UV end)
1386 {
1387     PERL_ARGS_ASSERT_SSC_ADD_RANGE;
1388
1389     assert(is_ANYOF_SYNTHETIC(ssc));
1390
1391     ssc->invlist = _add_range_to_invlist(ssc->invlist, start, end);
1392 }
1393
1394 PERL_STATIC_INLINE void
1395 S_ssc_cp_and(pTHX_ regnode_ssc *ssc, const UV cp)
1396 {
1397     /* AND just the single code point 'cp' into the SSC 'ssc' */
1398
1399     SV* cp_list = _new_invlist(2);
1400
1401     PERL_ARGS_ASSERT_SSC_CP_AND;
1402
1403     assert(is_ANYOF_SYNTHETIC(ssc));
1404
1405     cp_list = add_cp_to_invlist(cp_list, cp);
1406     ssc_intersection(ssc, cp_list,
1407                      FALSE /* Not inverted */
1408                      );
1409     SvREFCNT_dec_NN(cp_list);
1410 }
1411
1412 PERL_STATIC_INLINE void
1413 S_ssc_clear_locale(pTHX_ regnode_ssc *ssc)
1414 {
1415     /* Set the SSC 'ssc' to not match any locale things */
1416
1417     PERL_ARGS_ASSERT_SSC_CLEAR_LOCALE;
1418
1419     assert(is_ANYOF_SYNTHETIC(ssc));
1420
1421     ANYOF_POSIXL_ZERO(ssc);
1422     ANYOF_FLAGS(ssc) &= ~ANYOF_LOCALE_FLAGS;
1423 }
1424
1425 STATIC void
1426 S_ssc_finalize(pTHX_ RExC_state_t *pRExC_state, regnode_ssc *ssc)
1427 {
1428     /* The inversion list in the SSC is marked mortal; now we need a more
1429      * permanent copy, which is stored the same way that is done in a regular
1430      * ANYOF node, with the first 256 code points in a bit map */
1431
1432     SV* invlist = invlist_clone(ssc->invlist);
1433
1434     PERL_ARGS_ASSERT_SSC_FINALIZE;
1435
1436     assert(is_ANYOF_SYNTHETIC(ssc));
1437
1438     /* The code in this file assumes that all but these flags aren't relevant
1439      * to the SSC, except ANYOF_EMPTY_STRING, which should be cleared by the
1440      * time we reach here */
1441     assert(! (ANYOF_FLAGS(ssc) & ~ANYOF_COMMON_FLAGS));
1442
1443     populate_ANYOF_from_invlist( (regnode *) ssc, &invlist);
1444
1445     set_ANYOF_arg(pRExC_state, (regnode *) ssc, invlist,
1446                                 NULL, NULL, NULL, FALSE);
1447
1448     if (ANYOF_POSIXL_SSC_TEST_ANY_SET(ssc)) {
1449         ANYOF_FLAGS(ssc) |= ANYOF_POSIXL;
1450     }
1451
1452     assert(! (ANYOF_FLAGS(ssc) & ANYOF_LOCALE_FLAGS) || RExC_contains_locale);
1453 }
1454
1455 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1456 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1457 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1458 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list         \
1459                                ? (TRIE_LIST_CUR( idx ) - 1)           \
1460                                : 0 )
1461
1462
1463 #ifdef DEBUGGING
1464 /*
1465    dump_trie(trie,widecharmap,revcharmap)
1466    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1467    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1468
1469    These routines dump out a trie in a somewhat readable format.
1470    The _interim_ variants are used for debugging the interim
1471    tables that are used to generate the final compressed
1472    representation which is what dump_trie expects.
1473
1474    Part of the reason for their existence is to provide a form
1475    of documentation as to how the different representations function.
1476
1477 */
1478
1479 /*
1480   Dumps the final compressed table form of the trie to Perl_debug_log.
1481   Used for debugging make_trie().
1482 */
1483
1484 STATIC void
1485 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1486             AV *revcharmap, U32 depth)
1487 {
1488     U32 state;
1489     SV *sv=sv_newmortal();
1490     int colwidth= widecharmap ? 6 : 4;
1491     U16 word;
1492     GET_RE_DEBUG_FLAGS_DECL;
1493
1494     PERL_ARGS_ASSERT_DUMP_TRIE;
1495
1496     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1497         (int)depth * 2 + 2,"",
1498         "Match","Base","Ofs" );
1499
1500     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1501         SV ** const tmp = av_fetch( revcharmap, state, 0);
1502         if ( tmp ) {
1503             PerlIO_printf( Perl_debug_log, "%*s",
1504                 colwidth,
1505                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1506                             PL_colors[0], PL_colors[1],
1507                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1508                             PERL_PV_ESCAPE_FIRSTCHAR
1509                 )
1510             );
1511         }
1512     }
1513     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1514         (int)depth * 2 + 2,"");
1515
1516     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1517         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1518     PerlIO_printf( Perl_debug_log, "\n");
1519
1520     for( state = 1 ; state < trie->statecount ; state++ ) {
1521         const U32 base = trie->states[ state ].trans.base;
1522
1523         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|",
1524                                        (int)depth * 2 + 2,"", (UV)state);
1525
1526         if ( trie->states[ state ].wordnum ) {
1527             PerlIO_printf( Perl_debug_log, " W%4X",
1528                                            trie->states[ state ].wordnum );
1529         } else {
1530             PerlIO_printf( Perl_debug_log, "%6s", "" );
1531         }
1532
1533         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1534
1535         if ( base ) {
1536             U32 ofs = 0;
1537
1538             while( ( base + ofs  < trie->uniquecharcount ) ||
1539                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1540                      && trie->trans[ base + ofs - trie->uniquecharcount ].check
1541                                                                     != state))
1542                     ofs++;
1543
1544             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1545
1546             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1547                 if ( ( base + ofs >= trie->uniquecharcount )
1548                         && ( base + ofs - trie->uniquecharcount
1549                                                         < trie->lasttrans )
1550                         && trie->trans[ base + ofs
1551                                     - trie->uniquecharcount ].check == state )
1552                 {
1553                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1554                     colwidth,
1555                     (UV)trie->trans[ base + ofs
1556                                              - trie->uniquecharcount ].next );
1557                 } else {
1558                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1559                 }
1560             }
1561
1562             PerlIO_printf( Perl_debug_log, "]");
1563
1564         }
1565         PerlIO_printf( Perl_debug_log, "\n" );
1566     }
1567     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=",
1568                                 (int)depth*2, "");
1569     for (word=1; word <= trie->wordcount; word++) {
1570         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1571             (int)word, (int)(trie->wordinfo[word].prev),
1572             (int)(trie->wordinfo[word].len));
1573     }
1574     PerlIO_printf(Perl_debug_log, "\n" );
1575 }
1576 /*
1577   Dumps a fully constructed but uncompressed trie in list form.
1578   List tries normally only are used for construction when the number of
1579   possible chars (trie->uniquecharcount) is very high.
1580   Used for debugging make_trie().
1581 */
1582 STATIC void
1583 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1584                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1585                          U32 depth)
1586 {
1587     U32 state;
1588     SV *sv=sv_newmortal();
1589     int colwidth= widecharmap ? 6 : 4;
1590     GET_RE_DEBUG_FLAGS_DECL;
1591
1592     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1593
1594     /* print out the table precompression.  */
1595     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1596         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1597         "------:-----+-----------------\n" );
1598
1599     for( state=1 ; state < next_alloc ; state ++ ) {
1600         U16 charid;
1601
1602         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1603             (int)depth * 2 + 2,"", (UV)state  );
1604         if ( ! trie->states[ state ].wordnum ) {
1605             PerlIO_printf( Perl_debug_log, "%5s| ","");
1606         } else {
1607             PerlIO_printf( Perl_debug_log, "W%4x| ",
1608                 trie->states[ state ].wordnum
1609             );
1610         }
1611         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1612             SV ** const tmp = av_fetch( revcharmap,
1613                                         TRIE_LIST_ITEM(state,charid).forid, 0);
1614             if ( tmp ) {
1615                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1616                     colwidth,
1617                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp),
1618                               colwidth,
1619                               PL_colors[0], PL_colors[1],
1620                               (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0)
1621                               | PERL_PV_ESCAPE_FIRSTCHAR
1622                     ) ,
1623                     TRIE_LIST_ITEM(state,charid).forid,
1624                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1625                 );
1626                 if (!(charid % 10))
1627                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1628                         (int)((depth * 2) + 14), "");
1629             }
1630         }
1631         PerlIO_printf( Perl_debug_log, "\n");
1632     }
1633 }
1634
1635 /*
1636   Dumps a fully constructed but uncompressed trie in table form.
1637   This is the normal DFA style state transition table, with a few
1638   twists to facilitate compression later.
1639   Used for debugging make_trie().
1640 */
1641 STATIC void
1642 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1643                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1644                           U32 depth)
1645 {
1646     U32 state;
1647     U16 charid;
1648     SV *sv=sv_newmortal();
1649     int colwidth= widecharmap ? 6 : 4;
1650     GET_RE_DEBUG_FLAGS_DECL;
1651
1652     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1653
1654     /*
1655        print out the table precompression so that we can do a visual check
1656        that they are identical.
1657      */
1658
1659     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1660
1661     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1662         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1663         if ( tmp ) {
1664             PerlIO_printf( Perl_debug_log, "%*s",
1665                 colwidth,
1666                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth,
1667                             PL_colors[0], PL_colors[1],
1668                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1669                             PERL_PV_ESCAPE_FIRSTCHAR
1670                 )
1671             );
1672         }
1673     }
1674
1675     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1676
1677     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1678         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1679     }
1680
1681     PerlIO_printf( Perl_debug_log, "\n" );
1682
1683     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1684
1685         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ",
1686             (int)depth * 2 + 2,"",
1687             (UV)TRIE_NODENUM( state ) );
1688
1689         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1690             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1691             if (v)
1692                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1693             else
1694                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1695         }
1696         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1697             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n",
1698                                             (UV)trie->trans[ state ].check );
1699         } else {
1700             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n",
1701                                             (UV)trie->trans[ state ].check,
1702             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1703         }
1704     }
1705 }
1706
1707 #endif
1708
1709
1710 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1711   startbranch: the first branch in the whole branch sequence
1712   first      : start branch of sequence of branch-exact nodes.
1713                May be the same as startbranch
1714   last       : Thing following the last branch.
1715                May be the same as tail.
1716   tail       : item following the branch sequence
1717   count      : words in the sequence
1718   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1719   depth      : indent depth
1720
1721 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1722
1723 A trie is an N'ary tree where the branches are determined by digital
1724 decomposition of the key. IE, at the root node you look up the 1st character and
1725 follow that branch repeat until you find the end of the branches. Nodes can be
1726 marked as "accepting" meaning they represent a complete word. Eg:
1727
1728   /he|she|his|hers/
1729
1730 would convert into the following structure. Numbers represent states, letters
1731 following numbers represent valid transitions on the letter from that state, if
1732 the number is in square brackets it represents an accepting state, otherwise it
1733 will be in parenthesis.
1734
1735       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1736       |    |
1737       |   (2)
1738       |    |
1739      (1)   +-i->(6)-+-s->[7]
1740       |
1741       +-s->(3)-+-h->(4)-+-e->[5]
1742
1743       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1744
1745 This shows that when matching against the string 'hers' we will begin at state 1
1746 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1747 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1748 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1749 single traverse. We store a mapping from accepting to state to which word was
1750 matched, and then when we have multiple possibilities we try to complete the
1751 rest of the regex in the order in which they occured in the alternation.
1752
1753 The only prior NFA like behaviour that would be changed by the TRIE support is
1754 the silent ignoring of duplicate alternations which are of the form:
1755
1756  / (DUPE|DUPE) X? (?{ ... }) Y /x
1757
1758 Thus EVAL blocks following a trie may be called a different number of times with
1759 and without the optimisation. With the optimisations dupes will be silently
1760 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1761 the following demonstrates:
1762
1763  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1764
1765 which prints out 'word' three times, but
1766
1767  'words'=~/(word|word|word)(?{ print $1 })S/
1768
1769 which doesnt print it out at all. This is due to other optimisations kicking in.
1770
1771 Example of what happens on a structural level:
1772
1773 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1774
1775    1: CURLYM[1] {1,32767}(18)
1776    5:   BRANCH(8)
1777    6:     EXACT <ac>(16)
1778    8:   BRANCH(11)
1779    9:     EXACT <ad>(16)
1780   11:   BRANCH(14)
1781   12:     EXACT <ab>(16)
1782   16:   SUCCEED(0)
1783   17:   NOTHING(18)
1784   18: END(0)
1785
1786 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1787 and should turn into:
1788
1789    1: CURLYM[1] {1,32767}(18)
1790    5:   TRIE(16)
1791         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1792           <ac>
1793           <ad>
1794           <ab>
1795   16:   SUCCEED(0)
1796   17:   NOTHING(18)
1797   18: END(0)
1798
1799 Cases where tail != last would be like /(?foo|bar)baz/:
1800
1801    1: BRANCH(4)
1802    2:   EXACT <foo>(8)
1803    4: BRANCH(7)
1804    5:   EXACT <bar>(8)
1805    7: TAIL(8)
1806    8: EXACT <baz>(10)
1807   10: END(0)
1808
1809 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1810 and would end up looking like:
1811
1812     1: TRIE(8)
1813       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1814         <foo>
1815         <bar>
1816    7: TAIL(8)
1817    8: EXACT <baz>(10)
1818   10: END(0)
1819
1820     d = uvchr_to_utf8_flags(d, uv, 0);
1821
1822 is the recommended Unicode-aware way of saying
1823
1824     *(d++) = uv;
1825 */
1826
1827 #define TRIE_STORE_REVCHAR(val)                                            \
1828     STMT_START {                                                           \
1829         if (UTF) {                                                         \
1830             SV *zlopp = newSV(7); /* XXX: optimize me */                   \
1831             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1832             unsigned const char *const kapow = uvchr_to_utf8(flrbbbbb, val); \
1833             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1834             SvPOK_on(zlopp);                                               \
1835             SvUTF8_on(zlopp);                                              \
1836             av_push(revcharmap, zlopp);                                    \
1837         } else {                                                           \
1838             char ooooff = (char)val;                                           \
1839             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1840         }                                                                  \
1841         } STMT_END
1842
1843 /* This gets the next character from the input, folding it if not already
1844  * folded. */
1845 #define TRIE_READ_CHAR STMT_START {                                           \
1846     wordlen++;                                                                \
1847     if ( UTF ) {                                                              \
1848         /* if it is UTF then it is either already folded, or does not need    \
1849          * folding */                                                         \
1850         uvc = valid_utf8_to_uvchr( (const U8*) uc, &len);                     \
1851     }                                                                         \
1852     else if (folder == PL_fold_latin1) {                                      \
1853         /* This folder implies Unicode rules, which in the range expressible  \
1854          *  by not UTF is the lower case, with the two exceptions, one of     \
1855          *  which should have been taken care of before calling this */       \
1856         assert(*uc != LATIN_SMALL_LETTER_SHARP_S);                            \
1857         uvc = toLOWER_L1(*uc);                                                \
1858         if (UNLIKELY(uvc == MICRO_SIGN)) uvc = GREEK_SMALL_LETTER_MU;         \
1859         len = 1;                                                              \
1860     } else {                                                                  \
1861         /* raw data, will be folded later if needed */                        \
1862         uvc = (U32)*uc;                                                       \
1863         len = 1;                                                              \
1864     }                                                                         \
1865 } STMT_END
1866
1867
1868
1869 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1870     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1871         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1872         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1873     }                                                           \
1874     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1875     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1876     TRIE_LIST_CUR( state )++;                                   \
1877 } STMT_END
1878
1879 #define TRIE_LIST_NEW(state) STMT_START {                       \
1880     Newxz( trie->states[ state ].trans.list,               \
1881         4, reg_trie_trans_le );                                 \
1882      TRIE_LIST_CUR( state ) = 1;                                \
1883      TRIE_LIST_LEN( state ) = 4;                                \
1884 } STMT_END
1885
1886 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1887     U16 dupe= trie->states[ state ].wordnum;                    \
1888     regnode * const noper_next = regnext( noper );              \
1889                                                                 \
1890     DEBUG_r({                                                   \
1891         /* store the word for dumping */                        \
1892         SV* tmp;                                                \
1893         if (OP(noper) != NOTHING)                               \
1894             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1895         else                                                    \
1896             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1897         av_push( trie_words, tmp );                             \
1898     });                                                         \
1899                                                                 \
1900     curword++;                                                  \
1901     trie->wordinfo[curword].prev   = 0;                         \
1902     trie->wordinfo[curword].len    = wordlen;                   \
1903     trie->wordinfo[curword].accept = state;                     \
1904                                                                 \
1905     if ( noper_next < tail ) {                                  \
1906         if (!trie->jump)                                        \
1907             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, \
1908                                                  sizeof(U16) ); \
1909         trie->jump[curword] = (U16)(noper_next - convert);      \
1910         if (!jumper)                                            \
1911             jumper = noper_next;                                \
1912         if (!nextbranch)                                        \
1913             nextbranch= regnext(cur);                           \
1914     }                                                           \
1915                                                                 \
1916     if ( dupe ) {                                               \
1917         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1918         /* chain, so that when the bits of chain are later    */\
1919         /* linked together, the dups appear in the chain      */\
1920         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1921         trie->wordinfo[dupe].prev = curword;                    \
1922     } else {                                                    \
1923         /* we haven't inserted this word yet.                */ \
1924         trie->states[ state ].wordnum = curword;                \
1925     }                                                           \
1926 } STMT_END
1927
1928
1929 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1930      ( ( base + charid >=  ucharcount                                   \
1931          && base + charid < ubound                                      \
1932          && state == trie->trans[ base - ucharcount + charid ].check    \
1933          && trie->trans[ base - ucharcount + charid ].next )            \
1934            ? trie->trans[ base - ucharcount + charid ].next             \
1935            : ( state==1 ? special : 0 )                                 \
1936       )
1937
1938 #define MADE_TRIE       1
1939 #define MADE_JUMP_TRIE  2
1940 #define MADE_EXACT_TRIE 4
1941
1942 STATIC I32
1943 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch,
1944                   regnode *first, regnode *last, regnode *tail,
1945                   U32 word_count, U32 flags, U32 depth)
1946 {
1947     dVAR;
1948     /* first pass, loop through and scan words */
1949     reg_trie_data *trie;
1950     HV *widecharmap = NULL;
1951     AV *revcharmap = newAV();
1952     regnode *cur;
1953     STRLEN len = 0;
1954     UV uvc = 0;
1955     U16 curword = 0;
1956     U32 next_alloc = 0;
1957     regnode *jumper = NULL;
1958     regnode *nextbranch = NULL;
1959     regnode *convert = NULL;
1960     U32 *prev_states; /* temp array mapping each state to previous one */
1961     /* we just use folder as a flag in utf8 */
1962     const U8 * folder = NULL;
1963
1964 #ifdef DEBUGGING
1965     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tuuu"));
1966     AV *trie_words = NULL;
1967     /* along with revcharmap, this only used during construction but both are
1968      * useful during debugging so we store them in the struct when debugging.
1969      */
1970 #else
1971     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("tu"));
1972     STRLEN trie_charcount=0;
1973 #endif
1974     SV *re_trie_maxbuff;
1975     GET_RE_DEBUG_FLAGS_DECL;
1976
1977     PERL_ARGS_ASSERT_MAKE_TRIE;
1978 #ifndef DEBUGGING
1979     PERL_UNUSED_ARG(depth);
1980 #endif
1981
1982     switch (flags) {
1983         case EXACT: break;
1984         case EXACTFA:
1985         case EXACTFU_SS:
1986         case EXACTFU: folder = PL_fold_latin1; break;
1987         case EXACTF:  folder = PL_fold; break;
1988         default: Perl_croak( aTHX_ "panic! In trie construction, unknown node type %u %s", (unsigned) flags, PL_reg_name[flags] );
1989     }
1990
1991     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1992     trie->refcount = 1;
1993     trie->startstate = 1;
1994     trie->wordcount = word_count;
1995     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1996     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1997     if (flags == EXACT)
1998         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1999     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
2000                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
2001
2002     DEBUG_r({
2003         trie_words = newAV();
2004     });
2005
2006     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2007     if (!SvIOK(re_trie_maxbuff)) {
2008         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2009     }
2010     DEBUG_TRIE_COMPILE_r({
2011         PerlIO_printf( Perl_debug_log,
2012           "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
2013           (int)depth * 2 + 2, "",
2014           REG_NODE_NUM(startbranch),REG_NODE_NUM(first),
2015           REG_NODE_NUM(last), REG_NODE_NUM(tail), (int)depth);
2016     });
2017
2018    /* Find the node we are going to overwrite */
2019     if ( first == startbranch && OP( last ) != BRANCH ) {
2020         /* whole branch chain */
2021         convert = first;
2022     } else {
2023         /* branch sub-chain */
2024         convert = NEXTOPER( first );
2025     }
2026
2027     /*  -- First loop and Setup --
2028
2029        We first traverse the branches and scan each word to determine if it
2030        contains widechars, and how many unique chars there are, this is
2031        important as we have to build a table with at least as many columns as we
2032        have unique chars.
2033
2034        We use an array of integers to represent the character codes 0..255
2035        (trie->charmap) and we use a an HV* to store Unicode characters. We use
2036        the native representation of the character value as the key and IV's for
2037        the coded index.
2038
2039        *TODO* If we keep track of how many times each character is used we can
2040        remap the columns so that the table compression later on is more
2041        efficient in terms of memory by ensuring the most common value is in the
2042        middle and the least common are on the outside.  IMO this would be better
2043        than a most to least common mapping as theres a decent chance the most
2044        common letter will share a node with the least common, meaning the node
2045        will not be compressible. With a middle is most common approach the worst
2046        case is when we have the least common nodes twice.
2047
2048      */
2049
2050     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2051         regnode *noper = NEXTOPER( cur );
2052         const U8 *uc = (U8*)STRING( noper );
2053         const U8 *e  = uc + STR_LEN( noper );
2054         STRLEN foldlen = 0;
2055         U32 wordlen      = 0;         /* required init */
2056         STRLEN minbytes = 0;
2057         STRLEN maxbytes = 0;
2058         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the
2059                                                bitmap?*/
2060
2061         if (OP(noper) == NOTHING) {
2062             regnode *noper_next= regnext(noper);
2063             if (noper_next != tail && OP(noper_next) == flags) {
2064                 noper = noper_next;
2065                 uc= (U8*)STRING(noper);
2066                 e= uc + STR_LEN(noper);
2067                 trie->minlen= STR_LEN(noper);
2068             } else {
2069                 trie->minlen= 0;
2070                 continue;
2071             }
2072         }
2073
2074         if ( set_bit ) { /* bitmap only alloced when !(UTF&&Folding) */
2075             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
2076                                           regardless of encoding */
2077             if (OP( noper ) == EXACTFU_SS) {
2078                 /* false positives are ok, so just set this */
2079                 TRIE_BITMAP_SET(trie, LATIN_SMALL_LETTER_SHARP_S);
2080             }
2081         }
2082         for ( ; uc < e ; uc += len ) {
2083             TRIE_CHARCOUNT(trie)++;
2084             TRIE_READ_CHAR;
2085
2086             /* Acummulate to the current values, the range in the number of
2087              * bytes that this character could match.  The max is presumed to
2088              * be the same as the folded input (which TRIE_READ_CHAR returns),
2089              * except that when this is not in UTF-8, it could be matched
2090              * against a string which is UTF-8, and the variant characters
2091              * could be 2 bytes instead of the 1 here.  Likewise, for the
2092              * minimum number of bytes when not folded.  When folding, the min
2093              * is assumed to be 1 byte could fold to match the single character
2094              * here, or in the case of a multi-char fold, 1 byte can fold to
2095              * the whole sequence.  'foldlen' is used to denote whether we are
2096              * in such a sequence, skipping the min setting if so.  XXX TODO
2097              * Use the exact list of what folds to each character, from
2098              * PL_utf8_foldclosures */
2099             if (UTF) {
2100                 maxbytes += UTF8SKIP(uc);
2101                 if (! folder) {
2102                     /* A non-UTF-8 string could be 1 byte to match our 2 */
2103                     minbytes += (UTF8_IS_DOWNGRADEABLE_START(*uc))
2104                                 ? 1
2105                                 : UTF8SKIP(uc);
2106                 }
2107                 else {
2108                     if (foldlen) {
2109                         foldlen -= UTF8SKIP(uc);
2110                     }
2111                     else {
2112                         foldlen = is_MULTI_CHAR_FOLD_utf8(uc);
2113                         minbytes++;
2114                     }
2115                 }
2116             }
2117             else {
2118                 maxbytes += (UNI_IS_INVARIANT(*uc))
2119                              ? 1
2120                              : 2;
2121                 if (! folder) {
2122                     minbytes++;
2123                 }
2124                 else {
2125                     if (foldlen) {
2126                         foldlen--;
2127                     }
2128                     else {
2129                         foldlen = is_MULTI_CHAR_FOLD_latin1(uc);
2130                         minbytes++;
2131                     }
2132                 }
2133             }
2134             if ( uvc < 256 ) {
2135                 if ( folder ) {
2136                     U8 folded= folder[ (U8) uvc ];
2137                     if ( !trie->charmap[ folded ] ) {
2138                         trie->charmap[ folded ]=( ++trie->uniquecharcount );
2139                         TRIE_STORE_REVCHAR( folded );
2140                     }
2141                 }
2142                 if ( !trie->charmap[ uvc ] ) {
2143                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
2144                     TRIE_STORE_REVCHAR( uvc );
2145                 }
2146                 if ( set_bit ) {
2147                     /* store the codepoint in the bitmap, and its folded
2148                      * equivalent. */
2149                     TRIE_BITMAP_SET(trie, uvc);
2150
2151                     /* store the folded codepoint */
2152                     if ( folder ) TRIE_BITMAP_SET(trie, folder[(U8) uvc ]);
2153
2154                     if ( !UTF ) {
2155                         /* store first byte of utf8 representation of
2156                            variant codepoints */
2157                         if (! UVCHR_IS_INVARIANT(uvc)) {
2158                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
2159                         }
2160                     }
2161                     set_bit = 0; /* We've done our bit :-) */
2162                 }
2163             } else {
2164                 SV** svpp;
2165                 if ( !widecharmap )
2166                     widecharmap = newHV();
2167
2168                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
2169
2170                 if ( !svpp )
2171                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
2172
2173                 if ( !SvTRUE( *svpp ) ) {
2174                     sv_setiv( *svpp, ++trie->uniquecharcount );
2175                     TRIE_STORE_REVCHAR(uvc);
2176                 }
2177             }
2178         }
2179         if( cur == first ) {
2180             trie->minlen = minbytes;
2181             trie->maxlen = maxbytes;
2182         } else if (minbytes < trie->minlen) {
2183             trie->minlen = minbytes;
2184         } else if (maxbytes > trie->maxlen) {
2185             trie->maxlen = maxbytes;
2186         }
2187     } /* end first pass */
2188     DEBUG_TRIE_COMPILE_r(
2189         PerlIO_printf( Perl_debug_log,
2190                 "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
2191                 (int)depth * 2 + 2,"",
2192                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
2193                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
2194                 (int)trie->minlen, (int)trie->maxlen )
2195     );
2196
2197     /*
2198         We now know what we are dealing with in terms of unique chars and
2199         string sizes so we can calculate how much memory a naive
2200         representation using a flat table  will take. If it's over a reasonable
2201         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
2202         conservative but potentially much slower representation using an array
2203         of lists.
2204
2205         At the end we convert both representations into the same compressed
2206         form that will be used in regexec.c for matching with. The latter
2207         is a form that cannot be used to construct with but has memory
2208         properties similar to the list form and access properties similar
2209         to the table form making it both suitable for fast searches and
2210         small enough that its feasable to store for the duration of a program.
2211
2212         See the comment in the code where the compressed table is produced
2213         inplace from the flat tabe representation for an explanation of how
2214         the compression works.
2215
2216     */
2217
2218
2219     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
2220     prev_states[1] = 0;
2221
2222     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1)
2223                                                     > SvIV(re_trie_maxbuff) )
2224     {
2225         /*
2226             Second Pass -- Array Of Lists Representation
2227
2228             Each state will be represented by a list of charid:state records
2229             (reg_trie_trans_le) the first such element holds the CUR and LEN
2230             points of the allocated array. (See defines above).
2231
2232             We build the initial structure using the lists, and then convert
2233             it into the compressed table form which allows faster lookups
2234             (but cant be modified once converted).
2235         */
2236
2237         STRLEN transcount = 1;
2238
2239         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2240             "%*sCompiling trie using list compiler\n",
2241             (int)depth * 2 + 2, ""));
2242
2243         trie->states = (reg_trie_state *)
2244             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2245                                   sizeof(reg_trie_state) );
2246         TRIE_LIST_NEW(1);
2247         next_alloc = 2;
2248
2249         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2250
2251             regnode *noper   = NEXTOPER( cur );
2252             U8 *uc           = (U8*)STRING( noper );
2253             const U8 *e      = uc + STR_LEN( noper );
2254             U32 state        = 1;         /* required init */
2255             U16 charid       = 0;         /* sanity init */
2256             U32 wordlen      = 0;         /* required init */
2257
2258             if (OP(noper) == NOTHING) {
2259                 regnode *noper_next= regnext(noper);
2260                 if (noper_next != tail && OP(noper_next) == flags) {
2261                     noper = noper_next;
2262                     uc= (U8*)STRING(noper);
2263                     e= uc + STR_LEN(noper);
2264                 }
2265             }
2266
2267             if (OP(noper) != NOTHING) {
2268                 for ( ; uc < e ; uc += len ) {
2269
2270                     TRIE_READ_CHAR;
2271
2272                     if ( uvc < 256 ) {
2273                         charid = trie->charmap[ uvc ];
2274                     } else {
2275                         SV** const svpp = hv_fetch( widecharmap,
2276                                                     (char*)&uvc,
2277                                                     sizeof( UV ),
2278                                                     0);
2279                         if ( !svpp ) {
2280                             charid = 0;
2281                         } else {
2282                             charid=(U16)SvIV( *svpp );
2283                         }
2284                     }
2285                     /* charid is now 0 if we dont know the char read, or
2286                      * nonzero if we do */
2287                     if ( charid ) {
2288
2289                         U16 check;
2290                         U32 newstate = 0;
2291
2292                         charid--;
2293                         if ( !trie->states[ state ].trans.list ) {
2294                             TRIE_LIST_NEW( state );
2295                         }
2296                         for ( check = 1;
2297                               check <= TRIE_LIST_USED( state );
2298                               check++ )
2299                         {
2300                             if ( TRIE_LIST_ITEM( state, check ).forid
2301                                                                     == charid )
2302                             {
2303                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
2304                                 break;
2305                             }
2306                         }
2307                         if ( ! newstate ) {
2308                             newstate = next_alloc++;
2309                             prev_states[newstate] = state;
2310                             TRIE_LIST_PUSH( state, charid, newstate );
2311                             transcount++;
2312                         }
2313                         state = newstate;
2314                     } else {
2315                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2316                     }
2317                 }
2318             }
2319             TRIE_HANDLE_WORD(state);
2320
2321         } /* end second pass */
2322
2323         /* next alloc is the NEXT state to be allocated */
2324         trie->statecount = next_alloc;
2325         trie->states = (reg_trie_state *)
2326             PerlMemShared_realloc( trie->states,
2327                                    next_alloc
2328                                    * sizeof(reg_trie_state) );
2329
2330         /* and now dump it out before we compress it */
2331         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
2332                                                          revcharmap, next_alloc,
2333                                                          depth+1)
2334         );
2335
2336         trie->trans = (reg_trie_trans *)
2337             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
2338         {
2339             U32 state;
2340             U32 tp = 0;
2341             U32 zp = 0;
2342
2343
2344             for( state=1 ; state < next_alloc ; state ++ ) {
2345                 U32 base=0;
2346
2347                 /*
2348                 DEBUG_TRIE_COMPILE_MORE_r(
2349                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
2350                 );
2351                 */
2352
2353                 if (trie->states[state].trans.list) {
2354                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
2355                     U16 maxid=minid;
2356                     U16 idx;
2357
2358                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2359                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
2360                         if ( forid < minid ) {
2361                             minid=forid;
2362                         } else if ( forid > maxid ) {
2363                             maxid=forid;
2364                         }
2365                     }
2366                     if ( transcount < tp + maxid - minid + 1) {
2367                         transcount *= 2;
2368                         trie->trans = (reg_trie_trans *)
2369                             PerlMemShared_realloc( trie->trans,
2370                                                      transcount
2371                                                      * sizeof(reg_trie_trans) );
2372                         Zero( trie->trans + (transcount / 2),
2373                               transcount / 2,
2374                               reg_trie_trans );
2375                     }
2376                     base = trie->uniquecharcount + tp - minid;
2377                     if ( maxid == minid ) {
2378                         U32 set = 0;
2379                         for ( ; zp < tp ; zp++ ) {
2380                             if ( ! trie->trans[ zp ].next ) {
2381                                 base = trie->uniquecharcount + zp - minid;
2382                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state,
2383                                                                    1).newstate;
2384                                 trie->trans[ zp ].check = state;
2385                                 set = 1;
2386                                 break;
2387                             }
2388                         }
2389                         if ( !set ) {
2390                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state,
2391                                                                    1).newstate;
2392                             trie->trans[ tp ].check = state;
2393                             tp++;
2394                             zp = tp;
2395                         }
2396                     } else {
2397                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
2398                             const U32 tid = base
2399                                            - trie->uniquecharcount
2400                                            + TRIE_LIST_ITEM( state, idx ).forid;
2401                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state,
2402                                                                 idx ).newstate;
2403                             trie->trans[ tid ].check = state;
2404                         }
2405                         tp += ( maxid - minid + 1 );
2406                     }
2407                     Safefree(trie->states[ state ].trans.list);
2408                 }
2409                 /*
2410                 DEBUG_TRIE_COMPILE_MORE_r(
2411                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
2412                 );
2413                 */
2414                 trie->states[ state ].trans.base=base;
2415             }
2416             trie->lasttrans = tp + 1;
2417         }
2418     } else {
2419         /*
2420            Second Pass -- Flat Table Representation.
2421
2422            we dont use the 0 slot of either trans[] or states[] so we add 1 to
2423            each.  We know that we will need Charcount+1 trans at most to store
2424            the data (one row per char at worst case) So we preallocate both
2425            structures assuming worst case.
2426
2427            We then construct the trie using only the .next slots of the entry
2428            structs.
2429
2430            We use the .check field of the first entry of the node temporarily
2431            to make compression both faster and easier by keeping track of how
2432            many non zero fields are in the node.
2433
2434            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
2435            transition.
2436
2437            There are two terms at use here: state as a TRIE_NODEIDX() which is
2438            a number representing the first entry of the node, and state as a
2439            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1)
2440            and TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3)
2441            if there are 2 entrys per node. eg:
2442
2443              A B       A B
2444           1. 2 4    1. 3 7
2445           2. 0 3    3. 0 5
2446           3. 0 0    5. 0 0
2447           4. 0 0    7. 0 0
2448
2449            The table is internally in the right hand, idx form. However as we
2450            also have to deal with the states array which is indexed by nodenum
2451            we have to use TRIE_NODENUM() to convert.
2452
2453         */
2454         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log,
2455             "%*sCompiling trie using table compiler\n",
2456             (int)depth * 2 + 2, ""));
2457
2458         trie->trans = (reg_trie_trans *)
2459             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
2460                                   * trie->uniquecharcount + 1,
2461                                   sizeof(reg_trie_trans) );
2462         trie->states = (reg_trie_state *)
2463             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
2464                                   sizeof(reg_trie_state) );
2465         next_alloc = trie->uniquecharcount + 1;
2466
2467
2468         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
2469
2470             regnode *noper   = NEXTOPER( cur );
2471             const U8 *uc     = (U8*)STRING( noper );
2472             const U8 *e      = uc + STR_LEN( noper );
2473
2474             U32 state        = 1;         /* required init */
2475
2476             U16 charid       = 0;         /* sanity init */
2477             U32 accept_state = 0;         /* sanity init */
2478
2479             U32 wordlen      = 0;         /* required init */
2480
2481             if (OP(noper) == NOTHING) {
2482                 regnode *noper_next= regnext(noper);
2483                 if (noper_next != tail && OP(noper_next) == flags) {
2484                     noper = noper_next;
2485                     uc= (U8*)STRING(noper);
2486                     e= uc + STR_LEN(noper);
2487                 }
2488             }
2489
2490             if ( OP(noper) != NOTHING ) {
2491                 for ( ; uc < e ; uc += len ) {
2492
2493                     TRIE_READ_CHAR;
2494
2495                     if ( uvc < 256 ) {
2496                         charid = trie->charmap[ uvc ];
2497                     } else {
2498                         SV* const * const svpp = hv_fetch( widecharmap,
2499                                                            (char*)&uvc,
2500                                                            sizeof( UV ),
2501                                                            0);
2502                         charid = svpp ? (U16)SvIV(*svpp) : 0;
2503                     }
2504                     if ( charid ) {
2505                         charid--;
2506                         if ( !trie->trans[ state + charid ].next ) {
2507                             trie->trans[ state + charid ].next = next_alloc;
2508                             trie->trans[ state ].check++;
2509                             prev_states[TRIE_NODENUM(next_alloc)]
2510                                     = TRIE_NODENUM(state);
2511                             next_alloc += trie->uniquecharcount;
2512                         }
2513                         state = trie->trans[ state + charid ].next;
2514                     } else {
2515                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
2516                     }
2517                     /* charid is now 0 if we dont know the char read, or
2518                      * nonzero if we do */
2519                 }
2520             }
2521             accept_state = TRIE_NODENUM( state );
2522             TRIE_HANDLE_WORD(accept_state);
2523
2524         } /* end second pass */
2525
2526         /* and now dump it out before we compress it */
2527         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
2528                                                           revcharmap,
2529                                                           next_alloc, depth+1));
2530
2531         {
2532         /*
2533            * Inplace compress the table.*
2534
2535            For sparse data sets the table constructed by the trie algorithm will
2536            be mostly 0/FAIL transitions or to put it another way mostly empty.
2537            (Note that leaf nodes will not contain any transitions.)
2538
2539            This algorithm compresses the tables by eliminating most such
2540            transitions, at the cost of a modest bit of extra work during lookup:
2541
2542            - Each states[] entry contains a .base field which indicates the
2543            index in the state[] array wheres its transition data is stored.
2544
2545            - If .base is 0 there are no valid transitions from that node.
2546
2547            - If .base is nonzero then charid is added to it to find an entry in
2548            the trans array.
2549
2550            -If trans[states[state].base+charid].check!=state then the
2551            transition is taken to be a 0/Fail transition. Thus if there are fail
2552            transitions at the front of the node then the .base offset will point
2553            somewhere inside the previous nodes data (or maybe even into a node
2554            even earlier), but the .check field determines if the transition is
2555            valid.
2556
2557            XXX - wrong maybe?
2558            The following process inplace converts the table to the compressed
2559            table: We first do not compress the root node 1,and mark all its
2560            .check pointers as 1 and set its .base pointer as 1 as well. This
2561            allows us to do a DFA construction from the compressed table later,
2562            and ensures that any .base pointers we calculate later are greater
2563            than 0.
2564
2565            - We set 'pos' to indicate the first entry of the second node.
2566
2567            - We then iterate over the columns of the node, finding the first and
2568            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2569            and set the .check pointers accordingly, and advance pos
2570            appropriately and repreat for the next node. Note that when we copy
2571            the next pointers we have to convert them from the original
2572            NODEIDX form to NODENUM form as the former is not valid post
2573            compression.
2574
2575            - If a node has no transitions used we mark its base as 0 and do not
2576            advance the pos pointer.
2577
2578            - If a node only has one transition we use a second pointer into the
2579            structure to fill in allocated fail transitions from other states.
2580            This pointer is independent of the main pointer and scans forward
2581            looking for null transitions that are allocated to a state. When it
2582            finds one it writes the single transition into the "hole".  If the
2583            pointer doesnt find one the single transition is appended as normal.
2584
2585            - Once compressed we can Renew/realloc the structures to release the
2586            excess space.
2587
2588            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2589            specifically Fig 3.47 and the associated pseudocode.
2590
2591            demq
2592         */
2593         const U32 laststate = TRIE_NODENUM( next_alloc );
2594         U32 state, charid;
2595         U32 pos = 0, zp=0;
2596         trie->statecount = laststate;
2597
2598         for ( state = 1 ; state < laststate ; state++ ) {
2599             U8 flag = 0;
2600             const U32 stateidx = TRIE_NODEIDX( state );
2601             const U32 o_used = trie->trans[ stateidx ].check;
2602             U32 used = trie->trans[ stateidx ].check;
2603             trie->trans[ stateidx ].check = 0;
2604
2605             for ( charid = 0;
2606                   used && charid < trie->uniquecharcount;
2607                   charid++ )
2608             {
2609                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2610                     if ( trie->trans[ stateidx + charid ].next ) {
2611                         if (o_used == 1) {
2612                             for ( ; zp < pos ; zp++ ) {
2613                                 if ( ! trie->trans[ zp ].next ) {
2614                                     break;
2615                                 }
2616                             }
2617                             trie->states[ state ].trans.base
2618                                                     = zp
2619                                                       + trie->uniquecharcount
2620                                                       - charid ;
2621                             trie->trans[ zp ].next
2622                                 = SAFE_TRIE_NODENUM( trie->trans[ stateidx
2623                                                              + charid ].next );
2624                             trie->trans[ zp ].check = state;
2625                             if ( ++zp > pos ) pos = zp;
2626                             break;
2627                         }
2628                         used--;
2629                     }
2630                     if ( !flag ) {
2631                         flag = 1;
2632                         trie->states[ state ].trans.base
2633                                        = pos + trie->uniquecharcount - charid ;
2634                     }
2635                     trie->trans[ pos ].next
2636                         = SAFE_TRIE_NODENUM(
2637                                        trie->trans[ stateidx + charid ].next );
2638                     trie->trans[ pos ].check = state;
2639                     pos++;
2640                 }
2641             }
2642         }
2643         trie->lasttrans = pos + 1;
2644         trie->states = (reg_trie_state *)
2645             PerlMemShared_realloc( trie->states, laststate
2646                                    * sizeof(reg_trie_state) );
2647         DEBUG_TRIE_COMPILE_MORE_r(
2648             PerlIO_printf( Perl_debug_log,
2649                 "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2650                 (int)depth * 2 + 2,"",
2651                 (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount
2652                        + 1 ),
2653                 (IV)next_alloc,
2654                 (IV)pos,
2655                 ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2656             );
2657
2658         } /* end table compress */
2659     }
2660     DEBUG_TRIE_COMPILE_MORE_r(
2661             PerlIO_printf(Perl_debug_log,
2662                 "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2663                 (int)depth * 2 + 2, "",
2664                 (UV)trie->statecount,
2665                 (UV)trie->lasttrans)
2666     );
2667     /* resize the trans array to remove unused space */
2668     trie->trans = (reg_trie_trans *)
2669         PerlMemShared_realloc( trie->trans, trie->lasttrans
2670                                * sizeof(reg_trie_trans) );
2671
2672     {   /* Modify the program and insert the new TRIE node */
2673         U8 nodetype =(U8)(flags & 0xFF);
2674         char *str=NULL;
2675
2676 #ifdef DEBUGGING
2677         regnode *optimize = NULL;
2678 #ifdef RE_TRACK_PATTERN_OFFSETS
2679
2680         U32 mjd_offset = 0;
2681         U32 mjd_nodelen = 0;
2682 #endif /* RE_TRACK_PATTERN_OFFSETS */
2683 #endif /* DEBUGGING */
2684         /*
2685            This means we convert either the first branch or the first Exact,
2686            depending on whether the thing following (in 'last') is a branch
2687            or not and whther first is the startbranch (ie is it a sub part of
2688            the alternation or is it the whole thing.)
2689            Assuming its a sub part we convert the EXACT otherwise we convert
2690            the whole branch sequence, including the first.
2691          */
2692         /* Find the node we are going to overwrite */
2693         if ( first != startbranch || OP( last ) == BRANCH ) {
2694             /* branch sub-chain */
2695             NEXT_OFF( first ) = (U16)(last - first);
2696 #ifdef RE_TRACK_PATTERN_OFFSETS
2697             DEBUG_r({
2698                 mjd_offset= Node_Offset((convert));
2699                 mjd_nodelen= Node_Length((convert));
2700             });
2701 #endif
2702             /* whole branch chain */
2703         }
2704 #ifdef RE_TRACK_PATTERN_OFFSETS
2705         else {
2706             DEBUG_r({
2707                 const  regnode *nop = NEXTOPER( convert );
2708                 mjd_offset= Node_Offset((nop));
2709                 mjd_nodelen= Node_Length((nop));
2710             });
2711         }
2712         DEBUG_OPTIMISE_r(
2713             PerlIO_printf(Perl_debug_log,
2714                 "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2715                 (int)depth * 2 + 2, "",
2716                 (UV)mjd_offset, (UV)mjd_nodelen)
2717         );
2718 #endif
2719         /* But first we check to see if there is a common prefix we can
2720            split out as an EXACT and put in front of the TRIE node.  */
2721         trie->startstate= 1;
2722         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2723             U32 state;
2724             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2725                 U32 ofs = 0;
2726                 I32 idx = -1;
2727                 U32 count = 0;
2728                 const U32 base = trie->states[ state ].trans.base;
2729
2730                 if ( trie->states[state].wordnum )
2731                         count = 1;
2732
2733                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2734                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2735                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2736                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2737                     {
2738                         if ( ++count > 1 ) {
2739                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2740                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2741                             if ( state == 1 ) break;
2742                             if ( count == 2 ) {
2743                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2744                                 DEBUG_OPTIMISE_r(
2745                                     PerlIO_printf(Perl_debug_log,
2746                                         "%*sNew Start State=%"UVuf" Class: [",
2747                                         (int)depth * 2 + 2, "",
2748                                         (UV)state));
2749                                 if (idx >= 0) {
2750                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2751                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2752
2753                                     TRIE_BITMAP_SET(trie,*ch);
2754                                     if ( folder )
2755                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2756                                     DEBUG_OPTIMISE_r(
2757                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2758                                     );
2759                                 }
2760                             }
2761                             TRIE_BITMAP_SET(trie,*ch);
2762                             if ( folder )
2763                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2764                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2765                         }
2766                         idx = ofs;
2767                     }
2768                 }
2769                 if ( count == 1 ) {
2770                     SV **tmp = av_fetch( revcharmap, idx, 0);
2771                     STRLEN len;
2772                     char *ch = SvPV( *tmp, len );
2773                     DEBUG_OPTIMISE_r({
2774                         SV *sv=sv_newmortal();
2775                         PerlIO_printf( Perl_debug_log,
2776                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2777                             (int)depth * 2 + 2, "",
2778                             (UV)state, (UV)idx,
2779                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6,
2780                                 PL_colors[0], PL_colors[1],
2781                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2782                                 PERL_PV_ESCAPE_FIRSTCHAR
2783                             )
2784                         );
2785                     });
2786                     if ( state==1 ) {
2787                         OP( convert ) = nodetype;
2788                         str=STRING(convert);
2789                         STR_LEN(convert)=0;
2790                     }
2791                     STR_LEN(convert) += len;
2792                     while (len--)
2793                         *str++ = *ch++;
2794                 } else {
2795 #ifdef DEBUGGING
2796                     if (state>1)
2797                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2798 #endif
2799                     break;
2800                 }
2801             }
2802             trie->prefixlen = (state-1);
2803             if (str) {
2804                 regnode *n = convert+NODE_SZ_STR(convert);
2805                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2806                 trie->startstate = state;
2807                 trie->minlen -= (state - 1);
2808                 trie->maxlen -= (state - 1);
2809 #ifdef DEBUGGING
2810                /* At least the UNICOS C compiler choked on this
2811                 * being argument to DEBUG_r(), so let's just have
2812                 * it right here. */
2813                if (
2814 #ifdef PERL_EXT_RE_BUILD
2815                    1
2816 #else
2817                    DEBUG_r_TEST
2818 #endif
2819                    ) {
2820                    regnode *fix = convert;
2821                    U32 word = trie->wordcount;
2822                    mjd_nodelen++;
2823                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2824                    while( ++fix < n ) {
2825                        Set_Node_Offset_Length(fix, 0, 0);
2826                    }
2827                    while (word--) {
2828                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2829                        if (tmp) {
2830                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2831                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2832                            else
2833                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2834                        }
2835                    }
2836                }
2837 #endif
2838                 if (trie->maxlen) {
2839                     convert = n;
2840                 } else {
2841                     NEXT_OFF(convert) = (U16)(tail - convert);
2842                     DEBUG_r(optimize= n);
2843                 }
2844             }
2845         }
2846         if (!jumper)
2847             jumper = last;
2848         if ( trie->maxlen ) {
2849             NEXT_OFF( convert ) = (U16)(tail - convert);
2850             ARG_SET( convert, data_slot );
2851             /* Store the offset to the first unabsorbed branch in
2852                jump[0], which is otherwise unused by the jump logic.
2853                We use this when dumping a trie and during optimisation. */
2854             if (trie->jump)
2855                 trie->jump[0] = (U16)(nextbranch - convert);
2856
2857             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2858              *   and there is a bitmap
2859              *   and the first "jump target" node we found leaves enough room
2860              * then convert the TRIE node into a TRIEC node, with the bitmap
2861              * embedded inline in the opcode - this is hypothetically faster.
2862              */
2863             if ( !trie->states[trie->startstate].wordnum
2864                  && trie->bitmap
2865                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2866             {
2867                 OP( convert ) = TRIEC;
2868                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2869                 PerlMemShared_free(trie->bitmap);
2870                 trie->bitmap= NULL;
2871             } else
2872                 OP( convert ) = TRIE;
2873
2874             /* store the type in the flags */
2875             convert->flags = nodetype;
2876             DEBUG_r({
2877             optimize = convert
2878                       + NODE_STEP_REGNODE
2879                       + regarglen[ OP( convert ) ];
2880             });
2881             /* XXX We really should free up the resource in trie now,
2882                    as we won't use them - (which resources?) dmq */
2883         }
2884         /* needed for dumping*/
2885         DEBUG_r(if (optimize) {
2886             regnode *opt = convert;
2887
2888             while ( ++opt < optimize) {
2889                 Set_Node_Offset_Length(opt,0,0);
2890             }
2891             /*
2892                 Try to clean up some of the debris left after the
2893                 optimisation.
2894              */
2895             while( optimize < jumper ) {
2896                 mjd_nodelen += Node_Length((optimize));
2897                 OP( optimize ) = OPTIMIZED;
2898                 Set_Node_Offset_Length(optimize,0,0);
2899                 optimize++;
2900             }
2901             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2902         });
2903     } /* end node insert */
2904
2905     /*  Finish populating the prev field of the wordinfo array.  Walk back
2906      *  from each accept state until we find another accept state, and if
2907      *  so, point the first word's .prev field at the second word. If the
2908      *  second already has a .prev field set, stop now. This will be the
2909      *  case either if we've already processed that word's accept state,
2910      *  or that state had multiple words, and the overspill words were
2911      *  already linked up earlier.
2912      */
2913     {
2914         U16 word;
2915         U32 state;
2916         U16 prev;
2917
2918         for (word=1; word <= trie->wordcount; word++) {
2919             prev = 0;
2920             if (trie->wordinfo[word].prev)
2921                 continue;
2922             state = trie->wordinfo[word].accept;
2923             while (state) {
2924                 state = prev_states[state];
2925                 if (!state)
2926                     break;
2927                 prev = trie->states[state].wordnum;
2928                 if (prev)
2929                     break;
2930             }
2931             trie->wordinfo[word].prev = prev;
2932         }
2933         Safefree(prev_states);
2934     }
2935
2936
2937     /* and now dump out the compressed format */
2938     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2939
2940     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2941 #ifdef DEBUGGING
2942     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2943     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2944 #else
2945     SvREFCNT_dec_NN(revcharmap);
2946 #endif
2947     return trie->jump
2948            ? MADE_JUMP_TRIE
2949            : trie->startstate>1
2950              ? MADE_EXACT_TRIE
2951              : MADE_TRIE;
2952 }
2953
2954 STATIC void
2955 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2956 {
2957 /* The Trie is constructed and compressed now so we can build a fail array if
2958  * it's needed
2959
2960    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and
2961    3.32 in the
2962    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi,
2963    Ullman 1985/88
2964    ISBN 0-201-10088-6
2965
2966    We find the fail state for each state in the trie, this state is the longest
2967    proper suffix of the current state's 'word' that is also a proper prefix of
2968    another word in our trie. State 1 represents the word '' and is thus the
2969    default fail state. This allows the DFA not to have to restart after its
2970    tried and failed a word at a given point, it simply continues as though it
2971    had been matching the other word in the first place.
2972    Consider
2973       'abcdgu'=~/abcdefg|cdgu/
2974    When we get to 'd' we are still matching the first word, we would encounter
2975    'g' which would fail, which would bring us to the state representing 'd' in
2976    the second word where we would try 'g' and succeed, proceeding to match
2977    'cdgu'.
2978  */
2979  /* add a fail transition */
2980     const U32 trie_offset = ARG(source);
2981     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2982     U32 *q;
2983     const U32 ucharcount = trie->uniquecharcount;
2984     const U32 numstates = trie->statecount;
2985     const U32 ubound = trie->lasttrans + ucharcount;
2986     U32 q_read = 0;
2987     U32 q_write = 0;
2988     U32 charid;
2989     U32 base = trie->states[ 1 ].trans.base;
2990     U32 *fail;
2991     reg_ac_data *aho;
2992     const U32 data_slot = add_data( pRExC_state, STR_WITH_LEN("T"));
2993     GET_RE_DEBUG_FLAGS_DECL;
2994
2995     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2996 #ifndef DEBUGGING
2997     PERL_UNUSED_ARG(depth);
2998 #endif
2999
3000
3001     ARG_SET( stclass, data_slot );
3002     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
3003     RExC_rxi->data->data[ data_slot ] = (void*)aho;
3004     aho->trie=trie_offset;
3005     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
3006     Copy( trie->states, aho->states, numstates, reg_trie_state );
3007     Newxz( q, numstates, U32);
3008     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
3009     aho->refcount = 1;
3010     fail = aho->fail;
3011     /* initialize fail[0..1] to be 1 so that we always have
3012        a valid final fail state */
3013     fail[ 0 ] = fail[ 1 ] = 1;
3014
3015     for ( charid = 0; charid < ucharcount ; charid++ ) {
3016         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
3017         if ( newstate ) {
3018             q[ q_write ] = newstate;
3019             /* set to point at the root */
3020             fail[ q[ q_write++ ] ]=1;
3021         }
3022     }
3023     while ( q_read < q_write) {
3024         const U32 cur = q[ q_read++ % numstates ];
3025         base = trie->states[ cur ].trans.base;
3026
3027         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
3028             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
3029             if (ch_state) {
3030                 U32 fail_state = cur;
3031                 U32 fail_base;
3032                 do {
3033                     fail_state = fail[ fail_state ];
3034                     fail_base = aho->states[ fail_state ].trans.base;
3035                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
3036
3037                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
3038                 fail[ ch_state ] = fail_state;
3039                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
3040                 {
3041                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
3042                 }
3043                 q[ q_write++ % numstates] = ch_state;
3044             }
3045         }
3046     }
3047     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
3048        when we fail in state 1, this allows us to use the
3049        charclass scan to find a valid start char. This is based on the principle
3050        that theres a good chance the string being searched contains lots of stuff
3051        that cant be a start char.
3052      */
3053     fail[ 0 ] = fail[ 1 ] = 0;
3054     DEBUG_TRIE_COMPILE_r({
3055         PerlIO_printf(Perl_debug_log,
3056                       "%*sStclass Failtable (%"UVuf" states): 0",
3057                       (int)(depth * 2), "", (UV)numstates
3058         );
3059         for( q_read=1; q_read<numstates; q_read++ ) {
3060             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
3061         }
3062         PerlIO_printf(Perl_debug_log, "\n");
3063     });
3064     Safefree(q);
3065     /*RExC_seen |= REG_TRIEDFA_SEEN;*/
3066 }
3067
3068
3069 #define DEBUG_PEEP(str,scan,depth) \
3070     DEBUG_OPTIMISE_r({if (scan){ \
3071        SV * const mysv=sv_newmortal(); \
3072        regnode *Next = regnext(scan); \
3073        regprop(RExC_rx, mysv, scan); \
3074        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
3075        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
3076        Next ? (REG_NODE_NUM(Next)) : 0 ); \
3077    }});
3078
3079
3080 /* The below joins as many adjacent EXACTish nodes as possible into a single
3081  * one.  The regop may be changed if the node(s) contain certain sequences that
3082  * require special handling.  The joining is only done if:
3083  * 1) there is room in the current conglomerated node to entirely contain the
3084  *    next one.
3085  * 2) they are the exact same node type
3086  *
3087  * The adjacent nodes actually may be separated by NOTHING-kind nodes, and
3088  * these get optimized out
3089  *
3090  * If a node is to match under /i (folded), the number of characters it matches
3091  * can be different than its character length if it contains a multi-character
3092  * fold.  *min_subtract is set to the total delta number of characters of the
3093  * input nodes.
3094  *
3095  * And *unfolded_multi_char is set to indicate whether or not the node contains
3096  * an unfolded multi-char fold.  This happens when whether the fold is valid or
3097  * not won't be known until runtime; namely for EXACTF nodes that contain LATIN
3098  * SMALL LETTER SHARP S, as only if the target string being matched against
3099  * turns out to be UTF-8 is that fold valid; and also for EXACTFL nodes whose
3100  * folding rules depend on the locale in force at runtime.  (Multi-char folds
3101  * whose components are all above the Latin1 range are not run-time locale
3102  * dependent, and have already been folded by the time this function is
3103  * called.)
3104  *
3105  * This is as good a place as any to discuss the design of handling these
3106  * multi-character fold sequences.  It's been wrong in Perl for a very long
3107  * time.  There are three code points in Unicode whose multi-character folds
3108  * were long ago discovered to mess things up.  The previous designs for
3109  * dealing with these involved assigning a special node for them.  This
3110  * approach doesn't always work, as evidenced by this example:
3111  *      "\xDFs" =~ /s\xDF/ui    # Used to fail before these patches
3112  * Both sides fold to "sss", but if the pattern is parsed to create a node that
3113  * would match just the \xDF, it won't be able to handle the case where a
3114  * successful match would have to cross the node's boundary.  The new approach
3115  * that hopefully generally solves the problem generates an EXACTFU_SS node
3116  * that is "sss" in this case.
3117  *
3118  * It turns out that there are problems with all multi-character folds, and not
3119  * just these three.  Now the code is general, for all such cases.  The
3120  * approach taken is:
3121  * 1)   This routine examines each EXACTFish node that could contain multi-
3122  *      character folded sequences.  Since a single character can fold into
3123  *      such a sequence, the minimum match length for this node is less than
3124  *      the number of characters in the node.  This routine returns in
3125  *      *min_subtract how many characters to subtract from the the actual
3126  *      length of the string to get a real minimum match length; it is 0 if
3127  *      there are no multi-char foldeds.  This delta is used by the caller to
3128  *      adjust the min length of the match, and the delta between min and max,
3129  *      so that the optimizer doesn't reject these possibilities based on size
3130  *      constraints.
3131  * 2)   For the sequence involving the Sharp s (\xDF), the node type EXACTFU_SS
3132  *      is used for an EXACTFU node that contains at least one "ss" sequence in
3133  *      it.  For non-UTF-8 patterns and strings, this is the only case where
3134  *      there is a possible fold length change.  That means that a regular
3135  *      EXACTFU node without UTF-8 involvement doesn't have to concern itself
3136  *      with length changes, and so can be processed faster.  regexec.c takes
3137  *      advantage of this.  Generally, an EXACTFish node that is in UTF-8 is
3138  *      pre-folded by regcomp.c (except EXACTFL, some of whose folds aren't
3139  *      known until runtime).  This saves effort in regex matching.  However,
3140  *      the pre-folding isn't done for non-UTF8 patterns because the fold of
3141  *      the MICRO SIGN requires UTF-8, and we don't want to slow things down by
3142  *      forcing the pattern into UTF8 unless necessary.  Also what EXACTF (and,
3143  *      again, EXACTFL) nodes fold to isn't known until runtime.  The fold
3144  *      possibilities for the non-UTF8 patterns are quite simple, except for
3145  *      the sharp s.  All the ones that don't involve a UTF-8 target string are
3146  *      members of a fold-pair, and arrays are set up for all of them so that
3147  *      the other member of the pair can be found quickly.  Code elsewhere in
3148  *      this file makes sure that in EXACTFU nodes, the sharp s gets folded to
3149  *      'ss', even if the pattern isn't UTF-8.  This avoids the issues
3150  *      described in the next item.
3151  * 3)   A problem remains for unfolded multi-char folds. (These occur when the
3152  *      validity of the fold won't be known until runtime, and so must remain
3153  *      unfolded for now.  This happens for the sharp s in EXACTF and EXACTFA
3154  *      nodes when the pattern isn't in UTF-8.  (Note, BTW, that there cannot
3155  *      be an EXACTF node with a UTF-8 pattern.)  They also occur for various
3156  *      folds in EXACTFL nodes, regardless of the UTF-ness of the pattern.)
3157  *      The reason this is a problem is that the optimizer part of regexec.c
3158  *      (probably unwittingly, in Perl_regexec_flags()) makes an assumption
3159  *      that a character in the pattern corresponds to at most a single
3160  *      character in the target string.  (And I do mean character, and not byte
3161  *      here, unlike other parts of the documentation that have never been
3162  *      updated to account for multibyte Unicode.)  sharp s in EXACTF and
3163  *      EXACTFL nodes can match the two character string 'ss'; in EXACTFA nodes
3164  *      it can match "\x{17F}\x{17F}".  These, along with other ones in EXACTFL
3165  *      nodes, violate the assumption, and they are the only instances where it
3166  *      is violated.  I'm reluctant to try to change the assumption, as the
3167  *      code involved is impenetrable to me (khw), so instead the code here
3168  *      punts.  This routine examines EXACTFL nodes, and (when the pattern
3169  *      isn't UTF-8) EXACTF and EXACTFA for such unfolded folds, and returns a
3170  *      boolean indicating whether or not the node contains such a fold.  When
3171  *      it is true, the caller sets a flag that later causes the optimizer in
3172  *      this file to not set values for the floating and fixed string lengths,
3173  *      and thus avoids the optimizer code in regexec.c that makes the invalid
3174  *      assumption.  Thus, there is no optimization based on string lengths for
3175  *      EXACTFL nodes that contain these few folds, nor for non-UTF8-pattern
3176  *      EXACTF and EXACTFA nodes that contain the sharp s.  (The reason the
3177  *      assumption is wrong only in these cases is that all other non-UTF-8
3178  *      folds are 1-1; and, for UTF-8 patterns, we pre-fold all other folds to
3179  *      their expanded versions.  (Again, we can't prefold sharp s to 'ss' in
3180  *      EXACTF nodes because we don't know at compile time if it actually
3181  *      matches 'ss' or not.  For EXACTF nodes it will match iff the target
3182  *      string is in UTF-8.  This is in contrast to EXACTFU nodes, where it
3183  *      always matches; and EXACTFA where it never does.  In an EXACTFA node in
3184  *      a UTF-8 pattern, sharp s is folded to "\x{17F}\x{17F}, avoiding the
3185  *      problem; but in a non-UTF8 pattern, folding it to that above-Latin1
3186  *      string would require the pattern to be forced into UTF-8, the overhead
3187  *      of which we want to avoid.  Similarly the unfolded multi-char folds in
3188  *      EXACTFL nodes will match iff the locale at the time of match is a UTF-8
3189  *      locale.)
3190  *
3191  *      Similarly, the code that generates tries doesn't currently handle
3192  *      not-already-folded multi-char folds, and it looks like a pain to change
3193  *      that.  Therefore, trie generation of EXACTFA nodes with the sharp s
3194  *      doesn't work.  Instead, such an EXACTFA is turned into a new regnode,
3195  *      EXACTFA_NO_TRIE, which the trie code knows not to handle.  Most people
3196  *      using /iaa matching will be doing so almost entirely with ASCII
3197  *      strings, so this should rarely be encountered in practice */
3198
3199 #define JOIN_EXACT(scan,min_subtract,unfolded_multi_char, flags) \
3200     if (PL_regkind[OP(scan)] == EXACT) \
3201         join_exact(pRExC_state,(scan),(min_subtract),unfolded_multi_char, (flags),NULL,depth+1)
3202
3203 STATIC U32
3204 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan,
3205                    UV *min_subtract, bool *unfolded_multi_char,
3206                    U32 flags,regnode *val, U32 depth)
3207 {
3208     /* Merge several consecutive EXACTish nodes into one. */
3209     regnode *n = regnext(scan);
3210     U32 stringok = 1;
3211     regnode *next = scan + NODE_SZ_STR(scan);
3212     U32 merged = 0;
3213     U32 stopnow = 0;
3214 #ifdef DEBUGGING
3215     regnode *stop = scan;
3216     GET_RE_DEBUG_FLAGS_DECL;
3217 #else
3218     PERL_UNUSED_ARG(depth);
3219 #endif
3220
3221     PERL_ARGS_ASSERT_JOIN_EXACT;
3222 #ifndef EXPERIMENTAL_INPLACESCAN
3223     PERL_UNUSED_ARG(flags);
3224     PERL_UNUSED_ARG(val);
3225 #endif
3226     DEBUG_PEEP("join",scan,depth);
3227
3228     /* Look through the subsequent nodes in the chain.  Skip NOTHING, merge
3229      * EXACT ones that are mergeable to the current one. */
3230     while (n
3231            && (PL_regkind[OP(n)] == NOTHING
3232                || (stringok && OP(n) == OP(scan)))
3233            && NEXT_OFF(n)
3234            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX)
3235     {
3236
3237         if (OP(n) == TAIL || n > next)
3238             stringok = 0;
3239         if (PL_regkind[OP(n)] == NOTHING) {
3240             DEBUG_PEEP("skip:",n,depth);
3241             NEXT_OFF(scan) += NEXT_OFF(n);
3242             next = n + NODE_STEP_REGNODE;
3243 #ifdef DEBUGGING
3244             if (stringok)
3245                 stop = n;
3246 #endif
3247             n = regnext(n);
3248         }
3249         else if (stringok) {
3250             const unsigned int oldl = STR_LEN(scan);
3251             regnode * const nnext = regnext(n);
3252
3253             /* XXX I (khw) kind of doubt that this works on platforms (should
3254              * Perl ever run on one) where U8_MAX is above 255 because of lots
3255              * of other assumptions */
3256             /* Don't join if the sum can't fit into a single node */
3257             if (oldl + STR_LEN(n) > U8_MAX)
3258                 break;
3259
3260             DEBUG_PEEP("merg",n,depth);
3261             merged++;
3262
3263             NEXT_OFF(scan) += NEXT_OFF(n);
3264             STR_LEN(scan) += STR_LEN(n);
3265             next = n + NODE_SZ_STR(n);
3266             /* Now we can overwrite *n : */
3267             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
3268 #ifdef DEBUGGING
3269             stop = next - 1;
3270 #endif
3271             n = nnext;
3272             if (stopnow) break;
3273         }
3274
3275 #ifdef EXPERIMENTAL_INPLACESCAN
3276         if (flags && !NEXT_OFF(n)) {
3277             DEBUG_PEEP("atch", val, depth);
3278             if (reg_off_by_arg[OP(n)]) {
3279                 ARG_SET(n, val - n);
3280             }
3281             else {
3282                 NEXT_OFF(n) = val - n;
3283             }
3284             stopnow = 1;
3285         }
3286 #endif
3287     }
3288
3289     *min_subtract = 0;
3290     *unfolded_multi_char = FALSE;
3291
3292     /* Here, all the adjacent mergeable EXACTish nodes have been merged.  We
3293      * can now analyze for sequences of problematic code points.  (Prior to
3294      * this final joining, sequences could have been split over boundaries, and
3295      * hence missed).  The sequences only happen in folding, hence for any
3296      * non-EXACT EXACTish node */
3297     if (OP(scan) != EXACT) {
3298         U8* s0 = (U8*) STRING(scan);
3299         U8* s = s0;
3300         U8* s_end = s0 + STR_LEN(scan);
3301
3302         int total_count_delta = 0;  /* Total delta number of characters that
3303                                        multi-char folds expand to */
3304
3305         /* One pass is made over the node's string looking for all the
3306          * possibilities.  To avoid some tests in the loop, there are two main
3307          * cases, for UTF-8 patterns (which can't have EXACTF nodes) and
3308          * non-UTF-8 */
3309         if (UTF) {
3310             U8* folded = NULL;
3311
3312             if (OP(scan) == EXACTFL) {
3313                 U8 *d;
3314
3315                 /* An EXACTFL node would already have been changed to another
3316                  * node type unless there is at least one character in it that
3317                  * is problematic; likely a character whose fold definition
3318                  * won't be known until runtime, and so has yet to be folded.
3319                  * For all but the UTF-8 locale, folds are 1-1 in length, but
3320                  * to handle the UTF-8 case, we need to create a temporary
3321                  * folded copy using UTF-8 locale rules in order to analyze it.
3322                  * This is because our macros that look to see if a sequence is
3323                  * a multi-char fold assume everything is folded (otherwise the
3324                  * tests in those macros would be too complicated and slow).
3325                  * Note that here, the non-problematic folds will have already
3326                  * been done, so we can just copy such characters.  We actually
3327                  * don't completely fold the EXACTFL string.  We skip the
3328                  * unfolded multi-char folds, as that would just create work
3329                  * below to figure out the size they already are */
3330
3331                 Newx(folded, UTF8_MAX_FOLD_CHAR_EXPAND * STR_LEN(scan) + 1, U8);
3332                 d = folded;
3333                 while (s < s_end) {
3334                     STRLEN s_len = UTF8SKIP(s);
3335                     if (! is_PROBLEMATIC_LOCALE_FOLD_utf8(s)) {
3336                         Copy(s, d, s_len, U8);
3337                         d += s_len;
3338                     }
3339                     else if (is_FOLDS_TO_MULTI_utf8(s)) {
3340                         *unfolded_multi_char = TRUE;
3341                         Copy(s, d, s_len, U8);
3342                         d += s_len;
3343                     }
3344                     else if (isASCII(*s)) {
3345                         *(d++) = toFOLD(*s);
3346                     }
3347                     else {
3348                         STRLEN len;
3349                         _to_utf8_fold_flags(s, d, &len, FOLD_FLAGS_FULL);
3350                         d += len;
3351                     }
3352                     s += s_len;
3353                 }
3354
3355                 /* Point the remainder of the routine to look at our temporary
3356                  * folded copy */
3357                 s = folded;
3358                 s_end = d;
3359             } /* End of creating folded copy of EXACTFL string */
3360
3361             /* Examine the string for a multi-character fold sequence.  UTF-8
3362              * patterns have all characters pre-folded by the time this code is
3363              * executed */
3364             while (s < s_end - 1) /* Can stop 1 before the end, as minimum
3365                                      length sequence we are looking for is 2 */
3366             {
3367                 int count = 0;  /* How many characters in a multi-char fold */
3368                 int len = is_MULTI_CHAR_FOLD_utf8(s);
3369                 if (! len) {    /* Not a multi-char fold: get next char */
3370                     s += UTF8SKIP(s);
3371                     continue;
3372                 }
3373
3374                 /* Nodes with 'ss' require special handling, except for
3375                  * EXACTFA-ish for which there is no multi-char fold to this */
3376                 if (len == 2 && *s == 's' && *(s+1) == 's'
3377                     && OP(scan) != EXACTFA
3378                     && OP(scan) != EXACTFA_NO_TRIE)
3379                 {
3380                     count = 2;
3381                     if (OP(scan) != EXACTFL) {
3382                         OP(scan) = EXACTFU_SS;
3383                     }
3384                     s += 2;
3385                 }
3386                 else { /* Here is a generic multi-char fold. */
3387                     U8* multi_end  = s + len;
3388
3389                     /* Count how many characters in it.  In the case of /aa, no
3390                      * folds which contain ASCII code points are allowed, so
3391                      * check for those, and skip if found. */
3392                     if (OP(scan) != EXACTFA && OP(scan) != EXACTFA_NO_TRIE) {
3393                         count = utf8_length(s, multi_end);
3394                         s = multi_end;
3395                     }
3396                     else {
3397                         while (s < multi_end) {
3398                             if (isASCII(*s)) {
3399                                 s++;
3400                                 goto next_iteration;
3401                             }
3402                             else {
3403                                 s += UTF8SKIP(s);
3404                             }
3405                             count++;
3406                         }
3407                     }
3408                 }
3409
3410                 /* The delta is how long the sequence is minus 1 (1 is how long
3411                  * the character that folds to the sequence is) */
3412                 total_count_delta += count - 1;
3413               next_iteration: ;
3414             }
3415
3416             /* We created a temporary folded copy of the string in EXACTFL
3417              * nodes.  Therefore we need to be sure it doesn't go below zero,
3418              * as the real string could be shorter */
3419             if (OP(scan) == EXACTFL) {
3420                 int total_chars = utf8_length((U8*) STRING(scan),
3421                                            (U8*) STRING(scan) + STR_LEN(scan));
3422                 if (total_count_delta > total_chars) {
3423                     total_count_delta = total_chars;
3424                 }
3425             }
3426
3427             *min_subtract += total_count_delta;
3428             Safefree(folded);
3429         }
3430         else if (OP(scan) == EXACTFA) {
3431
3432             /* Non-UTF-8 pattern, EXACTFA node.  There can't be a multi-char
3433              * fold to the ASCII range (and there are no existing ones in the
3434              * upper latin1 range).  But, as outlined in the comments preceding
3435              * this function, we need to flag any occurrences of the sharp s.
3436              * This character forbids trie formation (because of added
3437              * complexity) */
3438             while (s < s_end) {
3439                 if (*s == LATIN_SMALL_LETTER_SHARP_S) {
3440                     OP(scan) = EXACTFA_NO_TRIE;
3441                     *unfolded_multi_char = TRUE;
3442                     break;
3443                 }
3444                 s++;
3445                 continue;
3446             }
3447         }
3448         else {
3449
3450             /* Non-UTF-8 pattern, not EXACTFA node.  Look for the multi-char
3451              * folds that are all Latin1.  As explained in the comments
3452              * preceding this function, we look also for the sharp s in EXACTF
3453              * and EXACTFL nodes; it can be in the final position.  Otherwise
3454              * we can stop looking 1 byte earlier because have to find at least
3455              * two characters for a multi-fold */
3456             const U8* upper = (OP(scan) == EXACTF || OP(scan) == EXACTFL)
3457                               ? s_end
3458                               : s_end -1;
3459
3460             while (s < upper) {
3461                 int len = is_MULTI_CHAR_FOLD_latin1(s);
3462                 if (! len) {    /* Not a multi-char fold. */
3463                     if (*s == LATIN_SMALL_LETTER_SHARP_S
3464                         && (OP(scan) == EXACTF || OP(scan) == EXACTFL))
3465                     {
3466                         *unfolded_multi_char = TRUE;
3467                     }
3468                     s++;
3469                     continue;
3470                 }
3471
3472                 if (len == 2
3473                     && isARG2_lower_or_UPPER_ARG1('s', *s)
3474                     && isARG2_lower_or_UPPER_ARG1('s', *(s+1)))
3475                 {
3476
3477                     /* EXACTF nodes need to know that the minimum length
3478                      * changed so that a sharp s in the string can match this
3479                      * ss in the pattern, but they remain EXACTF nodes, as they
3480                      * won't match this unless the target string is is UTF-8,
3481                      * which we don't know until runtime.  EXACTFL nodes can't
3482                      * transform into EXACTFU nodes */
3483                     if (OP(scan) != EXACTF && OP(scan) != EXACTFL) {
3484                         OP(scan) = EXACTFU_SS;
3485                     }
3486                 }
3487
3488                 *min_subtract += len - 1;
3489                 s += len;
3490             }
3491         }
3492     }
3493
3494 #ifdef DEBUGGING
3495     /* Allow dumping but overwriting the collection of skipped
3496      * ops and/or strings with fake optimized ops */
3497     n = scan + NODE_SZ_STR(scan);
3498     while (n <= stop) {
3499         OP(n) = OPTIMIZED;
3500         FLAGS(n) = 0;
3501         NEXT_OFF(n) = 0;
3502         n++;
3503     }
3504 #endif
3505     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
3506     return stopnow;
3507 }
3508
3509 /* REx optimizer.  Converts nodes into quicker variants "in place".
3510    Finds fixed substrings.  */
3511
3512 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
3513    to the position after last scanned or to NULL. */
3514
3515 #define INIT_AND_WITHP \
3516     assert(!and_withp); \
3517     Newx(and_withp,1, regnode_ssc); \
3518     SAVEFREEPV(and_withp)
3519
3520 /* this is a chain of data about sub patterns we are processing that
3521    need to be handled separately/specially in study_chunk. Its so
3522    we can simulate recursion without losing state.  */
3523 struct scan_frame;
3524 typedef struct scan_frame {
3525     regnode *last;  /* last node to process in this frame */
3526     regnode *next;  /* next node to process when last is reached */
3527     struct scan_frame *prev; /*previous frame*/
3528     U32 prev_recursed_depth;
3529     I32 stop; /* what stopparen do we use */
3530 } scan_frame;
3531
3532
3533 STATIC SSize_t
3534 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
3535                         SSize_t *minlenp, SSize_t *deltap,
3536                         regnode *last,
3537                         scan_data_t *data,
3538                         I32 stopparen,
3539                         U32 recursed_depth,
3540                         regnode_ssc *and_withp,
3541                         U32 flags, U32 depth)
3542                         /* scanp: Start here (read-write). */
3543                         /* deltap: Write maxlen-minlen here. */
3544                         /* last: Stop before this one. */
3545                         /* data: string data about the pattern */
3546                         /* stopparen: treat close N as END */
3547                         /* recursed: which subroutines have we recursed into */
3548                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
3549 {
3550     dVAR;
3551     /* There must be at least this number of characters to match */
3552     SSize_t min = 0;
3553     I32 pars = 0, code;
3554     regnode *scan = *scanp, *next;
3555     SSize_t delta = 0;
3556     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
3557     int is_inf_internal = 0;            /* The studied chunk is infinite */
3558     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
3559     scan_data_t data_fake;
3560     SV *re_trie_maxbuff = NULL;
3561     regnode *first_non_open = scan;
3562     SSize_t stopmin = SSize_t_MAX;
3563     scan_frame *frame = NULL;
3564     GET_RE_DEBUG_FLAGS_DECL;
3565
3566     PERL_ARGS_ASSERT_STUDY_CHUNK;
3567
3568 #ifdef DEBUGGING
3569     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
3570 #endif
3571     if ( depth == 0 ) {
3572         while (first_non_open && OP(first_non_open) == OPEN)
3573             first_non_open=regnext(first_non_open);
3574     }
3575
3576
3577   fake_study_recurse:
3578     while ( scan && OP(scan) != END && scan < last ){
3579         UV min_subtract = 0;    /* How mmany chars to subtract from the minimum
3580                                    node length to get a real minimum (because
3581                                    the folded version may be shorter) */
3582         bool unfolded_multi_char = FALSE;
3583         /* Peephole optimizer: */
3584         DEBUG_OPTIMISE_MORE_r(
3585         {
3586             PerlIO_printf(Perl_debug_log,
3587                 "%*sstudy_chunk stopparen=%ld depth=%lu recursed_depth=%lu ",
3588                 ((int) depth*2), "", (long)stopparen,
3589                 (unsigned long)depth, (unsigned long)recursed_depth);
3590             if (recursed_depth) {
3591                 U32 i;
3592                 U32 j;
3593                 for ( j = 0 ; j < recursed_depth ; j++ ) {
3594                     PerlIO_printf(Perl_debug_log,"[");
3595                     for ( i = 0 ; i < (U32)RExC_npar ; i++ )
3596                         PerlIO_printf(Perl_debug_log,"%d",
3597                             PAREN_TEST(RExC_study_chunk_recursed +
3598                                        (j * RExC_study_chunk_recursed_bytes), i)
3599                             ? 1 : 0
3600                         );
3601                     PerlIO_printf(Perl_debug_log,"]");
3602                 }
3603             }
3604             PerlIO_printf(Perl_debug_log,"\n");
3605         }
3606         );
3607         DEBUG_STUDYDATA("Peep:", data, depth);
3608         DEBUG_PEEP("Peep", scan, depth);
3609
3610
3611         /* The reason we do this here we need to deal with things like /(?:f)(?:o)(?:o)/
3612          * which cant be dealt with by the normal EXACT parsing code, as each (?:..) is handled
3613          * by a different invocation of reg() -- Yves
3614          */
3615         JOIN_EXACT(scan,&min_subtract, &unfolded_multi_char, 0);
3616
3617         /* Follow the next-chain of the current node and optimize
3618            away all the NOTHINGs from it.  */
3619         if (OP(scan) != CURLYX) {
3620             const int max = (reg_off_by_arg[OP(scan)]
3621                        ? I32_MAX
3622                        /* I32 may be smaller than U16 on CRAYs! */
3623                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
3624             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
3625             int noff;
3626             regnode *n = scan;
3627
3628             /* Skip NOTHING and LONGJMP. */
3629             while ((n = regnext(n))
3630                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
3631                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
3632                    && off + noff < max)
3633                 off += noff;
3634             if (reg_off_by_arg[OP(scan)])
3635                 ARG(scan) = off;
3636             else
3637                 NEXT_OFF(scan) = off;
3638         }
3639
3640
3641
3642         /* The principal pseudo-switch.  Cannot be a switch, since we
3643            look into several different things.  */
3644         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
3645                    || OP(scan) == IFTHEN) {
3646             next = regnext(scan);
3647             code = OP(scan);
3648             /* demq: the op(next)==code check is to see if we have
3649              * "branch-branch" AFAICT */
3650
3651             if (OP(next) == code || code == IFTHEN) {
3652                 /* NOTE - There is similar code to this block below for
3653                  * handling TRIE nodes on a re-study.  If you change stuff here
3654                  * check there too. */
3655                 SSize_t max1 = 0, min1 = SSize_t_MAX, num = 0;
3656                 regnode_ssc accum;
3657                 regnode * const startbranch=scan;
3658
3659                 if (flags & SCF_DO_SUBSTR) {
3660                     /* Cannot merge strings after this. */
3661                     scan_commit(pRExC_state, data, minlenp, is_inf);
3662                 }
3663
3664                 if (flags & SCF_DO_STCLASS)
3665                     ssc_init_zero(pRExC_state, &accum);
3666
3667                 while (OP(scan) == code) {
3668                     SSize_t deltanext, minnext, fake;
3669                     I32 f = 0;
3670                     regnode_ssc this_class;
3671
3672                     num++;
3673                     data_fake.flags = 0;
3674                     if (data) {
3675                         data_fake.whilem_c = data->whilem_c;
3676                         data_fake.last_closep = data->last_closep;
3677                     }
3678                     else
3679                         data_fake.last_closep = &fake;
3680
3681                     data_fake.pos_delta = delta;
3682                     next = regnext(scan);
3683                     scan = NEXTOPER(scan);
3684                     if (code != BRANCH)
3685                         scan = NEXTOPER(scan);
3686                     if (flags & SCF_DO_STCLASS) {
3687                         ssc_init(pRExC_state, &this_class);
3688                         data_fake.start_class = &this_class;
3689                         f = SCF_DO_STCLASS_AND;
3690                     }
3691                     if (flags & SCF_WHILEM_VISITED_POS)
3692                         f |= SCF_WHILEM_VISITED_POS;
3693
3694                     /* we suppose the run is continuous, last=next...*/
3695                     minnext = study_chunk(pRExC_state, &scan, minlenp,
3696                                       &deltanext, next, &data_fake, stopparen,
3697                                       recursed_depth, NULL, f,depth+1);
3698                     if (min1 > minnext)
3699                         min1 = minnext;
3700                     if (deltanext == SSize_t_MAX) {
3701                         is_inf = is_inf_internal = 1;
3702                         max1 = SSize_t_MAX;
3703                     } else if (max1 < minnext + deltanext)
3704                         max1 = minnext + deltanext;
3705                     scan = next;
3706                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3707                         pars++;
3708                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3709                         if ( stopmin > minnext)
3710                             stopmin = min + min1;
3711                         flags &= ~SCF_DO_SUBSTR;
3712                         if (data)
3713                             data->flags |= SCF_SEEN_ACCEPT;
3714                     }
3715                     if (data) {
3716                         if (data_fake.flags & SF_HAS_EVAL)
3717                             data->flags |= SF_HAS_EVAL;
3718                         data->whilem_c = data_fake.whilem_c;
3719                     }
3720                     if (flags & SCF_DO_STCLASS)
3721                         ssc_or(pRExC_state, &accum, (regnode_charclass*)&this_class);
3722                 }
3723                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
3724                     min1 = 0;
3725                 if (flags & SCF_DO_SUBSTR) {
3726                     data->pos_min += min1;
3727                     if (data->pos_delta >= SSize_t_MAX - (max1 - min1))
3728                         data->pos_delta = SSize_t_MAX;
3729                     else
3730                         data->pos_delta += max1 - min1;
3731                     if (max1 != min1 || is_inf)
3732                         data->longest = &(data->longest_float);
3733                 }
3734                 min += min1;
3735                 if (delta == SSize_t_MAX
3736                  || SSize_t_MAX - delta - (max1 - min1) < 0)
3737                     delta = SSize_t_MAX;
3738                 else
3739                     delta += max1 - min1;
3740                 if (flags & SCF_DO_STCLASS_OR) {
3741                     ssc_or(pRExC_state, data->start_class, (regnode_charclass*) &accum);
3742                     if (min1) {
3743                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) and_withp);
3744                         flags &= ~SCF_DO_STCLASS;
3745                     }
3746                 }
3747                 else if (flags & SCF_DO_STCLASS_AND) {
3748                     if (min1) {
3749                         ssc_and(pRExC_state, data->start_class, (regnode_charclass *) &accum);
3750                         flags &= ~SCF_DO_STCLASS;
3751                     }
3752                     else {
3753                         /* Switch to OR mode: cache the old value of
3754                          * data->start_class */
3755                         INIT_AND_WITHP;
3756                         StructCopy(data->start_class, and_withp, regnode_ssc);
3757                         flags &= ~SCF_DO_STCLASS_AND;
3758                         StructCopy(&accum, data->start_class, regnode_ssc);
3759                         flags |= SCF_DO_STCLASS_OR;
3760                     }
3761                 }
3762
3763                 if (PERL_ENABLE_TRIE_OPTIMISATION &&
3764                         OP( startbranch ) == BRANCH )
3765                 {
3766                 /* demq.
3767
3768                    Assuming this was/is a branch we are dealing with: 'scan'
3769                    now points at the item that follows the branch sequence,
3770                    whatever it is. We now start at the beginning of the
3771                    sequence and look for subsequences of
3772
3773                    BRANCH->EXACT=>x1
3774                    BRANCH->EXACT=>x2
3775                    tail
3776
3777                    which would be constructed from a pattern like
3778                    /A|LIST|OF|WORDS/
3779
3780                    If we can find such a subsequence we need to turn the first
3781                    element into a trie and then add the subsequent branch exact
3782                    strings to the trie.
3783
3784                    We have two cases
3785
3786                      1. patterns where the whole set of branches can be
3787                         converted.
3788
3789                      2. patterns where only a subset can be converted.
3790
3791                    In case 1 we can replace the whole set with a single regop
3792                    for the trie. In case 2 we need to keep the start and end
3793                    branches so
3794
3795                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
3796                      becomes BRANCH TRIE; BRANCH X;
3797
3798                   There is an additional case, that being where there is a
3799                   common prefix, which gets split out into an EXACT like node
3800                   preceding the TRIE node.
3801
3802                   If x(1..n)==tail then we can do a simple trie, if not we make
3803                   a "jump" trie, such that when we match the appropriate word
3804                   we "jump" to the appropriate tail node. Essentially we turn
3805                   a nested if into a case structure of sorts.
3806
3807                 */
3808
3809                     int made=0;
3810                     if (!re_trie_maxbuff) {
3811                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
3812                         if (!SvIOK(re_trie_maxbuff))
3813                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
3814                     }
3815                     if ( SvIV(re_trie_maxbuff)>=0  ) {
3816                         regnode *cur;
3817                         regnode *first = (regnode *)NULL;
3818                         regnode *last = (regnode *)NULL;
3819                         regnode *tail = scan;
3820                         U8 trietype = 0;
3821                         U32 count=0;
3822
3823 #ifdef DEBUGGING
3824                         SV * const mysv = sv_newmortal();   /* for dumping */
3825 #endif
3826                         /* var tail is used because there may be a TAIL
3827                            regop in the way. Ie, the exacts will point to the
3828                            thing following the TAIL, but the last branch will
3829                            point at the TAIL. So we advance tail. If we
3830                            have nested (?:) we may have to move through several
3831                            tails.
3832                          */
3833
3834                         while ( OP( tail ) == TAIL ) {
3835                             /* this is the TAIL generated by (?:) */
3836                             tail = regnext( tail );
3837                         }
3838
3839
3840                         DEBUG_TRIE_COMPILE_r({
3841                             regprop(RExC_rx, mysv, tail );
3842                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
3843                               (int)depth * 2 + 2, "",
3844                               "Looking for TRIE'able sequences. Tail node is: ",
3845                               SvPV_nolen_const( mysv )
3846                             );
3847                         });
3848
3849                         /*
3850
3851                             Step through the branches
3852                                 cur represents each branch,
3853                                 noper is the first thing to be matched as part
3854                                       of that branch
3855                                 noper_next is the regnext() of that node.
3856
3857                             We normally handle a case like this
3858                             /FOO[xyz]|BAR[pqr]/ via a "jump trie" but we also
3859                             support building with NOJUMPTRIE, which restricts
3860                             the trie logic to structures like /FOO|BAR/.
3861
3862                             If noper is a trieable nodetype then the branch is
3863                             a possible optimization target. If we are building
3864                             under NOJUMPTRIE then we require that noper_next is
3865                             the same as scan (our current position in the regex
3866                             program).
3867
3868                             Once we have two or more consecutive such branches
3869                             we can create a trie of the EXACT's contents and
3870                             stitch it in place into the program.
3871
3872                             If the sequence represents all of the branches in
3873                             the alternation we replace the entire thing with a
3874                             single TRIE node.
3875
3876                             Otherwise when it is a subsequence we need to
3877                             stitch it in place and replace only the relevant
3878                             branches. This means the first branch has to remain
3879                             as it is used by the alternation logic, and its
3880                             next pointer, and needs to be repointed at the item
3881                             on the branch chain following the last branch we
3882                             have optimized away.
3883
3884                             This could be either a BRANCH, in which case the
3885                             subsequence is internal, or it could be the item
3886                             following the branch sequence in which case the
3887                             subsequence is at the end (which does not
3888                             necessarily mean the first node is the start of the
3889                             alternation).
3890
3891                             TRIE_TYPE(X) is a define which maps the optype to a
3892                             trietype.
3893
3894                                 optype          |  trietype
3895                                 ----------------+-----------
3896                                 NOTHING         | NOTHING
3897                                 EXACT           | EXACT
3898                                 EXACTFU         | EXACTFU
3899                                 EXACTFU_SS      | EXACTFU
3900                                 EXACTFA         | EXACTFA
3901
3902
3903                         */
3904 #define TRIE_TYPE(X) ( ( NOTHING == (X) ) ? NOTHING :   \
3905                        ( EXACT == (X) )   ? EXACT :        \
3906                        ( EXACTFU == (X) || EXACTFU_SS == (X) ) ? EXACTFU :        \
3907                        ( EXACTFA == (X) ) ? EXACTFA :        \
3908                        0 )
3909
3910                         /* dont use tail as the end marker for this traverse */
3911                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3912                             regnode * const noper = NEXTOPER( cur );
3913                             U8 noper_type = OP( noper );
3914                             U8 noper_trietype = TRIE_TYPE( noper_type );
3915 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3916                             regnode * const noper_next = regnext( noper );
3917                             U8 noper_next_type = (noper_next && noper_next != tail) ? OP(noper_next) : 0;