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