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