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