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