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