Re: [perl #41010] (?(COND)) in pattern matching not working properly
[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 /* these make a few things look better, to avoid indentation */
3969 #define BEGIN_BLOCK {
3970 #define END_BLOCK }
3971  
3972 regexp *
3973 Perl_pregcomp(pTHX_ char *exp, char *xend, PMOP *pm)
3974 {
3975     dVAR;
3976     GET_RE_DEBUG_FLAGS_DECL;
3977     DEBUG_r(if (!PL_colorset) reginitcolors());
3978 #ifndef PERL_IN_XSUB_RE
3979     BEGIN_BLOCK
3980     /* Dispatch a request to compile a regexp to correct 
3981        regexp engine. */
3982     HV * const table = GvHV(PL_hintgv);
3983     if (table) {
3984         SV **ptr= hv_fetchs(table, "regcomp", FALSE);
3985         if (ptr && SvIOK(*ptr) && SvIV(*ptr)) {
3986             const regexp_engine *eng=INT2PTR(regexp_engine*,SvIV(*ptr));
3987             DEBUG_COMPILE_r({
3988                 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
3989                     SvIV(*ptr));
3990             });            
3991             return CALLREGCOMP_ENG(eng, exp, xend, pm);
3992         } 
3993     }
3994     END_BLOCK
3995 #endif
3996     BEGIN_BLOCK    
3997     register regexp *r;
3998     register regexp_internal *ri;
3999     regnode *scan;
4000     regnode *first;
4001     I32 flags;
4002     I32 minlen = 0;
4003     I32 sawplus = 0;
4004     I32 sawopen = 0;
4005     scan_data_t data;
4006     RExC_state_t RExC_state;
4007     RExC_state_t * const pRExC_state = &RExC_state;
4008 #ifdef TRIE_STUDY_OPT    
4009     int restudied= 0;
4010     RExC_state_t copyRExC_state;
4011 #endif    
4012     if (exp == NULL)
4013         FAIL("NULL regexp argument");
4014
4015     RExC_utf8 = pm->op_pmdynflags & PMdf_CMP_UTF8;
4016
4017     RExC_precomp = exp;
4018     DEBUG_COMPILE_r({
4019         SV *dsv= sv_newmortal();
4020         RE_PV_QUOTED_DECL(s, RExC_utf8,
4021             dsv, RExC_precomp, (xend - exp), 60);
4022         PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
4023                        PL_colors[4],PL_colors[5],s);
4024     });
4025     RExC_flags = pm->op_pmflags;
4026     RExC_sawback = 0;
4027
4028     RExC_seen = 0;
4029     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
4030     RExC_seen_evals = 0;
4031     RExC_extralen = 0;
4032
4033     /* First pass: determine size, legality. */
4034     RExC_parse = exp;
4035     RExC_start = exp;
4036     RExC_end = xend;
4037     RExC_naughty = 0;
4038     RExC_npar = 1;
4039     RExC_nestroot = 0;
4040     RExC_size = 0L;
4041     RExC_emit = &PL_regdummy;
4042     RExC_whilem_seen = 0;
4043     RExC_charnames = NULL;
4044     RExC_open_parens = NULL;
4045     RExC_close_parens = NULL;
4046     RExC_opend = NULL;
4047     RExC_paren_names = NULL;
4048     RExC_recurse = NULL;
4049     RExC_recurse_count = 0;
4050
4051 #if 0 /* REGC() is (currently) a NOP at the first pass.
4052        * Clever compilers notice this and complain. --jhi */
4053     REGC((U8)REG_MAGIC, (char*)RExC_emit);
4054 #endif
4055     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n"));
4056     if (reg(pRExC_state, 0, &flags,1) == NULL) {
4057         RExC_precomp = NULL;
4058         return(NULL);
4059     }
4060     DEBUG_PARSE_r({
4061         PerlIO_printf(Perl_debug_log, 
4062             "Required size %"IVdf" nodes\n"
4063             "Starting second pass (creation)\n", 
4064             (IV)RExC_size);
4065         RExC_lastnum=0; 
4066         RExC_lastparse=NULL; 
4067     });
4068     /* Small enough for pointer-storage convention?
4069        If extralen==0, this means that we will not need long jumps. */
4070     if (RExC_size >= 0x10000L && RExC_extralen)
4071         RExC_size += RExC_extralen;
4072     else
4073         RExC_extralen = 0;
4074     if (RExC_whilem_seen > 15)
4075         RExC_whilem_seen = 15;
4076
4077 #ifdef DEBUGGING
4078     /* Make room for a sentinel value at the end of the program */
4079     RExC_size++;
4080 #endif
4081
4082     /* Allocate space and zero-initialize. Note, the two step process 
4083        of zeroing when in debug mode, thus anything assigned has to 
4084        happen after that */
4085     Newxz(r, 1, regexp);
4086     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
4087          char, regexp_internal);
4088     if ( r == NULL || ri == NULL )
4089         FAIL("Regexp out of space");
4090 #ifdef DEBUGGING
4091     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
4092     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
4093 #else 
4094     /* bulk initialize base fields with 0. */
4095     Zero(ri, sizeof(regexp_internal), char);        
4096 #endif
4097
4098     /* non-zero initialization begins here */
4099     RXi_SET( r, ri );
4100     r->engine= RE_ENGINE_PTR;
4101     r->refcnt = 1;
4102     r->prelen = xend - exp;
4103     r->precomp = savepvn(RExC_precomp, r->prelen);
4104     r->extflags = pm->op_pmflags & RXf_PMf_COMPILETIME;
4105     r->intflags = 0;
4106     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
4107     
4108     if (RExC_seen & REG_SEEN_RECURSE) {
4109         Newxz(RExC_open_parens, RExC_npar,regnode *);
4110         SAVEFREEPV(RExC_open_parens);
4111         Newxz(RExC_close_parens,RExC_npar,regnode *);
4112         SAVEFREEPV(RExC_close_parens);
4113     }
4114
4115     /* Useful during FAIL. */
4116     Newxz(ri->offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
4117     if (ri->offsets) {
4118         ri->offsets[0] = RExC_size;
4119     }
4120     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
4121                           "%s %"UVuf" bytes for offset annotations.\n",
4122                           ri->offsets ? "Got" : "Couldn't get",
4123                           (UV)((2*RExC_size+1) * sizeof(U32))));
4124
4125     RExC_rx = r;
4126     RExC_rxi = ri;
4127
4128     /* Second pass: emit code. */
4129     RExC_flags = pm->op_pmflags;        /* don't let top level (?i) bleed */
4130     RExC_parse = exp;
4131     RExC_end = xend;
4132     RExC_naughty = 0;
4133     RExC_npar = 1;
4134     RExC_emit_start = ri->program;
4135     RExC_emit = ri->program;
4136 #ifdef DEBUGGING
4137     /* put a sentinal on the end of the program so we can check for
4138        overwrites */
4139     ri->program[RExC_size].type = 255;
4140 #endif
4141     /* Store the count of eval-groups for security checks: */
4142     RExC_rx->seen_evals = RExC_seen_evals;
4143     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
4144     if (reg(pRExC_state, 0, &flags,1) == NULL)
4145         return(NULL);
4146
4147     /* XXXX To minimize changes to RE engine we always allocate
4148        3-units-long substrs field. */
4149     Newx(r->substrs, 1, struct reg_substr_data);
4150     if (RExC_recurse_count) {
4151         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
4152         SAVEFREEPV(RExC_recurse);
4153     }
4154
4155 reStudy:
4156     r->minlen = minlen = sawplus = sawopen = 0;
4157     Zero(r->substrs, 1, struct reg_substr_data);
4158
4159 #ifdef TRIE_STUDY_OPT
4160     if ( restudied ) {
4161         U32 seen=RExC_seen;
4162         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
4163         
4164         RExC_state = copyRExC_state;
4165         if (seen & REG_TOP_LEVEL_BRANCHES) 
4166             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
4167         else
4168             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
4169         if (data.last_found) {
4170             SvREFCNT_dec(data.longest_fixed);
4171             SvREFCNT_dec(data.longest_float);
4172             SvREFCNT_dec(data.last_found);
4173         }
4174         StructCopy(&zero_scan_data, &data, scan_data_t);
4175     } else {
4176         StructCopy(&zero_scan_data, &data, scan_data_t);
4177         copyRExC_state = RExC_state;
4178     }
4179 #else
4180     StructCopy(&zero_scan_data, &data, scan_data_t);
4181 #endif    
4182
4183     /* Dig out information for optimizations. */
4184     r->extflags = pm->op_pmflags & RXf_PMf_COMPILETIME; /* Again? */
4185     pm->op_pmflags = RExC_flags;
4186     if (UTF)
4187         r->extflags |= RXf_UTF8;        /* Unicode in it? */
4188     ri->regstclass = NULL;
4189     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
4190         r->intflags |= PREGf_NAUGHTY;
4191     scan = ri->program + 1;             /* First BRANCH. */
4192
4193     /* testing for BRANCH here tells us whether there is "must appear"
4194        data in the pattern. If there is then we can use it for optimisations */
4195     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
4196         I32 fake;
4197         STRLEN longest_float_length, longest_fixed_length;
4198         struct regnode_charclass_class ch_class; /* pointed to by data */
4199         int stclass_flag;
4200         I32 last_close = 0; /* pointed to by data */
4201
4202         first = scan;
4203         /* Skip introductions and multiplicators >= 1. */
4204         while ((OP(first) == OPEN && (sawopen = 1)) ||
4205                /* An OR of *one* alternative - should not happen now. */
4206             (OP(first) == BRANCH && OP(regnext(first)) != BRANCH) ||
4207             /* for now we can't handle lookbehind IFMATCH*/
4208             (OP(first) == IFMATCH && !first->flags) || 
4209             (OP(first) == PLUS) ||
4210             (OP(first) == MINMOD) ||
4211                /* An {n,m} with n>0 */
4212             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ) 
4213         {
4214                 
4215                 if (OP(first) == PLUS)
4216                     sawplus = 1;
4217                 else
4218                     first += regarglen[OP(first)];
4219                 if (OP(first) == IFMATCH) {
4220                     first = NEXTOPER(first);
4221                     first += EXTRA_STEP_2ARGS;
4222                 } else  /* XXX possible optimisation for /(?=)/  */
4223                     first = NEXTOPER(first);
4224         }
4225
4226         /* Starting-point info. */
4227       again:
4228         DEBUG_PEEP("first:",first,0);
4229         /* Ignore EXACT as we deal with it later. */
4230         if (PL_regkind[OP(first)] == EXACT) {
4231             if (OP(first) == EXACT)
4232                 NOOP;   /* Empty, get anchored substr later. */
4233             else if ((OP(first) == EXACTF || OP(first) == EXACTFL))
4234                 ri->regstclass = first;
4235         }
4236 #ifdef TRIE_STCLASS     
4237         else if (PL_regkind[OP(first)] == TRIE &&
4238                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
4239         {
4240             regnode *trie_op;
4241             /* this can happen only on restudy */
4242             if ( OP(first) == TRIE ) {
4243                 struct regnode_1 *trieop =
4244                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
4245                 StructCopy(first,trieop,struct regnode_1);
4246                 trie_op=(regnode *)trieop;
4247             } else {
4248                 struct regnode_charclass *trieop =
4249                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
4250                 StructCopy(first,trieop,struct regnode_charclass);
4251                 trie_op=(regnode *)trieop;
4252             }
4253             OP(trie_op)+=2;
4254             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
4255             ri->regstclass = trie_op;
4256         }
4257 #endif  
4258         else if (strchr((const char*)PL_simple,OP(first)))
4259             ri->regstclass = first;
4260         else if (PL_regkind[OP(first)] == BOUND ||
4261                  PL_regkind[OP(first)] == NBOUND)
4262             ri->regstclass = first;
4263         else if (PL_regkind[OP(first)] == BOL) {
4264             r->extflags |= (OP(first) == MBOL
4265                            ? RXf_ANCH_MBOL
4266                            : (OP(first) == SBOL
4267                               ? RXf_ANCH_SBOL
4268                               : RXf_ANCH_BOL));
4269             first = NEXTOPER(first);
4270             goto again;
4271         }
4272         else if (OP(first) == GPOS) {
4273             r->extflags |= RXf_ANCH_GPOS;
4274             first = NEXTOPER(first);
4275             goto again;
4276         }
4277         else if ((!sawopen || !RExC_sawback) &&
4278             (OP(first) == STAR &&
4279             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
4280             !(r->extflags & RXf_ANCH) && !(RExC_seen & REG_SEEN_EVAL))
4281         {
4282             /* turn .* into ^.* with an implied $*=1 */
4283             const int type =
4284                 (OP(NEXTOPER(first)) == REG_ANY)
4285                     ? RXf_ANCH_MBOL
4286                     : RXf_ANCH_SBOL;
4287             r->extflags |= type;
4288             r->intflags |= PREGf_IMPLICIT;
4289             first = NEXTOPER(first);
4290             goto again;
4291         }
4292         if (sawplus && (!sawopen || !RExC_sawback)
4293             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
4294             /* x+ must match at the 1st pos of run of x's */
4295             r->intflags |= PREGf_SKIP;
4296
4297         /* Scan is after the zeroth branch, first is atomic matcher. */
4298 #ifdef TRIE_STUDY_OPT
4299         DEBUG_PARSE_r(
4300             if (!restudied)
4301                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4302                               (IV)(first - scan + 1))
4303         );
4304 #else
4305         DEBUG_PARSE_r(
4306             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4307                 (IV)(first - scan + 1))
4308         );
4309 #endif
4310
4311
4312         /*
4313         * If there's something expensive in the r.e., find the
4314         * longest literal string that must appear and make it the
4315         * regmust.  Resolve ties in favor of later strings, since
4316         * the regstart check works with the beginning of the r.e.
4317         * and avoiding duplication strengthens checking.  Not a
4318         * strong reason, but sufficient in the absence of others.
4319         * [Now we resolve ties in favor of the earlier string if
4320         * it happens that c_offset_min has been invalidated, since the
4321         * earlier string may buy us something the later one won't.]
4322         */
4323         
4324         data.longest_fixed = newSVpvs("");
4325         data.longest_float = newSVpvs("");
4326         data.last_found = newSVpvs("");
4327         data.longest = &(data.longest_fixed);
4328         first = scan;
4329         if (!ri->regstclass) {
4330             cl_init(pRExC_state, &ch_class);
4331             data.start_class = &ch_class;
4332             stclass_flag = SCF_DO_STCLASS_AND;
4333         } else                          /* XXXX Check for BOUND? */
4334             stclass_flag = 0;
4335         data.last_closep = &last_close;
4336         
4337         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
4338             &data, -1, NULL, NULL,
4339             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
4340
4341         
4342         CHECK_RESTUDY_GOTO;
4343
4344
4345         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
4346              && data.last_start_min == 0 && data.last_end > 0
4347              && !RExC_seen_zerolen
4348              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
4349             r->extflags |= RXf_CHECK_ALL;
4350         scan_commit(pRExC_state, &data,&minlen,0);
4351         SvREFCNT_dec(data.last_found);
4352
4353         /* Note that code very similar to this but for anchored string 
4354            follows immediately below, changes may need to be made to both. 
4355            Be careful. 
4356          */
4357         longest_float_length = CHR_SVLEN(data.longest_float);
4358         if (longest_float_length
4359             || (data.flags & SF_FL_BEFORE_EOL
4360                 && (!(data.flags & SF_FL_BEFORE_MEOL)
4361                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
4362         {
4363             I32 t,ml;
4364
4365             if (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
4366                 && data.offset_fixed == data.offset_float_min
4367                 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float))
4368                     goto remove_float;          /* As in (a)+. */
4369
4370             /* copy the information about the longest float from the reg_scan_data
4371                over to the program. */
4372             if (SvUTF8(data.longest_float)) {
4373                 r->float_utf8 = data.longest_float;
4374                 r->float_substr = NULL;
4375             } else {
4376                 r->float_substr = data.longest_float;
4377                 r->float_utf8 = NULL;
4378             }
4379             /* float_end_shift is how many chars that must be matched that 
4380                follow this item. We calculate it ahead of time as once the
4381                lookbehind offset is added in we lose the ability to correctly
4382                calculate it.*/
4383             ml = data.minlen_float ? *(data.minlen_float) 
4384                                    : (I32)longest_float_length;
4385             r->float_end_shift = ml - data.offset_float_min
4386                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
4387                 + data.lookbehind_float;
4388             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
4389             r->float_max_offset = data.offset_float_max;
4390             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
4391                 r->float_max_offset -= data.lookbehind_float;
4392             
4393             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
4394                        && (!(data.flags & SF_FL_BEFORE_MEOL)
4395                            || (RExC_flags & RXf_PMf_MULTILINE)));
4396             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
4397         }
4398         else {
4399           remove_float:
4400             r->float_substr = r->float_utf8 = NULL;
4401             SvREFCNT_dec(data.longest_float);
4402             longest_float_length = 0;
4403         }
4404
4405         /* Note that code very similar to this but for floating string 
4406            is immediately above, changes may need to be made to both. 
4407            Be careful. 
4408          */
4409         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
4410         if (longest_fixed_length
4411             || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
4412                 && (!(data.flags & SF_FIX_BEFORE_MEOL)
4413                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
4414         {
4415             I32 t,ml;
4416
4417             /* copy the information about the longest fixed 
4418                from the reg_scan_data over to the program. */
4419             if (SvUTF8(data.longest_fixed)) {
4420                 r->anchored_utf8 = data.longest_fixed;
4421                 r->anchored_substr = NULL;
4422             } else {
4423                 r->anchored_substr = data.longest_fixed;
4424                 r->anchored_utf8 = NULL;
4425             }
4426             /* fixed_end_shift is how many chars that must be matched that 
4427                follow this item. We calculate it ahead of time as once the
4428                lookbehind offset is added in we lose the ability to correctly
4429                calculate it.*/
4430             ml = data.minlen_fixed ? *(data.minlen_fixed) 
4431                                    : (I32)longest_fixed_length;
4432             r->anchored_end_shift = ml - data.offset_fixed
4433                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
4434                 + data.lookbehind_fixed;
4435             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
4436
4437             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
4438                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
4439                      || (RExC_flags & RXf_PMf_MULTILINE)));
4440             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
4441         }
4442         else {
4443             r->anchored_substr = r->anchored_utf8 = NULL;
4444             SvREFCNT_dec(data.longest_fixed);
4445             longest_fixed_length = 0;
4446         }
4447         if (ri->regstclass
4448             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
4449             ri->regstclass = NULL;
4450         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
4451             && stclass_flag
4452             && !(data.start_class->flags & ANYOF_EOS)
4453             && !cl_is_anything(data.start_class))
4454         {
4455             const U32 n = add_data(pRExC_state, 1, "f");
4456
4457             Newx(RExC_rxi->data->data[n], 1,
4458                 struct regnode_charclass_class);
4459             StructCopy(data.start_class,
4460                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
4461                        struct regnode_charclass_class);
4462             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
4463             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
4464             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
4465                       regprop(r, sv, (regnode*)data.start_class);
4466                       PerlIO_printf(Perl_debug_log,
4467                                     "synthetic stclass \"%s\".\n",
4468                                     SvPVX_const(sv));});
4469         }
4470
4471         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
4472         if (longest_fixed_length > longest_float_length) {
4473             r->check_end_shift = r->anchored_end_shift;
4474             r->check_substr = r->anchored_substr;
4475             r->check_utf8 = r->anchored_utf8;
4476             r->check_offset_min = r->check_offset_max = r->anchored_offset;
4477             if (r->extflags & RXf_ANCH_SINGLE)
4478                 r->extflags |= RXf_NOSCAN;
4479         }
4480         else {
4481             r->check_end_shift = r->float_end_shift;
4482             r->check_substr = r->float_substr;
4483             r->check_utf8 = r->float_utf8;
4484             r->check_offset_min = r->float_min_offset;
4485             r->check_offset_max = r->float_max_offset;
4486         }
4487         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
4488            This should be changed ASAP!  */
4489         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
4490             r->extflags |= RXf_USE_INTUIT;
4491             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
4492                 r->extflags |= RXf_INTUIT_TAIL;
4493         }
4494         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
4495         if ( (STRLEN)minlen < longest_float_length )
4496             minlen= longest_float_length;
4497         if ( (STRLEN)minlen < longest_fixed_length )
4498             minlen= longest_fixed_length;     
4499         */
4500     }
4501     else {
4502         /* Several toplevels. Best we can is to set minlen. */
4503         I32 fake;
4504         struct regnode_charclass_class ch_class;
4505         I32 last_close = 0;
4506         
4507         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
4508
4509         scan = ri->program + 1;
4510         cl_init(pRExC_state, &ch_class);
4511         data.start_class = &ch_class;
4512         data.last_closep = &last_close;
4513
4514         
4515         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
4516             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
4517         
4518         CHECK_RESTUDY_GOTO;
4519
4520         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
4521                 = r->float_substr = r->float_utf8 = NULL;
4522         if (!(data.start_class->flags & ANYOF_EOS)
4523             && !cl_is_anything(data.start_class))
4524         {
4525             const U32 n = add_data(pRExC_state, 1, "f");
4526
4527             Newx(RExC_rxi->data->data[n], 1,
4528                 struct regnode_charclass_class);
4529             StructCopy(data.start_class,
4530                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
4531                        struct regnode_charclass_class);
4532             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
4533             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
4534             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
4535                       regprop(r, sv, (regnode*)data.start_class);
4536                       PerlIO_printf(Perl_debug_log,
4537                                     "synthetic stclass \"%s\".\n",
4538                                     SvPVX_const(sv));});
4539         }
4540     }
4541
4542     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
4543        the "real" pattern. */
4544     DEBUG_OPTIMISE_r({
4545         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
4546                       (IV)minlen, (IV)r->minlen);
4547     });
4548     r->minlenret = minlen;
4549     if (r->minlen < minlen) 
4550         r->minlen = minlen;
4551     
4552     if (RExC_seen & REG_SEEN_GPOS)
4553         r->extflags |= RXf_GPOS_SEEN;
4554     if (RExC_seen & REG_SEEN_LOOKBEHIND)
4555         r->extflags |= RXf_LOOKBEHIND_SEEN;
4556     if (RExC_seen & REG_SEEN_EVAL)
4557         r->extflags |= RXf_EVAL_SEEN;
4558     if (RExC_seen & REG_SEEN_CANY)
4559         r->extflags |= RXf_CANY_SEEN;
4560     if (RExC_seen & REG_SEEN_VERBARG)
4561         r->intflags |= PREGf_VERBARG_SEEN;
4562     if (RExC_seen & REG_SEEN_CUTGROUP)
4563         r->intflags |= PREGf_CUTGROUP_SEEN;
4564     if (RExC_paren_names)
4565         r->paren_names = (HV*)SvREFCNT_inc(RExC_paren_names);
4566     else
4567         r->paren_names = NULL;
4568                 
4569     if (RExC_recurse_count) {
4570         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
4571             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
4572             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
4573         }
4574     }
4575     Newxz(r->startp, RExC_npar, I32);
4576     Newxz(r->endp, RExC_npar, I32);
4577     /* assume we don't need to swap parens around before we match */
4578
4579     DEBUG_DUMP_r({
4580         PerlIO_printf(Perl_debug_log,"Final program:\n");
4581         regdump(r);
4582     });
4583     DEBUG_OFFSETS_r(if (ri->offsets) {
4584         const U32 len = ri->offsets[0];
4585         U32 i;
4586         GET_RE_DEBUG_FLAGS_DECL;
4587         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->offsets[0]);
4588         for (i = 1; i <= len; i++) {
4589             if (ri->offsets[i*2-1] || ri->offsets[i*2])
4590                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
4591                 (UV)i, (UV)ri->offsets[i*2-1], (UV)ri->offsets[i*2]);
4592             }
4593         PerlIO_printf(Perl_debug_log, "\n");
4594     });
4595     return(r);
4596     END_BLOCK    
4597 }
4598
4599 #undef CORE_ONLY_BLOCK
4600 #undef END_BLOCK
4601 #undef RE_ENGINE_PTR
4602
4603 #ifndef PERL_IN_XSUB_RE
4604 SV*
4605 Perl_reg_named_buff_sv(pTHX_ SV* namesv)
4606 {
4607     I32 parno = 0; /* no match */
4608     if (PL_curpm) {
4609         const REGEXP * const rx = PM_GETRE(PL_curpm);
4610         if (rx && rx->paren_names) {            
4611             HE *he_str = hv_fetch_ent( rx->paren_names, namesv, 0, 0 );
4612             if (he_str) {
4613                 IV i;
4614                 SV* sv_dat=HeVAL(he_str);
4615                 I32 *nums=(I32*)SvPVX(sv_dat);
4616                 for ( i=0; i<SvIVX(sv_dat); i++ ) {
4617                     if ((I32)(rx->lastparen) >= nums[i] &&
4618                         rx->endp[nums[i]] != -1) 
4619                     {
4620                         parno = nums[i];
4621                         break;
4622                     }
4623                 }
4624             }
4625         }
4626     }
4627     if ( !parno ) {
4628         return 0;
4629     } else {
4630         GV *gv_paren;
4631         SV *sv= sv_newmortal();
4632         Perl_sv_setpvf(aTHX_ sv, "%"IVdf,(IV)parno);
4633         gv_paren= Perl_gv_fetchsv(aTHX_ sv, GV_ADD, SVt_PVGV);
4634         return GvSVn(gv_paren);
4635     }
4636 }
4637 #endif
4638
4639 /* Scans the name of a named buffer from the pattern.
4640  * If flags is REG_RSN_RETURN_NULL returns null.
4641  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
4642  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
4643  * to the parsed name as looked up in the RExC_paren_names hash.
4644  * If there is an error throws a vFAIL().. type exception.
4645  */
4646
4647 #define REG_RSN_RETURN_NULL    0
4648 #define REG_RSN_RETURN_NAME    1
4649 #define REG_RSN_RETURN_DATA    2
4650
4651 STATIC SV*
4652 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags) {
4653     char *name_start = RExC_parse;
4654     if ( UTF ) {
4655         STRLEN numlen;
4656         while( isIDFIRST_uni(utf8n_to_uvchr((U8*)RExC_parse,
4657             RExC_end - RExC_parse, &numlen, UTF8_ALLOW_DEFAULT)))
4658         {
4659                 RExC_parse += numlen;
4660         }
4661     } else {
4662         while( isIDFIRST(*RExC_parse) )
4663             RExC_parse++;
4664     }
4665     if ( flags ) {
4666         SV* sv_name = sv_2mortal(Perl_newSVpvn(aTHX_ name_start,
4667             (int)(RExC_parse - name_start)));
4668         if (UTF)
4669             SvUTF8_on(sv_name);
4670         if ( flags == REG_RSN_RETURN_NAME)
4671             return sv_name;
4672         else if (flags==REG_RSN_RETURN_DATA) {
4673             HE *he_str = NULL;
4674             SV *sv_dat = NULL;
4675             if ( ! sv_name )      /* should not happen*/
4676                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
4677             if (RExC_paren_names)
4678                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
4679             if ( he_str )
4680                 sv_dat = HeVAL(he_str);
4681             if ( ! sv_dat )
4682                 vFAIL("Reference to nonexistent named group");
4683             return sv_dat;
4684         }
4685         else {
4686             Perl_croak(aTHX_ "panic: bad flag in reg_scan_name");
4687         }
4688         /* NOT REACHED */
4689     }
4690     return NULL;
4691 }
4692
4693 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
4694     int rem=(int)(RExC_end - RExC_parse);                       \
4695     int cut;                                                    \
4696     int num;                                                    \
4697     int iscut=0;                                                \
4698     if (rem>10) {                                               \
4699         rem=10;                                                 \
4700         iscut=1;                                                \
4701     }                                                           \
4702     cut=10-rem;                                                 \
4703     if (RExC_lastparse!=RExC_parse)                             \
4704         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
4705             rem, RExC_parse,                                    \
4706             cut + 4,                                            \
4707             iscut ? "..." : "<"                                 \
4708         );                                                      \
4709     else                                                        \
4710         PerlIO_printf(Perl_debug_log,"%16s","");                \
4711                                                                 \
4712     if (SIZE_ONLY)                                              \
4713        num=RExC_size;                                           \
4714     else                                                        \
4715        num=REG_NODE_NUM(RExC_emit);                             \
4716     if (RExC_lastnum!=num)                                      \
4717        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
4718     else                                                        \
4719        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
4720     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
4721         (int)((depth*2)), "",                                   \
4722         (funcname)                                              \
4723     );                                                          \
4724     RExC_lastnum=num;                                           \
4725     RExC_lastparse=RExC_parse;                                  \
4726 })
4727
4728
4729
4730 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
4731     DEBUG_PARSE_MSG((funcname));                            \
4732     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
4733 })
4734 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
4735     DEBUG_PARSE_MSG((funcname));                            \
4736     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
4737 })
4738 /*
4739  - reg - regular expression, i.e. main body or parenthesized thing
4740  *
4741  * Caller must absorb opening parenthesis.
4742  *
4743  * Combining parenthesis handling with the base level of regular expression
4744  * is a trifle forced, but the need to tie the tails of the branches to what
4745  * follows makes it hard to avoid.
4746  */
4747 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
4748 #ifdef DEBUGGING
4749 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
4750 #else
4751 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
4752 #endif
4753
4754 /* this idea is borrowed from STR_WITH_LEN in handy.h */
4755 #define CHECK_WORD(s,v,l)  \
4756     (((sizeof(s)-1)==(l)) && (strnEQ(start_verb, (s ""), (sizeof(s)-1))))
4757
4758 STATIC regnode *
4759 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
4760     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
4761 {
4762     dVAR;
4763     register regnode *ret;              /* Will be the head of the group. */
4764     register regnode *br;
4765     register regnode *lastbr;
4766     register regnode *ender = NULL;
4767     register I32 parno = 0;
4768     I32 flags;
4769     const I32 oregflags = RExC_flags;
4770     bool have_branch = 0;
4771     bool is_open = 0;
4772
4773     /* for (?g), (?gc), and (?o) warnings; warning
4774        about (?c) will warn about (?g) -- japhy    */
4775
4776 #define WASTED_O  0x01
4777 #define WASTED_G  0x02
4778 #define WASTED_C  0x04
4779 #define WASTED_GC (0x02|0x04)
4780     I32 wastedflags = 0x00;
4781
4782     char * parse_start = RExC_parse; /* MJD */
4783     char * const oregcomp_parse = RExC_parse;
4784
4785     GET_RE_DEBUG_FLAGS_DECL;
4786     DEBUG_PARSE("reg ");
4787
4788
4789     *flagp = 0;                         /* Tentatively. */
4790
4791
4792     /* Make an OPEN node, if parenthesized. */
4793     if (paren) {
4794         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
4795             char *start_verb = RExC_parse;
4796             STRLEN verb_len = 0;
4797             char *start_arg = NULL;
4798             unsigned char op = 0;
4799             int argok = 1;
4800             int internal_argval = 0; /* internal_argval is only useful if !argok */
4801             while ( *RExC_parse && *RExC_parse != ')' ) {
4802                 if ( *RExC_parse == ':' ) {
4803                     start_arg = RExC_parse + 1;
4804                     break;
4805                 }
4806                 RExC_parse++;
4807             }
4808             ++start_verb;
4809             verb_len = RExC_parse - start_verb;
4810             if ( start_arg ) {
4811                 RExC_parse++;
4812                 while ( *RExC_parse && *RExC_parse != ')' ) 
4813                     RExC_parse++;
4814                 if ( *RExC_parse != ')' ) 
4815                     vFAIL("Unterminated verb pattern argument");
4816                 if ( RExC_parse == start_arg )
4817                     start_arg = NULL;
4818             } else {
4819                 if ( *RExC_parse != ')' )
4820                     vFAIL("Unterminated verb pattern");
4821             }
4822             
4823             switch ( *start_verb ) {
4824             case 'A':  /* (*ACCEPT) */
4825                 if ( CHECK_WORD("ACCEPT",start_verb,verb_len) ) {
4826                     op = ACCEPT;
4827                     internal_argval = RExC_nestroot;
4828                 }
4829                 break;
4830             case 'C':  /* (*COMMIT) */
4831                 if ( CHECK_WORD("COMMIT",start_verb,verb_len) )
4832                     op = COMMIT;
4833                 break;
4834             case 'F':  /* (*FAIL) */
4835                 if ( verb_len==1 || CHECK_WORD("FAIL",start_verb,verb_len) ) {
4836                     op = OPFAIL;
4837                     argok = 0;
4838                 }
4839                 break;
4840             case ':':  /* (*:NAME) */
4841             case 'M':  /* (*MARK:NAME) */
4842                 if ( verb_len==0 || CHECK_WORD("MARK",start_verb,verb_len) ) {
4843                     op = MARKPOINT;
4844                     argok = -1;
4845                 }
4846                 break;
4847             case 'P':  /* (*PRUNE) */
4848                 if ( CHECK_WORD("PRUNE",start_verb,verb_len) )
4849                     op = PRUNE;
4850                 break;
4851             case 'S':   /* (*SKIP) */  
4852                 if ( CHECK_WORD("SKIP",start_verb,verb_len) ) 
4853                     op = SKIP;
4854                 break;
4855             case 'T':  /* (*THEN) */
4856                 /* [19:06] <TimToady> :: is then */
4857                 if ( CHECK_WORD("THEN",start_verb,verb_len) ) {
4858                     op = CUTGROUP;
4859                     RExC_seen |= REG_SEEN_CUTGROUP;
4860                 }
4861                 break;
4862             }
4863             if ( ! op ) {
4864                 RExC_parse++;
4865                 vFAIL3("Unknown verb pattern '%.*s'",
4866                     verb_len, start_verb);
4867             }
4868             if ( argok ) {
4869                 if ( start_arg && internal_argval ) {
4870                     vFAIL3("Verb pattern '%.*s' may not have an argument",
4871                         verb_len, start_verb); 
4872                 } else if ( argok < 0 && !start_arg ) {
4873                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
4874                         verb_len, start_verb);    
4875                 } else {
4876                     ret = reganode(pRExC_state, op, internal_argval);
4877                     if ( ! internal_argval && ! SIZE_ONLY ) {
4878                         if (start_arg) {
4879                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
4880                             ARG(ret) = add_data( pRExC_state, 1, "S" );
4881                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
4882                             ret->flags = 0;
4883                         } else {
4884                             ret->flags = 1; 
4885                         }
4886                     }               
4887                 }
4888                 if (!internal_argval)
4889                     RExC_seen |= REG_SEEN_VERBARG;
4890             } else if ( start_arg ) {
4891                 vFAIL3("Verb pattern '%.*s' may not have an argument",
4892                         verb_len, start_verb);    
4893             } else {
4894                 ret = reg_node(pRExC_state, op);
4895             }
4896             nextchar(pRExC_state);
4897             return ret;
4898         } else 
4899         if (*RExC_parse == '?') { /* (?...) */
4900             U32 posflags = 0, negflags = 0;
4901             U32 *flagsp = &posflags;
4902             bool is_logical = 0;
4903             const char * const seqstart = RExC_parse;
4904
4905             RExC_parse++;
4906             paren = *RExC_parse++;
4907             ret = NULL;                 /* For look-ahead/behind. */
4908             switch (paren) {
4909
4910             case '<':           /* (?<...) */
4911                 if (*RExC_parse == '!')
4912                     paren = ',';
4913                 else if (*RExC_parse != '=') 
4914                 {               /* (?<...>) */
4915                     char *name_start;
4916                     SV *svname;
4917                     paren= '>';
4918             case '\'':          /* (?'...') */
4919                     name_start= RExC_parse;
4920                     svname = reg_scan_name(pRExC_state,
4921                         SIZE_ONLY ?  /* reverse test from the others */
4922                         REG_RSN_RETURN_NAME : 
4923                         REG_RSN_RETURN_NULL);
4924                     if (RExC_parse == name_start)
4925                         goto unknown;
4926                     if (*RExC_parse != paren)
4927                         vFAIL2("Sequence (?%c... not terminated",
4928                             paren=='>' ? '<' : paren);
4929                     if (SIZE_ONLY) {
4930                         HE *he_str;
4931                         SV *sv_dat = NULL;
4932                         if (!svname) /* shouldnt happen */
4933                             Perl_croak(aTHX_
4934                                 "panic: reg_scan_name returned NULL");
4935                         if (!RExC_paren_names) {
4936                             RExC_paren_names= newHV();
4937                             sv_2mortal((SV*)RExC_paren_names);
4938                         }
4939                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
4940                         if ( he_str )
4941                             sv_dat = HeVAL(he_str);
4942                         if ( ! sv_dat ) {
4943                             /* croak baby croak */
4944                             Perl_croak(aTHX_
4945                                 "panic: paren_name hash element allocation failed");
4946                         } else if ( SvPOK(sv_dat) ) {
4947                             IV count=SvIV(sv_dat);
4948                             I32 *pv=(I32*)SvGROW(sv_dat,SvCUR(sv_dat)+sizeof(I32)+1);
4949                             SvCUR_set(sv_dat,SvCUR(sv_dat)+sizeof(I32));
4950                             pv[count]=RExC_npar;
4951                             SvIVX(sv_dat)++;
4952                         } else {
4953                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
4954                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
4955                             SvIOK_on(sv_dat);
4956                             SvIVX(sv_dat)= 1;
4957                         }
4958
4959                         /*sv_dump(sv_dat);*/
4960                     }
4961                     nextchar(pRExC_state);
4962                     paren = 1;
4963                     goto capturing_parens;
4964                 }
4965                 RExC_seen |= REG_SEEN_LOOKBEHIND;
4966                 RExC_parse++;
4967             case '=':           /* (?=...) */
4968             case '!':           /* (?!...) */
4969                 RExC_seen_zerolen++;
4970                 if (*RExC_parse == ')') {
4971                     ret=reg_node(pRExC_state, OPFAIL);
4972                     nextchar(pRExC_state);
4973                     return ret;
4974                 }
4975             case ':':           /* (?:...) */
4976             case '>':           /* (?>...) */
4977                 break;
4978             case '$':           /* (?$...) */
4979             case '@':           /* (?@...) */
4980                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
4981                 break;
4982             case '#':           /* (?#...) */
4983                 while (*RExC_parse && *RExC_parse != ')')
4984                     RExC_parse++;
4985                 if (*RExC_parse != ')')
4986                     FAIL("Sequence (?#... not terminated");
4987                 nextchar(pRExC_state);
4988                 *flagp = TRYAGAIN;
4989                 return NULL;
4990             case '0' :           /* (?0) */
4991             case 'R' :           /* (?R) */
4992                 if (*RExC_parse != ')')
4993                     FAIL("Sequence (?R) not terminated");
4994                 ret = reg_node(pRExC_state, GOSTART);
4995                 nextchar(pRExC_state);
4996                 return ret;
4997                 /*notreached*/
4998             { /* named and numeric backreferences */
4999                 I32 num;
5000                 char * parse_start;
5001             case '&':            /* (?&NAME) */
5002                 parse_start = RExC_parse - 1;
5003                 {
5004                     SV *sv_dat = reg_scan_name(pRExC_state,
5005                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5006                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
5007                 }
5008                 goto gen_recurse_regop;
5009                 /* NOT REACHED */
5010             case '+':
5011                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
5012                     RExC_parse++;
5013                     vFAIL("Illegal pattern");
5014                 }
5015                 goto parse_recursion;
5016                 /* NOT REACHED*/
5017             case '-': /* (?-1) */
5018                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
5019                     RExC_parse--; /* rewind to let it be handled later */
5020                     goto parse_flags;
5021                 } 
5022                 /*FALLTHROUGH */
5023             case '1': case '2': case '3': case '4': /* (?1) */
5024             case '5': case '6': case '7': case '8': case '9':
5025                 RExC_parse--;
5026               parse_recursion:
5027                 num = atoi(RExC_parse);
5028                 parse_start = RExC_parse - 1; /* MJD */
5029                 if (*RExC_parse == '-')
5030                     RExC_parse++;
5031                 while (isDIGIT(*RExC_parse))
5032                         RExC_parse++;
5033                 if (*RExC_parse!=')') 
5034                     vFAIL("Expecting close bracket");
5035                         
5036               gen_recurse_regop:
5037                 if ( paren == '-' ) {
5038                     /*
5039                     Diagram of capture buffer numbering.
5040                     Top line is the normal capture buffer numbers
5041                     Botton line is the negative indexing as from
5042                     the X (the (?-2))
5043
5044                     +   1 2    3 4 5 X          6 7
5045                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
5046                     -   5 4    3 2 1 X          x x
5047
5048                     */
5049                     num = RExC_npar + num;
5050                     if (num < 1)  {
5051                         RExC_parse++;
5052                         vFAIL("Reference to nonexistent group");
5053                     }
5054                 } else if ( paren == '+' ) {
5055                     num = RExC_npar + num - 1;
5056                 }
5057
5058                 ret = reganode(pRExC_state, GOSUB, num);
5059                 if (!SIZE_ONLY) {
5060                     if (num > (I32)RExC_rx->nparens) {
5061                         RExC_parse++;
5062                         vFAIL("Reference to nonexistent group");
5063                     }
5064                     ARG2L_SET( ret, RExC_recurse_count++);
5065                     RExC_emit++;
5066                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
5067                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
5068                 } else {
5069                     RExC_size++;
5070                 }
5071                 RExC_seen |= REG_SEEN_RECURSE;
5072                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
5073                 Set_Node_Offset(ret, parse_start); /* MJD */
5074
5075                 nextchar(pRExC_state);
5076                 return ret;
5077             } /* named and numeric backreferences */
5078             /* NOT REACHED */
5079
5080             case 'p':           /* (?p...) */
5081                 if (SIZE_ONLY && ckWARN2(WARN_DEPRECATED, WARN_REGEXP))
5082                     vWARNdep(RExC_parse, "(?p{}) is deprecated - use (??{})");
5083                 /* FALL THROUGH*/
5084             case '?':           /* (??...) */
5085                 is_logical = 1;
5086                 if (*RExC_parse != '{')
5087                     goto unknown;
5088                 paren = *RExC_parse++;
5089                 /* FALL THROUGH */
5090             case '{':           /* (?{...}) */
5091             {
5092                 I32 count = 1;
5093                 U32 n = 0;
5094                 char c;
5095                 char *s = RExC_parse;
5096
5097                 RExC_seen_zerolen++;
5098                 RExC_seen |= REG_SEEN_EVAL;
5099                 while (count && (c = *RExC_parse)) {
5100                     if (c == '\\') {
5101                         if (RExC_parse[1])
5102                             RExC_parse++;
5103                     }
5104                     else if (c == '{')
5105                         count++;
5106                     else if (c == '}')
5107                         count--;
5108                     RExC_parse++;
5109                 }
5110                 if (*RExC_parse != ')') {
5111                     RExC_parse = s;             
5112                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
5113                 }
5114                 if (!SIZE_ONLY) {
5115                     PAD *pad;
5116                     OP_4tree *sop, *rop;
5117                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
5118
5119                     ENTER;
5120                     Perl_save_re_context(aTHX);
5121                     rop = sv_compile_2op(sv, &sop, "re", &pad);
5122                     sop->op_private |= OPpREFCOUNTED;
5123                     /* re_dup will OpREFCNT_inc */
5124                     OpREFCNT_set(sop, 1);
5125                     LEAVE;
5126
5127                     n = add_data(pRExC_state, 3, "nop");
5128                     RExC_rxi->data->data[n] = (void*)rop;
5129                     RExC_rxi->data->data[n+1] = (void*)sop;
5130                     RExC_rxi->data->data[n+2] = (void*)pad;
5131                     SvREFCNT_dec(sv);
5132                 }
5133                 else {                                          /* First pass */
5134                     if (PL_reginterp_cnt < ++RExC_seen_evals
5135                         && IN_PERL_RUNTIME)
5136                         /* No compiled RE interpolated, has runtime
5137                            components ===> unsafe.  */
5138                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
5139                     if (PL_tainting && PL_tainted)
5140                         FAIL("Eval-group in insecure regular expression");
5141 #if PERL_VERSION > 8
5142                     if (IN_PERL_COMPILETIME)
5143                         PL_cv_has_eval = 1;
5144 #endif
5145                 }
5146
5147                 nextchar(pRExC_state);
5148                 if (is_logical) {
5149                     ret = reg_node(pRExC_state, LOGICAL);
5150                     if (!SIZE_ONLY)
5151                         ret->flags = 2;
5152                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
5153                     /* deal with the length of this later - MJD */
5154                     return ret;
5155                 }
5156                 ret = reganode(pRExC_state, EVAL, n);
5157                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
5158                 Set_Node_Offset(ret, parse_start);
5159                 return ret;
5160             }
5161             case '(':           /* (?(?{...})...) and (?(?=...)...) */
5162             {
5163                 int is_define= 0;
5164                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
5165                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
5166                         || RExC_parse[1] == '<'
5167                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
5168                         I32 flag;
5169                         
5170                         ret = reg_node(pRExC_state, LOGICAL);
5171                         if (!SIZE_ONLY)
5172                             ret->flags = 1;
5173                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
5174                         goto insert_if;
5175                     }
5176                 }
5177                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
5178                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
5179                 {
5180                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
5181                     char *name_start= RExC_parse++;
5182                     U32 num = 0;
5183                     SV *sv_dat=reg_scan_name(pRExC_state,
5184                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5185                     if (RExC_parse == name_start || *RExC_parse != ch)
5186                         vFAIL2("Sequence (?(%c... not terminated",
5187                             (ch == '>' ? '<' : ch));
5188                     RExC_parse++;
5189                     if (!SIZE_ONLY) {
5190                         num = add_data( pRExC_state, 1, "S" );
5191                         RExC_rxi->data->data[num]=(void*)sv_dat;
5192                         SvREFCNT_inc(sv_dat);
5193                     }
5194                     ret = reganode(pRExC_state,NGROUPP,num);
5195                     goto insert_if_check_paren;
5196                 }
5197                 else if (RExC_parse[0] == 'D' &&
5198                          RExC_parse[1] == 'E' &&
5199                          RExC_parse[2] == 'F' &&
5200                          RExC_parse[3] == 'I' &&
5201                          RExC_parse[4] == 'N' &&
5202                          RExC_parse[5] == 'E')
5203                 {
5204                     ret = reganode(pRExC_state,DEFINEP,0);
5205                     RExC_parse +=6 ;
5206                     is_define = 1;
5207                     goto insert_if_check_paren;
5208                 }
5209                 else if (RExC_parse[0] == 'R') {
5210                     RExC_parse++;
5211                     parno = 0;
5212                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
5213                         parno = atoi(RExC_parse++);
5214                         while (isDIGIT(*RExC_parse))
5215                             RExC_parse++;
5216                     } else if (RExC_parse[0] == '&') {
5217                         SV *sv_dat;
5218                         RExC_parse++;
5219                         sv_dat = reg_scan_name(pRExC_state,
5220                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
5221                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
5222                     }
5223                     ret = reganode(pRExC_state,INSUBP,parno); 
5224                     goto insert_if_check_paren;
5225                 }
5226                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
5227                     /* (?(1)...) */
5228                     char c;
5229                     parno = atoi(RExC_parse++);
5230
5231                     while (isDIGIT(*RExC_parse))
5232                         RExC_parse++;
5233                     ret = reganode(pRExC_state, GROUPP, parno);
5234
5235                  insert_if_check_paren:
5236                     if ((c = *nextchar(pRExC_state)) != ')')
5237                         vFAIL("Switch condition not recognized");
5238                   insert_if:
5239                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
5240                     br = regbranch(pRExC_state, &flags, 1,depth+1);
5241                     if (br == NULL)
5242                         br = reganode(pRExC_state, LONGJMP, 0);
5243                     else
5244                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
5245                     c = *nextchar(pRExC_state);
5246                     if (flags&HASWIDTH)
5247                         *flagp |= HASWIDTH;
5248                     if (c == '|') {
5249                         if (is_define) 
5250                             vFAIL("(?(DEFINE)....) does not allow branches");
5251                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
5252                         regbranch(pRExC_state, &flags, 1,depth+1);
5253                         REGTAIL(pRExC_state, ret, lastbr);
5254                         if (flags&HASWIDTH)
5255                             *flagp |= HASWIDTH;
5256                         c = *nextchar(pRExC_state);
5257                     }
5258                     else
5259                         lastbr = NULL;
5260                     if (c != ')')
5261                         vFAIL("Switch (?(condition)... contains too many branches");
5262                     ender = reg_node(pRExC_state, TAIL);
5263                     REGTAIL(pRExC_state, br, ender);
5264                     if (lastbr) {
5265                         REGTAIL(pRExC_state, lastbr, ender);
5266                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
5267                     }
5268                     else
5269                         REGTAIL(pRExC_state, ret, ender);
5270                     return ret;
5271                 }
5272                 else {
5273                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
5274                 }
5275             }
5276             case 0:
5277                 RExC_parse--; /* for vFAIL to print correctly */
5278                 vFAIL("Sequence (? incomplete");
5279                 break;
5280             default:
5281                 --RExC_parse;
5282               parse_flags:      /* (?i) */
5283                 while (*RExC_parse && strchr("iogcmsx", *RExC_parse)) {
5284                     /* (?g), (?gc) and (?o) are useless here
5285                        and must be globally applied -- japhy */
5286
5287                     if (*RExC_parse == 'o' || *RExC_parse == 'g') {
5288                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5289                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
5290                             if (! (wastedflags & wflagbit) ) {
5291                                 wastedflags |= wflagbit;
5292                                 vWARN5(
5293                                     RExC_parse + 1,
5294                                     "Useless (%s%c) - %suse /%c modifier",
5295                                     flagsp == &negflags ? "?-" : "?",
5296                                     *RExC_parse,
5297                                     flagsp == &negflags ? "don't " : "",
5298                                     *RExC_parse
5299                                 );
5300                             }
5301                         }
5302                     }
5303                     else if (*RExC_parse == 'c') {
5304                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5305                             if (! (wastedflags & WASTED_C) ) {
5306                                 wastedflags |= WASTED_GC;
5307                                 vWARN3(
5308                                     RExC_parse + 1,
5309                                     "Useless (%sc) - %suse /gc modifier",
5310                                     flagsp == &negflags ? "?-" : "?",
5311                                     flagsp == &negflags ? "don't " : ""
5312                                 );
5313                             }
5314                         }
5315                     }
5316                     else { pmflag(flagsp, *RExC_parse); }
5317
5318                     ++RExC_parse;
5319                 }
5320                 if (*RExC_parse == '-') {
5321                     flagsp = &negflags;
5322                     wastedflags = 0;  /* reset so (?g-c) warns twice */
5323                     ++RExC_parse;
5324                     goto parse_flags;
5325                 }
5326                 RExC_flags |= posflags;
5327                 RExC_flags &= ~negflags;
5328                 if (*RExC_parse == ':') {
5329                     RExC_parse++;
5330                     paren = ':';
5331                     break;
5332                 }               
5333               unknown:
5334                 if (*RExC_parse != ')') {
5335                     RExC_parse++;
5336                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
5337                 }
5338                 nextchar(pRExC_state);
5339                 *flagp = TRYAGAIN;
5340                 return NULL;
5341             }
5342         }
5343         else {                  /* (...) */
5344           capturing_parens:
5345             parno = RExC_npar;
5346             RExC_npar++;
5347             
5348             ret = reganode(pRExC_state, OPEN, parno);
5349             if (!SIZE_ONLY ){
5350                 if (!RExC_nestroot) 
5351                     RExC_nestroot = parno;
5352                 if (RExC_seen & REG_SEEN_RECURSE) {
5353                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
5354                         "Setting open paren #%"IVdf" to %d\n", 
5355                         (IV)parno, REG_NODE_NUM(ret)));
5356                     RExC_open_parens[parno-1]= ret;
5357                 }
5358             }
5359             Set_Node_Length(ret, 1); /* MJD */
5360             Set_Node_Offset(ret, RExC_parse); /* MJD */
5361             is_open = 1;
5362         }
5363     }
5364     else                        /* ! paren */
5365         ret = NULL;
5366
5367     /* Pick up the branches, linking them together. */
5368     parse_start = RExC_parse;   /* MJD */
5369     br = regbranch(pRExC_state, &flags, 1,depth+1);
5370     /*     branch_len = (paren != 0); */
5371
5372     if (br == NULL)
5373         return(NULL);
5374     if (*RExC_parse == '|') {
5375         if (!SIZE_ONLY && RExC_extralen) {
5376             reginsert(pRExC_state, BRANCHJ, br, depth+1);
5377         }
5378         else {                  /* MJD */
5379             reginsert(pRExC_state, BRANCH, br, depth+1);
5380             Set_Node_Length(br, paren != 0);
5381             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
5382         }
5383         have_branch = 1;
5384         if (SIZE_ONLY)
5385             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
5386     }
5387     else if (paren == ':') {
5388         *flagp |= flags&SIMPLE;
5389     }
5390     if (is_open) {                              /* Starts with OPEN. */
5391         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
5392     }
5393     else if (paren != '?')              /* Not Conditional */
5394         ret = br;
5395     *flagp |= flags & (SPSTART | HASWIDTH);
5396     lastbr = br;
5397     while (*RExC_parse == '|') {
5398         if (!SIZE_ONLY && RExC_extralen) {
5399             ender = reganode(pRExC_state, LONGJMP,0);
5400             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
5401         }
5402         if (SIZE_ONLY)
5403             RExC_extralen += 2;         /* Account for LONGJMP. */
5404         nextchar(pRExC_state);
5405         br = regbranch(pRExC_state, &flags, 0, depth+1);
5406
5407         if (br == NULL)
5408             return(NULL);
5409         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
5410         lastbr = br;
5411         if (flags&HASWIDTH)
5412             *flagp |= HASWIDTH;
5413         *flagp |= flags&SPSTART;
5414     }
5415
5416     if (have_branch || paren != ':') {
5417         /* Make a closing node, and hook it on the end. */
5418         switch (paren) {
5419         case ':':
5420             ender = reg_node(pRExC_state, TAIL);
5421             break;
5422         case 1:
5423             ender = reganode(pRExC_state, CLOSE, parno);
5424             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
5425                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
5426                         "Setting close paren #%"IVdf" to %d\n", 
5427                         (IV)parno, REG_NODE_NUM(ender)));
5428                 RExC_close_parens[parno-1]= ender;
5429                 if (RExC_nestroot == parno) 
5430                     RExC_nestroot = 0;
5431             }       
5432             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
5433             Set_Node_Length(ender,1); /* MJD */
5434             break;
5435         case '<':
5436         case ',':
5437         case '=':
5438         case '!':
5439             *flagp &= ~HASWIDTH;
5440             /* FALL THROUGH */
5441         case '>':
5442             ender = reg_node(pRExC_state, SUCCEED);
5443             break;
5444         case 0:
5445             ender = reg_node(pRExC_state, END);
5446             if (!SIZE_ONLY) {
5447                 assert(!RExC_opend); /* there can only be one! */
5448                 RExC_opend = ender;
5449             }
5450             break;
5451         }
5452         REGTAIL(pRExC_state, lastbr, ender);
5453
5454         if (have_branch && !SIZE_ONLY) {
5455             if (depth==1)
5456                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
5457
5458             /* Hook the tails of the branches to the closing node. */
5459             for (br = ret; br; br = regnext(br)) {
5460                 const U8 op = PL_regkind[OP(br)];
5461                 if (op == BRANCH) {
5462                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
5463                 }
5464                 else if (op == BRANCHJ) {
5465                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
5466                 }
5467             }
5468         }
5469     }
5470
5471     {
5472         const char *p;
5473         static const char parens[] = "=!<,>";
5474
5475         if (paren && (p = strchr(parens, paren))) {
5476             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
5477             int flag = (p - parens) > 1;
5478
5479             if (paren == '>')
5480                 node = SUSPEND, flag = 0;
5481             reginsert(pRExC_state, node,ret, depth+1);
5482             Set_Node_Cur_Length(ret);
5483             Set_Node_Offset(ret, parse_start + 1);
5484             ret->flags = flag;
5485             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
5486         }
5487     }
5488
5489     /* Check for proper termination. */
5490     if (paren) {
5491         RExC_flags = oregflags;
5492         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
5493             RExC_parse = oregcomp_parse;
5494             vFAIL("Unmatched (");
5495         }
5496     }
5497     else if (!paren && RExC_parse < RExC_end) {
5498         if (*RExC_parse == ')') {
5499             RExC_parse++;
5500             vFAIL("Unmatched )");
5501         }
5502         else
5503             FAIL("Junk on end of regexp");      /* "Can't happen". */
5504         /* NOTREACHED */
5505     }
5506
5507     return(ret);
5508 }
5509
5510 /*
5511  - regbranch - one alternative of an | operator
5512  *
5513  * Implements the concatenation operator.
5514  */
5515 STATIC regnode *
5516 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
5517 {
5518     dVAR;
5519     register regnode *ret;
5520     register regnode *chain = NULL;
5521     register regnode *latest;
5522     I32 flags = 0, c = 0;
5523     GET_RE_DEBUG_FLAGS_DECL;
5524     DEBUG_PARSE("brnc");
5525     if (first)
5526         ret = NULL;
5527     else {
5528         if (!SIZE_ONLY && RExC_extralen)
5529             ret = reganode(pRExC_state, BRANCHJ,0);
5530         else {
5531             ret = reg_node(pRExC_state, BRANCH);
5532             Set_Node_Length(ret, 1);
5533         }
5534     }
5535         
5536     if (!first && SIZE_ONLY)
5537         RExC_extralen += 1;                     /* BRANCHJ */
5538
5539     *flagp = WORST;                     /* Tentatively. */
5540
5541     RExC_parse--;
5542     nextchar(pRExC_state);
5543     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
5544         flags &= ~TRYAGAIN;
5545         latest = regpiece(pRExC_state, &flags,depth+1);
5546         if (latest == NULL) {
5547             if (flags & TRYAGAIN)
5548                 continue;
5549             return(NULL);
5550         }
5551         else if (ret == NULL)
5552             ret = latest;
5553         *flagp |= flags&HASWIDTH;
5554         if (chain == NULL)      /* First piece. */
5555             *flagp |= flags&SPSTART;
5556         else {
5557             RExC_naughty++;
5558             REGTAIL(pRExC_state, chain, latest);
5559         }
5560         chain = latest;
5561         c++;
5562     }
5563     if (chain == NULL) {        /* Loop ran zero times. */
5564         chain = reg_node(pRExC_state, NOTHING);
5565         if (ret == NULL)
5566             ret = chain;
5567     }
5568     if (c == 1) {
5569         *flagp |= flags&SIMPLE;
5570     }
5571
5572     return ret;
5573 }
5574
5575 /*
5576  - regpiece - something followed by possible [*+?]
5577  *
5578  * Note that the branching code sequences used for ? and the general cases
5579  * of * and + are somewhat optimized:  they use the same NOTHING node as
5580  * both the endmarker for their branch list and the body of the last branch.
5581  * It might seem that this node could be dispensed with entirely, but the
5582  * endmarker role is not redundant.
5583  */
5584 STATIC regnode *
5585 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
5586 {
5587     dVAR;
5588     register regnode *ret;
5589     register char op;
5590     register char *next;
5591     I32 flags;
5592     const char * const origparse = RExC_parse;
5593     I32 min;
5594     I32 max = REG_INFTY;
5595     char *parse_start;
5596     const char *maxpos = NULL;
5597     GET_RE_DEBUG_FLAGS_DECL;
5598     DEBUG_PARSE("piec");
5599
5600     ret = regatom(pRExC_state, &flags,depth+1);
5601     if (ret == NULL) {
5602         if (flags & TRYAGAIN)
5603             *flagp |= TRYAGAIN;
5604         return(NULL);
5605     }
5606
5607     op = *RExC_parse;
5608
5609     if (op == '{' && regcurly(RExC_parse)) {
5610         maxpos = NULL;
5611         parse_start = RExC_parse; /* MJD */
5612         next = RExC_parse + 1;
5613         while (isDIGIT(*next) || *next == ',') {
5614             if (*next == ',') {
5615                 if (maxpos)
5616                     break;
5617                 else
5618                     maxpos = next;
5619             }
5620             next++;
5621         }
5622         if (*next == '}') {             /* got one */
5623             if (!maxpos)
5624                 maxpos = next;
5625             RExC_parse++;
5626             min = atoi(RExC_parse);
5627             if (*maxpos == ',')
5628                 maxpos++;
5629             else
5630                 maxpos = RExC_parse;
5631             max = atoi(maxpos);
5632             if (!max && *maxpos != '0')
5633                 max = REG_INFTY;                /* meaning "infinity" */
5634             else if (max >= REG_INFTY)
5635                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
5636             RExC_parse = next;
5637             nextchar(pRExC_state);
5638
5639         do_curly:
5640             if ((flags&SIMPLE)) {
5641                 RExC_naughty += 2 + RExC_naughty / 2;
5642                 reginsert(pRExC_state, CURLY, ret, depth+1);
5643                 Set_Node_Offset(ret, parse_start+1); /* MJD */
5644                 Set_Node_Cur_Length(ret);
5645             }
5646             else {
5647                 regnode * const w = reg_node(pRExC_state, WHILEM);
5648
5649                 w->flags = 0;
5650                 REGTAIL(pRExC_state, ret, w);
5651                 if (!SIZE_ONLY && RExC_extralen) {
5652                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
5653                     reginsert(pRExC_state, NOTHING,ret, depth+1);
5654                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
5655                 }
5656                 reginsert(pRExC_state, CURLYX,ret, depth+1);
5657                                 /* MJD hk */
5658                 Set_Node_Offset(ret, parse_start+1);
5659                 Set_Node_Length(ret,
5660                                 op == '{' ? (RExC_parse - parse_start) : 1);
5661
5662                 if (!SIZE_ONLY && RExC_extralen)
5663                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
5664                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
5665                 if (SIZE_ONLY)
5666                     RExC_whilem_seen++, RExC_extralen += 3;
5667                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
5668             }
5669             ret->flags = 0;
5670
5671             if (min > 0)
5672                 *flagp = WORST;
5673             if (max > 0)
5674                 *flagp |= HASWIDTH;
5675             if (max && max < min)
5676                 vFAIL("Can't do {n,m} with n > m");
5677             if (!SIZE_ONLY) {
5678                 ARG1_SET(ret, (U16)min);
5679                 ARG2_SET(ret, (U16)max);
5680             }
5681
5682             goto nest_check;
5683         }
5684     }
5685
5686     if (!ISMULT1(op)) {
5687         *flagp = flags;
5688         return(ret);
5689     }
5690
5691 #if 0                           /* Now runtime fix should be reliable. */
5692
5693     /* if this is reinstated, don't forget to put this back into perldiag:
5694
5695             =item Regexp *+ operand could be empty at {#} in regex m/%s/
5696
5697            (F) The part of the regexp subject to either the * or + quantifier
5698            could match an empty string. The {#} shows in the regular
5699            expression about where the problem was discovered.
5700
5701     */
5702
5703     if (!(flags&HASWIDTH) && op != '?')
5704       vFAIL("Regexp *+ operand could be empty");
5705 #endif
5706
5707     parse_start = RExC_parse;
5708     nextchar(pRExC_state);
5709
5710     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
5711
5712     if (op == '*' && (flags&SIMPLE)) {
5713         reginsert(pRExC_state, STAR, ret, depth+1);
5714         ret->flags = 0;
5715         RExC_naughty += 4;
5716     }
5717     else if (op == '*') {
5718         min = 0;
5719         goto do_curly;
5720     }
5721     else if (op == '+' && (flags&SIMPLE)) {
5722         reginsert(pRExC_state, PLUS, ret, depth+1);
5723         ret->flags = 0;
5724         RExC_naughty += 3;
5725     }
5726     else if (op == '+') {
5727         min = 1;
5728         goto do_curly;
5729     }
5730     else if (op == '?') {
5731         min = 0; max = 1;
5732         goto do_curly;
5733     }
5734   nest_check:
5735     if (!SIZE_ONLY && !(flags&HASWIDTH) && max > REG_INFTY/3 && ckWARN(WARN_REGEXP)) {
5736         vWARN3(RExC_parse,
5737                "%.*s matches null string many times",
5738                (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
5739                origparse);
5740     }
5741
5742     if (RExC_parse < RExC_end && *RExC_parse == '?') {
5743         nextchar(pRExC_state);
5744         reginsert(pRExC_state, MINMOD, ret, depth+1);
5745         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
5746     }
5747 #ifndef REG_ALLOW_MINMOD_SUSPEND
5748     else
5749 #endif
5750     if (RExC_parse < RExC_end && *RExC_parse == '+') {
5751         regnode *ender;
5752         nextchar(pRExC_state);
5753         ender = reg_node(pRExC_state, SUCCEED);
5754         REGTAIL(pRExC_state, ret, ender);
5755         reginsert(pRExC_state, SUSPEND, ret, depth+1);
5756         ret->flags = 0;
5757         ender = reg_node(pRExC_state, TAIL);
5758         REGTAIL(pRExC_state, ret, ender);
5759         /*ret= ender;*/
5760     }
5761
5762     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
5763         RExC_parse++;
5764         vFAIL("Nested quantifiers");
5765     }
5766
5767     return(ret);
5768 }
5769
5770
5771 /* reg_namedseq(pRExC_state,UVp)
5772    
5773    This is expected to be called by a parser routine that has 
5774    recognized'\N' and needs to handle the rest. RExC_parse is 
5775    expected to point at the first char following the N at the time
5776    of the call.
5777    
5778    If valuep is non-null then it is assumed that we are parsing inside 
5779    of a charclass definition and the first codepoint in the resolved
5780    string is returned via *valuep and the routine will return NULL. 
5781    In this mode if a multichar string is returned from the charnames 
5782    handler a warning will be issued, and only the first char in the 
5783    sequence will be examined. If the string returned is zero length
5784    then the value of *valuep is undefined and NON-NULL will 
5785    be returned to indicate failure. (This will NOT be a valid pointer 
5786    to a regnode.)
5787    
5788    If value is null then it is assumed that we are parsing normal text
5789    and inserts a new EXACT node into the program containing the resolved
5790    string and returns a pointer to the new node. If the string is 
5791    zerolength a NOTHING node is emitted.
5792    
5793    On success RExC_parse is set to the char following the endbrace.
5794    Parsing failures will generate a fatal errorvia vFAIL(...)
5795    
5796    NOTE: We cache all results from the charnames handler locally in 
5797    the RExC_charnames hash (created on first use) to prevent a charnames 
5798    handler from playing silly-buggers and returning a short string and 
5799    then a long string for a given pattern. Since the regexp program 
5800    size is calculated during an initial parse this would result
5801    in a buffer overrun so we cache to prevent the charname result from
5802    changing during the course of the parse.
5803    
5804  */
5805 STATIC regnode *
5806 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep) 
5807 {
5808     char * name;        /* start of the content of the name */
5809     char * endbrace;    /* endbrace following the name */
5810     SV *sv_str = NULL;  
5811     SV *sv_name = NULL;
5812     STRLEN len; /* this has various purposes throughout the code */
5813     bool cached = 0; /* if this is true then we shouldn't refcount dev sv_str */
5814     regnode *ret = NULL;
5815     
5816     if (*RExC_parse != '{') {
5817         vFAIL("Missing braces on \\N{}");
5818     }
5819     name = RExC_parse+1;
5820     endbrace = strchr(RExC_parse, '}');
5821     if ( ! endbrace ) {
5822         RExC_parse++;
5823         vFAIL("Missing right brace on \\N{}");
5824     } 
5825     RExC_parse = endbrace + 1;  
5826     
5827     
5828     /* RExC_parse points at the beginning brace, 
5829        endbrace points at the last */
5830     if ( name[0]=='U' && name[1]=='+' ) {
5831         /* its a "unicode hex" notation {U+89AB} */
5832         I32 fl = PERL_SCAN_ALLOW_UNDERSCORES
5833             | PERL_SCAN_DISALLOW_PREFIX
5834             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
5835         UV cp;
5836         len = (STRLEN)(endbrace - name - 2);
5837         cp = grok_hex(name + 2, &len, &fl, NULL);
5838         if ( len != (STRLEN)(endbrace - name - 2) ) {
5839             cp = 0xFFFD;
5840         }    
5841         if (cp > 0xff)
5842             RExC_utf8 = 1;
5843         if ( valuep ) {
5844             *valuep = cp;
5845             return NULL;
5846         }
5847         sv_str= Perl_newSVpvf_nocontext("%c",(int)cp);
5848     } else {
5849         /* fetch the charnames handler for this scope */
5850         HV * const table = GvHV(PL_hintgv);
5851         SV **cvp= table ? 
5852             hv_fetchs(table, "charnames", FALSE) :
5853             NULL;
5854         SV *cv= cvp ? *cvp : NULL;
5855         HE *he_str;
5856         int count;
5857         /* create an SV with the name as argument */
5858         sv_name = newSVpvn(name, endbrace - name);
5859         
5860         if (!table || !(PL_hints & HINT_LOCALIZE_HH)) {
5861             vFAIL2("Constant(\\N{%s}) unknown: "
5862                   "(possibly a missing \"use charnames ...\")",
5863                   SvPVX(sv_name));
5864         }
5865         if (!cvp || !SvOK(*cvp)) { /* when $^H{charnames} = undef; */
5866             vFAIL2("Constant(\\N{%s}): "
5867                   "$^H{charnames} is not defined",SvPVX(sv_name));
5868         }
5869         
5870         
5871         
5872         if (!RExC_charnames) {
5873             /* make sure our cache is allocated */
5874             RExC_charnames = newHV();
5875             sv_2mortal((SV*)RExC_charnames);
5876         } 
5877             /* see if we have looked this one up before */
5878         he_str = hv_fetch_ent( RExC_charnames, sv_name, 0, 0 );
5879         if ( he_str ) {
5880             sv_str = HeVAL(he_str);
5881             cached = 1;
5882         } else {
5883             dSP ;
5884
5885             ENTER ;
5886             SAVETMPS ;
5887             PUSHMARK(SP) ;
5888             
5889             XPUSHs(sv_name);
5890             
5891             PUTBACK ;
5892             
5893             count= call_sv(cv, G_SCALAR);
5894             
5895             if (count == 1) { /* XXXX is this right? dmq */
5896                 sv_str = POPs;
5897                 SvREFCNT_inc_simple_void(sv_str);
5898             } 
5899             
5900             SPAGAIN ;
5901             PUTBACK ;
5902             FREETMPS ;
5903             LEAVE ;
5904             
5905             if ( !sv_str || !SvOK(sv_str) ) {
5906                 vFAIL2("Constant(\\N{%s}): Call to &{$^H{charnames}} "
5907                       "did not return a defined value",SvPVX(sv_name));
5908             }
5909             if (hv_store_ent( RExC_charnames, sv_name, sv_str, 0))
5910                 cached = 1;
5911         }
5912     }
5913     if (valuep) {
5914         char *p = SvPV(sv_str, len);
5915         if (len) {
5916             STRLEN numlen = 1;
5917             if ( SvUTF8(sv_str) ) {
5918                 *valuep = utf8_to_uvchr((U8*)p, &numlen);
5919                 if (*valuep > 0x7F)
5920                     RExC_utf8 = 1; 
5921                 /* XXXX
5922                   We have to turn on utf8 for high bit chars otherwise
5923                   we get failures with
5924                   
5925                    "ss" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
5926                    "SS" =~ /[\N{LATIN SMALL LETTER SHARP S}]/i
5927                 
5928                   This is different from what \x{} would do with the same
5929                   codepoint, where the condition is > 0xFF.
5930                   - dmq
5931                 */
5932                 
5933                 
5934             } else {
5935                 *valuep = (UV)*p;
5936                 /* warn if we havent used the whole string? */
5937             }
5938             if (numlen<len && SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5939                 vWARN2(RExC_parse,
5940                     "Ignoring excess chars from \\N{%s} in character class",
5941                     SvPVX(sv_name)
5942                 );
5943             }        
5944         } else if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
5945             vWARN2(RExC_parse,
5946                     "Ignoring zero length \\N{%s} in character class",
5947                     SvPVX(sv_name)
5948                 );
5949         }
5950         if (sv_name)    
5951             SvREFCNT_dec(sv_name);    
5952         if (!cached)
5953             SvREFCNT_dec(sv_str);    
5954         return len ? NULL : (regnode *)&len;
5955     } else if(SvCUR(sv_str)) {     
5956         
5957         char *s; 
5958         char *p, *pend;        
5959         STRLEN charlen = 1;
5960         char * parse_start = name-3; /* needed for the offsets */
5961         GET_RE_DEBUG_FLAGS_DECL;     /* needed for the offsets */
5962         
5963         ret = reg_node(pRExC_state,
5964             (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
5965         s= STRING(ret);
5966         
5967         if ( RExC_utf8 && !SvUTF8(sv_str) ) {
5968             sv_utf8_upgrade(sv_str);
5969         } else if ( !RExC_utf8 && SvUTF8(sv_str) ) {
5970             RExC_utf8= 1;
5971         }
5972         
5973         p = SvPV(sv_str, len);
5974         pend = p + len;
5975         /* len is the length written, charlen is the size the char read */
5976         for ( len = 0; p < pend; p += charlen ) {
5977             if (UTF) {
5978                 UV uvc = utf8_to_uvchr((U8*)p, &charlen);
5979                 if (FOLD) {
5980                     STRLEN foldlen,numlen;
5981                     U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
5982                     uvc = toFOLD_uni(uvc, tmpbuf, &foldlen);
5983                     /* Emit all the Unicode characters. */
5984                     
5985                     for (foldbuf = tmpbuf;
5986                         foldlen;
5987                         foldlen -= numlen) 
5988                     {
5989                         uvc = utf8_to_uvchr(foldbuf, &numlen);
5990                         if (numlen > 0) {
5991                             const STRLEN unilen = reguni(pRExC_state, uvc, s);
5992                             s       += unilen;
5993                             len     += unilen;
5994                             /* In EBCDIC the numlen
5995                             * and unilen can differ. */
5996                             foldbuf += numlen;
5997                             if (numlen >= foldlen)
5998                                 break;
5999                         }
6000                         else
6001                             break; /* "Can't happen." */
6002                     }                          
6003                 } else {
6004                     const STRLEN unilen = reguni(pRExC_state, uvc, s);
6005                     if (unilen > 0) {
6006                        s   += unilen;
6007                        len += unilen;
6008                     }
6009                 }
6010             } else {
6011                 len++;
6012                 REGC(*p, s++);
6013             }
6014         }
6015         if (SIZE_ONLY) {
6016             RExC_size += STR_SZ(len);
6017         } else {
6018             STR_LEN(ret) = len;
6019             RExC_emit += STR_SZ(len);
6020         }
6021         Set_Node_Cur_Length(ret); /* MJD */
6022         RExC_parse--; 
6023         nextchar(pRExC_state);
6024     } else {
6025         ret = reg_node(pRExC_state,NOTHING);
6026     }
6027     if (!cached) {
6028         SvREFCNT_dec(sv_str);
6029     }
6030     if (sv_name) {
6031         SvREFCNT_dec(sv_name); 
6032     }
6033     return ret;
6034
6035 }
6036
6037
6038 /*
6039  * reg_recode
6040  *
6041  * It returns the code point in utf8 for the value in *encp.
6042  *    value: a code value in the source encoding
6043  *    encp:  a pointer to an Encode object
6044  *
6045  * If the result from Encode is not a single character,
6046  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
6047  */
6048 STATIC UV
6049 S_reg_recode(pTHX_ const char value, SV **encp)
6050 {
6051     STRLEN numlen = 1;
6052     SV * const sv = sv_2mortal(newSVpvn(&value, numlen));
6053     const char * const s = encp && *encp ? sv_recode_to_utf8(sv, *encp)
6054                                          : SvPVX(sv);
6055     const STRLEN newlen = SvCUR(sv);
6056     UV uv = UNICODE_REPLACEMENT;
6057
6058     if (newlen)
6059         uv = SvUTF8(sv)
6060              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
6061              : *(U8*)s;
6062
6063     if (!newlen || numlen != newlen) {
6064         uv = UNICODE_REPLACEMENT;
6065         if (encp)
6066             *encp = NULL;
6067     }
6068     return uv;
6069 }
6070
6071
6072 /*
6073  - regatom - the lowest level
6074  *
6075  * Optimization:  gobbles an entire sequence of ordinary characters so that
6076  * it can turn them into a single node, which is smaller to store and
6077  * faster to run.  Backslashed characters are exceptions, each becoming a
6078  * separate node; the code is simpler that way and it's not worth fixing.
6079  *
6080  * [Yes, it is worth fixing, some scripts can run twice the speed.]
6081  * [It looks like its ok, as in S_study_chunk we merge adjacent EXACT nodes]
6082  */
6083 STATIC regnode *
6084 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
6085 {
6086     dVAR;
6087     register regnode *ret = NULL;
6088     I32 flags;
6089     char *parse_start = RExC_parse;
6090     GET_RE_DEBUG_FLAGS_DECL;
6091     DEBUG_PARSE("atom");
6092     *flagp = WORST;             /* Tentatively. */
6093
6094 tryagain:
6095     switch (*RExC_parse) {
6096     case '^':
6097         RExC_seen_zerolen++;
6098         nextchar(pRExC_state);
6099         if (RExC_flags & RXf_PMf_MULTILINE)
6100             ret = reg_node(pRExC_state, MBOL);
6101         else if (RExC_flags & RXf_PMf_SINGLELINE)
6102             ret = reg_node(pRExC_state, SBOL);
6103         else
6104             ret = reg_node(pRExC_state, BOL);
6105         Set_Node_Length(ret, 1); /* MJD */
6106         break;
6107     case '$':
6108         nextchar(pRExC_state);
6109         if (*RExC_parse)
6110             RExC_seen_zerolen++;
6111         if (RExC_flags & RXf_PMf_MULTILINE)
6112             ret = reg_node(pRExC_state, MEOL);
6113         else if (RExC_flags & RXf_PMf_SINGLELINE)
6114             ret = reg_node(pRExC_state, SEOL);
6115         else
6116             ret = reg_node(pRExC_state, EOL);
6117         Set_Node_Length(ret, 1); /* MJD */
6118         break;
6119     case '.':
6120         nextchar(pRExC_state);
6121         if (RExC_flags & RXf_PMf_SINGLELINE)
6122             ret = reg_node(pRExC_state, SANY);
6123         else
6124             ret = reg_node(pRExC_state, REG_ANY);
6125         *flagp |= HASWIDTH|SIMPLE;
6126         RExC_naughty++;
6127         Set_Node_Length(ret, 1); /* MJD */
6128         break;
6129     case '[':
6130     {
6131         char * const oregcomp_parse = ++RExC_parse;
6132         ret = regclass(pRExC_state,depth+1);
6133         if (*RExC_parse != ']') {
6134             RExC_parse = oregcomp_parse;
6135             vFAIL("Unmatched [");
6136         }
6137         nextchar(pRExC_state);
6138         *flagp |= HASWIDTH|SIMPLE;
6139         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
6140         break;
6141     }
6142     case '(':
6143         nextchar(pRExC_state);
6144         ret = reg(pRExC_state, 1, &flags,depth+1);
6145         if (ret == NULL) {
6146                 if (flags & TRYAGAIN) {
6147                     if (RExC_parse == RExC_end) {
6148                          /* Make parent create an empty node if needed. */
6149                         *flagp |= TRYAGAIN;
6150                         return(NULL);
6151                     }
6152                     goto tryagain;
6153                 }
6154                 return(NULL);
6155         }
6156         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE);
6157         break;
6158     case '|':
6159     case ')':
6160         if (flags & TRYAGAIN) {
6161             *flagp |= TRYAGAIN;
6162             return NULL;
6163         }
6164         vFAIL("Internal urp");
6165                                 /* Supposed to be caught earlier. */
6166         break;
6167     case '{':
6168         if (!regcurly(RExC_parse)) {
6169             RExC_parse++;
6170             goto defchar;
6171         }
6172         /* FALL THROUGH */
6173     case '?':
6174     case '+':
6175     case '*':
6176         RExC_parse++;
6177         vFAIL("Quantifier follows nothing");
6178         break;
6179     case '\\':
6180         switch (*++RExC_parse) {
6181         case 'A':
6182             RExC_seen_zerolen++;
6183             ret = reg_node(pRExC_state, SBOL);
6184             *flagp |= SIMPLE;
6185             nextchar(pRExC_state);
6186             Set_Node_Length(ret, 2); /* MJD */
6187             break;
6188         case 'G':
6189             ret = reg_node(pRExC_state, GPOS);
6190             RExC_seen |= REG_SEEN_GPOS;
6191             *flagp |= SIMPLE;
6192             nextchar(pRExC_state);
6193             Set_Node_Length(ret, 2); /* MJD */
6194             break;
6195         case 'Z':
6196             ret = reg_node(pRExC_state, SEOL);
6197             *flagp |= SIMPLE;
6198             RExC_seen_zerolen++;                /* Do not optimize RE away */
6199             nextchar(pRExC_state);
6200             break;
6201         case 'z':
6202             ret = reg_node(pRExC_state, EOS);
6203             *flagp |= SIMPLE;
6204             RExC_seen_zerolen++;                /* Do not optimize RE away */
6205             nextchar(pRExC_state);
6206             Set_Node_Length(ret, 2); /* MJD */
6207             break;
6208         case 'C':
6209             ret = reg_node(pRExC_state, CANY);
6210             RExC_seen |= REG_SEEN_CANY;
6211             *flagp |= HASWIDTH|SIMPLE;
6212             nextchar(pRExC_state);
6213             Set_Node_Length(ret, 2); /* MJD */
6214             break;
6215         case 'X':
6216             ret = reg_node(pRExC_state, CLUMP);
6217             *flagp |= HASWIDTH;
6218             nextchar(pRExC_state);
6219             Set_Node_Length(ret, 2); /* MJD */
6220             break;
6221         case 'w':
6222             ret = reg_node(pRExC_state, (U8)(LOC ? ALNUML     : ALNUM));
6223             *flagp |= HASWIDTH|SIMPLE;
6224             nextchar(pRExC_state);
6225             Set_Node_Length(ret, 2); /* MJD */
6226             break;
6227         case 'W':
6228             ret = reg_node(pRExC_state, (U8)(LOC ? NALNUML    : NALNUM));
6229             *flagp |= HASWIDTH|SIMPLE;
6230             nextchar(pRExC_state);
6231             Set_Node_Length(ret, 2); /* MJD */
6232             break;
6233         case 'b':
6234             RExC_seen_zerolen++;
6235             RExC_seen |= REG_SEEN_LOOKBEHIND;
6236             ret = reg_node(pRExC_state, (U8)(LOC ? BOUNDL     : BOUND));
6237             *flagp |= SIMPLE;
6238             nextchar(pRExC_state);
6239             Set_Node_Length(ret, 2); /* MJD */
6240             break;
6241         case 'B':
6242             RExC_seen_zerolen++;
6243             RExC_seen |= REG_SEEN_LOOKBEHIND;
6244             ret = reg_node(pRExC_state, (U8)(LOC ? NBOUNDL    : NBOUND));
6245             *flagp |= SIMPLE;
6246             nextchar(pRExC_state);
6247             Set_Node_Length(ret, 2); /* MJD */
6248             break;
6249         case 's':
6250             ret = reg_node(pRExC_state, (U8)(LOC ? SPACEL     : SPACE));
6251             *flagp |= HASWIDTH|SIMPLE;
6252             nextchar(pRExC_state);
6253             Set_Node_Length(ret, 2); /* MJD */
6254             break;
6255         case 'S':
6256             ret = reg_node(pRExC_state, (U8)(LOC ? NSPACEL    : NSPACE));
6257             *flagp |= HASWIDTH|SIMPLE;
6258             nextchar(pRExC_state);
6259             Set_Node_Length(ret, 2); /* MJD */
6260             break;
6261         case 'd':
6262             ret = reg_node(pRExC_state, DIGIT);
6263             *flagp |= HASWIDTH|SIMPLE;
6264             nextchar(pRExC_state);
6265             Set_Node_Length(ret, 2); /* MJD */
6266             break;
6267         case 'D':
6268             ret = reg_node(pRExC_state, NDIGIT);
6269             *flagp |= HASWIDTH|SIMPLE;
6270             nextchar(pRExC_state);
6271             Set_Node_Length(ret, 2); /* MJD */
6272             break;
6273         case 'p':
6274         case 'P':
6275             {   
6276                 char* const oldregxend = RExC_end;
6277                 char* parse_start = RExC_parse - 2;
6278
6279                 if (RExC_parse[1] == '{') {
6280                   /* a lovely hack--pretend we saw [\pX] instead */
6281                     RExC_end = strchr(RExC_parse, '}');
6282                     if (!RExC_end) {
6283                         const U8 c = (U8)*RExC_parse;
6284                         RExC_parse += 2;
6285                         RExC_end = oldregxend;
6286                         vFAIL2("Missing right brace on \\%c{}", c);
6287                     }
6288                     RExC_end++;
6289                 }
6290                 else {
6291                     RExC_end = RExC_parse + 2;
6292                     if (RExC_end > oldregxend)
6293                         RExC_end = oldregxend;
6294                 }
6295                 RExC_parse--;
6296
6297                 ret = regclass(pRExC_state,depth+1);
6298
6299                 RExC_end = oldregxend;
6300                 RExC_parse--;
6301
6302                 Set_Node_Offset(ret, parse_start + 2);
6303                 Set_Node_Cur_Length(ret);
6304                 nextchar(pRExC_state);
6305                 *flagp |= HASWIDTH|SIMPLE;
6306             }
6307             break;
6308         case 'N': 
6309             /* Handle \N{NAME} here and not below because it can be 
6310             multicharacter. join_exact() will join them up later on. 
6311             Also this makes sure that things like /\N{BLAH}+/ and 
6312             \N{BLAH} being multi char Just Happen. dmq*/
6313             ++RExC_parse;
6314             ret= reg_namedseq(pRExC_state, NULL); 
6315             break;
6316         case 'k':    /* Handle \k<NAME> and \k'NAME' */
6317         {   
6318             char ch= RExC_parse[1];         
6319             if (ch != '<' && ch != '\'') {
6320                 if (SIZE_ONLY)
6321                     vWARN( RExC_parse + 1, 
6322                         "Possible broken named back reference treated as literal k");
6323                 parse_start--;
6324                 goto defchar;
6325             } else {
6326                 char* name_start = (RExC_parse += 2);
6327                 U32 num = 0;
6328                 SV *sv_dat = reg_scan_name(pRExC_state,
6329                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
6330                 ch= (ch == '<') ? '>' : '\'';
6331                     
6332                 if (RExC_parse == name_start || *RExC_parse != ch)
6333                     vFAIL2("Sequence \\k%c... not terminated",
6334                         (ch == '>' ? '<' : ch));
6335                 
6336                 RExC_sawback = 1;
6337                 ret = reganode(pRExC_state,
6338                            (U8)(FOLD ? (LOC ? NREFFL : NREFF) : NREF),
6339                            num);
6340                 *flagp |= HASWIDTH;
6341                 
6342                 
6343                 if (!SIZE_ONLY) {
6344                     num = add_data( pRExC_state, 1, "S" );
6345                     ARG_SET(ret,num);
6346                     RExC_rxi->data->data[num]=(void*)sv_dat;
6347                     SvREFCNT_inc(sv_dat);
6348                 }    
6349                 /* override incorrect value set in reganode MJD */
6350                 Set_Node_Offset(ret, parse_start+1);
6351                 Set_Node_Cur_Length(ret); /* MJD */
6352                 nextchar(pRExC_state);
6353                                
6354             }
6355             break;
6356         }            
6357         case 'n':
6358         case 'r':
6359         case 't':
6360         case 'f':
6361         case 'e':
6362         case 'a':
6363         case 'x':
6364         case 'c':
6365         case '0':
6366             goto defchar;
6367         case 'R': 
6368         case '1': case '2': case '3': case '4':
6369         case '5': case '6': case '7': case '8': case '9':
6370             {
6371                 I32 num;
6372                 bool isrel=(*RExC_parse=='R');
6373                 if (isrel)
6374                     RExC_parse++;
6375                 num = atoi(RExC_parse);
6376                 if (isrel) {
6377                     num = RExC_npar - num;
6378                     if (num < 1)
6379                         vFAIL("Reference to nonexistent or unclosed group");
6380                 }
6381                 if (num > 9 && num >= RExC_npar)
6382                     goto defchar;
6383                 else {
6384                     char * const parse_start = RExC_parse - 1; /* MJD */
6385                     while (isDIGIT(*RExC_parse))
6386                         RExC_parse++;
6387
6388                     if (!SIZE_ONLY) {
6389                         if (num > (I32)RExC_rx->nparens)
6390                             vFAIL("Reference to nonexistent group");
6391                     }
6392                     RExC_sawback = 1;
6393                     ret = reganode(pRExC_state,
6394                                    (U8)(FOLD ? (LOC ? REFFL : REFF) : REF),
6395                                    num);
6396                     *flagp |= HASWIDTH;
6397
6398                     /* override incorrect value set in reganode MJD */
6399                     Set_Node_Offset(ret, parse_start+1);
6400                     Set_Node_Cur_Length(ret); /* MJD */
6401                     RExC_parse--;
6402                     nextchar(pRExC_state);
6403                 }
6404             }
6405             break;
6406         case '\0':
6407             if (RExC_parse >= RExC_end)
6408                 FAIL("Trailing \\");
6409             /* FALL THROUGH */
6410         default:
6411             /* Do not generate "unrecognized" warnings here, we fall
6412                back into the quick-grab loop below */
6413             parse_start--;
6414             goto defchar;
6415         }
6416         break;
6417
6418     case '#':
6419         if (RExC_flags & RXf_PMf_EXTENDED) {
6420             while (RExC_parse < RExC_end && *RExC_parse != '\n')
6421                 RExC_parse++;
6422             if (RExC_parse < RExC_end)
6423                 goto tryagain;
6424         }
6425         /* FALL THROUGH */
6426
6427     default: {
6428             register STRLEN len;
6429             register UV ender;
6430             register char *p;
6431             char *s;
6432             STRLEN foldlen;
6433             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
6434
6435             parse_start = RExC_parse - 1;
6436
6437             RExC_parse++;
6438
6439         defchar:
6440             ender = 0;
6441             ret = reg_node(pRExC_state,
6442                            (U8)(FOLD ? (LOC ? EXACTFL : EXACTF) : EXACT));
6443             s = STRING(ret);
6444             for (len = 0, p = RExC_parse - 1;
6445               len < 127 && p < RExC_end;
6446               len++)
6447             {
6448                 char * const oldp = p;
6449
6450                 if (RExC_flags & RXf_PMf_EXTENDED)
6451                     p = regwhite(p, RExC_end);
6452                 switch (*p) {
6453                 case '^':
6454                 case '$':
6455                 case '.':
6456                 case '[':
6457                 case '(':
6458                 case ')':
6459                 case '|':
6460                     goto loopdone;
6461                 case '\\':
6462                     switch (*++p) {
6463                     case 'A':
6464                     case 'C':
6465                     case 'X':
6466                     case 'G':
6467                     case 'Z':
6468                     case 'z':
6469                     case 'w':
6470                     case 'W':
6471                     case 'b':
6472                     case 'B':
6473                     case 's':
6474                     case 'S':
6475                     case 'd':
6476                     case 'D':
6477                     case 'p':
6478                     case 'P':
6479                     case 'N':
6480                     case 'R':
6481                     case 'k':
6482                         --p;
6483                         goto loopdone;
6484                     case 'n':
6485                         ender = '\n';
6486                         p++;
6487                         break;
6488                     case 'r':
6489                         ender = '\r';
6490                         p++;
6491                         break;
6492                     case 't':
6493                         ender = '\t';
6494                         p++;
6495                         break;
6496                     case 'f':
6497                         ender = '\f';
6498                         p++;
6499                         break;
6500                     case 'e':
6501                           ender = ASCII_TO_NATIVE('\033');
6502                         p++;
6503                         break;
6504                     case 'a':
6505                           ender = ASCII_TO_NATIVE('\007');
6506                         p++;
6507                         break;
6508                     case 'x':
6509                         if (*++p == '{') {
6510                             char* const e = strchr(p, '}');
6511         
6512                             if (!e) {
6513                                 RExC_parse = p + 1;
6514                                 vFAIL("Missing right brace on \\x{}");
6515                             }
6516                             else {
6517                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
6518                                     | PERL_SCAN_DISALLOW_PREFIX;
6519                                 STRLEN numlen = e - p - 1;
6520                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
6521                                 if (ender > 0xff)
6522                                     RExC_utf8 = 1;
6523                                 p = e + 1;
6524                             }
6525                         }
6526                         else {
6527                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
6528                             STRLEN numlen = 2;
6529                             ender = grok_hex(p, &numlen, &flags, NULL);
6530                             p += numlen;
6531                         }
6532                         if (PL_encoding && ender < 0x100)
6533                             goto recode_encoding;
6534                         break;
6535                     case 'c':
6536                         p++;
6537                         ender = UCHARAT(p++);
6538                         ender = toCTRL(ender);
6539                         break;
6540                     case '0': case '1': case '2': case '3':case '4':
6541                     case '5': case '6': case '7': case '8':case '9':
6542                         if (*p == '0' ||
6543                           (isDIGIT(p[1]) && atoi(p) >= RExC_npar) ) {
6544                             I32 flags = 0;
6545                             STRLEN numlen = 3;
6546                             ender = grok_oct(p, &numlen, &flags, NULL);
6547                             p += numlen;
6548                         }
6549                         else {
6550                             --p;
6551                             goto loopdone;
6552                         }
6553                         if (PL_encoding && ender < 0x100)
6554                             goto recode_encoding;
6555                         break;
6556                     recode_encoding:
6557                         {
6558                             SV* enc = PL_encoding;
6559                             ender = reg_recode((const char)(U8)ender, &enc);
6560                             if (!enc && SIZE_ONLY && ckWARN(WARN_REGEXP))
6561                                 vWARN(p, "Invalid escape in the specified encoding");
6562                             RExC_utf8 = 1;
6563                         }
6564                         break;
6565                     case '\0':
6566                         if (p >= RExC_end)
6567                             FAIL("Trailing \\");
6568                         /* FALL THROUGH */
6569                     default:
6570                         if (!SIZE_ONLY&& isALPHA(*p) && ckWARN(WARN_REGEXP))
6571                             vWARN2(p + 1, "Unrecognized escape \\%c passed through", UCHARAT(p));
6572                         goto normal_default;
6573                     }
6574                     break;
6575                 default:
6576                   normal_default:
6577                     if (UTF8_IS_START(*p) && UTF) {
6578                         STRLEN numlen;
6579                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
6580                                                &numlen, UTF8_ALLOW_DEFAULT);
6581                         p += numlen;
6582                     }
6583                     else
6584                         ender = *p++;
6585                     break;
6586                 }
6587                 if (RExC_flags & RXf_PMf_EXTENDED)
6588                     p = regwhite(p, RExC_end);
6589                 if (UTF && FOLD) {
6590                     /* Prime the casefolded buffer. */
6591                     ender = toFOLD_uni(ender, tmpbuf, &foldlen);
6592                 }
6593                 if (ISMULT2(p)) { /* Back off on ?+*. */
6594                     if (len)
6595                         p = oldp;
6596                     else if (UTF) {
6597                          if (FOLD) {
6598                               /* Emit all the Unicode characters. */
6599                               STRLEN numlen;
6600                               for (foldbuf = tmpbuf;
6601                                    foldlen;
6602                                    foldlen -= numlen) {
6603                                    ender = utf8_to_uvchr(foldbuf, &numlen);
6604                                    if (numlen > 0) {
6605                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
6606                                         s       += unilen;
6607                                         len     += unilen;
6608                                         /* In EBCDIC the numlen
6609                                          * and unilen can differ. */
6610                                         foldbuf += numlen;
6611                                         if (numlen >= foldlen)
6612                                              break;
6613                                    }
6614                                    else
6615                                         break; /* "Can't happen." */
6616                               }
6617                          }
6618                          else {
6619                               const STRLEN unilen = reguni(pRExC_state, ender, s);
6620                               if (unilen > 0) {
6621                                    s   += unilen;
6622                                    len += unilen;
6623                               }
6624                          }
6625                     }
6626                     else {
6627                         len++;
6628                         REGC((char)ender, s++);
6629                     }
6630                     break;
6631                 }
6632                 if (UTF) {
6633                      if (FOLD) {
6634                           /* Emit all the Unicode characters. */
6635                           STRLEN numlen;
6636                           for (foldbuf = tmpbuf;
6637                                foldlen;
6638                                foldlen -= numlen) {
6639                                ender = utf8_to_uvchr(foldbuf, &numlen);
6640                                if (numlen > 0) {
6641                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
6642                                     len     += unilen;
6643                                     s       += unilen;
6644                                     /* In EBCDIC the numlen
6645                                      * and unilen can differ. */
6646                                     foldbuf += numlen;
6647                                     if (numlen >= foldlen)
6648                                          break;
6649                                }
6650                                else
6651                                     break;
6652                           }
6653                      }
6654                      else {
6655                           const STRLEN unilen = reguni(pRExC_state, ender, s);
6656                           if (unilen > 0) {
6657                                s   += unilen;
6658                                len += unilen;
6659                           }
6660                      }
6661                      len--;
6662                 }
6663                 else
6664                     REGC((char)ender, s++);
6665             }
6666         loopdone:
6667             RExC_parse = p - 1;
6668             Set_Node_Cur_Length(ret); /* MJD */
6669             nextchar(pRExC_state);
6670             {
6671                 /* len is STRLEN which is unsigned, need to copy to signed */
6672                 IV iv = len;
6673                 if (iv < 0)
6674                     vFAIL("Internal disaster");
6675             }
6676             if (len > 0)
6677                 *flagp |= HASWIDTH;
6678             if (len == 1 && UNI_IS_INVARIANT(ender))
6679                 *flagp |= SIMPLE;
6680                 
6681             if (SIZE_ONLY)
6682                 RExC_size += STR_SZ(len);
6683             else {
6684                 STR_LEN(ret) = len;
6685                 RExC_emit += STR_SZ(len);
6686             }
6687         }
6688         break;
6689     }
6690
6691     return(ret);
6692 }
6693
6694 STATIC char *
6695 S_regwhite(char *p, const char *e)
6696 {
6697     while (p < e) {
6698         if (isSPACE(*p))
6699             ++p;
6700         else if (*p == '#') {
6701             do {
6702                 p++;
6703             } while (p < e && *p != '\n');
6704         }
6705         else
6706             break;
6707     }
6708     return p;
6709 }
6710
6711 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
6712    Character classes ([:foo:]) can also be negated ([:^foo:]).
6713    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
6714    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
6715    but trigger failures because they are currently unimplemented. */
6716
6717 #define POSIXCC_DONE(c)   ((c) == ':')
6718 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
6719 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
6720
6721 STATIC I32
6722 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
6723 {
6724     dVAR;
6725     I32 namedclass = OOB_NAMEDCLASS;
6726
6727     if (value == '[' && RExC_parse + 1 < RExC_end &&
6728         /* I smell either [: or [= or [. -- POSIX has been here, right? */
6729         POSIXCC(UCHARAT(RExC_parse))) {
6730         const char c = UCHARAT(RExC_parse);
6731         char* const s = RExC_parse++;
6732         
6733         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
6734             RExC_parse++;
6735         if (RExC_parse == RExC_end)
6736             /* Grandfather lone [:, [=, [. */
6737             RExC_parse = s;
6738         else {
6739             const char* const t = RExC_parse++; /* skip over the c */
6740             assert(*t == c);
6741
6742             if (UCHARAT(RExC_parse) == ']') {
6743                 const char *posixcc = s + 1;
6744                 RExC_parse++; /* skip over the ending ] */
6745
6746                 if (*s == ':') {
6747                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
6748                     const I32 skip = t - posixcc;
6749
6750                     /* Initially switch on the length of the name.  */
6751                     switch (skip) {
6752                     case 4:
6753                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
6754                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
6755                         break;
6756                     case 5:
6757                         /* Names all of length 5.  */
6758                         /* alnum alpha ascii blank cntrl digit graph lower
6759                            print punct space upper  */
6760                         /* Offset 4 gives the best switch position.  */
6761                         switch (posixcc[4]) {
6762                         case 'a':
6763                             if (memEQ(posixcc, "alph", 4)) /* alpha */
6764                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
6765                             break;
6766                         case 'e':
6767                             if (memEQ(posixcc, "spac", 4)) /* space */
6768                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
6769                             break;
6770                         case 'h':
6771                             if (memEQ(posixcc, "grap", 4)) /* graph */
6772                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
6773                             break;
6774                         case 'i':
6775                             if (memEQ(posixcc, "asci", 4)) /* ascii */
6776                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
6777                             break;
6778                         case 'k':
6779                             if (memEQ(posixcc, "blan", 4)) /* blank */
6780                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
6781                             break;
6782                         case 'l':
6783                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
6784                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
6785                             break;
6786                         case 'm':
6787                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
6788                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
6789                             break;
6790                         case 'r':
6791                             if (memEQ(posixcc, "lowe", 4)) /* lower */
6792                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
6793                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
6794                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
6795                             break;
6796                         case 't':
6797                             if (memEQ(posixcc, "digi", 4)) /* digit */
6798                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
6799                             else if (memEQ(posixcc, "prin", 4)) /* print */
6800                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
6801                             else if (memEQ(posixcc, "punc", 4)) /* punct */
6802                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
6803                             break;
6804                         }
6805                         break;
6806                     case 6:
6807                         if (memEQ(posixcc, "xdigit", 6))
6808                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
6809                         break;
6810                     }
6811
6812                     if (namedclass == OOB_NAMEDCLASS)
6813                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
6814                                       t - s - 1, s + 1);
6815                     assert (posixcc[skip] == ':');
6816                     assert (posixcc[skip+1] == ']');
6817                 } else if (!SIZE_ONLY) {
6818                     /* [[=foo=]] and [[.foo.]] are still future. */
6819
6820                     /* adjust RExC_parse so the warning shows after
6821                        the class closes */
6822                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
6823                         RExC_parse++;
6824                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
6825                 }
6826             } else {
6827                 /* Maternal grandfather:
6828                  * "[:" ending in ":" but not in ":]" */
6829                 RExC_parse = s;
6830             }
6831         }
6832     }
6833
6834     return namedclass;
6835 }
6836
6837 STATIC void
6838 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
6839 {
6840     dVAR;
6841     if (POSIXCC(UCHARAT(RExC_parse))) {
6842         const char *s = RExC_parse;
6843         const char  c = *s++;
6844
6845         while (isALNUM(*s))
6846             s++;
6847         if (*s && c == *s && s[1] == ']') {
6848             if (ckWARN(WARN_REGEXP))
6849                 vWARN3(s+2,
6850                         "POSIX syntax [%c %c] belongs inside character classes",
6851                         c, c);
6852
6853             /* [[=foo=]] and [[.foo.]] are still future. */
6854             if (POSIXCC_NOTYET(c)) {
6855                 /* adjust RExC_parse so the error shows after
6856                    the class closes */
6857                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
6858                     NOOP;
6859                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
6860             }
6861         }
6862     }
6863 }
6864
6865
6866 /*
6867    parse a class specification and produce either an ANYOF node that
6868    matches the pattern. If the pattern matches a single char only and
6869    that char is < 256 then we produce an EXACT node instead.
6870 */
6871 STATIC regnode *
6872 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
6873 {
6874     dVAR;
6875     register UV value = 0;
6876     register UV nextvalue;
6877     register IV prevvalue = OOB_UNICODE;
6878     register IV range = 0;
6879     register regnode *ret;
6880     STRLEN numlen;
6881     IV namedclass;
6882     char *rangebegin = NULL;
6883     bool need_class = 0;
6884     SV *listsv = NULL;
6885     UV n;
6886     bool optimize_invert   = TRUE;
6887     AV* unicode_alternate  = NULL;
6888 #ifdef EBCDIC
6889     UV literal_endpoint = 0;
6890 #endif
6891     UV stored = 0;  /* number of chars stored in the class */
6892
6893     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
6894         case we need to change the emitted regop to an EXACT. */
6895     const char * orig_parse = RExC_parse;
6896     GET_RE_DEBUG_FLAGS_DECL;
6897 #ifndef DEBUGGING
6898     PERL_UNUSED_ARG(depth);
6899 #endif
6900
6901     DEBUG_PARSE("clas");
6902
6903     /* Assume we are going to generate an ANYOF node. */
6904     ret = reganode(pRExC_state, ANYOF, 0);
6905
6906     if (!SIZE_ONLY)
6907         ANYOF_FLAGS(ret) = 0;
6908
6909     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
6910         RExC_naughty++;
6911         RExC_parse++;
6912         if (!SIZE_ONLY)
6913             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
6914     }
6915
6916     if (SIZE_ONLY) {
6917         RExC_size += ANYOF_SKIP;
6918         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
6919     }
6920     else {
6921         RExC_emit += ANYOF_SKIP;
6922         if (FOLD)
6923             ANYOF_FLAGS(ret) |= ANYOF_FOLD;
6924         if (LOC)
6925             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
6926         ANYOF_BITMAP_ZERO(ret);
6927         listsv = newSVpvs("# comment\n");
6928     }
6929
6930     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
6931
6932     if (!SIZE_ONLY && POSIXCC(nextvalue))
6933         checkposixcc(pRExC_state);
6934
6935     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
6936     if (UCHARAT(RExC_parse) == ']')
6937         goto charclassloop;
6938
6939 parseit:
6940     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
6941
6942     charclassloop:
6943
6944         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
6945
6946         if (!range)
6947             rangebegin = RExC_parse;
6948         if (UTF) {
6949             value = utf8n_to_uvchr((U8*)RExC_parse,
6950                                    RExC_end - RExC_parse,
6951                                    &numlen, UTF8_ALLOW_DEFAULT);
6952             RExC_parse += numlen;
6953         }
6954         else
6955             value = UCHARAT(RExC_parse++);
6956
6957         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
6958         if (value == '[' && POSIXCC(nextvalue))
6959             namedclass = regpposixcc(pRExC_state, value);
6960         else if (value == '\\') {
6961             if (UTF) {
6962                 value = utf8n_to_uvchr((U8*)RExC_parse,
6963                                    RExC_end - RExC_parse,
6964                                    &numlen, UTF8_ALLOW_DEFAULT);
6965                 RExC_parse += numlen;
6966             }
6967             else
6968                 value = UCHARAT(RExC_parse++);
6969             /* Some compilers cannot handle switching on 64-bit integer
6970              * values, therefore value cannot be an UV.  Yes, this will
6971              * be a problem later if we want switch on Unicode.
6972              * A similar issue a little bit later when switching on
6973              * namedclass. --jhi */
6974             switch ((I32)value) {
6975             case 'w':   namedclass = ANYOF_ALNUM;       break;
6976             case 'W':   namedclass = ANYOF_NALNUM;      break;
6977             case 's':   namedclass = ANYOF_SPACE;       break;
6978             case 'S':   namedclass = ANYOF_NSPACE;      break;
6979             case 'd':   namedclass = ANYOF_DIGIT;       break;
6980             case 'D':   namedclass = ANYOF_NDIGIT;      break;
6981             case 'N':  /* Handle \N{NAME} in class */
6982                 {
6983                     /* We only pay attention to the first char of 
6984                     multichar strings being returned. I kinda wonder
6985                     if this makes sense as it does change the behaviour
6986                     from earlier versions, OTOH that behaviour was broken
6987                     as well. */
6988                     UV v; /* value is register so we cant & it /grrr */
6989                     if (reg_namedseq(pRExC_state, &v)) {
6990                         goto parseit;
6991                     }
6992                     value= v; 
6993                 }
6994                 break;
6995             case 'p':
6996             case 'P':
6997                 {
6998                 char *e;
6999                 if (RExC_parse >= RExC_end)
7000                     vFAIL2("Empty \\%c{}", (U8)value);
7001                 if (*RExC_parse == '{') {
7002                     const U8 c = (U8)value;
7003                     e = strchr(RExC_parse++, '}');
7004                     if (!e)
7005                         vFAIL2("Missing right brace on \\%c{}", c);
7006                     while (isSPACE(UCHARAT(RExC_parse)))
7007                         RExC_parse++;
7008                     if (e == RExC_parse)
7009                         vFAIL2("Empty \\%c{}", c);
7010                     n = e - RExC_parse;
7011                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
7012                         n--;
7013                 }
7014                 else {
7015                     e = RExC_parse;
7016                     n = 1;
7017                 }
7018                 if (!SIZE_ONLY) {
7019                     if (UCHARAT(RExC_parse) == '^') {
7020                          RExC_parse++;
7021                          n--;
7022                          value = value == 'p' ? 'P' : 'p'; /* toggle */
7023                          while (isSPACE(UCHARAT(RExC_parse))) {
7024                               RExC_parse++;
7025                               n--;
7026                          }
7027                     }
7028                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%.*s\n",
7029                         (value=='p' ? '+' : '!'), (int)n, RExC_parse);
7030                 }
7031                 RExC_parse = e + 1;
7032                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
7033                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
7034                 }
7035                 break;
7036             case 'n':   value = '\n';                   break;
7037             case 'r':   value = '\r';                   break;
7038             case 't':   value = '\t';                   break;
7039             case 'f':   value = '\f';                   break;
7040             case 'b':   value = '\b';                   break;
7041             case 'e':   value = ASCII_TO_NATIVE('\033');break;
7042             case 'a':   value = ASCII_TO_NATIVE('\007');break;
7043             case 'x':
7044                 if (*RExC_parse == '{') {
7045                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
7046                         | PERL_SCAN_DISALLOW_PREFIX;
7047                     char * const e = strchr(RExC_parse++, '}');
7048                     if (!e)
7049                         vFAIL("Missing right brace on \\x{}");
7050
7051                     numlen = e - RExC_parse;
7052                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
7053                     RExC_parse = e + 1;
7054                 }
7055                 else {
7056                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
7057                     numlen = 2;
7058                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
7059                     RExC_parse += numlen;
7060                 }
7061                 if (PL_encoding && value < 0x100)
7062                     goto recode_encoding;
7063                 break;
7064             case 'c':
7065                 value = UCHARAT(RExC_parse++);
7066                 value = toCTRL(value);
7067                 break;
7068             case '0': case '1': case '2': case '3': case '4':
7069             case '5': case '6': case '7': case '8': case '9':
7070                 {
7071                     I32 flags = 0;
7072                     numlen = 3;
7073                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
7074                     RExC_parse += numlen;
7075                     if (PL_encoding && value < 0x100)
7076                         goto recode_encoding;
7077                     break;
7078                 }
7079             recode_encoding:
7080                 {
7081                     SV* enc = PL_encoding;
7082                     value = reg_recode((const char)(U8)value, &enc);
7083                     if (!enc && SIZE_ONLY && ckWARN(WARN_REGEXP))
7084                         vWARN(RExC_parse,
7085                               "Invalid escape in the specified encoding");
7086                     break;
7087                 }
7088             default:
7089                 if (!SIZE_ONLY && isALPHA(value) && ckWARN(WARN_REGEXP))
7090                     vWARN2(RExC_parse,
7091                            "Unrecognized escape \\%c in character class passed through",
7092                            (int)value);
7093                 break;
7094             }
7095         } /* end of \blah */
7096 #ifdef EBCDIC
7097         else
7098             literal_endpoint++;
7099 #endif
7100
7101         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
7102
7103             if (!SIZE_ONLY && !need_class)
7104                 ANYOF_CLASS_ZERO(ret);
7105
7106             need_class = 1;
7107
7108             /* a bad range like a-\d, a-[:digit:] ? */
7109             if (range) {
7110                 if (!SIZE_ONLY) {
7111                     if (ckWARN(WARN_REGEXP)) {
7112                         const int w =
7113                             RExC_parse >= rangebegin ?
7114                             RExC_parse - rangebegin : 0;
7115                         vWARN4(RExC_parse,
7116                                "False [] range \"%*.*s\"",
7117                                w, w, rangebegin);
7118                     }
7119                     if (prevvalue < 256) {
7120                         ANYOF_BITMAP_SET(ret, prevvalue);
7121                         ANYOF_BITMAP_SET(ret, '-');
7122                     }
7123                     else {
7124                         ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
7125                         Perl_sv_catpvf(aTHX_ listsv,
7126                                        "%04"UVxf"\n%04"UVxf"\n", (UV)prevvalue, (UV) '-');
7127                     }
7128                 }
7129
7130                 range = 0; /* this was not a true range */
7131             }
7132
7133             if (!SIZE_ONLY) {
7134                 const char *what = NULL;
7135                 char yesno = 0;
7136
7137                 if (namedclass > OOB_NAMEDCLASS)
7138                     optimize_invert = FALSE;
7139                 /* Possible truncation here but in some 64-bit environments
7140                  * the compiler gets heartburn about switch on 64-bit values.
7141                  * A similar issue a little earlier when switching on value.
7142                  * --jhi */
7143                 switch ((I32)namedclass) {
7144                 case ANYOF_ALNUM:
7145                     if (LOC)
7146                         ANYOF_CLASS_SET(ret, ANYOF_ALNUM);
7147                     else {
7148                         for (value = 0; value < 256; value++)
7149                             if (isALNUM(value))
7150                                 ANYOF_BITMAP_SET(ret, value);
7151                     }
7152                     yesno = '+';
7153                     what = "Word";      
7154                     break;
7155                 case ANYOF_NALNUM:
7156                     if (LOC)
7157                         ANYOF_CLASS_SET(ret, ANYOF_NALNUM);
7158                     else {
7159                         for (value = 0; value < 256; value++)
7160                             if (!isALNUM(value))
7161                                 ANYOF_BITMAP_SET(ret, value);
7162                     }
7163                     yesno = '!';
7164                     what = "Word";
7165                     break;
7166                 case ANYOF_ALNUMC:
7167                     if (LOC)
7168                         ANYOF_CLASS_SET(ret, ANYOF_ALNUMC);
7169                     else {
7170                         for (value = 0; value < 256; value++)
7171                             if (isALNUMC(value))
7172                                 ANYOF_BITMAP_SET(ret, value);
7173                     }
7174                     yesno = '+';
7175                     what = "Alnum";
7176                     break;
7177                 case ANYOF_NALNUMC:
7178                     if (LOC)
7179                         ANYOF_CLASS_SET(ret, ANYOF_NALNUMC);
7180                     else {
7181                         for (value = 0; value < 256; value++)
7182                             if (!isALNUMC(value))
7183                                 ANYOF_BITMAP_SET(ret, value);
7184                     }
7185                     yesno = '!';
7186                     what = "Alnum";
7187                     break;
7188                 case ANYOF_ALPHA:
7189                     if (LOC)
7190                         ANYOF_CLASS_SET(ret, ANYOF_ALPHA);
7191                     else {
7192                         for (value = 0; value < 256; value++)
7193                             if (isALPHA(value))
7194                                 ANYOF_BITMAP_SET(ret, value);
7195                     }
7196                     yesno = '+';
7197                     what = "Alpha";
7198                     break;
7199                 case ANYOF_NALPHA:
7200                     if (LOC)
7201                         ANYOF_CLASS_SET(ret, ANYOF_NALPHA);
7202                     else {
7203                         for (value = 0; value < 256; value++)
7204                             if (!isALPHA(value))
7205                                 ANYOF_BITMAP_SET(ret, value);
7206                     }
7207                     yesno = '!';
7208                     what = "Alpha";
7209                     break;
7210                 case ANYOF_ASCII:
7211                     if (LOC)
7212                         ANYOF_CLASS_SET(ret, ANYOF_ASCII);
7213                     else {
7214 #ifndef EBCDIC
7215                         for (value = 0; value < 128; value++)
7216                             ANYOF_BITMAP_SET(ret, value);
7217 #else  /* EBCDIC */
7218                         for (value = 0; value < 256; value++) {
7219                             if (isASCII(value))
7220                                 ANYOF_BITMAP_SET(ret, value);
7221                         }
7222 #endif /* EBCDIC */
7223                     }
7224                     yesno = '+';
7225                     what = "ASCII";
7226                     break;
7227                 case ANYOF_NASCII:
7228                     if (LOC)
7229                         ANYOF_CLASS_SET(ret, ANYOF_NASCII);
7230                     else {
7231 #ifndef EBCDIC
7232                         for (value = 128; value < 256; value++)
7233                             ANYOF_BITMAP_SET(ret, value);
7234 #else  /* EBCDIC */
7235                         for (value = 0; value < 256; value++) {
7236                             if (!isASCII(value))
7237                                 ANYOF_BITMAP_SET(ret, value);
7238                         }
7239 #endif /* EBCDIC */
7240                     }
7241                     yesno = '!';
7242                     what = "ASCII";
7243                     break;
7244                 case ANYOF_BLANK:
7245                     if (LOC)
7246                         ANYOF_CLASS_SET(ret, ANYOF_BLANK);
7247                     else {
7248                         for (value = 0; value < 256; value++)
7249                             if (isBLANK(value))
7250                                 ANYOF_BITMAP_SET(ret, value);
7251                     }
7252                     yesno = '+';
7253                     what = "Blank";
7254                     break;
7255                 case ANYOF_NBLANK:
7256                     if (LOC)
7257                         ANYOF_CLASS_SET(ret, ANYOF_NBLANK);
7258                     else {
7259                         for (value = 0; value < 256; value++)
7260                             if (!isBLANK(value))
7261                                 ANYOF_BITMAP_SET(ret, value);
7262                     }
7263                     yesno = '!';
7264                     what = "Blank";
7265                     break;
7266                 case ANYOF_CNTRL:
7267                     if (LOC)
7268                         ANYOF_CLASS_SET(ret, ANYOF_CNTRL);
7269                     else {
7270                         for (value = 0; value < 256; value++)
7271                             if (isCNTRL(value))
7272                                 ANYOF_BITMAP_SET(ret, value);
7273                     }
7274                     yesno = '+';
7275                     what = "Cntrl";
7276                     break;
7277                 case ANYOF_NCNTRL:
7278                     if (LOC)
7279                         ANYOF_CLASS_SET(ret, ANYOF_NCNTRL);
7280                     else {
7281                         for (value = 0; value < 256; value++)
7282                             if (!isCNTRL(value))
7283                                 ANYOF_BITMAP_SET(ret, value);
7284                     }
7285                     yesno = '!';
7286                     what = "Cntrl";
7287                     break;
7288                 case ANYOF_DIGIT:
7289                     if (LOC)
7290                         ANYOF_CLASS_SET(ret, ANYOF_DIGIT);
7291                     else {
7292                         /* consecutive digits assumed */
7293                         for (value = '0'; value <= '9'; value++)
7294                             ANYOF_BITMAP_SET(ret, value);
7295                     }
7296                     yesno = '+';
7297                     what = "Digit";
7298                     break;
7299                 case ANYOF_NDIGIT:
7300                     if (LOC)
7301                         ANYOF_CLASS_SET(ret, ANYOF_NDIGIT);
7302                     else {
7303                         /* consecutive digits assumed */
7304                         for (value = 0; value < '0'; value++)
7305                             ANYOF_BITMAP_SET(ret, value);
7306                         for (value = '9' + 1; value < 256; value++)
7307                             ANYOF_BITMAP_SET(ret, value);
7308                     }
7309                     yesno = '!';
7310                     what = "Digit";
7311                     break;
7312                 case ANYOF_GRAPH:
7313                     if (LOC)
7314                         ANYOF_CLASS_SET(ret, ANYOF_GRAPH);
7315                     else {
7316                         for (value = 0; value < 256; value++)
7317                             if (isGRAPH(value))
7318                                 ANYOF_BITMAP_SET(ret, value);
7319                     }
7320                     yesno = '+';
7321                     what = "Graph";
7322                     break;
7323                 case ANYOF_NGRAPH:
7324                     if (LOC)
7325                         ANYOF_CLASS_SET(ret, ANYOF_NGRAPH);
7326                     else {
7327                         for (value = 0; value < 256; value++)
7328                             if (!isGRAPH(value))
7329                                 ANYOF_BITMAP_SET(ret, value);
7330                     }
7331                     yesno = '!';
7332                     what = "Graph";
7333                     break;
7334                 case ANYOF_LOWER:
7335                     if (LOC)
7336                         ANYOF_CLASS_SET(ret, ANYOF_LOWER);
7337                     else {
7338                         for (value = 0; value < 256; value++)
7339                             if (isLOWER(value))
7340                                 ANYOF_BITMAP_SET(ret, value);
7341                     }
7342                     yesno = '+';
7343                     what = "Lower";
7344                     break;
7345                 case ANYOF_NLOWER:
7346                     if (LOC)
7347                         ANYOF_CLASS_SET(ret, ANYOF_NLOWER);
7348                     else {
7349                         for (value = 0; value < 256; value++)
7350                             if (!isLOWER(value))
7351                                 ANYOF_BITMAP_SET(ret, value);
7352                     }
7353                     yesno = '!';
7354                     what = "Lower";
7355                     break;
7356                 case ANYOF_PRINT:
7357                     if (LOC)
7358                         ANYOF_CLASS_SET(ret, ANYOF_PRINT);
7359                     else {
7360                         for (value = 0; value < 256; value++)
7361                             if (isPRINT(value))
7362                                 ANYOF_BITMAP_SET(ret, value);
7363                     }
7364                     yesno = '+';
7365                     what = "Print";
7366                     break;
7367                 case ANYOF_NPRINT:
7368                     if (LOC)
7369                         ANYOF_CLASS_SET(ret, ANYOF_NPRINT);
7370                     else {
7371                         for (value = 0; value < 256; value++)
7372                             if (!isPRINT(value))
7373                                 ANYOF_BITMAP_SET(ret, value);
7374                     }
7375                     yesno = '!';
7376                     what = "Print";
7377                     break;
7378                 case ANYOF_PSXSPC:
7379                     if (LOC)
7380                         ANYOF_CLASS_SET(ret, ANYOF_PSXSPC);
7381                     else {
7382                         for (value = 0; value < 256; value++)
7383                             if (isPSXSPC(value))
7384                                 ANYOF_BITMAP_SET(ret, value);
7385                     }
7386                     yesno = '+';
7387                     what = "Space";
7388                     break;
7389                 case ANYOF_NPSXSPC:
7390                     if (LOC)
7391                         ANYOF_CLASS_SET(ret, ANYOF_NPSXSPC);
7392                     else {
7393                         for (value = 0; value < 256; value++)
7394                             if (!isPSXSPC(value))
7395                                 ANYOF_BITMAP_SET(ret, value);
7396                     }
7397                     yesno = '!';
7398                     what = "Space";
7399                     break;
7400                 case ANYOF_PUNCT:
7401                     if (LOC)
7402                         ANYOF_CLASS_SET(ret, ANYOF_PUNCT);
7403                     else {
7404                         for (value = 0; value < 256; value++)
7405                             if (isPUNCT(value))
7406                                 ANYOF_BITMAP_SET(ret, value);
7407                     }
7408                     yesno = '+';
7409                     what = "Punct";
7410                     break;
7411                 case ANYOF_NPUNCT:
7412                     if (LOC)
7413                         ANYOF_CLASS_SET(ret, ANYOF_NPUNCT);
7414                     else {
7415                         for (value = 0; value < 256; value++)
7416                             if (!isPUNCT(value))
7417                                 ANYOF_BITMAP_SET(ret, value);
7418                     }
7419                     yesno = '!';
7420                     what = "Punct";
7421                     break;
7422                 case ANYOF_SPACE:
7423                     if (LOC)
7424                         ANYOF_CLASS_SET(ret, ANYOF_SPACE);
7425                     else {
7426                         for (value = 0; value < 256; value++)
7427                             if (isSPACE(value))
7428                                 ANYOF_BITMAP_SET(ret, value);
7429                     }
7430                     yesno = '+';
7431                     what = "SpacePerl";
7432                     break;
7433                 case ANYOF_NSPACE:
7434                     if (LOC)
7435                         ANYOF_CLASS_SET(ret, ANYOF_NSPACE);
7436                     else {
7437                         for (value = 0; value < 256; value++)
7438                             if (!isSPACE(value))
7439                                 ANYOF_BITMAP_SET(ret, value);
7440                     }
7441                     yesno = '!';
7442                     what = "SpacePerl";
7443                     break;
7444                 case ANYOF_UPPER:
7445                     if (LOC)
7446                         ANYOF_CLASS_SET(ret, ANYOF_UPPER);
7447                     else {
7448                         for (value = 0; value < 256; value++)
7449                             if (isUPPER(value))
7450                                 ANYOF_BITMAP_SET(ret, value);
7451                     }
7452                     yesno = '+';
7453                     what = "Upper";
7454                     break;
7455                 case ANYOF_NUPPER:
7456                     if (LOC)
7457                         ANYOF_CLASS_SET(ret, ANYOF_NUPPER);
7458                     else {
7459                         for (value = 0; value < 256; value++)
7460                             if (!isUPPER(value))
7461                                 ANYOF_BITMAP_SET(ret, value);
7462                     }
7463                     yesno = '!';
7464                     what = "Upper";
7465                     break;
7466                 case ANYOF_XDIGIT:
7467                     if (LOC)
7468                         ANYOF_CLASS_SET(ret, ANYOF_XDIGIT);
7469                     else {
7470                         for (value = 0; value < 256; value++)
7471                             if (isXDIGIT(value))
7472                                 ANYOF_BITMAP_SET(ret, value);
7473                     }
7474                     yesno = '+';
7475                     what = "XDigit";
7476                     break;
7477                 case ANYOF_NXDIGIT:
7478                     if (LOC)
7479                         ANYOF_CLASS_SET(ret, ANYOF_NXDIGIT);
7480                     else {
7481                         for (value = 0; value < 256; value++)
7482                             if (!isXDIGIT(value))
7483                                 ANYOF_BITMAP_SET(ret, value);
7484                     }
7485                     yesno = '!';
7486                     what = "XDigit";
7487                     break;
7488                 case ANYOF_MAX:
7489                     /* this is to handle \p and \P */
7490                     break;
7491                 default:
7492                     vFAIL("Invalid [::] class");
7493                     break;
7494                 }
7495                 if (what) {
7496                     /* Strings such as "+utf8::isWord\n" */
7497                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::Is%s\n", yesno, what);
7498                 }
7499                 if (LOC)
7500                     ANYOF_FLAGS(ret) |= ANYOF_CLASS;
7501                 continue;
7502             }
7503         } /* end of namedclass \blah */
7504
7505         if (range) {
7506             if (prevvalue > (IV)value) /* b-a */ {
7507                 const int w = RExC_parse - rangebegin;
7508                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
7509                 range = 0; /* not a valid range */
7510             }
7511         }
7512         else {
7513             prevvalue = value; /* save the beginning of the range */
7514             if (*RExC_parse == '-' && RExC_parse+1 < RExC_end &&
7515                 RExC_parse[1] != ']') {
7516                 RExC_parse++;
7517
7518                 /* a bad range like \w-, [:word:]- ? */
7519                 if (namedclass > OOB_NAMEDCLASS) {
7520                     if (ckWARN(WARN_REGEXP)) {
7521                         const int w =
7522                             RExC_parse >= rangebegin ?
7523                             RExC_parse - rangebegin : 0;
7524                         vWARN4(RExC_parse,
7525                                "False [] range \"%*.*s\"",
7526                                w, w, rangebegin);
7527                     }
7528                     if (!SIZE_ONLY)
7529                         ANYOF_BITMAP_SET(ret, '-');
7530                 } else
7531                     range = 1;  /* yeah, it's a range! */
7532                 continue;       /* but do it the next time */
7533             }
7534         }
7535
7536         /* now is the next time */
7537         /*stored += (value - prevvalue + 1);*/
7538         if (!SIZE_ONLY) {
7539             if (prevvalue < 256) {
7540                 const IV ceilvalue = value < 256 ? value : 255;
7541                 IV i;
7542 #ifdef EBCDIC
7543                 /* In EBCDIC [\x89-\x91] should include
7544                  * the \x8e but [i-j] should not. */
7545                 if (literal_endpoint == 2 &&
7546                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
7547                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
7548                 {
7549                     if (isLOWER(prevvalue)) {
7550                         for (i = prevvalue; i <= ceilvalue; i++)
7551                             if (isLOWER(i))
7552                                 ANYOF_BITMAP_SET(ret, i);
7553                     } else {
7554                         for (i = prevvalue; i <= ceilvalue; i++)
7555                             if (isUPPER(i))
7556                                 ANYOF_BITMAP_SET(ret, i);
7557                     }
7558                 }
7559                 else
7560 #endif
7561                       for (i = prevvalue; i <= ceilvalue; i++) {
7562                         if (!ANYOF_BITMAP_TEST(ret,i)) {
7563                             stored++;  
7564                             ANYOF_BITMAP_SET(ret, i);
7565                         }
7566                       }
7567           }
7568           if (value > 255 || UTF) {
7569                 const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
7570                 const UV natvalue      = NATIVE_TO_UNI(value);
7571                 stored+=2; /* can't optimize this class */
7572                 ANYOF_FLAGS(ret) |= ANYOF_UNICODE;
7573                 if (prevnatvalue < natvalue) { /* what about > ? */
7574                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\t%04"UVxf"\n",
7575                                    prevnatvalue, natvalue);
7576                 }
7577                 else if (prevnatvalue == natvalue) {
7578                     Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n", natvalue);
7579                     if (FOLD) {
7580                          U8 foldbuf[UTF8_MAXBYTES_CASE+1];
7581                          STRLEN foldlen;
7582                          const UV f = to_uni_fold(natvalue, foldbuf, &foldlen);
7583
7584 #ifdef EBCDIC /* RD t/uni/fold ff and 6b */
7585                          if (RExC_precomp[0] == ':' &&
7586                              RExC_precomp[1] == '[' &&
7587                              (f == 0xDF || f == 0x92)) {
7588                              f = NATIVE_TO_UNI(f);
7589                         }
7590 #endif
7591                          /* If folding and foldable and a single
7592                           * character, insert also the folded version
7593                           * to the charclass. */
7594                          if (f != value) {
7595 #ifdef EBCDIC /* RD tunifold ligatures s,t fb05, fb06 */
7596                              if ((RExC_precomp[0] == ':' &&
7597                                   RExC_precomp[1] == '[' &&
7598                                   (f == 0xA2 &&
7599                                    (value == 0xFB05 || value == 0xFB06))) ?
7600                                  foldlen == ((STRLEN)UNISKIP(f) - 1) :
7601                                  foldlen == (STRLEN)UNISKIP(f) )
7602 #else
7603                               if (foldlen == (STRLEN)UNISKIP(f))
7604 #endif
7605                                   Perl_sv_catpvf(aTHX_ listsv,
7606                                                  "%04"UVxf"\n", f);
7607                               else {
7608                                   /* Any multicharacter foldings
7609                                    * require the following transform:
7610                                    * [ABCDEF] -> (?:[ABCabcDEFd]|pq|rst)
7611                                    * where E folds into "pq" and F folds
7612                                    * into "rst", all other characters
7613                                    * fold to single characters.  We save
7614                                    * away these multicharacter foldings,
7615                                    * to be later saved as part of the
7616                                    * additional "s" data. */
7617                                   SV *sv;
7618
7619                                   if (!unicode_alternate)
7620                                       unicode_alternate = newAV();
7621                                   sv = newSVpvn((char*)foldbuf, foldlen);
7622                                   SvUTF8_on(sv);
7623                                   av_push(unicode_alternate, sv);
7624                               }
7625                          }
7626
7627                          /* If folding and the value is one of the Greek
7628                           * sigmas insert a few more sigmas to make the
7629                           * folding rules of the sigmas to work right.
7630                           * Note that not all the possible combinations
7631                           * are handled here: some of them are handled
7632                           * by the standard folding rules, and some of
7633                           * them (literal or EXACTF cases) are handled
7634                           * during runtime in regexec.c:S_find_byclass(). */
7635                          if (value == UNICODE_GREEK_SMALL_LETTER_FINAL_SIGMA) {
7636                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7637                                              (UV)UNICODE_GREEK_CAPITAL_LETTER_SIGMA);
7638                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7639                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
7640                          }
7641                          else if (value == UNICODE_GREEK_CAPITAL_LETTER_SIGMA)
7642                               Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n",
7643                                              (UV)UNICODE_GREEK_SMALL_LETTER_SIGMA);
7644                     }
7645                 }
7646             }
7647 #ifdef EBCDIC
7648             literal_endpoint = 0;
7649 #endif
7650         }
7651
7652         range = 0; /* this range (if it was one) is done now */
7653     }
7654
7655     if (need_class) {
7656         ANYOF_FLAGS(ret) |= ANYOF_LARGE;
7657         if (SIZE_ONLY)
7658             RExC_size += ANYOF_CLASS_ADD_SKIP;
7659         else
7660             RExC_emit += ANYOF_CLASS_ADD_SKIP;
7661     }
7662
7663
7664     if (SIZE_ONLY)
7665         return ret;
7666     /****** !SIZE_ONLY AFTER HERE *********/
7667
7668     if( stored == 1 && value < 256
7669         && !( ANYOF_FLAGS(ret) & ( ANYOF_FLAGS_ALL ^ ANYOF_FOLD ) )
7670     ) {
7671         /* optimize single char class to an EXACT node
7672            but *only* when its not a UTF/high char  */
7673         const char * cur_parse= RExC_parse;
7674         RExC_emit = (regnode *)orig_emit;
7675         RExC_parse = (char *)orig_parse;
7676         ret = reg_node(pRExC_state,
7677                        (U8)((ANYOF_FLAGS(ret) & ANYOF_FOLD) ? EXACTF : EXACT));
7678         RExC_parse = (char *)cur_parse;
7679         *STRING(ret)= (char)value;
7680         STR_LEN(ret)= 1;
7681         RExC_emit += STR_SZ(1);
7682         return ret;
7683     }
7684     /* optimize case-insensitive simple patterns (e.g. /[a-z]/i) */
7685     if ( /* If the only flag is folding (plus possibly inversion). */
7686         ((ANYOF_FLAGS(ret) & (ANYOF_FLAGS_ALL ^ ANYOF_INVERT)) == ANYOF_FOLD)
7687        ) {
7688         for (value = 0; value < 256; ++value) {
7689             if (ANYOF_BITMAP_TEST(ret, value)) {
7690                 UV fold = PL_fold[value];
7691
7692                 if (fold != value)
7693                     ANYOF_BITMAP_SET(ret, fold);
7694             }
7695         }
7696         ANYOF_FLAGS(ret) &= ~ANYOF_FOLD;
7697     }
7698
7699     /* optimize inverted simple patterns (e.g. [^a-z]) */
7700     if (optimize_invert &&
7701         /* If the only flag is inversion. */
7702         (ANYOF_FLAGS(ret) & ANYOF_FLAGS_ALL) == ANYOF_INVERT) {
7703         for (value = 0; value < ANYOF_BITMAP_SIZE; ++value)
7704             ANYOF_BITMAP(ret)[value] ^= ANYOF_FLAGS_ALL;
7705         ANYOF_FLAGS(ret) = ANYOF_UNICODE_ALL;
7706     }
7707     {
7708         AV * const av = newAV();
7709         SV *rv;
7710         /* The 0th element stores the character class description
7711          * in its textual form: used later (regexec.c:Perl_regclass_swash())
7712          * to initialize the appropriate swash (which gets stored in
7713          * the 1st element), and also useful for dumping the regnode.
7714          * The 2nd element stores the multicharacter foldings,
7715          * used later (regexec.c:S_reginclass()). */
7716         av_store(av, 0, listsv);
7717         av_store(av, 1, NULL);
7718         av_store(av, 2, (SV*)unicode_alternate);
7719         rv = newRV_noinc((SV*)av);
7720         n = add_data(pRExC_state, 1, "s");
7721         RExC_rxi->data->data[n] = (void*)rv;
7722         ARG_SET(ret, n);
7723     }
7724     return ret;
7725 }
7726
7727 STATIC char*
7728 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
7729 {
7730     char* const retval = RExC_parse++;
7731
7732     for (;;) {
7733         if (*RExC_parse == '(' && RExC_parse[1] == '?' &&
7734                 RExC_parse[2] == '#') {
7735             while (*RExC_parse != ')') {
7736                 if (RExC_parse == RExC_end)
7737                     FAIL("Sequence (?#... not terminated");
7738                 RExC_parse++;
7739             }
7740             RExC_parse++;
7741             continue;
7742         }
7743         if (RExC_flags & RXf_PMf_EXTENDED) {
7744             if (isSPACE(*RExC_parse)) {
7745                 RExC_parse++;
7746                 continue;
7747             }
7748             else if (*RExC_parse == '#') {
7749                 while (RExC_parse < RExC_end)
7750                     if (*RExC_parse++ == '\n') break;
7751                 continue;
7752             }
7753         }
7754         return retval;
7755     }
7756 }
7757
7758 /*
7759 - reg_node - emit a node
7760 */
7761 STATIC regnode *                        /* Location. */
7762 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
7763 {
7764     dVAR;
7765     register regnode *ptr;
7766     regnode * const ret = RExC_emit;
7767     GET_RE_DEBUG_FLAGS_DECL;
7768
7769     if (SIZE_ONLY) {
7770         SIZE_ALIGN(RExC_size);
7771         RExC_size += 1;
7772         return(ret);
7773     }
7774 #ifdef DEBUGGING
7775     if (OP(RExC_emit) == 255)
7776         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %s: %d ",
7777             reg_name[op], OP(RExC_emit));
7778 #endif  
7779     NODE_ALIGN_FILL(ret);
7780     ptr = ret;
7781     FILL_ADVANCE_NODE(ptr, op);
7782     if (RExC_offsets) {         /* MJD */
7783         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
7784               "reg_node", __LINE__, 
7785               reg_name[op],
7786               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
7787                 ? "Overwriting end of array!\n" : "OK",
7788               (UV)(RExC_emit - RExC_emit_start),
7789               (UV)(RExC_parse - RExC_start),
7790               (UV)RExC_offsets[0])); 
7791         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
7792     }
7793
7794     RExC_emit = ptr;
7795     return(ret);
7796 }
7797
7798 /*
7799 - reganode - emit a node with an argument
7800 */
7801 STATIC regnode *                        /* Location. */
7802 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
7803 {
7804     dVAR;
7805     register regnode *ptr;
7806     regnode * const ret = RExC_emit;
7807     GET_RE_DEBUG_FLAGS_DECL;
7808
7809     if (SIZE_ONLY) {
7810         SIZE_ALIGN(RExC_size);
7811         RExC_size += 2;
7812         /* 
7813            We can't do this:
7814            
7815            assert(2==regarglen[op]+1); 
7816         
7817            Anything larger than this has to allocate the extra amount.
7818            If we changed this to be:
7819            
7820            RExC_size += (1 + regarglen[op]);
7821            
7822            then it wouldn't matter. Its not clear what side effect
7823            might come from that so its not done so far.
7824            -- dmq
7825         */
7826         return(ret);
7827     }
7828 #ifdef DEBUGGING
7829     if (OP(RExC_emit) == 255)
7830         Perl_croak(aTHX_ "panic: reganode overwriting end of allocated program space");
7831 #endif 
7832     NODE_ALIGN_FILL(ret);
7833     ptr = ret;
7834     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
7835     if (RExC_offsets) {         /* MJD */
7836         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
7837               "reganode",
7838               __LINE__,
7839               reg_name[op],
7840               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
7841               "Overwriting end of array!\n" : "OK",
7842               (UV)(RExC_emit - RExC_emit_start),
7843               (UV)(RExC_parse - RExC_start),
7844               (UV)RExC_offsets[0])); 
7845         Set_Cur_Node_Offset;
7846     }
7847             
7848     RExC_emit = ptr;
7849     return(ret);
7850 }
7851
7852 /*
7853 - reguni - emit (if appropriate) a Unicode character
7854 */
7855 STATIC STRLEN
7856 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
7857 {
7858     dVAR;
7859     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
7860 }
7861
7862 /*
7863 - reginsert - insert an operator in front of already-emitted operand
7864 *
7865 * Means relocating the operand.
7866 */
7867 STATIC void
7868 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
7869 {
7870     dVAR;
7871     register regnode *src;
7872     register regnode *dst;
7873     register regnode *place;
7874     const int offset = regarglen[(U8)op];
7875     const int size = NODE_STEP_REGNODE + offset;
7876     GET_RE_DEBUG_FLAGS_DECL;
7877 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
7878     DEBUG_PARSE_FMT("inst"," - %s",reg_name[op]);
7879     if (SIZE_ONLY) {
7880         RExC_size += size;
7881         return;
7882     }
7883
7884     src = RExC_emit;
7885     RExC_emit += size;
7886     dst = RExC_emit;
7887     if (RExC_open_parens) {
7888         int paren;
7889         DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);
7890         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
7891             if ( RExC_open_parens[paren] >= opnd ) {
7892                 DEBUG_PARSE_FMT("open"," - %d",size);
7893                 RExC_open_parens[paren] += size;
7894             } else {
7895                 DEBUG_PARSE_FMT("open"," - %s","ok");
7896             }
7897             if ( RExC_close_parens[paren] >= opnd ) {
7898                 DEBUG_PARSE_FMT("close"," - %d",size);
7899                 RExC_close_parens[paren] += size;
7900             } else {
7901                 DEBUG_PARSE_FMT("close"," - %s","ok");
7902             }
7903         }
7904     }
7905
7906     while (src > opnd) {
7907         StructCopy(--src, --dst, regnode);
7908         if (RExC_offsets) {     /* MJD 20010112 */
7909             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
7910                   "reg_insert",
7911                   __LINE__,
7912                   reg_name[op],
7913                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
7914                     ? "Overwriting end of array!\n" : "OK",
7915                   (UV)(src - RExC_emit_start),
7916                   (UV)(dst - RExC_emit_start),
7917                   (UV)RExC_offsets[0])); 
7918             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
7919             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
7920         }
7921     }
7922     
7923
7924     place = opnd;               /* Op node, where operand used to be. */
7925     if (RExC_offsets) {         /* MJD */
7926         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
7927               "reginsert",
7928               __LINE__,
7929               reg_name[op],
7930               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
7931               ? "Overwriting end of array!\n" : "OK",
7932               (UV)(place - RExC_emit_start),
7933               (UV)(RExC_parse - RExC_start),
7934               (UV)RExC_offsets[0]));
7935         Set_Node_Offset(place, RExC_parse);
7936         Set_Node_Length(place, 1);
7937     }
7938     src = NEXTOPER(place);
7939     FILL_ADVANCE_NODE(place, op);
7940     Zero(src, offset, regnode);
7941 }
7942
7943 /*
7944 - regtail - set the next-pointer at the end of a node chain of p to val.
7945 - SEE ALSO: regtail_study
7946 */
7947 /* TODO: All three parms should be const */
7948 STATIC void
7949 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
7950 {
7951     dVAR;
7952     register regnode *scan;
7953     GET_RE_DEBUG_FLAGS_DECL;
7954 #ifndef DEBUGGING
7955     PERL_UNUSED_ARG(depth);
7956 #endif
7957
7958     if (SIZE_ONLY)
7959         return;
7960
7961     /* Find last node. */
7962     scan = p;
7963     for (;;) {
7964         regnode * const temp = regnext(scan);
7965         DEBUG_PARSE_r({
7966             SV * const mysv=sv_newmortal();
7967             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
7968             regprop(RExC_rx, mysv, scan);
7969             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
7970                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
7971                     (temp == NULL ? "->" : ""),
7972                     (temp == NULL ? reg_name[OP(val)] : "")
7973             );
7974         });
7975         if (temp == NULL)
7976             break;
7977         scan = temp;
7978     }
7979
7980     if (reg_off_by_arg[OP(scan)]) {
7981         ARG_SET(scan, val - scan);
7982     }
7983     else {
7984         NEXT_OFF(scan) = val - scan;
7985     }
7986 }
7987
7988 #ifdef DEBUGGING
7989 /*
7990 - regtail_study - set the next-pointer at the end of a node chain of p to val.
7991 - Look for optimizable sequences at the same time.
7992 - currently only looks for EXACT chains.
7993
7994 This is expermental code. The idea is to use this routine to perform 
7995 in place optimizations on branches and groups as they are constructed,
7996 with the long term intention of removing optimization from study_chunk so
7997 that it is purely analytical.
7998
7999 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
8000 to control which is which.
8001
8002 */
8003 /* TODO: All four parms should be const */
8004
8005 STATIC U8
8006 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
8007 {
8008     dVAR;
8009     register regnode *scan;
8010     U8 exact = PSEUDO;
8011 #ifdef EXPERIMENTAL_INPLACESCAN
8012     I32 min = 0;
8013 #endif
8014
8015     GET_RE_DEBUG_FLAGS_DECL;
8016
8017
8018     if (SIZE_ONLY)
8019         return exact;
8020
8021     /* Find last node. */
8022
8023     scan = p;
8024     for (;;) {
8025         regnode * const temp = regnext(scan);
8026 #ifdef EXPERIMENTAL_INPLACESCAN
8027         if (PL_regkind[OP(scan)] == EXACT)
8028             if (join_exact(pRExC_state,scan,&min,1,val,depth+1))
8029                 return EXACT;
8030 #endif
8031         if ( exact ) {
8032             switch (OP(scan)) {
8033                 case EXACT:
8034                 case EXACTF:
8035                 case EXACTFL:
8036                         if( exact == PSEUDO )
8037                             exact= OP(scan);
8038                         else if ( exact != OP(scan) )
8039                             exact= 0;
8040                 case NOTHING:
8041                     break;
8042                 default:
8043                     exact= 0;
8044             }
8045         }
8046         DEBUG_PARSE_r({
8047             SV * const mysv=sv_newmortal();
8048             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
8049             regprop(RExC_rx, mysv, scan);
8050             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
8051                 SvPV_nolen_const(mysv),
8052                 REG_NODE_NUM(scan),
8053                 reg_name[exact]);
8054         });
8055         if (temp == NULL)
8056             break;
8057         scan = temp;
8058     }
8059     DEBUG_PARSE_r({
8060         SV * const mysv_val=sv_newmortal();
8061         DEBUG_PARSE_MSG("");
8062         regprop(RExC_rx, mysv_val, val);
8063         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
8064                       SvPV_nolen_const(mysv_val),
8065                       (IV)REG_NODE_NUM(val),
8066                       (IV)(val - scan)
8067         );
8068     });
8069     if (reg_off_by_arg[OP(scan)]) {
8070         ARG_SET(scan, val - scan);
8071     }
8072     else {
8073         NEXT_OFF(scan) = val - scan;
8074     }
8075
8076     return exact;
8077 }
8078 #endif
8079
8080 /*
8081  - regcurly - a little FSA that accepts {\d+,?\d*}
8082  */
8083 STATIC I32
8084 S_regcurly(register const char *s)
8085 {
8086     if (*s++ != '{')
8087         return FALSE;
8088     if (!isDIGIT(*s))
8089         return FALSE;
8090     while (isDIGIT(*s))
8091         s++;
8092     if (*s == ',')
8093         s++;
8094     while (isDIGIT(*s))
8095         s++;
8096     if (*s != '}')
8097         return FALSE;
8098     return TRUE;
8099 }
8100
8101
8102 /*
8103  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
8104  */
8105 void
8106 Perl_regdump(pTHX_ const regexp *r)
8107 {
8108 #ifdef DEBUGGING
8109     dVAR;
8110     SV * const sv = sv_newmortal();
8111     SV *dsv= sv_newmortal();
8112     RXi_GET_DECL(r,ri);
8113
8114     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
8115
8116     /* Header fields of interest. */
8117     if (r->anchored_substr) {
8118         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
8119             RE_SV_DUMPLEN(r->anchored_substr), 30);
8120         PerlIO_printf(Perl_debug_log,
8121                       "anchored %s%s at %"IVdf" ",
8122                       s, RE_SV_TAIL(r->anchored_substr),
8123                       (IV)r->anchored_offset);
8124     } else if (r->anchored_utf8) {
8125         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
8126             RE_SV_DUMPLEN(r->anchored_utf8), 30);
8127         PerlIO_printf(Perl_debug_log,
8128                       "anchored utf8 %s%s at %"IVdf" ",
8129                       s, RE_SV_TAIL(r->anchored_utf8),
8130                       (IV)r->anchored_offset);
8131     }                 
8132     if (r->float_substr) {
8133         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
8134             RE_SV_DUMPLEN(r->float_substr), 30);
8135         PerlIO_printf(Perl_debug_log,
8136                       "floating %s%s at %"IVdf"..%"UVuf" ",
8137                       s, RE_SV_TAIL(r->float_substr),
8138                       (IV)r->float_min_offset, (UV)r->float_max_offset);
8139     } else if (r->float_utf8) {
8140         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
8141             RE_SV_DUMPLEN(r->float_utf8), 30);
8142         PerlIO_printf(Perl_debug_log,
8143                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
8144                       s, RE_SV_TAIL(r->float_utf8),
8145                       (IV)r->float_min_offset, (UV)r->float_max_offset);
8146     }
8147     if (r->check_substr || r->check_utf8)
8148         PerlIO_printf(Perl_debug_log,
8149                       (const char *)
8150                       (r->check_substr == r->float_substr
8151                        && r->check_utf8 == r->float_utf8
8152                        ? "(checking floating" : "(checking anchored"));
8153     if (r->extflags & RXf_NOSCAN)
8154         PerlIO_printf(Perl_debug_log, " noscan");
8155     if (r->extflags & RXf_CHECK_ALL)
8156         PerlIO_printf(Perl_debug_log, " isall");
8157     if (r->check_substr || r->check_utf8)
8158         PerlIO_printf(Perl_debug_log, ") ");
8159
8160     if (ri->regstclass) {
8161         regprop(r, sv, ri->regstclass);
8162         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
8163     }
8164     if (r->extflags & RXf_ANCH) {
8165         PerlIO_printf(Perl_debug_log, "anchored");
8166         if (r->extflags & RXf_ANCH_BOL)
8167             PerlIO_printf(Perl_debug_log, "(BOL)");
8168         if (r->extflags & RXf_ANCH_MBOL)
8169             PerlIO_printf(Perl_debug_log, "(MBOL)");
8170         if (r->extflags & RXf_ANCH_SBOL)
8171             PerlIO_printf(Perl_debug_log, "(SBOL)");
8172         if (r->extflags & RXf_ANCH_GPOS)
8173             PerlIO_printf(Perl_debug_log, "(GPOS)");
8174         PerlIO_putc(Perl_debug_log, ' ');
8175     }
8176     if (r->extflags & RXf_GPOS_SEEN)
8177         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
8178     if (r->intflags & PREGf_SKIP)
8179         PerlIO_printf(Perl_debug_log, "plus ");
8180     if (r->intflags & PREGf_IMPLICIT)
8181         PerlIO_printf(Perl_debug_log, "implicit ");
8182     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
8183     if (r->extflags & RXf_EVAL_SEEN)
8184         PerlIO_printf(Perl_debug_log, "with eval ");
8185     PerlIO_printf(Perl_debug_log, "\n");
8186 #else
8187     PERL_UNUSED_CONTEXT;
8188     PERL_UNUSED_ARG(r);
8189 #endif  /* DEBUGGING */
8190 }
8191
8192 /*
8193 - regprop - printable representation of opcode
8194 */
8195 void
8196 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
8197 {
8198 #ifdef DEBUGGING
8199     dVAR;
8200     register int k;
8201     RXi_GET_DECL(prog,progi);
8202     GET_RE_DEBUG_FLAGS_DECL;
8203     
8204
8205     sv_setpvn(sv, "", 0);
8206
8207     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
8208         /* It would be nice to FAIL() here, but this may be called from
8209            regexec.c, and it would be hard to supply pRExC_state. */
8210         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
8211     sv_catpv(sv, reg_name[OP(o)]); /* Take off const! */
8212
8213     k = PL_regkind[OP(o)];
8214
8215     if (k == EXACT) {
8216         SV * const dsv = sv_2mortal(newSVpvs(""));
8217         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
8218          * is a crude hack but it may be the best for now since 
8219          * we have no flag "this EXACTish node was UTF-8" 
8220          * --jhi */
8221         const char * const s = 
8222             pv_pretty(dsv, STRING(o), STR_LEN(o), 60, 
8223                 PL_colors[0], PL_colors[1],
8224                 PERL_PV_ESCAPE_UNI_DETECT |
8225                 PERL_PV_PRETTY_ELIPSES    |
8226                 PERL_PV_PRETTY_LTGT    
8227             ); 
8228         Perl_sv_catpvf(aTHX_ sv, " %s", s );
8229     } else if (k == TRIE) {
8230         /* print the details of the trie in dumpuntil instead, as
8231          * progi->data isn't available here */
8232         const char op = OP(o);
8233         const I32 n = ARG(o);
8234         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
8235                (reg_ac_data *)progi->data->data[n] :
8236                NULL;
8237         const reg_trie_data * const trie
8238             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
8239         
8240         Perl_sv_catpvf(aTHX_ sv, "-%s",reg_name[o->flags]);
8241         DEBUG_TRIE_COMPILE_r(
8242             Perl_sv_catpvf(aTHX_ sv,
8243                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
8244                 (UV)trie->startstate,
8245                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
8246                 (UV)trie->wordcount,
8247                 (UV)trie->minlen,
8248                 (UV)trie->maxlen,
8249                 (UV)TRIE_CHARCOUNT(trie),
8250                 (UV)trie->uniquecharcount
8251             )
8252         );
8253         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
8254             int i;
8255             int rangestart = -1;
8256             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
8257             Perl_sv_catpvf(aTHX_ sv, "[");
8258             for (i = 0; i <= 256; i++) {
8259                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
8260                     if (rangestart == -1)
8261                         rangestart = i;
8262                 } else if (rangestart != -1) {
8263                     if (i <= rangestart + 3)
8264                         for (; rangestart < i; rangestart++)
8265                             put_byte(sv, rangestart);
8266                     else {
8267                         put_byte(sv, rangestart);
8268                         sv_catpvs(sv, "-");
8269                         put_byte(sv, i - 1);
8270                     }
8271                     rangestart = -1;
8272                 }
8273             }
8274             Perl_sv_catpvf(aTHX_ sv, "]");
8275         } 
8276          
8277     } else if (k == CURLY) {
8278         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
8279             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
8280         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
8281     }
8282     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
8283         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
8284     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) 
8285         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
8286     else if (k == GOSUB) 
8287         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
8288     else if (k == VERB) {
8289         if (!o->flags) 
8290             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
8291                 (SV*)progi->data->data[ ARG( o ) ]);
8292     } else if (k == LOGICAL)
8293         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
8294     else if (k == ANYOF) {
8295         int i, rangestart = -1;
8296         const U8 flags = ANYOF_FLAGS(o);
8297
8298         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
8299         static const char * const anyofs[] = {
8300             "\\w",
8301             "\\W",
8302             "\\s",
8303             "\\S",
8304             "\\d",
8305             "\\D",
8306             "[:alnum:]",
8307             "[:^alnum:]",
8308             "[:alpha:]",
8309             "[:^alpha:]",
8310             "[:ascii:]",
8311             "[:^ascii:]",
8312             "[:ctrl:]",
8313             "[:^ctrl:]",
8314             "[:graph:]",
8315             "[:^graph:]",
8316             "[:lower:]",
8317             "[:^lower:]",
8318             "[:print:]",
8319             "[:^print:]",
8320             "[:punct:]",
8321             "[:^punct:]",
8322             "[:upper:]",
8323             "[:^upper:]",
8324             "[:xdigit:]",
8325             "[:^xdigit:]",
8326             "[:space:]",
8327             "[:^space:]",
8328             "[:blank:]",
8329             "[:^blank:]"
8330         };
8331
8332         if (flags & ANYOF_LOCALE)
8333             sv_catpvs(sv, "{loc}");
8334         if (flags & ANYOF_FOLD)
8335             sv_catpvs(sv, "{i}");
8336         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
8337         if (flags & ANYOF_INVERT)
8338             sv_catpvs(sv, "^");
8339         for (i = 0; i <= 256; i++) {
8340             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
8341                 if (rangestart == -1)
8342                     rangestart = i;
8343             } else if (rangestart != -1) {
8344                 if (i <= rangestart + 3)
8345                     for (; rangestart < i; rangestart++)
8346                         put_byte(sv, rangestart);
8347                 else {
8348                     put_byte(sv, rangestart);
8349                     sv_catpvs(sv, "-");
8350                     put_byte(sv, i - 1);
8351                 }
8352                 rangestart = -1;
8353             }
8354         }
8355
8356         if (o->flags & ANYOF_CLASS)
8357             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
8358                 if (ANYOF_CLASS_TEST(o,i))
8359                     sv_catpv(sv, anyofs[i]);
8360
8361         if (flags & ANYOF_UNICODE)
8362             sv_catpvs(sv, "{unicode}");
8363         else if (flags & ANYOF_UNICODE_ALL)
8364             sv_catpvs(sv, "{unicode_all}");
8365
8366         {
8367             SV *lv;
8368             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
8369         
8370             if (lv) {
8371                 if (sw) {
8372                     U8 s[UTF8_MAXBYTES_CASE+1];
8373                 
8374                     for (i = 0; i <= 256; i++) { /* just the first 256 */
8375                         uvchr_to_utf8(s, i);
8376                         
8377                         if (i < 256 && swash_fetch(sw, s, TRUE)) {
8378                             if (rangestart == -1)
8379                                 rangestart = i;
8380                         } else if (rangestart != -1) {
8381                             if (i <= rangestart + 3)
8382                                 for (; rangestart < i; rangestart++) {
8383                                     const U8 * const e = uvchr_to_utf8(s,rangestart);
8384                                     U8 *p;
8385                                     for(p = s; p < e; p++)
8386                                         put_byte(sv, *p);
8387                                 }
8388                             else {
8389                                 const U8 *e = uvchr_to_utf8(s,rangestart);
8390                                 U8 *p;
8391                                 for (p = s; p < e; p++)
8392                                     put_byte(sv, *p);
8393                                 sv_catpvs(sv, "-");
8394                                 e = uvchr_to_utf8(s, i-1);
8395                                 for (p = s; p < e; p++)
8396                                     put_byte(sv, *p);
8397                                 }
8398                                 rangestart = -1;
8399                             }
8400                         }
8401                         
8402                     sv_catpvs(sv, "..."); /* et cetera */
8403                 }
8404
8405                 {
8406                     char *s = savesvpv(lv);
8407                     char * const origs = s;
8408                 
8409                     while (*s && *s != '\n')
8410                         s++;
8411                 
8412                     if (*s == '\n') {
8413                         const char * const t = ++s;
8414                         
8415                         while (*s) {
8416                             if (*s == '\n')
8417                                 *s = ' ';
8418                             s++;
8419                         }
8420                         if (s[-1] == ' ')
8421                             s[-1] = 0;
8422                         
8423                         sv_catpv(sv, t);
8424                     }
8425                 
8426                     Safefree(origs);
8427                 }
8428             }
8429         }
8430
8431         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
8432     }
8433     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
8434         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
8435 #else
8436     PERL_UNUSED_CONTEXT;
8437     PERL_UNUSED_ARG(sv);
8438     PERL_UNUSED_ARG(o);
8439     PERL_UNUSED_ARG(prog);
8440 #endif  /* DEBUGGING */
8441 }
8442
8443 SV *
8444 Perl_re_intuit_string(pTHX_ regexp *prog)
8445 {                               /* Assume that RE_INTUIT is set */
8446     dVAR;
8447     GET_RE_DEBUG_FLAGS_DECL;
8448     PERL_UNUSED_CONTEXT;
8449
8450     DEBUG_COMPILE_r(
8451         {
8452             const char * const s = SvPV_nolen_const(prog->check_substr
8453                       ? prog->check_substr : prog->check_utf8);
8454
8455             if (!PL_colorset) reginitcolors();
8456             PerlIO_printf(Perl_debug_log,
8457                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
8458                       PL_colors[4],
8459                       prog->check_substr ? "" : "utf8 ",
8460                       PL_colors[5],PL_colors[0],
8461                       s,
8462                       PL_colors[1],
8463                       (strlen(s) > 60 ? "..." : ""));
8464         } );
8465
8466     return prog->check_substr ? prog->check_substr : prog->check_utf8;
8467 }
8468
8469 /* 
8470    pregfree() 
8471    
8472    handles refcounting and freeing the perl core regexp structure. When 
8473    it is necessary to actually free the structure the first thing it 
8474    does is call the 'free' method of the regexp_engine associated to to 
8475    the regexp, allowing the handling of the void *pprivate; member 
8476    first. (This routine is not overridable by extensions, which is why 
8477    the extensions free is called first.)
8478    
8479    See regdupe and regdupe_internal if you change anything here. 
8480 */
8481 #ifndef PERL_IN_XSUB_RE
8482 void
8483 Perl_pregfree(pTHX_ struct regexp *r)
8484 {
8485     dVAR;
8486     GET_RE_DEBUG_FLAGS_DECL;
8487
8488     if (!r || (--r->refcnt > 0))
8489         return;
8490         
8491     CALLREGFREE_PVT(r); /* free the private data */
8492     
8493     /* gcov results gave these as non-null 100% of the time, so there's no
8494        optimisation in checking them before calling Safefree  */
8495     Safefree(r->precomp);
8496     RX_MATCH_COPY_FREE(r);
8497 #ifdef PERL_OLD_COPY_ON_WRITE
8498     if (r->saved_copy)
8499         SvREFCNT_dec(r->saved_copy);
8500 #endif
8501     if (r->substrs) {
8502         if (r->anchored_substr)
8503             SvREFCNT_dec(r->anchored_substr);
8504         if (r->anchored_utf8)
8505             SvREFCNT_dec(r->anchored_utf8);
8506         if (r->float_substr)
8507             SvREFCNT_dec(r->float_substr);
8508         if (r->float_utf8)
8509             SvREFCNT_dec(r->float_utf8);
8510         Safefree(r->substrs);
8511     }
8512     if (r->paren_names)
8513             SvREFCNT_dec(r->paren_names);
8514     
8515     Safefree(r->startp);
8516     Safefree(r->endp);
8517     Safefree(r);
8518 }
8519 #endif
8520
8521 /* regfree_internal() 
8522
8523    Free the private data in a regexp. This is overloadable by 
8524    extensions. Perl takes care of the regexp structure in pregfree(), 
8525    this covers the *pprivate pointer which technically perldoesnt 
8526    know about, however of course we have to handle the 
8527    regexp_internal structure when no extension is in use. 
8528    
8529    Note this is called before freeing anything in the regexp 
8530    structure. 
8531  */
8532  
8533 void
8534 Perl_regfree_internal(pTHX_ struct regexp *r)
8535 {
8536     dVAR;
8537     RXi_GET_DECL(r,ri);
8538     GET_RE_DEBUG_FLAGS_DECL;
8539     
8540     DEBUG_COMPILE_r({
8541         if (!PL_colorset)
8542             reginitcolors();
8543         {
8544             SV *dsv= sv_newmortal();
8545             RE_PV_QUOTED_DECL(s, (r->extflags & RXf_UTF8),
8546                 dsv, r->precomp, r->prelen, 60);
8547             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
8548                 PL_colors[4],PL_colors[5],s);
8549         }
8550     });
8551
8552     Safefree(ri->offsets);             /* 20010421 MJD */
8553     if (ri->data) {
8554         int n = ri->data->count;
8555         PAD* new_comppad = NULL;
8556         PAD* old_comppad;
8557         PADOFFSET refcnt;
8558
8559         while (--n >= 0) {
8560           /* If you add a ->what type here, update the comment in regcomp.h */
8561             switch (ri->data->what[n]) {
8562             case 's':
8563             case 'S':
8564             case 'u':
8565                 SvREFCNT_dec((SV*)ri->data->data[n]);
8566                 break;
8567             case 'f':
8568                 Safefree(ri->data->data[n]);
8569                 break;
8570             case 'p':
8571                 new_comppad = (AV*)ri->data->data[n];
8572                 break;
8573             case 'o':
8574                 if (new_comppad == NULL)
8575                     Perl_croak(aTHX_ "panic: pregfree comppad");
8576                 PAD_SAVE_LOCAL(old_comppad,
8577                     /* Watch out for global destruction's random ordering. */
8578                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
8579                 );
8580                 OP_REFCNT_LOCK;
8581                 refcnt = OpREFCNT_dec((OP_4tree*)ri->data->data[n]);
8582                 OP_REFCNT_UNLOCK;
8583                 if (!refcnt)
8584                     op_free((OP_4tree*)ri->data->data[n]);
8585
8586                 PAD_RESTORE_LOCAL(old_comppad);
8587                 SvREFCNT_dec((SV*)new_comppad);
8588                 new_comppad = NULL;
8589                 break;
8590             case 'n':
8591                 break;
8592             case 'T':           
8593                 { /* Aho Corasick add-on structure for a trie node.
8594                      Used in stclass optimization only */
8595                     U32 refcount;
8596                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
8597                     OP_REFCNT_LOCK;
8598                     refcount = --aho->refcount;
8599                     OP_REFCNT_UNLOCK;
8600                     if ( !refcount ) {
8601                         PerlMemShared_free(aho->states);
8602                         PerlMemShared_free(aho->fail);
8603                          /* do this last!!!! */
8604                         PerlMemShared_free(ri->data->data[n]);
8605                         PerlMemShared_free(ri->regstclass);
8606                     }
8607                 }
8608                 break;
8609             case 't':
8610                 {
8611                     /* trie structure. */
8612                     U32 refcount;
8613                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
8614                     OP_REFCNT_LOCK;
8615                     refcount = --trie->refcount;
8616                     OP_REFCNT_UNLOCK;
8617                     if ( !refcount ) {
8618                         PerlMemShared_free(trie->charmap);
8619                         PerlMemShared_free(trie->states);
8620                         PerlMemShared_free(trie->trans);
8621                         if (trie->bitmap)
8622                             PerlMemShared_free(trie->bitmap);
8623                         if (trie->wordlen)
8624                             PerlMemShared_free(trie->wordlen);
8625                         if (trie->jump)
8626                             PerlMemShared_free(trie->jump);
8627                         if (trie->nextword)
8628                             PerlMemShared_free(trie->nextword);
8629                         /* do this last!!!! */
8630                         PerlMemShared_free(ri->data->data[n]);
8631                     }
8632                 }
8633                 break;
8634             default:
8635                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
8636             }
8637         }
8638         Safefree(ri->data->what);
8639         Safefree(ri->data);
8640     }
8641     if (ri->swap) {
8642         Safefree(ri->swap->startp);
8643         Safefree(ri->swap->endp);
8644         Safefree(ri->swap);
8645     }
8646     Safefree(ri);
8647 }
8648
8649 #define sv_dup_inc(s,t) SvREFCNT_inc(sv_dup(s,t))
8650 #define av_dup_inc(s,t) (AV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8651 #define hv_dup_inc(s,t) (HV*)SvREFCNT_inc(sv_dup((SV*)s,t))
8652 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
8653
8654 /* 
8655    regdupe - duplicate a regexp. 
8656    
8657    This routine is called by sv.c's re_dup and is expected to clone a 
8658    given regexp structure. It is a no-op when not under USE_ITHREADS. 
8659    (Originally this *was* re_dup() for change history see sv.c)
8660    
8661    After all of the core data stored in struct regexp is duplicated
8662    the regexp_engine.dupe method is used to copy any private data
8663    stored in the *pprivate pointer. This allows extensions to handle
8664    any duplication it needs to do.
8665
8666    See pregfree() and regfree_internal() if you change anything here. 
8667 */
8668 #if defined(USE_ITHREADS)
8669 #ifndef PERL_IN_XSUB_RE
8670 regexp *
8671 Perl_re_dup(pTHX_ const regexp *r, CLONE_PARAMS *param)
8672 {
8673     dVAR;
8674     regexp *ret;
8675     int i, npar;
8676     struct reg_substr_datum *s;
8677
8678     if (!r)
8679         return (REGEXP *)NULL;
8680
8681     if ((ret = (REGEXP *)ptr_table_fetch(PL_ptr_table, r)))
8682         return ret;
8683
8684     
8685     npar = r->nparens+1;
8686     Newxz(ret, 1, regexp);
8687     Newx(ret->startp, npar, I32);
8688     Copy(r->startp, ret->startp, npar, I32);
8689     Newx(ret->endp, npar, I32);
8690     Copy(r->endp, ret->endp, npar, I32);
8691
8692     Newx(ret->substrs, 1, struct reg_substr_data);
8693     for (s = ret->substrs->data, i = 0; i < 3; i++, s++) {
8694         s->min_offset = r->substrs->data[i].min_offset;
8695         s->max_offset = r->substrs->data[i].max_offset;
8696         s->end_shift  = r->substrs->data[i].end_shift;
8697         s->substr     = sv_dup_inc(r->substrs->data[i].substr, param);
8698         s->utf8_substr = sv_dup_inc(r->substrs->data[i].utf8_substr, param);
8699     }
8700     
8701
8702     ret->precomp        = SAVEPVN(r->precomp, r->prelen);
8703     ret->refcnt         = r->refcnt;
8704     ret->minlen         = r->minlen;
8705     ret->minlenret      = r->minlenret;
8706     ret->prelen         = r->prelen;
8707     ret->nparens        = r->nparens;
8708     ret->lastparen      = r->lastparen;
8709     ret->lastcloseparen = r->lastcloseparen;
8710     ret->intflags       = r->intflags;
8711     ret->extflags       = r->extflags;
8712
8713     ret->sublen         = r->sublen;
8714
8715     ret->engine         = r->engine;
8716     
8717     ret->paren_names    = hv_dup_inc(r->paren_names, param);
8718
8719     if (RX_MATCH_COPIED(ret))
8720         ret->subbeg  = SAVEPVN(r->subbeg, r->sublen);
8721     else
8722         ret->subbeg = NULL;
8723 #ifdef PERL_OLD_COPY_ON_WRITE
8724     ret->saved_copy = NULL;
8725 #endif
8726     
8727     ret->pprivate = r->pprivate;
8728     RXi_SET(ret,CALLREGDUPE_PVT(ret,param));
8729     
8730     ptr_table_store(PL_ptr_table, r, ret);
8731     return ret;
8732 }
8733 #endif /* PERL_IN_XSUB_RE */
8734
8735 /*
8736    regdupe_internal()
8737    
8738    This is the internal complement to regdupe() which is used to copy
8739    the structure pointed to by the *pprivate pointer in the regexp.
8740    This is the core version of the extension overridable cloning hook.
8741    The regexp structure being duplicated will be copied by perl prior
8742    to this and will be provided as the regexp *r argument, however 
8743    with the /old/ structures pprivate pointer value. Thus this routine
8744    may override any copying normally done by perl.
8745    
8746    It returns a pointer to the new regexp_internal structure.
8747 */
8748
8749 void *
8750 Perl_regdupe_internal(pTHX_ const regexp *r, CLONE_PARAMS *param)
8751 {
8752     dVAR;
8753     regexp_internal *reti;
8754     int len, npar;
8755     RXi_GET_DECL(r,ri);
8756     
8757     npar = r->nparens+1;
8758     len = ri->offsets[0];
8759     
8760     Newxc(reti, sizeof(regexp_internal) + (len+1)*sizeof(regnode), char, regexp_internal);
8761     Copy(ri->program, reti->program, len+1, regnode);
8762     
8763     if(ri->swap) {
8764         Newx(reti->swap, 1, regexp_paren_ofs);
8765         /* no need to copy these */
8766         Newx(reti->swap->startp, npar, I32);
8767         Newx(reti->swap->endp, npar, I32);
8768     } else {
8769         reti->swap = NULL;
8770     }
8771
8772
8773     reti->regstclass = NULL;
8774     if (ri->data) {
8775         struct reg_data *d;
8776         const int count = ri->data->count;
8777         int i;
8778
8779         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
8780                 char, struct reg_data);
8781         Newx(d->what, count, U8);
8782
8783         d->count = count;
8784         for (i = 0; i < count; i++) {
8785             d->what[i] = ri->data->what[i];
8786             switch (d->what[i]) {
8787                 /* legal options are one of: sSfpontTu
8788                    see also regcomp.h and pregfree() */
8789             case 's':
8790             case 'S':
8791             case 'p': /* actually an AV, but the dup function is identical.  */
8792             case 'u': /* actually an HV, but the dup function is identical.  */
8793                 d->data[i] = sv_dup_inc((SV *)ri->data->data[i], param);
8794                 break;
8795             case 'f':
8796                 /* This is cheating. */
8797                 Newx(d->data[i], 1, struct regnode_charclass_class);
8798                 StructCopy(ri->data->data[i], d->data[i],
8799                             struct regnode_charclass_class);
8800                 reti->regstclass = (regnode*)d->data[i];
8801                 break;
8802             case 'o':
8803                 /* Compiled op trees are readonly and in shared memory,
8804                    and can thus be shared without duplication. */
8805                 OP_REFCNT_LOCK;
8806                 d->data[i] = (void*)OpREFCNT_inc((OP*)ri->data->data[i]);
8807                 OP_REFCNT_UNLOCK;
8808                 break;
8809             case 'T':
8810                 /* Trie stclasses are readonly and can thus be shared
8811                  * without duplication. We free the stclass in pregfree
8812                  * when the corresponding reg_ac_data struct is freed.
8813                  */
8814                 reti->regstclass= ri->regstclass;
8815                 /* Fall through */
8816             case 't':
8817                 OP_REFCNT_LOCK;
8818                 ((reg_trie_data*)ri->data->data[i])->refcount++;
8819                 OP_REFCNT_UNLOCK;
8820                 /* Fall through */
8821             case 'n':
8822                 d->data[i] = ri->data->data[i];
8823                 break;
8824             default:
8825                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
8826             }
8827         }
8828
8829         reti->data = d;
8830     }
8831     else
8832         reti->data = NULL;
8833
8834     Newx(reti->offsets, 2*len+1, U32);
8835     Copy(ri->offsets, reti->offsets, 2*len+1, U32);
8836     
8837     return (void*)reti;
8838 }
8839
8840 #endif    /* USE_ITHREADS */
8841
8842 /* 
8843    reg_stringify() 
8844    
8845    converts a regexp embedded in a MAGIC struct to its stringified form, 
8846    caching the converted form in the struct and returns the cached 
8847    string. 
8848
8849    If lp is nonnull then it is used to return the length of the 
8850    resulting string
8851    
8852    If flags is nonnull and the returned string contains UTF8 then 
8853    (*flags & 1) will be true.
8854    
8855    If haseval is nonnull then it is used to return whether the pattern 
8856    contains evals.
8857    
8858    Normally called via macro: 
8859    
8860         CALLREG_STRINGIFY(mg,&len,&utf8);
8861         
8862    And internally with
8863    
8864         CALLREG_AS_STR(mg,&lp,&flags,&haseval)        
8865     
8866    See sv_2pv_flags() in sv.c for an example of internal usage.
8867     
8868  */
8869 #ifndef PERL_IN_XSUB_RE
8870 char *
8871 Perl_reg_stringify(pTHX_ MAGIC *mg, STRLEN *lp, U32 *flags, I32 *haseval ) {
8872     dVAR;
8873     const regexp * const re = (regexp *)mg->mg_obj;
8874
8875     if (!mg->mg_ptr) {
8876         const char *fptr = "msix";
8877         char reflags[6];
8878         char ch;
8879         int left = 0;
8880         int right = 4;
8881         bool need_newline = 0;
8882         U16 reganch = (U16)((re->extflags & RXf_PMf_COMPILETIME) >> 12);
8883
8884         while((ch = *fptr++)) {
8885             if(reganch & 1) {
8886                 reflags[left++] = ch;
8887             }
8888             else {
8889                 reflags[right--] = ch;
8890             }
8891             reganch >>= 1;
8892         }
8893         if(left != 4) {
8894             reflags[left] = '-';
8895             left = 5;
8896         }
8897
8898         mg->mg_len = re->prelen + 4 + left;
8899         /*
8900          * If /x was used, we have to worry about a regex ending with a
8901          * comment later being embedded within another regex. If so, we don't
8902          * want this regex's "commentization" to leak out to the right part of
8903          * the enclosing regex, we must cap it with a newline.
8904          *
8905          * So, if /x was used, we scan backwards from the end of the regex. If
8906          * we find a '#' before we find a newline, we need to add a newline
8907          * ourself. If we find a '\n' first (or if we don't find '#' or '\n'),
8908          * we don't need to add anything.  -jfriedl
8909          */
8910         if (PMf_EXTENDED & re->extflags) {
8911             const char *endptr = re->precomp + re->prelen;
8912             while (endptr >= re->precomp) {
8913                 const char c = *(endptr--);
8914                 if (c == '\n')
8915                     break; /* don't need another */
8916                 if (c == '#') {
8917                     /* we end while in a comment, so we need a newline */
8918                     mg->mg_len++; /* save space for it */
8919                     need_newline = 1; /* note to add it */
8920                     break;
8921                 }
8922             }
8923         }
8924
8925         Newx(mg->mg_ptr, mg->mg_len + 1 + left, char);
8926         mg->mg_ptr[0] = '(';
8927         mg->mg_ptr[1] = '?';
8928         Copy(reflags, mg->mg_ptr+2, left, char);
8929         *(mg->mg_ptr+left+2) = ':';
8930         Copy(re->precomp, mg->mg_ptr+3+left, re->prelen, char);
8931         if (need_newline)
8932             mg->mg_ptr[mg->mg_len - 2] = '\n';
8933         mg->mg_ptr[mg->mg_len - 1] = ')';
8934         mg->mg_ptr[mg->mg_len] = 0;
8935     }
8936     if (haseval) 
8937         *haseval = re->seen_evals;
8938     if (flags)    
8939         *flags = ((re->extflags & RXf_UTF8) ? 1 : 0);
8940     
8941     if (lp)
8942         *lp = mg->mg_len;
8943     return mg->mg_ptr;
8944 }
8945
8946 /*
8947  - regnext - dig the "next" pointer out of a node
8948  */
8949 regnode *
8950 Perl_regnext(pTHX_ register regnode *p)
8951 {
8952     dVAR;
8953     register I32 offset;
8954
8955     if (!p)
8956         return(NULL);
8957
8958     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
8959     if (offset == 0)
8960         return(NULL);
8961
8962     return(p+offset);
8963 }
8964 #endif
8965
8966 STATIC void     
8967 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
8968 {
8969     va_list args;
8970     STRLEN l1 = strlen(pat1);
8971     STRLEN l2 = strlen(pat2);
8972     char buf[512];
8973     SV *msv;
8974     const char *message;
8975
8976     if (l1 > 510)
8977         l1 = 510;
8978     if (l1 + l2 > 510)
8979         l2 = 510 - l1;
8980     Copy(pat1, buf, l1 , char);
8981     Copy(pat2, buf + l1, l2 , char);
8982     buf[l1 + l2] = '\n';
8983     buf[l1 + l2 + 1] = '\0';
8984 #ifdef I_STDARG
8985     /* ANSI variant takes additional second argument */
8986     va_start(args, pat2);
8987 #else
8988     va_start(args);
8989 #endif
8990     msv = vmess(buf, &args);
8991     va_end(args);
8992     message = SvPV_const(msv,l1);
8993     if (l1 > 512)
8994         l1 = 512;
8995     Copy(message, buf, l1 , char);
8996     buf[l1-1] = '\0';                   /* Overwrite \n */
8997     Perl_croak(aTHX_ "%s", buf);
8998 }
8999
9000 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
9001
9002 #ifndef PERL_IN_XSUB_RE
9003 void
9004 Perl_save_re_context(pTHX)
9005 {
9006     dVAR;
9007
9008     struct re_save_state *state;
9009
9010     SAVEVPTR(PL_curcop);
9011     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
9012
9013     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
9014     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
9015     SSPUSHINT(SAVEt_RE_STATE);
9016
9017     Copy(&PL_reg_state, state, 1, struct re_save_state);
9018
9019     PL_reg_start_tmp = 0;
9020     PL_reg_start_tmpl = 0;
9021     PL_reg_oldsaved = NULL;
9022     PL_reg_oldsavedlen = 0;
9023     PL_reg_maxiter = 0;
9024     PL_reg_leftiter = 0;
9025     PL_reg_poscache = NULL;
9026     PL_reg_poscache_size = 0;
9027 #ifdef PERL_OLD_COPY_ON_WRITE
9028     PL_nrs = NULL;
9029 #endif
9030
9031     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
9032     if (PL_curpm) {
9033         const REGEXP * const rx = PM_GETRE(PL_curpm);
9034         if (rx) {
9035             U32 i;
9036             for (i = 1; i <= rx->nparens; i++) {
9037                 char digits[TYPE_CHARS(long)];
9038                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
9039                 GV *const *const gvp
9040                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
9041
9042                 if (gvp) {
9043                     GV * const gv = *gvp;
9044                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
9045                         save_scalar(gv);
9046                 }
9047             }
9048         }
9049     }
9050 }
9051 #endif
9052
9053 static void
9054 clear_re(pTHX_ void *r)
9055 {
9056     dVAR;
9057     ReREFCNT_dec((regexp *)r);
9058 }
9059
9060 #ifdef DEBUGGING
9061
9062 STATIC void
9063 S_put_byte(pTHX_ SV *sv, int c)
9064 {
9065     if (isCNTRL(c) || c == 255 || !isPRINT(c))
9066         Perl_sv_catpvf(aTHX_ sv, "\\%o", c);
9067     else if (c == '-' || c == ']' || c == '\\' || c == '^')
9068         Perl_sv_catpvf(aTHX_ sv, "\\%c", c);
9069     else
9070         Perl_sv_catpvf(aTHX_ sv, "%c", c);
9071 }
9072
9073
9074 #define CLEAR_OPTSTART \
9075     if (optstart) STMT_START { \
9076             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
9077             optstart=NULL; \
9078     } STMT_END
9079
9080 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
9081
9082 STATIC const regnode *
9083 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
9084             const regnode *last, const regnode *plast, 
9085             SV* sv, I32 indent, U32 depth)
9086 {
9087     dVAR;
9088     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
9089     register const regnode *next;
9090     const regnode *optstart= NULL;
9091     RXi_GET_DECL(r,ri);
9092     GET_RE_DEBUG_FLAGS_DECL;
9093
9094 #ifdef DEBUG_DUMPUNTIL
9095     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
9096         last ? last-start : 0,plast ? plast-start : 0);
9097 #endif
9098             
9099     if (plast && plast < last) 
9100         last= plast;
9101
9102     while (PL_regkind[op] != END && (!last || node < last)) {
9103         /* While that wasn't END last time... */
9104
9105         NODE_ALIGN(node);
9106         op = OP(node);
9107         if (op == CLOSE || op == WHILEM)
9108             indent--;
9109         next = regnext((regnode *)node);
9110         
9111         /* Where, what. */
9112         if (OP(node) == OPTIMIZED) {
9113             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
9114                 optstart = node;
9115             else
9116                 goto after_print;
9117         } else
9118             CLEAR_OPTSTART;
9119             
9120         regprop(r, sv, node);
9121         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
9122                       (int)(2*indent + 1), "", SvPVX_const(sv));
9123
9124         if (OP(node) != OPTIMIZED) {
9125             if (next == NULL)           /* Next ptr. */
9126                 PerlIO_printf(Perl_debug_log, "(0)");
9127             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
9128                 PerlIO_printf(Perl_debug_log, "(FAIL)");
9129             else
9130                 PerlIO_printf(Perl_debug_log, "(%"IVdf")", (IV)(next - start));
9131                 
9132             /*if (PL_regkind[(U8)op]  != TRIE)*/
9133                 (void)PerlIO_putc(Perl_debug_log, '\n');
9134         }
9135
9136       after_print:
9137         if (PL_regkind[(U8)op] == BRANCHJ) {
9138             assert(next);
9139             {
9140                 register const regnode *nnode = (OP(next) == LONGJMP
9141                                              ? regnext((regnode *)next)
9142                                              : next);
9143                 if (last && nnode > last)
9144                     nnode = last;
9145                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
9146             }
9147         }
9148         else if (PL_regkind[(U8)op] == BRANCH) {
9149             assert(next);
9150             DUMPUNTIL(NEXTOPER(node), next);
9151         }
9152         else if ( PL_regkind[(U8)op]  == TRIE ) {
9153             const regnode *this_trie = node;
9154             const char op = OP(node);
9155             const I32 n = ARG(node);
9156             const reg_ac_data * const ac = op>=AHOCORASICK ?
9157                (reg_ac_data *)ri->data->data[n] :
9158                NULL;
9159             const reg_trie_data * const trie =
9160                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
9161 #ifdef DEBUGGING
9162             AV *const trie_words = (AV *) ri->data->data[n + TRIE_WORDS_OFFSET];
9163 #endif
9164             const regnode *nextbranch= NULL;
9165             I32 word_idx;
9166             sv_setpvn(sv, "", 0);
9167             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
9168                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
9169                 
9170                 PerlIO_printf(Perl_debug_log, "%*s%s ",
9171                    (int)(2*(indent+3)), "",
9172                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
9173                             PL_colors[0], PL_colors[1],
9174                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
9175                             PERL_PV_PRETTY_ELIPSES    |
9176                             PERL_PV_PRETTY_LTGT
9177                             )
9178                             : "???"
9179                 );
9180                 if (trie->jump) {
9181                     U16 dist= trie->jump[word_idx+1];
9182                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
9183                                   (UV)((dist ? this_trie + dist : next) - start));
9184                     if (dist) {
9185                         if (!nextbranch)
9186                             nextbranch= this_trie + trie->jump[0];    
9187                         DUMPUNTIL(this_trie + dist, nextbranch);
9188                     }
9189                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
9190                         nextbranch= regnext((regnode *)nextbranch);
9191                 } else {
9192                     PerlIO_printf(Perl_debug_log, "\n");
9193                 }
9194             }
9195             if (last && next > last)
9196                 node= last;
9197             else
9198                 node= next;
9199         }
9200         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
9201             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
9202                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
9203         }
9204         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
9205             assert(next);
9206             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
9207         }
9208         else if ( op == PLUS || op == STAR) {
9209             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
9210         }
9211         else if (op == ANYOF) {
9212             /* arglen 1 + class block */
9213             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_LARGE)
9214                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
9215             node = NEXTOPER(node);
9216         }
9217         else if (PL_regkind[(U8)op] == EXACT) {
9218             /* Literal string, where present. */
9219             node += NODE_SZ_STR(node) - 1;
9220             node = NEXTOPER(node);
9221         }
9222         else {
9223             node = NEXTOPER(node);
9224             node += regarglen[(U8)op];
9225         }
9226         if (op == CURLYX || op == OPEN)
9227             indent++;
9228     }
9229     CLEAR_OPTSTART;
9230 #ifdef DEBUG_DUMPUNTIL    
9231     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
9232 #endif
9233     return node;
9234 }
9235
9236 #endif  /* DEBUGGING */
9237
9238 /*
9239  * Local variables:
9240  * c-indentation-style: bsd
9241  * c-basic-offset: 4
9242  * indent-tabs-mode: t
9243  * End:
9244  *
9245  * ex: set ts=8 sts=4 sw=4 noet:
9246  */