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