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