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