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