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