assert() that every NN argument is not NULL. Otherwise we have the
[p5sagit/p5-mst-13.2.git] / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * "A fair jaw-cracker dwarf-language must be."  --Samwise Gamgee
6  */
7
8 /* This file contains functions for compiling a regular expression.  See
9  * also regexec.c which funnily enough, contains functions for executing
10  * a regular expression.
11  *
12  * This file is also copied at build time to ext/re/re_comp.c, where
13  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
14  * This causes the main functions to be compiled under new names and with
15  * debugging support added, which makes "use re 'debug'" work.
16  */
17
18 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
19  * confused with the original package (see point 3 below).  Thanks, Henry!
20  */
21
22 /* Additional note: this code is very heavily munged from Henry's version
23  * in places.  In some spots I've traded clarity for efficiency, so don't
24  * blame Henry for some of the lack of readability.
25  */
26
27 /* The names of the functions have been changed from regcomp and
28  * regexec to  pregcomp and pregexec in order to avoid conflicts
29  * with the POSIX routines of the same names.
30 */
31
32 #ifdef PERL_EXT_RE_BUILD
33 #include "re_top.h"
34 #endif
35
36 /*
37  * pregcomp and pregexec -- regsub and regerror are not used in perl
38  *
39  *      Copyright (c) 1986 by University of Toronto.
40  *      Written by Henry Spencer.  Not derived from licensed software.
41  *
42  *      Permission is granted to anyone to use this software for any
43  *      purpose on any computer system, and to redistribute it freely,
44  *      subject to the following restrictions:
45  *
46  *      1. The author is not responsible for the consequences of use of
47  *              this software, no matter how awful, even if they arise
48  *              from defects in it.
49  *
50  *      2. The origin of this software must not be misrepresented, either
51  *              by explicit claim or by omission.
52  *
53  *      3. Altered versions must be plainly marked as such, and must not
54  *              be misrepresented as being the original software.
55  *
56  *
57  ****    Alterations to Henry's code are...
58  ****
59  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
60  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 by Larry Wall and others
61  ****
62  ****    You may distribute under the terms of either the GNU General Public
63  ****    License or the Artistic License, as specified in the README file.
64
65  *
66  * Beware that some of this code is subtly aware of the way operator
67  * precedence is structured in regular expressions.  Serious changes in
68  * regular-expression syntax might require a total rethink.
69  */
70 #include "EXTERN.h"
71 #define PERL_IN_REGCOMP_C
72 #include "perl.h"
73
74 #ifndef PERL_IN_XSUB_RE
75 #  include "INTERN.h"
76 #endif
77
78 #define REG_COMP_C
79 #ifdef PERL_IN_XSUB_RE
80 #  include "re_comp.h"
81 #else
82 #  include "regcomp.h"
83 #endif
84
85 #ifdef op
86 #undef op
87 #endif /* op */
88
89 #ifdef MSDOS
90 #  if defined(BUGGY_MSC6)
91  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
92 #    pragma optimize("a",off)
93  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
94 #    pragma optimize("w",on )
95 #  endif /* BUGGY_MSC6 */
96 #endif /* MSDOS */
97
98 #ifndef STATIC
99 #define STATIC  static
100 #endif
101
102 typedef struct RExC_state_t {
103     U32         flags;                  /* are we folding, multilining? */
104     char        *precomp;               /* uncompiled string. */
105     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
106     regexp      *rx;                    /* perl core regexp structure */
107     regexp_internal     *rxi;           /* internal data for regexp object pprivate field */        
108     char        *start;                 /* Start of input for compile */
109     char        *end;                   /* End of input for compile */
110     char        *parse;                 /* Input-scan pointer. */
111     I32         whilem_seen;            /* number of WHILEM in this expr */
112     regnode     *emit_start;            /* Start of emitted-code area */
113     regnode     *emit_bound;            /* First regnode outside of the allocated space */
114     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
115     I32         naughty;                /* How bad is this pattern? */
116     I32         sawback;                /* Did we see \1, ...? */
117     U32         seen;
118     I32         size;                   /* Code size. */
119     I32         npar;                   /* Capture buffer count, (OPEN). */
120     I32         cpar;                   /* Capture buffer count, (CLOSE). */
121     I32         nestroot;               /* root parens we are in - used by accept */
122     I32         extralen;
123     I32         seen_zerolen;
124     I32         seen_evals;
125     regnode     **open_parens;          /* pointers to open parens */
126     regnode     **close_parens;         /* pointers to close parens */
127     regnode     *opend;                 /* END node in program */
128     I32         utf8;           /* whether the pattern is utf8 or not */
129     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
130                                 /* XXX use this for future optimisation of case
131                                  * where pattern must be upgraded to utf8. */
132     HV          *charnames;             /* cache of named sequences */
133     HV          *paren_names;           /* Paren names */
134     
135     regnode     **recurse;              /* Recurse regops */
136     I32         recurse_count;          /* Number of recurse regops */
137 #if ADD_TO_REGEXEC
138     char        *starttry;              /* -Dr: where regtry was called. */
139 #define RExC_starttry   (pRExC_state->starttry)
140 #endif
141 #ifdef DEBUGGING
142     const char  *lastparse;
143     I32         lastnum;
144     AV          *paren_name_list;       /* idx -> name */
145 #define RExC_lastparse  (pRExC_state->lastparse)
146 #define RExC_lastnum    (pRExC_state->lastnum)
147 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
148 #endif
149 } RExC_state_t;
150
151 #define RExC_flags      (pRExC_state->flags)
152 #define RExC_precomp    (pRExC_state->precomp)
153 #define RExC_rx_sv      (pRExC_state->rx_sv)
154 #define RExC_rx         (pRExC_state->rx)
155 #define RExC_rxi        (pRExC_state->rxi)
156 #define RExC_start      (pRExC_state->start)
157 #define RExC_end        (pRExC_state->end)
158 #define RExC_parse      (pRExC_state->parse)
159 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
160 #ifdef RE_TRACK_PATTERN_OFFSETS
161 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
162 #endif
163 #define RExC_emit       (pRExC_state->emit)
164 #define RExC_emit_start (pRExC_state->emit_start)
165 #define RExC_emit_bound (pRExC_state->emit_bound)
166 #define RExC_naughty    (pRExC_state->naughty)
167 #define RExC_sawback    (pRExC_state->sawback)
168 #define RExC_seen       (pRExC_state->seen)
169 #define RExC_size       (pRExC_state->size)
170 #define RExC_npar       (pRExC_state->npar)
171 #define RExC_nestroot   (pRExC_state->nestroot)
172 #define RExC_extralen   (pRExC_state->extralen)
173 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
174 #define RExC_seen_evals (pRExC_state->seen_evals)
175 #define RExC_utf8       (pRExC_state->utf8)
176 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
177 #define RExC_charnames  (pRExC_state->charnames)
178 #define RExC_open_parens        (pRExC_state->open_parens)
179 #define RExC_close_parens       (pRExC_state->close_parens)
180 #define RExC_opend      (pRExC_state->opend)
181 #define RExC_paren_names        (pRExC_state->paren_names)
182 #define RExC_recurse    (pRExC_state->recurse)
183 #define RExC_recurse_count      (pRExC_state->recurse_count)
184
185
186 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
187 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
188         ((*s) == '{' && regcurly(s)))
189
190 #ifdef SPSTART
191 #undef SPSTART          /* dratted cpp namespace... */
192 #endif
193 /*
194  * Flags to be passed up and down.
195  */
196 #define WORST           0       /* Worst case. */
197 #define HASWIDTH        0x01    /* Known to match non-null strings. */
198 #define SIMPLE          0x02    /* Simple enough to be STAR/PLUS operand. */
199 #define SPSTART         0x04    /* Starts with * or +. */
200 #define TRYAGAIN        0x08    /* Weeded out a declaration. */
201 #define POSTPONED       0x10    /* (?1),(?&name), (??{...}) or similar */
202
203 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
204
205 /* whether trie related optimizations are enabled */
206 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
207 #define TRIE_STUDY_OPT
208 #define FULL_TRIE_STUDY
209 #define TRIE_STCLASS
210 #endif
211
212
213
214 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
215 #define PBITVAL(paren) (1 << ((paren) & 7))
216 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
217 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
218 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
219
220
221 /* About scan_data_t.
222
223   During optimisation we recurse through the regexp program performing
224   various inplace (keyhole style) optimisations. In addition study_chunk
225   and scan_commit populate this data structure with information about
226   what strings MUST appear in the pattern. We look for the longest 
227   string that must appear for at a fixed location, and we look for the
228   longest string that may appear at a floating location. So for instance
229   in the pattern:
230   
231     /FOO[xX]A.*B[xX]BAR/
232     
233   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
234   strings (because they follow a .* construct). study_chunk will identify
235   both FOO and BAR as being the longest fixed and floating strings respectively.
236   
237   The strings can be composites, for instance
238   
239      /(f)(o)(o)/
240      
241   will result in a composite fixed substring 'foo'.
242   
243   For each string some basic information is maintained:
244   
245   - offset or min_offset
246     This is the position the string must appear at, or not before.
247     It also implicitly (when combined with minlenp) tells us how many
248     character must match before the string we are searching.
249     Likewise when combined with minlenp and the length of the string
250     tells us how many characters must appear after the string we have 
251     found.
252   
253   - max_offset
254     Only used for floating strings. This is the rightmost point that
255     the string can appear at. Ifset to I32 max it indicates that the
256     string can occur infinitely far to the right.
257   
258   - minlenp
259     A pointer to the minimum length of the pattern that the string 
260     was found inside. This is important as in the case of positive 
261     lookahead or positive lookbehind we can have multiple patterns 
262     involved. Consider
263     
264     /(?=FOO).*F/
265     
266     The minimum length of the pattern overall is 3, the minimum length
267     of the lookahead part is 3, but the minimum length of the part that
268     will actually match is 1. So 'FOO's minimum length is 3, but the 
269     minimum length for the F is 1. This is important as the minimum length
270     is used to determine offsets in front of and behind the string being 
271     looked for.  Since strings can be composites this is the length of the
272     pattern at the time it was commited with a scan_commit. Note that
273     the length is calculated by study_chunk, so that the minimum lengths
274     are not known until the full pattern has been compiled, thus the 
275     pointer to the value.
276   
277   - lookbehind
278   
279     In the case of lookbehind the string being searched for can be
280     offset past the start point of the final matching string. 
281     If this value was just blithely removed from the min_offset it would
282     invalidate some of the calculations for how many chars must match
283     before or after (as they are derived from min_offset and minlen and
284     the length of the string being searched for). 
285     When the final pattern is compiled and the data is moved from the
286     scan_data_t structure into the regexp structure the information
287     about lookbehind is factored in, with the information that would 
288     have been lost precalculated in the end_shift field for the 
289     associated string.
290
291   The fields pos_min and pos_delta are used to store the minimum offset
292   and the delta to the maximum offset at the current point in the pattern.    
293
294 */
295
296 typedef struct scan_data_t {
297     /*I32 len_min;      unused */
298     /*I32 len_delta;    unused */
299     I32 pos_min;
300     I32 pos_delta;
301     SV *last_found;
302     I32 last_end;           /* min value, <0 unless valid. */
303     I32 last_start_min;
304     I32 last_start_max;
305     SV **longest;           /* Either &l_fixed, or &l_float. */
306     SV *longest_fixed;      /* longest fixed string found in pattern */
307     I32 offset_fixed;       /* offset where it starts */
308     I32 *minlen_fixed;      /* pointer to the minlen relevent to the string */
309     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
310     SV *longest_float;      /* longest floating string found in pattern */
311     I32 offset_float_min;   /* earliest point in string it can appear */
312     I32 offset_float_max;   /* latest point in string it can appear */
313     I32 *minlen_float;      /* pointer to the minlen relevent to the string */
314     I32 lookbehind_float;   /* is the position of the string modified by LB */
315     I32 flags;
316     I32 whilem_c;
317     I32 *last_closep;
318     struct regnode_charclass_class *start_class;
319 } scan_data_t;
320
321 /*
322  * Forward declarations for pregcomp()'s friends.
323  */
324
325 static const scan_data_t zero_scan_data =
326   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
327
328 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
329 #define SF_BEFORE_SEOL          0x0001
330 #define SF_BEFORE_MEOL          0x0002
331 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
332 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
333
334 #ifdef NO_UNARY_PLUS
335 #  define SF_FIX_SHIFT_EOL      (0+2)
336 #  define SF_FL_SHIFT_EOL               (0+4)
337 #else
338 #  define SF_FIX_SHIFT_EOL      (+2)
339 #  define SF_FL_SHIFT_EOL               (+4)
340 #endif
341
342 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
343 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
344
345 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
346 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
347 #define SF_IS_INF               0x0040
348 #define SF_HAS_PAR              0x0080
349 #define SF_IN_PAR               0x0100
350 #define SF_HAS_EVAL             0x0200
351 #define SCF_DO_SUBSTR           0x0400
352 #define SCF_DO_STCLASS_AND      0x0800
353 #define SCF_DO_STCLASS_OR       0x1000
354 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
355 #define SCF_WHILEM_VISITED_POS  0x2000
356
357 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
358 #define SCF_SEEN_ACCEPT         0x8000 
359
360 #define UTF (RExC_utf8 != 0)
361 #define LOC ((RExC_flags & RXf_PMf_LOCALE) != 0)
362 #define FOLD ((RExC_flags & RXf_PMf_FOLD) != 0)
363
364 #define OOB_UNICODE             12345678
365 #define OOB_NAMEDCLASS          -1
366
367 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
368 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
369
370
371 /* length of regex to show in messages that don't mark a position within */
372 #define RegexLengthToShowInErrorMessages 127
373
374 /*
375  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
376  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
377  * op/pragma/warn/regcomp.
378  */
379 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
380 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
381
382 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
383
384 /*
385  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
386  * arg. Show regex, up to a maximum length. If it's too long, chop and add
387  * "...".
388  */
389 #define _FAIL(code) STMT_START {                                        \
390     const char *ellipses = "";                                          \
391     IV len = RExC_end - RExC_precomp;                                   \
392                                                                         \
393     if (!SIZE_ONLY)                                                     \
394         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);                   \
395     if (len > RegexLengthToShowInErrorMessages) {                       \
396         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
397         len = RegexLengthToShowInErrorMessages - 10;                    \
398         ellipses = "...";                                               \
399     }                                                                   \
400     code;                                                               \
401 } STMT_END
402
403 #define FAIL(msg) _FAIL(                            \
404     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
405             msg, (int)len, RExC_precomp, ellipses))
406
407 #define FAIL2(msg,arg) _FAIL(                       \
408     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
409             arg, (int)len, RExC_precomp, ellipses))
410
411 /*
412  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
413  */
414 #define Simple_vFAIL(m) STMT_START {                                    \
415     const IV offset = RExC_parse - RExC_precomp;                        \
416     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
417             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
418 } STMT_END
419
420 /*
421  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
422  */
423 #define vFAIL(m) STMT_START {                           \
424     if (!SIZE_ONLY)                                     \
425         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
426     Simple_vFAIL(m);                                    \
427 } STMT_END
428
429 /*
430  * Like Simple_vFAIL(), but accepts two arguments.
431  */
432 #define Simple_vFAIL2(m,a1) STMT_START {                        \
433     const IV offset = RExC_parse - RExC_precomp;                        \
434     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
435             (int)offset, RExC_precomp, RExC_precomp + offset);  \
436 } STMT_END
437
438 /*
439  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
440  */
441 #define vFAIL2(m,a1) STMT_START {                       \
442     if (!SIZE_ONLY)                                     \
443         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
444     Simple_vFAIL2(m, a1);                               \
445 } STMT_END
446
447
448 /*
449  * Like Simple_vFAIL(), but accepts three arguments.
450  */
451 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
452     const IV offset = RExC_parse - RExC_precomp;                \
453     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
454             (int)offset, RExC_precomp, RExC_precomp + offset);  \
455 } STMT_END
456
457 /*
458  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
459  */
460 #define vFAIL3(m,a1,a2) STMT_START {                    \
461     if (!SIZE_ONLY)                                     \
462         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
463     Simple_vFAIL3(m, a1, a2);                           \
464 } STMT_END
465
466 /*
467  * Like Simple_vFAIL(), but accepts four arguments.
468  */
469 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
470     const IV offset = RExC_parse - RExC_precomp;                \
471     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
472             (int)offset, RExC_precomp, RExC_precomp + offset);  \
473 } STMT_END
474
475 #define vWARN(loc,m) STMT_START {                                       \
476     const IV offset = loc - RExC_precomp;                               \
477     Perl_warner(aTHX_ packWARN(WARN_REGEXP), "%s" REPORT_LOCATION,      \
478             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
479 } STMT_END
480
481 #define vWARNdep(loc,m) STMT_START {                                    \
482     const IV offset = loc - RExC_precomp;                               \
483     Perl_warner(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),          \
484             "%s" REPORT_LOCATION,                                       \
485             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
486 } STMT_END
487
488
489 #define vWARN2(loc, m, a1) STMT_START {                                 \
490     const IV offset = loc - RExC_precomp;                               \
491     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
492             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
493 } STMT_END
494
495 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
496     const IV offset = loc - RExC_precomp;                               \
497     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
498             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
499 } STMT_END
500
501 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
502     const IV offset = loc - RExC_precomp;                               \
503     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
504             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
505 } STMT_END
506
507 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
508     const IV offset = loc - RExC_precomp;                               \
509     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
510             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
511 } STMT_END
512
513
514 /* Allow for side effects in s */
515 #define REGC(c,s) STMT_START {                  \
516     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
517 } STMT_END
518
519 /* Macros for recording node offsets.   20001227 mjd@plover.com 
520  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
521  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
522  * Element 0 holds the number n.
523  * Position is 1 indexed.
524  */
525 #ifndef RE_TRACK_PATTERN_OFFSETS
526 #define Set_Node_Offset_To_R(node,byte)
527 #define Set_Node_Offset(node,byte)
528 #define Set_Cur_Node_Offset
529 #define Set_Node_Length_To_R(node,len)
530 #define Set_Node_Length(node,len)
531 #define Set_Node_Cur_Length(node)
532 #define Node_Offset(n) 
533 #define Node_Length(n) 
534 #define Set_Node_Offset_Length(node,offset,len)
535 #define ProgLen(ri) ri->u.proglen
536 #define SetProgLen(ri,x) ri->u.proglen = x
537 #else
538 #define ProgLen(ri) ri->u.offsets[0]
539 #define SetProgLen(ri,x) ri->u.offsets[0] = x
540 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
541     if (! SIZE_ONLY) {                                                  \
542         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
543                     __LINE__, (int)(node), (int)(byte)));               \
544         if((node) < 0) {                                                \
545             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
546         } else {                                                        \
547             RExC_offsets[2*(node)-1] = (byte);                          \
548         }                                                               \
549     }                                                                   \
550 } STMT_END
551
552 #define Set_Node_Offset(node,byte) \
553     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
554 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
555
556 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
557     if (! SIZE_ONLY) {                                                  \
558         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
559                 __LINE__, (int)(node), (int)(len)));                    \
560         if((node) < 0) {                                                \
561             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
562         } else {                                                        \
563             RExC_offsets[2*(node)] = (len);                             \
564         }                                                               \
565     }                                                                   \
566 } STMT_END
567
568 #define Set_Node_Length(node,len) \
569     Set_Node_Length_To_R((node)-RExC_emit_start, len)
570 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
571 #define Set_Node_Cur_Length(node) \
572     Set_Node_Length(node, RExC_parse - parse_start)
573
574 /* Get offsets and lengths */
575 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
576 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
577
578 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
579     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
580     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
581 } STMT_END
582 #endif
583
584 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
585 #define EXPERIMENTAL_INPLACESCAN
586 #endif /*RE_TRACK_PATTERN_OFFSETS*/
587
588 #define DEBUG_STUDYDATA(str,data,depth)                              \
589 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
590     PerlIO_printf(Perl_debug_log,                                    \
591         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
592         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
593         (int)(depth)*2, "",                                          \
594         (IV)((data)->pos_min),                                       \
595         (IV)((data)->pos_delta),                                     \
596         (UV)((data)->flags),                                         \
597         (IV)((data)->whilem_c),                                      \
598         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
599         is_inf ? "INF " : ""                                         \
600     );                                                               \
601     if ((data)->last_found)                                          \
602         PerlIO_printf(Perl_debug_log,                                \
603             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
604             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
605             SvPVX_const((data)->last_found),                         \
606             (IV)((data)->last_end),                                  \
607             (IV)((data)->last_start_min),                            \
608             (IV)((data)->last_start_max),                            \
609             ((data)->longest &&                                      \
610              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
611             SvPVX_const((data)->longest_fixed),                      \
612             (IV)((data)->offset_fixed),                              \
613             ((data)->longest &&                                      \
614              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
615             SvPVX_const((data)->longest_float),                      \
616             (IV)((data)->offset_float_min),                          \
617             (IV)((data)->offset_float_max)                           \
618         );                                                           \
619     PerlIO_printf(Perl_debug_log,"\n");                              \
620 });
621
622 static void clear_re(pTHX_ void *r);
623
624 /* Mark that we cannot extend a found fixed substring at this point.
625    Update the longest found anchored substring and the longest found
626    floating substrings if needed. */
627
628 STATIC void
629 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
630 {
631     const STRLEN l = CHR_SVLEN(data->last_found);
632     const STRLEN old_l = CHR_SVLEN(*data->longest);
633     GET_RE_DEBUG_FLAGS_DECL;
634
635     PERL_ARGS_ASSERT_SCAN_COMMIT;
636
637     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
638         SvSetMagicSV(*data->longest, data->last_found);
639         if (*data->longest == data->longest_fixed) {
640             data->offset_fixed = l ? data->last_start_min : data->pos_min;
641             if (data->flags & SF_BEFORE_EOL)
642                 data->flags
643                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
644             else
645                 data->flags &= ~SF_FIX_BEFORE_EOL;
646             data->minlen_fixed=minlenp; 
647             data->lookbehind_fixed=0;
648         }
649         else { /* *data->longest == data->longest_float */
650             data->offset_float_min = l ? data->last_start_min : data->pos_min;
651             data->offset_float_max = (l
652                                       ? data->last_start_max
653                                       : data->pos_min + data->pos_delta);
654             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
655                 data->offset_float_max = I32_MAX;
656             if (data->flags & SF_BEFORE_EOL)
657                 data->flags
658                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
659             else
660                 data->flags &= ~SF_FL_BEFORE_EOL;
661             data->minlen_float=minlenp;
662             data->lookbehind_float=0;
663         }
664     }
665     SvCUR_set(data->last_found, 0);
666     {
667         SV * const sv = data->last_found;
668         if (SvUTF8(sv) && SvMAGICAL(sv)) {
669             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
670             if (mg)
671                 mg->mg_len = 0;
672         }
673     }
674     data->last_end = -1;
675     data->flags &= ~SF_BEFORE_EOL;
676     DEBUG_STUDYDATA("commit: ",data,0);
677 }
678
679 /* Can match anything (initialization) */
680 STATIC void
681 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
682 {
683     PERL_ARGS_ASSERT_CL_ANYTHING;
684
685     ANYOF_CLASS_ZERO(cl);
686     ANYOF_BITMAP_SETALL(cl);
687     cl->flags = ANYOF_EOS|ANYOF_UNICODE_ALL;
688     if (LOC)
689         cl->flags |= ANYOF_LOCALE;
690 }
691
692 /* Can match anything (initialization) */
693 STATIC int
694 S_cl_is_anything(const struct regnode_charclass_class *cl)
695 {
696     int value;
697
698     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
699
700     for (value = 0; value <= ANYOF_MAX; value += 2)
701         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
702             return 1;
703     if (!(cl->flags & ANYOF_UNICODE_ALL))
704         return 0;
705     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
706         return 0;
707     return 1;
708 }
709
710 /* Can match anything (initialization) */
711 STATIC void
712 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
713 {
714     PERL_ARGS_ASSERT_CL_INIT;
715
716     Zero(cl, 1, struct regnode_charclass_class);
717     cl->type = ANYOF;
718     cl_anything(pRExC_state, cl);
719 }
720
721 STATIC void
722 S_cl_init_zero(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
723 {
724     PERL_ARGS_ASSERT_CL_INIT_ZERO;
725
726     Zero(cl, 1, struct regnode_charclass_class);
727     cl->type = ANYOF;
728     cl_anything(pRExC_state, cl);
729     if (LOC)
730         cl->flags |= ANYOF_LOCALE;
731 }
732
733 /* 'And' a given class with another one.  Can create false positives */
734 /* We assume that cl is not inverted */
735 STATIC void
736 S_cl_and(struct regnode_charclass_class *cl,
737         const struct regnode_charclass_class *and_with)
738 {
739     PERL_ARGS_ASSERT_CL_AND;
740
741     assert(and_with->type == ANYOF);
742     if (!(and_with->flags & ANYOF_CLASS)
743         && !(cl->flags & ANYOF_CLASS)
744         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
745         && !(and_with->flags & ANYOF_FOLD)
746         && !(cl->flags & ANYOF_FOLD)) {
747         int i;
748
749         if (and_with->flags & ANYOF_INVERT)
750             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
751                 cl->bitmap[i] &= ~and_with->bitmap[i];
752         else
753             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
754                 cl->bitmap[i] &= and_with->bitmap[i];
755     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
756     if (!(and_with->flags & ANYOF_EOS))
757         cl->flags &= ~ANYOF_EOS;
758
759     if (cl->flags & ANYOF_UNICODE_ALL && and_with->flags & ANYOF_UNICODE &&
760         !(and_with->flags & ANYOF_INVERT)) {
761         cl->flags &= ~ANYOF_UNICODE_ALL;
762         cl->flags |= ANYOF_UNICODE;
763         ARG_SET(cl, ARG(and_with));
764     }
765     if (!(and_with->flags & ANYOF_UNICODE_ALL) &&
766         !(and_with->flags & ANYOF_INVERT))
767         cl->flags &= ~ANYOF_UNICODE_ALL;
768     if (!(and_with->flags & (ANYOF_UNICODE|ANYOF_UNICODE_ALL)) &&
769         !(and_with->flags & ANYOF_INVERT))
770         cl->flags &= ~ANYOF_UNICODE;
771 }
772
773 /* 'OR' a given class with another one.  Can create false positives */
774 /* We assume that cl is not inverted */
775 STATIC void
776 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
777 {
778     PERL_ARGS_ASSERT_CL_OR;
779
780     if (or_with->flags & ANYOF_INVERT) {
781         /* We do not use
782          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
783          *   <= (B1 | !B2) | (CL1 | !CL2)
784          * which is wasteful if CL2 is small, but we ignore CL2:
785          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
786          * XXXX Can we handle case-fold?  Unclear:
787          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
788          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
789          */
790         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
791              && !(or_with->flags & ANYOF_FOLD)
792              && !(cl->flags & ANYOF_FOLD) ) {
793             int i;
794
795             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
796                 cl->bitmap[i] |= ~or_with->bitmap[i];
797         } /* XXXX: logic is complicated otherwise */
798         else {
799             cl_anything(pRExC_state, cl);
800         }
801     } else {
802         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
803         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
804              && (!(or_with->flags & ANYOF_FOLD)
805                  || (cl->flags & ANYOF_FOLD)) ) {
806             int i;
807
808             /* OR char bitmap and class bitmap separately */
809             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
810                 cl->bitmap[i] |= or_with->bitmap[i];
811             if (or_with->flags & ANYOF_CLASS) {
812                 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
813                     cl->classflags[i] |= or_with->classflags[i];
814                 cl->flags |= ANYOF_CLASS;
815             }
816         }
817         else { /* XXXX: logic is complicated, leave it along for a moment. */
818             cl_anything(pRExC_state, cl);
819         }
820     }
821     if (or_with->flags & ANYOF_EOS)
822         cl->flags |= ANYOF_EOS;
823
824     if (cl->flags & ANYOF_UNICODE && or_with->flags & ANYOF_UNICODE &&
825         ARG(cl) != ARG(or_with)) {
826         cl->flags |= ANYOF_UNICODE_ALL;
827         cl->flags &= ~ANYOF_UNICODE;
828     }
829     if (or_with->flags & ANYOF_UNICODE_ALL) {
830         cl->flags |= ANYOF_UNICODE_ALL;
831         cl->flags &= ~ANYOF_UNICODE;
832     }
833 }
834
835 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
836 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
837 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
838 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
839
840
841 #ifdef DEBUGGING
842 /*
843    dump_trie(trie,widecharmap,revcharmap)
844    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
845    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
846
847    These routines dump out a trie in a somewhat readable format.
848    The _interim_ variants are used for debugging the interim
849    tables that are used to generate the final compressed
850    representation which is what dump_trie expects.
851
852    Part of the reason for their existance is to provide a form
853    of documentation as to how the different representations function.
854
855 */
856
857 /*
858   Dumps the final compressed table form of the trie to Perl_debug_log.
859   Used for debugging make_trie().
860 */
861  
862 STATIC void
863 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
864             AV *revcharmap, U32 depth)
865 {
866     U32 state;
867     SV *sv=sv_newmortal();
868     int colwidth= widecharmap ? 6 : 4;
869     GET_RE_DEBUG_FLAGS_DECL;
870
871     PERL_ARGS_ASSERT_DUMP_TRIE;
872
873     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
874         (int)depth * 2 + 2,"",
875         "Match","Base","Ofs" );
876
877     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
878         SV ** const tmp = av_fetch( revcharmap, state, 0);
879         if ( tmp ) {
880             PerlIO_printf( Perl_debug_log, "%*s", 
881                 colwidth,
882                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
883                             PL_colors[0], PL_colors[1],
884                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
885                             PERL_PV_ESCAPE_FIRSTCHAR 
886                 ) 
887             );
888         }
889     }
890     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
891         (int)depth * 2 + 2,"");
892
893     for( state = 0 ; state < trie->uniquecharcount ; state++ )
894         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
895     PerlIO_printf( Perl_debug_log, "\n");
896
897     for( state = 1 ; state < trie->statecount ; state++ ) {
898         const U32 base = trie->states[ state ].trans.base;
899
900         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
901
902         if ( trie->states[ state ].wordnum ) {
903             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
904         } else {
905             PerlIO_printf( Perl_debug_log, "%6s", "" );
906         }
907
908         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
909
910         if ( base ) {
911             U32 ofs = 0;
912
913             while( ( base + ofs  < trie->uniquecharcount ) ||
914                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
915                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
916                     ofs++;
917
918             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
919
920             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
921                 if ( ( base + ofs >= trie->uniquecharcount ) &&
922                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
923                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
924                 {
925                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
926                     colwidth,
927                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
928                 } else {
929                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
930                 }
931             }
932
933             PerlIO_printf( Perl_debug_log, "]");
934
935         }
936         PerlIO_printf( Perl_debug_log, "\n" );
937     }
938 }    
939 /*
940   Dumps a fully constructed but uncompressed trie in list form.
941   List tries normally only are used for construction when the number of 
942   possible chars (trie->uniquecharcount) is very high.
943   Used for debugging make_trie().
944 */
945 STATIC void
946 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
947                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
948                          U32 depth)
949 {
950     U32 state;
951     SV *sv=sv_newmortal();
952     int colwidth= widecharmap ? 6 : 4;
953     GET_RE_DEBUG_FLAGS_DECL;
954
955     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
956
957     /* print out the table precompression.  */
958     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
959         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
960         "------:-----+-----------------\n" );
961     
962     for( state=1 ; state < next_alloc ; state ++ ) {
963         U16 charid;
964     
965         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
966             (int)depth * 2 + 2,"", (UV)state  );
967         if ( ! trie->states[ state ].wordnum ) {
968             PerlIO_printf( Perl_debug_log, "%5s| ","");
969         } else {
970             PerlIO_printf( Perl_debug_log, "W%4x| ",
971                 trie->states[ state ].wordnum
972             );
973         }
974         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
975             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
976             if ( tmp ) {
977                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
978                     colwidth,
979                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
980                             PL_colors[0], PL_colors[1],
981                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
982                             PERL_PV_ESCAPE_FIRSTCHAR 
983                     ) ,
984                     TRIE_LIST_ITEM(state,charid).forid,
985                     (UV)TRIE_LIST_ITEM(state,charid).newstate
986                 );
987                 if (!(charid % 10)) 
988                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
989                         (int)((depth * 2) + 14), "");
990             }
991         }
992         PerlIO_printf( Perl_debug_log, "\n");
993     }
994 }    
995
996 /*
997   Dumps a fully constructed but uncompressed trie in table form.
998   This is the normal DFA style state transition table, with a few 
999   twists to facilitate compression later. 
1000   Used for debugging make_trie().
1001 */
1002 STATIC void
1003 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1004                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1005                           U32 depth)
1006 {
1007     U32 state;
1008     U16 charid;
1009     SV *sv=sv_newmortal();
1010     int colwidth= widecharmap ? 6 : 4;
1011     GET_RE_DEBUG_FLAGS_DECL;
1012
1013     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1014     
1015     /*
1016        print out the table precompression so that we can do a visual check
1017        that they are identical.
1018      */
1019     
1020     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1021
1022     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1023         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1024         if ( tmp ) {
1025             PerlIO_printf( Perl_debug_log, "%*s", 
1026                 colwidth,
1027                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1028                             PL_colors[0], PL_colors[1],
1029                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1030                             PERL_PV_ESCAPE_FIRSTCHAR 
1031                 ) 
1032             );
1033         }
1034     }
1035
1036     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1037
1038     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1039         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1040     }
1041
1042     PerlIO_printf( Perl_debug_log, "\n" );
1043
1044     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1045
1046         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1047             (int)depth * 2 + 2,"",
1048             (UV)TRIE_NODENUM( state ) );
1049
1050         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1051             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1052             if (v)
1053                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1054             else
1055                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1056         }
1057         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1058             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1059         } else {
1060             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1061             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1062         }
1063     }
1064 }
1065
1066 #endif
1067
1068 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1069   startbranch: the first branch in the whole branch sequence
1070   first      : start branch of sequence of branch-exact nodes.
1071                May be the same as startbranch
1072   last       : Thing following the last branch.
1073                May be the same as tail.
1074   tail       : item following the branch sequence
1075   count      : words in the sequence
1076   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1077   depth      : indent depth
1078
1079 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1080
1081 A trie is an N'ary tree where the branches are determined by digital
1082 decomposition of the key. IE, at the root node you look up the 1st character and
1083 follow that branch repeat until you find the end of the branches. Nodes can be
1084 marked as "accepting" meaning they represent a complete word. Eg:
1085
1086   /he|she|his|hers/
1087
1088 would convert into the following structure. Numbers represent states, letters
1089 following numbers represent valid transitions on the letter from that state, if
1090 the number is in square brackets it represents an accepting state, otherwise it
1091 will be in parenthesis.
1092
1093       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1094       |    |
1095       |   (2)
1096       |    |
1097      (1)   +-i->(6)-+-s->[7]
1098       |
1099       +-s->(3)-+-h->(4)-+-e->[5]
1100
1101       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1102
1103 This shows that when matching against the string 'hers' we will begin at state 1
1104 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1105 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1106 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1107 single traverse. We store a mapping from accepting to state to which word was
1108 matched, and then when we have multiple possibilities we try to complete the
1109 rest of the regex in the order in which they occured in the alternation.
1110
1111 The only prior NFA like behaviour that would be changed by the TRIE support is
1112 the silent ignoring of duplicate alternations which are of the form:
1113
1114  / (DUPE|DUPE) X? (?{ ... }) Y /x
1115
1116 Thus EVAL blocks follwing a trie may be called a different number of times with
1117 and without the optimisation. With the optimisations dupes will be silently
1118 ignored. This inconsistant behaviour of EVAL type nodes is well established as
1119 the following demonstrates:
1120
1121  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1122
1123 which prints out 'word' three times, but
1124
1125  'words'=~/(word|word|word)(?{ print $1 })S/
1126
1127 which doesnt print it out at all. This is due to other optimisations kicking in.
1128
1129 Example of what happens on a structural level:
1130
1131 The regexp /(ac|ad|ab)+/ will produce the folowing debug output:
1132
1133    1: CURLYM[1] {1,32767}(18)
1134    5:   BRANCH(8)
1135    6:     EXACT <ac>(16)
1136    8:   BRANCH(11)
1137    9:     EXACT <ad>(16)
1138   11:   BRANCH(14)
1139   12:     EXACT <ab>(16)
1140   16:   SUCCEED(0)
1141   17:   NOTHING(18)
1142   18: END(0)
1143
1144 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1145 and should turn into:
1146
1147    1: CURLYM[1] {1,32767}(18)
1148    5:   TRIE(16)
1149         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1150           <ac>
1151           <ad>
1152           <ab>
1153   16:   SUCCEED(0)
1154   17:   NOTHING(18)
1155   18: END(0)
1156
1157 Cases where tail != last would be like /(?foo|bar)baz/:
1158
1159    1: BRANCH(4)
1160    2:   EXACT <foo>(8)
1161    4: BRANCH(7)
1162    5:   EXACT <bar>(8)
1163    7: TAIL(8)
1164    8: EXACT <baz>(10)
1165   10: END(0)
1166
1167 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1168 and would end up looking like:
1169
1170     1: TRIE(8)
1171       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1172         <foo>
1173         <bar>
1174    7: TAIL(8)
1175    8: EXACT <baz>(10)
1176   10: END(0)
1177
1178     d = uvuni_to_utf8_flags(d, uv, 0);
1179
1180 is the recommended Unicode-aware way of saying
1181
1182     *(d++) = uv;
1183 */
1184
1185 #define TRIE_STORE_REVCHAR                                                 \
1186     STMT_START {                                                           \
1187         if (UTF) {                                                         \
1188             SV *zlopp = newSV(2);                                          \
1189             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1190             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, uvc & 0xFF); \
1191             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1192             SvPOK_on(zlopp);                                               \
1193             SvUTF8_on(zlopp);                                              \
1194             av_push(revcharmap, zlopp);                                    \
1195         } else {                                                           \
1196             char ooooff = (char)uvc;                                               \
1197             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1198         }                                                                  \
1199         } STMT_END
1200
1201 #define TRIE_READ_CHAR STMT_START {                                           \
1202     wordlen++;                                                                \
1203     if ( UTF ) {                                                              \
1204         if ( folder ) {                                                       \
1205             if ( foldlen > 0 ) {                                              \
1206                uvc = utf8n_to_uvuni( scan, UTF8_MAXLEN, &len, uniflags );     \
1207                foldlen -= len;                                                \
1208                scan += len;                                                   \
1209                len = 0;                                                       \
1210             } else {                                                          \
1211                 uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1212                 uvc = to_uni_fold( uvc, foldbuf, &foldlen );                  \
1213                 foldlen -= UNISKIP( uvc );                                    \
1214                 scan = foldbuf + UNISKIP( uvc );                              \
1215             }                                                                 \
1216         } else {                                                              \
1217             uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1218         }                                                                     \
1219     } else {                                                                  \
1220         uvc = (U32)*uc;                                                       \
1221         len = 1;                                                              \
1222     }                                                                         \
1223 } STMT_END
1224
1225
1226
1227 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1228     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1229         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1230         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1231     }                                                           \
1232     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1233     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1234     TRIE_LIST_CUR( state )++;                                   \
1235 } STMT_END
1236
1237 #define TRIE_LIST_NEW(state) STMT_START {                       \
1238     Newxz( trie->states[ state ].trans.list,               \
1239         4, reg_trie_trans_le );                                 \
1240      TRIE_LIST_CUR( state ) = 1;                                \
1241      TRIE_LIST_LEN( state ) = 4;                                \
1242 } STMT_END
1243
1244 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1245     U16 dupe= trie->states[ state ].wordnum;                    \
1246     regnode * const noper_next = regnext( noper );              \
1247                                                                 \
1248     if (trie->wordlen)                                          \
1249         trie->wordlen[ curword ] = wordlen;                     \
1250     DEBUG_r({                                                   \
1251         /* store the word for dumping */                        \
1252         SV* tmp;                                                \
1253         if (OP(noper) != NOTHING)                               \
1254             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1255         else                                                    \
1256             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1257         av_push( trie_words, tmp );                             \
1258     });                                                         \
1259                                                                 \
1260     curword++;                                                  \
1261                                                                 \
1262     if ( noper_next < tail ) {                                  \
1263         if (!trie->jump)                                        \
1264             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1265         trie->jump[curword] = (U16)(noper_next - convert);      \
1266         if (!jumper)                                            \
1267             jumper = noper_next;                                \
1268         if (!nextbranch)                                        \
1269             nextbranch= regnext(cur);                           \
1270     }                                                           \
1271                                                                 \
1272     if ( dupe ) {                                               \
1273         /* So it's a dupe. This means we need to maintain a   */\
1274         /* linked-list from the first to the next.            */\
1275         /* we only allocate the nextword buffer when there    */\
1276         /* a dupe, so first time we have to do the allocation */\
1277         if (!trie->nextword)                                    \
1278             trie->nextword = (U16 *)                                    \
1279                 PerlMemShared_calloc( word_count + 1, sizeof(U16));     \
1280         while ( trie->nextword[dupe] )                          \
1281             dupe= trie->nextword[dupe];                         \
1282         trie->nextword[dupe]= curword;                          \
1283     } else {                                                    \
1284         /* we haven't inserted this word yet.                */ \
1285         trie->states[ state ].wordnum = curword;                \
1286     }                                                           \
1287 } STMT_END
1288
1289
1290 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1291      ( ( base + charid >=  ucharcount                                   \
1292          && base + charid < ubound                                      \
1293          && state == trie->trans[ base - ucharcount + charid ].check    \
1294          && trie->trans[ base - ucharcount + charid ].next )            \
1295            ? trie->trans[ base - ucharcount + charid ].next             \
1296            : ( state==1 ? special : 0 )                                 \
1297       )
1298
1299 #define MADE_TRIE       1
1300 #define MADE_JUMP_TRIE  2
1301 #define MADE_EXACT_TRIE 4
1302
1303 STATIC I32
1304 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1305 {
1306     dVAR;
1307     /* first pass, loop through and scan words */
1308     reg_trie_data *trie;
1309     HV *widecharmap = NULL;
1310     AV *revcharmap = newAV();
1311     regnode *cur;
1312     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1313     STRLEN len = 0;
1314     UV uvc = 0;
1315     U16 curword = 0;
1316     U32 next_alloc = 0;
1317     regnode *jumper = NULL;
1318     regnode *nextbranch = NULL;
1319     regnode *convert = NULL;
1320     /* we just use folder as a flag in utf8 */
1321     const U8 * const folder = ( flags == EXACTF
1322                        ? PL_fold
1323                        : ( flags == EXACTFL
1324                            ? PL_fold_locale
1325                            : NULL
1326                          )
1327                      );
1328
1329 #ifdef DEBUGGING
1330     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1331     AV *trie_words = NULL;
1332     /* along with revcharmap, this only used during construction but both are
1333      * useful during debugging so we store them in the struct when debugging.
1334      */
1335 #else
1336     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1337     STRLEN trie_charcount=0;
1338 #endif
1339     SV *re_trie_maxbuff;
1340     GET_RE_DEBUG_FLAGS_DECL;
1341
1342     PERL_ARGS_ASSERT_MAKE_TRIE;
1343 #ifndef DEBUGGING
1344     PERL_UNUSED_ARG(depth);
1345 #endif
1346
1347     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1348     trie->refcount = 1;
1349     trie->startstate = 1;
1350     trie->wordcount = word_count;
1351     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1352     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1353     if (!(UTF && folder))
1354         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1355     DEBUG_r({
1356         trie_words = newAV();
1357     });
1358
1359     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1360     if (!SvIOK(re_trie_maxbuff)) {
1361         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1362     }
1363     DEBUG_OPTIMISE_r({
1364                 PerlIO_printf( Perl_debug_log,
1365                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1366                   (int)depth * 2 + 2, "", 
1367                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1368                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1369                   (int)depth);
1370     });
1371    
1372    /* Find the node we are going to overwrite */
1373     if ( first == startbranch && OP( last ) != BRANCH ) {
1374         /* whole branch chain */
1375         convert = first;
1376     } else {
1377         /* branch sub-chain */
1378         convert = NEXTOPER( first );
1379     }
1380         
1381     /*  -- First loop and Setup --
1382
1383        We first traverse the branches and scan each word to determine if it
1384        contains widechars, and how many unique chars there are, this is
1385        important as we have to build a table with at least as many columns as we
1386        have unique chars.
1387
1388        We use an array of integers to represent the character codes 0..255
1389        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1390        native representation of the character value as the key and IV's for the
1391        coded index.
1392
1393        *TODO* If we keep track of how many times each character is used we can
1394        remap the columns so that the table compression later on is more
1395        efficient in terms of memory by ensuring most common value is in the
1396        middle and the least common are on the outside.  IMO this would be better
1397        than a most to least common mapping as theres a decent chance the most
1398        common letter will share a node with the least common, meaning the node
1399        will not be compressable. With a middle is most common approach the worst
1400        case is when we have the least common nodes twice.
1401
1402      */
1403
1404     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1405         regnode * const noper = NEXTOPER( cur );
1406         const U8 *uc = (U8*)STRING( noper );
1407         const U8 * const e  = uc + STR_LEN( noper );
1408         STRLEN foldlen = 0;
1409         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1410         const U8 *scan = (U8*)NULL;
1411         U32 wordlen      = 0;         /* required init */
1412         STRLEN chars = 0;
1413         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1414
1415         if (OP(noper) == NOTHING) {
1416             trie->minlen= 0;
1417             continue;
1418         }
1419         if ( set_bit ) /* bitmap only alloced when !(UTF&&Folding) */
1420             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1421                                           regardless of encoding */
1422
1423         for ( ; uc < e ; uc += len ) {
1424             TRIE_CHARCOUNT(trie)++;
1425             TRIE_READ_CHAR;
1426             chars++;
1427             if ( uvc < 256 ) {
1428                 if ( !trie->charmap[ uvc ] ) {
1429                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1430                     if ( folder )
1431                         trie->charmap[ folder[ uvc ] ] = trie->charmap[ uvc ];
1432                     TRIE_STORE_REVCHAR;
1433                 }
1434                 if ( set_bit ) {
1435                     /* store the codepoint in the bitmap, and if its ascii
1436                        also store its folded equivelent. */
1437                     TRIE_BITMAP_SET(trie,uvc);
1438
1439                     /* store the folded codepoint */
1440                     if ( folder ) TRIE_BITMAP_SET(trie,folder[ uvc ]);
1441
1442                     if ( !UTF ) {
1443                         /* store first byte of utf8 representation of
1444                            codepoints in the 127 < uvc < 256 range */
1445                         if (127 < uvc && uvc < 192) {
1446                             TRIE_BITMAP_SET(trie,194);
1447                         } else if (191 < uvc ) {
1448                             TRIE_BITMAP_SET(trie,195);
1449                         /* && uvc < 256 -- we know uvc is < 256 already */
1450                         }
1451                     }
1452                     set_bit = 0; /* We've done our bit :-) */
1453                 }
1454             } else {
1455                 SV** svpp;
1456                 if ( !widecharmap )
1457                     widecharmap = newHV();
1458
1459                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1460
1461                 if ( !svpp )
1462                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1463
1464                 if ( !SvTRUE( *svpp ) ) {
1465                     sv_setiv( *svpp, ++trie->uniquecharcount );
1466                     TRIE_STORE_REVCHAR;
1467                 }
1468             }
1469         }
1470         if( cur == first ) {
1471             trie->minlen=chars;
1472             trie->maxlen=chars;
1473         } else if (chars < trie->minlen) {
1474             trie->minlen=chars;
1475         } else if (chars > trie->maxlen) {
1476             trie->maxlen=chars;
1477         }
1478
1479     } /* end first pass */
1480     DEBUG_TRIE_COMPILE_r(
1481         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1482                 (int)depth * 2 + 2,"",
1483                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1484                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1485                 (int)trie->minlen, (int)trie->maxlen )
1486     );
1487     trie->wordlen = (U32 *) PerlMemShared_calloc( word_count, sizeof(U32) );
1488
1489     /*
1490         We now know what we are dealing with in terms of unique chars and
1491         string sizes so we can calculate how much memory a naive
1492         representation using a flat table  will take. If it's over a reasonable
1493         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1494         conservative but potentially much slower representation using an array
1495         of lists.
1496
1497         At the end we convert both representations into the same compressed
1498         form that will be used in regexec.c for matching with. The latter
1499         is a form that cannot be used to construct with but has memory
1500         properties similar to the list form and access properties similar
1501         to the table form making it both suitable for fast searches and
1502         small enough that its feasable to store for the duration of a program.
1503
1504         See the comment in the code where the compressed table is produced
1505         inplace from the flat tabe representation for an explanation of how
1506         the compression works.
1507
1508     */
1509
1510
1511     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1512         /*
1513             Second Pass -- Array Of Lists Representation
1514
1515             Each state will be represented by a list of charid:state records
1516             (reg_trie_trans_le) the first such element holds the CUR and LEN
1517             points of the allocated array. (See defines above).
1518
1519             We build the initial structure using the lists, and then convert
1520             it into the compressed table form which allows faster lookups
1521             (but cant be modified once converted).
1522         */
1523
1524         STRLEN transcount = 1;
1525
1526         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1527             "%*sCompiling trie using list compiler\n",
1528             (int)depth * 2 + 2, ""));
1529         
1530         trie->states = (reg_trie_state *)
1531             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1532                                   sizeof(reg_trie_state) );
1533         TRIE_LIST_NEW(1);
1534         next_alloc = 2;
1535
1536         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1537
1538             regnode * const noper = NEXTOPER( cur );
1539             U8 *uc           = (U8*)STRING( noper );
1540             const U8 * const e = uc + STR_LEN( noper );
1541             U32 state        = 1;         /* required init */
1542             U16 charid       = 0;         /* sanity init */
1543             U8 *scan         = (U8*)NULL; /* sanity init */
1544             STRLEN foldlen   = 0;         /* required init */
1545             U32 wordlen      = 0;         /* required init */
1546             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1547
1548             if (OP(noper) != NOTHING) {
1549                 for ( ; uc < e ; uc += len ) {
1550
1551                     TRIE_READ_CHAR;
1552
1553                     if ( uvc < 256 ) {
1554                         charid = trie->charmap[ uvc ];
1555                     } else {
1556                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1557                         if ( !svpp ) {
1558                             charid = 0;
1559                         } else {
1560                             charid=(U16)SvIV( *svpp );
1561                         }
1562                     }
1563                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1564                     if ( charid ) {
1565
1566                         U16 check;
1567                         U32 newstate = 0;
1568
1569                         charid--;
1570                         if ( !trie->states[ state ].trans.list ) {
1571                             TRIE_LIST_NEW( state );
1572                         }
1573                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1574                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1575                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1576                                 break;
1577                             }
1578                         }
1579                         if ( ! newstate ) {
1580                             newstate = next_alloc++;
1581                             TRIE_LIST_PUSH( state, charid, newstate );
1582                             transcount++;
1583                         }
1584                         state = newstate;
1585                     } else {
1586                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1587                     }
1588                 }
1589             }
1590             TRIE_HANDLE_WORD(state);
1591
1592         } /* end second pass */
1593
1594         /* next alloc is the NEXT state to be allocated */
1595         trie->statecount = next_alloc; 
1596         trie->states = (reg_trie_state *)
1597             PerlMemShared_realloc( trie->states,
1598                                    next_alloc
1599                                    * sizeof(reg_trie_state) );
1600
1601         /* and now dump it out before we compress it */
1602         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1603                                                          revcharmap, next_alloc,
1604                                                          depth+1)
1605         );
1606
1607         trie->trans = (reg_trie_trans *)
1608             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1609         {
1610             U32 state;
1611             U32 tp = 0;
1612             U32 zp = 0;
1613
1614
1615             for( state=1 ; state < next_alloc ; state ++ ) {
1616                 U32 base=0;
1617
1618                 /*
1619                 DEBUG_TRIE_COMPILE_MORE_r(
1620                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1621                 );
1622                 */
1623
1624                 if (trie->states[state].trans.list) {
1625                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1626                     U16 maxid=minid;
1627                     U16 idx;
1628
1629                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1630                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1631                         if ( forid < minid ) {
1632                             minid=forid;
1633                         } else if ( forid > maxid ) {
1634                             maxid=forid;
1635                         }
1636                     }
1637                     if ( transcount < tp + maxid - minid + 1) {
1638                         transcount *= 2;
1639                         trie->trans = (reg_trie_trans *)
1640                             PerlMemShared_realloc( trie->trans,
1641                                                      transcount
1642                                                      * sizeof(reg_trie_trans) );
1643                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1644                     }
1645                     base = trie->uniquecharcount + tp - minid;
1646                     if ( maxid == minid ) {
1647                         U32 set = 0;
1648                         for ( ; zp < tp ; zp++ ) {
1649                             if ( ! trie->trans[ zp ].next ) {
1650                                 base = trie->uniquecharcount + zp - minid;
1651                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1652                                 trie->trans[ zp ].check = state;
1653                                 set = 1;
1654                                 break;
1655                             }
1656                         }
1657                         if ( !set ) {
1658                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1659                             trie->trans[ tp ].check = state;
1660                             tp++;
1661                             zp = tp;
1662                         }
1663                     } else {
1664                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1665                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1666                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1667                             trie->trans[ tid ].check = state;
1668                         }
1669                         tp += ( maxid - minid + 1 );
1670                     }
1671                     Safefree(trie->states[ state ].trans.list);
1672                 }
1673                 /*
1674                 DEBUG_TRIE_COMPILE_MORE_r(
1675                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1676                 );
1677                 */
1678                 trie->states[ state ].trans.base=base;
1679             }
1680             trie->lasttrans = tp + 1;
1681         }
1682     } else {
1683         /*
1684            Second Pass -- Flat Table Representation.
1685
1686            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1687            We know that we will need Charcount+1 trans at most to store the data
1688            (one row per char at worst case) So we preallocate both structures
1689            assuming worst case.
1690
1691            We then construct the trie using only the .next slots of the entry
1692            structs.
1693
1694            We use the .check field of the first entry of the node  temporarily to
1695            make compression both faster and easier by keeping track of how many non
1696            zero fields are in the node.
1697
1698            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1699            transition.
1700
1701            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1702            number representing the first entry of the node, and state as a
1703            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1704            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1705            are 2 entrys per node. eg:
1706
1707              A B       A B
1708           1. 2 4    1. 3 7
1709           2. 0 3    3. 0 5
1710           3. 0 0    5. 0 0
1711           4. 0 0    7. 0 0
1712
1713            The table is internally in the right hand, idx form. However as we also
1714            have to deal with the states array which is indexed by nodenum we have to
1715            use TRIE_NODENUM() to convert.
1716
1717         */
1718         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1719             "%*sCompiling trie using table compiler\n",
1720             (int)depth * 2 + 2, ""));
1721
1722         trie->trans = (reg_trie_trans *)
1723             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
1724                                   * trie->uniquecharcount + 1,
1725                                   sizeof(reg_trie_trans) );
1726         trie->states = (reg_trie_state *)
1727             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1728                                   sizeof(reg_trie_state) );
1729         next_alloc = trie->uniquecharcount + 1;
1730
1731
1732         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1733
1734             regnode * const noper   = NEXTOPER( cur );
1735             const U8 *uc     = (U8*)STRING( noper );
1736             const U8 * const e = uc + STR_LEN( noper );
1737
1738             U32 state        = 1;         /* required init */
1739
1740             U16 charid       = 0;         /* sanity init */
1741             U32 accept_state = 0;         /* sanity init */
1742             U8 *scan         = (U8*)NULL; /* sanity init */
1743
1744             STRLEN foldlen   = 0;         /* required init */
1745             U32 wordlen      = 0;         /* required init */
1746             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1747
1748             if ( OP(noper) != NOTHING ) {
1749                 for ( ; uc < e ; uc += len ) {
1750
1751                     TRIE_READ_CHAR;
1752
1753                     if ( uvc < 256 ) {
1754                         charid = trie->charmap[ uvc ];
1755                     } else {
1756                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1757                         charid = svpp ? (U16)SvIV(*svpp) : 0;
1758                     }
1759                     if ( charid ) {
1760                         charid--;
1761                         if ( !trie->trans[ state + charid ].next ) {
1762                             trie->trans[ state + charid ].next = next_alloc;
1763                             trie->trans[ state ].check++;
1764                             next_alloc += trie->uniquecharcount;
1765                         }
1766                         state = trie->trans[ state + charid ].next;
1767                     } else {
1768                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1769                     }
1770                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1771                 }
1772             }
1773             accept_state = TRIE_NODENUM( state );
1774             TRIE_HANDLE_WORD(accept_state);
1775
1776         } /* end second pass */
1777
1778         /* and now dump it out before we compress it */
1779         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
1780                                                           revcharmap,
1781                                                           next_alloc, depth+1));
1782
1783         {
1784         /*
1785            * Inplace compress the table.*
1786
1787            For sparse data sets the table constructed by the trie algorithm will
1788            be mostly 0/FAIL transitions or to put it another way mostly empty.
1789            (Note that leaf nodes will not contain any transitions.)
1790
1791            This algorithm compresses the tables by eliminating most such
1792            transitions, at the cost of a modest bit of extra work during lookup:
1793
1794            - Each states[] entry contains a .base field which indicates the
1795            index in the state[] array wheres its transition data is stored.
1796
1797            - If .base is 0 there are no  valid transitions from that node.
1798
1799            - If .base is nonzero then charid is added to it to find an entry in
1800            the trans array.
1801
1802            -If trans[states[state].base+charid].check!=state then the
1803            transition is taken to be a 0/Fail transition. Thus if there are fail
1804            transitions at the front of the node then the .base offset will point
1805            somewhere inside the previous nodes data (or maybe even into a node
1806            even earlier), but the .check field determines if the transition is
1807            valid.
1808
1809            XXX - wrong maybe?
1810            The following process inplace converts the table to the compressed
1811            table: We first do not compress the root node 1,and mark its all its
1812            .check pointers as 1 and set its .base pointer as 1 as well. This
1813            allows to do a DFA construction from the compressed table later, and
1814            ensures that any .base pointers we calculate later are greater than
1815            0.
1816
1817            - We set 'pos' to indicate the first entry of the second node.
1818
1819            - We then iterate over the columns of the node, finding the first and
1820            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
1821            and set the .check pointers accordingly, and advance pos
1822            appropriately and repreat for the next node. Note that when we copy
1823            the next pointers we have to convert them from the original
1824            NODEIDX form to NODENUM form as the former is not valid post
1825            compression.
1826
1827            - If a node has no transitions used we mark its base as 0 and do not
1828            advance the pos pointer.
1829
1830            - If a node only has one transition we use a second pointer into the
1831            structure to fill in allocated fail transitions from other states.
1832            This pointer is independent of the main pointer and scans forward
1833            looking for null transitions that are allocated to a state. When it
1834            finds one it writes the single transition into the "hole".  If the
1835            pointer doesnt find one the single transition is appended as normal.
1836
1837            - Once compressed we can Renew/realloc the structures to release the
1838            excess space.
1839
1840            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
1841            specifically Fig 3.47 and the associated pseudocode.
1842
1843            demq
1844         */
1845         const U32 laststate = TRIE_NODENUM( next_alloc );
1846         U32 state, charid;
1847         U32 pos = 0, zp=0;
1848         trie->statecount = laststate;
1849
1850         for ( state = 1 ; state < laststate ; state++ ) {
1851             U8 flag = 0;
1852             const U32 stateidx = TRIE_NODEIDX( state );
1853             const U32 o_used = trie->trans[ stateidx ].check;
1854             U32 used = trie->trans[ stateidx ].check;
1855             trie->trans[ stateidx ].check = 0;
1856
1857             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
1858                 if ( flag || trie->trans[ stateidx + charid ].next ) {
1859                     if ( trie->trans[ stateidx + charid ].next ) {
1860                         if (o_used == 1) {
1861                             for ( ; zp < pos ; zp++ ) {
1862                                 if ( ! trie->trans[ zp ].next ) {
1863                                     break;
1864                                 }
1865                             }
1866                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
1867                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
1868                             trie->trans[ zp ].check = state;
1869                             if ( ++zp > pos ) pos = zp;
1870                             break;
1871                         }
1872                         used--;
1873                     }
1874                     if ( !flag ) {
1875                         flag = 1;
1876                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
1877                     }
1878                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
1879                     trie->trans[ pos ].check = state;
1880                     pos++;
1881                 }
1882             }
1883         }
1884         trie->lasttrans = pos + 1;
1885         trie->states = (reg_trie_state *)
1886             PerlMemShared_realloc( trie->states, laststate
1887                                    * sizeof(reg_trie_state) );
1888         DEBUG_TRIE_COMPILE_MORE_r(
1889                 PerlIO_printf( Perl_debug_log,
1890                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
1891                     (int)depth * 2 + 2,"",
1892                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
1893                     (IV)next_alloc,
1894                     (IV)pos,
1895                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
1896             );
1897
1898         } /* end table compress */
1899     }
1900     DEBUG_TRIE_COMPILE_MORE_r(
1901             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
1902                 (int)depth * 2 + 2, "",
1903                 (UV)trie->statecount,
1904                 (UV)trie->lasttrans)
1905     );
1906     /* resize the trans array to remove unused space */
1907     trie->trans = (reg_trie_trans *)
1908         PerlMemShared_realloc( trie->trans, trie->lasttrans
1909                                * sizeof(reg_trie_trans) );
1910
1911     /* and now dump out the compressed format */
1912     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
1913
1914     {   /* Modify the program and insert the new TRIE node*/ 
1915         U8 nodetype =(U8)(flags & 0xFF);
1916         char *str=NULL;
1917         
1918 #ifdef DEBUGGING
1919         regnode *optimize = NULL;
1920 #ifdef RE_TRACK_PATTERN_OFFSETS
1921
1922         U32 mjd_offset = 0;
1923         U32 mjd_nodelen = 0;
1924 #endif /* RE_TRACK_PATTERN_OFFSETS */
1925 #endif /* DEBUGGING */
1926         /*
1927            This means we convert either the first branch or the first Exact,
1928            depending on whether the thing following (in 'last') is a branch
1929            or not and whther first is the startbranch (ie is it a sub part of
1930            the alternation or is it the whole thing.)
1931            Assuming its a sub part we conver the EXACT otherwise we convert
1932            the whole branch sequence, including the first.
1933          */
1934         /* Find the node we are going to overwrite */
1935         if ( first != startbranch || OP( last ) == BRANCH ) {
1936             /* branch sub-chain */
1937             NEXT_OFF( first ) = (U16)(last - first);
1938 #ifdef RE_TRACK_PATTERN_OFFSETS
1939             DEBUG_r({
1940                 mjd_offset= Node_Offset((convert));
1941                 mjd_nodelen= Node_Length((convert));
1942             });
1943 #endif
1944             /* whole branch chain */
1945         }
1946 #ifdef RE_TRACK_PATTERN_OFFSETS
1947         else {
1948             DEBUG_r({
1949                 const  regnode *nop = NEXTOPER( convert );
1950                 mjd_offset= Node_Offset((nop));
1951                 mjd_nodelen= Node_Length((nop));
1952             });
1953         }
1954         DEBUG_OPTIMISE_r(
1955             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
1956                 (int)depth * 2 + 2, "",
1957                 (UV)mjd_offset, (UV)mjd_nodelen)
1958         );
1959 #endif
1960         /* But first we check to see if there is a common prefix we can 
1961            split out as an EXACT and put in front of the TRIE node.  */
1962         trie->startstate= 1;
1963         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
1964             U32 state;
1965             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
1966                 U32 ofs = 0;
1967                 I32 idx = -1;
1968                 U32 count = 0;
1969                 const U32 base = trie->states[ state ].trans.base;
1970
1971                 if ( trie->states[state].wordnum )
1972                         count = 1;
1973
1974                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1975                     if ( ( base + ofs >= trie->uniquecharcount ) &&
1976                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1977                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1978                     {
1979                         if ( ++count > 1 ) {
1980                             SV **tmp = av_fetch( revcharmap, ofs, 0);
1981                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
1982                             if ( state == 1 ) break;
1983                             if ( count == 2 ) {
1984                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
1985                                 DEBUG_OPTIMISE_r(
1986                                     PerlIO_printf(Perl_debug_log,
1987                                         "%*sNew Start State=%"UVuf" Class: [",
1988                                         (int)depth * 2 + 2, "",
1989                                         (UV)state));
1990                                 if (idx >= 0) {
1991                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
1992                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
1993
1994                                     TRIE_BITMAP_SET(trie,*ch);
1995                                     if ( folder )
1996                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
1997                                     DEBUG_OPTIMISE_r(
1998                                         PerlIO_printf(Perl_debug_log, (char*)ch)
1999                                     );
2000                                 }
2001                             }
2002                             TRIE_BITMAP_SET(trie,*ch);
2003                             if ( folder )
2004                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2005                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2006                         }
2007                         idx = ofs;
2008                     }
2009                 }
2010                 if ( count == 1 ) {
2011                     SV **tmp = av_fetch( revcharmap, idx, 0);
2012                     STRLEN len;
2013                     char *ch = SvPV( *tmp, len );
2014                     DEBUG_OPTIMISE_r({
2015                         SV *sv=sv_newmortal();
2016                         PerlIO_printf( Perl_debug_log,
2017                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2018                             (int)depth * 2 + 2, "",
2019                             (UV)state, (UV)idx, 
2020                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2021                                 PL_colors[0], PL_colors[1],
2022                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2023                                 PERL_PV_ESCAPE_FIRSTCHAR 
2024                             )
2025                         );
2026                     });
2027                     if ( state==1 ) {
2028                         OP( convert ) = nodetype;
2029                         str=STRING(convert);
2030                         STR_LEN(convert)=0;
2031                     }
2032                     STR_LEN(convert) += len;
2033                     while (len--)
2034                         *str++ = *ch++;
2035                 } else {
2036 #ifdef DEBUGGING            
2037                     if (state>1)
2038                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2039 #endif
2040                     break;
2041                 }
2042             }
2043             if (str) {
2044                 regnode *n = convert+NODE_SZ_STR(convert);
2045                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2046                 trie->startstate = state;
2047                 trie->minlen -= (state - 1);
2048                 trie->maxlen -= (state - 1);
2049 #ifdef DEBUGGING
2050                /* At least the UNICOS C compiler choked on this
2051                 * being argument to DEBUG_r(), so let's just have
2052                 * it right here. */
2053                if (
2054 #ifdef PERL_EXT_RE_BUILD
2055                    1
2056 #else
2057                    DEBUG_r_TEST
2058 #endif
2059                    ) {
2060                    regnode *fix = convert;
2061                    U32 word = trie->wordcount;
2062                    mjd_nodelen++;
2063                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2064                    while( ++fix < n ) {
2065                        Set_Node_Offset_Length(fix, 0, 0);
2066                    }
2067                    while (word--) {
2068                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2069                        if (tmp) {
2070                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2071                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2072                            else
2073                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2074                        }
2075                    }
2076                }
2077 #endif
2078                 if (trie->maxlen) {
2079                     convert = n;
2080                 } else {
2081                     NEXT_OFF(convert) = (U16)(tail - convert);
2082                     DEBUG_r(optimize= n);
2083                 }
2084             }
2085         }
2086         if (!jumper) 
2087             jumper = last; 
2088         if ( trie->maxlen ) {
2089             NEXT_OFF( convert ) = (U16)(tail - convert);
2090             ARG_SET( convert, data_slot );
2091             /* Store the offset to the first unabsorbed branch in 
2092                jump[0], which is otherwise unused by the jump logic. 
2093                We use this when dumping a trie and during optimisation. */
2094             if (trie->jump) 
2095                 trie->jump[0] = (U16)(nextbranch - convert);
2096             
2097             /* XXXX */
2098             if ( !trie->states[trie->startstate].wordnum && trie->bitmap && 
2099                  ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2100             {
2101                 OP( convert ) = TRIEC;
2102                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2103                 PerlMemShared_free(trie->bitmap);
2104                 trie->bitmap= NULL;
2105             } else 
2106                 OP( convert ) = TRIE;
2107
2108             /* store the type in the flags */
2109             convert->flags = nodetype;
2110             DEBUG_r({
2111             optimize = convert 
2112                       + NODE_STEP_REGNODE 
2113                       + regarglen[ OP( convert ) ];
2114             });
2115             /* XXX We really should free up the resource in trie now, 
2116                    as we won't use them - (which resources?) dmq */
2117         }
2118         /* needed for dumping*/
2119         DEBUG_r(if (optimize) {
2120             regnode *opt = convert;
2121
2122             while ( ++opt < optimize) {
2123                 Set_Node_Offset_Length(opt,0,0);
2124             }
2125             /* 
2126                 Try to clean up some of the debris left after the 
2127                 optimisation.
2128              */
2129             while( optimize < jumper ) {
2130                 mjd_nodelen += Node_Length((optimize));
2131                 OP( optimize ) = OPTIMIZED;
2132                 Set_Node_Offset_Length(optimize,0,0);
2133                 optimize++;
2134             }
2135             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2136         });
2137     } /* end node insert */
2138     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2139 #ifdef DEBUGGING
2140     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2141     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2142 #else
2143     SvREFCNT_dec(revcharmap);
2144 #endif
2145     return trie->jump 
2146            ? MADE_JUMP_TRIE 
2147            : trie->startstate>1 
2148              ? MADE_EXACT_TRIE 
2149              : MADE_TRIE;
2150 }
2151
2152 STATIC void
2153 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2154 {
2155 /* The Trie is constructed and compressed now so we can build a fail array now if its needed
2156
2157    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2158    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2159    ISBN 0-201-10088-6
2160
2161    We find the fail state for each state in the trie, this state is the longest proper
2162    suffix of the current states 'word' that is also a proper prefix of another word in our
2163    trie. State 1 represents the word '' and is the thus the default fail state. This allows
2164    the DFA not to have to restart after its tried and failed a word at a given point, it
2165    simply continues as though it had been matching the other word in the first place.
2166    Consider
2167       'abcdgu'=~/abcdefg|cdgu/
2168    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2169    fail, which would bring use to the state representing 'd' in the second word where we would
2170    try 'g' and succeed, prodceding to match 'cdgu'.
2171  */
2172  /* add a fail transition */
2173     const U32 trie_offset = ARG(source);
2174     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2175     U32 *q;
2176     const U32 ucharcount = trie->uniquecharcount;
2177     const U32 numstates = trie->statecount;
2178     const U32 ubound = trie->lasttrans + ucharcount;
2179     U32 q_read = 0;
2180     U32 q_write = 0;
2181     U32 charid;
2182     U32 base = trie->states[ 1 ].trans.base;
2183     U32 *fail;
2184     reg_ac_data *aho;
2185     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2186     GET_RE_DEBUG_FLAGS_DECL;
2187
2188     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2189 #ifndef DEBUGGING
2190     PERL_UNUSED_ARG(depth);
2191 #endif
2192
2193
2194     ARG_SET( stclass, data_slot );
2195     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2196     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2197     aho->trie=trie_offset;
2198     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2199     Copy( trie->states, aho->states, numstates, reg_trie_state );
2200     Newxz( q, numstates, U32);
2201     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2202     aho->refcount = 1;
2203     fail = aho->fail;
2204     /* initialize fail[0..1] to be 1 so that we always have
2205        a valid final fail state */
2206     fail[ 0 ] = fail[ 1 ] = 1;
2207
2208     for ( charid = 0; charid < ucharcount ; charid++ ) {
2209         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2210         if ( newstate ) {
2211             q[ q_write ] = newstate;
2212             /* set to point at the root */
2213             fail[ q[ q_write++ ] ]=1;
2214         }
2215     }
2216     while ( q_read < q_write) {
2217         const U32 cur = q[ q_read++ % numstates ];
2218         base = trie->states[ cur ].trans.base;
2219
2220         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2221             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2222             if (ch_state) {
2223                 U32 fail_state = cur;
2224                 U32 fail_base;
2225                 do {
2226                     fail_state = fail[ fail_state ];
2227                     fail_base = aho->states[ fail_state ].trans.base;
2228                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2229
2230                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2231                 fail[ ch_state ] = fail_state;
2232                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2233                 {
2234                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2235                 }
2236                 q[ q_write++ % numstates] = ch_state;
2237             }
2238         }
2239     }
2240     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2241        when we fail in state 1, this allows us to use the
2242        charclass scan to find a valid start char. This is based on the principle
2243        that theres a good chance the string being searched contains lots of stuff
2244        that cant be a start char.
2245      */
2246     fail[ 0 ] = fail[ 1 ] = 0;
2247     DEBUG_TRIE_COMPILE_r({
2248         PerlIO_printf(Perl_debug_log,
2249                       "%*sStclass Failtable (%"UVuf" states): 0", 
2250                       (int)(depth * 2), "", (UV)numstates
2251         );
2252         for( q_read=1; q_read<numstates; q_read++ ) {
2253             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2254         }
2255         PerlIO_printf(Perl_debug_log, "\n");
2256     });
2257     Safefree(q);
2258     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2259 }
2260
2261
2262 /*
2263  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2264  * These need to be revisited when a newer toolchain becomes available.
2265  */
2266 #if defined(__sparc64__) && defined(__GNUC__)
2267 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2268 #       undef  SPARC64_GCC_WORKAROUND
2269 #       define SPARC64_GCC_WORKAROUND 1
2270 #   endif
2271 #endif
2272
2273 #define DEBUG_PEEP(str,scan,depth) \
2274     DEBUG_OPTIMISE_r({if (scan){ \
2275        SV * const mysv=sv_newmortal(); \
2276        regnode *Next = regnext(scan); \
2277        regprop(RExC_rx, mysv, scan); \
2278        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2279        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2280        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2281    }});
2282
2283
2284
2285
2286
2287 #define JOIN_EXACT(scan,min,flags) \
2288     if (PL_regkind[OP(scan)] == EXACT) \
2289         join_exact(pRExC_state,(scan),(min),(flags),NULL,depth+1)
2290
2291 STATIC U32
2292 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, I32 *min, U32 flags,regnode *val, U32 depth) {
2293     /* Merge several consecutive EXACTish nodes into one. */
2294     regnode *n = regnext(scan);
2295     U32 stringok = 1;
2296     regnode *next = scan + NODE_SZ_STR(scan);
2297     U32 merged = 0;
2298     U32 stopnow = 0;
2299 #ifdef DEBUGGING
2300     regnode *stop = scan;
2301     GET_RE_DEBUG_FLAGS_DECL;
2302 #else
2303     PERL_UNUSED_ARG(depth);
2304 #endif
2305
2306     PERL_ARGS_ASSERT_JOIN_EXACT;
2307 #ifndef EXPERIMENTAL_INPLACESCAN
2308     PERL_UNUSED_ARG(flags);
2309     PERL_UNUSED_ARG(val);
2310 #endif
2311     DEBUG_PEEP("join",scan,depth);
2312     
2313     /* Skip NOTHING, merge EXACT*. */
2314     while (n &&
2315            ( PL_regkind[OP(n)] == NOTHING ||
2316              (stringok && (OP(n) == OP(scan))))
2317            && NEXT_OFF(n)
2318            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX) {
2319         
2320         if (OP(n) == TAIL || n > next)
2321             stringok = 0;
2322         if (PL_regkind[OP(n)] == NOTHING) {
2323             DEBUG_PEEP("skip:",n,depth);
2324             NEXT_OFF(scan) += NEXT_OFF(n);
2325             next = n + NODE_STEP_REGNODE;
2326 #ifdef DEBUGGING
2327             if (stringok)
2328                 stop = n;
2329 #endif
2330             n = regnext(n);
2331         }
2332         else if (stringok) {
2333             const unsigned int oldl = STR_LEN(scan);
2334             regnode * const nnext = regnext(n);
2335             
2336             DEBUG_PEEP("merg",n,depth);
2337             
2338             merged++;
2339             if (oldl + STR_LEN(n) > U8_MAX)
2340                 break;
2341             NEXT_OFF(scan) += NEXT_OFF(n);
2342             STR_LEN(scan) += STR_LEN(n);
2343             next = n + NODE_SZ_STR(n);
2344             /* Now we can overwrite *n : */
2345             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2346 #ifdef DEBUGGING
2347             stop = next - 1;
2348 #endif
2349             n = nnext;
2350             if (stopnow) break;
2351         }
2352
2353 #ifdef EXPERIMENTAL_INPLACESCAN
2354         if (flags && !NEXT_OFF(n)) {
2355             DEBUG_PEEP("atch", val, depth);
2356             if (reg_off_by_arg[OP(n)]) {
2357                 ARG_SET(n, val - n);
2358             }
2359             else {
2360                 NEXT_OFF(n) = val - n;
2361             }
2362             stopnow = 1;
2363         }
2364 #endif
2365     }
2366     
2367     if (UTF && ( OP(scan) == EXACTF ) && ( STR_LEN(scan) >= 6 ) ) {
2368     /*
2369     Two problematic code points in Unicode casefolding of EXACT nodes:
2370     
2371     U+0390 - GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS
2372     U+03B0 - GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS
2373     
2374     which casefold to
2375     
2376     Unicode                      UTF-8
2377     
2378     U+03B9 U+0308 U+0301         0xCE 0xB9 0xCC 0x88 0xCC 0x81
2379     U+03C5 U+0308 U+0301         0xCF 0x85 0xCC 0x88 0xCC 0x81
2380     
2381     This means that in case-insensitive matching (or "loose matching",
2382     as Unicode calls it), an EXACTF of length six (the UTF-8 encoded byte
2383     length of the above casefolded versions) can match a target string
2384     of length two (the byte length of UTF-8 encoded U+0390 or U+03B0).
2385     This would rather mess up the minimum length computation.
2386     
2387     What we'll do is to look for the tail four bytes, and then peek
2388     at the preceding two bytes to see whether we need to decrease
2389     the minimum length by four (six minus two).
2390     
2391     Thanks to the design of UTF-8, there cannot be false matches:
2392     A sequence of valid UTF-8 bytes cannot be a subsequence of
2393     another valid sequence of UTF-8 bytes.
2394     
2395     */
2396          char * const s0 = STRING(scan), *s, *t;
2397          char * const s1 = s0 + STR_LEN(scan) - 1;
2398          char * const s2 = s1 - 4;
2399 #ifdef EBCDIC /* RD tunifold greek 0390 and 03B0 */
2400          const char t0[] = "\xaf\x49\xaf\x42";
2401 #else
2402          const char t0[] = "\xcc\x88\xcc\x81";
2403 #endif
2404          const char * const t1 = t0 + 3;
2405     
2406          for (s = s0 + 2;
2407               s < s2 && (t = ninstr(s, s1, t0, t1));
2408               s = t + 4) {
2409 #ifdef EBCDIC
2410               if (((U8)t[-1] == 0x68 && (U8)t[-2] == 0xB4) ||
2411                   ((U8)t[-1] == 0x46 && (U8)t[-2] == 0xB5))
2412 #else
2413               if (((U8)t[-1] == 0xB9 && (U8)t[-2] == 0xCE) ||
2414                   ((U8)t[-1] == 0x85 && (U8)t[-2] == 0xCF))
2415 #endif
2416                    *min -= 4;
2417          }
2418     }
2419     
2420 #ifdef DEBUGGING
2421     /* Allow dumping */
2422     n = scan + NODE_SZ_STR(scan);
2423     while (n <= stop) {
2424         if (PL_regkind[OP(n)] != NOTHING || OP(n) == NOTHING) {
2425             OP(n) = OPTIMIZED;
2426             NEXT_OFF(n) = 0;
2427         }
2428         n++;
2429     }
2430 #endif
2431     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2432     return stopnow;
2433 }
2434
2435 /* REx optimizer.  Converts nodes into quickier variants "in place".
2436    Finds fixed substrings.  */
2437
2438 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2439    to the position after last scanned or to NULL. */
2440
2441 #define INIT_AND_WITHP \
2442     assert(!and_withp); \
2443     Newx(and_withp,1,struct regnode_charclass_class); \
2444     SAVEFREEPV(and_withp)
2445
2446 /* this is a chain of data about sub patterns we are processing that
2447    need to be handled seperately/specially in study_chunk. Its so
2448    we can simulate recursion without losing state.  */
2449 struct scan_frame;
2450 typedef struct scan_frame {
2451     regnode *last;  /* last node to process in this frame */
2452     regnode *next;  /* next node to process when last is reached */
2453     struct scan_frame *prev; /*previous frame*/
2454     I32 stop; /* what stopparen do we use */
2455 } scan_frame;
2456
2457
2458 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2459
2460 #define CASE_SYNST_FNC(nAmE)                                       \
2461 case nAmE:                                                         \
2462     if (flags & SCF_DO_STCLASS_AND) {                              \
2463             for (value = 0; value < 256; value++)                  \
2464                 if (!is_ ## nAmE ## _cp(value))                       \
2465                     ANYOF_BITMAP_CLEAR(data->start_class, value);  \
2466     }                                                              \
2467     else {                                                         \
2468             for (value = 0; value < 256; value++)                  \
2469                 if (is_ ## nAmE ## _cp(value))                        \
2470                     ANYOF_BITMAP_SET(data->start_class, value);    \
2471     }                                                              \
2472     break;                                                         \
2473 case N ## nAmE:                                                    \
2474     if (flags & SCF_DO_STCLASS_AND) {                              \
2475             for (value = 0; value < 256; value++)                   \
2476                 if (is_ ## nAmE ## _cp(value))                         \
2477                     ANYOF_BITMAP_CLEAR(data->start_class, value);   \
2478     }                                                               \
2479     else {                                                          \
2480             for (value = 0; value < 256; value++)                   \
2481                 if (!is_ ## nAmE ## _cp(value))                        \
2482                     ANYOF_BITMAP_SET(data->start_class, value);     \
2483     }                                                               \
2484     break
2485
2486
2487
2488 STATIC I32
2489 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2490                         I32 *minlenp, I32 *deltap,
2491                         regnode *last,
2492                         scan_data_t *data,
2493                         I32 stopparen,
2494                         U8* recursed,
2495                         struct regnode_charclass_class *and_withp,
2496                         U32 flags, U32 depth)
2497                         /* scanp: Start here (read-write). */
2498                         /* deltap: Write maxlen-minlen here. */
2499                         /* last: Stop before this one. */
2500                         /* data: string data about the pattern */
2501                         /* stopparen: treat close N as END */
2502                         /* recursed: which subroutines have we recursed into */
2503                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
2504 {
2505     dVAR;
2506     I32 min = 0, pars = 0, code;
2507     regnode *scan = *scanp, *next;
2508     I32 delta = 0;
2509     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
2510     int is_inf_internal = 0;            /* The studied chunk is infinite */
2511     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
2512     scan_data_t data_fake;
2513     SV *re_trie_maxbuff = NULL;
2514     regnode *first_non_open = scan;
2515     I32 stopmin = I32_MAX;
2516     scan_frame *frame = NULL;
2517     GET_RE_DEBUG_FLAGS_DECL;
2518
2519     PERL_ARGS_ASSERT_STUDY_CHUNK;
2520
2521 #ifdef DEBUGGING
2522     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
2523 #endif
2524
2525     if ( depth == 0 ) {
2526         while (first_non_open && OP(first_non_open) == OPEN)
2527             first_non_open=regnext(first_non_open);
2528     }
2529
2530
2531   fake_study_recurse:
2532     while ( scan && OP(scan) != END && scan < last ){
2533         /* Peephole optimizer: */
2534         DEBUG_STUDYDATA("Peep:", data,depth);
2535         DEBUG_PEEP("Peep",scan,depth);
2536         JOIN_EXACT(scan,&min,0);
2537
2538         /* Follow the next-chain of the current node and optimize
2539            away all the NOTHINGs from it.  */
2540         if (OP(scan) != CURLYX) {
2541             const int max = (reg_off_by_arg[OP(scan)]
2542                        ? I32_MAX
2543                        /* I32 may be smaller than U16 on CRAYs! */
2544                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
2545             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
2546             int noff;
2547             regnode *n = scan;
2548         
2549             /* Skip NOTHING and LONGJMP. */
2550             while ((n = regnext(n))
2551                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
2552                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
2553                    && off + noff < max)
2554                 off += noff;
2555             if (reg_off_by_arg[OP(scan)])
2556                 ARG(scan) = off;
2557             else
2558                 NEXT_OFF(scan) = off;
2559         }
2560
2561
2562
2563         /* The principal pseudo-switch.  Cannot be a switch, since we
2564            look into several different things.  */
2565         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
2566                    || OP(scan) == IFTHEN) {
2567             next = regnext(scan);
2568             code = OP(scan);
2569             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
2570         
2571             if (OP(next) == code || code == IFTHEN) {
2572                 /* NOTE - There is similar code to this block below for handling
2573                    TRIE nodes on a re-study.  If you change stuff here check there
2574                    too. */
2575                 I32 max1 = 0, min1 = I32_MAX, num = 0;
2576                 struct regnode_charclass_class accum;
2577                 regnode * const startbranch=scan;
2578                 
2579                 if (flags & SCF_DO_SUBSTR)
2580                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
2581                 if (flags & SCF_DO_STCLASS)
2582                     cl_init_zero(pRExC_state, &accum);
2583
2584                 while (OP(scan) == code) {
2585                     I32 deltanext, minnext, f = 0, fake;
2586                     struct regnode_charclass_class this_class;
2587
2588                     num++;
2589                     data_fake.flags = 0;
2590                     if (data) {
2591                         data_fake.whilem_c = data->whilem_c;
2592                         data_fake.last_closep = data->last_closep;
2593                     }
2594                     else
2595                         data_fake.last_closep = &fake;
2596
2597                     data_fake.pos_delta = delta;
2598                     next = regnext(scan);
2599                     scan = NEXTOPER(scan);
2600                     if (code != BRANCH)
2601                         scan = NEXTOPER(scan);
2602                     if (flags & SCF_DO_STCLASS) {
2603                         cl_init(pRExC_state, &this_class);
2604                         data_fake.start_class = &this_class;
2605                         f = SCF_DO_STCLASS_AND;
2606                     }
2607                     if (flags & SCF_WHILEM_VISITED_POS)
2608                         f |= SCF_WHILEM_VISITED_POS;
2609
2610                     /* we suppose the run is continuous, last=next...*/
2611                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
2612                                           next, &data_fake,
2613                                           stopparen, recursed, NULL, f,depth+1);
2614                     if (min1 > minnext)
2615                         min1 = minnext;
2616                     if (max1 < minnext + deltanext)
2617                         max1 = minnext + deltanext;
2618                     if (deltanext == I32_MAX)
2619                         is_inf = is_inf_internal = 1;
2620                     scan = next;
2621                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
2622                         pars++;
2623                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
2624                         if ( stopmin > minnext) 
2625                             stopmin = min + min1;
2626                         flags &= ~SCF_DO_SUBSTR;
2627                         if (data)
2628                             data->flags |= SCF_SEEN_ACCEPT;
2629                     }
2630                     if (data) {
2631                         if (data_fake.flags & SF_HAS_EVAL)
2632                             data->flags |= SF_HAS_EVAL;
2633                         data->whilem_c = data_fake.whilem_c;
2634                     }
2635                     if (flags & SCF_DO_STCLASS)
2636                         cl_or(pRExC_state, &accum, &this_class);
2637                 }
2638                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
2639                     min1 = 0;
2640                 if (flags & SCF_DO_SUBSTR) {
2641                     data->pos_min += min1;
2642                     data->pos_delta += max1 - min1;
2643                     if (max1 != min1 || is_inf)
2644                         data->longest = &(data->longest_float);
2645                 }
2646                 min += min1;
2647                 delta += max1 - min1;
2648                 if (flags & SCF_DO_STCLASS_OR) {
2649                     cl_or(pRExC_state, data->start_class, &accum);
2650                     if (min1) {
2651                         cl_and(data->start_class, and_withp);
2652                         flags &= ~SCF_DO_STCLASS;
2653                     }
2654                 }
2655                 else if (flags & SCF_DO_STCLASS_AND) {
2656                     if (min1) {
2657                         cl_and(data->start_class, &accum);
2658                         flags &= ~SCF_DO_STCLASS;
2659                     }
2660                     else {
2661                         /* Switch to OR mode: cache the old value of
2662                          * data->start_class */
2663                         INIT_AND_WITHP;
2664                         StructCopy(data->start_class, and_withp,
2665                                    struct regnode_charclass_class);
2666                         flags &= ~SCF_DO_STCLASS_AND;
2667                         StructCopy(&accum, data->start_class,
2668                                    struct regnode_charclass_class);
2669                         flags |= SCF_DO_STCLASS_OR;
2670                         data->start_class->flags |= ANYOF_EOS;
2671                     }
2672                 }
2673
2674                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
2675                 /* demq.
2676
2677                    Assuming this was/is a branch we are dealing with: 'scan' now
2678                    points at the item that follows the branch sequence, whatever
2679                    it is. We now start at the beginning of the sequence and look
2680                    for subsequences of
2681
2682                    BRANCH->EXACT=>x1
2683                    BRANCH->EXACT=>x2
2684                    tail
2685
2686                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
2687
2688                    If we can find such a subseqence we need to turn the first
2689                    element into a trie and then add the subsequent branch exact
2690                    strings to the trie.
2691
2692                    We have two cases
2693
2694                      1. patterns where the whole set of branch can be converted. 
2695
2696                      2. patterns where only a subset can be converted.
2697
2698                    In case 1 we can replace the whole set with a single regop
2699                    for the trie. In case 2 we need to keep the start and end
2700                    branchs so
2701
2702                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
2703                      becomes BRANCH TRIE; BRANCH X;
2704
2705                   There is an additional case, that being where there is a 
2706                   common prefix, which gets split out into an EXACT like node
2707                   preceding the TRIE node.
2708
2709                   If x(1..n)==tail then we can do a simple trie, if not we make
2710                   a "jump" trie, such that when we match the appropriate word
2711                   we "jump" to the appopriate tail node. Essentailly we turn
2712                   a nested if into a case structure of sorts.
2713
2714                 */
2715                 
2716                     int made=0;
2717                     if (!re_trie_maxbuff) {
2718                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2719                         if (!SvIOK(re_trie_maxbuff))
2720                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2721                     }
2722                     if ( SvIV(re_trie_maxbuff)>=0  ) {
2723                         regnode *cur;
2724                         regnode *first = (regnode *)NULL;
2725                         regnode *last = (regnode *)NULL;
2726                         regnode *tail = scan;
2727                         U8 optype = 0;
2728                         U32 count=0;
2729
2730 #ifdef DEBUGGING
2731                         SV * const mysv = sv_newmortal();       /* for dumping */
2732 #endif
2733                         /* var tail is used because there may be a TAIL
2734                            regop in the way. Ie, the exacts will point to the
2735                            thing following the TAIL, but the last branch will
2736                            point at the TAIL. So we advance tail. If we
2737                            have nested (?:) we may have to move through several
2738                            tails.
2739                          */
2740
2741                         while ( OP( tail ) == TAIL ) {
2742                             /* this is the TAIL generated by (?:) */
2743                             tail = regnext( tail );
2744                         }
2745
2746                         
2747                         DEBUG_OPTIMISE_r({
2748                             regprop(RExC_rx, mysv, tail );
2749                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
2750                                 (int)depth * 2 + 2, "", 
2751                                 "Looking for TRIE'able sequences. Tail node is: ", 
2752                                 SvPV_nolen_const( mysv )
2753                             );
2754                         });
2755                         
2756                         /*
2757
2758                            step through the branches, cur represents each
2759                            branch, noper is the first thing to be matched
2760                            as part of that branch and noper_next is the
2761                            regnext() of that node. if noper is an EXACT
2762                            and noper_next is the same as scan (our current
2763                            position in the regex) then the EXACT branch is
2764                            a possible optimization target. Once we have
2765                            two or more consequetive such branches we can
2766                            create a trie of the EXACT's contents and stich
2767                            it in place. If the sequence represents all of
2768                            the branches we eliminate the whole thing and
2769                            replace it with a single TRIE. If it is a
2770                            subsequence then we need to stitch it in. This
2771                            means the first branch has to remain, and needs
2772                            to be repointed at the item on the branch chain
2773                            following the last branch optimized. This could
2774                            be either a BRANCH, in which case the
2775                            subsequence is internal, or it could be the
2776                            item following the branch sequence in which
2777                            case the subsequence is at the end.
2778
2779                         */
2780
2781                         /* dont use tail as the end marker for this traverse */
2782                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
2783                             regnode * const noper = NEXTOPER( cur );
2784 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
2785                             regnode * const noper_next = regnext( noper );
2786 #endif
2787
2788                             DEBUG_OPTIMISE_r({
2789                                 regprop(RExC_rx, mysv, cur);
2790                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
2791                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
2792
2793                                 regprop(RExC_rx, mysv, noper);
2794                                 PerlIO_printf( Perl_debug_log, " -> %s",
2795                                     SvPV_nolen_const(mysv));
2796
2797                                 if ( noper_next ) {
2798                                   regprop(RExC_rx, mysv, noper_next );
2799                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
2800                                     SvPV_nolen_const(mysv));
2801                                 }
2802                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d)\n",
2803                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur) );
2804                             });
2805                             if ( (((first && optype!=NOTHING) ? OP( noper ) == optype
2806                                          : PL_regkind[ OP( noper ) ] == EXACT )
2807                                   || OP(noper) == NOTHING )
2808 #ifdef NOJUMPTRIE
2809                                   && noper_next == tail
2810 #endif
2811                                   && count < U16_MAX)
2812                             {
2813                                 count++;
2814                                 if ( !first || optype == NOTHING ) {
2815                                     if (!first) first = cur;
2816                                     optype = OP( noper );
2817                                 } else {
2818                                     last = cur;
2819                                 }
2820                             } else {
2821 /* 
2822     Currently we assume that the trie can handle unicode and ascii
2823     matches fold cased matches. If this proves true then the following
2824     define will prevent tries in this situation. 
2825     
2826     #define TRIE_TYPE_IS_SAFE (UTF || optype==EXACT)
2827 */
2828 #define TRIE_TYPE_IS_SAFE 1
2829                                 if ( last && TRIE_TYPE_IS_SAFE ) {
2830                                     make_trie( pRExC_state, 
2831                                             startbranch, first, cur, tail, count, 
2832                                             optype, depth+1 );
2833                                 }
2834                                 if ( PL_regkind[ OP( noper ) ] == EXACT
2835 #ifdef NOJUMPTRIE
2836                                      && noper_next == tail
2837 #endif
2838                                 ){
2839                                     count = 1;
2840                                     first = cur;
2841                                     optype = OP( noper );
2842                                 } else {
2843                                     count = 0;
2844                                     first = NULL;
2845                                     optype = 0;
2846                                 }
2847                                 last = NULL;
2848                             }
2849                         }
2850                         DEBUG_OPTIMISE_r({
2851                             regprop(RExC_rx, mysv, cur);
2852                             PerlIO_printf( Perl_debug_log,
2853                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
2854                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
2855
2856                         });
2857                         
2858                         if ( last && TRIE_TYPE_IS_SAFE ) {
2859                             made= make_trie( pRExC_state, startbranch, first, scan, tail, count, optype, depth+1 );
2860 #ifdef TRIE_STUDY_OPT   
2861                             if ( ((made == MADE_EXACT_TRIE && 
2862                                  startbranch == first) 
2863                                  || ( first_non_open == first )) && 
2864                                  depth==0 ) {
2865                                 flags |= SCF_TRIE_RESTUDY;
2866                                 if ( startbranch == first 
2867                                      && scan == tail ) 
2868                                 {
2869                                     RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
2870                                 }
2871                             }
2872 #endif
2873                         }
2874                     }
2875                     
2876                 } /* do trie */
2877                 
2878             }
2879             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
2880                 scan = NEXTOPER(NEXTOPER(scan));
2881             } else                      /* single branch is optimized. */
2882                 scan = NEXTOPER(scan);
2883             continue;
2884         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
2885             scan_frame *newframe = NULL;
2886             I32 paren;
2887             regnode *start;
2888             regnode *end;
2889
2890             if (OP(scan) != SUSPEND) {
2891             /* set the pointer */
2892                 if (OP(scan) == GOSUB) {
2893                     paren = ARG(scan);
2894                     RExC_recurse[ARG2L(scan)] = scan;
2895                     start = RExC_open_parens[paren-1];
2896                     end   = RExC_close_parens[paren-1];
2897                 } else {
2898                     paren = 0;
2899                     start = RExC_rxi->program + 1;
2900                     end   = RExC_opend;
2901                 }
2902                 if (!recursed) {
2903                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
2904                     SAVEFREEPV(recursed);
2905                 }
2906                 if (!PAREN_TEST(recursed,paren+1)) {
2907                     PAREN_SET(recursed,paren+1);
2908                     Newx(newframe,1,scan_frame);
2909                 } else {
2910                     if (flags & SCF_DO_SUBSTR) {
2911                         SCAN_COMMIT(pRExC_state,data,minlenp);
2912                         data->longest = &(data->longest_float);
2913                     }
2914                     is_inf = is_inf_internal = 1;
2915                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
2916                         cl_anything(pRExC_state, data->start_class);
2917                     flags &= ~SCF_DO_STCLASS;
2918                 }
2919             } else {
2920                 Newx(newframe,1,scan_frame);
2921                 paren = stopparen;
2922                 start = scan+2;
2923                 end = regnext(scan);
2924             }
2925             if (newframe) {
2926                 assert(start);
2927                 assert(end);
2928                 SAVEFREEPV(newframe);
2929                 newframe->next = regnext(scan);
2930                 newframe->last = last;
2931                 newframe->stop = stopparen;
2932                 newframe->prev = frame;
2933
2934                 frame = newframe;
2935                 scan =  start;
2936                 stopparen = paren;
2937                 last = end;
2938
2939                 continue;
2940             }
2941         }
2942         else if (OP(scan) == EXACT) {
2943             I32 l = STR_LEN(scan);
2944             UV uc;
2945             if (UTF) {
2946                 const U8 * const s = (U8*)STRING(scan);
2947                 l = utf8_length(s, s + l);
2948                 uc = utf8_to_uvchr(s, NULL);
2949             } else {
2950                 uc = *((U8*)STRING(scan));
2951             }
2952             min += l;
2953             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
2954                 /* The code below prefers earlier match for fixed
2955                    offset, later match for variable offset.  */
2956                 if (data->last_end == -1) { /* Update the start info. */
2957                     data->last_start_min = data->pos_min;
2958                     data->last_start_max = is_inf
2959                         ? I32_MAX : data->pos_min + data->pos_delta;
2960                 }
2961                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
2962                 if (UTF)
2963                     SvUTF8_on(data->last_found);
2964                 {
2965                     SV * const sv = data->last_found;
2966                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
2967                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
2968                     if (mg && mg->mg_len >= 0)
2969                         mg->mg_len += utf8_length((U8*)STRING(scan),
2970                                                   (U8*)STRING(scan)+STR_LEN(scan));
2971                 }
2972                 data->last_end = data->pos_min + l;
2973                 data->pos_min += l; /* As in the first entry. */
2974                 data->flags &= ~SF_BEFORE_EOL;
2975             }
2976             if (flags & SCF_DO_STCLASS_AND) {
2977                 /* Check whether it is compatible with what we know already! */
2978                 int compat = 1;
2979
2980                 if (uc >= 0x100 ||
2981                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
2982                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
2983                     && (!(data->start_class->flags & ANYOF_FOLD)
2984                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold[uc])))
2985                     )
2986                     compat = 0;
2987                 ANYOF_CLASS_ZERO(data->start_class);
2988                 ANYOF_BITMAP_ZERO(data->start_class);
2989                 if (compat)
2990                     ANYOF_BITMAP_SET(data->start_class, uc);
2991                 data->start_class->flags &= ~ANYOF_EOS;
2992                 if (uc < 0x100)
2993                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
2994             }
2995             else if (flags & SCF_DO_STCLASS_OR) {
2996                 /* false positive possible if the class is case-folded */
2997                 if (uc < 0x100)
2998                     ANYOF_BITMAP_SET(data->start_class, uc);
2999                 else
3000                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3001                 data->start_class->flags &= ~ANYOF_EOS;
3002                 cl_and(data->start_class, and_withp);
3003             }
3004             flags &= ~SCF_DO_STCLASS;
3005         }
3006         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3007             I32 l = STR_LEN(scan);
3008             UV uc = *((U8*)STRING(scan));
3009
3010             /* Search for fixed substrings supports EXACT only. */
3011             if (flags & SCF_DO_SUBSTR) {
3012                 assert(data);
3013                 SCAN_COMMIT(pRExC_state, data, minlenp);
3014             }
3015             if (UTF) {
3016                 const U8 * const s = (U8 *)STRING(scan);
3017                 l = utf8_length(s, s + l);
3018                 uc = utf8_to_uvchr(s, NULL);
3019             }
3020             min += l;
3021             if (flags & SCF_DO_SUBSTR)
3022                 data->pos_min += l;
3023             if (flags & SCF_DO_STCLASS_AND) {
3024                 /* Check whether it is compatible with what we know already! */
3025                 int compat = 1;
3026
3027                 if (uc >= 0x100 ||
3028                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3029                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3030                      && !ANYOF_BITMAP_TEST(data->start_class, PL_fold[uc])))
3031                     compat = 0;
3032                 ANYOF_CLASS_ZERO(data->start_class);
3033                 ANYOF_BITMAP_ZERO(data->start_class);
3034                 if (compat) {
3035                     ANYOF_BITMAP_SET(data->start_class, uc);
3036                     data->start_class->flags &= ~ANYOF_EOS;
3037                     data->start_class->flags |= ANYOF_FOLD;
3038                     if (OP(scan) == EXACTFL)
3039                         data->start_class->flags |= ANYOF_LOCALE;
3040                 }
3041             }
3042             else if (flags & SCF_DO_STCLASS_OR) {
3043                 if (data->start_class->flags & ANYOF_FOLD) {
3044                     /* false positive possible if the class is case-folded.
3045                        Assume that the locale settings are the same... */
3046                     if (uc < 0x100)
3047                         ANYOF_BITMAP_SET(data->start_class, uc);
3048                     data->start_class->flags &= ~ANYOF_EOS;
3049                 }
3050                 cl_and(data->start_class, and_withp);
3051             }
3052             flags &= ~SCF_DO_STCLASS;
3053         }
3054         else if (strchr((const char*)PL_varies,OP(scan))) {
3055             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3056             I32 f = flags, pos_before = 0;
3057             regnode * const oscan = scan;
3058             struct regnode_charclass_class this_class;
3059             struct regnode_charclass_class *oclass = NULL;
3060             I32 next_is_eval = 0;
3061
3062             switch (PL_regkind[OP(scan)]) {
3063             case WHILEM:                /* End of (?:...)* . */
3064                 scan = NEXTOPER(scan);
3065                 goto finish;
3066             case PLUS:
3067                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3068                     next = NEXTOPER(scan);
3069                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3070                         mincount = 1;
3071                         maxcount = REG_INFTY;
3072                         next = regnext(scan);
3073                         scan = NEXTOPER(scan);
3074                         goto do_curly;
3075                     }
3076                 }
3077                 if (flags & SCF_DO_SUBSTR)
3078                     data->pos_min++;
3079                 min++;
3080                 /* Fall through. */
3081             case STAR:
3082                 if (flags & SCF_DO_STCLASS) {
3083                     mincount = 0;
3084                     maxcount = REG_INFTY;
3085                     next = regnext(scan);
3086                     scan = NEXTOPER(scan);
3087                     goto do_curly;
3088                 }
3089                 is_inf = is_inf_internal = 1;
3090                 scan = regnext(scan);
3091                 if (flags & SCF_DO_SUBSTR) {
3092                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3093                     data->longest = &(data->longest_float);
3094                 }
3095                 goto optimize_curly_tail;
3096             case CURLY:
3097                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3098                     && (scan->flags == stopparen))
3099                 {
3100                     mincount = 1;
3101                     maxcount = 1;
3102                 } else {
3103                     mincount = ARG1(scan);
3104                     maxcount = ARG2(scan);
3105                 }
3106                 next = regnext(scan);
3107                 if (OP(scan) == CURLYX) {
3108                     I32 lp = (data ? *(data->last_closep) : 0);
3109                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3110                 }
3111                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3112                 next_is_eval = (OP(scan) == EVAL);
3113               do_curly:
3114                 if (flags & SCF_DO_SUBSTR) {
3115                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3116                     pos_before = data->pos_min;
3117                 }
3118                 if (data) {
3119                     fl = data->flags;
3120                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3121                     if (is_inf)
3122                         data->flags |= SF_IS_INF;
3123                 }
3124                 if (flags & SCF_DO_STCLASS) {
3125                     cl_init(pRExC_state, &this_class);
3126                     oclass = data->start_class;
3127                     data->start_class = &this_class;
3128                     f |= SCF_DO_STCLASS_AND;
3129                     f &= ~SCF_DO_STCLASS_OR;
3130                 }
3131                 /* These are the cases when once a subexpression
3132                    fails at a particular position, it cannot succeed
3133                    even after backtracking at the enclosing scope.
3134                 
3135                    XXXX what if minimal match and we are at the
3136                         initial run of {n,m}? */
3137                 if ((mincount != maxcount - 1) && (maxcount != REG_INFTY))
3138                     f &= ~SCF_WHILEM_VISITED_POS;
3139
3140                 /* This will finish on WHILEM, setting scan, or on NULL: */
3141                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3142                                       last, data, stopparen, recursed, NULL,
3143                                       (mincount == 0
3144                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3145
3146                 if (flags & SCF_DO_STCLASS)
3147                     data->start_class = oclass;
3148                 if (mincount == 0 || minnext == 0) {
3149                     if (flags & SCF_DO_STCLASS_OR) {
3150                         cl_or(pRExC_state, data->start_class, &this_class);
3151                     }
3152                     else if (flags & SCF_DO_STCLASS_AND) {
3153                         /* Switch to OR mode: cache the old value of
3154                          * data->start_class */
3155                         INIT_AND_WITHP;
3156                         StructCopy(data->start_class, and_withp,
3157                                    struct regnode_charclass_class);
3158                         flags &= ~SCF_DO_STCLASS_AND;
3159                         StructCopy(&this_class, data->start_class,
3160                                    struct regnode_charclass_class);
3161                         flags |= SCF_DO_STCLASS_OR;
3162                         data->start_class->flags |= ANYOF_EOS;
3163                     }
3164                 } else {                /* Non-zero len */
3165                     if (flags & SCF_DO_STCLASS_OR) {
3166                         cl_or(pRExC_state, data->start_class, &this_class);
3167                         cl_and(data->start_class, and_withp);
3168                     }
3169                     else if (flags & SCF_DO_STCLASS_AND)
3170                         cl_and(data->start_class, &this_class);
3171                     flags &= ~SCF_DO_STCLASS;
3172                 }
3173                 if (!scan)              /* It was not CURLYX, but CURLY. */
3174                     scan = next;
3175                 if ( /* ? quantifier ok, except for (?{ ... }) */
3176                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3177                     && (minnext == 0) && (deltanext == 0)
3178                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3179                     && maxcount <= REG_INFTY/3 /* Complement check for big count */
3180                     && ckWARN(WARN_REGEXP))
3181                 {
3182                     vWARN(RExC_parse,
3183                           "Quantifier unexpected on zero-length expression");
3184                 }
3185
3186                 min += minnext * mincount;
3187                 is_inf_internal |= ((maxcount == REG_INFTY
3188                                      && (minnext + deltanext) > 0)
3189                                     || deltanext == I32_MAX);
3190                 is_inf |= is_inf_internal;
3191                 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3192
3193                 /* Try powerful optimization CURLYX => CURLYN. */
3194                 if (  OP(oscan) == CURLYX && data
3195                       && data->flags & SF_IN_PAR
3196                       && !(data->flags & SF_HAS_EVAL)
3197                       && !deltanext && minnext == 1 ) {
3198                     /* Try to optimize to CURLYN.  */
3199                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3200                     regnode * const nxt1 = nxt;
3201 #ifdef DEBUGGING
3202                     regnode *nxt2;
3203 #endif
3204
3205                     /* Skip open. */
3206                     nxt = regnext(nxt);
3207                     if (!strchr((const char*)PL_simple,OP(nxt))
3208                         && !(PL_regkind[OP(nxt)] == EXACT
3209                              && STR_LEN(nxt) == 1))
3210                         goto nogo;
3211 #ifdef DEBUGGING
3212                     nxt2 = nxt;
3213 #endif
3214                     nxt = regnext(nxt);
3215                     if (OP(nxt) != CLOSE)
3216                         goto nogo;
3217                     if (RExC_open_parens) {
3218                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3219                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3220                     }
3221                     /* Now we know that nxt2 is the only contents: */
3222                     oscan->flags = (U8)ARG(nxt);
3223                     OP(oscan) = CURLYN;
3224                     OP(nxt1) = NOTHING; /* was OPEN. */
3225
3226 #ifdef DEBUGGING
3227                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3228                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistancy. */
3229                     NEXT_OFF(nxt2) = 0; /* just for consistancy with CURLY. */
3230                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3231                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3232                     NEXT_OFF(nxt+ 1) = 0; /* just for consistancy. */
3233 #endif
3234                 }
3235               nogo:
3236
3237                 /* Try optimization CURLYX => CURLYM. */
3238                 if (  OP(oscan) == CURLYX && data
3239                       && !(data->flags & SF_HAS_PAR)
3240                       && !(data->flags & SF_HAS_EVAL)
3241                       && !deltanext     /* atom is fixed width */
3242                       && minnext != 0   /* CURLYM can't handle zero width */
3243                 ) {
3244                     /* XXXX How to optimize if data == 0? */
3245                     /* Optimize to a simpler form.  */
3246                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3247                     regnode *nxt2;
3248
3249                     OP(oscan) = CURLYM;
3250                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3251                             && (OP(nxt2) != WHILEM))
3252                         nxt = nxt2;
3253                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3254                     /* Need to optimize away parenths. */
3255                     if (data->flags & SF_IN_PAR) {
3256                         /* Set the parenth number.  */
3257                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3258
3259                         if (OP(nxt) != CLOSE)
3260                             FAIL("Panic opt close");
3261                         oscan->flags = (U8)ARG(nxt);
3262                         if (RExC_open_parens) {
3263                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3264                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3265                         }
3266                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3267                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3268
3269 #ifdef DEBUGGING
3270                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3271                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3272                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistancy. */
3273                         NEXT_OFF(nxt + 1) = 0; /* just for consistancy. */
3274 #endif
3275 #if 0
3276                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3277                             regnode *nnxt = regnext(nxt1);
3278                         
3279                             if (nnxt == nxt) {
3280                                 if (reg_off_by_arg[OP(nxt1)])
3281                                     ARG_SET(nxt1, nxt2 - nxt1);
3282                                 else if (nxt2 - nxt1 < U16_MAX)
3283                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3284                                 else
3285                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3286                             }
3287                             nxt1 = nnxt;
3288                         }
3289 #endif
3290                         /* Optimize again: */
3291                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
3292                                     NULL, stopparen, recursed, NULL, 0,depth+1);
3293                     }
3294                     else
3295                         oscan->flags = 0;
3296                 }
3297                 else if ((OP(oscan) == CURLYX)
3298                          && (flags & SCF_WHILEM_VISITED_POS)
3299                          /* See the comment on a similar expression above.
3300                             However, this time it not a subexpression
3301                             we care about, but the expression itself. */
3302                          && (maxcount == REG_INFTY)
3303                          && data && ++data->whilem_c < 16) {
3304                     /* This stays as CURLYX, we can put the count/of pair. */
3305                     /* Find WHILEM (as in regexec.c) */
3306                     regnode *nxt = oscan + NEXT_OFF(oscan);
3307
3308                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
3309                         nxt += ARG(nxt);
3310                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
3311                         | (RExC_whilem_seen << 4)); /* On WHILEM */
3312                 }
3313                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
3314                     pars++;
3315                 if (flags & SCF_DO_SUBSTR) {
3316                     SV *last_str = NULL;
3317                     int counted = mincount != 0;
3318
3319                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
3320 #if defined(SPARC64_GCC_WORKAROUND)
3321                         I32 b = 0;
3322                         STRLEN l = 0;
3323                         const char *s = NULL;
3324                         I32 old = 0;
3325
3326                         if (pos_before >= data->last_start_min)
3327                             b = pos_before;
3328                         else
3329                             b = data->last_start_min;
3330
3331                         l = 0;
3332                         s = SvPV_const(data->last_found, l);
3333                         old = b - data->last_start_min;
3334
3335 #else
3336                         I32 b = pos_before >= data->last_start_min
3337                             ? pos_before : data->last_start_min;
3338                         STRLEN l;
3339                         const char * const s = SvPV_const(data->last_found, l);
3340                         I32 old = b - data->last_start_min;
3341 #endif
3342
3343                         if (UTF)
3344                             old = utf8_hop((U8*)s, old) - (U8*)s;
3345                         
3346                         l -= old;
3347                         /* Get the added string: */
3348                         last_str = newSVpvn_utf8(s  + old, l, UTF);
3349                         if (deltanext == 0 && pos_before == b) {
3350                             /* What was added is a constant string */
3351                             if (mincount > 1) {
3352                                 SvGROW(last_str, (mincount * l) + 1);
3353                                 repeatcpy(SvPVX(last_str) + l,
3354                                           SvPVX_const(last_str), l, mincount - 1);
3355                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
3356                                 /* Add additional parts. */
3357                                 SvCUR_set(data->last_found,
3358                                           SvCUR(data->last_found) - l);
3359                                 sv_catsv(data->last_found, last_str);
3360                                 {
3361                                     SV * sv = data->last_found;
3362                                     MAGIC *mg =
3363                                         SvUTF8(sv) && SvMAGICAL(sv) ?
3364                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3365                                     if (mg && mg->mg_len >= 0)
3366                                         mg->mg_len += CHR_SVLEN(last_str) - l;
3367                                 }
3368                                 data->last_end += l * (mincount - 1);
3369                             }
3370                         } else {
3371                             /* start offset must point into the last copy */
3372                             data->last_start_min += minnext * (mincount - 1);
3373                             data->last_start_max += is_inf ? I32_MAX
3374                                 : (maxcount - 1) * (minnext + data->pos_delta);
3375                         }
3376                     }
3377                     /* It is counted once already... */
3378                     data->pos_min += minnext * (mincount - counted);
3379                     data->pos_delta += - counted * deltanext +
3380                         (minnext + deltanext) * maxcount - minnext * mincount;
3381                     if (mincount != maxcount) {
3382                          /* Cannot extend fixed substrings found inside
3383                             the group.  */
3384                         SCAN_COMMIT(pRExC_state,data,minlenp);
3385                         if (mincount && last_str) {
3386                             SV * const sv = data->last_found;
3387                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3388                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3389
3390                             if (mg)
3391                                 mg->mg_len = -1;
3392                             sv_setsv(sv, last_str);
3393                             data->last_end = data->pos_min;
3394                             data->last_start_min =
3395                                 data->pos_min - CHR_SVLEN(last_str);
3396                             data->last_start_max = is_inf
3397                                 ? I32_MAX
3398                                 : data->pos_min + data->pos_delta
3399                                 - CHR_SVLEN(last_str);
3400                         }
3401                         data->longest = &(data->longest_float);
3402                     }
3403                     SvREFCNT_dec(last_str);
3404                 }
3405                 if (data && (fl & SF_HAS_EVAL))
3406                     data->flags |= SF_HAS_EVAL;
3407               optimize_curly_tail:
3408                 if (OP(oscan) != CURLYX) {
3409                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
3410                            && NEXT_OFF(next))
3411                         NEXT_OFF(oscan) += NEXT_OFF(next);
3412                 }
3413                 continue;
3414             default:                    /* REF and CLUMP only? */
3415                 if (flags & SCF_DO_SUBSTR) {
3416                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
3417                     data->longest = &(data->longest_float);
3418                 }
3419                 is_inf = is_inf_internal = 1;
3420                 if (flags & SCF_DO_STCLASS_OR)
3421                     cl_anything(pRExC_state, data->start_class);
3422                 flags &= ~SCF_DO_STCLASS;
3423                 break;
3424             }
3425         }
3426         else if (OP(scan) == LNBREAK) {
3427             if (flags & SCF_DO_STCLASS) {
3428                 int value = 0;
3429                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
3430                 if (flags & SCF_DO_STCLASS_AND) {
3431                     for (value = 0; value < 256; value++)
3432                         if (!is_VERTWS_cp(value))
3433                             ANYOF_BITMAP_CLEAR(data->start_class, value);  
3434                 }                                                              
3435                 else {                                                         
3436                     for (value = 0; value < 256; value++)
3437                         if (is_VERTWS_cp(value))
3438                             ANYOF_BITMAP_SET(data->start_class, value);    
3439                 }                                                              
3440                 if (flags & SCF_DO_STCLASS_OR)
3441                     cl_and(data->start_class, and_withp);
3442                 flags &= ~SCF_DO_STCLASS;
3443             }
3444             min += 1;
3445             delta += 1;
3446             if (flags & SCF_DO_SUBSTR) {
3447                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
3448                 data->pos_min += 1;
3449                 data->pos_delta += 1;
3450                 data->longest = &(data->longest_float);
3451             }
3452             
3453         }
3454         else if (OP(scan) == FOLDCHAR) {
3455             int d = ARG(scan)==0xDF ? 1 : 2;
3456             flags &= ~SCF_DO_STCLASS;
3457             min += 1;
3458             delta += d;
3459             if (flags & SCF_DO_SUBSTR) {
3460                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
3461                 data->pos_min += 1;
3462                 data->pos_delta += d;
3463                 data->longest = &(data->longest_float);
3464             }
3465         }
3466         else if (strchr((const char*)PL_simple,OP(scan))) {
3467             int value = 0;
3468
3469             if (flags & SCF_DO_SUBSTR) {
3470                 SCAN_COMMIT(pRExC_state,data,minlenp);
3471                 data->pos_min++;
3472             }
3473             min++;
3474             if (flags & SCF_DO_STCLASS) {
3475                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
3476
3477                 /* Some of the logic below assumes that switching
3478                    locale on will only add false positives. */
3479                 switch (PL_regkind[OP(scan)]) {
3480                 case SANY:
3481                 default:
3482                   do_default:
3483                     /* Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan)); */
3484                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3485                         cl_anything(pRExC_state, data->start_class);
3486                     break;
3487                 case REG_ANY:
3488                     if (OP(scan) == SANY)
3489                         goto do_default;
3490                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
3491                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
3492                                  || (data->start_class->flags & ANYOF_CLASS));
3493                         cl_anything(pRExC_state, data->start_class);
3494                     }
3495                     if (flags & SCF_DO_STCLASS_AND || !value)
3496                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
3497                     break;
3498                 case ANYOF:
3499                     if (flags & SCF_DO_STCLASS_AND)
3500                         cl_and(data->start_class,
3501                                (struct regnode_charclass_class*)scan);
3502                     else
3503                         cl_or(pRExC_state, data->start_class,
3504                               (struct regnode_charclass_class*)scan);
3505                     break;
3506                 case ALNUM:
3507                     if (flags & SCF_DO_STCLASS_AND) {
3508                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3509                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
3510                             for (value = 0; value < 256; value++)
3511                                 if (!isALNUM(value))
3512                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3513                         }
3514                     }
3515                     else {
3516                         if (data->start_class->flags & ANYOF_LOCALE)
3517                             ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
3518                         else {
3519                             for (value = 0; value < 256; value++)
3520                                 if (isALNUM(value))
3521                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3522                         }
3523                     }
3524                     break;
3525                 case ALNUML:
3526                     if (flags & SCF_DO_STCLASS_AND) {
3527                         if (data->start_class->flags & ANYOF_LOCALE)
3528                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
3529                     }
3530                     else {
3531                         ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
3532                         data->start_class->flags |= ANYOF_LOCALE;
3533                     }
3534                     break;
3535                 case NALNUM:
3536                     if (flags & SCF_DO_STCLASS_AND) {
3537                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3538                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
3539                             for (value = 0; value < 256; value++)
3540                                 if (isALNUM(value))
3541                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3542                         }
3543                     }
3544                     else {
3545                         if (data->start_class->flags & ANYOF_LOCALE)
3546                             ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
3547                         else {
3548                             for (value = 0; value < 256; value++)
3549                                 if (!isALNUM(value))
3550                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3551                         }
3552                     }
3553                     break;
3554                 case NALNUML:
3555                     if (flags & SCF_DO_STCLASS_AND) {
3556                         if (data->start_class->flags & ANYOF_LOCALE)
3557                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
3558                     }
3559                     else {
3560                         data->start_class->flags |= ANYOF_LOCALE;
3561                         ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
3562                     }
3563                     break;
3564                 case SPACE:
3565                     if (flags & SCF_DO_STCLASS_AND) {
3566                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3567                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
3568                             for (value = 0; value < 256; value++)
3569                                 if (!isSPACE(value))
3570                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3571                         }
3572                     }
3573                     else {
3574                         if (data->start_class->flags & ANYOF_LOCALE)
3575                             ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
3576                         else {
3577                             for (value = 0; value < 256; value++)
3578                                 if (isSPACE(value))
3579                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3580                         }
3581                     }
3582                     break;
3583                 case SPACEL:
3584                     if (flags & SCF_DO_STCLASS_AND) {
3585                         if (data->start_class->flags & ANYOF_LOCALE)
3586                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
3587                     }
3588                     else {
3589                         data->start_class->flags |= ANYOF_LOCALE;
3590                         ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
3591                     }
3592                     break;
3593                 case NSPACE:
3594                     if (flags & SCF_DO_STCLASS_AND) {
3595                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3596                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
3597                             for (value = 0; value < 256; value++)
3598                                 if (isSPACE(value))
3599                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3600                         }
3601                     }
3602                     else {
3603                         if (data->start_class->flags & ANYOF_LOCALE)
3604                             ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
3605                         else {
3606                             for (value = 0; value < 256; value++)
3607                                 if (!isSPACE(value))
3608                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3609                         }
3610                     }
3611                     break;
3612                 case NSPACEL:
3613                     if (flags & SCF_DO_STCLASS_AND) {
3614                         if (data->start_class->flags & ANYOF_LOCALE) {
3615                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
3616                             for (value = 0; value < 256; value++)
3617                                 if (!isSPACE(value))
3618                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3619                         }
3620                     }
3621                     else {
3622                         data->start_class->flags |= ANYOF_LOCALE;
3623                         ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
3624                     }
3625                     break;
3626                 case DIGIT:
3627                     if (flags & SCF_DO_STCLASS_AND) {
3628                         ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NDIGIT);
3629                         for (value = 0; value < 256; value++)
3630                             if (!isDIGIT(value))
3631                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
3632                     }
3633                     else {
3634                         if (data->start_class->flags & ANYOF_LOCALE)
3635                             ANYOF_CLASS_SET(data->start_class,ANYOF_DIGIT);
3636                         else {
3637                             for (value = 0; value < 256; value++)
3638                                 if (isDIGIT(value))
3639                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3640                         }
3641                     }
3642                     break;
3643                 case NDIGIT:
3644                     if (flags & SCF_DO_STCLASS_AND) {
3645                         ANYOF_CLASS_CLEAR(data->start_class,ANYOF_DIGIT);
3646                         for (value = 0; value < 256; value++)
3647                             if (isDIGIT(value))
3648                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
3649                     }
3650                     else {
3651                         if (data->start_class->flags & ANYOF_LOCALE)
3652                             ANYOF_CLASS_SET(data->start_class,ANYOF_NDIGIT);
3653                         else {
3654                             for (value = 0; value < 256; value++)
3655                                 if (!isDIGIT(value))
3656                                     ANYOF_BITMAP_SET(data->start_class, value);                 
3657                         }
3658                     }
3659                     break;
3660                 CASE_SYNST_FNC(VERTWS);
3661                 CASE_SYNST_FNC(HORIZWS);
3662                 
3663                 }
3664                 if (flags & SCF_DO_STCLASS_OR)
3665                     cl_and(data->start_class, and_withp);
3666                 flags &= ~SCF_DO_STCLASS;
3667             }
3668         }
3669         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
3670             data->flags |= (OP(scan) == MEOL
3671                             ? SF_BEFORE_MEOL
3672                             : SF_BEFORE_SEOL);
3673         }
3674         else if (  PL_regkind[OP(scan)] == BRANCHJ
3675                  /* Lookbehind, or need to calculate parens/evals/stclass: */
3676                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
3677                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
3678             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
3679                 || OP(scan) == UNLESSM )
3680             {
3681                 /* Negative Lookahead/lookbehind
3682                    In this case we can't do fixed string optimisation.
3683                 */
3684
3685                 I32 deltanext, minnext, fake = 0;
3686                 regnode *nscan;
3687                 struct regnode_charclass_class intrnl;
3688                 int f = 0;
3689
3690                 data_fake.flags = 0;
3691                 if (data) {
3692                     data_fake.whilem_c = data->whilem_c;
3693                     data_fake.last_closep = data->last_closep;
3694                 }
3695                 else
3696                     data_fake.last_closep = &fake;
3697                 data_fake.pos_delta = delta;
3698                 if ( flags & SCF_DO_STCLASS && !scan->flags
3699                      && OP(scan) == IFMATCH ) { /* Lookahead */
3700                     cl_init(pRExC_state, &intrnl);
3701                     data_fake.start_class = &intrnl;
3702                     f |= SCF_DO_STCLASS_AND;
3703                 }
3704                 if (flags & SCF_WHILEM_VISITED_POS)
3705                     f |= SCF_WHILEM_VISITED_POS;
3706                 next = regnext(scan);
3707                 nscan = NEXTOPER(NEXTOPER(scan));
3708                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
3709                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
3710                 if (scan->flags) {
3711                     if (deltanext) {
3712                         FAIL("Variable length lookbehind not implemented");
3713                     }
3714                     else if (minnext > (I32)U8_MAX) {
3715                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
3716                     }
3717                     scan->flags = (U8)minnext;
3718                 }
3719                 if (data) {
3720                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3721                         pars++;
3722                     if (data_fake.flags & SF_HAS_EVAL)
3723                         data->flags |= SF_HAS_EVAL;
3724                     data->whilem_c = data_fake.whilem_c;
3725                 }
3726                 if (f & SCF_DO_STCLASS_AND) {
3727                     const int was = (data->start_class->flags & ANYOF_EOS);
3728
3729                     cl_and(data->start_class, &intrnl);
3730                     if (was)
3731                         data->start_class->flags |= ANYOF_EOS;
3732                 }
3733             }
3734 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
3735             else {
3736                 /* Positive Lookahead/lookbehind
3737                    In this case we can do fixed string optimisation,
3738                    but we must be careful about it. Note in the case of
3739                    lookbehind the positions will be offset by the minimum
3740                    length of the pattern, something we won't know about
3741                    until after the recurse.
3742                 */
3743                 I32 deltanext, fake = 0;
3744                 regnode *nscan;
3745                 struct regnode_charclass_class intrnl;
3746                 int f = 0;
3747                 /* We use SAVEFREEPV so that when the full compile 
3748                     is finished perl will clean up the allocated 
3749                     minlens when its all done. This was we don't
3750                     have to worry about freeing them when we know
3751                     they wont be used, which would be a pain.
3752                  */
3753                 I32 *minnextp;
3754                 Newx( minnextp, 1, I32 );
3755                 SAVEFREEPV(minnextp);
3756
3757                 if (data) {
3758                     StructCopy(data, &data_fake, scan_data_t);
3759                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
3760                         f |= SCF_DO_SUBSTR;
3761                         if (scan->flags) 
3762                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
3763                         data_fake.last_found=newSVsv(data->last_found);
3764                     }
3765                 }
3766                 else
3767                     data_fake.last_closep = &fake;
3768                 data_fake.flags = 0;
3769                 data_fake.pos_delta = delta;
3770                 if (is_inf)
3771                     data_fake.flags |= SF_IS_INF;
3772                 if ( flags & SCF_DO_STCLASS && !scan->flags
3773                      && OP(scan) == IFMATCH ) { /* Lookahead */
3774                     cl_init(pRExC_state, &intrnl);
3775                     data_fake.start_class = &intrnl;
3776                     f |= SCF_DO_STCLASS_AND;
3777                 }
3778                 if (flags & SCF_WHILEM_VISITED_POS)
3779                     f |= SCF_WHILEM_VISITED_POS;
3780                 next = regnext(scan);
3781                 nscan = NEXTOPER(NEXTOPER(scan));
3782
3783                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
3784                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
3785                 if (scan->flags) {
3786                     if (deltanext) {
3787                         FAIL("Variable length lookbehind not implemented");
3788                     }
3789                     else if (*minnextp > (I32)U8_MAX) {
3790                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
3791                     }
3792                     scan->flags = (U8)*minnextp;
3793                 }
3794
3795                 *minnextp += min;
3796
3797                 if (f & SCF_DO_STCLASS_AND) {
3798                     const int was = (data->start_class->flags & ANYOF_EOS);
3799
3800                     cl_and(data->start_class, &intrnl);
3801                     if (was)
3802                         data->start_class->flags |= ANYOF_EOS;
3803                 }
3804                 if (data) {
3805                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3806                         pars++;
3807                     if (data_fake.flags & SF_HAS_EVAL)
3808                         data->flags |= SF_HAS_EVAL;
3809                     data->whilem_c = data_fake.whilem_c;
3810                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
3811                         if (RExC_rx->minlen<*minnextp)
3812                             RExC_rx->minlen=*minnextp;
3813                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
3814                         SvREFCNT_dec(data_fake.last_found);
3815                         
3816                         if ( data_fake.minlen_fixed != minlenp ) 
3817                         {
3818                             data->offset_fixed= data_fake.offset_fixed;
3819                             data->minlen_fixed= data_fake.minlen_fixed;
3820                             data->lookbehind_fixed+= scan->flags;
3821                         }
3822                         if ( data_fake.minlen_float != minlenp )
3823                         {
3824                             data->minlen_float= data_fake.minlen_float;
3825                             data->offset_float_min=data_fake.offset_float_min;
3826                             data->offset_float_max=data_fake.offset_float_max;
3827                             data->lookbehind_float+= scan->flags;
3828                         }
3829                     }
3830                 }
3831
3832
3833             }
3834 #endif
3835         }
3836         else if (OP(scan) == OPEN) {
3837             if (stopparen != (I32)ARG(scan))
3838                 pars++;
3839         }
3840         else if (OP(scan) == CLOSE) {
3841             if (stopparen == (I32)ARG(scan)) {
3842                 break;
3843             }
3844             if ((I32)ARG(scan) == is_par) {
3845                 next = regnext(scan);
3846
3847                 if ( next && (OP(next) != WHILEM) && next < last)
3848                     is_par = 0;         /* Disable optimization */
3849             }
3850             if (data)
3851                 *(data->last_closep) = ARG(scan);
3852         }
3853         else if (OP(scan) == EVAL) {
3854                 if (data)
3855                     data->flags |= SF_HAS_EVAL;
3856         }
3857         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
3858             if (flags & SCF_DO_SUBSTR) {
3859                 SCAN_COMMIT(pRExC_state,data,minlenp);
3860                 flags &= ~SCF_DO_SUBSTR;
3861             }
3862             if (data && OP(scan)==ACCEPT) {
3863                 data->flags |= SCF_SEEN_ACCEPT;
3864                 if (stopmin > min)
3865                     stopmin = min;
3866             }
3867         }
3868         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
3869         {
3870                 if (flags & SCF_DO_SUBSTR) {
3871                     SCAN_COMMIT(pRExC_state,data,minlenp);
3872                     data->longest = &(data->longest_float);
3873                 }
3874                 is_inf = is_inf_internal = 1;
3875                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3876                     cl_anything(pRExC_state, data->start_class);
3877                 flags &= ~SCF_DO_STCLASS;
3878         }
3879         else if (OP(scan) == GPOS) {
3880             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
3881                 !(delta || is_inf || (data && data->pos_delta))) 
3882             {
3883                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
3884                     RExC_rx->extflags |= RXf_ANCH_GPOS;
3885                 if (RExC_rx->gofs < (U32)min)
3886                     RExC_rx->gofs = min;
3887             } else {
3888                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
3889                 RExC_rx->gofs = 0;
3890             }       
3891         }
3892 #ifdef TRIE_STUDY_OPT
3893 #ifdef FULL_TRIE_STUDY
3894         else if (PL_regkind[OP(scan)] == TRIE) {
3895             /* NOTE - There is similar code to this block above for handling
3896                BRANCH nodes on the initial study.  If you change stuff here
3897                check there too. */
3898             regnode *trie_node= scan;
3899             regnode *tail= regnext(scan);
3900             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
3901             I32 max1 = 0, min1 = I32_MAX;
3902             struct regnode_charclass_class accum;
3903
3904             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
3905                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
3906             if (flags & SCF_DO_STCLASS)
3907                 cl_init_zero(pRExC_state, &accum);
3908                 
3909             if (!trie->jump) {
3910                 min1= trie->minlen;
3911                 max1= trie->maxlen;
3912             } else {
3913                 const regnode *nextbranch= NULL;
3914                 U32 word;
3915                 
3916                 for ( word=1 ; word <= trie->wordcount ; word++) 
3917                 {
3918                     I32 deltanext=0, minnext=0, f = 0, fake;
3919                     struct regnode_charclass_class this_class;
3920                     
3921                     data_fake.flags = 0;
3922                     if (data) {
3923                         data_fake.whilem_c = data->whilem_c;
3924                         data_fake.last_closep = data->last_closep;
3925                     }
3926                     else
3927                         data_fake.last_closep = &fake;
3928                     data_fake.pos_delta = delta;
3929                     if (flags & SCF_DO_STCLASS) {
3930                         cl_init(pRExC_state, &this_class);
3931                         data_fake.start_class = &this_class;
3932                         f = SCF_DO_STCLASS_AND;
3933                     }
3934                     if (flags & SCF_WHILEM_VISITED_POS)
3935                         f |= SCF_WHILEM_VISITED_POS;
3936     
3937                     if (trie->jump[word]) {
3938                         if (!nextbranch)
3939                             nextbranch = trie_node + trie->jump[0];
3940                         scan= trie_node + trie->jump[word];
3941                         /* We go from the jump point to the branch that follows
3942                            it. Note this means we need the vestigal unused branches
3943                            even though they arent otherwise used.
3944                          */
3945                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
3946                             &deltanext, (regnode *)nextbranch, &data_fake, 
3947                             stopparen, recursed, NULL, f,depth+1);
3948                     }
3949                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
3950                         nextbranch= regnext((regnode*)nextbranch);
3951                     
3952                     if (min1 > (I32)(minnext + trie->minlen))
3953                         min1 = minnext + trie->minlen;
3954                     if (max1 < (I32)(minnext + deltanext + trie->maxlen))
3955                         max1 = minnext + deltanext + trie->maxlen;
3956                     if (deltanext == I32_MAX)
3957                         is_inf = is_inf_internal = 1;
3958                     
3959                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
3960                         pars++;
3961                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
3962                         if ( stopmin > min + min1) 
3963                             stopmin = min + min1;
3964                         flags &= ~SCF_DO_SUBSTR;
3965                         if (data)
3966                             data->flags |= SCF_SEEN_ACCEPT;
3967                     }
3968                     if (data) {
3969                         if (data_fake.flags & SF_HAS_EVAL)
3970                             data->flags |= SF_HAS_EVAL;
3971                         data->whilem_c = data_fake.whilem_c;
3972                     }
3973                     if (flags & SCF_DO_STCLASS)
3974                         cl_or(pRExC_state, &accum, &this_class);
3975                 }
3976             }
3977             if (flags & SCF_DO_SUBSTR) {
3978                 data->pos_min += min1;
3979                 data->pos_delta += max1 - min1;
3980                 if (max1 != min1 || is_inf)
3981                     data->longest = &(data->longest_float);
3982             }
3983             min += min1;
3984             delta += max1 - min1;
3985             if (flags & SCF_DO_STCLASS_OR) {
3986                 cl_or(pRExC_state, data->start_class, &accum);
3987                 if (min1) {
3988                     cl_and(data->start_class, and_withp);
3989                     flags &= ~SCF_DO_STCLASS;
3990                 }
3991             }
3992             else if (flags & SCF_DO_STCLASS_AND) {
3993                 if (min1) {
3994                     cl_and(data->start_class, &accum);
3995                     flags &= ~SCF_DO_STCLASS;
3996                 }
3997                 else {
3998                     /* Switch to OR mode: cache the old value of
3999                      * data->start_class */
4000                     INIT_AND_WITHP;
4001                     StructCopy(data->start_class, and_withp,
4002                                struct regnode_charclass_class);
4003                     flags &= ~SCF_DO_STCLASS_AND;
4004                     StructCopy(&accum, data->start_class,
4005                                struct regnode_charclass_class);
4006                     flags |= SCF_DO_STCLASS_OR;
4007                     data->start_class->flags |= ANYOF_EOS;
4008                 }
4009             }
4010             scan= tail;
4011             continue;
4012         }
4013 #else
4014         else if (PL_regkind[OP(scan)] == TRIE) {
4015             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4016             U8*bang=NULL;
4017             
4018             min += trie->minlen;
4019             delta += (trie->maxlen - trie->minlen);
4020             flags &= ~SCF_DO_STCLASS; /* xxx */
4021             if (flags & SCF_DO_SUBSTR) {
4022                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4023                 data->pos_min += trie->minlen;
4024                 data->pos_delta += (trie->maxlen - trie->minlen);
4025                 if (trie->maxlen != trie->minlen)
4026                     data->longest = &(data->longest_float);
4027             }
4028             if (trie->jump) /* no more substrings -- for now /grr*/
4029                 flags &= ~SCF_DO_SUBSTR; 
4030         }
4031 #endif /* old or new */
4032 #endif /* TRIE_STUDY_OPT */     
4033
4034         /* Else: zero-length, ignore. */
4035         scan = regnext(scan);
4036     }
4037     if (frame) {
4038         last = frame->last;
4039         scan = frame->next;
4040         stopparen = frame->stop;
4041         frame = frame->prev;
4042         goto fake_study_recurse;
4043     }
4044
4045   finish:
4046     assert(!frame);
4047     DEBUG_STUDYDATA("pre-fin:",data,depth);
4048
4049     *scanp = scan;
4050     *deltap = is_inf_internal ? I32_MAX : delta;
4051     if (flags & SCF_DO_SUBSTR && is_inf)
4052         data->pos_delta = I32_MAX - data->pos_min;
4053     if (is_par > (I32)U8_MAX)
4054         is_par = 0;
4055     if (is_par && pars==1 && data) {
4056         data->flags |= SF_IN_PAR;
4057         data->flags &= ~SF_HAS_PAR;
4058     }
4059     else if (pars && data) {
4060         data->flags |= SF_HAS_PAR;
4061         data->flags &= ~SF_IN_PAR;
4062     }
4063     if (flags & SCF_DO_STCLASS_OR)
4064         cl_and(data->start_class, and_withp);
4065     if (flags & SCF_TRIE_RESTUDY)
4066         data->flags |=  SCF_TRIE_RESTUDY;
4067     
4068     DEBUG_STUDYDATA("post-fin:",data,depth);
4069     
4070     return min < stopmin ? min : stopmin;
4071 }
4072
4073 STATIC U32
4074 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4075 {
4076     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4077
4078     PERL_ARGS_ASSERT_ADD_DATA;
4079
4080     Renewc(RExC_rxi->data,
4081            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4082            char, struct reg_data);
4083     if(count)
4084         Renew(RExC_rxi->data->what, count + n, U8);
4085     else
4086         Newx(RExC_rxi->data->what, n, U8);
4087     RExC_rxi->data->count = count + n;
4088     Copy(s, RExC_rxi->data->what + count, n, U8);
4089     return count;
4090 }
4091
4092 /*XXX: todo make this not included in a non debugging perl */
4093 #ifndef PERL_IN_XSUB_RE
4094 void
4095 Perl_reginitcolors(pTHX)
4096 {
4097     dVAR;
4098     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4099     if (s) {
4100         char *t = savepv(s);
4101         int i = 0;
4102         PL_colors[0] = t;
4103         while (++i < 6) {
4104             t = strchr(t, '\t');
4105             if (t) {
4106                 *t = '\0';
4107                 PL_colors[i] = ++t;
4108             }
4109             else
4110                 PL_colors[i] = t = (char *)"";
4111         }
4112     } else {
4113         int i = 0;
4114         while (i < 6)
4115             PL_colors[i++] = (char *)"";
4116     }
4117     PL_colorset = 1;
4118 }
4119 #endif
4120
4121
4122 #ifdef TRIE_STUDY_OPT
4123 #define CHECK_RESTUDY_GOTO                                  \
4124         if (                                                \
4125               (data.flags & SCF_TRIE_RESTUDY)               \
4126               && ! restudied++                              \
4127         )     goto reStudy
4128 #else
4129 #define CHECK_RESTUDY_GOTO
4130 #endif        
4131
4132 /*
4133  - pregcomp - compile a regular expression into internal code
4134  *
4135  * We can't allocate space until we know how big the compiled form will be,
4136  * but we can't compile it (and thus know how big it is) until we've got a
4137  * place to put the code.  So we cheat:  we compile it twice, once with code
4138  * generation turned off and size counting turned on, and once "for real".
4139  * This also means that we don't allocate space until we are sure that the
4140  * thing really will compile successfully, and we never have to move the
4141  * code and thus invalidate pointers into it.  (Note that it has to be in
4142  * one piece because free() must be able to free it all.) [NB: not true in perl]
4143  *
4144  * Beware that the optimization-preparation code in here knows about some
4145  * of the structure of the compiled regexp.  [I'll say.]
4146  */
4147
4148
4149
4150 #ifndef PERL_IN_XSUB_RE
4151 #define RE_ENGINE_PTR &PL_core_reg_engine
4152 #else
4153 extern const struct regexp_engine my_reg_engine;
4154 #define RE_ENGINE_PTR &my_reg_engine
4155 #endif
4156
4157 #ifndef PERL_IN_XSUB_RE 
4158 REGEXP *
4159 Perl_pregcomp(pTHX_ const SV * const pattern, const U32 flags)
4160 {
4161     dVAR;
4162     HV * const table = GvHV(PL_hintgv);
4163
4164     PERL_ARGS_ASSERT_PREGCOMP;
4165
4166     /* Dispatch a request to compile a regexp to correct 
4167        regexp engine. */
4168     if (table) {
4169         SV **ptr= hv_fetchs(table, "regcomp", FALSE);
4170         GET_RE_DEBUG_FLAGS_DECL;
4171         if (ptr && SvIOK(*ptr) && SvIV(*ptr)) {
4172             const regexp_engine *eng=INT2PTR(regexp_engine*,SvIV(*ptr));
4173             DEBUG_COMPILE_r({
4174                 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4175                     SvIV(*ptr));
4176             });            
4177             return CALLREGCOMP_ENG(eng, pattern, flags);
4178         } 
4179     }
4180     return Perl_re_compile(aTHX_ pattern, flags);
4181 }
4182 #endif
4183
4184 REGEXP *
4185 Perl_re_compile(pTHX_ const SV * const pattern, U32 pm_flags)
4186 {
4187     dVAR;
4188     REGEXP *rx;
4189     struct regexp *r;
4190     register regexp_internal *ri;
4191     STRLEN plen;
4192     char*  exp = SvPV((SV*)pattern, plen);
4193     char* xend = exp + plen;
4194     regnode *scan;
4195     I32 flags;
4196     I32 minlen = 0;
4197     I32 sawplus = 0;
4198     I32 sawopen = 0;
4199     scan_data_t data;
4200     RExC_state_t RExC_state;
4201     RExC_state_t * const pRExC_state = &RExC_state;
4202 #ifdef TRIE_STUDY_OPT    
4203     int restudied= 0;
4204     RExC_state_t copyRExC_state;
4205 #endif    
4206     GET_RE_DEBUG_FLAGS_DECL;
4207
4208     PERL_ARGS_ASSERT_RE_COMPILE;
4209
4210     DEBUG_r(if (!PL_colorset) reginitcolors());
4211
4212     RExC_utf8 = RExC_orig_utf8 = SvUTF8(pattern);
4213
4214     DEBUG_COMPILE_r({
4215         SV *dsv= sv_newmortal();
4216         RE_PV_QUOTED_DECL(s, RExC_utf8,
4217             dsv, exp, plen, 60);
4218         PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
4219                        PL_colors[4],PL_colors[5],s);
4220     });
4221
4222 redo_first_pass:
4223     RExC_precomp = exp;
4224     RExC_flags = pm_flags;
4225     RExC_sawback = 0;
4226
4227     RExC_seen = 0;
4228     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
4229     RExC_seen_evals = 0;
4230     RExC_extralen = 0;
4231
4232     /* First pass: determine size, legality. */
4233     RExC_parse = exp;
4234     RExC_start = exp;
4235     RExC_end = xend;
4236     RExC_naughty = 0;
4237     RExC_npar = 1;
4238     RExC_nestroot = 0;
4239     RExC_size = 0L;
4240     RExC_emit = &PL_regdummy;
4241     RExC_whilem_seen = 0;
4242     RExC_charnames = NULL;
4243     RExC_open_parens = NULL;
4244     RExC_close_parens = NULL;
4245     RExC_opend = NULL;
4246     RExC_paren_names = NULL;
4247 #ifdef DEBUGGING
4248     RExC_paren_name_list = NULL;
4249 #endif
4250     RExC_recurse = NULL;
4251     RExC_recurse_count = 0;
4252
4253 #if 0 /* REGC() is (currently) a NOP at the first pass.
4254        * Clever compilers notice this and complain. --jhi */
4255     REGC((U8)REG_MAGIC, (char*)RExC_emit);
4256 #endif
4257     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n"));
4258     if (reg(pRExC_state, 0, &flags,1) == NULL) {
4259         RExC_precomp = NULL;
4260         return(NULL);
4261     }
4262     if (RExC_utf8 && !RExC_orig_utf8) {
4263         /* It's possible to write a regexp in ascii that represents Unicode
4264         codepoints outside of the byte range, such as via \x{100}. If we
4265         detect such a sequence we have to convert the entire pattern to utf8
4266         and then recompile, as our sizing calculation will have been based
4267         on 1 byte == 1 character, but we will need to use utf8 to encode
4268         at least some part of the pattern, and therefore must convert the whole
4269         thing.
4270         XXX: somehow figure out how to make this less expensive...
4271         -- dmq */
4272         STRLEN len = plen;
4273         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
4274             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
4275         exp = (char*)Perl_bytes_to_utf8(aTHX_ (U8*)exp, &len);
4276         xend = exp + len;
4277         RExC_orig_utf8 = RExC_utf8;
4278         SAVEFREEPV(exp);
4279         goto redo_first_pass;
4280     }
4281     DEBUG_PARSE_r({
4282         PerlIO_printf(Perl_debug_log, 
4283             "Required size %"IVdf" nodes\n"
4284             "Starting second pass (creation)\n", 
4285             (IV)RExC_size);
4286         RExC_lastnum=0; 
4287         RExC_lastparse=NULL; 
4288     });
4289     /* Small enough for pointer-storage convention?
4290        If extralen==0, this means that we will not need long jumps. */
4291     if (RExC_size >= 0x10000L && RExC_extralen)
4292         RExC_size += RExC_extralen;
4293     else
4294         RExC_extralen = 0;
4295     if (RExC_whilem_seen > 15)
4296         RExC_whilem_seen = 15;
4297
4298     /* Allocate space and zero-initialize. Note, the two step process 
4299        of zeroing when in debug mode, thus anything assigned has to 
4300        happen after that */
4301     rx = (REGEXP*) newSV_type(SVt_REGEXP);
4302     r = (struct regexp*)SvANY(rx);
4303     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
4304          char, regexp_internal);
4305     if ( r == NULL || ri == NULL )
4306         FAIL("Regexp out of space");
4307 #ifdef DEBUGGING
4308     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
4309     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
4310 #else 
4311     /* bulk initialize base fields with 0. */
4312     Zero(ri, sizeof(regexp_internal), char);        
4313 #endif
4314
4315     /* non-zero initialization begins here */
4316     RXi_SET( r, ri );
4317     r->engine= RE_ENGINE_PTR;
4318     r->extflags = pm_flags;
4319     {
4320         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
4321         bool has_minus = ((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD);
4322         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
4323         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
4324                             >> RXf_PMf_STD_PMMOD_SHIFT);
4325         const char *fptr = STD_PAT_MODS;        /*"msix"*/
4326         char *p;
4327         const STRLEN wraplen = plen + has_minus + has_p + has_runon
4328             + (sizeof(STD_PAT_MODS) - 1)
4329             + (sizeof("(?:)") - 1);
4330
4331         p = sv_grow((SV *)rx, wraplen + 1);
4332         SvCUR_set(rx, wraplen);
4333         SvPOK_on(rx);
4334         SvFLAGS(rx) |= SvUTF8(pattern);
4335         *p++='('; *p++='?';
4336         if (has_p)
4337             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
4338         {
4339             char *r = p + (sizeof(STD_PAT_MODS) - 1) + has_minus - 1;
4340             char *colon = r + 1;
4341             char ch;
4342
4343             while((ch = *fptr++)) {
4344                 if(reganch & 1)
4345                     *p++ = ch;
4346                 else
4347                     *r-- = ch;
4348                 reganch >>= 1;
4349             }
4350             if(has_minus) {
4351                 *r = '-';
4352                 p = colon;
4353             }
4354         }
4355
4356         *p++ = ':';
4357         Copy(RExC_precomp, p, plen, char);
4358         assert ((RX_WRAPPED(rx) - p) < 16);
4359         r->pre_prefix = p - RX_WRAPPED(rx);
4360         p += plen;
4361         if (has_runon)
4362             *p++ = '\n';
4363         *p++ = ')';
4364         *p = 0;
4365     }
4366
4367     r->intflags = 0;
4368     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
4369     
4370     if (RExC_seen & REG_SEEN_RECURSE) {
4371         Newxz(RExC_open_parens, RExC_npar,regnode *);
4372         SAVEFREEPV(RExC_open_parens);
4373         Newxz(RExC_close_parens,RExC_npar,regnode *);
4374         SAVEFREEPV(RExC_close_parens);
4375     }
4376
4377     /* Useful during FAIL. */
4378 #ifdef RE_TRACK_PATTERN_OFFSETS
4379     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
4380     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
4381                           "%s %"UVuf" bytes for offset annotations.\n",
4382                           ri->u.offsets ? "Got" : "Couldn't get",
4383                           (UV)((2*RExC_size+1) * sizeof(U32))));
4384 #endif
4385     SetProgLen(ri,RExC_size);
4386     RExC_rx_sv = rx;
4387     RExC_rx = r;
4388     RExC_rxi = ri;
4389
4390     /* Second pass: emit code. */
4391     RExC_flags = pm_flags;      /* don't let top level (?i) bleed */
4392     RExC_parse = exp;
4393     RExC_end = xend;
4394     RExC_naughty = 0;
4395     RExC_npar = 1;
4396     RExC_emit_start = ri->program;
4397     RExC_emit = ri->program;
4398     RExC_emit_bound = ri->program + RExC_size + 1;
4399
4400     /* Store the count of eval-groups for security checks: */
4401     RExC_rx->seen_evals = RExC_seen_evals;
4402     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
4403     if (reg(pRExC_state, 0, &flags,1) == NULL) {
4404         ReREFCNT_dec(rx);   
4405         return(NULL);
4406     }
4407     /* XXXX To minimize changes to RE engine we always allocate
4408        3-units-long substrs field. */
4409     Newx(r->substrs, 1, struct reg_substr_data);
4410     if (RExC_recurse_count) {
4411         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
4412         SAVEFREEPV(RExC_recurse);
4413     }
4414
4415 reStudy:
4416     r->minlen = minlen = sawplus = sawopen = 0;
4417     Zero(r->substrs, 1, struct reg_substr_data);
4418
4419 #ifdef TRIE_STUDY_OPT
4420     if ( restudied ) {
4421         U32 seen=RExC_seen;
4422         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
4423         
4424         RExC_state = copyRExC_state;
4425         if (seen & REG_TOP_LEVEL_BRANCHES) 
4426             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
4427         else
4428             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
4429         if (data.last_found) {
4430             SvREFCNT_dec(data.longest_fixed);
4431             SvREFCNT_dec(data.longest_float);
4432             SvREFCNT_dec(data.last_found);
4433         }
4434         StructCopy(&zero_scan_data, &data, scan_data_t);
4435     } else {
4436         StructCopy(&zero_scan_data, &data, scan_data_t);
4437         copyRExC_state = RExC_state;
4438     }
4439 #else
4440     StructCopy(&zero_scan_data, &data, scan_data_t);
4441 #endif    
4442
4443     /* Dig out information for optimizations. */
4444     r->extflags = RExC_flags; /* was pm_op */
4445     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
4446  
4447     if (UTF)
4448         SvUTF8_on(rx);  /* Unicode in it? */
4449     ri->regstclass = NULL;
4450     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
4451         r->intflags |= PREGf_NAUGHTY;
4452     scan = ri->program + 1;             /* First BRANCH. */
4453
4454     /* testing for BRANCH here tells us whether there is "must appear"
4455        data in the pattern. If there is then we can use it for optimisations */
4456     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
4457         I32 fake;
4458         STRLEN longest_float_length, longest_fixed_length;
4459         struct regnode_charclass_class ch_class; /* pointed to by data */
4460         int stclass_flag;
4461         I32 last_close = 0; /* pointed to by data */
4462         regnode *first= scan;
4463         regnode *first_next= regnext(first);
4464         
4465         /* Skip introductions and multiplicators >= 1. */
4466         while ((OP(first) == OPEN && (sawopen = 1)) ||
4467                /* An OR of *one* alternative - should not happen now. */
4468             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
4469             /* for now we can't handle lookbehind IFMATCH*/
4470             (OP(first) == IFMATCH && !first->flags) || 
4471             (OP(first) == PLUS) ||
4472             (OP(first) == MINMOD) ||
4473                /* An {n,m} with n>0 */
4474             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
4475             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
4476         {
4477                 
4478                 if (OP(first) == PLUS)
4479                     sawplus = 1;
4480                 else
4481                     first += regarglen[OP(first)];
4482                 if (OP(first) == IFMATCH) {
4483                     first = NEXTOPER(first);
4484                     first += EXTRA_STEP_2ARGS;
4485                 } else  /* XXX possible optimisation for /(?=)/  */
4486                     first = NEXTOPER(first);
4487                 first_next= regnext(first);
4488         }
4489
4490         /* Starting-point info. */
4491       again:
4492         DEBUG_PEEP("first:",first,0);
4493         /* Ignore EXACT as we deal with it later. */
4494         if (PL_regkind[OP(first)] == EXACT) {
4495             if (OP(first) == EXACT)
4496                 NOOP;   /* Empty, get anchored substr later. */
4497             else if ((OP(first) == EXACTF || OP(first) == EXACTFL))
4498                 ri->regstclass = first;
4499         }
4500 #ifdef TRIE_STCLASS     
4501         else if (PL_regkind[OP(first)] == TRIE &&
4502                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
4503         {
4504             regnode *trie_op;
4505             /* this can happen only on restudy */
4506             if ( OP(first) == TRIE ) {
4507                 struct regnode_1 *trieop = (struct regnode_1 *)
4508                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
4509                 StructCopy(first,trieop,struct regnode_1);
4510                 trie_op=(regnode *)trieop;
4511             } else {
4512                 struct regnode_charclass *trieop = (struct regnode_charclass *)
4513                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
4514                 StructCopy(first,trieop,struct regnode_charclass);
4515                 trie_op=(regnode *)trieop;
4516             }
4517             OP(trie_op)+=2;
4518             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
4519             ri->regstclass = trie_op;
4520         }
4521 #endif  
4522         else if (strchr((const char*)PL_simple,OP(first)))
4523             ri->regstclass = first;
4524         else if (PL_regkind[OP(first)] == BOUND ||
4525                  PL_regkind[OP(first)] == NBOUND)
4526             ri->regstclass = first;
4527         else if (PL_regkind[OP(first)] == BOL) {
4528             r->extflags |= (OP(first) == MBOL
4529                            ? RXf_ANCH_MBOL
4530                            : (OP(first) == SBOL
4531                               ? RXf_ANCH_SBOL
4532                               : RXf_ANCH_BOL));
4533             first = NEXTOPER(first);
4534             goto again;
4535         }
4536         else if (OP(first) == GPOS) {
4537             r->extflags |= RXf_ANCH_GPOS;
4538             first = NEXTOPER(first);
4539             goto again;
4540         }
4541         else if ((!sawopen || !RExC_sawback) &&
4542             (OP(first) == STAR &&
4543             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
4544             !(r->extflags & RXf_ANCH) && !(RExC_seen & REG_SEEN_EVAL))
4545         {
4546             /* turn .* into ^.* with an implied $*=1 */
4547             const int type =
4548                 (OP(NEXTOPER(first)) == REG_ANY)
4549                     ? RXf_ANCH_MBOL
4550                     : RXf_ANCH_SBOL;
4551             r->extflags |= type;
4552             r->intflags |= PREGf_IMPLICIT;
4553             first = NEXTOPER(first);
4554             goto again;
4555         }
4556         if (sawplus && (!sawopen || !RExC_sawback)
4557             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
4558             /* x+ must match at the 1st pos of run of x's */
4559             r->intflags |= PREGf_SKIP;
4560
4561         /* Scan is after the zeroth branch, first is atomic matcher. */
4562 #ifdef TRIE_STUDY_OPT
4563         DEBUG_PARSE_r(
4564             if (!restudied)
4565                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4566                               (IV)(first - scan + 1))
4567         );
4568 #else
4569         DEBUG_PARSE_r(
4570             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4571                 (IV)(first - scan + 1))
4572         );
4573 #endif
4574
4575
4576         /*
4577         * If there's something expensive in the r.e., find the
4578         * longest literal string that must appear and make it the
4579         * regmust.  Resolve ties in favor of later strings, since
4580         * the regstart check works with the beginning of the r.e.
4581         * and avoiding duplication strengthens checking.  Not a
4582         * strong reason, but sufficient in the absence of others.
4583         * [Now we resolve ties in favor of the earlier string if
4584         * it happens that c_offset_min has been invalidated, since the
4585         * earlier string may buy us something the later one won't.]
4586         */
4587         
4588         data.longest_fixed = newSVpvs("");
4589         data.longest_float = newSVpvs("");
4590         data.last_found = newSVpvs("");
4591         data.longest = &(data.longest_fixed);
4592         first = scan;
4593         if (!ri->regstclass) {
4594             cl_init(pRExC_state, &ch_class);
4595             data.start_class = &ch_class;
4596             stclass_flag = SCF_DO_STCLASS_AND;
4597         } else                          /* XXXX Check for BOUND? */
4598             stclass_flag = 0;
4599         data.last_closep = &last_close;
4600         
4601         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
4602             &data, -1, NULL, NULL,
4603             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
4604
4605         
4606         CHECK_RESTUDY_GOTO;
4607
4608
4609         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
4610              && data.last_start_min == 0 && data.last_end > 0
4611              && !RExC_seen_zerolen
4612              && !(RExC_seen & REG_SEEN_VERBARG)
4613              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
4614             r->extflags |= RXf_CHECK_ALL;
4615         scan_commit(pRExC_state, &data,&minlen,0);
4616         SvREFCNT_dec(data.last_found);
4617
4618         /* Note that code very similar to this but for anchored string 
4619            follows immediately below, changes may need to be made to both. 
4620            Be careful. 
4621          */
4622         longest_float_length = CHR_SVLEN(data.longest_float);
4623         if (longest_float_length
4624             || (data.flags & SF_FL_BEFORE_EOL
4625                 && (!(data.flags & SF_FL_BEFORE_MEOL)
4626                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
4627         {
4628             I32 t,ml;
4629
4630             if (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
4631                 && data.offset_fixed == data.offset_float_min
4632                 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float))
4633                     goto remove_float;          /* As in (a)+. */
4634
4635             /* copy the information about the longest float from the reg_scan_data
4636                over to the program. */
4637             if (SvUTF8(data.longest_float)) {
4638                 r->float_utf8 = data.longest_float;
4639                 r->float_substr = NULL;
4640             } else {
4641                 r->float_substr = data.longest_float;
4642                 r->float_utf8 = NULL;
4643             }
4644             /* float_end_shift is how many chars that must be matched that 
4645                follow this item. We calculate it ahead of time as once the
4646                lookbehind offset is added in we lose the ability to correctly
4647                calculate it.*/
4648             ml = data.minlen_float ? *(data.minlen_float) 
4649                                    : (I32)longest_float_length;
4650             r->float_end_shift = ml - data.offset_float_min
4651                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
4652                 + data.lookbehind_float;
4653             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
4654             r->float_max_offset = data.offset_float_max;
4655             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
4656                 r->float_max_offset -= data.lookbehind_float;
4657             
4658             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
4659                        && (!(data.flags & SF_FL_BEFORE_MEOL)
4660                            || (RExC_flags & RXf_PMf_MULTILINE)));
4661             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
4662         }
4663         else {
4664           remove_float:
4665             r->float_substr = r->float_utf8 = NULL;
4666             SvREFCNT_dec(data.longest_float);
4667             longest_float_length = 0;
4668         }
4669
4670         /* Note that code very similar to this but for floating string 
4671            is immediately above, changes may need to be made to both. 
4672            Be careful. 
4673          */
4674         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
4675         if (longest_fixed_length
4676             || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
4677                 && (!(data.flags & SF_FIX_BEFORE_MEOL)
4678                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
4679         {
4680             I32 t,ml;
4681
4682             /* copy the information about the longest fixed 
4683                from the reg_scan_data over to the program. */
4684             if (SvUTF8(data.longest_fixed)) {
4685                 r->anchored_utf8 = data.longest_fixed;
4686                 r->anchored_substr = NULL;
4687             } else {
4688                 r->anchored_substr = data.longest_fixed;
4689                 r->anchored_utf8 = NULL;
4690             }
4691             /* fixed_end_shift is how many chars that must be matched that 
4692                follow this item. We calculate it ahead of time as once the
4693                lookbehind offset is added in we lose the ability to correctly
4694                calculate it.*/
4695             ml = data.minlen_fixed ? *(data.minlen_fixed) 
4696                                    : (I32)longest_fixed_length;
4697             r->anchored_end_shift = ml - data.offset_fixed
4698                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
4699                 + data.lookbehind_fixed;
4700             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
4701
4702             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
4703                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
4704                      || (RExC_flags & RXf_PMf_MULTILINE)));
4705             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
4706         }
4707         else {
4708             r->anchored_substr = r->anchored_utf8 = NULL;
4709             SvREFCNT_dec(data.longest_fixed);
4710             longest_fixed_length = 0;
4711         }
4712         if (ri->regstclass
4713             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
4714             ri->regstclass = NULL;
4715         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
4716             && stclass_flag
4717             && !(data.start_class->flags & ANYOF_EOS)
4718             && !cl_is_anything(data.start_class))
4719         {
4720             const U32 n = add_data(pRExC_state, 1, "f");
4721
4722             Newx(RExC_rxi->data->data[n], 1,
4723                 struct regnode_charclass_class);
4724             StructCopy(data.start_class,
4725                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
4726                        struct regnode_charclass_class);
4727             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
4728             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
4729             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
4730                       regprop(r, sv, (regnode*)data.start_class);
4731                       PerlIO_printf(Perl_debug_log,
4732                                     "synthetic stclass \"%s\".\n",
4733                                     SvPVX_const(sv));});
4734         }
4735
4736         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
4737         if (longest_fixed_length > longest_float_length) {
4738             r->check_end_shift = r->anchored_end_shift;
4739             r->check_substr = r->anchored_substr;
4740             r->check_utf8 = r->anchored_utf8;
4741             r->check_offset_min = r->check_offset_max = r->anchored_offset;
4742             if (r->extflags & RXf_ANCH_SINGLE)
4743                 r->extflags |= RXf_NOSCAN;
4744         }
4745         else {
4746             r->check_end_shift = r->float_end_shift;
4747             r->check_substr = r->float_substr;
4748             r->check_utf8 = r->float_utf8;
4749             r->check_offset_min = r->float_min_offset;
4750             r->check_offset_max = r->float_max_offset;
4751         }
4752         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
4753            This should be changed ASAP!  */
4754         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
4755             r->extflags |= RXf_USE_INTUIT;
4756             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
4757                 r->extflags |= RXf_INTUIT_TAIL;
4758         }
4759         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
4760         if ( (STRLEN)minlen < longest_float_length )
4761             minlen= longest_float_length;
4762         if ( (STRLEN)minlen < longest_fixed_length )
4763             minlen= longest_fixed_length;     
4764         */
4765     }
4766     else {
4767         /* Several toplevels. Best we can is to set minlen. */
4768         I32 fake;
4769         struct regnode_charclass_class ch_class;
4770         I32 last_close = 0;
4771         
4772         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
4773
4774         scan = ri->program + 1;
4775         cl_init(pRExC_state, &ch_class);
4776         data.start_class = &ch_class;
4777         data.last_closep = &last_close;
4778
4779         
4780         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
4781             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
4782         
4783         CHECK_RESTUDY_GOTO;
4784
4785         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
4786                 = r->float_substr = r->float_utf8 = NULL;
4787         if (!(data.start_class->flags & ANYOF_EOS)
4788             && !cl_is_anything(data.start_class))
4789         {
4790             const U32 n = add_data(pRExC_state, 1, "f");
4791
4792             Newx(RExC_rxi->data->data[n], 1,
4793                 struct regnode_charclass_class);
4794             StructCopy(data.start_class,
4795                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
4796                        struct regnode_charclass_class);
4797             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
4798             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
4799             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
4800                       regprop(r, sv, (regnode*)data.start_class);
4801                       PerlIO_printf(Perl_debug_log,
4802                                     "synthetic stclass \"%s\".\n",
4803                                     SvPVX_const(sv));});
4804         }
4805     }
4806
4807     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
4808        the "real" pattern. */
4809     DEBUG_OPTIMISE_r({
4810         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
4811                       (IV)minlen, (IV)r->minlen);
4812     });
4813     r->minlenret = minlen;
4814     if (r->minlen < minlen) 
4815         r->minlen = minlen;
4816     
4817     if (RExC_seen & REG_SEEN_GPOS)
4818         r->extflags |= RXf_GPOS_SEEN;
4819     if (RExC_seen & REG_SEEN_LOOKBEHIND)
4820         r->extflags |= RXf_LOOKBEHIND_SEEN;
4821     if (RExC_seen & REG_SEEN_EVAL)
4822         r->extflags |= RXf_EVAL_SEEN;
4823     if (RExC_seen & REG_SEEN_CANY)
4824         r->extflags |= RXf_CANY_SEEN;
4825     if (RExC_seen & REG_SEEN_VERBARG)
4826         r->intflags |= PREGf_VERBARG_SEEN;
4827     if (RExC_seen & REG_SEEN_CUTGROUP)
4828         r->intflags |= PREGf_CUTGROUP_SEEN;
4829     if (RExC_paren_names)
4830         RXp_PAREN_NAMES(r) = (HV*)SvREFCNT_inc(RExC_paren_names);
4831     else
4832         RXp_PAREN_NAMES(r) = NULL;
4833
4834 #ifdef STUPID_PATTERN_CHECKS            
4835     if (RX_PRELEN(rx) == 0)
4836         r->extflags |= RXf_NULL;
4837     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
4838         /* XXX: this should happen BEFORE we compile */
4839         r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
4840     else if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
4841         r->extflags |= RXf_WHITE;
4842     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
4843         r->extflags |= RXf_START_ONLY;
4844 #else
4845     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
4846             /* XXX: this should happen BEFORE we compile */
4847             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
4848     else {
4849         regnode *first = ri->program + 1;
4850         U8 fop = OP(first);
4851         U8 nop = OP(NEXTOPER(first));
4852         
4853         if (PL_regkind[fop] == NOTHING && nop == END)
4854             r->extflags |= RXf_NULL;
4855         else if (PL_regkind[fop] == BOL && nop == END)
4856             r->extflags |= RXf_START_ONLY;
4857         else if (fop == PLUS && nop ==SPACE && OP(regnext(first))==END)
4858             r->extflags |= RXf_WHITE;    
4859     }
4860 #endif
4861 #ifdef DEBUGGING
4862     if (RExC_paren_names) {
4863         ri->name_list_idx = add_data( pRExC_state, 1, "p" );
4864         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
4865     } else
4866 #endif
4867         ri->name_list_idx = 0;
4868
4869     if (RExC_recurse_count) {
4870         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
4871             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
4872             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
4873         }
4874     }
4875     Newxz(r->offs, RExC_npar, regexp_paren_pair);
4876     /* assume we don't need to swap parens around before we match */
4877
4878     DEBUG_DUMP_r({
4879         PerlIO_printf(Perl_debug_log,"Final program:\n");
4880         regdump(r);
4881     });
4882 #ifdef RE_TRACK_PATTERN_OFFSETS
4883     DEBUG_OFFSETS_r(if (ri->u.offsets) {
4884         const U32 len = ri->u.offsets[0];
4885         U32 i;
4886         GET_RE_DEBUG_FLAGS_DECL;
4887         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
4888         for (i = 1; i <= len; i++) {
4889             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
4890                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
4891                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
4892             }
4893         PerlIO_printf(Perl_debug_log, "\n");
4894     });
4895 #endif
4896     return rx;
4897 }
4898
4899 #undef RE_ENGINE_PTR
4900
4901
4902 SV*
4903 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
4904                     const U32 flags)
4905 {
4906     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
4907
4908     PERL_UNUSED_ARG(value);
4909
4910     if (flags & RXapif_FETCH) {
4911         return reg_named_buff_fetch(rx, key, flags);
4912     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
4913         Perl_croak(aTHX_ PL_no_modify);
4914         return NULL;
4915     } else if (flags & RXapif_EXISTS) {
4916         return reg_named_buff_exists(rx, key, flags)
4917             ? &PL_sv_yes
4918             : &PL_sv_no;
4919     } else if (flags & RXapif_REGNAMES) {
4920         return reg_named_buff_all(rx, flags);
4921     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
4922         return reg_named_buff_scalar(rx, flags);
4923     } else {
4924         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
4925         return NULL;
4926     }
4927 }
4928
4929 SV*
4930 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
4931                          const U32 flags)
4932 {
4933     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
4934     PERL_UNUSED_ARG(lastkey);
4935
4936     if (flags & RXapif_FIRSTKEY)
4937         return reg_named_buff_firstkey(rx, flags);
4938     else if (flags & RXapif_NEXTKEY)
4939         return reg_named_buff_nextkey(rx, flags);
4940     else {
4941         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
4942         return NULL;
4943     }
4944 }
4945
4946 SV*
4947 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
4948                           const U32 flags)
4949 {
4950     AV *retarray = NULL;
4951     SV *ret;
4952     struct regexp *const rx = (struct regexp *)SvANY(r);
4953
4954     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
4955
4956     if (flags & RXapif_ALL)
4957         retarray=newAV();
4958
4959     if (rx && RXp_PAREN_NAMES(rx)) {
4960         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
4961         if (he_str) {
4962             IV i;
4963             SV* sv_dat=HeVAL(he_str);
4964             I32 *nums=(I32*)SvPVX(sv_dat);
4965             for ( i=0; i<SvIVX(sv_dat); i++ ) {
4966                 if ((I32)(rx->nparens) >= nums[i]
4967                     && rx->offs[nums[i]].start != -1
4968                     && rx->offs[nums[i]].end != -1)
4969                 {
4970                     ret = newSVpvs("");
4971                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
4972                     if (!retarray)
4973                         return ret;
4974                 } else {
4975                     ret = newSVsv(&PL_sv_undef);
4976                 }
4977                 if (retarray) {
4978                     SvREFCNT_inc_simple_void(ret);
4979                     av_push(retarray, ret);
4980                 }
4981             }
4982             if (retarray)
4983                 return newRV((SV*)retarray);
4984         }
4985     }
4986     return NULL;
4987 }
4988
4989 bool
4990 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
4991                            const U32 flags)
4992 {
4993     struct regexp *const rx = (struct regexp *)SvANY(r);
4994
4995     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
4996
4997     if (rx && RXp_PAREN_NAMES(rx)) {
4998         if (flags & RXapif_ALL) {
4999             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
5000         } else {
5001             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
5002             if (sv) {
5003                 SvREFCNT_dec(sv);
5004                 return TRUE;
5005             } else {
5006                 return FALSE;
5007             }
5008         }
5009     } else {
5010         return FALSE;
5011     }
5012 }
5013
5014 SV*
5015 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
5016 {
5017     struct regexp *const rx = (struct regexp *)SvANY(r);
5018
5019     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
5020
5021     if ( rx && RXp_PAREN_NAMES(rx) ) {
5022         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
5023
5024         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
5025     } else {
5026         return FALSE;
5027     }
5028 }
5029
5030 SV*
5031 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
5032 {
5033     struct regexp *const rx = (struct regexp *)SvANY(r);
5034
5035     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
5036
5037     if (rx && RXp_PAREN_NAMES(rx)) {
5038         HV *hv = RXp_PAREN_NAMES(rx);
5039         HE *temphe;
5040         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5041             IV i;
5042             IV parno = 0;
5043             SV* sv_dat = HeVAL(temphe);
5044             I32 *nums = (I32*)SvPVX(sv_dat);
5045             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5046                 if ((I32)(rx->lastcloseparen) >= nums[i] &&
5047                     rx->offs[nums[i]].start != -1 &&
5048                     rx->offs[nums[i]].end != -1)
5049                 {
5050                     parno = nums[i];
5051                     break;
5052                 }
5053             }
5054             if (parno || flags & RXapif_ALL) {
5055                 return newSVhek(HeKEY_hek(temphe));
5056             }
5057         }
5058     }
5059     return NULL;
5060 }
5061
5062 SV*
5063 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
5064 {
5065     SV *ret;
5066     AV *av;
5067     I32 length;
5068     struct regexp *const rx = (struct regexp *)SvANY(r);
5069
5070     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
5071
5072     if (rx && RXp_PAREN_NAMES(rx)) {
5073         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
5074             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
5075         } else if (flags & RXapif_ONE) {
5076             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
5077             av = (AV*)SvRV(ret);
5078             length = av_len(av);
5079             return newSViv(length + 1);
5080         } else {
5081             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
5082             return NULL;
5083         }
5084     }
5085     return &PL_sv_undef;
5086 }
5087
5088 SV*
5089 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
5090 {
5091     struct regexp *const rx = (struct regexp *)SvANY(r);
5092     AV *av = newAV();
5093
5094     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
5095
5096     if (rx && RXp_PAREN_NAMES(rx)) {
5097         HV *hv= RXp_PAREN_NAMES(rx);
5098         HE *temphe;
5099         (void)hv_iterinit(hv);
5100         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5101             IV i;
5102             IV parno = 0;
5103             SV* sv_dat = HeVAL(temphe);
5104             I32 *nums = (I32*)SvPVX(sv_dat);
5105             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5106                 if ((I32)(rx->lastcloseparen) >= nums[i] &&
5107                     rx->offs[nums[i]].start != -1 &&
5108                     rx->offs[nums[i]].end != -1)
5109                 {
5110                     parno = nums[i];
5111                     break;
5112                 }
5113             }
5114             if (parno || flags & RXapif_ALL) {
5115                 av_push(av, newSVhek(HeKEY_hek(temphe)));
5116             }
5117         }
5118     }
5119
5120     return newRV((SV*)av);
5121 }
5122
5123 void
5124 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
5125                              SV * const sv)
5126 {
5127     struct regexp *const rx = (struct regexp *)SvANY(r);
5128     char *s = NULL;
5129     I32 i = 0;
5130     I32 s1, t1;
5131
5132     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
5133         
5134     if (!rx->subbeg) {
5135         sv_setsv(sv,&PL_sv_undef);
5136         return;
5137     } 
5138     else               
5139     if (paren == RX_BUFF_IDX_PREMATCH && rx->offs[0].start != -1) {
5140         /* $` */
5141         i = rx->offs[0].start;
5142         s = rx->subbeg;
5143     }
5144     else 
5145     if (paren == RX_BUFF_IDX_POSTMATCH && rx->offs[0].end != -1) {
5146         /* $' */
5147         s = rx->subbeg + rx->offs[0].end;
5148         i = rx->sublen - rx->offs[0].end;
5149     } 
5150     else
5151     if ( 0 <= paren && paren <= (I32)rx->nparens &&
5152         (s1 = rx->offs[paren].start) != -1 &&
5153         (t1 = rx->offs[paren].end) != -1)
5154     {
5155         /* $& $1 ... */
5156         i = t1 - s1;
5157         s = rx->subbeg + s1;
5158     } else {
5159         sv_setsv(sv,&PL_sv_undef);
5160         return;
5161     }          
5162     assert(rx->sublen >= (s - rx->subbeg) + i );
5163     if (i >= 0) {
5164         const int oldtainted = PL_tainted;
5165         TAINT_NOT;
5166         sv_setpvn(sv, s, i);
5167         PL_tainted = oldtainted;
5168         if ( (rx->extflags & RXf_CANY_SEEN)
5169             ? (RXp_MATCH_UTF8(rx)
5170                         && (!i || is_utf8_string((U8*)s, i)))
5171             : (RXp_MATCH_UTF8(rx)) )
5172         {
5173             SvUTF8_on(sv);
5174         }
5175         else
5176             SvUTF8_off(sv);
5177         if (PL_tainting) {
5178             if (RXp_MATCH_TAINTED(rx)) {
5179                 if (SvTYPE(sv) >= SVt_PVMG) {
5180                     MAGIC* const mg = SvMAGIC(sv);
5181                     MAGIC* mgt;
5182                     PL_tainted = 1;
5183                     SvMAGIC_set(sv, mg->mg_moremagic);
5184                     SvTAINT(sv);
5185                     if ((mgt = SvMAGIC(sv))) {
5186                         mg->mg_moremagic = mgt;
5187                         SvMAGIC_set(sv, mg);
5188                     }
5189                 } else {
5190                     PL_tainted = 1;
5191                     SvTAINT(sv);
5192                 }
5193             } else 
5194                 SvTAINTED_off(sv);
5195         }
5196     } else {
5197         sv_setsv(sv,&PL_sv_undef);
5198         return;
5199     }
5200 }
5201
5202 void
5203 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
5204                                                          SV const * const value)
5205 {
5206     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
5207
5208     PERL_UNUSED_ARG(rx);
5209     PERL_UNUSED_ARG(paren);
5210     PERL_UNUSED_ARG(value);
5211
5212     if (!PL_localizing)
5213         Perl_croak(aTHX_ PL_no_modify);
5214 }
5215
5216 I32
5217 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
5218                               const I32 paren)
5219 {
5220     struct regexp *const rx = (struct regexp *)SvANY(r);
5221     I32 i;
5222     I32 s1, t1;
5223
5224     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
5225
5226     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
5227         switch (paren) {
5228       /* $` / ${^PREMATCH} */
5229       case RX_BUFF_IDX_PREMATCH:
5230         if (rx->offs[0].start != -1) {
5231                         i = rx->offs[0].start;
5232                         if (i > 0) {
5233                                 s1 = 0;
5234                                 t1 = i;
5235                                 goto getlen;
5236                         }
5237             }
5238         return 0;
5239       /* $' / ${^POSTMATCH} */
5240       case RX_BUFF_IDX_POSTMATCH:
5241             if (rx->offs[0].end != -1) {
5242                         i = rx->sublen - rx->offs[0].end;
5243                         if (i > 0) {
5244                                 s1 = rx->offs[0].end;
5245                                 t1 = rx->sublen;
5246                                 goto getlen;
5247                         }
5248             }
5249         return 0;
5250       /* $& / ${^MATCH}, $1, $2, ... */
5251       default:
5252             if (paren <= (I32)rx->nparens &&
5253             (s1 = rx->offs[paren].start) != -1 &&
5254             (t1 = rx->offs[paren].end) != -1)
5255             {
5256             i = t1 - s1;
5257             goto getlen;
5258         } else {
5259             if (ckWARN(WARN_UNINITIALIZED))
5260                 report_uninit((SV*)sv);
5261             return 0;
5262         }
5263     }
5264   getlen:
5265     if (i > 0 && RXp_MATCH_UTF8(rx)) {
5266         const char * const s = rx->subbeg + s1;
5267         const U8 *ep;
5268         STRLEN el;
5269
5270         i = t1 - s1;
5271         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
5272                         i = el;
5273     }
5274     return i;
5275 }
5276
5277 SV*
5278 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
5279 {
5280     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
5281         PERL_UNUSED_ARG(rx);
5282         if (0)
5283             return NULL;
5284         else
5285             return newSVpvs("Regexp");
5286 }
5287
5288 /* Scans the name of a named buffer from the pattern.
5289  * If flags is REG_RSN_RETURN_NULL returns null.
5290  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
5291  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
5292  * to the parsed name as looked up in the RExC_paren_names hash.
5293  * If there is an error throws a vFAIL().. type exception.
5294  */
5295
5296 #define REG_RSN_RETURN_NULL    0
5297 #define REG_RSN_RETURN_NAME    1
5298 #define REG_RSN_RETURN_DATA    2
5299
5300 STATIC SV*
5301 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
5302 {
5303     char *name_start = RExC_parse;
5304
5305     PERL_ARGS_ASSERT_REG_SCAN_NAME;
5306
5307     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
5308          /* skip IDFIRST by using do...while */
5309         if (UTF)
5310             do {
5311                 RExC_parse += UTF8SKIP(RExC_parse);
5312             } while (isALNUM_utf8((U8*)RExC_parse));
5313         else
5314             do {
5315                 RExC_parse++;
5316             } while (isALNUM(*RExC_parse));
5317     }
5318
5319     if ( flags ) {
5320         SV* sv_name
5321             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
5322                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
5323         if ( flags == REG_RSN_RETURN_NAME)
5324             return sv_name;
5325         else if (flags==REG_RSN_RETURN_DATA) {
5326             HE *he_str = NULL;
5327             SV *sv_dat = NULL;
5328             if ( ! sv_name )      /* should not happen*/
5329                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
5330             if (RExC_paren_names)
5331                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
5332             if ( he_str )
5333                 sv_dat = HeVAL(he_str);
5334             if ( ! sv_dat )
5335                 vFAIL("Reference to nonexistent named group");
5336             return sv_dat;
5337         }
5338         else {
5339             Perl_croak(aTHX_ "panic: bad flag in reg_scan_name");
5340         }
5341         /* NOT REACHED */
5342     }
5343     return NULL;
5344 }
5345
5346 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
5347     int rem=(int)(RExC_end - RExC_parse);                       \
5348     int cut;                                                    \
5349     int num;                                                    \
5350     int iscut=0;                                                \
5351     if (rem>10) {                                               \
5352         rem=10;                                                 \
5353         iscut=1;                                                \
5354     }                                                           \
5355     cut=10-rem;                                                 \
5356     if (RExC_lastparse!=RExC_parse)                             \
5357         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
5358             rem, RExC_parse,                                    \
5359             cut + 4,                                            \
5360             iscut ? "..." : "<"                                 \
5361         );                                                      \
5362     else                                                        \
5363         PerlIO_printf(Perl_debug_log,"%16s","");                \
5364                                                                 \
5365     if (SIZE_ONLY)                                              \
5366        num = RExC_size + 1;                                     \
5367     else                                                        \
5368        num=REG_NODE_NUM(RExC_emit);                             \
5369     if (RExC_lastnum!=num)                                      \
5370        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
5371     else                                                        \
5372        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
5373     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
5374         (int)((depth*2)), "",                                   \
5375         (funcname)                                              \
5376     );                                                          \
5377     RExC_lastnum=num;                                           \
5378     RExC_lastparse=RExC_parse;                                  \
5379 })
5380
5381
5382
5383 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
5384     DEBUG_PARSE_MSG((funcname));                            \
5385     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
5386 })
5387 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
5388     DEBUG_PARSE_MSG((funcname));                            \
5389     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
5390 })
5391 /*
5392  - reg - regular expression, i.e. main body or parenthesized thing
5393  *
5394  * Caller must absorb opening parenthesis.
5395  *
5396  * Combining parenthesis handling with the base level of regular expression
5397  * is a trifle forced, but the need to tie the tails of the branches to what
5398  * follows makes it hard to avoid.
5399  */
5400 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
5401 #ifdef DEBUGGING
5402 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
5403 #else
5404 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
5405 #endif
5406
5407 STATIC regnode *
5408 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
5409     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
5410 {
5411     dVAR;
5412     register regnode *ret;              /* Will be the head of the group. */
5413     register regnode *br;
5414     register regnode *lastbr;
5415     register regnode *ender = NULL;
5416     register I32 parno = 0;
5417     I32 flags;
5418     U32 oregflags = RExC_flags;
5419     bool have_branch = 0;
5420     bool is_open = 0;
5421     I32 freeze_paren = 0;
5422     I32 after_freeze = 0;
5423
5424     /* for (?g), (?gc), and (?o) warnings; warning
5425        about (?c) will warn about (?g) -- japhy    */
5426
5427 #define WASTED_O  0x01
5428 #define WASTED_G  0x02
5429 #define WASTED_C  0x04
5430 #define WASTED_GC (0x02|0x04)
5431     I32 wastedflags = 0x00;
5432
5433     char * parse_start = RExC_parse; /* MJD */
5434     char * const oregcomp_parse = RExC_parse;
5435
5436     GET_RE_DEBUG_FLAGS_DECL;
5437
5438     PERL_ARGS_ASSERT_REG;
5439     DEBUG_PARSE("reg ");
5440
5441     *flagp = 0;                         /* Tentatively. */
5442
5443
5444     /* Make an OPEN node, if parenthesized. */
5445     if (paren) {
5446         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
5447             char *start_verb = RExC_parse;
5448             STRLEN verb_len = 0;
5449             char *start_arg = NULL;
5450             unsigned char op = 0;
5451             int argok = 1;
5452             int internal_argval = 0; /* internal_argval is only useful if !argok */
5453             while ( *RExC_parse && *RExC_parse != ')' ) {
5454                 if ( *RExC_parse == ':' ) {
5455                     start_arg = RExC_parse + 1;
5456                     break;
5457                 }
5458                 RExC_parse++;
5459             }
5460             ++start_verb;
5461             verb_len = RExC_parse - start_verb;
5462             if ( start_arg ) {
5463                 RExC_parse++;
5464                 while ( *RExC_parse && *RExC_parse != ')' ) 
5465                     RExC_parse++;
5466                 if ( *RExC_parse != ')' ) 
5467                     vFAIL("Unterminated verb pattern argument");
5468                 if ( RExC_parse == start_arg )
5469                     start_arg = NULL;
5470             } else {
5471                 if ( *RExC_parse != ')' )
5472                     vFAIL("Unterminated verb pattern");
5473             }
5474             
5475             switch ( *start_verb ) {
5476             case 'A':  /* (*ACCEPT) */
5477                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
5478                     op = ACCEPT;
5479                     internal_argval = RExC_nestroot;
5480                 }
5481                 break;
5482             case 'C':  /* (*COMMIT) */
5483                 if ( memEQs(start_verb,verb_len,"COMMIT") )
5484                     op = COMMIT;
5485                 break;
5486             case 'F':  /* (*FAIL) */
5487                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
5488                     op = OPFAIL;
5489                     argok = 0;
5490                 }
5491                 break;
5492             case ':':  /* (*:NAME) */
5493             case 'M':  /* (*MARK:NAME) */
5494                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
5495                     op = MARKPOINT;
5496                     argok = -1;
5497                 }
5498                 break;
5499             case 'P':  /* (*PRUNE) */
5500                 if ( memEQs(start_verb,verb_len,"PRUNE") )
5501                     op = PRUNE;
5502                 break;
5503             case 'S':   /* (*SKIP) */  
5504                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
5505                     op = SKIP;
5506                 break;
5507             case 'T':  /* (*THEN) */
5508                 /* [19:06] <TimToady> :: is then */
5509                 if ( memEQs(start_verb,verb_len,"THEN") ) {
5510                     op = CUTGROUP;
5511                     RExC_seen |= REG_SEEN_CUTGROUP;
5512                 }
5513                 break;
5514             }
5515             if ( ! op ) {
5516                 RExC_parse++;
5517                 vFAIL3("Unknown verb pattern '%.*s'",
5518                     verb_len, start_verb);
5519             }
5520             if ( argok ) {
5521                 if ( start_arg && internal_argval ) {
5522                     vFAIL3("Verb pattern '%.*s' may not have an argument",
5523                         verb_len, start_verb); 
5524                 } else if ( argok < 0 && !start_arg ) {
5525                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
5526                         verb_len, start_verb);    
5527                 } else {
5528                     ret = reganode(pRExC_state, op, internal_argval);
5529                     if ( ! internal_argval && ! SIZE_ONLY ) {
5530                         if (start_arg) {
5531                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
5532                             ARG(ret) = add_data( pRExC_state, 1, "S" );
5533                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
5534                             ret->flags = 0;
5535                         } else {
5536                             ret->flags = 1; 
5537                         }
5538                     }               
5539                 }
5540                 if (!internal_argval)
5541                     RExC_seen |= REG_SEEN_VERBARG;
5542             } else if ( start_arg ) {
5543                 vFAIL3("Verb pattern '%.*s' may not have an argument",
5544                         verb_len, start_verb);    
5545             } else {
5546                 ret = reg_node(pRExC_state, op);
5547             }
5548             nextchar(pRExC_state);
5549             return ret;
5550         } else 
5551         if (*RExC_parse == '?') { /* (?...) */
5552             bool is_logical = 0;
5553             const char * const seqstart = RExC_parse;
5554
5555             RExC_parse++;
5556             paren = *RExC_parse++;
5557             ret = NULL;                 /* For look-ahead/behind. */
5558             switch (paren) {
5559
5560             case 'P':   /* (?P...) variants for those used to PCRE/Python */
5561                 paren = *RExC_parse++;
5562                 if ( paren == '<')         /* (?P<...>) named capture */
5563                     goto named_capture;
5564                 else if (paren == '>') {   /* (?P>name) named recursion */
5565                     goto named_recursion;
5566                 }
5567                 else if (paren == '=') {   /* (?P=...)  named backref */
5568                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
5569                        you change this make sure you change that */
5570                     char* name_start = RExC_parse;
5571                     U32 num = 0;
5572                     SV *sv_dat = reg_scan_name(pRExC_state,
5573                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5574                     if (RExC_parse == name_start || *RExC_parse != ')')
5575                         vFAIL2("Sequence %.3s... not terminated",parse_start);
5576
5577                     if (!SIZE_ONLY) {
5578                         num = add_data( pRExC_state, 1, "S" );
5579                         RExC_rxi->data->data[num]=(void*)sv_dat;
5580                         SvREFCNT_inc_simple_void(sv_dat);
5581                     }
5582                     RExC_sawback = 1;
5583                     ret = reganode(pRExC_state,
5584                            (U8)(FOLD ? (LOC ? NREFFL : NREFF) : NREF),
5585                            num);
5586                     *flagp |= HASWIDTH;
5587
5588                     Set_Node_Offset(ret, parse_start+1);
5589                     Set_Node_Cur_Length(ret); /* MJD */
5590
5591                     nextchar(pRExC_state);
5592                     return ret;
5593                 }
5594                 RExC_parse++;
5595                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
5596                 /*NOTREACHED*/
5597             case '<':           /* (?<...) */
5598                 if (*RExC_parse == '!')
5599                     paren = ',';
5600                 else if (*RExC_parse != '=') 
5601               named_capture:
5602                 {               /* (?<...>) */
5603                     char *name_start;
5604                     SV *svname;
5605                     paren= '>';
5606             case '\'':          /* (?'...') */
5607                     name_start= RExC_parse;
5608                     svname = reg_scan_name(pRExC_state,
5609                         SIZE_ONLY ?  /* reverse test from the others */
5610                         REG_RSN_RETURN_NAME : 
5611                         REG_RSN_RETURN_NULL);
5612                     if (RExC_parse == name_start) {
5613                         RExC_parse++;
5614                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
5615                         /*NOTREACHED*/
5616                     }
5617                     if (*RExC_parse != paren)
5618                         vFAIL2("Sequence (?%c... not terminated",
5619                             paren=='>' ? '<' : paren);
5620                     if (SIZE_ONLY) {
5621                         HE *he_str;
5622                         SV *sv_dat = NULL;
5623                         if (!svname) /* shouldnt happen */
5624                             Perl_croak(aTHX_
5625                                 "panic: reg_scan_name returned NULL");
5626                         if (!RExC_paren_names) {
5627                             RExC_paren_names= newHV();
5628                             sv_2mortal((SV*)RExC_paren_names);
5629 #ifdef DEBUGGING
5630                             RExC_paren_name_list= newAV();
5631                             sv_2mortal((SV*)RExC_paren_name_list);
5632 #endif
5633                         }
5634                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
5635                         if ( he_str )
5636                             sv_dat = HeVAL(he_str);
5637                         if ( ! sv_dat ) {
5638                             /* croak baby croak */
5639                             Perl_croak(aTHX_
5640                                 "panic: paren_name hash element allocation failed");
5641                         } else if ( SvPOK(sv_dat) ) {
5642                             /* (?|...) can mean we have dupes so scan to check
5643                                its already been stored. Maybe a flag indicating
5644                                we are inside such a construct would be useful,
5645                                but the arrays are likely to be quite small, so
5646                                for now we punt -- dmq */
5647                             IV count = SvIV(sv_dat);
5648                             I32 *pv = (I32*)SvPVX(sv_dat);
5649                             IV i;
5650                             for ( i = 0 ; i < count ; i++ ) {
5651                                 if ( pv[i] == RExC_npar ) {
5652                                     count = 0;
5653                                     break;
5654                                 }
5655                             }
5656                             if ( count ) {
5657                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
5658                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
5659                                 pv[count] = RExC_npar;
5660                                 SvIVX(sv_dat)++;
5661                             }
5662                         } else {
5663                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
5664                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
5665                             SvIOK_on(sv_dat);
5666                             SvIVX(sv_dat)= 1;
5667                         }
5668 #ifdef DEBUGGING
5669                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
5670                             SvREFCNT_dec(svname);
5671 #endif
5672
5673                         /*sv_dump(sv_dat);*/
5674                     }
5675                     nextchar(pRExC_state);
5676                     paren = 1;
5677                     goto capturing_parens;
5678                 }
5679                 RExC_seen |= REG_SEEN_LOOKBEHIND;
5680                 RExC_parse++;
5681             case '=':           /* (?=...) */
5682             case '!':           /* (?!...) */
5683                 RExC_seen_zerolen++;
5684                 if (*RExC_parse == ')') {
5685                     ret=reg_node(pRExC_state, OPFAIL);
5686                     nextchar(pRExC_state);
5687                     return ret;
5688                 }
5689                 break;
5690             case '|':           /* (?|...) */
5691                 /* branch reset, behave like a (?:...) except that
5692                    buffers in alternations share the same numbers */
5693                 paren = ':'; 
5694                 after_freeze = freeze_paren = RExC_npar;
5695                 break;
5696             case ':':           /* (?:...) */
5697             case '>':           /* (?>...) */
5698                 break;
5699             case '$':           /* (?$...) */
5700             case '@':           /* (?@...) */
5701                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
5702                 break;
5703             case '#':           /* (?#...) */
5704                 while (*RExC_parse && *RExC_parse != ')')
5705                     RExC_parse++;
5706                 if (*RExC_parse != ')')
5707                     FAIL("Sequence (?#... not terminated");
5708                 nextchar(pRExC_state);
5709                 *flagp = TRYAGAIN;
5710                 return NULL;
5711             case '0' :           /* (?0) */
5712             case 'R' :           /* (?R) */
5713                 if (*RExC_parse != ')')
5714                     FAIL("Sequence (?R) not terminated");
5715                 ret = reg_node(pRExC_state, GOSTART);
5716                 *flagp |= POSTPONED;
5717                 nextchar(pRExC_state);
5718                 return ret;
5719                 /*notreached*/
5720             { /* named and numeric backreferences */
5721                 I32 num;
5722             case '&':            /* (?&NAME) */
5723                 parse_start = RExC_parse - 1;
5724               named_recursion:
5725                 {
5726                     SV *sv_dat = reg_scan_name(pRExC_state,
5727                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5728                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
5729                 }
5730                 goto gen_recurse_regop;
5731                 /* NOT REACHED */
5732             case '+':
5733                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
5734                     RExC_parse++;
5735                     vFAIL("Illegal pattern");
5736                 }
5737                 goto parse_recursion;
5738                 /* NOT REACHED*/
5739             case '-': /* (?-1) */
5740                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
5741                     RExC_parse--; /* rewind to let it be handled later */
5742                     goto parse_flags;
5743                 } 
5744                 /*FALLTHROUGH */
5745             case '1': case '2': case '3': case '4': /* (?1) */
5746             case '5': case '6': case '7': case '8': case '9':
5747                 RExC_parse--;
5748               parse_recursion:
5749                 num = atoi(RExC_parse);
5750                 parse_start = RExC_parse - 1; /* MJD */
5751                 if (*RExC_parse == '-')
5752                     RExC_parse++;
5753                 while (isDIGIT(*RExC_parse))
5754                         RExC_parse++;
5755                 if (*RExC_parse!=')') 
5756                     vFAIL("Expecting close bracket");
5757                         
5758               gen_recurse_regop:
5759                 if ( paren == '-' ) {
5760                     /*
5761                     Diagram of capture buffer numbering.
5762                     Top line is the normal capture buffer numbers
5763                     Botton line is the negative indexing as from
5764                     the X (the (?-2))
5765
5766                     +   1 2    3 4 5 X          6 7
5767                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
5768                     -   5 4    3 2 1 X          x x
5769
5770                     */
5771                     num = RExC_npar + num;
5772                     if (num < 1)  {
5773                         RExC_parse++;
5774                         vFAIL("Reference to nonexistent group");
5775                     }
5776                 } else if ( paren == '+' ) {
5777                     num = RExC_npar + num - 1;
5778                 }
5779
5780                 ret = reganode(pRExC_state, GOSUB, num);
5781                 if (!SIZE_ONLY) {
5782                     if (num > (I32)RExC_rx->nparens) {
5783                         RExC_parse++;
5784                         vFAIL("Reference to nonexistent group");
5785                     }
5786                     ARG2L_SET( ret, RExC_recurse_count++);
5787                     RExC_emit++;
5788                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
5789                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
5790                 } else {
5791                     RExC_size++;
5792                 }
5793                 RExC_seen |= REG_SEEN_RECURSE;
5794                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
5795                 Set_Node_Offset(ret, parse_start); /* MJD */
5796
5797                 *flagp |= POSTPONED;
5798                 nextchar(pRExC_state);
5799                 return ret;
5800             } /* named and numeric backreferences */
5801             /* NOT REACHED */
5802
5803             case '?':           /* (??...) */
5804                 is_logical = 1;
5805                 if (*RExC_parse != '{') {
5806                     RExC_parse++;
5807                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
5808                     /*NOTREACHED*/
5809                 }
5810                 *flagp |= POSTPONED;
5811                 paren = *RExC_parse++;
5812                 /* FALL THROUGH */
5813             case '{':           /* (?{...}) */
5814             {
5815                 I32 count = 1;
5816                 U32 n = 0;
5817                 char c;
5818                 char *s = RExC_parse;
5819
5820                 RExC_seen_zerolen++;
5821                 RExC_seen |= REG_SEEN_EVAL;
5822                 while (count && (c = *RExC_parse)) {
5823                     if (c == '\\') {
5824                         if (RExC_parse[1])
5825                             RExC_parse++;
5826                     }
5827                     else if (c == '{')
5828                         count++;
5829                     else if (c == '}')
5830                         count--;
5831                     RExC_parse++;
5832                 }
5833                 if (*RExC_parse != ')') {
5834                     RExC_parse = s;             
5835                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
5836                 }
5837                 if (!SIZE_ONLY) {
5838                     PAD *pad;
5839                     OP_4tree *sop, *rop;
5840                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
5841
5842                     ENTER;
5843                     Perl_save_re_context(aTHX);
5844                     rop = sv_compile_2op(sv, &sop, "re", &pad);
5845                     sop->op_private |= OPpREFCOUNTED;
5846                     /* re_dup will OpREFCNT_inc */
5847                     OpREFCNT_set(sop, 1);
5848                     LEAVE;
5849
5850                     n = add_data(pRExC_state, 3, "nop");
5851                     RExC_rxi->data->data[n] = (void*)rop;
5852                     RExC_rxi->data->data[n+1] = (void*)sop;
5853                     RExC_rxi->data->data[n+2] = (void*)pad;
5854                     SvREFCNT_dec(sv);
5855                 }
5856                 else {                                          /* First pass */
5857                     if (PL_reginterp_cnt < ++RExC_seen_evals
5858                         && IN_PERL_RUNTIME)
5859                         /* No compiled RE interpolated, has runtime
5860                            components ===> unsafe.  */
5861                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
5862                     if (PL_tainting && PL_tainted)
5863                         FAIL("Eval-group in insecure regular expression");
5864 #if PERL_VERSION > 8
5865                     if (IN_PERL_COMPILETIME)
5866                         PL_cv_has_eval = 1;
5867 #endif
5868                 }
5869
5870                 nextchar(pRExC_state);
5871                 if (is_logical) {
5872                     ret = reg_node(pRExC_state, LOGICAL);
5873                     if (!SIZE_ONLY)
5874                         ret->flags = 2;
5875                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
5876                     /* deal with the length of this later - MJD */
5877                     return ret;
5878                 }
5879                 ret = reganode(pRExC_state, EVAL, n);
5880                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
5881                 Set_Node_Offset(ret, parse_start);
5882                 return ret;
5883             }
5884             case '(':           /* (?(?{...})...) and (?(?=...)...) */
5885             {
5886                 int is_define= 0;
5887                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
5888                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
5889                         || RExC_parse[1] == '<'
5890                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
5891                         I32 flag;
5892                         
5893                         ret = reg_node(pRExC_state, LOGICAL);
5894                         if (!SIZE_ONLY)
5895                             ret->flags = 1;
5896                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
5897                         goto insert_if;
5898                     }
5899                 }
5900                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
5901                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
5902                 {
5903                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
5904                     char *name_start= RExC_parse++;
5905                     U32 num = 0;
5906                     SV *sv_dat=reg_scan_name(pRExC_state,
5907                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5908                     if (RExC_parse == name_start || *RExC_parse != ch)
5909                         vFAIL2("Sequence (?(%c... not terminated",
5910                             (ch == '>' ? '<' : ch));
5911                     RExC_parse++;
5912                     if (!SIZE_ONLY) {
5913                         num = add_data( pRExC_state, 1, "S" );
5914                         RExC_rxi->data->data[num]=(void*)sv_dat;
5915                         SvREFCNT_inc_simple_void(sv_dat);
5916                     }
5917                     ret = reganode(pRExC_state,NGROUPP,num);
5918                     goto insert_if_check_paren;
5919                 }
5920                 else if (RExC_parse[0] == 'D' &&
5921                          RExC_parse[1] == 'E' &&
5922                          RExC_parse[2] == 'F' &&
5923                          RExC_parse[3] == 'I' &&
5924                          RExC_parse[4] == 'N' &&
5925                          RExC_parse[5] == 'E')
5926                 {
5927                     ret = reganode(pRExC_state,DEFINEP,0);
5928                     RExC_parse +=6 ;
5929                     is_define = 1;
5930                     goto insert_if_check_paren;
5931                 }
5932                 else if (RExC_parse[0] == 'R') {
5933                     RExC_parse++;
5934                     parno = 0;
5935                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
5936                         parno = atoi(RExC_parse++);
5937                         while (isDIGIT(*RExC_parse))
5938                             RExC_parse++;
5939                     } else if (RExC_parse[0] == '&') {
5940                         SV *sv_dat;
5941                         RExC_parse++;
5942                         sv_dat = reg_scan_name(pRExC_state,
5943                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5944                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
5945                     }
5946                     ret = reganode(pRExC_state,INSUBP,parno); 
5947                     goto insert_if_check_paren;
5948                 }
5949                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
5950                     /* (?(1)...) */
5951                     char c;
5952                     parno = atoi(RExC_parse++);
5953
5954                     while (isDIGIT(*RExC_parse))
5955                         RExC_parse++;
5956                     ret = reganode(pRExC_state, GROUPP, parno);
5957
5958                  insert_if_check_paren:
5959                     if ((c = *nextchar(pRExC_state)) != ')')
5960                         vFAIL("Switch condition not recognized");
5961                   insert_if:
5962                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
5963                     br = regbranch(pRExC_state, &flags, 1,depth+1);
5964                     if (br == NULL)
5965                         br = reganode(pRExC_state, LONGJMP, 0);
5966                     else
5967                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
5968                     c = *nextchar(pRExC_state);
5969                     if (flags&HASWIDTH)
5970                         *flagp |= HASWIDTH;
5971                     if (c == '|') {
5972                         if (is_define) 
5973                             vFAIL("(?(DEFINE)....) does not allow branches");
5974                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
5975                         regbranch(pRExC_state, &flags, 1,depth+1);
5976                         REGTAIL(pRExC_state, ret, lastbr);
5977                         if (flags&HASWIDTH)
5978                             *flagp |= HASWIDTH;
5979                         c = *nextchar(pRExC_state);
5980                     }
5981                     else
5982                         lastbr = NULL;
5983                     if (c != ')')
5984                         vFAIL("Switch (?(condition)... contains too many branches");
5985                     ender = reg_node(pRExC_state, TAIL);
5986                     REGTAIL(pRExC_state, br, ender);
5987                     if (lastbr) {
5988                         REGTAIL(pRExC_state, lastbr, ender);
5989                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
5990                     }
5991                     else
5992                         REGTAIL(pRExC_state, ret, ender);
5993                     RExC_size++; /* XXX WHY do we need this?!!
5994                                     For large programs it seems to be required
5995                                     but I can't figure out why. -- dmq*/
5996                     return ret;
5997                 }
5998                 else {
5999                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
6000                 }
6001             }
6002             case 0:
6003                 RExC_parse--; /* for vFAIL to print correctly */
6004                 vFAIL("Sequence (? incomplete");
6005                 break;
6006             default:
6007                 --RExC_parse;
6008                 parse_flags:      /* (?i) */  
6009             {
6010                 U32 posflags = 0, negflags = 0;
6011                 U32 *flagsp = &posflags;
6012
6013                 while (*RExC_parse) {
6014                     /* && strchr("iogcmsx", *RExC_parse) */
6015                     /* (?g), (?gc) and (?o) are useless here
6016                        and must be globally applied -- japhy */
6017                     switch (*RExC_parse) {
6018                     CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
6019                     case ONCE_PAT_MOD: /* 'o' */
6020                     case GLOBAL_PAT_MOD: /* 'g' */
6021                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
6022                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
6023                             if (! (wastedflags & wflagbit) ) {
6024                                 wastedflags |= wflagbit;
6025                                 vWARN5(
6026                                     RExC_parse + 1,
6027                                     "Useless (%s%c) - %suse /%c modifier",
6028                                     flagsp == &negflags ? "?-" : "?",
6029                                     *RExC_parse,
6030                                     flagsp == &negflags ? "don't " : "",
6031                                     *RExC_parse
6032                                 );
6033                             }
6034                         }
6035                         break;
6036                         
6037                     case CONTINUE_PAT_MOD: /* 'c' */
6038                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
6039                             if (! (wastedflags & WASTED_C) ) {
6040                                 wastedflags |= WASTED_GC;
6041                                 vWARN3(
6042                                     RExC_parse + 1,
6043                                     "Useless (%sc) - %suse /gc modifier",
6044                                     flagsp == &negflags ? "?-" : "?",
6045                                     flagsp == &negflags ? "don't " : ""
6046                                 );
6047                             }
6048                         }
6049                         break;
6050                     case KEEPCOPY_PAT_MOD: /* 'p' */
6051                         if (flagsp == &negflags) {
6052                             if (SIZE_ONLY && ckWARN(WARN_REGEXP))
6053                                 vWARN(RExC_parse + 1,"Useless use of (?-p)");
6054                         } else {
6055                             *flagsp |= RXf_PMf_KEEPCOPY;
6056                         }
6057                         break;
6058                     case '-':
6059                         if (flagsp == &negflags) {
6060                             RExC_parse++;
6061                             vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
6062                             /*NOTREACHED*/
6063                         }
6064                         flagsp = &negflags;
6065                         wastedflags = 0;  /* reset so (?g-c) warns twice */
6066                         break;
6067                     case ':':
6068                         paren = ':';
6069                         /*FALLTHROUGH*/
6070                     case ')':
6071                         RExC_flags |= posflags;
6072                         RExC_flags &= ~negflags;
6073                         if (paren != ':') {
6074                             oregflags |= posflags;
6075                             oregflags &= ~negflags;
6076                         }
6077                         nextchar(pRExC_state);
6078                         if (paren != ':') {
6079                             *flagp = TRYAGAIN;
6080                             return NULL;
6081                         } else {
6082                             ret = NULL;
6083                             goto parse_rest;
6084                         }
6085                         /*NOTREACHED*/
6086                     default:
6087                         RExC_parse++;
6088                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
6089                         /*NOTREACHED*/
6090                     }                           
6091                     ++RExC_parse;
6092                 }
6093             }} /* one for the default block, one for the switch */
6094         }
6095         else {                  /* (...) */
6096           capturing_parens:
6097             parno = RExC_npar;
6098             RExC_npar++;
6099             
6100             ret = reganode(pRExC_state, OPEN, parno);
6101             if (!SIZE_ONLY ){
6102                 if (!RExC_nestroot) 
6103                     RExC_nestroot = parno;
6104                 if (RExC_seen & REG_SEEN_RECURSE
6105                     && !RExC_open_parens[parno-1])
6106                 {
6107                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
6108                         "Setting open paren #%"IVdf" to %d\n", 
6109                         (IV)parno, REG_NODE_NUM(ret)));
6110                     RExC_open_parens[parno-1]= ret;
6111                 }
6112             }
6113             Set_Node_Length(ret, 1); /* MJD */
6114             Set_Node_Offset(ret, RExC_parse); /* MJD */
6115             is_open = 1;
6116         }
6117     }
6118     else                        /* ! paren */
6119         ret = NULL;
6120    
6121    parse_rest:
6122     /* Pick up the branches, linking them together. */
6123     parse_start = RExC_parse;   /* MJD */
6124     br = regbranch(pRExC_state, &flags, 1,depth+1);
6125     /*     branch_len = (paren != 0); */
6126
6127     if (br == NULL)
6128         return(NULL);
6129     if (*RExC_parse == '|') {
6130         if (!SIZE_ONLY && RExC_extralen) {
6131             reginsert(pRExC_state, BRANCHJ, br, depth+1);
6132         }
6133         else {                  /* MJD */
6134             reginsert(pRExC_state, BRANCH, br, depth+1);
6135             Set_Node_Length(br, paren != 0);
6136             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
6137         }
6138         have_branch = 1;
6139         if (SIZE_ONLY)
6140             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
6141     }
6142     else if (paren == ':') {
6143         *flagp |= flags&SIMPLE;
6144     }
6145     if (is_open) {                              /* Starts with OPEN. */
6146         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
6147     }
6148     else if (paren != '?')              /* Not Conditional */
6149         ret = br;
6150     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
6151     lastbr = br;
6152     while (*RExC_parse == '|') {
6153         if (!SIZE_ONLY && RExC_extralen) {
6154             ender = reganode(pRExC_state, LONGJMP,0);
6155             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
6156         }
6157         if (SIZE_ONLY)
6158             RExC_extralen += 2;         /* Account for LONGJMP. */
6159         nextchar(pRExC_state);
6160         if (freeze_paren) {
6161             if (RExC_npar > after_freeze)
6162                 after_freeze = RExC_npar;
6163             RExC_npar = freeze_paren;       
6164         }
6165         br = regbranch(pRExC_state, &flags, 0, depth+1);
6166
6167         if (br == NULL)
6168             return(NULL);
6169         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
6170         lastbr = br;
6171         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
6172     }
6173
6174     if (have_branch || paren != ':') {
6175         /* Make a closing node, and hook it on the end. */
6176         switch (paren) {
6177         case ':':
6178             ender = reg_node(pRExC_state, TAIL);
6179             break;
6180         case 1:
6181             ender = reganode(pRExC_state, CLOSE, parno);
6182             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
6183                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
6184                         "Setting close paren #%"IVdf" to %d\n", 
6185                         (IV)parno, REG_NODE_NUM(ender)));
6186                 RExC_close_parens[parno-1]= ender;
6187                 if (RExC_nestroot == parno) 
6188                     RExC_nestroot = 0;
6189             }       
6190             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
6191             Set_Node_Length(ender,1); /* MJD */
6192             break;
6193         case '<':
6194         case ',':
6195         case '=':
6196         case '!':
6197             *flagp &= ~HASWIDTH;
6198             /* FALL THROUGH */
6199         case '>':
6200             ender = reg_node(pRExC_state, SUCCEED);
6201             break;
6202         case 0:
6203             ender = reg_node(pRExC_state, END);
6204             if (!SIZE_ONLY) {
6205                 assert(!RExC_opend); /* there can only be one! */
6206                 RExC_opend = ender;
6207             }
6208             break;
6209         }
6210         REGTAIL(pRExC_state, lastbr, ender);
6211
6212         if (have_branch && !SIZE_ONLY) {
6213             if (depth==1)
6214                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
6215
6216             /* Hook the tails of the branches to the closing node. */
6217             for (br = ret; br; br = regnext(br)) {
6218                 const U8 op = PL_regkind[OP(br)];
6219                 if (op == BRANCH) {
6220                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
6221                 }
6222                 else if (op == BRANCHJ) {
6223                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
6224                 }
6225             }
6226         }
6227     }
6228
6229     {
6230         const char *p;
6231         static const char parens[] = "=!<,>";
6232
6233         if (paren && (p = strchr(parens, paren))) {
6234             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
6235             int flag = (p - parens) > 1;
6236
6237             if (paren == '>')
6238                 node = SUSPEND, flag = 0;
6239             reginsert(pRExC_state, node,ret, depth+1);
6240             Set_Node_Cur_Length(ret);
6241             Set_Node_Offset(ret, parse_start + 1);
6242             ret->flags = flag;
6243             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
6244         }
6245     }
6246
6247     /* Check for proper termination. */
6248     if (paren) {
6249         RExC_flags = oregflags;
6250         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
6251             RExC_parse = oregcomp_parse;
6252             vFAIL("Unmatched (");
6253         }
6254     }
6255     else if (!paren && RExC_parse < RExC_end) {
6256         if (*RExC_parse == ')') {
6257             RExC_parse++;
6258             vFAIL("Unmatched )");
6259         }
6260         else
6261             FAIL("Junk on end of regexp");      /* "Can't happen". */
6262         /* NOTREACHED */
6263     }
6264     if (after_freeze)
6265         RExC_npar = after_freeze;
6266     return(ret);
6267 }
6268
6269 /*
6270  - regbranch - one alternative of an | operator
6271  *
6272  * Implements the concatenation operator.
6273  */
6274 STATIC regnode *
6275 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
6276 {
6277     dVAR;
6278     register regnode *ret;
6279     register regnode *chain = NULL;
6280     register regnode *latest;
6281     I32 flags = 0, c = 0;
6282     GET_RE_DEBUG_FLAGS_DECL;
6283
6284     PERL_ARGS_ASSERT_REGBRANCH;
6285
6286     DEBUG_PARSE("brnc");
6287
6288     if (first)
6289         ret = NULL;
6290     else {
6291         if (!SIZE_ONLY && RExC_extralen)
6292             ret = reganode(pRExC_state, BRANCHJ,0);
6293         else {
6294             ret = reg_node(pRExC_state, BRANCH);
6295             Set_Node_Length(ret, 1);
6296         }
6297     }
6298         
6299     if (!first && SIZE_ONLY)
6300         RExC_extralen += 1;                     /* BRANCHJ */
6301
6302     *flagp = WORST;                     /* Tentatively. */
6303
6304     RExC_parse--;
6305     nextchar(pRExC_state);
6306     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
6307         flags &= ~TRYAGAIN;
6308         latest = regpiece(pRExC_state, &flags,depth+1);
6309         if (latest == NULL) {
6310             if (flags & TRYAGAIN)
6311                 continue;
6312             return(NULL);
6313         }
6314         else if (ret == NULL)
6315             ret = latest;
6316         *flagp |= flags&(HASWIDTH|POSTPONED);
6317         if (chain == NULL)      /* First piece. */
6318             *flagp |= flags&SPSTART;
6319         else {
6320             RExC_naughty++;
6321             REGTAIL(pRExC_state, chain, latest);
6322         }
6323         chain = latest;
6324         c++;
6325     }
6326     if (chain == NULL) {        /* Loop ran zero times. */
6327         chain = reg_node(pRExC_state, NOTHING);
6328         if (ret == NULL)
6329             ret = chain;
6330     }
6331     if (c == 1) {
6332         *flagp |= flags&SIMPLE;
6333     }
6334
6335     return ret;
6336 }
6337
6338 /*
6339  - regpiece - something followed by possible [*+?]
6340  *
6341  * Note that the branching code sequences used for ? and the general cases
6342  * of * and + are somewhat optimized:  they use the same NOTHING node as
6343  * both the endmarker for their branch list and the body of the last branch.
6344  * It might seem that this node could be dispensed with entirely, but the
6345  * endmarker role is not redundant.
6346  */
6347 STATIC regnode *
6348 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
6349 {
6350     dVAR;
6351     register regnode *ret;
6352     register char op;
6353     register char *next;
6354     I32 flags;
6355     const char * const origparse = RExC_parse;
6356     I32 min;
6357     I32 max = REG_INFTY;
6358     char *parse_start;
6359     const char *maxpos = NULL;
6360     GET_RE_DEBUG_FLAGS_DECL;
6361
6362     PERL_ARGS_ASSERT_REGPIECE;
6363
6364     DEBUG_PARSE("piec");
6365
6366     ret = regatom(pRExC_state, &flags,depth+1);
6367     if (ret == NULL) {
6368         if (flags & TRYAGAIN)
6369             *flagp |= TRYAGAIN;
6370         return(NULL);
6371     }
6372
6373     op = *RExC_parse;
6374
6375     if (op == '{' && regcurly(RExC_parse)) {
6376         maxpos = NULL;
6377         parse_start = RExC_parse; /* MJD */
6378         next = RExC_parse + 1;
6379         while (isDIGIT(*next) || *next == ',') {
6380             if (*next == ',') {
6381                 if (maxpos)
6382                     break;
6383                 else
6384                     maxpos = next;
6385             }
6386             next++;
6387         }
6388         if (*next == '}') {             /* got one */
6389             if (!maxpos)
6390                 maxpos = next;
6391             RExC_parse++;
6392             min = atoi(RExC_parse);
6393             if (*maxpos == ',')
6394                 maxpos++;
6395             else
6396                 maxpos = RExC_parse;
6397             max = atoi(maxpos);
6398             if (!max && *maxpos != '0')
6399                 max = REG_INFTY;                /* meaning "infinity" */
6400             else if (max >= REG_INFTY)
6401                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
6402             RExC_parse = next;
6403             nextchar(pRExC_state);
6404
6405         do_curly:
6406             if ((flags&SIMPLE)) {
6407                 RExC_naughty += 2 + RExC_naughty / 2;
6408                 reginsert(pRExC_state, CURLY, ret, depth+1);
6409                 Set_Node_Offset(ret, parse_start+1); /* MJD */
6410                 Set_Node_Cur_Length(ret);
6411             }
6412             else {
6413                 regnode * const w = reg_node(pRExC_state, WHILEM);
6414
6415                 w->flags = 0;
6416                 REGTAIL(pRExC_state, ret, w);
6417                 if (!SIZE_ONLY && RExC_extralen) {
6418                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
6419                     reginsert(pRExC_state, NOTHING,ret, depth+1);
6420                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
6421                 }
6422                 reginsert(pRExC_state, CURLYX,ret, depth+1);
6423                                 /* MJD hk */
6424                 Set_Node_Offset(ret, parse_start+1);
6425                 Set_Node_Length(ret,
6426                                 op == '{' ? (RExC_parse - parse_start) : 1);
6427
6428                 if (!SIZE_ONLY && RExC_extralen)
6429                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
6430                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
6431                 if (SIZE_ONLY)
6432                     RExC_whilem_seen++, RExC_extralen += 3;
6433                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
6434             }
6435             ret->flags = 0;
6436
6437             if (min > 0)
6438                 *flagp = WORST;
6439             if (max > 0)
6440                 *flagp |= HASWIDTH;
6441             if (max && max < min)
6442                 vFAIL("Can't do {n,m} with n > m");
6443             if (!SIZE_ONLY) {
6444                 ARG1_SET(ret, (U16)min);
6445                 ARG2_SET(ret, (U16)max);
6446             }
6447
6448             goto nest_check;
6449         }
6450     }
6451
6452     if (!ISMULT1(op)) {
6453         *flagp = flags;
6454         return(ret);
6455     }
6456
6457 #if 0                           /* Now runtime fix should be reliable. */
6458
6459     /* if this is reinstated, don't forget to put this back into perldiag:
6460
6461             =item Regexp *+ operand could be empty at {#} in regex m/%s/
6462
6463            (F) The part of the regexp subject to either the * or + quantifier
6464            could match an empty string. The {#} shows in the regular
6465            expression about where the problem was discovered.
6466
6467     */
6468
6469     if (!(flags&HASWIDTH) && op != '?')
6470       vFAIL("Regexp *+ operand could be empty");
6471 #endif
6472
6473     parse_start = RExC_parse;
6474     nextchar(pRExC_state);
6475
6476     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
6477
6478     if (op == '*' && (flags&SIMPLE)) {
6479         reginsert(pRExC_state, STAR, ret, depth+1);
6480         ret->flags = 0;
6481         RExC_naughty += 4;
6482     }
6483     else if (op == '*') {
6484         min = 0;
6485         goto do_curly;
6486     }
6487     else if (op == '+' && (flags&SIMPLE)) {
6488         reginsert(pRExC_state, PLUS, ret, depth+1);
6489         ret->flags = 0;
6490         RExC_naughty += 3;
6491     }
6492     else if (op == '+') {
6493         min = 1;
6494         goto do_curly;
6495     }
6496     else if (op == '?') {
6497         min = 0; max = 1;
6498         goto do_curly;
6499     }
6500   nest_check:
6501     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3 && ckWARN(WARN_REGEXP)) {
6502         vWARN3(RExC_parse,
6503                "%.*s matches null string many times",
6504                (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
6505                origparse);
6506     }
6507
6508     if (RExC_parse < RExC_end && *RExC_parse == '?') {
6509         nextchar(pRExC_state);
6510         reginsert(pRExC_state, MINMOD, ret, depth+1);
6511         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
6512     }
6513 #ifndef REG_ALLOW_MINMOD_SUSPEND
6514     else
6515 #endif
6516     if (RExC_parse < RExC_end && *RExC_parse == '+') {
6517         regnode *ender;
6518         nextchar(pRExC_state);
6519         ender = reg_node(pRExC_state, SUCCEED);
6520         REGTAIL(pRExC_state, ret, ender);
6521         reginsert(pRExC_state, SUSPEND, ret, depth+1);
6522         ret->flags = 0;
6523         ender = reg_node(pRExC_state, TAIL);
6524         REGTAIL(pRExC_state, ret, ender);
6525         /*ret= ender;*/
6526     }
6527
6528     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
6529         RExC_parse++;
6530         vFAIL("Nested quantifiers");
6531     }
6532
6533     return(ret);
6534 }
6535
6536
6537 /* reg_namedseq(pRExC_state,UVp)
6538    
6539    This is expected to be called by a parser routine that has 
6540    recognized'\N' and needs to handle the rest. RExC_parse is 
6541    expected to point at the first char following the N at the time
6542    of the call.
6543    
6544    If valuep is non-null then it is assumed that we are parsing inside 
6545    of a charclass definition and the first codepoint in the resolved
6546    string is returned via *valuep and the routine will return NULL. 
6547    In this mode if a multichar string is returned from the charnames 
6548    handler a warning will be issued, and only the first char in the 
6549    sequence will be examined. If the string returned is zero length
6550    then the value of *valuep is undefined and NON-NULL will 
6551    be returned to indicate failure. (This will NOT be a valid pointer 
6552    to a regnode.)
6553    
6554    If value is null then it is assumed that we are parsing normal text
6555    and inserts a new EXACT node into the program containing the resolved
6556    string and returns a pointer to the new node. If the string is 
6557    zerolength a NOTHING node is emitted.
6558    
6559    On success RExC_parse is set to the char following the endbrace.
6560    Parsing failures will generate a fatal errorvia vFAIL(...)
6561    
6562    NOTE: We cache all results from the charnames handler locally in 
6563    the RExC_charnames hash (created on first use) to prevent a charnames 
6564    handler from playing silly-buggers and returning a short string and 
6565    then a long string for a given pattern. Since the regexp program 
6566    size is calculated during an initial parse this would result
6567    in a buffer overrun so we cache to prevent the charname result from
6568    changing during the course of the parse.
6569    
6570  */
6571 STATIC regnode *
6572 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep) 
6573 {
6574     char * name;        /* start of the content of the name */
6575     char * endbrace;    /* endbrace following the name */
6576     SV *sv_str = NULL;  
6577     SV *sv_name = NULL;
6578     STRLEN len; /* this has various purposes throughout the code */
6579     bool cached = 0; /* if this is true then we shouldn't refcount dev sv_str */
6580     regnode *ret = NULL;
6581  
6582     PERL_ARGS_ASSERT_REG_NAMEDSEQ;
6583    
6584     if (*RExC_parse != '{') {
6585         vFAIL("Missing braces on \\N{}");
6586     }
6587     name = RExC_parse+1;
6588     endbrace = strchr(RExC_parse, '}');
6589     if ( ! endbrace ) {
6590         RExC_parse++;
6591         vFAIL("Missing right brace on \\N{}");
6592     } 
6593     RExC_parse = endbrace + 1;  
6594     
6595     
6596     /* RExC_parse points at the beginning brace, 
6597        endbrace points at the last */
6598     if ( name[0]=='U' && name[1]=='+' ) {
6599         /* its a "Unicode hex" notation {U+89AB} */
6600         I32 fl = PERL_SCAN_ALLOW_UNDERSCORES
6601             | PERL_SCAN_DISALLOW_PREFIX
6602             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
6603         UV cp;
6604         char string;
6605         len = (STRLEN)(endbrace - name - 2);
6606         cp = grok_hex(name + 2, &len, &fl, NULL);
6607         if ( len != (STRLEN)(endbrace - name - 2) ) {
6608             cp = 0xFFFD;
6609         }    
6610         if (cp > 0xff)
6611             RExC_utf8 = 1;
6612         if ( valuep ) {
6613             *valuep = cp;
6614             return NULL;
6615         }
6616         string = (char)cp;
6617         sv_str= newSVpvn(&string, 1);
6618     } else {
6619         /* fetch the charnames handler for this scope */
6620         HV * const table = GvHV(PL_hintgv);
6621         SV **cvp= table ? 
6622             hv_fetchs(table, "charnames", FALSE) :
6623             NULL;
6624         SV *cv= cvp ? *cvp : NULL;
6625         HE *he_str;
6626         int count;
6627         /* create an SV with the name as argument */
6628         sv_name = newSVpvn(name, endbrace - name);
6629         
6630         if (!table || !(PL_hints & HINT_LOCALIZE_HH)) {
6631             vFAIL2("Constant(\\N{%s}) unknown: "
6632                   "(possibly a missing \"use charnames ...\")",
6633                   SvPVX(sv_name));
6634         }
6635         if (!cvp || !SvOK(*cvp)) { /* when $^H{charnames} = undef; */
6636             vFAIL2("Constant(\\N{%s}): "
6637                   "$^H{charnames} is not defined",SvPVX(sv_name));
6638         }
6639         
6640         
6641         
6642         if (!RExC_charnames) {
6643             /* make sure our cache is allocated */
6644             RExC_charnames = newHV();
6645             sv_2mortal((SV*)RExC_charnames);
6646         } 
6647             /* see if we have looked this one up before */
6648         he_str = hv_fetch_ent( RExC_charnames, sv_name, 0, 0 );
6649         if ( he_str ) {
6650             sv_str = HeVAL(he_str);
6651             cached = 1;
6652         } else {
6653             dSP ;
6654
6655             ENTER ;
6656             SAVETMPS ;
6657             PUSHMARK(SP) ;
6658             
6659             XPUSHs(sv_name);
6660             
6661             PUTBACK ;
6662             
6663             count= call_sv(cv, G_SCALAR);
6664             
6665             if (count == 1) { /* XXXX is this right? dmq */
6666                 sv_str = POPs;
6667                 SvREFCNT_inc_simple_void(sv_str);
6668             } 
6669             
6670             SPAGAIN ;
6671             PUTBACK ;
6672             FREETMPS ;
6673             LEAVE ;
6674             
6675             if ( !sv_str || !SvOK(sv_str) ) {
6676                 vFAIL2("Constant(\\N{%s}): Call to &{$^H{charnames}} "
6677                       "did not return a defined value",SvPVX(sv_name));
6678             }
6679             if (hv_store_ent( RExC_charnames, sv_name, sv_str, 0))
6680                 cached = 1;
6681         }
6682     }
6683     if (valuep) {
6684         char *p = SvPV(sv_str, len);
6685         if (len) {
6686             STRLEN numlen = 1;
6687             if ( SvUTF8(sv_str) ) {
6688                 *valuep = utf8_to_uvchr((U8*)p, &numlen);
6689                 if (*valuep > 0x7F)
6690                     RExC_utf8 = 1; 
6691                 /* XXXX
6692                   We have to turn on utf8 for high bit chars otherwise
6693                   we get failures with
6694                   
6695                    "ss" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
6696                    "SS" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
6697                 
6698                   This is different from what \x{} would do with the same
6699                   codepoint, where the condition is > 0xFF.
6700                   - dmq
6701                 */
6702                 
6703                 
6704             } else {
6705                 *valuep = (UV)*p;
6706                 /* warn if we havent used the whole string? */
6707             }
6708             if (numlen<len && SIZE_ONLY && ckWARN(WARN_REGEXP)) {
6709                 vWARN2(RExC_parse,
6710                     "Ignoring excess chars from \\N{%s} in character class",
6711                     SvPVX(sv_name)
6712                 );
6713             }        
6714         } else if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
6715             vWARN2(RExC_parse,
6716                     "Ignoring zero length \\N{%s} in character class",
6717                     SvPVX(sv_name)
6718                 );
6719         }
6720         if (sv_name)    
6721             SvREFCNT_dec(sv_name);    
6722         if (!cached)
6723             SvREFCNT_dec(sv_str);    
6724         return len ? NULL : (regnode *)&len;
6725     } else if(SvCUR(sv_str)) {     
6726         
6727         char *s; 
6728         char *p, *pend;        
6729         STRLEN charlen = 1;
6730 #ifdef DEBUGGING
6731         char * parse_start = name-3; /* needed for the offsets */
6732 #endif
6733         GET_RE_DEBUG_FLAGS_DECL;     /* needed for the offsets */
6734         
6735         ret = reg_node(pRExC_state,
6736             (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
6737         s= STRING(ret);
6738         
6739         if ( RExC_utf8 && !SvUTF8(sv_str) ) {
6740             sv_utf8_upgrade(sv_str);
6741         } else if ( !RExC_utf8 && SvUTF8(sv_str) ) {
6742             RExC_utf8= 1;
6743         }
6744         
6745         p = SvPV(sv_str, len);
6746         pend = p + len;
6747         /* len is the length written, charlen is the size the char read */
6748         for ( len = 0; p < pend; p += charlen ) {
6749             if (UTF) {
6750                 UV uvc = utf8_to_uvchr((U8*)p, &charlen);
6751                 if (FOLD) {
6752                     STRLEN foldlen,numlen;
6753                     U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
6754                     uvc = toFOLD_uni(uvc, tmpbuf, &foldlen);
6755                     /* Emit all the Unicode characters. */
6756                     
6757                     for (foldbuf = tmpbuf;
6758                         foldlen;
6759                         foldlen -= numlen) 
6760                     {
6761                         uvc = utf8_to_uvchr(foldbuf, &numlen);
6762                         if (numlen > 0) {
6763                             const STRLEN unilen = reguni(pRExC_state, uvc, s);
6764                             s       += unilen;
6765                             len     += unilen;
6766                             /* In EBCDIC the numlen
6767                             * and unilen can differ. */
6768                             foldbuf += numlen;
6769                             if (numlen >= foldlen)
6770                                 break;
6771                         }
6772                         else
6773                             break; /* "Can't happen." */
6774                     }                          
6775                 } else {
6776                     const STRLEN unilen = reguni(pRExC_state, uvc, s);
6777                     if (unilen > 0) {
6778                        s   += unilen;
6779                        len += unilen;
6780                     }
6781                 }
6782             } else {
6783                 len++;
6784                 REGC(*p, s++);
6785             }
6786         }
6787         if (SIZE_ONLY) {
6788             RExC_size += STR_SZ(len);
6789         } else {
6790             STR_LEN(ret) = len;
6791             RExC_emit += STR_SZ(len);
6792         }
6793         Set_Node_Cur_Length(ret); /* MJD */
6794         RExC_parse--; 
6795         nextchar(pRExC_state);
6796     } else {
6797         ret = reg_node(pRExC_state,NOTHING);
6798     }
6799     if (!cached) {
6800         SvREFCNT_dec(sv_str);
6801     }
6802     if (sv_name) {
6803         SvREFCNT_dec(sv_name); 
6804     }
6805     return ret;
6806
6807 }
6808
6809
6810 /*
6811  * reg_recode
6812  *
6813  * It returns the code point in utf8 for the value in *encp.
6814  *    value: a code value in the source encoding
6815  *    encp:  a pointer to an Encode object
6816  *
6817  * If the result from Encode is not a single character,
6818  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
6819  */
6820 STATIC UV
6821 S_reg_recode(pTHX_ const char value, SV **encp)
6822 {
6823     STRLEN numlen = 1;
6824     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
6825     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
6826     const STRLEN newlen = SvCUR(sv);
6827     UV uv = UNICODE_REPLACEMENT;
6828
6829     PERL_ARGS_ASSERT_REG_RECODE;
6830
6831     if (newlen)
6832         uv = SvUTF8(sv)
6833              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
6834              : *(U8*)s;
6835
6836     if (!newlen || numlen != newlen) {
6837         uv = UNICODE_REPLACEMENT;
6838         *encp = NULL;
6839     }
6840     return uv;
6841 }
6842
6843
6844 /*
6845  - regatom - the lowest level
6846
6847    Try to identify anything special at the start of the pattern. If there
6848    is, then handle it as required. This may involve generating a single regop,
6849    such as for an assertion; or it may involve recursing, such as to
6850    handle a () structure.
6851
6852    If the string doesn't start with something special then we gobble up
6853    as much literal text as we can.
6854
6855    Once we have been able to handle whatever type of thing started the
6856    sequence, we return.
6857
6858    Note: we have to be careful with escapes, as they can be both literal
6859    and special, and in the case of \10 and friends can either, depending
6860    on context. Specifically there are two seperate switches for handling
6861    escape sequences, with the one for handling literal escapes requiring
6862    a dummy entry for all of the special escapes that are actually handled
6863    by the other.
6864 */
6865
6866 STATIC regnode *
6867 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
6868 {
6869     dVAR;
6870     register regnode *ret = NULL;
6871     I32 flags;
6872     char *parse_start = RExC_parse;
6873     GET_RE_DEBUG_FLAGS_DECL;
6874     DEBUG_PARSE("atom");
6875     *flagp = WORST;             /* Tentatively. */
6876
6877     PERL_ARGS_ASSERT_REGATOM;
6878
6879 tryagain:
6880     switch ((U8)*RExC_parse) {
6881     case '^':
6882         RExC_seen_zerolen++;
6883         nextchar(pRExC_state);
6884         if (RExC_flags & RXf_PMf_MULTILINE)
6885             ret = reg_node(pRExC_state, MBOL);
6886         else if (RExC_flags & RXf_PMf_SINGLELINE)
6887             ret = reg_node(pRExC_state, SBOL);
6888         else
6889             ret = reg_node(pRExC_state, BOL);
6890         Set_Node_Length(ret, 1); /* MJD */
6891         break;
6892     case '$':
6893         nextchar(pRExC_state);
6894         if (*RExC_parse)
6895             RExC_seen_zerolen++;
6896         if (RExC_flags & RXf_PMf_MULTILINE)
6897             ret = reg_node(pRExC_state, MEOL);
6898         else if (RExC_flags & RXf_PMf_SINGLELINE)
6899             ret = reg_node(pRExC_state, SEOL);
6900         else
6901             ret = reg_node(pRExC_state, EOL);
6902         Set_Node_Length(ret, 1); /* MJD */
6903         break;
6904     case '.':
6905         nextchar(pRExC_state);
6906         if (RExC_flags & RXf_PMf_SINGLELINE)
6907             ret = reg_node(pRExC_state, SANY);
6908         else
6909             ret = reg_node(pRExC_state, REG_ANY);
6910         *flagp |= HASWIDTH|SIMPLE;
6911         RExC_naughty++;
6912         Set_Node_Length(ret, 1); /* MJD */
6913         break;
6914     case '[':
6915     {
6916         char * const oregcomp_parse = ++RExC_parse;
6917         ret = regclass(pRExC_state,depth+1);
6918         if (*RExC_parse != ']') {
6919             RExC_parse = oregcomp_parse;
6920             vFAIL("Unmatched [");
6921         }
6922         nextchar(pRExC_state);
6923         *flagp |= HASWIDTH|SIMPLE;
6924         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
6925         break;
6926     }
6927     case '(':
6928         nextchar(pRExC_state);
6929         ret = reg(pRExC_state, 1, &flags,depth+1);
6930         if (ret == NULL) {
6931                 if (flags & TRYAGAIN) {
6932                     if (RExC_parse == RExC_end) {
6933                          /* Make parent create an empty node if needed. */
6934                         *flagp |= TRYAGAIN;
6935                         return(NULL);
6936                     }
6937                     goto tryagain;
6938                 }
6939                 return(NULL);
6940         }
6941         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
6942         break;
6943     case '|':
6944     case ')':
6945         if (flags & TRYAGAIN) {
6946             *flagp |= TRYAGAIN;
6947             return NULL;
6948         }
6949         vFAIL("Internal urp");
6950                                 /* Supposed to be caught earlier. */
6951         break;
6952     case '{':
6953         if (!regcurly(RExC_parse)) {
6954             RExC_parse++;
6955             goto defchar;
6956         }
6957         /* FALL THROUGH */
6958     case '?':
6959     case '+':
6960     case '*':
6961         RExC_parse++;
6962         vFAIL("Quantifier follows nothing");
6963         break;
6964     case 0xDF:
6965     case 0xC3:
6966     case 0xCE:
6967         do_foldchar:
6968         if (!LOC && FOLD) {
6969             U32 len,cp;
6970             len=0; /* silence a spurious compiler warning */
6971             if ((cp = what_len_TRICKYFOLD_safe(RExC_parse,RExC_end,UTF,len))) {
6972                 *flagp |= HASWIDTH; /* could be SIMPLE too, but needs a handler in regexec.regrepeat */
6973                 RExC_parse+=len-1; /* we get one from nextchar() as well. :-( */
6974                 ret = reganode(pRExC_state, FOLDCHAR, cp);
6975                 Set_Node_Length(ret, 1); /* MJD */
6976                 nextchar(pRExC_state); /* kill whitespace under /x */
6977                 return ret;
6978             }
6979         }
6980         goto outer_default;
6981     case '\\':
6982         /* Special Escapes
6983
6984            This switch handles escape sequences that resolve to some kind
6985            of special regop and not to literal text. Escape sequnces that
6986            resolve to literal text are handled below in the switch marked
6987            "Literal Escapes".
6988
6989            Every entry in this switch *must* have a corresponding entry
6990            in the literal escape switch. However, the opposite is not
6991            required, as the default for this switch is to jump to the
6992            literal text handling code.
6993         */
6994         switch ((U8)*++RExC_parse) {
6995         case 0xDF:
6996         case 0xC3:
6997         case 0xCE:
6998                    goto do_foldchar;        
6999         /* Special Escapes */
7000         case 'A':
7001             RExC_seen_zerolen++;
7002             ret = reg_node(pRExC_state, SBOL);
7003             *flagp |= SIMPLE;
7004             goto finish_meta_pat;
7005         case 'G':
7006             ret = reg_node(pRExC_state, GPOS);
7007             RExC_seen |= REG_SEEN_GPOS;
7008             *flagp |= SIMPLE;
7009             goto finish_meta_pat;
7010         case 'K':
7011             RExC_seen_zerolen++;
7012             ret = reg_node(pRExC_state, KEEPS);
7013             *flagp |= SIMPLE;
7014             /* XXX:dmq : disabling in-place substitution seems to
7015              * be necessary here to avoid cases of memory corruption, as
7016              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
7017              */
7018             RExC_seen |= REG_SEEN_LOOKBEHIND;
7019             goto finish_meta_pat;
7020         case 'Z':
7021             ret = reg_node(pRExC_state, SEOL);
7022             *flagp |= SIMPLE;
7023             RExC_seen_zerolen++;                /* Do not optimize RE away */
7024             goto finish_meta_pat;
7025         case 'z':
7026             ret = reg_node(pRExC_state, EOS);
7027             *flagp |= SIMPLE;
7028             RExC_seen_zerolen++;                /* Do not optimize RE away */
7029             goto finish_meta_pat;
7030         case 'C':
7031             ret = reg_node(pRExC_state, CANY);
7032             RExC_seen |= REG_SEEN_CANY;
7033             *flagp |= HASWIDTH|SIMPLE;
7034             goto finish_meta_pat;
7035         case 'X':
7036             ret = reg_node(pRExC_state, CLUMP);
7037             *flagp |= HASWIDTH;
7038             goto finish_meta_pat;
7039         case 'w':
7040             ret = reg_node(pRExC_state, (U8)(LOC ? ALNUML     : ALNUM));
7041             *flagp |= HASWIDTH|SIMPLE;
7042             goto finish_meta_pat;
7043         case 'W':
7044             ret = reg_node(pRExC_state, (U8)(LOC ? NALNUML    : NALNUM));
7045             *flagp |= HASWIDTH|SIMPLE;
7046             goto finish_meta_pat;
7047         case 'b':
7048             RExC_seen_zerolen++;
7049             RExC_seen |= REG_SEEN_LOOKBEHIND;
7050             ret = reg_node(pRExC_state, (U8)(LOC ? BOUNDL     : BOUND));
7051             *flagp |= SIMPLE;
7052             goto finish_meta_pat;
7053         case 'B':
7054             RExC_seen_zerolen++;
7055             RExC_seen |= REG_SEEN_LOOKBEHIND;
7056             ret = reg_node(pRExC_state, (U8)(LOC ? NBOUNDL    : NBOUND));
7057             *flagp |= SIMPLE;
7058             goto finish_meta_pat;
7059         case 's':
7060             ret = reg_node(pRExC_state, (U8)(LOC ? SPACEL     : SPACE));
7061             *flagp |= HASWIDTH|SIMPLE;
7062             goto finish_meta_pat;
7063         case 'S':
7064             ret = reg_node(pRExC_state, (U8)(LOC ? NSPACEL    : NSPACE));
7065             *flagp |= HASWIDTH|SIMPLE;
7066             goto finish_meta_pat;
7067         case 'd':
7068             ret = reg_node(pRExC_state, DIGIT);
7069             *flagp |= HASWIDTH|SIMPLE;
7070             goto finish_meta_pat;
7071         case 'D':
7072             ret = reg_node(pRExC_state, NDIGIT);
7073             *flagp |= HASWIDTH|SIMPLE;
7074             goto finish_meta_pat;
7075         case 'R':
7076             ret = reg_node(pRExC_state, LNBREAK);
7077             *flagp |= HASWIDTH|SIMPLE;
7078             goto finish_meta_pat;
7079         case 'h':
7080             ret = reg_node(pRExC_state, HORIZWS);
7081             *flagp |= HASWIDTH|SIMPLE;
7082             goto finish_meta_pat;
7083         case 'H':
7084             ret = reg_node(pRExC_state, NHORIZWS);
7085             *flagp |= HASWIDTH|SIMPLE;
7086             goto finish_meta_pat;
7087         case 'v':
7088             ret = reg_node(pRExC_state, VERTWS);
7089             *flagp |= HASWIDTH|SIMPLE;
7090             goto finish_meta_pat;
7091         case 'V':
7092             ret = reg_node(pRExC_state, NVERTWS);
7093             *flagp |= HASWIDTH|SIMPLE;
7094          finish_meta_pat:           
7095             nextchar(pRExC_state);
7096             Set_Node_Length(ret, 2); /* MJD */
7097             break;          
7098         case 'p':
7099         case 'P':
7100             {   
7101                 char* const oldregxend = RExC_end;
7102 #ifdef DEBUGGING
7103                 char* parse_start = RExC_parse - 2;
7104 #endif
7105
7106                 if (RExC_parse[1] == '{') {
7107                   /* a lovely hack--pretend we saw [\pX] instead */
7108                     RExC_end = strchr(RExC_parse, '}');
7109                     if (!RExC_end) {
7110                         const U8 c = (U8)*RExC_parse;
7111                         RExC_parse += 2;
7112                         RExC_end = oldregxend;
7113                         vFAIL2("Missing right brace on \\%c{}", c);
7114                     }
7115                     RExC_end++;
7116                 }
7117                 else {
7118                     RExC_end = RExC_parse + 2;
7119                     if (RExC_end > oldregxend)
7120                         RExC_end = oldregxend;
7121                 }
7122                 RExC_parse--;
7123
7124                 ret = regclass(pRExC_state,depth+1);
7125
7126                 RExC_end = oldregxend;
7127                 RExC_parse--;
7128
7129                 Set_Node_Offset(ret, parse_start + 2);
7130                 Set_Node_Cur_Length(ret);
7131                 nextchar(pRExC_state);
7132                 *flagp |= HASWIDTH|SIMPLE;
7133             }
7134             break;
7135         case 'N': 
7136             /* Handle \N{NAME} here and not below because it can be 
7137             multicharacter. join_exact() will join them up later on. 
7138             Also this makes sure that things like /\N{BLAH}+/ and 
7139             \N{BLAH} being multi char Just Happen. dmq*/
7140             ++RExC_parse;
7141             ret= reg_namedseq(pRExC_state, NULL); 
7142             break;
7143         case 'k':    /* Handle \k<NAME> and \k'NAME' */
7144         parse_named_seq:
7145         {   
7146             char ch= RExC_parse[1];         
7147             if (ch != '<' && ch != '\'' && ch != '{') {
7148                 RExC_parse++;
7149                 vFAIL2("Sequence %.2s... not terminated",parse_start);
7150             } else {
7151                 /* this pretty much dupes the code for (?P=...) in reg(), if
7152                    you change this make sure you change that */
7153                 char* name_start = (RExC_parse += 2);
7154                 U32 num = 0;
7155                 SV *sv_dat = reg_scan_name(pRExC_state,
7156                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7157                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
7158                 if (RExC_parse == name_start || *RExC_parse != ch)
7159                     vFAIL2("Sequence %.3s... not terminated",parse_start);
7160
7161                 if (!SIZE_ONLY) {
7162                     num = add_data( pRExC_state, 1, "S" );
7163                     RExC_rxi->data->data[num]=(void*)sv_dat;
7164                     SvREFCNT_inc_simple_void(sv_dat);
7165                 }
7166
7167                 RExC_sawback = 1;
7168                 ret = reganode(pRExC_state,
7169                            (U8)(FOLD ? (LOC ? NREFFL : NREFF) : NREF),
7170                            num);
7171                 *flagp |= HASWIDTH;
7172
7173                 /* override incorrect value set in reganode MJD */
7174                 Set_Node_Offset(ret, parse_start+1);
7175                 Set_Node_Cur_Length(ret); /* MJD */
7176                 nextchar(pRExC_state);
7177
7178             }
7179             break;
7180         }
7181         case 'g': 
7182         case '1': case '2': case '3': case '4':
7183         case '5': case '6': case '7': case '8': case '9':
7184             {
7185                 I32 num;
7186                 bool isg = *RExC_parse == 'g';
7187                 bool isrel = 0; 
7188                 bool hasbrace = 0;
7189                 if (isg) {
7190                     RExC_parse++;
7191                     if (*RExC_parse == '{') {
7192                         RExC_parse++;
7193                         hasbrace = 1;
7194                     }
7195                     if (*RExC_parse == '-') {
7196                         RExC_parse++;
7197                         isrel = 1;
7198                     }
7199                     if (hasbrace && !isDIGIT(*RExC_parse)) {
7200                         if (isrel) RExC_parse--;
7201                         RExC_parse -= 2;                            
7202                         goto parse_named_seq;
7203                 }   }
7204                 num = atoi(RExC_parse);
7205                 if (isg && num == 0)
7206                     vFAIL("Reference to invalid group 0");
7207                 if (isrel) {
7208                     num = RExC_npar - num;
7209                     if (num < 1)
7210                         vFAIL("Reference to nonexistent or unclosed group");
7211                 }
7212                 if (!isg && num > 9 && num >= RExC_npar)
7213                     goto defchar;
7214                 else {
7215                     char * const parse_start = RExC_parse - 1; /* MJD */
7216                     while (isDIGIT(*RExC_parse))
7217                         RExC_parse++;
7218                     if (parse_start == RExC_parse - 1) 
7219                         vFAIL("Unterminated \\g... pattern");
7220                     if (hasbrace) {
7221                         if (*RExC_parse != '}') 
7222                             vFAIL("Unterminated \\g{...} pattern");
7223                         RExC_parse++;
7224                     }    
7225                     if (!SIZE_ONLY) {
7226                         if (num > (I32)RExC_rx->nparens)
7227                             vFAIL("Reference to nonexistent group");
7228                     }
7229                     RExC_sawback = 1;
7230                     ret = reganode(pRExC_state,
7231                                    (U8)(FOLD ? (LOC ? REFFL : REFF) : REF),
7232                                    num);
7233                     *flagp |= HASWIDTH;
7234
7235                     /* override incorrect value set in reganode MJD */
7236                     Set_Node_Offset(ret, parse_start+1);
7237                     Set_Node_Cur_Length(ret); /* MJD */
7238                     RExC_parse--;
7239                     nextchar(pRExC_state);
7240                 }
7241             }
7242             break;
7243         case '\0':
7244             if (RExC_parse >= RExC_end)
7245                 FAIL("Trailing \\");
7246             /* FALL THROUGH */
7247         default:
7248             /* Do not generate "unrecognized" warnings here, we fall
7249                back into the quick-grab loop below */
7250             parse_start--;
7251             goto defchar;
7252         }
7253         break;
7254
7255     case '#':
7256         if (RExC_flags & RXf_PMf_EXTENDED) {
7257             if ( reg_skipcomment( pRExC_state ) )
7258                 goto tryagain;
7259         }
7260         /* FALL THROUGH */
7261
7262     default:
7263         outer_default:{
7264             register STRLEN len;
7265             register UV ender;
7266             register char *p;
7267             char *s;
7268             STRLEN foldlen;
7269             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
7270
7271             parse_start = RExC_parse - 1;
7272
7273             RExC_parse++;
7274
7275         defchar:
7276             ender = 0;
7277             ret = reg_node(pRExC_state,
7278                            (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
7279             s = STRING(ret);
7280             for (len = 0, p = RExC_parse - 1;
7281               len < 127 && p < RExC_end;
7282               len++)
7283             {
7284                 char * const oldp = p;
7285
7286                 if (RExC_flags & RXf_PMf_EXTENDED)
7287                     p = regwhite( pRExC_state, p );
7288                 switch ((U8)*p) {
7289                 case 0xDF:
7290                 case 0xC3:
7291                 case 0xCE:
7292                            if (LOC || !FOLD || !is_TRICKYFOLD_safe(p,RExC_end,UTF))
7293                                 goto normal_default;
7294                 case '^':
7295                 case '$':
7296                 case '.':
7297                 case '[':
7298                 case '(':
7299                 case ')':
7300                 case '|':
7301                     goto loopdone;
7302                 case '\\':
7303                     /* Literal Escapes Switch
7304
7305                        This switch is meant to handle escape sequences that
7306                        resolve to a literal character.
7307
7308                        Every escape sequence that represents something
7309                        else, like an assertion or a char class, is handled
7310                        in the switch marked 'Special Escapes' above in this
7311                        routine, but also has an entry here as anything that
7312                        isn't explicitly mentioned here will be treated as
7313                        an unescaped equivalent literal.
7314                     */
7315
7316                     switch ((U8)*++p) {
7317                     /* These are all the special escapes. */
7318                     case 0xDF:
7319                     case 0xC3:
7320                     case 0xCE:
7321                            if (LOC || !FOLD || !is_TRICKYFOLD_safe(p,RExC_end,UTF))
7322                                 goto normal_default;                
7323                     case 'A':             /* Start assertion */
7324                     case 'b': case 'B':   /* Word-boundary assertion*/
7325                     case 'C':             /* Single char !DANGEROUS! */
7326                     case 'd': case 'D':   /* digit class */
7327                     case 'g': case 'G':   /* generic-backref, pos assertion */
7328                     case 'h': case 'H':   /* HORIZWS */
7329                     case 'k': case 'K':   /* named backref, keep marker */
7330                     case 'N':             /* named char sequence */
7331                     case 'p': case 'P':   /* Unicode property */
7332                               case 'R':   /* LNBREAK */
7333                     case 's': case 'S':   /* space class */
7334                     case 'v': case 'V':   /* VERTWS */
7335                     case 'w': case 'W':   /* word class */
7336                     case 'X':             /* eXtended Unicode "combining character sequence" */
7337                     case 'z': case 'Z':   /* End of line/string assertion */
7338                         --p;
7339                         goto loopdone;
7340
7341                     /* Anything after here is an escape that resolves to a
7342                        literal. (Except digits, which may or may not)
7343                      */
7344                     case 'n':
7345                         ender = '\n';
7346                         p++;
7347                         break;
7348                     case 'r':
7349                         ender = '\r';
7350                         p++;
7351                         break;
7352                     case 't':
7353                         ender = '\t';
7354                         p++;
7355                         break;
7356                     case 'f':
7357                         ender = '\f';
7358                         p++;
7359                         break;
7360                     case 'e':
7361                           ender = ASCII_TO_NATIVE('\033');
7362                         p++;
7363                         break;
7364                     case 'a':
7365                           ender = ASCII_TO_NATIVE('\007');
7366                         p++;
7367                         break;
7368                     case 'x':
7369                         if (*++p == '{') {
7370                             char* const e = strchr(p, '}');
7371         
7372                             if (!e) {
7373                                 RExC_parse = p + 1;
7374                                 vFAIL("Missing right brace on \\x{}");
7375                             }
7376                             else {
7377                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
7378                                     | PERL_SCAN_DISALLOW_PREFIX;
7379                                 STRLEN numlen = e - p - 1;
7380                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
7381                                 if (ender > 0xff)
7382                                     RExC_utf8 = 1;
7383                                 p = e + 1;
7384                             }
7385                         }
7386                         else {
7387                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
7388                             STRLEN numlen = 2;
7389                             ender = grok_hex(p, &numlen, &flags, NULL);
7390                             p += numlen;
7391                         }
7392                         if (PL_encoding && ender < 0x100)
7393                             goto recode_encoding;
7394                         break;
7395                     case 'c':
7396                         p++;
7397                         ender = UCHARAT(p++);
7398                         ender = toCTRL(ender);
7399                         break;
7400                     case '0': case '1': case '2': case '3':case '4':
7401                     case '5': case '6': case '7': case '8':case '9':
7402                         if (*p == '0' ||
7403                           (isDIGIT(p[1]) && atoi(p) >= RExC_npar) ) {
7404                             I32 flags = 0;
7405                             STRLEN numlen = 3;
7406                             ender = grok_oct(p, &numlen, &flags, NULL);
7407                             p += numlen;
7408                         }
7409                         else {
7410                             --p;
7411                             goto loopdone;
7412                         }
7413                         if (PL_encoding && ender < 0x100)
7414                             goto recode_encoding;
7415                         break;
7416                     recode_encoding:
7417                         {
7418                             SV* enc = PL_encoding;
7419                             ender = reg_recode((const char)(U8)ender, &enc);
7420                             if (!enc && SIZE_ONLY && ckWARN(WARN_REGEXP))
7421                                 vWARN(p, "Invalid escape in the specified encoding");
7422                             RExC_utf8 = 1;
7423                         }
7424                         break;
7425                     case '\0':
7426                         if (p >= RExC_end)
7427                             FAIL("Trailing \\");
7428                         /* FALL THROUGH */
7429                     default:
7430                         if (!SIZE_ONLY&& isALPHA(*p) && ckWARN(WARN_REGEXP))
7431                             vWARN2(p + 1, "Unrecognized escape \\%c passed through", UCHARAT(p));
7432                         goto normal_default;
7433                     }
7434                     break;
7435                 default:
7436                   normal_default:
7437                     if (UTF8_IS_START(*p) && UTF) {
7438                         STRLEN numlen;
7439                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
7440                                                &numlen, UTF8_ALLOW_DEFAULT);
7441                         p += numlen;
7442                     }
7443                     else
7444                         ender = *p++;
7445                     break;
7446                 }
7447                 if ( RExC_flags & RXf_PMf_EXTENDED)
7448                     p = regwhite( pRExC_state, p );
7449                 if (UTF && FOLD) {
7450                     /* Prime the casefolded buffer. */
7451                     ender = toFOLD_uni(ender, tmpbuf, &foldlen);
7452                 }
7453                 if (p < RExC_end && ISMULT2(p)) { /* Back off on ?+*. */
7454                     if (len)
7455                         p = oldp;
7456                     else if (UTF) {
7457                          if (FOLD) {
7458                               /* Emit all the Unicode characters. */
7459                               STRLEN numlen;
7460                               for (foldbuf = tmpbuf;
7461                                    foldlen;
7462                                    foldlen -= numlen) {
7463                                    ender = utf8_to_uvchr(foldbuf, &numlen);
7464                                    if (numlen > 0) {
7465                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
7466                                         s       += unilen;
7467                                         len     += unilen;
7468                                         /* In EBCDIC the numlen
7469                                          * and unilen can differ. */
7470                                         foldbuf += numlen;
7471                                         if (numlen >= foldlen)
7472                                              break;
7473                                    }
7474                                    else
7475                                         break; /* "Can't happen." */
7476                               }
7477                          }
7478                          else {
7479                               const STRLEN unilen = reguni(pRExC_state, ender, s);
7480                               if (unilen > 0) {
7481                                    s   += unilen;
7482                                    len += unilen;
7483                               }
7484                          }
7485                     }
7486                     else {
7487                         len++;
7488                         REGC((char)ender, s++);
7489                     }
7490                     break;
7491                 }
7492                 if (UTF) {
7493                      if (FOLD) {
7494                           /* Emit all the Unicode characters. */
7495                           STRLEN numlen;
7496                           for (foldbuf = tmpbuf;
7497                                foldlen;
7498                                foldlen -= numlen) {
7499                                ender = utf8_to_uvchr(foldbuf, &numlen);
7500                                if (numlen > 0) {
7501                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
7502                                     len     += unilen;
7503                                     s       += unilen;
7504                                     /* In EBCDIC the numlen
7505                                      * and unilen can differ. */
7506                                     foldbuf += numlen;
7507                                     if (numlen >= foldlen)
7508                                          break;
7509                                }
7510                                else
7511                                     break;
7512                           }
7513                      }
7514                      else {
7515                           const STRLEN unilen = reguni(pRExC_state, ender, s);
7516                           if (unilen > 0) {
7517                                s   += unilen;
7518                                len += unilen;
7519                           }
7520                      }
7521                      len--;
7522                 }
7523                 else
7524                     REGC((char)ender, s++);
7525             }
7526         loopdone:
7527             RExC_parse = p - 1;
7528             Set_Node_Cur_Length(ret); /* MJD */
7529             nextchar(pRExC_state);
7530             {
7531                 /* len is STRLEN which is unsigned, need to copy to signed */
7532                 IV iv = len;
7533                 if (iv < 0)
7534                     vFAIL("Internal disaster");
7535             }
7536             if (len > 0)
7537                 *flagp |= HASWIDTH;
7538             if (len == 1 && UNI_IS_INVARIANT(ender))
7539                 *flagp |= SIMPLE;
7540                 
7541             if (SIZE_ONLY)
7542                 RExC_size += STR_SZ(len);
7543             else {
7544                 STR_LEN(ret) = len;
7545                 RExC_emit += STR_SZ(len);
7546             }
7547         }
7548         break;
7549     }
7550
7551     return(ret);
7552 }
7553
7554 STATIC char *
7555 S_regwhite( RExC_state_t *pRExC_state, char *p )
7556 {
7557     const char *e = RExC_end;
7558
7559     PERL_ARGS_ASSERT_REGWHITE;
7560
7561     while (p < e) {
7562         if (isSPACE(*p))
7563             ++p;
7564         else if (*p == '#') {
7565             bool ended = 0;
7566             do {
7567                 if (*p++ == '\n') {
7568                     ended = 1;
7569                     break;
7570                 }
7571             } while (p < e);
7572             if (!ended)
7573                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
7574         }
7575         else
7576             break;
7577     }
7578     return p;
7579 }
7580
7581 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
7582    Character classes ([:foo:]) can also be negated ([:^foo:]).
7583    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
7584    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
7585    but trigger failures because they are currently unimplemented. */
7586
7587 #define POSIXCC_DONE(c)   ((c) == ':')
7588 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
7589 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
7590
7591 STATIC I32
7592 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
7593 {
7594     dVAR;
7595     I32 namedclass = OOB_NAMEDCLASS;
7596
7597     PERL_ARGS_ASSERT_REGPPOSIXCC;
7598
7599     if (value == '[' && RExC_parse + 1 < RExC_end &&
7600         /* I smell either [: or [= or [. -- POSIX has been here, right? */
7601         POSIXCC(UCHARAT(RExC_parse))) {
7602         const char c = UCHARAT(RExC_parse);
7603         char* const s = RExC_parse++;
7604         
7605         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
7606             RExC_parse++;
7607         if (RExC_parse == RExC_end)
7608             /* Grandfather lone [:, [=, [. */
7609             RExC_parse = s;
7610         else {
7611             const char* const t = RExC_parse++; /* skip over the c */
7612             assert(*t == c);
7613
7614             if (UCHARAT(RExC_parse) == ']') {
7615                 const char *posixcc = s + 1;
7616                 RExC_parse++; /* skip over the ending ] */
7617
7618                 if (*s == ':') {
7619                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
7620                     const I32 skip = t - posixcc;
7621
7622                     /* Initially switch on the length of the name.  */
7623                     switch (skip) {
7624                     case 4:
7625                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
7626                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
7627                         break;
7628                     case 5:
7629                         /* Names all of length 5.  */
7630                         /* alnum alpha ascii blank cntrl digit graph lower
7631                            print punct space upper  */
7632                         /* Offset 4 gives the best switch position.  */
7633                         switch (posixcc[4]) {
7634                         case 'a':
7635                             if (memEQ(posixcc, "alph", 4)) /* alpha */
7636                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
7637                             break;
7638                         case 'e':
7639                             if (memEQ(posixcc, "spac", 4)) /* space */
7640                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
7641                             break;
7642                         case 'h':
7643                             if (memEQ(posixcc, "grap", 4)) /* graph */
7644                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
7645                             break;
7646                         case 'i':
7647                             if (memEQ(posixcc, "asci", 4)) /* ascii */
7648                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
7649                             break;
7650                         case 'k':
7651                             if (memEQ(posixcc, "blan", 4)) /* blank */
7652                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
7653                             break;
7654                         case 'l':
7655                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
7656                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
7657                             break;
7658                         case 'm':
7659                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
7660                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
7661                             break;
7662                         case 'r':
7663                             if (memEQ(posixcc, "lowe", 4)) /* lower */
7664                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
7665                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
7666                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
7667                             break;
7668                         case 't':
7669                             if (memEQ(posixcc, "digi", 4)) /* digit */
7670                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
7671                             else if (memEQ(posixcc, "prin", 4)) /* print */
7672                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
7673                             else if (memEQ(posixcc, "punc", 4)) /* punct */
7674                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
7675                             break;
7676                         }
7677                         break;
7678                     case 6:
7679                         if (memEQ(posixcc, "xdigit", 6))
7680                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
7681                         break;
7682                     }
7683
7684                     if (namedclass == OOB_NAMEDCLASS)
7685                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
7686                                       t - s - 1, s + 1);
7687                     assert (posixcc[skip] == ':');
7688                     assert (posixcc[skip+1] == ']');
7689                 } else if (!SIZE_ONLY) {
7690                     /* [[=foo=]] and [[.foo.]] are still future. */
7691
7692                     /* adjust RExC_parse so the warning shows after
7693                        the class closes */
7694                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
7695                         RExC_parse++;
7696                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
7697                 }
7698             } else {
7699                 /* Maternal grandfather:
7700                  * "[:" ending in ":" but not in ":]" */
7701                 RExC_parse = s;
7702             }
7703         }
7704     }
7705
7706     return namedclass;
7707 }
7708
7709 STATIC void
7710 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
7711 {
7712     dVAR;
7713
7714     PERL_ARGS_ASSERT_CHECKPOSIXCC;
7715
7716     if (POSIXCC(UCHARAT(RExC_parse))) {
7717         const char *s = RExC_parse;
7718         const char  c = *s++;
7719
7720         while (isALNUM(*s))
7721             s++;
7722         if (*s && c == *s && s[1] == ']') {
7723             if (ckWARN(WARN_REGEXP))
7724                 vWARN3(s+2,
7725                         "POSIX syntax [%c %c] belongs inside character classes",
7726                         c, c);
7727
7728             /* [[=foo=]] and [[.foo.]] are still future. */
7729             if (POSIXCC_NOTYET(c)) {
7730                 /* adjust RExC_parse so the error shows after
7731                    the class closes */
7732                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
7733                     NOOP;
7734                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
7735             }
7736         }
7737     }
7738 }
7739
7740
7741 #define _C_C_T_(NAME,TEST,WORD)                         \
7742 ANYOF_##NAME:                                           \
7743     if (LOC)                                            \
7744         ANYOF_CLASS_SET(ret, ANYOF_##NAME);             \
7745     else {                                              \
7746         for (value = 0; value < 256; value++)           \
7747             if (TEST)                                   \
7748                 ANYOF_BITMAP_SET(ret, value);           \
7749     }                                                   \
7750     yesno = '+';                                        \
7751     what = WORD;                                        \
7752     break;                                              \
7753 case ANYOF_N##NAME:                                     \
7754     if (LOC)                                            \
7755         ANYOF_CLASS_SET(ret, ANYOF_N##NAME);            \
7756     else {                                              \
7757         for (value = 0; value < 256; value++)           \
7758             if (!TEST)                                  \
7759                 ANYOF_BITMAP_SET(ret, value);           \
7760     }                                                   \
7761     yesno = '!';                                        \
7762     what = WORD;                                        \
7763     break
7764
7765 #define _C_C_T_NOLOC_(NAME,TEST,WORD)                   \
7766 ANYOF_##NAME:                                           \
7767         for (value = 0; value < 256; value++)           \
7768             if (TEST)                                   \
7769                 ANYOF_BITMAP_SET(ret, value);           \
7770     yesno = '+';                                        \
7771     what = WORD;                                        \
7772     break;                                              \
7773 case ANYOF_N##NAME:                                     \
7774         for (value = 0; value < 256; value++)           \
7775             if (!TEST)                                  \
7776                 ANYOF_BITMAP_SET(ret, value);           \
7777     yesno = '!';                                        \
7778     what = WORD;                                        \
7779     break
7780
7781 /*
7782    parse a class specification and produce either an ANYOF node that
7783    matches the pattern or if the pattern matches a single char only and
7784    that char is < 256 and we are case insensitive then we produce an 
7785    EXACT node instead.
7786 */
7787
7788 STATIC regnode *
7789 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
7790 {
7791     dVAR;
7792     register UV nextvalue;
7793     register IV prevvalue = OOB_UNICODE;
7794     register IV range = 0;
7795     UV value = 0; /* XXX:dmq: needs to be referenceable (unfortunately) */
7796     register regnode *ret;
7797     STRLEN numlen;
7798     IV namedclass;
7799     char *rangebegin = NULL;
7800     bool need_class = 0;
7801     SV *listsv = NULL;
7802     UV n;
7803     bool optimize_invert   = TRUE;
7804     AV* unicode_alternate  = NULL;
7805 #ifdef EBCDIC
7806     UV literal_endpoint = 0;
7807 #endif
7808     UV stored = 0;  /* number of chars stored in the class */
7809
7810     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
7811         case we need to change the emitted regop to an EXACT. */
7812     const char * orig_parse = RExC_parse;
7813     GET_RE_DEBUG_FLAGS_DECL;
7814
7815     PERL_ARGS_ASSERT_REGCLASS;
7816 #ifndef DEBUGGING
7817     PERL_UNUSED_ARG(depth);
7818 #endif
7819
7820     DEBUG_PARSE("clas");
7821
7822     /* Assume we are going to generate an ANYOF node. */
7823     ret = reganode(pRExC_state, ANYOF, 0);
7824
7825     if (!SIZE_ONLY)
7826         ANYOF_FLAGS(ret) = 0;
7827
7828     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
7829         RExC_naughty++;
7830         RExC_parse++;
7831         if (!SIZE_ONLY)
7832             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
7833     }
7834
7835     if (SIZE_ONLY) {
7836         RExC_size += ANYOF_SKIP;
7837         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
7838     }
7839     else {
7840         RExC_emit += ANYOF_SKIP;
7841         if (FOLD)
7842             ANYOF_FLAGS(ret) |= ANYOF_FOLD;
7843         if (LOC)
7844             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
7845         ANYOF_BITMAP_ZERO(ret);
7846         listsv = newSVpvs("# comment\n");
7847     }
7848
7849     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
7850
7851     if (!SIZE_ONLY && POSIXCC(nextvalue))
7852         checkposixcc(pRExC_state);
7853
7854     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
7855     if (UCHARAT(RExC_parse) == ']')
7856         goto charclassloop;
7857
7858 parseit:
7859     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
7860
7861     charclassloop:
7862
7863         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
7864
7865         if (!range)
7866             rangebegin = RExC_parse;
7867         if (UTF) {
7868             value = utf8n_to_uvchr((U8*)RExC_parse,
7869                                    RExC_end - RExC_parse,
7870                                    &numlen, UTF8_ALLOW_DEFAULT);
7871             RExC_parse += numlen;
7872         }
7873         else
7874             value = UCHARAT(RExC_parse++);
7875
7876         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
7877         if (value == '[' && POSIXCC(nextvalue))
7878             namedclass = regpposixcc(pRExC_state, value);
7879         else if (value == '\\') {
7880             if (UTF) {
7881                 value = utf8n_to_uvchr((U8*)RExC_parse,
7882                                    RExC_end - RExC_parse,
7883                                    &numlen, UTF8_ALLOW_DEFAULT);
7884                 RExC_parse += numlen;
7885             }
7886             else
7887                 value = UCHARAT(RExC_parse++);
7888             /* Some compilers cannot handle switching on 64-bit integer
7889              * values, therefore value cannot be an UV.  Yes, this will
7890              * be a problem later if we want switch on Unicode.
7891              * A similar issue a little bit later when switching on
7892              * namedclass. --jhi */
7893             switch ((I32)value) {
7894             case 'w':   namedclass = ANYOF_ALNUM;       break;
7895             case 'W':   namedclass = ANYOF_NALNUM;      break;
7896             case 's':   namedclass = ANYOF_SPACE;       break;
7897             case 'S':   namedclass = ANYOF_NSPACE;      break;
7898             case 'd':   namedclass = ANYOF_DIGIT;       break;
7899             case 'D':   namedclass = ANYOF_NDIGIT;      break;
7900             case 'v':   namedclass = ANYOF_VERTWS;      break;
7901             case 'V':   namedclass = ANYOF_NVERTWS;     break;
7902             case 'h':   namedclass = ANYOF_HORIZWS;     break;
7903             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
7904             case 'N':  /* Handle \N{NAME} in class */
7905                 {
7906                     /* We only pay attention to the first char of 
7907                     multichar strings being returned. I kinda wonder
7908                     if this makes sense as it does change the behaviour
7909                     from earlier versions, OTOH that behaviour was broken
7910                     as well. */
7911                     UV v; /* value is register so we cant & it /grrr */
7912                     if (reg_namedseq(pRExC_state, &v)) {
7913                         goto parseit;
7914                     }
7915                     value= v; 
7916                 }
7917                 break;
7918             case 'p':
7919             case 'P':
7920                 {
7921                 char *e;
7922                 if (RExC_parse >= RExC_end)
7923                     vFAIL2("Empty \\%c{}", (U8)value);
7924                 if (*RExC_parse == '{') {
7925                     const U8 c = (U8)value;
7926                     e = strchr(RExC_parse++, '}');
7927                     if (!e)
7928                         vFAIL2("Missing right brace on \\%c{}", c);
7929                     while (isSPACE(UCHARAT(RExC_parse)))
7930                         RExC_parse++;
7931                     if (e == RExC_parse)
7932                         vFAIL2("Empty \\%c{}", c);
7933                     n = e - RExC_parse;
7934                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
7935                         n--;
7936                 }
7937                 else {
7938                     e = RExC_parse;
7939                     n = 1;
7940                 }
7941                 if (!SIZE_ONLY) {
7942                     if (UCHARAT(RExC_parse) == '^') {
7943                          RExC_parse++;
7944                          n--;
7945                          value = value == 'p' ? 'P' : 'p'; /* toggle */
7946                          while (isSPACE(UCHARAT(RExC_parse))) {
7947                               RExC_parse++;
7948                               n--;
7949                          }
7950                     }
7951                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%.*s\n",
7952                         (value=='p' ? '+' : '!'), (int)n, RExC_parse);
7953                 }
7954                 RExC_parse = e + 1;
7955                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
7956                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
7957                 }
7958                 break;
7959             case 'n':   value = '\n';                   break;
7960             case 'r':   value = '\r';                   break;
7961             case 't':   value = '\t';                   break;
7962             case 'f':   value = '\f';                   break;
7963             case 'b':   value = '\b';                   break;
7964             case 'e':   value = ASCII_TO_NATIVE('\033');break;
7965             case 'a':   value = ASCII_TO_NATIVE('\007');break;
7966             case 'x':
7967                 if (*RExC_parse == '{') {
7968                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
7969                         | PERL_SCAN_DISALLOW_PREFIX;
7970                     char * const e = strchr(RExC_parse++, '}');
7971                     if (!e)
7972                         vFAIL("Missing right brace on \\x{}");
7973
7974                     numlen = e - RExC_parse;
7975                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
7976                     RExC_parse = e + 1;
7977                 }
7978                 else {
7979                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
7980                     numlen = 2;
7981                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
7982                     RExC_parse += numlen;
7983                 }
7984                 if (PL_encoding && value < 0x100)
7985                     goto recode_encoding;
7986                 break;
7987             case 'c':
7988                 value = UCHARAT(RExC_parse++);
7989                 value = toCTRL(value);
7990                 break;
7991             case '0': case '1': case '2': case '3': case '4':
7992             case '5': case '6': case '7': case '8': case '9':
7993                 {
7994                     I32 flags = 0;
7995                     numlen = 3;
7996                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
7997                     RExC_parse += numlen;
7998                     if (PL_encoding && value < 0x100)
7999                         goto recode_encoding;
8000                     break;
8001                 }
8002             recode_encoding:
8003                 {
8004                     SV* enc = PL_encoding;
8005                     value = reg_recode((const char)(U8)value, &enc);
8006                     if (!enc && SIZE_ONLY && ckWARN(WARN_REGEXP))
8007                         vWARN(RExC_parse,
8008                               "Invalid escape in the specified encoding");
8009                     break;
8010                 }
8011             default:
8012                 if (!SIZE_ONLY && isALPHA(value) && ckWARN(WARN_REGEXP))
8013                     vWARN2(RExC_parse,
8014                            "Unrecognized escape \\%c in character class passed through",
8015                            (int)value);
8016                 break;
8017             }
8018         } /* end of \blah */
8019 #ifdef EBCDIC
8020         else
8021             literal_endpoint++;
8022 #endif
8023
8024         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
8025
8026             if (!SIZE_ONLY && !need_class)
8027                 ANYOF_CLASS_ZERO(ret);
8028
8029             need_class = 1;
8030
8031             /* a bad range like a-\d, a-[:digit:] ? */
8032             if (range) {
8033                 if (!SIZE_ONLY) {
8034                     if (ckWARN(WARN_REGEXP)) {
8035                         const int w =
8036                             RExC_parse >= rangebegin ?
8037                             RExC_parse - rangebegin : 0;
8038                         vWARN4(RExC_parse,
8039                                "False [] range \"%*.*s\"",
8040                                w, w, rangebegin);
8041                     }
8042                     if (prevvalue < 256) {
8043                         ANYOF_BITMAP_SET(ret, prevvalue);
8044                         ANYOF_BITMAP_SET(ret, '-');
8045                     }
8046                     else {
8047                         ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
8048                         Perl_sv_catpvf(aTHX_ listsv,
8049                                        "%04"UVxf"\n%04"UVxf"\n", (UV)prevvalue, (UV) '-');
8050                     }
8051                 }
8052
8053                 range = 0; /* this was not a true range */
8054             }
8055
8056
8057     
8058             if (!SIZE_ONLY) {
8059                 const char *what = NULL;
8060                 char yesno = 0;
8061
8062                 if (namedclass > OOB_NAMEDCLASS)
8063                     optimize_invert = FALSE;
8064                 /* Possible truncation here but in some 64-bit environments
8065                  * the compiler gets heartburn about switch on 64-bit values.
8066                  * A similar issue a little earlier when switching on value.
8067                  * --jhi */
8068                 switch ((I32)namedclass) {
8069                 case _C_C_T_(ALNUM, isALNUM(value), "Word");
8070                 case _C_C_T_(ALNUMC, isALNUMC(value), "Alnum");
8071                 case _C_C_T_(ALPHA, isALPHA(value), "Alpha");
8072                 case _C_C_T_(BLANK, isBLANK(value), "Blank");
8073                 case _C_C_T_(CNTRL, isCNTRL(value), "Cntrl");
8074                 case _C_C_T_(GRAPH, isGRAPH(value), "Graph");
8075                 case _C_C_T_(LOWER, isLOWER(value), "Lower");
8076                 case _C_C_T_(PRINT, isPRINT(value), "Print");
8077                 case _C_C_T_(PSXSPC, isPSXSPC(value), "Space");
8078                 case _C_C_T_(PUNCT, isPUNCT(value), "Punct");
8079                 case _C_C_T_(SPACE, isSPACE(value), "SpacePerl");
8080                 case _C_C_T_(UPPER, isUPPER(value), "Upper");
8081                 case _C_C_T_(XDIGIT, isXDIGIT(value), "XDigit");
8082                 case _C_C_T_NOLOC_(VERTWS, is_VERTWS_latin1(&value), "VertSpace");
8083                 case _C_C_T_NOLOC_(HORIZWS, is_HORIZWS_latin1(&value), "HorizSpace");
8084                 case ANYOF_ASCII:
8085                     if (LOC)
8086                         ANYOF_CLASS_SET(ret, ANYOF_ASCII);
8087                     else {
8088 #ifndef EBCDIC
8089                         for (value = 0; value < 128; value++)
8090                             ANYOF_BITMAP_SET(ret, value);
8091 #else  /* EBCDIC */
8092                         for (value = 0; value < 256; value++) {
8093                             if (isASCII(value))
8094                                 ANYOF_BITMAP_SET(ret, value);
8095                         }
8096 #endif /* EBCDIC */
8097                     }
8098                     yesno = '+';
8099                     what = "ASCII";
8100                     break;
8101                 case ANYOF_NASCII:
8102                     if (LOC)
8103                         ANYOF_CLASS_SET(ret, ANYOF_NASCII);
8104                     else {
8105 #ifndef EBCDIC
8106                         for (value = 128; value < 256; value++)
8107                             ANYOF_BITMAP_SET(ret, value);
8108 #else  /* EBCDIC */
8109                         for (value = 0; value < 256; value++) {
8110                             if (!isASCII(value))
8111                                 ANYOF_BITMAP_SET(ret, value);
8112                         }
8113 #endif /* EBCDIC */
8114                     }
8115                     yesno = '!';
8116                     what = "ASCII";
8117                     break;              
8118                 case ANYOF_DIGIT:
8119                     if (LOC)
8120                         ANYOF_CLASS_SET(ret, ANYOF_DIGIT);
8121                     else {
8122                         /* consecutive digits assumed */
8123                         for (value = '0'; value <= '9'; value++)
8124                             ANYOF_BITMAP_SET(ret, value);
8125                     }
8126                     yesno = '+';
8127                     what = "Digit";
8128                     break;
8129                 case ANYOF_NDIGIT:
8130                     if (LOC)
8131                         ANYOF_CLASS_SET(ret, ANYOF_NDIGIT);
8132                     else {
8133                         /* consecutive digits assumed */
8134                         for (value = 0; value < '0'; value++)
8135                             ANYOF_BITMAP_SET(ret, value);
8136                         for (value = '9' + 1; value < 256; value++)
8137                             ANYOF_BITMAP_SET(ret, value);
8138                     }
8139                     yesno = '!';
8140                     what = "Digit";
8141                     break;              
8142                 case ANYOF_MAX:
8143                     /* this is to handle \p and \P */
8144                     break;
8145                 default:
8146                     vFAIL("Invalid [::] class");
8147                     break;
8148                 }
8149                 if (what) {
8150                     /* Strings such as "+utf8::isWord\n" */
8151                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::Is%s\n", yesno, what);
8152                 }
8153                 if (LOC)
8154                     ANYOF_FLAGS(ret) |= ANYOF_CLASS;
8155                 continue;
8156             }
8157         } /* end of namedclass \blah */
8158
8159         if (range) {
8160             if (prevvalue > (IV)value) /* b-a */ {
8161                 const int w = RExC_parse - rangebegin;
8162                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
8163                 range = 0; /* not a valid range */
8164             }
8165         }
8166         else {
8167             prevvalue = value; /* save the beginning of the range */
8168             if (*RExC_parse == '-' && RExC_parse+1 < RExC_end &&
8169                 RExC_parse[1] != ']') {
8170                 RExC_parse++;
8171
8172                 /* a bad range like \w-, [:word:]- ? */
8173                 if (namedclass > OOB_NAMEDCLASS) {
8174                     if (ckWARN(WARN_REGEXP)) {
8175                         const int w =
8176                             RExC_parse >= rangebegin ?
8177                             RExC_parse - rangebegin : 0;
8178                         vWARN4(RExC_parse,
8179                                "False [] range \"%*.*s\"",
8180                                w, w, rangebegin);
8181                     }
8182                     if (!SIZE_ONLY)
8183                         ANYOF_BITMAP_SET(ret, '-');
8184                 } else
8185                     range = 1;  /* yeah, it's a range! */
8186                 continue;       /* but do it the next time */
8187             }
8188         }
8189
8190         /* now is the next time */
8191         /*stored += (value - prevvalue + 1);*/
8192         if (!SIZE_ONLY) {
8193             if (prevvalue < 256) {
8194                 const IV ceilvalue = value < 256 ? value : 255;
8195                 IV i;
8196 #ifdef EBCDIC
8197                 /* In EBCDIC [\x89-\x91] should include
8198                  * the \x8e but [i-j] should not. */
8199                 if (literal_endpoint == 2 &&
8200                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
8201                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
8202                 {
8203                     if (isLOWER(prevvalue)) {
8204                         for (i = prevvalue; i <= ceilvalue; i++)
8205                             if (isLOWER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
8206                                 stored++;
8207                                 ANYOF_BITMAP_SET(ret, i);
8208                             }
8209                     } else {
8210                         for (i = prevvalue; i <= ceilvalue; i++)
8211                             if (isUPPER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
8212                                 stored++;
8213                                 ANYOF_BITMAP_SET(ret, i);
8214                             }
8215                     }
8216                 }
8217                 else
8218 #endif
8219                       for (i = prevvalue; i <= ceilvalue; i++) {
8220                         if (!ANYOF_BITMAP_TEST(ret,i)) {
8221                             stored++;  
8222                             ANYOF_BITMAP_SET(ret, i);
8223                         }
8224                       }
8225           }
8226           if (value > 255 || UTF) {
8227                 const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
8228                 const UV natvalue      = NATIVE_TO_UNI(value);
8229                 stored+=2; /* can't optimize this class */
8230                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
8231                 if (prevnatvalue < natvalue) { /* what about > ? */
8232                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\t%04"UVxf"\n",
8233                                    prevnatvalue, natvalue);
8234                 }
8235                 else if (prevnatvalue == natvalue) {
8236                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n", natvalue);
8237                     if (FOLD) {
8238                          U8 foldbuf[UTF8_MAXBYTES_CASE+1];
8239                          STRLEN foldlen;
8240                          const UV f = to_uni_fold(natvalue, foldbuf, &foldlen);
8241
8242 #ifdef EBCDIC /* RD t/uni/fold ff and 6b */
8243                          if (RExC_precomp[0] == ':' &&
8244                              RExC_precomp[1] == '[' &&
8245                              (f == 0xDF || f == 0x92)) {
8246                              f = NATIVE_TO_UNI(f);
8247                         }
8248 #endif
8249                          /* If folding and foldable and a single
8250                           * character, insert also the folded version
8251                           * to the charclass. */
8252                          if (f != value) {
8253 #ifdef EBCDIC /* RD tunifold ligatures s,t fb05, fb06 */
8254                              if ((RExC_precomp[0] == ':' &&
8255                                   RExC_precomp[1] == '[' &&
8256                                   (f == 0xA2 &&
8257                                    (value == 0xFB05 || value == 0xFB06))) ?
8258                                  foldlen == ((STRLEN)UNISKIP(f) - 1) :
8259                                  foldlen == (STRLEN)UNISKIP(f) )
8260 #else
8261                               if (foldlen == (STRLEN)UNISKIP(f))
8262 #endif
8263                                   Perl_sv_catpvf(aTHX_ listsv,
8264                                                  "%04"UVxf"\n", f);
8265                               else {
8266                                   /* Any multicharacter foldings
8267                                    * require the following transform:
8268                                    * [ABCDEF] -> (?:[ABCabcDEFd]|pq|rst)
8269                                    * where E folds into "pq" and F folds
8270                                    * into "rst", all other characters
8271                                    * fold to single characters.  We save
8272                                    * away these multicharacter foldings,
8273                                    * to be later saved as part of the
8274                                    * additional "s" data. */
8275                                   SV *sv;
8276
8277                                   if (!unicode_alternate)
8278                                       unicode_alternate = newAV();
8279                                   sv = newSVpvn_utf8((char*)foldbuf, foldlen,
8280                                                      TRUE);
8281                                   av_push(unicode_alternate, sv);
8282                               }
8283                          }
8284
8285                          /* If folding and the value is one of the Greek
8286                           * sigmas insert a few more sigmas to make the
8287                           * folding rules of the sigmas to work right.
8288                           * Note that not all the possible combinations
8289                           * are handled here: some of them are handled
8290                           * by the standard folding rules, and some of
8291                           * them (literal or EXACTF cases) are handled
8292                           * during runtime in regexec.c:S_find_byclass(). */
8293                          if (value == UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA) {
8294                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
8295                                              (UV)UNICODE_GREEK_CAPITAL_LETTER_SIGMA);
8296                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
8297                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
8298                          }
8299                          else if (value == UNICODE_GREEK_CAPITAL_LETTER_SIGMA)
8300                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
8301                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
8302                     }
8303                 }
8304             }
8305 #ifdef EBCDIC
8306             literal_endpoint = 0;
8307 #endif
8308         }
8309
8310         range = 0; /* this range (if it was one) is done now */
8311     }
8312
8313     if (need_class) {
8314         ANYOF_FLAGS(ret) |= ANYOF_LARGE;
8315         if (SIZE_ONLY)
8316             RExC_size += ANYOF_CLASS_ADD_SKIP;
8317         else
8318             RExC_emit += ANYOF_CLASS_ADD_SKIP;
8319     }
8320
8321
8322     if (SIZE_ONLY)
8323         return ret;
8324     /****** !SIZE_ONLY AFTER HERE *********/
8325
8326     if( stored == 1 && (value < 128 || (value < 256 && !UTF))
8327         && !( ANYOF_FLAGS(ret) & ( ANYOF_FLAGS_ALL ^ ANYOF_FOLD ) )
8328     ) {
8329         /* optimize single char class to an EXACT node
8330            but *only* when its not a UTF/high char  */
8331         const char * cur_parse= RExC_parse;
8332         RExC_emit = (regnode *)orig_emit;
8333         RExC_parse = (char *)orig_parse;
8334         ret = reg_node(pRExC_state,
8335                        (U8)((ANYOF_FLAGS(ret) & ANYOF_FOLD) ? EXACTF : EXACT));
8336         RExC_parse = (char *)cur_parse;
8337         *STRING(ret)= (char)value;
8338         STR_LEN(ret)= 1;
8339         RExC_emit += STR_SZ(1);
8340         return ret;
8341     }
8342     /* optimize case-insensitive simple patterns (e.g. /[a-z]/i) */
8343     if ( /* If the only flag is folding (plus possibly inversion). */
8344         ((ANYOF_FLAGS(ret) & (ANYOF_FLAGS_ALL ^ ANYOF_INVERT)) == ANYOF_FOLD)
8345        ) {
8346         for (value = 0; value < 256; ++value) {
8347             if (ANYOF_BITMAP_TEST(ret, value)) {
8348                 UV fold = PL_fold[value];
8349
8350                 if (fold != value)
8351                     ANYOF_BITMAP_SET(ret, fold);
8352             }
8353         }
8354         ANYOF_FLAGS(ret) &= ~ANYOF_FOLD;
8355     }
8356
8357     /* optimize inverted simple patterns (e.g. [^a-z]) */
8358     if (optimize_invert &&
8359         /* If the only flag is inversion. */
8360         (ANYOF_FLAGS(ret) & ANYOF_FLAGS_ALL) == ANYOF_INVERT) {
8361         for (value = 0; value < ANYOF_BITMAP_SIZE; ++value)
8362             ANYOF_BITMAP(ret)[value] ^= ANYOF_FLAGS_ALL;
8363         ANYOF_FLAGS(ret) = ANYOF_UNICODE_ALL;
8364     }
8365     {
8366         AV * const av = newAV();
8367         SV *rv;
8368         /* The 0th element stores the character class description
8369          * in its textual form: used later (regexec.c:Perl_regclass_swash())
8370          * to initialize the appropriate swash (which gets stored in
8371          * the 1st element), and also useful for dumping the regnode.
8372          * The 2nd element stores the multicharacter foldings,
8373          * used later (regexec.c:S_reginclass()). */
8374         av_store(av, 0, listsv);
8375         av_store(av, 1, NULL);
8376         av_store(av, 2, (SV*)unicode_alternate);
8377         rv = newRV_noinc((SV*)av);
8378         n = add_data(pRExC_state, 1, "s");
8379         RExC_rxi->data->data[n] = (void*)rv;
8380         ARG_SET(ret, n);
8381     }
8382     return ret;
8383 }
8384 #undef _C_C_T_
8385
8386
8387 /* reg_skipcomment()
8388
8389    Absorbs an /x style # comments from the input stream.
8390    Returns true if there is more text remaining in the stream.
8391    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
8392    terminates the pattern without including a newline.
8393
8394    Note its the callers responsibility to ensure that we are
8395    actually in /x mode
8396
8397 */
8398
8399 STATIC bool
8400 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
8401 {
8402     bool ended = 0;
8403
8404     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
8405
8406     while (RExC_parse < RExC_end)
8407         if (*RExC_parse++ == '\n') {
8408             ended = 1;
8409             break;
8410         }
8411     if (!ended) {
8412         /* we ran off the end of the pattern without ending
8413            the comment, so we have to add an \n when wrapping */
8414         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
8415         return 0;
8416     } else
8417         return 1;
8418 }
8419
8420 /* nextchar()
8421
8422    Advance that parse position, and optionall absorbs
8423    "whitespace" from the inputstream.
8424
8425    Without /x "whitespace" means (?#...) style comments only,
8426    with /x this means (?#...) and # comments and whitespace proper.
8427
8428    Returns the RExC_parse point from BEFORE the scan occurs.
8429
8430    This is the /x friendly way of saying RExC_parse++.
8431 */
8432
8433 STATIC char*
8434 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
8435 {
8436     char* const retval = RExC_parse++;
8437
8438     PERL_ARGS_ASSERT_NEXTCHAR;
8439
8440     for (;;) {
8441         if (*RExC_parse == '(' && RExC_parse[1] == '?' &&
8442                 RExC_parse[2] == '#') {
8443             while (*RExC_parse != ')') {
8444                 if (RExC_parse == RExC_end)
8445                     FAIL("Sequence (?#... not terminated");
8446                 RExC_parse++;
8447             }
8448             RExC_parse++;
8449             continue;
8450         }
8451         if (RExC_flags & RXf_PMf_EXTENDED) {
8452             if (isSPACE(*RExC_parse)) {
8453                 RExC_parse++;
8454                 continue;
8455             }
8456             else if (*RExC_parse == '#') {
8457                 if ( reg_skipcomment( pRExC_state ) )
8458                     continue;
8459             }
8460         }
8461         return retval;
8462     }
8463 }
8464
8465 /*
8466 - reg_node - emit a node
8467 */
8468 STATIC regnode *                        /* Location. */
8469 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
8470 {
8471     dVAR;
8472     register regnode *ptr;
8473     regnode * const ret = RExC_emit;
8474     GET_RE_DEBUG_FLAGS_DECL;
8475
8476     PERL_ARGS_ASSERT_REG_NODE;
8477
8478     if (SIZE_ONLY) {
8479         SIZE_ALIGN(RExC_size);
8480         RExC_size += 1;
8481         return(ret);
8482     }
8483     if (RExC_emit >= RExC_emit_bound)
8484         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d", op);
8485
8486     NODE_ALIGN_FILL(ret);
8487     ptr = ret;
8488     FILL_ADVANCE_NODE(ptr, op);
8489 #ifdef RE_TRACK_PATTERN_OFFSETS
8490     if (RExC_offsets) {         /* MJD */
8491         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
8492               "reg_node", __LINE__, 
8493               PL_reg_name[op],
8494               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
8495                 ? "Overwriting end of array!\n" : "OK",
8496               (UV)(RExC_emit - RExC_emit_start),
8497               (UV)(RExC_parse - RExC_start),
8498               (UV)RExC_offsets[0])); 
8499         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
8500     }
8501 #endif
8502     RExC_emit = ptr;
8503     return(ret);
8504 }
8505
8506 /*
8507 - reganode - emit a node with an argument
8508 */
8509 STATIC regnode *                        /* Location. */
8510 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
8511 {
8512     dVAR;
8513     register regnode *ptr;
8514     regnode * const ret = RExC_emit;
8515     GET_RE_DEBUG_FLAGS_DECL;
8516
8517     PERL_ARGS_ASSERT_REGANODE;
8518
8519     if (SIZE_ONLY) {
8520         SIZE_ALIGN(RExC_size);
8521         RExC_size += 2;
8522         /* 
8523            We can't do this:
8524            
8525            assert(2==regarglen[op]+1); 
8526         
8527            Anything larger than this has to allocate the extra amount.
8528            If we changed this to be:
8529            
8530            RExC_size += (1 + regarglen[op]);
8531            
8532            then it wouldn't matter. Its not clear what side effect
8533            might come from that so its not done so far.
8534            -- dmq
8535         */
8536         return(ret);
8537     }
8538     if (RExC_emit >= RExC_emit_bound)
8539         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d", op);
8540
8541     NODE_ALIGN_FILL(ret);
8542     ptr = ret;
8543     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
8544 #ifdef RE_TRACK_PATTERN_OFFSETS
8545     if (RExC_offsets) {         /* MJD */
8546         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
8547               "reganode",
8548               __LINE__,
8549               PL_reg_name[op],
8550               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
8551               "Overwriting end of array!\n" : "OK",
8552               (UV)(RExC_emit - RExC_emit_start),
8553               (UV)(RExC_parse - RExC_start),
8554               (UV)RExC_offsets[0])); 
8555         Set_Cur_Node_Offset;
8556     }
8557 #endif            
8558     RExC_emit = ptr;
8559     return(ret);
8560 }
8561
8562 /*
8563 - reguni - emit (if appropriate) a Unicode character
8564 */
8565 STATIC STRLEN
8566 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
8567 {
8568     dVAR;
8569
8570     PERL_ARGS_ASSERT_REGUNI;
8571
8572     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
8573 }
8574
8575 /*
8576 - reginsert - insert an operator in front of already-emitted operand
8577 *
8578 * Means relocating the operand.
8579 */
8580 STATIC void
8581 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
8582 {
8583     dVAR;
8584     register regnode *src;
8585     register regnode *dst;
8586     register regnode *place;
8587     const int offset = regarglen[(U8)op];
8588     const int size = NODE_STEP_REGNODE + offset;
8589     GET_RE_DEBUG_FLAGS_DECL;
8590
8591     PERL_ARGS_ASSERT_REGINSERT;
8592     PERL_UNUSED_ARG(depth);
8593 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
8594     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
8595     if (SIZE_ONLY) {
8596         RExC_size += size;
8597         return;
8598     }
8599
8600     src = RExC_emit;
8601     RExC_emit += size;
8602     dst = RExC_emit;
8603     if (RExC_open_parens) {
8604         int paren;
8605         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
8606         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
8607             if ( RExC_open_parens[paren] >= opnd ) {
8608                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
8609                 RExC_open_parens[paren] += size;
8610             } else {
8611                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
8612             }
8613             if ( RExC_close_parens[paren] >= opnd ) {
8614                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
8615                 RExC_close_parens[paren] += size;
8616             } else {
8617                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
8618             }
8619         }
8620     }
8621
8622     while (src > opnd) {
8623         StructCopy(--src, --dst, regnode);
8624 #ifdef RE_TRACK_PATTERN_OFFSETS
8625         if (RExC_offsets) {     /* MJD 20010112 */
8626             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
8627                   "reg_insert",
8628                   __LINE__,
8629                   PL_reg_name[op],
8630                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
8631                     ? "Overwriting end of array!\n" : "OK",
8632                   (UV)(src - RExC_emit_start),
8633                   (UV)(dst - RExC_emit_start),
8634                   (UV)RExC_offsets[0])); 
8635             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
8636             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
8637         }
8638 #endif
8639     }
8640     
8641
8642     place = opnd;               /* Op node, where operand used to be. */
8643 #ifdef RE_TRACK_PATTERN_OFFSETS
8644     if (RExC_offsets) {         /* MJD */
8645         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
8646               "reginsert",
8647               __LINE__,
8648               PL_reg_name[op],
8649               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
8650               ? "Overwriting end of array!\n" : "OK",
8651               (UV)(place - RExC_emit_start),
8652               (UV)(RExC_parse - RExC_start),
8653               (UV)RExC_offsets[0]));
8654         Set_Node_Offset(place, RExC_parse);
8655         Set_Node_Length(place, 1);
8656     }
8657 #endif    
8658     src = NEXTOPER(place);
8659     FILL_ADVANCE_NODE(place, op);
8660     Zero(src, offset, regnode);
8661 }
8662
8663 /*
8664 - regtail - set the next-pointer at the end of a node chain of p to val.
8665 - SEE ALSO: regtail_study
8666 */
8667 /* TODO: All three parms should be const */
8668 STATIC void
8669 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
8670 {
8671     dVAR;
8672     register regnode *scan;
8673     GET_RE_DEBUG_FLAGS_DECL;
8674
8675     PERL_ARGS_ASSERT_REGTAIL;
8676 #ifndef DEBUGGING
8677     PERL_UNUSED_ARG(depth);
8678 #endif
8679
8680     if (SIZE_ONLY)
8681         return;
8682
8683     /* Find last node. */
8684     scan = p;
8685     for (;;) {
8686         regnode * const temp = regnext(scan);
8687         DEBUG_PARSE_r({
8688             SV * const mysv=sv_newmortal();
8689             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
8690             regprop(RExC_rx, mysv, scan);
8691             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
8692                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
8693                     (temp == NULL ? "->" : ""),
8694                     (temp == NULL ? PL_reg_name[OP(val)] : "")
8695             );
8696         });
8697         if (temp == NULL)
8698             break;
8699         scan = temp;
8700     }
8701
8702     if (reg_off_by_arg[OP(scan)]) {
8703         ARG_SET(scan, val - scan);
8704     }
8705     else {
8706         NEXT_OFF(scan) = val - scan;
8707     }
8708 }
8709
8710 #ifdef DEBUGGING
8711 /*
8712 - regtail_study - set the next-pointer at the end of a node chain of p to val.
8713 - Look for optimizable sequences at the same time.
8714 - currently only looks for EXACT chains.
8715
8716 This is expermental code. The idea is to use this routine to perform 
8717 in place optimizations on branches and groups as they are constructed,
8718 with the long term intention of removing optimization from study_chunk so
8719 that it is purely analytical.
8720
8721 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
8722 to control which is which.
8723
8724 */
8725 /* TODO: All four parms should be const */
8726
8727 STATIC U8
8728 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
8729 {
8730     dVAR;
8731     register regnode *scan;
8732     U8 exact = PSEUDO;
8733 #ifdef EXPERIMENTAL_INPLACESCAN
8734     I32 min = 0;
8735 #endif
8736     GET_RE_DEBUG_FLAGS_DECL;
8737
8738     PERL_ARGS_ASSERT_REGTAIL_STUDY;
8739
8740
8741     if (SIZE_ONLY)
8742         return exact;
8743
8744     /* Find last node. */
8745
8746     scan = p;
8747     for (;;) {
8748         regnode * const temp = regnext(scan);
8749 #ifdef EXPERIMENTAL_INPLACESCAN
8750         if (PL_regkind[OP(scan)] == EXACT)
8751             if (join_exact(pRExC_state,scan,&min,1,val,depth+1))
8752                 return EXACT;
8753 #endif
8754         if ( exact ) {
8755             switch (OP(scan)) {
8756                 case EXACT:
8757                 case EXACTF:
8758                 case EXACTFL:
8759                         if( exact == PSEUDO )
8760                             exact= OP(scan);
8761                         else if ( exact != OP(scan) )
8762                             exact= 0;
8763                 case NOTHING:
8764                     break;
8765                 default:
8766                     exact= 0;
8767             }
8768         }
8769         DEBUG_PARSE_r({
8770             SV * const mysv=sv_newmortal();
8771             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
8772             regprop(RExC_rx, mysv, scan);
8773             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
8774                 SvPV_nolen_const(mysv),
8775                 REG_NODE_NUM(scan),
8776                 PL_reg_name[exact]);
8777         });
8778         if (temp == NULL)
8779             break;
8780         scan = temp;
8781     }
8782     DEBUG_PARSE_r({
8783         SV * const mysv_val=sv_newmortal();
8784         DEBUG_PARSE_MSG("");
8785         regprop(RExC_rx, mysv_val, val);
8786         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
8787                       SvPV_nolen_const(mysv_val),
8788                       (IV)REG_NODE_NUM(val),
8789                       (IV)(val - scan)
8790         );
8791     });
8792     if (reg_off_by_arg[OP(scan)]) {
8793         ARG_SET(scan, val - scan);
8794     }
8795     else {
8796         NEXT_OFF(scan) = val - scan;
8797     }
8798
8799     return exact;
8800 }
8801 #endif
8802
8803 /*
8804  - regcurly - a little FSA that accepts {\d+,?\d*}
8805  */
8806 STATIC I32
8807 S_regcurly(register const char *s)
8808 {
8809     PERL_ARGS_ASSERT_REGCURLY;
8810
8811     if (*s++ != '{')
8812         return FALSE;
8813     if (!isDIGIT(*s))
8814         return FALSE;
8815     while (isDIGIT(*s))
8816         s++;
8817     if (*s == ',')
8818         s++;
8819     while (isDIGIT(*s))
8820         s++;
8821     if (*s != '}')
8822         return FALSE;
8823     return TRUE;
8824 }
8825
8826
8827 /*
8828  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
8829  */
8830 #ifdef DEBUGGING
8831 void 
8832 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
8833 {
8834     int bit;
8835     int set=0;
8836
8837     for (bit=0; bit<32; bit++) {
8838         if (flags & (1<<bit)) {
8839             if (!set++ && lead) 
8840                 PerlIO_printf(Perl_debug_log, "%s",lead);
8841             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
8842         }               
8843     }      
8844     if (lead)  {
8845         if (set) 
8846             PerlIO_printf(Perl_debug_log, "\n");
8847         else 
8848             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
8849     }            
8850 }   
8851 #endif
8852
8853 void
8854 Perl_regdump(pTHX_ const regexp *r)
8855 {
8856 #ifdef DEBUGGING
8857     dVAR;
8858     SV * const sv = sv_newmortal();
8859     SV *dsv= sv_newmortal();
8860     RXi_GET_DECL(r,ri);
8861     GET_RE_DEBUG_FLAGS_DECL;
8862
8863     PERL_ARGS_ASSERT_REGDUMP;
8864
8865     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
8866
8867     /* Header fields of interest. */
8868     if (r->anchored_substr) {
8869         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
8870             RE_SV_DUMPLEN(r->anchored_substr), 30);
8871         PerlIO_printf(Perl_debug_log,
8872                       "anchored %s%s at %"IVdf" ",
8873                       s, RE_SV_TAIL(r->anchored_substr),
8874                       (IV)r->anchored_offset);
8875     } else if (r->anchored_utf8) {
8876         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
8877             RE_SV_DUMPLEN(r->anchored_utf8), 30);
8878         PerlIO_printf(Perl_debug_log,
8879                       "anchored utf8 %s%s at %"IVdf" ",
8880                       s, RE_SV_TAIL(r->anchored_utf8),
8881                       (IV)r->anchored_offset);
8882     }                 
8883     if (r->float_substr) {
8884         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
8885             RE_SV_DUMPLEN(r->float_substr), 30);
8886         PerlIO_printf(Perl_debug_log,
8887                       "floating %s%s at %"IVdf"..%"UVuf" ",
8888                       s, RE_SV_TAIL(r->float_substr),
8889                       (IV)r->float_min_offset, (UV)r->float_max_offset);
8890     } else if (r->float_utf8) {
8891         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
8892             RE_SV_DUMPLEN(r->float_utf8), 30);
8893         PerlIO_printf(Perl_debug_log,
8894                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
8895                       s, RE_SV_TAIL(r->float_utf8),
8896                       (IV)r->float_min_offset, (UV)r->float_max_offset);
8897     }
8898     if (r->check_substr || r->check_utf8)
8899         PerlIO_printf(Perl_debug_log,
8900                       (const char *)
8901                       (r->check_substr == r->float_substr
8902                        && r->check_utf8 == r->float_utf8
8903                        ? "(checking floating" : "(checking anchored"));
8904     if (r->extflags & RXf_NOSCAN)
8905         PerlIO_printf(Perl_debug_log, " noscan");
8906     if (r->extflags & RXf_CHECK_ALL)
8907         PerlIO_printf(Perl_debug_log, " isall");
8908     if (r->check_substr || r->check_utf8)
8909         PerlIO_printf(Perl_debug_log, ") ");
8910
8911     if (ri->regstclass) {
8912         regprop(r, sv, ri->regstclass);
8913         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
8914     }
8915     if (r->extflags & RXf_ANCH) {
8916         PerlIO_printf(Perl_debug_log, "anchored");
8917         if (r->extflags & RXf_ANCH_BOL)
8918             PerlIO_printf(Perl_debug_log, "(BOL)");
8919         if (r->extflags & RXf_ANCH_MBOL)
8920             PerlIO_printf(Perl_debug_log, "(MBOL)");
8921         if (r->extflags & RXf_ANCH_SBOL)
8922             PerlIO_printf(Perl_debug_log, "(SBOL)");
8923         if (r->extflags & RXf_ANCH_GPOS)
8924             PerlIO_printf(Perl_debug_log, "(GPOS)");
8925         PerlIO_putc(Perl_debug_log, ' ');
8926     }
8927     if (r->extflags & RXf_GPOS_SEEN)
8928         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
8929     if (r->intflags & PREGf_SKIP)
8930         PerlIO_printf(Perl_debug_log, "plus ");
8931     if (r->intflags & PREGf_IMPLICIT)
8932         PerlIO_printf(Perl_debug_log, "implicit ");
8933     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
8934     if (r->extflags & RXf_EVAL_SEEN)
8935         PerlIO_printf(Perl_debug_log, "with eval ");
8936     PerlIO_printf(Perl_debug_log, "\n");
8937     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
8938 #else
8939     PERL_ARGS_ASSERT_REGDUMP;
8940     PERL_UNUSED_CONTEXT;
8941     PERL_UNUSED_ARG(r);
8942 #endif  /* DEBUGGING */
8943 }
8944
8945 /*
8946 - regprop - printable representation of opcode
8947 */
8948 void
8949 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
8950 {
8951 #ifdef DEBUGGING
8952     dVAR;
8953     register int k;
8954     RXi_GET_DECL(prog,progi);
8955     GET_RE_DEBUG_FLAGS_DECL;
8956     
8957     PERL_ARGS_ASSERT_REGPROP;
8958
8959     sv_setpvn(sv, "", 0);
8960
8961     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
8962         /* It would be nice to FAIL() here, but this may be called from
8963            regexec.c, and it would be hard to supply pRExC_state. */
8964         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
8965     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
8966
8967     k = PL_regkind[OP(o)];
8968
8969     if (k == EXACT) {
8970         sv_catpvs(sv, " ");
8971         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
8972          * is a crude hack but it may be the best for now since 
8973          * we have no flag "this EXACTish node was UTF-8" 
8974          * --jhi */
8975         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
8976                   PERL_PV_ESCAPE_UNI_DETECT |
8977                   PERL_PV_PRETTY_ELLIPSES   |
8978                   PERL_PV_PRETTY_LTGT       |
8979                   PERL_PV_PRETTY_NOCLEAR
8980                   );
8981     } else if (k == TRIE) {
8982         /* print the details of the trie in dumpuntil instead, as
8983          * progi->data isn't available here */
8984         const char op = OP(o);
8985         const U32 n = ARG(o);
8986         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
8987                (reg_ac_data *)progi->data->data[n] :
8988                NULL;
8989         const reg_trie_data * const trie
8990             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
8991         
8992         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
8993         DEBUG_TRIE_COMPILE_r(
8994             Perl_sv_catpvf(aTHX_ sv,
8995                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
8996                 (UV)trie->startstate,
8997                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
8998                 (UV)trie->wordcount,
8999                 (UV)trie->minlen,
9000                 (UV)trie->maxlen,
9001                 (UV)TRIE_CHARCOUNT(trie),
9002                 (UV)trie->uniquecharcount
9003             )
9004         );
9005         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
9006             int i;
9007             int rangestart = -1;
9008             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
9009             sv_catpvs(sv, "[");
9010             for (i = 0; i <= 256; i++) {
9011                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
9012                     if (rangestart == -1)
9013                         rangestart = i;
9014                 } else if (rangestart != -1) {
9015                     if (i <= rangestart + 3)
9016                         for (; rangestart < i; rangestart++)
9017                             put_byte(sv, rangestart);
9018                     else {
9019                         put_byte(sv, rangestart);
9020                         sv_catpvs(sv, "-");
9021                         put_byte(sv, i - 1);
9022                     }
9023                     rangestart = -1;
9024                 }
9025             }
9026             sv_catpvs(sv, "]");
9027         } 
9028          
9029     } else if (k == CURLY) {
9030         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
9031             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
9032         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
9033     }
9034     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
9035         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
9036     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
9037         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
9038         if ( RXp_PAREN_NAMES(prog) ) {
9039             if ( k != REF || OP(o) < NREF) {        
9040                 AV *list= (AV *)progi->data->data[progi->name_list_idx];
9041                 SV **name= av_fetch(list, ARG(o), 0 );
9042                 if (name)
9043                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
9044             }       
9045             else {
9046                 AV *list= (AV *)progi->data->data[ progi->name_list_idx ];
9047                 SV *sv_dat=(SV*)progi->data->data[ ARG( o ) ];
9048                 I32 *nums=(I32*)SvPVX(sv_dat);
9049                 SV **name= av_fetch(list, nums[0], 0 );
9050                 I32 n;
9051                 if (name) {
9052                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
9053                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
9054                                     (n ? "," : ""), (IV)nums[n]);
9055                     }
9056                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
9057                 }
9058             }
9059         }            
9060     } else if (k == GOSUB) 
9061         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
9062     else if (k == VERB) {
9063         if (!o->flags) 
9064             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
9065                 SVfARG((SV*)progi->data->data[ ARG( o ) ]));
9066     } else if (k == LOGICAL)
9067         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
9068     else if (k == FOLDCHAR)
9069         Perl_sv_catpvf(aTHX_ sv, "[0x%"UVXf"]", PTR2UV(ARG(o)) );
9070     else if (k == ANYOF) {
9071         int i, rangestart = -1;
9072         const U8 flags = ANYOF_FLAGS(o);
9073
9074         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
9075         static const char * const anyofs[] = {
9076             "\\w",
9077             "\\W",
9078             "\\s",
9079             "\\S",
9080             "\\d",
9081             "\\D",
9082             "[:alnum:]",
9083             "[:^alnum:]",
9084             "[:alpha:]",
9085             "[:^alpha:]",
9086             "[:ascii:]",
9087             "[:^ascii:]",
9088             "[:ctrl:]",
9089             "[:^ctrl:]",
9090             "[:graph:]",
9091             "[:^graph:]",
9092             "[:lower:]",
9093             "[:^lower:]",
9094             "[:print:]",
9095             "[:^print:]",
9096             "[:punct:]",
9097             "[:^punct:]",
9098             "[:upper:]",
9099             "[:^upper:]",
9100             "[:xdigit:]",
9101             "[:^xdigit:]",
9102             "[:space:]",
9103             "[:^space:]",
9104             "[:blank:]",
9105             "[:^blank:]"
9106         };
9107
9108         if (flags & ANYOF_LOCALE)
9109             sv_catpvs(sv, "{loc}");
9110         if (flags & ANYOF_FOLD)
9111             sv_catpvs(sv, "{i}");
9112         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
9113         if (flags & ANYOF_INVERT)
9114             sv_catpvs(sv, "^");
9115         for (i = 0; i <= 256; i++) {
9116             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
9117                 if (rangestart == -1)
9118                     rangestart = i;
9119             } else if (rangestart != -1) {
9120                 if (i <= rangestart + 3)
9121                     for (; rangestart < i; rangestart++)
9122                         put_byte(sv, rangestart);
9123                 else {
9124                     put_byte(sv, rangestart);
9125                     sv_catpvs(sv, "-");
9126                     put_byte(sv, i - 1);
9127                 }
9128                 rangestart = -1;
9129             }
9130         }
9131
9132         if (o->flags & ANYOF_CLASS)
9133             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
9134                 if (ANYOF_CLASS_TEST(o,i))
9135                     sv_catpv(sv, anyofs[i]);
9136
9137         if (flags & ANYOF_UNICODE)
9138             sv_catpvs(sv, "{unicode}");
9139         else if (flags & ANYOF_UNICODE_ALL)
9140             sv_catpvs(sv, "{unicode_all}");
9141
9142         {
9143             SV *lv;
9144             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
9145         
9146             if (lv) {
9147                 if (sw) {
9148                     U8 s[UTF8_MAXBYTES_CASE+1];
9149                 
9150                     for (i = 0; i <= 256; i++) { /* just the first 256 */
9151                         uvchr_to_utf8(s, i);
9152                         
9153                         if (i < 256 && swash_fetch(sw, s, TRUE)) {
9154                             if (rangestart == -1)
9155                                 rangestart = i;
9156                         } else if (rangestart != -1) {
9157                             if (i <= rangestart + 3)
9158                                 for (; rangestart < i; rangestart++) {
9159                                     const U8 * const e = uvchr_to_utf8(s,rangestart);
9160                                     U8 *p;
9161                                     for(p = s; p < e; p++)
9162                                         put_byte(sv, *p);
9163                                 }
9164                             else {
9165                                 const U8 *e = uvchr_to_utf8(s,rangestart);
9166                                 U8 *p;
9167                                 for (p = s; p < e; p++)
9168                                     put_byte(sv, *p);
9169                                 sv_catpvs(sv, "-");
9170                                 e = uvchr_to_utf8(s, i-1);
9171                                 for (p = s; p < e; p++)
9172                                     put_byte(sv, *p);
9173                                 }
9174                                 rangestart = -1;
9175                             }
9176                         }
9177                         
9178                     sv_catpvs(sv, "..."); /* et cetera */
9179                 }
9180
9181                 {
9182                     char *s = savesvpv(lv);
9183                     char * const origs = s;
9184                 
9185                     while (*s && *s != '\n')
9186                         s++;
9187                 
9188                     if (*s == '\n') {
9189                         const char * const t = ++s;
9190                         
9191                         while (*s) {
9192                             if (*s == '\n')
9193                                 *s = ' ';
9194                             s++;
9195                         }
9196                         if (s[-1] == ' ')
9197                             s[-1] = 0;
9198                         
9199                         sv_catpv(sv, t);
9200                     }
9201                 
9202                     Safefree(origs);
9203                 }
9204             }
9205         }
9206
9207         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
9208     }
9209     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
9210         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
9211 #else
9212     PERL_UNUSED_CONTEXT;
9213     PERL_UNUSED_ARG(sv);
9214     PERL_UNUSED_ARG(o);
9215     PERL_UNUSED_ARG(prog);
9216 #endif  /* DEBUGGING */
9217 }
9218
9219 SV *
9220 Perl_re_intuit_string(pTHX_ REGEXP * const r)
9221 {                               /* Assume that RE_INTUIT is set */
9222     dVAR;
9223     struct regexp *const prog = (struct regexp *)SvANY(r);
9224     GET_RE_DEBUG_FLAGS_DECL;
9225
9226     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
9227     PERL_UNUSED_CONTEXT;
9228
9229     DEBUG_COMPILE_r(
9230         {
9231             const char * const s = SvPV_nolen_const(prog->check_substr
9232                       ? prog->check_substr : prog->check_utf8);
9233
9234             if (!PL_colorset) reginitcolors();
9235             PerlIO_printf(Perl_debug_log,
9236                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
9237                       PL_colors[4],
9238                       prog->check_substr ? "" : "utf8 ",
9239                       PL_colors[5],PL_colors[0],
9240                       s,
9241                       PL_colors[1],
9242                       (strlen(s) > 60 ? "..." : ""));
9243         } );
9244
9245     return prog->check_substr ? prog->check_substr : prog->check_utf8;
9246 }
9247
9248 /* 
9249    pregfree() 
9250    
9251    handles refcounting and freeing the perl core regexp structure. When 
9252    it is necessary to actually free the structure the first thing it 
9253    does is call the 'free' method of the regexp_engine associated to to 
9254    the regexp, allowing the handling of the void *pprivate; member 
9255    first. (This routine is not overridable by extensions, which is why 
9256    the extensions free is called first.)
9257    
9258    See regdupe and regdupe_internal if you change anything here. 
9259 */
9260 #ifndef PERL_IN_XSUB_RE
9261 void
9262 Perl_pregfree(pTHX_ REGEXP *r)
9263 {
9264     SvREFCNT_dec(r);
9265 }
9266
9267 void
9268 Perl_pregfree2(pTHX_ REGEXP *rx)
9269 {
9270     dVAR;
9271     struct regexp *const r = (struct regexp *)SvANY(rx);
9272     GET_RE_DEBUG_FLAGS_DECL;
9273
9274     PERL_ARGS_ASSERT_PREGFREE2;
9275
9276     if (r->mother_re) {
9277         ReREFCNT_dec(r->mother_re);
9278     } else {
9279         CALLREGFREE_PVT(rx); /* free the private data */
9280         if (RXp_PAREN_NAMES(r))
9281             SvREFCNT_dec(RXp_PAREN_NAMES(r));
9282     }        
9283     if (r->substrs) {
9284         if (r->anchored_substr)
9285             SvREFCNT_dec(r->anchored_substr);
9286         if (r->anchored_utf8)
9287             SvREFCNT_dec(r->anchored_utf8);
9288         if (r->float_substr)
9289             SvREFCNT_dec(r->float_substr);
9290         if (r->float_utf8)
9291             SvREFCNT_dec(r->float_utf8);
9292         Safefree(r->substrs);
9293     }
9294     RX_MATCH_COPY_FREE(rx);
9295 #ifdef PERL_OLD_COPY_ON_WRITE
9296     if (r->saved_copy)
9297         SvREFCNT_dec(r->saved_copy);
9298 #endif
9299     Safefree(r->swap);
9300     Safefree(r->offs);
9301 }
9302
9303 /*  reg_temp_copy()
9304     
9305     This is a hacky workaround to the structural issue of match results
9306     being stored in the regexp structure which is in turn stored in
9307     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
9308     could be PL_curpm in multiple contexts, and could require multiple
9309     result sets being associated with the pattern simultaneously, such
9310     as when doing a recursive match with (??{$qr})
9311     
9312     The solution is to make a lightweight copy of the regexp structure 
9313     when a qr// is returned from the code executed by (??{$qr}) this
9314     lightweight copy doesnt actually own any of its data except for
9315     the starp/end and the actual regexp structure itself. 
9316     
9317 */    
9318     
9319     
9320 REGEXP *
9321 Perl_reg_temp_copy (pTHX_ REGEXP *rx)
9322 {
9323     REGEXP *ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
9324     struct regexp *ret = (struct regexp *)SvANY(ret_x);
9325     struct regexp *const r = (struct regexp *)SvANY(rx);
9326     register const I32 npar = r->nparens+1;
9327
9328     PERL_ARGS_ASSERT_REG_TEMP_COPY;
9329
9330     (void)ReREFCNT_inc(rx);
9331     /* We can take advantage of the existing "copied buffer" mechanism in SVs
9332        by pointing directly at the buffer, but flagging that the allocated
9333        space in the copy is zero. As we've just done a struct copy, it's now
9334        a case of zero-ing that, rather than copying the current length.  */
9335     SvPV_set(ret_x, RX_WRAPPED(rx));
9336     SvFLAGS(ret_x) |= SvFLAGS(rx) & (SVf_POK|SVp_POK|SVf_UTF8);
9337     StructCopy(&(r->xpv_cur), &(ret->xpv_cur), struct regexp_allocated);
9338     SvLEN_set(ret_x, 0);
9339     Newx(ret->offs, npar, regexp_paren_pair);
9340     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
9341     if (r->substrs) {
9342         Newx(ret->substrs, 1, struct reg_substr_data);
9343         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
9344
9345         SvREFCNT_inc_void(ret->anchored_substr);
9346         SvREFCNT_inc_void(ret->anchored_utf8);
9347         SvREFCNT_inc_void(ret->float_substr);
9348         SvREFCNT_inc_void(ret->float_utf8);
9349
9350         /* check_substr and check_utf8, if non-NULL, point to either their
9351            anchored or float namesakes, and don't hold a second reference.  */
9352     }
9353     RX_MATCH_COPIED_off(ret_x);
9354 #ifdef PERL_OLD_COPY_ON_WRITE
9355     ret->saved_copy = NULL;
9356 #endif
9357     ret->mother_re = rx;
9358     ret->swap = NULL;
9359     
9360     return ret_x;
9361 }
9362 #endif
9363
9364 /* regfree_internal() 
9365
9366    Free the private data in a regexp. This is overloadable by 
9367    extensions. Perl takes care of the regexp structure in pregfree(), 
9368    this covers the *pprivate pointer which technically perldoesnt 
9369    know about, however of course we have to handle the 
9370    regexp_internal structure when no extension is in use. 
9371    
9372    Note this is called before freeing anything in the regexp 
9373    structure. 
9374  */
9375  
9376 void
9377 Perl_regfree_internal(pTHX_ REGEXP * const rx)
9378 {
9379     dVAR;
9380     struct regexp *const r = (struct regexp *)SvANY(rx);
9381     RXi_GET_DECL(r,ri);
9382     GET_RE_DEBUG_FLAGS_DECL;
9383
9384     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
9385
9386     DEBUG_COMPILE_r({
9387         if (!PL_colorset)
9388             reginitcolors();
9389         {
9390             SV *dsv= sv_newmortal();
9391             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
9392                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
9393             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
9394                 PL_colors[4],PL_colors[5],s);
9395         }
9396     });
9397 #ifdef RE_TRACK_PATTERN_OFFSETS
9398     if (ri->u.offsets)
9399         Safefree(ri->u.offsets);             /* 20010421 MJD */
9400 #endif
9401     if (ri->data) {
9402         int n = ri->data->count;
9403         PAD* new_comppad = NULL;
9404         PAD* old_comppad;
9405         PADOFFSET refcnt;
9406
9407         while (--n >= 0) {
9408           /* If you add a ->what type here, update the comment in regcomp.h */
9409             switch (ri->data->what[n]) {
9410             case 's':
9411             case 'S':
9412             case 'u':
9413                 SvREFCNT_dec((SV*)ri->data->data[n]);
9414                 break;
9415             case 'f':
9416                 Safefree(ri->data->data[n]);
9417                 break;
9418             case 'p':
9419                 new_comppad = (AV*)ri->data->data[n];
9420                 break;
9421             case 'o':
9422                 if (new_comppad == NULL)
9423                     Perl_croak(aTHX_ "panic: pregfree comppad");
9424                 PAD_SAVE_LOCAL(old_comppad,
9425                     /* Watch out for global destruction's random ordering. */
9426                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
9427                 );
9428                 OP_REFCNT_LOCK;
9429                 refcnt = OpREFCNT_dec((OP_4tree*)ri->data->data[n]);
9430                 OP_REFCNT_UNLOCK;
9431                 if (!refcnt)
9432                     op_free((OP_4tree*)ri->data->data[n]);
9433
9434                 PAD_RESTORE_LOCAL(old_comppad);
9435                 SvREFCNT_dec((SV*)new_comppad);
9436                 new_comppad = NULL;
9437                 break;
9438             case 'n':
9439                 break;
9440             case 'T':           
9441                 { /* Aho Corasick add-on structure for a trie node.
9442                      Used in stclass optimization only */
9443                     U32 refcount;
9444                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
9445                     OP_REFCNT_LOCK;
9446                     refcount = --aho->refcount;
9447                     OP_REFCNT_UNLOCK;
9448                     if ( !refcount ) {
9449                         PerlMemShared_free(aho->states);
9450                         PerlMemShared_free(aho->fail);
9451                          /* do this last!!!! */
9452                         PerlMemShared_free(ri->data->data[n]);
9453                         PerlMemShared_free(ri->regstclass);
9454                     }
9455                 }
9456                 break;
9457             case 't':
9458                 {
9459                     /* trie structure. */
9460                     U32 refcount;
9461                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
9462                     OP_REFCNT_LOCK;
9463                     refcount = --trie->refcount;
9464                     OP_REFCNT_UNLOCK;
9465                     if ( !refcount ) {
9466                         PerlMemShared_free(trie->charmap);
9467                         PerlMemShared_free(trie->states);
9468                         PerlMemShared_free(trie->trans);
9469                         if (trie->bitmap)
9470                             PerlMemShared_free(trie->bitmap);
9471                         if (trie->wordlen)
9472                             PerlMemShared_free(trie->wordlen);
9473                         if (trie->jump)
9474                             PerlMemShared_free(trie->jump);
9475                         if (trie->nextword)
9476                             PerlMemShared_free(trie->nextword);
9477                         /* do this last!!!! */
9478                         PerlMemShared_free(ri->data->data[n]);
9479                     }
9480                 }
9481                 break;
9482             default:
9483                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
9484             }
9485         }
9486         Safefree(ri->data->what);
9487         Safefree(ri->data);
9488     }
9489
9490     Safefree(ri);
9491 }
9492
9493 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
9494 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9495 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
9496 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
9497
9498 /* 
9499    re_dup - duplicate a regexp. 
9500    
9501    This routine is expected to clone a given regexp structure. It is not
9502    compiler under USE_ITHREADS.
9503
9504    After all of the core data stored in struct regexp is duplicated
9505    the regexp_engine.dupe method is used to copy any private data
9506    stored in the *pprivate pointer. This allows extensions to handle
9507    any duplication it needs to do.
9508
9509    See pregfree() and regfree_internal() if you change anything here. 
9510 */
9511 #if defined(USE_ITHREADS)
9512 #ifndef PERL_IN_XSUB_RE
9513 void
9514 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
9515 {
9516     dVAR;
9517     I32 npar;
9518     const struct regexp *r = (const struct regexp *)SvANY(sstr);
9519     struct regexp *ret = (struct regexp *)SvANY(dstr);
9520     
9521     PERL_ARGS_ASSERT_RE_DUP_GUTS;
9522
9523     npar = r->nparens+1;
9524     Newx(ret->offs, npar, regexp_paren_pair);
9525     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
9526     if(ret->swap) {
9527         /* no need to copy these */
9528         Newx(ret->swap, npar, regexp_paren_pair);
9529     }
9530
9531     if (ret->substrs) {
9532         /* Do it this way to avoid reading from *r after the StructCopy().
9533            That way, if any of the sv_dup_inc()s dislodge *r from the L1
9534            cache, it doesn't matter.  */
9535         const bool anchored = r->check_substr
9536             ? r->check_substr == r->anchored_substr
9537             : r->check_utf8 == r->anchored_utf8;
9538         Newx(ret->substrs, 1, struct reg_substr_data);
9539         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
9540
9541         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
9542         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
9543         ret->float_substr = sv_dup_inc(ret->float_substr, param);
9544         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
9545
9546         /* check_substr and check_utf8, if non-NULL, point to either their
9547            anchored or float namesakes, and don't hold a second reference.  */
9548
9549         if (ret->check_substr) {
9550             if (anchored) {
9551                 assert(r->check_utf8 == r->anchored_utf8);
9552                 ret->check_substr = ret->anchored_substr;
9553                 ret->check_utf8 = ret->anchored_utf8;
9554             } else {
9555                 assert(r->check_substr == r->float_substr);
9556                 assert(r->check_utf8 == r->float_utf8);
9557                 ret->check_substr = ret->float_substr;
9558                 ret->check_utf8 = ret->float_utf8;
9559             }
9560         } else if (ret->check_utf8) {
9561             if (anchored) {
9562                 ret->check_utf8 = ret->anchored_utf8;
9563             } else {
9564                 ret->check_utf8 = ret->float_utf8;
9565             }
9566         }
9567     }
9568
9569     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
9570
9571     if (ret->pprivate)
9572         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
9573
9574     if (RX_MATCH_COPIED(dstr))
9575         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
9576     else
9577         ret->subbeg = NULL;
9578 #ifdef PERL_OLD_COPY_ON_WRITE
9579     ret->saved_copy = NULL;
9580 #endif
9581
9582     ret->mother_re      = NULL;
9583     ret->gofs = 0;
9584 }
9585 #endif /* PERL_IN_XSUB_RE */
9586
9587 /*
9588    regdupe_internal()
9589    
9590    This is the internal complement to regdupe() which is used to copy
9591    the structure pointed to by the *pprivate pointer in the regexp.
9592    This is the core version of the extension overridable cloning hook.
9593    The regexp structure being duplicated will be copied by perl prior
9594    to this and will be provided as the regexp *r argument, however 
9595    with the /old/ structures pprivate pointer value. Thus this routine
9596    may override any copying normally done by perl.
9597    
9598    It returns a pointer to the new regexp_internal structure.
9599 */
9600
9601 void *
9602 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
9603 {
9604     dVAR;
9605     struct regexp *const r = (struct regexp *)SvANY(rx);
9606     regexp_internal *reti;
9607     int len, npar;
9608     RXi_GET_DECL(r,ri);
9609
9610     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
9611     
9612     npar = r->nparens+1;
9613     len = ProgLen(ri);
9614     
9615     Newxc(reti, sizeof(regexp_internal) + (len+1)*sizeof(regnode), char, regexp_internal);
9616     Copy(ri->program, reti->program, len+1, regnode);
9617     
9618
9619     reti->regstclass = NULL;
9620
9621     if (ri->data) {
9622         struct reg_data *d;
9623         const int count = ri->data->count;
9624         int i;
9625
9626         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
9627                 char, struct reg_data);
9628         Newx(d->what, count, U8);
9629
9630         d->count = count;
9631         for (i = 0; i < count; i++) {
9632             d->what[i] = ri->data->what[i];
9633             switch (d->what[i]) {
9634                 /* legal options are one of: sSfpontTu
9635                    see also regcomp.h and pregfree() */
9636             case 's':
9637             case 'S':
9638             case 'p': /* actually an AV, but the dup function is identical.  */
9639             case 'u': /* actually an HV, but the dup function is identical.  */
9640                 d->data[i] = sv_dup_inc((SV *)ri->data->data[i], param);
9641                 break;
9642             case 'f':
9643                 /* This is cheating. */
9644                 Newx(d->data[i], 1, struct regnode_charclass_class);
9645                 StructCopy(ri->data->data[i], d->data[i],
9646                             struct regnode_charclass_class);
9647                 reti->regstclass = (regnode*)d->data[i];
9648                 break;
9649             case 'o':
9650                 /* Compiled op trees are readonly and in shared memory,
9651                    and can thus be shared without duplication. */
9652                 OP_REFCNT_LOCK;
9653                 d->data[i] = (void*)OpREFCNT_inc((OP*)ri->data->data[i]);
9654                 OP_REFCNT_UNLOCK;
9655                 break;
9656             case 'T':
9657                 /* Trie stclasses are readonly and can thus be shared
9658                  * without duplication. We free the stclass in pregfree
9659                  * when the corresponding reg_ac_data struct is freed.
9660                  */
9661                 reti->regstclass= ri->regstclass;
9662                 /* Fall through */
9663             case 't':
9664                 OP_REFCNT_LOCK;
9665                 ((reg_trie_data*)ri->data->data[i])->refcount++;
9666                 OP_REFCNT_UNLOCK;
9667                 /* Fall through */
9668             case 'n':
9669                 d->data[i] = ri->data->data[i];
9670                 break;
9671             default:
9672                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
9673             }
9674         }
9675
9676         reti->data = d;
9677     }
9678     else
9679         reti->data = NULL;
9680
9681     reti->name_list_idx = ri->name_list_idx;
9682
9683 #ifdef RE_TRACK_PATTERN_OFFSETS
9684     if (ri->u.offsets) {
9685         Newx(reti->u.offsets, 2*len+1, U32);
9686         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
9687     }
9688 #else
9689     SetProgLen(reti,len);
9690 #endif
9691
9692     return (void*)reti;
9693 }
9694
9695 #endif    /* USE_ITHREADS */
9696
9697 #ifndef PERL_IN_XSUB_RE
9698
9699 /*
9700  - regnext - dig the "next" pointer out of a node
9701  */
9702 regnode *
9703 Perl_regnext(pTHX_ register regnode *p)
9704 {
9705     dVAR;
9706     register I32 offset;
9707
9708     if (!p)
9709         return(NULL);
9710
9711     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
9712     if (offset == 0)
9713         return(NULL);
9714
9715     return(p+offset);
9716 }
9717 #endif
9718
9719 STATIC void     
9720 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
9721 {
9722     va_list args;
9723     STRLEN l1 = strlen(pat1);
9724     STRLEN l2 = strlen(pat2);
9725     char buf[512];
9726     SV *msv;
9727     const char *message;
9728
9729     PERL_ARGS_ASSERT_RE_CROAK2;
9730
9731     if (l1 > 510)
9732         l1 = 510;
9733     if (l1 + l2 > 510)
9734         l2 = 510 - l1;
9735     Copy(pat1, buf, l1 , char);
9736     Copy(pat2, buf + l1, l2 , char);
9737     buf[l1 + l2] = '\n';
9738     buf[l1 + l2 + 1] = '\0';
9739 #ifdef I_STDARG
9740     /* ANSI variant takes additional second argument */
9741     va_start(args, pat2);
9742 #else
9743     va_start(args);
9744 #endif
9745     msv = vmess(buf, &args);
9746     va_end(args);
9747     message = SvPV_const(msv,l1);
9748     if (l1 > 512)
9749         l1 = 512;
9750     Copy(message, buf, l1 , char);
9751     buf[l1-1] = '\0';                   /* Overwrite \n */
9752     Perl_croak(aTHX_ "%s", buf);
9753 }
9754
9755 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
9756
9757 #ifndef PERL_IN_XSUB_RE
9758 void
9759 Perl_save_re_context(pTHX)
9760 {
9761     dVAR;
9762
9763     struct re_save_state *state;
9764
9765     SAVEVPTR(PL_curcop);
9766     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
9767
9768     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
9769     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
9770     SSPUSHINT(SAVEt_RE_STATE);
9771
9772     Copy(&PL_reg_state, state, 1, struct re_save_state);
9773
9774     PL_reg_start_tmp = 0;
9775     PL_reg_start_tmpl = 0;
9776     PL_reg_oldsaved = NULL;
9777     PL_reg_oldsavedlen = 0;
9778     PL_reg_maxiter = 0;
9779     PL_reg_leftiter = 0;
9780     PL_reg_poscache = NULL;
9781     PL_reg_poscache_size = 0;
9782 #ifdef PERL_OLD_COPY_ON_WRITE
9783     PL_nrs = NULL;
9784 #endif
9785
9786     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
9787     if (PL_curpm) {
9788         const REGEXP * const rx = PM_GETRE(PL_curpm);
9789         if (rx) {
9790             U32 i;
9791             for (i = 1; i <= RX_NPARENS(rx); i++) {
9792                 char digits[TYPE_CHARS(long)];
9793                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
9794                 GV *const *const gvp
9795                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
9796
9797                 if (gvp) {
9798                     GV * const gv = *gvp;
9799                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
9800                         save_scalar(gv);
9801                 }
9802             }
9803         }
9804     }
9805 }
9806 #endif
9807
9808 static void
9809 clear_re(pTHX_ void *r)
9810 {
9811     dVAR;
9812     ReREFCNT_dec((REGEXP *)r);
9813 }
9814
9815 #ifdef DEBUGGING
9816
9817 STATIC void
9818 S_put_byte(pTHX_ SV *sv, int c)
9819 {
9820     PERL_ARGS_ASSERT_PUT_BYTE;
9821
9822     /* Our definition of isPRINT() ignores locales, so only bytes that are
9823        not part of UTF-8 are considered printable. I assume that the same
9824        holds for UTF-EBCDIC.
9825        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
9826        which Wikipedia says:
9827
9828        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
9829        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
9830        identical, to the ASCII delete (DEL) or rubout control character.
9831        ) So the old condition can be simplified to !isPRINT(c)  */
9832     if (!isPRINT(c))
9833         Perl_sv_catpvf(aTHX_ sv, "\\%o", c);
9834     else {
9835         const char string = c;
9836         if (c == '-' || c == ']' || c == '\\' || c == '^')
9837             sv_catpvs(sv, "\\");
9838         sv_catpvn(sv, &string, 1);
9839     }
9840 }
9841
9842
9843 #define CLEAR_OPTSTART \
9844     if (optstart) STMT_START { \
9845             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
9846             optstart=NULL; \
9847     } STMT_END
9848
9849 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
9850
9851 STATIC const regnode *
9852 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
9853             const regnode *last, const regnode *plast, 
9854             SV* sv, I32 indent, U32 depth)
9855 {
9856     dVAR;
9857     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
9858     register const regnode *next;
9859     const regnode *optstart= NULL;
9860     
9861     RXi_GET_DECL(r,ri);
9862     GET_RE_DEBUG_FLAGS_DECL;
9863
9864     PERL_ARGS_ASSERT_DUMPUNTIL;
9865
9866 #ifdef DEBUG_DUMPUNTIL
9867     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
9868         last ? last-start : 0,plast ? plast-start : 0);
9869 #endif
9870             
9871     if (plast && plast < last) 
9872         last= plast;
9873
9874     while (PL_regkind[op] != END && (!last || node < last)) {
9875         /* While that wasn't END last time... */
9876         NODE_ALIGN(node);
9877         op = OP(node);
9878         if (op == CLOSE || op == WHILEM)
9879             indent--;
9880         next = regnext((regnode *)node);
9881
9882         /* Where, what. */
9883         if (OP(node) == OPTIMIZED) {
9884             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
9885                 optstart = node;
9886             else
9887                 goto after_print;
9888         } else
9889             CLEAR_OPTSTART;
9890         
9891         regprop(r, sv, node);
9892         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
9893                       (int)(2*indent + 1), "", SvPVX_const(sv));
9894         
9895         if (OP(node) != OPTIMIZED) {                  
9896             if (next == NULL)           /* Next ptr. */
9897                 PerlIO_printf(Perl_debug_log, " (0)");
9898             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
9899                 PerlIO_printf(Perl_debug_log, " (FAIL)");
9900             else 
9901                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
9902             (void)PerlIO_putc(Perl_debug_log, '\n'); 
9903         }
9904         
9905       after_print:
9906         if (PL_regkind[(U8)op] == BRANCHJ) {
9907             assert(next);
9908             {
9909                 register const regnode *nnode = (OP(next) == LONGJMP
9910                                              ? regnext((regnode *)next)
9911                                              : next);
9912                 if (last && nnode > last)
9913                     nnode = last;
9914                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
9915             }
9916         }
9917         else if (PL_regkind[(U8)op] == BRANCH) {
9918             assert(next);
9919             DUMPUNTIL(NEXTOPER(node), next);
9920         }
9921         else if ( PL_regkind[(U8)op]  == TRIE ) {
9922             const regnode *this_trie = node;
9923             const char op = OP(node);
9924             const U32 n = ARG(node);
9925             const reg_ac_data * const ac = op>=AHOCORASICK ?
9926                (reg_ac_data *)ri->data->data[n] :
9927                NULL;
9928             const reg_trie_data * const trie =
9929                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
9930 #ifdef DEBUGGING
9931             AV *const trie_words = (AV *) ri->data->data[n + TRIE_WORDS_OFFSET];
9932 #endif
9933             const regnode *nextbranch= NULL;
9934             I32 word_idx;
9935             sv_setpvn(sv, "", 0);
9936             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
9937                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
9938                 
9939                 PerlIO_printf(Perl_debug_log, "%*s%s ",
9940                    (int)(2*(indent+3)), "",
9941                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
9942                             PL_colors[0], PL_colors[1],
9943                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
9944                             PERL_PV_PRETTY_ELLIPSES    |
9945                             PERL_PV_PRETTY_LTGT
9946                             )
9947                             : "???"
9948                 );
9949                 if (trie->jump) {
9950                     U16 dist= trie->jump[word_idx+1];
9951                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
9952                                   (UV)((dist ? this_trie + dist : next) - start));
9953                     if (dist) {
9954                         if (!nextbranch)
9955                             nextbranch= this_trie + trie->jump[0];    
9956                         DUMPUNTIL(this_trie + dist, nextbranch);
9957                     }
9958                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
9959                         nextbranch= regnext((regnode *)nextbranch);
9960                 } else {
9961                     PerlIO_printf(Perl_debug_log, "\n");
9962                 }
9963             }
9964             if (last && next > last)
9965                 node= last;
9966             else
9967                 node= next;
9968         }
9969         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
9970             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
9971                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
9972         }
9973         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
9974             assert(next);
9975             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
9976         }
9977         else if ( op == PLUS || op == STAR) {
9978             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
9979         }
9980         else if (op == ANYOF) {
9981             /* arglen 1 + class block */
9982             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_LARGE)
9983                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
9984             node = NEXTOPER(node);
9985         }
9986         else if (PL_regkind[(U8)op] == EXACT) {
9987             /* Literal string, where present. */
9988             node += NODE_SZ_STR(node) - 1;
9989             node = NEXTOPER(node);
9990         }
9991         else {
9992             node = NEXTOPER(node);
9993             node += regarglen[(U8)op];
9994         }
9995         if (op == CURLYX || op == OPEN)
9996             indent++;
9997     }
9998     CLEAR_OPTSTART;
9999 #ifdef DEBUG_DUMPUNTIL    
10000     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
10001 #endif
10002     return node;
10003 }
10004
10005 #endif  /* DEBUGGING */
10006
10007 /*
10008  * Local variables:
10009  * c-indentation-style: bsd
10010  * c-basic-offset: 4
10011  * indent-tabs-mode: t
10012  * End:
10013  *
10014  * ex: set ts=8 sts=4 sw=4 noet:
10015  */