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