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