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