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