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