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