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