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