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