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