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