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