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