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