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