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