]> git.vpit.fr Git - perl/modules/re-engine-Hooks.git/blob - src/5015001/regcomp.c
Fix infinite recursion with perl 5.17.[12]
[perl/modules/re-engine-Hooks.git] / src / 5015001 / regcomp.c
1 /*    regcomp.c
2  */
3
4 /*
5  * 'A fair jaw-cracker dwarf-language must be.'            --Samwise Gamgee
6  *
7  *     [p.285 of _The Lord of the Rings_, II/iii: "The Ring Goes South"]
8  */
9
10 /* This file contains functions for compiling a regular expression.  See
11  * also regexec.c which funnily enough, contains functions for executing
12  * a regular expression.
13  *
14  * This file is also copied at build time to ext/re/re_comp.c, where
15  * it's built with -DPERL_EXT_RE_BUILD -DPERL_EXT_RE_DEBUG -DPERL_EXT.
16  * This causes the main functions to be compiled under new names and with
17  * debugging support added, which makes "use re 'debug'" work.
18  */
19
20 /* NOTE: this is derived from Henry Spencer's regexp code, and should not
21  * confused with the original package (see point 3 below).  Thanks, Henry!
22  */
23
24 /* Additional note: this code is very heavily munged from Henry's version
25  * in places.  In some spots I've traded clarity for efficiency, so don't
26  * blame Henry for some of the lack of readability.
27  */
28
29 /* The names of the functions have been changed from regcomp and
30  * regexec to pregcomp and pregexec in order to avoid conflicts
31  * with the POSIX routines of the same names.
32 */
33
34 #ifdef PERL_EXT_RE_BUILD
35 #include "re_top.h"
36 #endif
37
38 /*
39  * pregcomp and pregexec -- regsub and regerror are not used in perl
40  *
41  *      Copyright (c) 1986 by University of Toronto.
42  *      Written by Henry Spencer.  Not derived from licensed software.
43  *
44  *      Permission is granted to anyone to use this software for any
45  *      purpose on any computer system, and to redistribute it freely,
46  *      subject to the following restrictions:
47  *
48  *      1. The author is not responsible for the consequences of use of
49  *              this software, no matter how awful, even if they arise
50  *              from defects in it.
51  *
52  *      2. The origin of this software must not be misrepresented, either
53  *              by explicit claim or by omission.
54  *
55  *      3. Altered versions must be plainly marked as such, and must not
56  *              be misrepresented as being the original software.
57  *
58  *
59  ****    Alterations to Henry's code are...
60  ****
61  ****    Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
62  ****    2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
63  ****    by Larry Wall and others
64  ****
65  ****    You may distribute under the terms of either the GNU General Public
66  ****    License or the Artistic License, as specified in the README file.
67
68  *
69  * Beware that some of this code is subtly aware of the way operator
70  * precedence is structured in regular expressions.  Serious changes in
71  * regular-expression syntax might require a total rethink.
72  */
73 #include "EXTERN.h"
74 #define PERL_IN_REGCOMP_C
75 #include "perl.h"
76
77 #ifndef PERL_IN_XSUB_RE
78 #include "re_defs.h"
79 #endif
80
81 #define REG_COMP_C
82 #ifdef PERL_IN_XSUB_RE
83 #  include "re_comp.h"
84 #else
85 #  include "regcomp.h"
86 #endif
87
88 #include "dquote_static.c"
89
90 #ifdef op
91 #undef op
92 #endif /* op */
93
94 #ifdef MSDOS
95 #  if defined(BUGGY_MSC6)
96  /* MSC 6.00A breaks on op/regexp.t test 85 unless we turn this off */
97 #    pragma optimize("a",off)
98  /* But MSC 6.00A is happy with 'w', for aliases only across function calls*/
99 #    pragma optimize("w",on )
100 #  endif /* BUGGY_MSC6 */
101 #endif /* MSDOS */
102
103 #ifndef STATIC
104 #define STATIC  static
105 #endif
106
107 typedef struct RExC_state_t {
108     U32         flags;                  /* are we folding, multilining? */
109     char        *precomp;               /* uncompiled string. */
110     REGEXP      *rx_sv;                 /* The SV that is the regexp. */
111     regexp      *rx;                    /* perl core regexp structure */
112     regexp_internal     *rxi;           /* internal data for regexp object pprivate field */        
113     char        *start;                 /* Start of input for compile */
114     char        *end;                   /* End of input for compile */
115     char        *parse;                 /* Input-scan pointer. */
116     I32         whilem_seen;            /* number of WHILEM in this expr */
117     regnode     *emit_start;            /* Start of emitted-code area */
118     regnode     *emit_bound;            /* First regnode outside of the allocated space */
119     regnode     *emit;                  /* Code-emit pointer; &regdummy = don't = compiling */
120     I32         naughty;                /* How bad is this pattern? */
121     I32         sawback;                /* Did we see \1, ...? */
122     U32         seen;
123     I32         size;                   /* Code size. */
124     I32         npar;                   /* Capture buffer count, (OPEN). */
125     I32         cpar;                   /* Capture buffer count, (CLOSE). */
126     I32         nestroot;               /* root parens we are in - used by accept */
127     I32         extralen;
128     I32         seen_zerolen;
129     I32         seen_evals;
130     regnode     **open_parens;          /* pointers to open parens */
131     regnode     **close_parens;         /* pointers to close parens */
132     regnode     *opend;                 /* END node in program */
133     I32         utf8;           /* whether the pattern is utf8 or not */
134     I32         orig_utf8;      /* whether the pattern was originally in utf8 */
135                                 /* XXX use this for future optimisation of case
136                                  * where pattern must be upgraded to utf8. */
137     I32         uni_semantics;  /* If a d charset modifier should use unicode
138                                    rules, even if the pattern is not in
139                                    utf8 */
140     HV          *paren_names;           /* Paren names */
141     
142     regnode     **recurse;              /* Recurse regops */
143     I32         recurse_count;          /* Number of recurse regops */
144     I32         in_lookbehind;
145     I32         contains_locale;
146     I32         override_recoding;
147 #if ADD_TO_REGEXEC
148     char        *starttry;              /* -Dr: where regtry was called. */
149 #define RExC_starttry   (pRExC_state->starttry)
150 #endif
151 #ifdef DEBUGGING
152     const char  *lastparse;
153     I32         lastnum;
154     AV          *paren_name_list;       /* idx -> name */
155 #define RExC_lastparse  (pRExC_state->lastparse)
156 #define RExC_lastnum    (pRExC_state->lastnum)
157 #define RExC_paren_name_list    (pRExC_state->paren_name_list)
158 #endif
159 } RExC_state_t;
160
161 #define RExC_flags      (pRExC_state->flags)
162 #define RExC_precomp    (pRExC_state->precomp)
163 #define RExC_rx_sv      (pRExC_state->rx_sv)
164 #define RExC_rx         (pRExC_state->rx)
165 #define RExC_rxi        (pRExC_state->rxi)
166 #define RExC_start      (pRExC_state->start)
167 #define RExC_end        (pRExC_state->end)
168 #define RExC_parse      (pRExC_state->parse)
169 #define RExC_whilem_seen        (pRExC_state->whilem_seen)
170 #ifdef RE_TRACK_PATTERN_OFFSETS
171 #define RExC_offsets    (pRExC_state->rxi->u.offsets) /* I am not like the others */
172 #endif
173 #define RExC_emit       (pRExC_state->emit)
174 #define RExC_emit_start (pRExC_state->emit_start)
175 #define RExC_emit_bound (pRExC_state->emit_bound)
176 #define RExC_naughty    (pRExC_state->naughty)
177 #define RExC_sawback    (pRExC_state->sawback)
178 #define RExC_seen       (pRExC_state->seen)
179 #define RExC_size       (pRExC_state->size)
180 #define RExC_npar       (pRExC_state->npar)
181 #define RExC_nestroot   (pRExC_state->nestroot)
182 #define RExC_extralen   (pRExC_state->extralen)
183 #define RExC_seen_zerolen       (pRExC_state->seen_zerolen)
184 #define RExC_seen_evals (pRExC_state->seen_evals)
185 #define RExC_utf8       (pRExC_state->utf8)
186 #define RExC_uni_semantics      (pRExC_state->uni_semantics)
187 #define RExC_orig_utf8  (pRExC_state->orig_utf8)
188 #define RExC_open_parens        (pRExC_state->open_parens)
189 #define RExC_close_parens       (pRExC_state->close_parens)
190 #define RExC_opend      (pRExC_state->opend)
191 #define RExC_paren_names        (pRExC_state->paren_names)
192 #define RExC_recurse    (pRExC_state->recurse)
193 #define RExC_recurse_count      (pRExC_state->recurse_count)
194 #define RExC_in_lookbehind      (pRExC_state->in_lookbehind)
195 #define RExC_contains_locale    (pRExC_state->contains_locale)
196 #define RExC_override_recoding  (pRExC_state->override_recoding)
197
198
199 #define ISMULT1(c)      ((c) == '*' || (c) == '+' || (c) == '?')
200 #define ISMULT2(s)      ((*s) == '*' || (*s) == '+' || (*s) == '?' || \
201         ((*s) == '{' && regcurly(s)))
202
203 #ifdef SPSTART
204 #undef SPSTART          /* dratted cpp namespace... */
205 #endif
206 /*
207  * Flags to be passed up and down.
208  */
209 #define WORST           0       /* Worst case. */
210 #define HASWIDTH        0x01    /* Known to match non-null strings. */
211
212 /* Simple enough to be STAR/PLUS operand, in an EXACT node must be a single
213  * character, and if utf8, must be invariant.  Note that this is not the same thing as REGNODE_SIMPLE */
214 #define SIMPLE          0x02
215 #define SPSTART         0x04    /* Starts with * or +. */
216 #define TRYAGAIN        0x08    /* Weeded out a declaration. */
217 #define POSTPONED       0x10    /* (?1),(?&name), (??{...}) or similar */
218
219 #define REG_NODE_NUM(x) ((x) ? (int)((x)-RExC_emit_start) : -1)
220
221 /* whether trie related optimizations are enabled */
222 #if PERL_ENABLE_EXTENDED_TRIE_OPTIMISATION
223 #define TRIE_STUDY_OPT
224 #define FULL_TRIE_STUDY
225 #define TRIE_STCLASS
226 #endif
227
228
229
230 #define PBYTE(u8str,paren) ((U8*)(u8str))[(paren) >> 3]
231 #define PBITVAL(paren) (1 << ((paren) & 7))
232 #define PAREN_TEST(u8str,paren) ( PBYTE(u8str,paren) & PBITVAL(paren))
233 #define PAREN_SET(u8str,paren) PBYTE(u8str,paren) |= PBITVAL(paren)
234 #define PAREN_UNSET(u8str,paren) PBYTE(u8str,paren) &= (~PBITVAL(paren))
235
236 /* If not already in utf8, do a longjmp back to the beginning */
237 #define UTF8_LONGJMP 42 /* Choose a value not likely to ever conflict */
238 #define REQUIRE_UTF8    STMT_START {                                       \
239                                      if (! UTF) JMPENV_JUMP(UTF8_LONGJMP); \
240                         } STMT_END
241
242 /* About scan_data_t.
243
244   During optimisation we recurse through the regexp program performing
245   various inplace (keyhole style) optimisations. In addition study_chunk
246   and scan_commit populate this data structure with information about
247   what strings MUST appear in the pattern. We look for the longest 
248   string that must appear at a fixed location, and we look for the
249   longest string that may appear at a floating location. So for instance
250   in the pattern:
251   
252     /FOO[xX]A.*B[xX]BAR/
253     
254   Both 'FOO' and 'A' are fixed strings. Both 'B' and 'BAR' are floating
255   strings (because they follow a .* construct). study_chunk will identify
256   both FOO and BAR as being the longest fixed and floating strings respectively.
257   
258   The strings can be composites, for instance
259   
260      /(f)(o)(o)/
261      
262   will result in a composite fixed substring 'foo'.
263   
264   For each string some basic information is maintained:
265   
266   - offset or min_offset
267     This is the position the string must appear at, or not before.
268     It also implicitly (when combined with minlenp) tells us how many
269     characters must match before the string we are searching for.
270     Likewise when combined with minlenp and the length of the string it
271     tells us how many characters must appear after the string we have 
272     found.
273   
274   - max_offset
275     Only used for floating strings. This is the rightmost point that
276     the string can appear at. If set to I32 max it indicates that the
277     string can occur infinitely far to the right.
278   
279   - minlenp
280     A pointer to the minimum length of the pattern that the string 
281     was found inside. This is important as in the case of positive 
282     lookahead or positive lookbehind we can have multiple patterns 
283     involved. Consider
284     
285     /(?=FOO).*F/
286     
287     The minimum length of the pattern overall is 3, the minimum length
288     of the lookahead part is 3, but the minimum length of the part that
289     will actually match is 1. So 'FOO's minimum length is 3, but the 
290     minimum length for the F is 1. This is important as the minimum length
291     is used to determine offsets in front of and behind the string being 
292     looked for.  Since strings can be composites this is the length of the
293     pattern at the time it was committed with a scan_commit. Note that
294     the length is calculated by study_chunk, so that the minimum lengths
295     are not known until the full pattern has been compiled, thus the 
296     pointer to the value.
297   
298   - lookbehind
299   
300     In the case of lookbehind the string being searched for can be
301     offset past the start point of the final matching string. 
302     If this value was just blithely removed from the min_offset it would
303     invalidate some of the calculations for how many chars must match
304     before or after (as they are derived from min_offset and minlen and
305     the length of the string being searched for). 
306     When the final pattern is compiled and the data is moved from the
307     scan_data_t structure into the regexp structure the information
308     about lookbehind is factored in, with the information that would 
309     have been lost precalculated in the end_shift field for the 
310     associated string.
311
312   The fields pos_min and pos_delta are used to store the minimum offset
313   and the delta to the maximum offset at the current point in the pattern.    
314
315 */
316
317 typedef struct scan_data_t {
318     /*I32 len_min;      unused */
319     /*I32 len_delta;    unused */
320     I32 pos_min;
321     I32 pos_delta;
322     SV *last_found;
323     I32 last_end;           /* min value, <0 unless valid. */
324     I32 last_start_min;
325     I32 last_start_max;
326     SV **longest;           /* Either &l_fixed, or &l_float. */
327     SV *longest_fixed;      /* longest fixed string found in pattern */
328     I32 offset_fixed;       /* offset where it starts */
329     I32 *minlen_fixed;      /* pointer to the minlen relevant to the string */
330     I32 lookbehind_fixed;   /* is the position of the string modfied by LB */
331     SV *longest_float;      /* longest floating string found in pattern */
332     I32 offset_float_min;   /* earliest point in string it can appear */
333     I32 offset_float_max;   /* latest point in string it can appear */
334     I32 *minlen_float;      /* pointer to the minlen relevant to the string */
335     I32 lookbehind_float;   /* is the position of the string modified by LB */
336     I32 flags;
337     I32 whilem_c;
338     I32 *last_closep;
339     struct regnode_charclass_class *start_class;
340 } scan_data_t;
341
342 /*
343  * Forward declarations for pregcomp()'s friends.
344  */
345
346 static const scan_data_t zero_scan_data =
347   { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 ,0};
348
349 #define SF_BEFORE_EOL           (SF_BEFORE_SEOL|SF_BEFORE_MEOL)
350 #define SF_BEFORE_SEOL          0x0001
351 #define SF_BEFORE_MEOL          0x0002
352 #define SF_FIX_BEFORE_EOL       (SF_FIX_BEFORE_SEOL|SF_FIX_BEFORE_MEOL)
353 #define SF_FL_BEFORE_EOL        (SF_FL_BEFORE_SEOL|SF_FL_BEFORE_MEOL)
354
355 #ifdef NO_UNARY_PLUS
356 #  define SF_FIX_SHIFT_EOL      (0+2)
357 #  define SF_FL_SHIFT_EOL               (0+4)
358 #else
359 #  define SF_FIX_SHIFT_EOL      (+2)
360 #  define SF_FL_SHIFT_EOL               (+4)
361 #endif
362
363 #define SF_FIX_BEFORE_SEOL      (SF_BEFORE_SEOL << SF_FIX_SHIFT_EOL)
364 #define SF_FIX_BEFORE_MEOL      (SF_BEFORE_MEOL << SF_FIX_SHIFT_EOL)
365
366 #define SF_FL_BEFORE_SEOL       (SF_BEFORE_SEOL << SF_FL_SHIFT_EOL)
367 #define SF_FL_BEFORE_MEOL       (SF_BEFORE_MEOL << SF_FL_SHIFT_EOL) /* 0x20 */
368 #define SF_IS_INF               0x0040
369 #define SF_HAS_PAR              0x0080
370 #define SF_IN_PAR               0x0100
371 #define SF_HAS_EVAL             0x0200
372 #define SCF_DO_SUBSTR           0x0400
373 #define SCF_DO_STCLASS_AND      0x0800
374 #define SCF_DO_STCLASS_OR       0x1000
375 #define SCF_DO_STCLASS          (SCF_DO_STCLASS_AND|SCF_DO_STCLASS_OR)
376 #define SCF_WHILEM_VISITED_POS  0x2000
377
378 #define SCF_TRIE_RESTUDY        0x4000 /* Do restudy? */
379 #define SCF_SEEN_ACCEPT         0x8000 
380
381 #define UTF cBOOL(RExC_utf8)
382 #define LOC (get_regex_charset(RExC_flags) == REGEX_LOCALE_CHARSET)
383 #define UNI_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_UNICODE_CHARSET)
384 #define DEPENDS_SEMANTICS (get_regex_charset(RExC_flags) == REGEX_DEPENDS_CHARSET)
385 #define AT_LEAST_UNI_SEMANTICS (get_regex_charset(RExC_flags) >= REGEX_UNICODE_CHARSET)
386 #define ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_RESTRICTED_CHARSET)
387 #define MORE_ASCII_RESTRICTED (get_regex_charset(RExC_flags) == REGEX_ASCII_MORE_RESTRICTED_CHARSET)
388 #define AT_LEAST_ASCII_RESTRICTED (get_regex_charset(RExC_flags) >= REGEX_ASCII_RESTRICTED_CHARSET)
389
390 #define FOLD cBOOL(RExC_flags & RXf_PMf_FOLD)
391
392 #define OOB_UNICODE             12345678
393 #define OOB_NAMEDCLASS          -1
394
395 #define CHR_SVLEN(sv) (UTF ? sv_len_utf8(sv) : SvCUR(sv))
396 #define CHR_DIST(a,b) (UTF ? utf8_distance(a,b) : a - b)
397
398
399 /* length of regex to show in messages that don't mark a position within */
400 #define RegexLengthToShowInErrorMessages 127
401
402 /*
403  * If MARKER[12] are adjusted, be sure to adjust the constants at the top
404  * of t/op/regmesg.t, the tests in t/op/re_tests, and those in
405  * op/pragma/warn/regcomp.
406  */
407 #define MARKER1 "<-- HERE"    /* marker as it appears in the description */
408 #define MARKER2 " <-- HERE "  /* marker as it appears within the regex */
409
410 #define REPORT_LOCATION " in regex; marked by " MARKER1 " in m/%.*s" MARKER2 "%s/"
411
412 /*
413  * Calls SAVEDESTRUCTOR_X if needed, then calls Perl_croak with the given
414  * arg. Show regex, up to a maximum length. If it's too long, chop and add
415  * "...".
416  */
417 #define _FAIL(code) STMT_START {                                        \
418     const char *ellipses = "";                                          \
419     IV len = RExC_end - RExC_precomp;                                   \
420                                                                         \
421     if (!SIZE_ONLY)                                                     \
422         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);                   \
423     if (len > RegexLengthToShowInErrorMessages) {                       \
424         /* chop 10 shorter than the max, to ensure meaning of "..." */  \
425         len = RegexLengthToShowInErrorMessages - 10;                    \
426         ellipses = "...";                                               \
427     }                                                                   \
428     code;                                                               \
429 } STMT_END
430
431 #define FAIL(msg) _FAIL(                            \
432     Perl_croak(aTHX_ "%s in regex m/%.*s%s/",       \
433             msg, (int)len, RExC_precomp, ellipses))
434
435 #define FAIL2(msg,arg) _FAIL(                       \
436     Perl_croak(aTHX_ msg " in regex m/%.*s%s/",     \
437             arg, (int)len, RExC_precomp, ellipses))
438
439 /*
440  * Simple_vFAIL -- like FAIL, but marks the current location in the scan
441  */
442 #define Simple_vFAIL(m) STMT_START {                                    \
443     const IV offset = RExC_parse - RExC_precomp;                        \
444     Perl_croak(aTHX_ "%s" REPORT_LOCATION,                              \
445             m, (int)offset, RExC_precomp, RExC_precomp + offset);       \
446 } STMT_END
447
448 /*
449  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL()
450  */
451 #define vFAIL(m) STMT_START {                           \
452     if (!SIZE_ONLY)                                     \
453         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
454     Simple_vFAIL(m);                                    \
455 } STMT_END
456
457 /*
458  * Like Simple_vFAIL(), but accepts two arguments.
459  */
460 #define Simple_vFAIL2(m,a1) STMT_START {                        \
461     const IV offset = RExC_parse - RExC_precomp;                        \
462     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1,                   \
463             (int)offset, RExC_precomp, RExC_precomp + offset);  \
464 } STMT_END
465
466 /*
467  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL2().
468  */
469 #define vFAIL2(m,a1) STMT_START {                       \
470     if (!SIZE_ONLY)                                     \
471         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
472     Simple_vFAIL2(m, a1);                               \
473 } STMT_END
474
475
476 /*
477  * Like Simple_vFAIL(), but accepts three arguments.
478  */
479 #define Simple_vFAIL3(m, a1, a2) STMT_START {                   \
480     const IV offset = RExC_parse - RExC_precomp;                \
481     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2,               \
482             (int)offset, RExC_precomp, RExC_precomp + offset);  \
483 } STMT_END
484
485 /*
486  * Calls SAVEDESTRUCTOR_X if needed, then Simple_vFAIL3().
487  */
488 #define vFAIL3(m,a1,a2) STMT_START {                    \
489     if (!SIZE_ONLY)                                     \
490         SAVEDESTRUCTOR_X(clear_re,(void*)RExC_rx_sv);   \
491     Simple_vFAIL3(m, a1, a2);                           \
492 } STMT_END
493
494 /*
495  * Like Simple_vFAIL(), but accepts four arguments.
496  */
497 #define Simple_vFAIL4(m, a1, a2, a3) STMT_START {               \
498     const IV offset = RExC_parse - RExC_precomp;                \
499     S_re_croak2(aTHX_ m, REPORT_LOCATION, a1, a2, a3,           \
500             (int)offset, RExC_precomp, RExC_precomp + offset);  \
501 } STMT_END
502
503 #define ckWARNreg(loc,m) STMT_START {                                   \
504     const IV offset = loc - RExC_precomp;                               \
505     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
506             (int)offset, RExC_precomp, RExC_precomp + offset);          \
507 } STMT_END
508
509 #define ckWARNregdep(loc,m) STMT_START {                                \
510     const IV offset = loc - RExC_precomp;                               \
511     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
512             m REPORT_LOCATION,                                          \
513             (int)offset, RExC_precomp, RExC_precomp + offset);          \
514 } STMT_END
515
516 #define ckWARN2regdep(loc,m, a1) STMT_START {                           \
517     const IV offset = loc - RExC_precomp;                               \
518     Perl_ck_warner_d(aTHX_ packWARN2(WARN_DEPRECATED, WARN_REGEXP),     \
519             m REPORT_LOCATION,                                          \
520             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
521 } STMT_END
522
523 #define ckWARN2reg(loc, m, a1) STMT_START {                             \
524     const IV offset = loc - RExC_precomp;                               \
525     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
526             a1, (int)offset, RExC_precomp, RExC_precomp + offset);      \
527 } STMT_END
528
529 #define vWARN3(loc, m, a1, a2) STMT_START {                             \
530     const IV offset = loc - RExC_precomp;                               \
531     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
532             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
533 } STMT_END
534
535 #define ckWARN3reg(loc, m, a1, a2) STMT_START {                         \
536     const IV offset = loc - RExC_precomp;                               \
537     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
538             a1, a2, (int)offset, RExC_precomp, RExC_precomp + offset);  \
539 } STMT_END
540
541 #define vWARN4(loc, m, a1, a2, a3) STMT_START {                         \
542     const IV offset = loc - RExC_precomp;                               \
543     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
544             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
545 } STMT_END
546
547 #define ckWARN4reg(loc, m, a1, a2, a3) STMT_START {                     \
548     const IV offset = loc - RExC_precomp;                               \
549     Perl_ck_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,      \
550             a1, a2, a3, (int)offset, RExC_precomp, RExC_precomp + offset); \
551 } STMT_END
552
553 #define vWARN5(loc, m, a1, a2, a3, a4) STMT_START {                     \
554     const IV offset = loc - RExC_precomp;                               \
555     Perl_warner(aTHX_ packWARN(WARN_REGEXP), m REPORT_LOCATION,         \
556             a1, a2, a3, a4, (int)offset, RExC_precomp, RExC_precomp + offset); \
557 } STMT_END
558
559
560 /* Allow for side effects in s */
561 #define REGC(c,s) STMT_START {                  \
562     if (!SIZE_ONLY) *(s) = (c); else (void)(s); \
563 } STMT_END
564
565 /* Macros for recording node offsets.   20001227 mjd@plover.com 
566  * Nodes are numbered 1, 2, 3, 4.  Node #n's position is recorded in
567  * element 2*n-1 of the array.  Element #2n holds the byte length node #n.
568  * Element 0 holds the number n.
569  * Position is 1 indexed.
570  */
571 #ifndef RE_TRACK_PATTERN_OFFSETS
572 #define Set_Node_Offset_To_R(node,byte)
573 #define Set_Node_Offset(node,byte)
574 #define Set_Cur_Node_Offset
575 #define Set_Node_Length_To_R(node,len)
576 #define Set_Node_Length(node,len)
577 #define Set_Node_Cur_Length(node)
578 #define Node_Offset(n) 
579 #define Node_Length(n) 
580 #define Set_Node_Offset_Length(node,offset,len)
581 #define ProgLen(ri) ri->u.proglen
582 #define SetProgLen(ri,x) ri->u.proglen = x
583 #else
584 #define ProgLen(ri) ri->u.offsets[0]
585 #define SetProgLen(ri,x) ri->u.offsets[0] = x
586 #define Set_Node_Offset_To_R(node,byte) STMT_START {                    \
587     if (! SIZE_ONLY) {                                                  \
588         MJD_OFFSET_DEBUG(("** (%d) offset of node %d is %d.\n",         \
589                     __LINE__, (int)(node), (int)(byte)));               \
590         if((node) < 0) {                                                \
591             Perl_croak(aTHX_ "value of node is %d in Offset macro", (int)(node)); \
592         } else {                                                        \
593             RExC_offsets[2*(node)-1] = (byte);                          \
594         }                                                               \
595     }                                                                   \
596 } STMT_END
597
598 #define Set_Node_Offset(node,byte) \
599     Set_Node_Offset_To_R((node)-RExC_emit_start, (byte)-RExC_start)
600 #define Set_Cur_Node_Offset Set_Node_Offset(RExC_emit, RExC_parse)
601
602 #define Set_Node_Length_To_R(node,len) STMT_START {                     \
603     if (! SIZE_ONLY) {                                                  \
604         MJD_OFFSET_DEBUG(("** (%d) size of node %d is %d.\n",           \
605                 __LINE__, (int)(node), (int)(len)));                    \
606         if((node) < 0) {                                                \
607             Perl_croak(aTHX_ "value of node is %d in Length macro", (int)(node)); \
608         } else {                                                        \
609             RExC_offsets[2*(node)] = (len);                             \
610         }                                                               \
611     }                                                                   \
612 } STMT_END
613
614 #define Set_Node_Length(node,len) \
615     Set_Node_Length_To_R((node)-RExC_emit_start, len)
616 #define Set_Cur_Node_Length(len) Set_Node_Length(RExC_emit, len)
617 #define Set_Node_Cur_Length(node) \
618     Set_Node_Length(node, RExC_parse - parse_start)
619
620 /* Get offsets and lengths */
621 #define Node_Offset(n) (RExC_offsets[2*((n)-RExC_emit_start)-1])
622 #define Node_Length(n) (RExC_offsets[2*((n)-RExC_emit_start)])
623
624 #define Set_Node_Offset_Length(node,offset,len) STMT_START {    \
625     Set_Node_Offset_To_R((node)-RExC_emit_start, (offset));     \
626     Set_Node_Length_To_R((node)-RExC_emit_start, (len));        \
627 } STMT_END
628 #endif
629
630 #if PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS
631 #define EXPERIMENTAL_INPLACESCAN
632 #endif /*PERL_ENABLE_EXPERIMENTAL_REGEX_OPTIMISATIONS*/
633
634 #define DEBUG_STUDYDATA(str,data,depth)                              \
635 DEBUG_OPTIMISE_MORE_r(if(data){                                      \
636     PerlIO_printf(Perl_debug_log,                                    \
637         "%*s" str "Pos:%"IVdf"/%"IVdf                                \
638         " Flags: 0x%"UVXf" Whilem_c: %"IVdf" Lcp: %"IVdf" %s",       \
639         (int)(depth)*2, "",                                          \
640         (IV)((data)->pos_min),                                       \
641         (IV)((data)->pos_delta),                                     \
642         (UV)((data)->flags),                                         \
643         (IV)((data)->whilem_c),                                      \
644         (IV)((data)->last_closep ? *((data)->last_closep) : -1),     \
645         is_inf ? "INF " : ""                                         \
646     );                                                               \
647     if ((data)->last_found)                                          \
648         PerlIO_printf(Perl_debug_log,                                \
649             "Last:'%s' %"IVdf":%"IVdf"/%"IVdf" %sFixed:'%s' @ %"IVdf \
650             " %sFloat: '%s' @ %"IVdf"/%"IVdf"",                      \
651             SvPVX_const((data)->last_found),                         \
652             (IV)((data)->last_end),                                  \
653             (IV)((data)->last_start_min),                            \
654             (IV)((data)->last_start_max),                            \
655             ((data)->longest &&                                      \
656              (data)->longest==&((data)->longest_fixed)) ? "*" : "",  \
657             SvPVX_const((data)->longest_fixed),                      \
658             (IV)((data)->offset_fixed),                              \
659             ((data)->longest &&                                      \
660              (data)->longest==&((data)->longest_float)) ? "*" : "",  \
661             SvPVX_const((data)->longest_float),                      \
662             (IV)((data)->offset_float_min),                          \
663             (IV)((data)->offset_float_max)                           \
664         );                                                           \
665     PerlIO_printf(Perl_debug_log,"\n");                              \
666 });
667
668 static void clear_re(pTHX_ void *r);
669
670 /* Mark that we cannot extend a found fixed substring at this point.
671    Update the longest found anchored substring and the longest found
672    floating substrings if needed. */
673
674 STATIC void
675 S_scan_commit(pTHX_ const RExC_state_t *pRExC_state, scan_data_t *data, I32 *minlenp, int is_inf)
676 {
677     const STRLEN l = CHR_SVLEN(data->last_found);
678     const STRLEN old_l = CHR_SVLEN(*data->longest);
679     GET_RE_DEBUG_FLAGS_DECL;
680
681     PERL_ARGS_ASSERT_SCAN_COMMIT;
682
683     if ((l >= old_l) && ((l > old_l) || (data->flags & SF_BEFORE_EOL))) {
684         SvSetMagicSV(*data->longest, data->last_found);
685         if (*data->longest == data->longest_fixed) {
686             data->offset_fixed = l ? data->last_start_min : data->pos_min;
687             if (data->flags & SF_BEFORE_EOL)
688                 data->flags
689                     |= ((data->flags & SF_BEFORE_EOL) << SF_FIX_SHIFT_EOL);
690             else
691                 data->flags &= ~SF_FIX_BEFORE_EOL;
692             data->minlen_fixed=minlenp; 
693             data->lookbehind_fixed=0;
694         }
695         else { /* *data->longest == data->longest_float */
696             data->offset_float_min = l ? data->last_start_min : data->pos_min;
697             data->offset_float_max = (l
698                                       ? data->last_start_max
699                                       : data->pos_min + data->pos_delta);
700             if (is_inf || (U32)data->offset_float_max > (U32)I32_MAX)
701                 data->offset_float_max = I32_MAX;
702             if (data->flags & SF_BEFORE_EOL)
703                 data->flags
704                     |= ((data->flags & SF_BEFORE_EOL) << SF_FL_SHIFT_EOL);
705             else
706                 data->flags &= ~SF_FL_BEFORE_EOL;
707             data->minlen_float=minlenp;
708             data->lookbehind_float=0;
709         }
710     }
711     SvCUR_set(data->last_found, 0);
712     {
713         SV * const sv = data->last_found;
714         if (SvUTF8(sv) && SvMAGICAL(sv)) {
715             MAGIC * const mg = mg_find(sv, PERL_MAGIC_utf8);
716             if (mg)
717                 mg->mg_len = 0;
718         }
719     }
720     data->last_end = -1;
721     data->flags &= ~SF_BEFORE_EOL;
722     DEBUG_STUDYDATA("commit: ",data,0);
723 }
724
725 /* Can match anything (initialization) */
726 STATIC void
727 S_cl_anything(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
728 {
729     PERL_ARGS_ASSERT_CL_ANYTHING;
730
731     ANYOF_BITMAP_SETALL(cl);
732     cl->flags = ANYOF_CLASS|ANYOF_EOS|ANYOF_UNICODE_ALL
733                 |ANYOF_LOC_NONBITMAP_FOLD|ANYOF_NON_UTF8_LATIN1_ALL;
734
735     /* If any portion of the regex is to operate under locale rules,
736      * initialization includes it.  The reason this isn't done for all regexes
737      * is that the optimizer was written under the assumption that locale was
738      * all-or-nothing.  Given the complexity and lack of documentation in the
739      * optimizer, and that there are inadequate test cases for locale, so many
740      * parts of it may not work properly, it is safest to avoid locale unless
741      * necessary. */
742     if (RExC_contains_locale) {
743         ANYOF_CLASS_SETALL(cl);     /* /l uses class */
744         cl->flags |= ANYOF_LOCALE;
745     }
746     else {
747         ANYOF_CLASS_ZERO(cl);       /* Only /l uses class now */
748     }
749 }
750
751 /* Can match anything (initialization) */
752 STATIC int
753 S_cl_is_anything(const struct regnode_charclass_class *cl)
754 {
755     int value;
756
757     PERL_ARGS_ASSERT_CL_IS_ANYTHING;
758
759     for (value = 0; value <= ANYOF_MAX; value += 2)
760         if (ANYOF_CLASS_TEST(cl, value) && ANYOF_CLASS_TEST(cl, value + 1))
761             return 1;
762     if (!(cl->flags & ANYOF_UNICODE_ALL))
763         return 0;
764     if (!ANYOF_BITMAP_TESTALLSET((const void*)cl))
765         return 0;
766     return 1;
767 }
768
769 /* Can match anything (initialization) */
770 STATIC void
771 S_cl_init(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl)
772 {
773     PERL_ARGS_ASSERT_CL_INIT;
774
775     Zero(cl, 1, struct regnode_charclass_class);
776     cl->type = ANYOF;
777     cl_anything(pRExC_state, cl);
778     ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
779 }
780
781 /* These two functions currently do the exact same thing */
782 #define cl_init_zero            S_cl_init
783
784 /* 'AND' a given class with another one.  Can create false positives.  'cl'
785  * should not be inverted.  'and_with->flags & ANYOF_CLASS' should be 0 if
786  * 'and_with' is a regnode_charclass instead of a regnode_charclass_class. */
787 STATIC void
788 S_cl_and(struct regnode_charclass_class *cl,
789         const struct regnode_charclass_class *and_with)
790 {
791     PERL_ARGS_ASSERT_CL_AND;
792
793     assert(and_with->type == ANYOF);
794
795     /* I (khw) am not sure all these restrictions are necessary XXX */
796     if (!(ANYOF_CLASS_TEST_ANY_SET(and_with))
797         && !(ANYOF_CLASS_TEST_ANY_SET(cl))
798         && (and_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
799         && !(and_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
800         && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) {
801         int i;
802
803         if (and_with->flags & ANYOF_INVERT)
804             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
805                 cl->bitmap[i] &= ~and_with->bitmap[i];
806         else
807             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
808                 cl->bitmap[i] &= and_with->bitmap[i];
809     } /* XXXX: logic is complicated otherwise, leave it along for a moment. */
810
811     if (and_with->flags & ANYOF_INVERT) {
812
813         /* Here, the and'ed node is inverted.  Get the AND of the flags that
814          * aren't affected by the inversion.  Those that are affected are
815          * handled individually below */
816         U8 affected_flags = cl->flags & ~INVERSION_UNAFFECTED_FLAGS;
817         cl->flags &= (and_with->flags & INVERSION_UNAFFECTED_FLAGS);
818         cl->flags |= affected_flags;
819
820         /* We currently don't know how to deal with things that aren't in the
821          * bitmap, but we know that the intersection is no greater than what
822          * is already in cl, so let there be false positives that get sorted
823          * out after the synthetic start class succeeds, and the node is
824          * matched for real. */
825
826         /* The inversion of these two flags indicate that the resulting
827          * intersection doesn't have them */
828         if (and_with->flags & ANYOF_UNICODE_ALL) {
829             cl->flags &= ~ANYOF_UNICODE_ALL;
830         }
831         if (and_with->flags & ANYOF_NON_UTF8_LATIN1_ALL) {
832             cl->flags &= ~ANYOF_NON_UTF8_LATIN1_ALL;
833         }
834     }
835     else {   /* and'd node is not inverted */
836         U8 outside_bitmap_but_not_utf8; /* Temp variable */
837
838         if (! ANYOF_NONBITMAP(and_with)) {
839
840             /* Here 'and_with' doesn't match anything outside the bitmap
841              * (except possibly ANYOF_UNICODE_ALL), which means the
842              * intersection can't either, except for ANYOF_UNICODE_ALL, in
843              * which case we don't know what the intersection is, but it's no
844              * greater than what cl already has, so can just leave it alone,
845              * with possible false positives */
846             if (! (and_with->flags & ANYOF_UNICODE_ALL)) {
847                 ARG_SET(cl, ANYOF_NONBITMAP_EMPTY);
848                 cl->flags &= ~ANYOF_NONBITMAP_NON_UTF8;
849             }
850         }
851         else if (! ANYOF_NONBITMAP(cl)) {
852
853             /* Here, 'and_with' does match something outside the bitmap, and cl
854              * doesn't have a list of things to match outside the bitmap.  If
855              * cl can match all code points above 255, the intersection will
856              * be those above-255 code points that 'and_with' matches.  If cl
857              * can't match all Unicode code points, it means that it can't
858              * match anything outside the bitmap (since the 'if' that got us
859              * into this block tested for that), so we leave the bitmap empty.
860              */
861             if (cl->flags & ANYOF_UNICODE_ALL) {
862                 ARG_SET(cl, ARG(and_with));
863
864                 /* and_with's ARG may match things that don't require UTF8.
865                  * And now cl's will too, in spite of this being an 'and'.  See
866                  * the comments below about the kludge */
867                 cl->flags |= and_with->flags & ANYOF_NONBITMAP_NON_UTF8;
868             }
869         }
870         else {
871             /* Here, both 'and_with' and cl match something outside the
872              * bitmap.  Currently we do not do the intersection, so just match
873              * whatever cl had at the beginning.  */
874         }
875
876
877         /* Take the intersection of the two sets of flags.  However, the
878          * ANYOF_NONBITMAP_NON_UTF8 flag is treated as an 'or'.  This is a
879          * kludge around the fact that this flag is not treated like the others
880          * which are initialized in cl_anything().  The way the optimizer works
881          * is that the synthetic start class (SSC) is initialized to match
882          * anything, and then the first time a real node is encountered, its
883          * values are AND'd with the SSC's with the result being the values of
884          * the real node.  However, there are paths through the optimizer where
885          * the AND never gets called, so those initialized bits are set
886          * inappropriately, which is not usually a big deal, as they just cause
887          * false positives in the SSC, which will just mean a probably
888          * imperceptible slow down in execution.  However this bit has a
889          * higher false positive consequence in that it can cause utf8.pm,
890          * utf8_heavy.pl ... to be loaded when not necessary, which is a much
891          * bigger slowdown and also causes significant extra memory to be used.
892          * In order to prevent this, the code now takes a different tack.  The
893          * bit isn't set unless some part of the regular expression needs it,
894          * but once set it won't get cleared.  This means that these extra
895          * modules won't get loaded unless there was some path through the
896          * pattern that would have required them anyway, and  so any false
897          * positives that occur by not ANDing them out when they could be
898          * aren't as severe as they would be if we treated this bit like all
899          * the others */
900         outside_bitmap_but_not_utf8 = (cl->flags | and_with->flags)
901                                       & ANYOF_NONBITMAP_NON_UTF8;
902         cl->flags &= and_with->flags;
903         cl->flags |= outside_bitmap_but_not_utf8;
904     }
905 }
906
907 /* 'OR' a given class with another one.  Can create false positives.  'cl'
908  * should not be inverted.  'or_with->flags & ANYOF_CLASS' should be 0 if
909  * 'or_with' is a regnode_charclass instead of a regnode_charclass_class. */
910 STATIC void
911 S_cl_or(const RExC_state_t *pRExC_state, struct regnode_charclass_class *cl, const struct regnode_charclass_class *or_with)
912 {
913     PERL_ARGS_ASSERT_CL_OR;
914
915     if (or_with->flags & ANYOF_INVERT) {
916
917         /* Here, the or'd node is to be inverted.  This means we take the
918          * complement of everything not in the bitmap, but currently we don't
919          * know what that is, so give up and match anything */
920         if (ANYOF_NONBITMAP(or_with)) {
921             cl_anything(pRExC_state, cl);
922         }
923         /* We do not use
924          * (B1 | CL1) | (!B2 & !CL2) = (B1 | !B2 & !CL2) | (CL1 | (!B2 & !CL2))
925          *   <= (B1 | !B2) | (CL1 | !CL2)
926          * which is wasteful if CL2 is small, but we ignore CL2:
927          *   (B1 | CL1) | (!B2 & !CL2) <= (B1 | CL1) | !B2 = (B1 | !B2) | CL1
928          * XXXX Can we handle case-fold?  Unclear:
929          *   (OK1(i) | OK1(i')) | !(OK1(i) | OK1(i')) =
930          *   (OK1(i) | OK1(i')) | (!OK1(i) & !OK1(i'))
931          */
932         else if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
933              && !(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
934              && !(cl->flags & ANYOF_LOC_NONBITMAP_FOLD) ) {
935             int i;
936
937             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
938                 cl->bitmap[i] |= ~or_with->bitmap[i];
939         } /* XXXX: logic is complicated otherwise */
940         else {
941             cl_anything(pRExC_state, cl);
942         }
943
944         /* And, we can just take the union of the flags that aren't affected
945          * by the inversion */
946         cl->flags |= or_with->flags & INVERSION_UNAFFECTED_FLAGS;
947
948         /* For the remaining flags:
949             ANYOF_UNICODE_ALL and inverted means to not match anything above
950                     255, which means that the union with cl should just be
951                     what cl has in it, so can ignore this flag
952             ANYOF_NON_UTF8_LATIN1_ALL and inverted means if not utf8 and ord
953                     is 127-255 to match them, but then invert that, so the
954                     union with cl should just be what cl has in it, so can
955                     ignore this flag
956          */
957     } else {    /* 'or_with' is not inverted */
958         /* (B1 | CL1) | (B2 | CL2) = (B1 | B2) | (CL1 | CL2)) */
959         if ( (or_with->flags & ANYOF_LOCALE) == (cl->flags & ANYOF_LOCALE)
960              && (!(or_with->flags & ANYOF_LOC_NONBITMAP_FOLD)
961                  || (cl->flags & ANYOF_LOC_NONBITMAP_FOLD)) ) {
962             int i;
963
964             /* OR char bitmap and class bitmap separately */
965             for (i = 0; i < ANYOF_BITMAP_SIZE; i++)
966                 cl->bitmap[i] |= or_with->bitmap[i];
967             if (ANYOF_CLASS_TEST_ANY_SET(or_with)) {
968                 for (i = 0; i < ANYOF_CLASSBITMAP_SIZE; i++)
969                     cl->classflags[i] |= or_with->classflags[i];
970                 cl->flags |= ANYOF_CLASS;
971             }
972         }
973         else { /* XXXX: logic is complicated, leave it along for a moment. */
974             cl_anything(pRExC_state, cl);
975         }
976
977         if (ANYOF_NONBITMAP(or_with)) {
978
979             /* Use the added node's outside-the-bit-map match if there isn't a
980              * conflict.  If there is a conflict (both nodes match something
981              * outside the bitmap, but what they match outside is not the same
982              * pointer, and hence not easily compared until XXX we extend
983              * inversion lists this far), give up and allow the start class to
984              * match everything outside the bitmap.  If that stuff is all above
985              * 255, can just set UNICODE_ALL, otherwise caould be anything. */
986             if (! ANYOF_NONBITMAP(cl)) {
987                 ARG_SET(cl, ARG(or_with));
988             }
989             else if (ARG(cl) != ARG(or_with)) {
990
991                 if ((or_with->flags & ANYOF_NONBITMAP_NON_UTF8)) {
992                     cl_anything(pRExC_state, cl);
993                 }
994                 else {
995                     cl->flags |= ANYOF_UNICODE_ALL;
996                 }
997             }
998         }
999
1000         /* Take the union */
1001         cl->flags |= or_with->flags;
1002     }
1003 }
1004
1005 #define TRIE_LIST_ITEM(state,idx) (trie->states[state].trans.list)[ idx ]
1006 #define TRIE_LIST_CUR(state)  ( TRIE_LIST_ITEM( state, 0 ).forid )
1007 #define TRIE_LIST_LEN(state) ( TRIE_LIST_ITEM( state, 0 ).newstate )
1008 #define TRIE_LIST_USED(idx)  ( trie->states[state].trans.list ? (TRIE_LIST_CUR( idx ) - 1) : 0 )
1009
1010
1011 #ifdef DEBUGGING
1012 /*
1013    dump_trie(trie,widecharmap,revcharmap)
1014    dump_trie_interim_list(trie,widecharmap,revcharmap,next_alloc)
1015    dump_trie_interim_table(trie,widecharmap,revcharmap,next_alloc)
1016
1017    These routines dump out a trie in a somewhat readable format.
1018    The _interim_ variants are used for debugging the interim
1019    tables that are used to generate the final compressed
1020    representation which is what dump_trie expects.
1021
1022    Part of the reason for their existence is to provide a form
1023    of documentation as to how the different representations function.
1024
1025 */
1026
1027 /*
1028   Dumps the final compressed table form of the trie to Perl_debug_log.
1029   Used for debugging make_trie().
1030 */
1031
1032 STATIC void
1033 S_dump_trie(pTHX_ const struct _reg_trie_data *trie, HV *widecharmap,
1034             AV *revcharmap, U32 depth)
1035 {
1036     U32 state;
1037     SV *sv=sv_newmortal();
1038     int colwidth= widecharmap ? 6 : 4;
1039     U16 word;
1040     GET_RE_DEBUG_FLAGS_DECL;
1041
1042     PERL_ARGS_ASSERT_DUMP_TRIE;
1043
1044     PerlIO_printf( Perl_debug_log, "%*sChar : %-6s%-6s%-4s ",
1045         (int)depth * 2 + 2,"",
1046         "Match","Base","Ofs" );
1047
1048     for( state = 0 ; state < trie->uniquecharcount ; state++ ) {
1049         SV ** const tmp = av_fetch( revcharmap, state, 0);
1050         if ( tmp ) {
1051             PerlIO_printf( Perl_debug_log, "%*s", 
1052                 colwidth,
1053                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1054                             PL_colors[0], PL_colors[1],
1055                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1056                             PERL_PV_ESCAPE_FIRSTCHAR 
1057                 ) 
1058             );
1059         }
1060     }
1061     PerlIO_printf( Perl_debug_log, "\n%*sState|-----------------------",
1062         (int)depth * 2 + 2,"");
1063
1064     for( state = 0 ; state < trie->uniquecharcount ; state++ )
1065         PerlIO_printf( Perl_debug_log, "%.*s", colwidth, "--------");
1066     PerlIO_printf( Perl_debug_log, "\n");
1067
1068     for( state = 1 ; state < trie->statecount ; state++ ) {
1069         const U32 base = trie->states[ state ].trans.base;
1070
1071         PerlIO_printf( Perl_debug_log, "%*s#%4"UVXf"|", (int)depth * 2 + 2,"", (UV)state);
1072
1073         if ( trie->states[ state ].wordnum ) {
1074             PerlIO_printf( Perl_debug_log, " W%4X", trie->states[ state ].wordnum );
1075         } else {
1076             PerlIO_printf( Perl_debug_log, "%6s", "" );
1077         }
1078
1079         PerlIO_printf( Perl_debug_log, " @%4"UVXf" ", (UV)base );
1080
1081         if ( base ) {
1082             U32 ofs = 0;
1083
1084             while( ( base + ofs  < trie->uniquecharcount ) ||
1085                    ( base + ofs - trie->uniquecharcount < trie->lasttrans
1086                      && trie->trans[ base + ofs - trie->uniquecharcount ].check != state))
1087                     ofs++;
1088
1089             PerlIO_printf( Perl_debug_log, "+%2"UVXf"[ ", (UV)ofs);
1090
1091             for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
1092                 if ( ( base + ofs >= trie->uniquecharcount ) &&
1093                      ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
1094                      trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
1095                 {
1096                    PerlIO_printf( Perl_debug_log, "%*"UVXf,
1097                     colwidth,
1098                     (UV)trie->trans[ base + ofs - trie->uniquecharcount ].next );
1099                 } else {
1100                     PerlIO_printf( Perl_debug_log, "%*s",colwidth,"   ." );
1101                 }
1102             }
1103
1104             PerlIO_printf( Perl_debug_log, "]");
1105
1106         }
1107         PerlIO_printf( Perl_debug_log, "\n" );
1108     }
1109     PerlIO_printf(Perl_debug_log, "%*sword_info N:(prev,len)=", (int)depth*2, "");
1110     for (word=1; word <= trie->wordcount; word++) {
1111         PerlIO_printf(Perl_debug_log, " %d:(%d,%d)",
1112             (int)word, (int)(trie->wordinfo[word].prev),
1113             (int)(trie->wordinfo[word].len));
1114     }
1115     PerlIO_printf(Perl_debug_log, "\n" );
1116 }    
1117 /*
1118   Dumps a fully constructed but uncompressed trie in list form.
1119   List tries normally only are used for construction when the number of 
1120   possible chars (trie->uniquecharcount) is very high.
1121   Used for debugging make_trie().
1122 */
1123 STATIC void
1124 S_dump_trie_interim_list(pTHX_ const struct _reg_trie_data *trie,
1125                          HV *widecharmap, AV *revcharmap, U32 next_alloc,
1126                          U32 depth)
1127 {
1128     U32 state;
1129     SV *sv=sv_newmortal();
1130     int colwidth= widecharmap ? 6 : 4;
1131     GET_RE_DEBUG_FLAGS_DECL;
1132
1133     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_LIST;
1134
1135     /* print out the table precompression.  */
1136     PerlIO_printf( Perl_debug_log, "%*sState :Word | Transition Data\n%*s%s",
1137         (int)depth * 2 + 2,"", (int)depth * 2 + 2,"",
1138         "------:-----+-----------------\n" );
1139     
1140     for( state=1 ; state < next_alloc ; state ++ ) {
1141         U16 charid;
1142     
1143         PerlIO_printf( Perl_debug_log, "%*s %4"UVXf" :",
1144             (int)depth * 2 + 2,"", (UV)state  );
1145         if ( ! trie->states[ state ].wordnum ) {
1146             PerlIO_printf( Perl_debug_log, "%5s| ","");
1147         } else {
1148             PerlIO_printf( Perl_debug_log, "W%4x| ",
1149                 trie->states[ state ].wordnum
1150             );
1151         }
1152         for( charid = 1 ; charid <= TRIE_LIST_USED( state ) ; charid++ ) {
1153             SV ** const tmp = av_fetch( revcharmap, TRIE_LIST_ITEM(state,charid).forid, 0);
1154             if ( tmp ) {
1155                 PerlIO_printf( Perl_debug_log, "%*s:%3X=%4"UVXf" | ",
1156                     colwidth,
1157                     pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1158                             PL_colors[0], PL_colors[1],
1159                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1160                             PERL_PV_ESCAPE_FIRSTCHAR 
1161                     ) ,
1162                     TRIE_LIST_ITEM(state,charid).forid,
1163                     (UV)TRIE_LIST_ITEM(state,charid).newstate
1164                 );
1165                 if (!(charid % 10)) 
1166                     PerlIO_printf(Perl_debug_log, "\n%*s| ",
1167                         (int)((depth * 2) + 14), "");
1168             }
1169         }
1170         PerlIO_printf( Perl_debug_log, "\n");
1171     }
1172 }    
1173
1174 /*
1175   Dumps a fully constructed but uncompressed trie in table form.
1176   This is the normal DFA style state transition table, with a few 
1177   twists to facilitate compression later. 
1178   Used for debugging make_trie().
1179 */
1180 STATIC void
1181 S_dump_trie_interim_table(pTHX_ const struct _reg_trie_data *trie,
1182                           HV *widecharmap, AV *revcharmap, U32 next_alloc,
1183                           U32 depth)
1184 {
1185     U32 state;
1186     U16 charid;
1187     SV *sv=sv_newmortal();
1188     int colwidth= widecharmap ? 6 : 4;
1189     GET_RE_DEBUG_FLAGS_DECL;
1190
1191     PERL_ARGS_ASSERT_DUMP_TRIE_INTERIM_TABLE;
1192     
1193     /*
1194        print out the table precompression so that we can do a visual check
1195        that they are identical.
1196      */
1197     
1198     PerlIO_printf( Perl_debug_log, "%*sChar : ",(int)depth * 2 + 2,"" );
1199
1200     for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1201         SV ** const tmp = av_fetch( revcharmap, charid, 0);
1202         if ( tmp ) {
1203             PerlIO_printf( Perl_debug_log, "%*s", 
1204                 colwidth,
1205                 pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), colwidth, 
1206                             PL_colors[0], PL_colors[1],
1207                             (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
1208                             PERL_PV_ESCAPE_FIRSTCHAR 
1209                 ) 
1210             );
1211         }
1212     }
1213
1214     PerlIO_printf( Perl_debug_log, "\n%*sState+-",(int)depth * 2 + 2,"" );
1215
1216     for( charid=0 ; charid < trie->uniquecharcount ; charid++ ) {
1217         PerlIO_printf( Perl_debug_log, "%.*s", colwidth,"--------");
1218     }
1219
1220     PerlIO_printf( Perl_debug_log, "\n" );
1221
1222     for( state=1 ; state < next_alloc ; state += trie->uniquecharcount ) {
1223
1224         PerlIO_printf( Perl_debug_log, "%*s%4"UVXf" : ", 
1225             (int)depth * 2 + 2,"",
1226             (UV)TRIE_NODENUM( state ) );
1227
1228         for( charid = 0 ; charid < trie->uniquecharcount ; charid++ ) {
1229             UV v=(UV)SAFE_TRIE_NODENUM( trie->trans[ state + charid ].next );
1230             if (v)
1231                 PerlIO_printf( Perl_debug_log, "%*"UVXf, colwidth, v );
1232             else
1233                 PerlIO_printf( Perl_debug_log, "%*s", colwidth, "." );
1234         }
1235         if ( ! trie->states[ TRIE_NODENUM( state ) ].wordnum ) {
1236             PerlIO_printf( Perl_debug_log, " (%4"UVXf")\n", (UV)trie->trans[ state ].check );
1237         } else {
1238             PerlIO_printf( Perl_debug_log, " (%4"UVXf") W%4X\n", (UV)trie->trans[ state ].check,
1239             trie->states[ TRIE_NODENUM( state ) ].wordnum );
1240         }
1241     }
1242 }
1243
1244 #endif
1245
1246
1247 /* make_trie(startbranch,first,last,tail,word_count,flags,depth)
1248   startbranch: the first branch in the whole branch sequence
1249   first      : start branch of sequence of branch-exact nodes.
1250                May be the same as startbranch
1251   last       : Thing following the last branch.
1252                May be the same as tail.
1253   tail       : item following the branch sequence
1254   count      : words in the sequence
1255   flags      : currently the OP() type we will be building one of /EXACT(|F|Fl)/
1256   depth      : indent depth
1257
1258 Inplace optimizes a sequence of 2 or more Branch-Exact nodes into a TRIE node.
1259
1260 A trie is an N'ary tree where the branches are determined by digital
1261 decomposition of the key. IE, at the root node you look up the 1st character and
1262 follow that branch repeat until you find the end of the branches. Nodes can be
1263 marked as "accepting" meaning they represent a complete word. Eg:
1264
1265   /he|she|his|hers/
1266
1267 would convert into the following structure. Numbers represent states, letters
1268 following numbers represent valid transitions on the letter from that state, if
1269 the number is in square brackets it represents an accepting state, otherwise it
1270 will be in parenthesis.
1271
1272       +-h->+-e->[3]-+-r->(8)-+-s->[9]
1273       |    |
1274       |   (2)
1275       |    |
1276      (1)   +-i->(6)-+-s->[7]
1277       |
1278       +-s->(3)-+-h->(4)-+-e->[5]
1279
1280       Accept Word Mapping: 3=>1 (he),5=>2 (she), 7=>3 (his), 9=>4 (hers)
1281
1282 This shows that when matching against the string 'hers' we will begin at state 1
1283 read 'h' and move to state 2, read 'e' and move to state 3 which is accepting,
1284 then read 'r' and go to state 8 followed by 's' which takes us to state 9 which
1285 is also accepting. Thus we know that we can match both 'he' and 'hers' with a
1286 single traverse. We store a mapping from accepting to state to which word was
1287 matched, and then when we have multiple possibilities we try to complete the
1288 rest of the regex in the order in which they occured in the alternation.
1289
1290 The only prior NFA like behaviour that would be changed by the TRIE support is
1291 the silent ignoring of duplicate alternations which are of the form:
1292
1293  / (DUPE|DUPE) X? (?{ ... }) Y /x
1294
1295 Thus EVAL blocks following a trie may be called a different number of times with
1296 and without the optimisation. With the optimisations dupes will be silently
1297 ignored. This inconsistent behaviour of EVAL type nodes is well established as
1298 the following demonstrates:
1299
1300  'words'=~/(word|word|word)(?{ print $1 })[xyz]/
1301
1302 which prints out 'word' three times, but
1303
1304  'words'=~/(word|word|word)(?{ print $1 })S/
1305
1306 which doesnt print it out at all. This is due to other optimisations kicking in.
1307
1308 Example of what happens on a structural level:
1309
1310 The regexp /(ac|ad|ab)+/ will produce the following debug output:
1311
1312    1: CURLYM[1] {1,32767}(18)
1313    5:   BRANCH(8)
1314    6:     EXACT <ac>(16)
1315    8:   BRANCH(11)
1316    9:     EXACT <ad>(16)
1317   11:   BRANCH(14)
1318   12:     EXACT <ab>(16)
1319   16:   SUCCEED(0)
1320   17:   NOTHING(18)
1321   18: END(0)
1322
1323 This would be optimizable with startbranch=5, first=5, last=16, tail=16
1324 and should turn into:
1325
1326    1: CURLYM[1] {1,32767}(18)
1327    5:   TRIE(16)
1328         [Words:3 Chars Stored:6 Unique Chars:4 States:5 NCP:1]
1329           <ac>
1330           <ad>
1331           <ab>
1332   16:   SUCCEED(0)
1333   17:   NOTHING(18)
1334   18: END(0)
1335
1336 Cases where tail != last would be like /(?foo|bar)baz/:
1337
1338    1: BRANCH(4)
1339    2:   EXACT <foo>(8)
1340    4: BRANCH(7)
1341    5:   EXACT <bar>(8)
1342    7: TAIL(8)
1343    8: EXACT <baz>(10)
1344   10: END(0)
1345
1346 which would be optimizable with startbranch=1, first=1, last=7, tail=8
1347 and would end up looking like:
1348
1349     1: TRIE(8)
1350       [Words:2 Chars Stored:6 Unique Chars:5 States:7 NCP:1]
1351         <foo>
1352         <bar>
1353    7: TAIL(8)
1354    8: EXACT <baz>(10)
1355   10: END(0)
1356
1357     d = uvuni_to_utf8_flags(d, uv, 0);
1358
1359 is the recommended Unicode-aware way of saying
1360
1361     *(d++) = uv;
1362 */
1363
1364 #define TRIE_STORE_REVCHAR                                                 \
1365     STMT_START {                                                           \
1366         if (UTF) {                                                         \
1367             SV *zlopp = newSV(2);                                          \
1368             unsigned char *flrbbbbb = (unsigned char *) SvPVX(zlopp);      \
1369             unsigned const char *const kapow = uvuni_to_utf8(flrbbbbb, uvc & 0xFF); \
1370             SvCUR_set(zlopp, kapow - flrbbbbb);                            \
1371             SvPOK_on(zlopp);                                               \
1372             SvUTF8_on(zlopp);                                              \
1373             av_push(revcharmap, zlopp);                                    \
1374         } else {                                                           \
1375             char ooooff = (char)uvc;                                               \
1376             av_push(revcharmap, newSVpvn(&ooooff, 1));                     \
1377         }                                                                  \
1378         } STMT_END
1379
1380 #define TRIE_READ_CHAR STMT_START {                                           \
1381     wordlen++;                                                                \
1382     if ( UTF ) {                                                              \
1383         if ( folder ) {                                                       \
1384             if ( foldlen > 0 ) {                                              \
1385                uvc = utf8n_to_uvuni( scan, UTF8_MAXLEN, &len, uniflags );     \
1386                foldlen -= len;                                                \
1387                scan += len;                                                   \
1388                len = 0;                                                       \
1389             } else {                                                          \
1390                 uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1391                 uvc = to_uni_fold( uvc, foldbuf, &foldlen );                  \
1392                 foldlen -= UNISKIP( uvc );                                    \
1393                 scan = foldbuf + UNISKIP( uvc );                              \
1394             }                                                                 \
1395         } else {                                                              \
1396             uvc = utf8n_to_uvuni( (const U8*)uc, UTF8_MAXLEN, &len, uniflags);\
1397         }                                                                     \
1398     } else {                                                                  \
1399         uvc = (U32)*uc;                                                       \
1400         len = 1;                                                              \
1401     }                                                                         \
1402 } STMT_END
1403
1404
1405
1406 #define TRIE_LIST_PUSH(state,fid,ns) STMT_START {               \
1407     if ( TRIE_LIST_CUR( state ) >=TRIE_LIST_LEN( state ) ) {    \
1408         U32 ging = TRIE_LIST_LEN( state ) *= 2;                 \
1409         Renew( trie->states[ state ].trans.list, ging, reg_trie_trans_le ); \
1410     }                                                           \
1411     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).forid = fid;     \
1412     TRIE_LIST_ITEM( state, TRIE_LIST_CUR( state ) ).newstate = ns;   \
1413     TRIE_LIST_CUR( state )++;                                   \
1414 } STMT_END
1415
1416 #define TRIE_LIST_NEW(state) STMT_START {                       \
1417     Newxz( trie->states[ state ].trans.list,               \
1418         4, reg_trie_trans_le );                                 \
1419      TRIE_LIST_CUR( state ) = 1;                                \
1420      TRIE_LIST_LEN( state ) = 4;                                \
1421 } STMT_END
1422
1423 #define TRIE_HANDLE_WORD(state) STMT_START {                    \
1424     U16 dupe= trie->states[ state ].wordnum;                    \
1425     regnode * const noper_next = regnext( noper );              \
1426                                                                 \
1427     DEBUG_r({                                                   \
1428         /* store the word for dumping */                        \
1429         SV* tmp;                                                \
1430         if (OP(noper) != NOTHING)                               \
1431             tmp = newSVpvn_utf8(STRING(noper), STR_LEN(noper), UTF);    \
1432         else                                                    \
1433             tmp = newSVpvn_utf8( "", 0, UTF );                  \
1434         av_push( trie_words, tmp );                             \
1435     });                                                         \
1436                                                                 \
1437     curword++;                                                  \
1438     trie->wordinfo[curword].prev   = 0;                         \
1439     trie->wordinfo[curword].len    = wordlen;                   \
1440     trie->wordinfo[curword].accept = state;                     \
1441                                                                 \
1442     if ( noper_next < tail ) {                                  \
1443         if (!trie->jump)                                        \
1444             trie->jump = (U16 *) PerlMemShared_calloc( word_count + 1, sizeof(U16) ); \
1445         trie->jump[curword] = (U16)(noper_next - convert);      \
1446         if (!jumper)                                            \
1447             jumper = noper_next;                                \
1448         if (!nextbranch)                                        \
1449             nextbranch= regnext(cur);                           \
1450     }                                                           \
1451                                                                 \
1452     if ( dupe ) {                                               \
1453         /* It's a dupe. Pre-insert into the wordinfo[].prev   */\
1454         /* chain, so that when the bits of chain are later    */\
1455         /* linked together, the dups appear in the chain      */\
1456         trie->wordinfo[curword].prev = trie->wordinfo[dupe].prev; \
1457         trie->wordinfo[dupe].prev = curword;                    \
1458     } else {                                                    \
1459         /* we haven't inserted this word yet.                */ \
1460         trie->states[ state ].wordnum = curword;                \
1461     }                                                           \
1462 } STMT_END
1463
1464
1465 #define TRIE_TRANS_STATE(state,base,ucharcount,charid,special)          \
1466      ( ( base + charid >=  ucharcount                                   \
1467          && base + charid < ubound                                      \
1468          && state == trie->trans[ base - ucharcount + charid ].check    \
1469          && trie->trans[ base - ucharcount + charid ].next )            \
1470            ? trie->trans[ base - ucharcount + charid ].next             \
1471            : ( state==1 ? special : 0 )                                 \
1472       )
1473
1474 #define MADE_TRIE       1
1475 #define MADE_JUMP_TRIE  2
1476 #define MADE_EXACT_TRIE 4
1477
1478 STATIC I32
1479 S_make_trie(pTHX_ RExC_state_t *pRExC_state, regnode *startbranch, regnode *first, regnode *last, regnode *tail, U32 word_count, U32 flags, U32 depth)
1480 {
1481     dVAR;
1482     /* first pass, loop through and scan words */
1483     reg_trie_data *trie;
1484     HV *widecharmap = NULL;
1485     AV *revcharmap = newAV();
1486     regnode *cur;
1487     const U32 uniflags = UTF8_ALLOW_DEFAULT;
1488     STRLEN len = 0;
1489     UV uvc = 0;
1490     U16 curword = 0;
1491     U32 next_alloc = 0;
1492     regnode *jumper = NULL;
1493     regnode *nextbranch = NULL;
1494     regnode *convert = NULL;
1495     U32 *prev_states; /* temp array mapping each state to previous one */
1496     /* we just use folder as a flag in utf8 */
1497     const U8 * folder = NULL;
1498
1499 #ifdef DEBUGGING
1500     const U32 data_slot = add_data( pRExC_state, 4, "tuuu" );
1501     AV *trie_words = NULL;
1502     /* along with revcharmap, this only used during construction but both are
1503      * useful during debugging so we store them in the struct when debugging.
1504      */
1505 #else
1506     const U32 data_slot = add_data( pRExC_state, 2, "tu" );
1507     STRLEN trie_charcount=0;
1508 #endif
1509     SV *re_trie_maxbuff;
1510     GET_RE_DEBUG_FLAGS_DECL;
1511
1512     PERL_ARGS_ASSERT_MAKE_TRIE;
1513 #ifndef DEBUGGING
1514     PERL_UNUSED_ARG(depth);
1515 #endif
1516
1517     switch (flags) {
1518         case EXACTFA:
1519         case EXACTFU: folder = PL_fold_latin1; break;
1520         case EXACTF:  folder = PL_fold; break;
1521         case EXACTFL: folder = PL_fold_locale; break;
1522     }
1523
1524     trie = (reg_trie_data *) PerlMemShared_calloc( 1, sizeof(reg_trie_data) );
1525     trie->refcount = 1;
1526     trie->startstate = 1;
1527     trie->wordcount = word_count;
1528     RExC_rxi->data->data[ data_slot ] = (void*)trie;
1529     trie->charmap = (U16 *) PerlMemShared_calloc( 256, sizeof(U16) );
1530     if (!(UTF && folder))
1531         trie->bitmap = (char *) PerlMemShared_calloc( ANYOF_BITMAP_SIZE, 1 );
1532     trie->wordinfo = (reg_trie_wordinfo *) PerlMemShared_calloc(
1533                        trie->wordcount+1, sizeof(reg_trie_wordinfo));
1534
1535     DEBUG_r({
1536         trie_words = newAV();
1537     });
1538
1539     re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
1540     if (!SvIOK(re_trie_maxbuff)) {
1541         sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
1542     }
1543     DEBUG_OPTIMISE_r({
1544                 PerlIO_printf( Perl_debug_log,
1545                   "%*smake_trie start==%d, first==%d, last==%d, tail==%d depth=%d\n",
1546                   (int)depth * 2 + 2, "", 
1547                   REG_NODE_NUM(startbranch),REG_NODE_NUM(first), 
1548                   REG_NODE_NUM(last), REG_NODE_NUM(tail),
1549                   (int)depth);
1550     });
1551    
1552    /* Find the node we are going to overwrite */
1553     if ( first == startbranch && OP( last ) != BRANCH ) {
1554         /* whole branch chain */
1555         convert = first;
1556     } else {
1557         /* branch sub-chain */
1558         convert = NEXTOPER( first );
1559     }
1560         
1561     /*  -- First loop and Setup --
1562
1563        We first traverse the branches and scan each word to determine if it
1564        contains widechars, and how many unique chars there are, this is
1565        important as we have to build a table with at least as many columns as we
1566        have unique chars.
1567
1568        We use an array of integers to represent the character codes 0..255
1569        (trie->charmap) and we use a an HV* to store Unicode characters. We use the
1570        native representation of the character value as the key and IV's for the
1571        coded index.
1572
1573        *TODO* If we keep track of how many times each character is used we can
1574        remap the columns so that the table compression later on is more
1575        efficient in terms of memory by ensuring the most common value is in the
1576        middle and the least common are on the outside.  IMO this would be better
1577        than a most to least common mapping as theres a decent chance the most
1578        common letter will share a node with the least common, meaning the node
1579        will not be compressible. With a middle is most common approach the worst
1580        case is when we have the least common nodes twice.
1581
1582      */
1583
1584     for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1585         regnode * const noper = NEXTOPER( cur );
1586         const U8 *uc = (U8*)STRING( noper );
1587         const U8 * const e  = uc + STR_LEN( noper );
1588         STRLEN foldlen = 0;
1589         U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1590         const U8 *scan = (U8*)NULL;
1591         U32 wordlen      = 0;         /* required init */
1592         STRLEN chars = 0;
1593         bool set_bit = trie->bitmap ? 1 : 0; /*store the first char in the bitmap?*/
1594
1595         if (OP(noper) == NOTHING) {
1596             trie->minlen= 0;
1597             continue;
1598         }
1599         if ( set_bit ) /* bitmap only alloced when !(UTF&&Folding) */
1600             TRIE_BITMAP_SET(trie,*uc); /* store the raw first byte
1601                                           regardless of encoding */
1602
1603         for ( ; uc < e ; uc += len ) {
1604             TRIE_CHARCOUNT(trie)++;
1605             TRIE_READ_CHAR;
1606             chars++;
1607             if ( uvc < 256 ) {
1608                 if ( !trie->charmap[ uvc ] ) {
1609                     trie->charmap[ uvc ]=( ++trie->uniquecharcount );
1610                     if ( folder )
1611                         trie->charmap[ folder[ uvc ] ] = trie->charmap[ uvc ];
1612                     TRIE_STORE_REVCHAR;
1613                 }
1614                 if ( set_bit ) {
1615                     /* store the codepoint in the bitmap, and its folded
1616                      * equivalent. */
1617                     TRIE_BITMAP_SET(trie,uvc);
1618
1619                     /* store the folded codepoint */
1620                     if ( folder ) TRIE_BITMAP_SET(trie,folder[ uvc ]);
1621
1622                     if ( !UTF ) {
1623                         /* store first byte of utf8 representation of
1624                            variant codepoints */
1625                         if (! UNI_IS_INVARIANT(uvc)) {
1626                             TRIE_BITMAP_SET(trie, UTF8_TWO_BYTE_HI(uvc));
1627                         }
1628                     }
1629                     set_bit = 0; /* We've done our bit :-) */
1630                 }
1631             } else {
1632                 SV** svpp;
1633                 if ( !widecharmap )
1634                     widecharmap = newHV();
1635
1636                 svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 1 );
1637
1638                 if ( !svpp )
1639                     Perl_croak( aTHX_ "error creating/fetching widecharmap entry for 0x%"UVXf, uvc );
1640
1641                 if ( !SvTRUE( *svpp ) ) {
1642                     sv_setiv( *svpp, ++trie->uniquecharcount );
1643                     TRIE_STORE_REVCHAR;
1644                 }
1645             }
1646         }
1647         if( cur == first ) {
1648             trie->minlen=chars;
1649             trie->maxlen=chars;
1650         } else if (chars < trie->minlen) {
1651             trie->minlen=chars;
1652         } else if (chars > trie->maxlen) {
1653             trie->maxlen=chars;
1654         }
1655
1656     } /* end first pass */
1657     DEBUG_TRIE_COMPILE_r(
1658         PerlIO_printf( Perl_debug_log, "%*sTRIE(%s): W:%d C:%d Uq:%d Min:%d Max:%d\n",
1659                 (int)depth * 2 + 2,"",
1660                 ( widecharmap ? "UTF8" : "NATIVE" ), (int)word_count,
1661                 (int)TRIE_CHARCOUNT(trie), trie->uniquecharcount,
1662                 (int)trie->minlen, (int)trie->maxlen )
1663     );
1664
1665     /*
1666         We now know what we are dealing with in terms of unique chars and
1667         string sizes so we can calculate how much memory a naive
1668         representation using a flat table  will take. If it's over a reasonable
1669         limit (as specified by ${^RE_TRIE_MAXBUF}) we use a more memory
1670         conservative but potentially much slower representation using an array
1671         of lists.
1672
1673         At the end we convert both representations into the same compressed
1674         form that will be used in regexec.c for matching with. The latter
1675         is a form that cannot be used to construct with but has memory
1676         properties similar to the list form and access properties similar
1677         to the table form making it both suitable for fast searches and
1678         small enough that its feasable to store for the duration of a program.
1679
1680         See the comment in the code where the compressed table is produced
1681         inplace from the flat tabe representation for an explanation of how
1682         the compression works.
1683
1684     */
1685
1686
1687     Newx(prev_states, TRIE_CHARCOUNT(trie) + 2, U32);
1688     prev_states[1] = 0;
1689
1690     if ( (IV)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1) > SvIV(re_trie_maxbuff) ) {
1691         /*
1692             Second Pass -- Array Of Lists Representation
1693
1694             Each state will be represented by a list of charid:state records
1695             (reg_trie_trans_le) the first such element holds the CUR and LEN
1696             points of the allocated array. (See defines above).
1697
1698             We build the initial structure using the lists, and then convert
1699             it into the compressed table form which allows faster lookups
1700             (but cant be modified once converted).
1701         */
1702
1703         STRLEN transcount = 1;
1704
1705         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1706             "%*sCompiling trie using list compiler\n",
1707             (int)depth * 2 + 2, ""));
1708         
1709         trie->states = (reg_trie_state *)
1710             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1711                                   sizeof(reg_trie_state) );
1712         TRIE_LIST_NEW(1);
1713         next_alloc = 2;
1714
1715         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1716
1717             regnode * const noper = NEXTOPER( cur );
1718             U8 *uc           = (U8*)STRING( noper );
1719             const U8 * const e = uc + STR_LEN( noper );
1720             U32 state        = 1;         /* required init */
1721             U16 charid       = 0;         /* sanity init */
1722             U8 *scan         = (U8*)NULL; /* sanity init */
1723             STRLEN foldlen   = 0;         /* required init */
1724             U32 wordlen      = 0;         /* required init */
1725             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1726
1727             if (OP(noper) != NOTHING) {
1728                 for ( ; uc < e ; uc += len ) {
1729
1730                     TRIE_READ_CHAR;
1731
1732                     if ( uvc < 256 ) {
1733                         charid = trie->charmap[ uvc ];
1734                     } else {
1735                         SV** const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1736                         if ( !svpp ) {
1737                             charid = 0;
1738                         } else {
1739                             charid=(U16)SvIV( *svpp );
1740                         }
1741                     }
1742                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1743                     if ( charid ) {
1744
1745                         U16 check;
1746                         U32 newstate = 0;
1747
1748                         charid--;
1749                         if ( !trie->states[ state ].trans.list ) {
1750                             TRIE_LIST_NEW( state );
1751                         }
1752                         for ( check = 1; check <= TRIE_LIST_USED( state ); check++ ) {
1753                             if ( TRIE_LIST_ITEM( state, check ).forid == charid ) {
1754                                 newstate = TRIE_LIST_ITEM( state, check ).newstate;
1755                                 break;
1756                             }
1757                         }
1758                         if ( ! newstate ) {
1759                             newstate = next_alloc++;
1760                             prev_states[newstate] = state;
1761                             TRIE_LIST_PUSH( state, charid, newstate );
1762                             transcount++;
1763                         }
1764                         state = newstate;
1765                     } else {
1766                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1767                     }
1768                 }
1769             }
1770             TRIE_HANDLE_WORD(state);
1771
1772         } /* end second pass */
1773
1774         /* next alloc is the NEXT state to be allocated */
1775         trie->statecount = next_alloc; 
1776         trie->states = (reg_trie_state *)
1777             PerlMemShared_realloc( trie->states,
1778                                    next_alloc
1779                                    * sizeof(reg_trie_state) );
1780
1781         /* and now dump it out before we compress it */
1782         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_list(trie, widecharmap,
1783                                                          revcharmap, next_alloc,
1784                                                          depth+1)
1785         );
1786
1787         trie->trans = (reg_trie_trans *)
1788             PerlMemShared_calloc( transcount, sizeof(reg_trie_trans) );
1789         {
1790             U32 state;
1791             U32 tp = 0;
1792             U32 zp = 0;
1793
1794
1795             for( state=1 ; state < next_alloc ; state ++ ) {
1796                 U32 base=0;
1797
1798                 /*
1799                 DEBUG_TRIE_COMPILE_MORE_r(
1800                     PerlIO_printf( Perl_debug_log, "tp: %d zp: %d ",tp,zp)
1801                 );
1802                 */
1803
1804                 if (trie->states[state].trans.list) {
1805                     U16 minid=TRIE_LIST_ITEM( state, 1).forid;
1806                     U16 maxid=minid;
1807                     U16 idx;
1808
1809                     for( idx = 2 ; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1810                         const U16 forid = TRIE_LIST_ITEM( state, idx).forid;
1811                         if ( forid < minid ) {
1812                             minid=forid;
1813                         } else if ( forid > maxid ) {
1814                             maxid=forid;
1815                         }
1816                     }
1817                     if ( transcount < tp + maxid - minid + 1) {
1818                         transcount *= 2;
1819                         trie->trans = (reg_trie_trans *)
1820                             PerlMemShared_realloc( trie->trans,
1821                                                      transcount
1822                                                      * sizeof(reg_trie_trans) );
1823                         Zero( trie->trans + (transcount / 2), transcount / 2 , reg_trie_trans );
1824                     }
1825                     base = trie->uniquecharcount + tp - minid;
1826                     if ( maxid == minid ) {
1827                         U32 set = 0;
1828                         for ( ; zp < tp ; zp++ ) {
1829                             if ( ! trie->trans[ zp ].next ) {
1830                                 base = trie->uniquecharcount + zp - minid;
1831                                 trie->trans[ zp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1832                                 trie->trans[ zp ].check = state;
1833                                 set = 1;
1834                                 break;
1835                             }
1836                         }
1837                         if ( !set ) {
1838                             trie->trans[ tp ].next = TRIE_LIST_ITEM( state, 1).newstate;
1839                             trie->trans[ tp ].check = state;
1840                             tp++;
1841                             zp = tp;
1842                         }
1843                     } else {
1844                         for ( idx=1; idx <= TRIE_LIST_USED( state ) ; idx++ ) {
1845                             const U32 tid = base -  trie->uniquecharcount + TRIE_LIST_ITEM( state, idx ).forid;
1846                             trie->trans[ tid ].next = TRIE_LIST_ITEM( state, idx ).newstate;
1847                             trie->trans[ tid ].check = state;
1848                         }
1849                         tp += ( maxid - minid + 1 );
1850                     }
1851                     Safefree(trie->states[ state ].trans.list);
1852                 }
1853                 /*
1854                 DEBUG_TRIE_COMPILE_MORE_r(
1855                     PerlIO_printf( Perl_debug_log, " base: %d\n",base);
1856                 );
1857                 */
1858                 trie->states[ state ].trans.base=base;
1859             }
1860             trie->lasttrans = tp + 1;
1861         }
1862     } else {
1863         /*
1864            Second Pass -- Flat Table Representation.
1865
1866            we dont use the 0 slot of either trans[] or states[] so we add 1 to each.
1867            We know that we will need Charcount+1 trans at most to store the data
1868            (one row per char at worst case) So we preallocate both structures
1869            assuming worst case.
1870
1871            We then construct the trie using only the .next slots of the entry
1872            structs.
1873
1874            We use the .check field of the first entry of the node temporarily to
1875            make compression both faster and easier by keeping track of how many non
1876            zero fields are in the node.
1877
1878            Since trans are numbered from 1 any 0 pointer in the table is a FAIL
1879            transition.
1880
1881            There are two terms at use here: state as a TRIE_NODEIDX() which is a
1882            number representing the first entry of the node, and state as a
1883            TRIE_NODENUM() which is the trans number. state 1 is TRIE_NODEIDX(1) and
1884            TRIE_NODENUM(1), state 2 is TRIE_NODEIDX(2) and TRIE_NODENUM(3) if there
1885            are 2 entrys per node. eg:
1886
1887              A B       A B
1888           1. 2 4    1. 3 7
1889           2. 0 3    3. 0 5
1890           3. 0 0    5. 0 0
1891           4. 0 0    7. 0 0
1892
1893            The table is internally in the right hand, idx form. However as we also
1894            have to deal with the states array which is indexed by nodenum we have to
1895            use TRIE_NODENUM() to convert.
1896
1897         */
1898         DEBUG_TRIE_COMPILE_MORE_r( PerlIO_printf( Perl_debug_log, 
1899             "%*sCompiling trie using table compiler\n",
1900             (int)depth * 2 + 2, ""));
1901
1902         trie->trans = (reg_trie_trans *)
1903             PerlMemShared_calloc( ( TRIE_CHARCOUNT(trie) + 1 )
1904                                   * trie->uniquecharcount + 1,
1905                                   sizeof(reg_trie_trans) );
1906         trie->states = (reg_trie_state *)
1907             PerlMemShared_calloc( TRIE_CHARCOUNT(trie) + 2,
1908                                   sizeof(reg_trie_state) );
1909         next_alloc = trie->uniquecharcount + 1;
1910
1911
1912         for ( cur = first ; cur < last ; cur = regnext( cur ) ) {
1913
1914             regnode * const noper   = NEXTOPER( cur );
1915             const U8 *uc     = (U8*)STRING( noper );
1916             const U8 * const e = uc + STR_LEN( noper );
1917
1918             U32 state        = 1;         /* required init */
1919
1920             U16 charid       = 0;         /* sanity init */
1921             U32 accept_state = 0;         /* sanity init */
1922             U8 *scan         = (U8*)NULL; /* sanity init */
1923
1924             STRLEN foldlen   = 0;         /* required init */
1925             U32 wordlen      = 0;         /* required init */
1926             U8 foldbuf[ UTF8_MAXBYTES_CASE + 1 ];
1927
1928             if ( OP(noper) != NOTHING ) {
1929                 for ( ; uc < e ; uc += len ) {
1930
1931                     TRIE_READ_CHAR;
1932
1933                     if ( uvc < 256 ) {
1934                         charid = trie->charmap[ uvc ];
1935                     } else {
1936                         SV* const * const svpp = hv_fetch( widecharmap, (char*)&uvc, sizeof( UV ), 0);
1937                         charid = svpp ? (U16)SvIV(*svpp) : 0;
1938                     }
1939                     if ( charid ) {
1940                         charid--;
1941                         if ( !trie->trans[ state + charid ].next ) {
1942                             trie->trans[ state + charid ].next = next_alloc;
1943                             trie->trans[ state ].check++;
1944                             prev_states[TRIE_NODENUM(next_alloc)]
1945                                     = TRIE_NODENUM(state);
1946                             next_alloc += trie->uniquecharcount;
1947                         }
1948                         state = trie->trans[ state + charid ].next;
1949                     } else {
1950                         Perl_croak( aTHX_ "panic! In trie construction, no char mapping for %"IVdf, uvc );
1951                     }
1952                     /* charid is now 0 if we dont know the char read, or nonzero if we do */
1953                 }
1954             }
1955             accept_state = TRIE_NODENUM( state );
1956             TRIE_HANDLE_WORD(accept_state);
1957
1958         } /* end second pass */
1959
1960         /* and now dump it out before we compress it */
1961         DEBUG_TRIE_COMPILE_MORE_r(dump_trie_interim_table(trie, widecharmap,
1962                                                           revcharmap,
1963                                                           next_alloc, depth+1));
1964
1965         {
1966         /*
1967            * Inplace compress the table.*
1968
1969            For sparse data sets the table constructed by the trie algorithm will
1970            be mostly 0/FAIL transitions or to put it another way mostly empty.
1971            (Note that leaf nodes will not contain any transitions.)
1972
1973            This algorithm compresses the tables by eliminating most such
1974            transitions, at the cost of a modest bit of extra work during lookup:
1975
1976            - Each states[] entry contains a .base field which indicates the
1977            index in the state[] array wheres its transition data is stored.
1978
1979            - If .base is 0 there are no valid transitions from that node.
1980
1981            - If .base is nonzero then charid is added to it to find an entry in
1982            the trans array.
1983
1984            -If trans[states[state].base+charid].check!=state then the
1985            transition is taken to be a 0/Fail transition. Thus if there are fail
1986            transitions at the front of the node then the .base offset will point
1987            somewhere inside the previous nodes data (or maybe even into a node
1988            even earlier), but the .check field determines if the transition is
1989            valid.
1990
1991            XXX - wrong maybe?
1992            The following process inplace converts the table to the compressed
1993            table: We first do not compress the root node 1,and mark all its
1994            .check pointers as 1 and set its .base pointer as 1 as well. This
1995            allows us to do a DFA construction from the compressed table later,
1996            and ensures that any .base pointers we calculate later are greater
1997            than 0.
1998
1999            - We set 'pos' to indicate the first entry of the second node.
2000
2001            - We then iterate over the columns of the node, finding the first and
2002            last used entry at l and m. We then copy l..m into pos..(pos+m-l),
2003            and set the .check pointers accordingly, and advance pos
2004            appropriately and repreat for the next node. Note that when we copy
2005            the next pointers we have to convert them from the original
2006            NODEIDX form to NODENUM form as the former is not valid post
2007            compression.
2008
2009            - If a node has no transitions used we mark its base as 0 and do not
2010            advance the pos pointer.
2011
2012            - If a node only has one transition we use a second pointer into the
2013            structure to fill in allocated fail transitions from other states.
2014            This pointer is independent of the main pointer and scans forward
2015            looking for null transitions that are allocated to a state. When it
2016            finds one it writes the single transition into the "hole".  If the
2017            pointer doesnt find one the single transition is appended as normal.
2018
2019            - Once compressed we can Renew/realloc the structures to release the
2020            excess space.
2021
2022            See "Table-Compression Methods" in sec 3.9 of the Red Dragon,
2023            specifically Fig 3.47 and the associated pseudocode.
2024
2025            demq
2026         */
2027         const U32 laststate = TRIE_NODENUM( next_alloc );
2028         U32 state, charid;
2029         U32 pos = 0, zp=0;
2030         trie->statecount = laststate;
2031
2032         for ( state = 1 ; state < laststate ; state++ ) {
2033             U8 flag = 0;
2034             const U32 stateidx = TRIE_NODEIDX( state );
2035             const U32 o_used = trie->trans[ stateidx ].check;
2036             U32 used = trie->trans[ stateidx ].check;
2037             trie->trans[ stateidx ].check = 0;
2038
2039             for ( charid = 0 ; used && charid < trie->uniquecharcount ; charid++ ) {
2040                 if ( flag || trie->trans[ stateidx + charid ].next ) {
2041                     if ( trie->trans[ stateidx + charid ].next ) {
2042                         if (o_used == 1) {
2043                             for ( ; zp < pos ; zp++ ) {
2044                                 if ( ! trie->trans[ zp ].next ) {
2045                                     break;
2046                                 }
2047                             }
2048                             trie->states[ state ].trans.base = zp + trie->uniquecharcount - charid ;
2049                             trie->trans[ zp ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2050                             trie->trans[ zp ].check = state;
2051                             if ( ++zp > pos ) pos = zp;
2052                             break;
2053                         }
2054                         used--;
2055                     }
2056                     if ( !flag ) {
2057                         flag = 1;
2058                         trie->states[ state ].trans.base = pos + trie->uniquecharcount - charid ;
2059                     }
2060                     trie->trans[ pos ].next = SAFE_TRIE_NODENUM( trie->trans[ stateidx + charid ].next );
2061                     trie->trans[ pos ].check = state;
2062                     pos++;
2063                 }
2064             }
2065         }
2066         trie->lasttrans = pos + 1;
2067         trie->states = (reg_trie_state *)
2068             PerlMemShared_realloc( trie->states, laststate
2069                                    * sizeof(reg_trie_state) );
2070         DEBUG_TRIE_COMPILE_MORE_r(
2071                 PerlIO_printf( Perl_debug_log,
2072                     "%*sAlloc: %d Orig: %"IVdf" elements, Final:%"IVdf". Savings of %%%5.2f\n",
2073                     (int)depth * 2 + 2,"",
2074                     (int)( ( TRIE_CHARCOUNT(trie) + 1 ) * trie->uniquecharcount + 1 ),
2075                     (IV)next_alloc,
2076                     (IV)pos,
2077                     ( ( next_alloc - pos ) * 100 ) / (double)next_alloc );
2078             );
2079
2080         } /* end table compress */
2081     }
2082     DEBUG_TRIE_COMPILE_MORE_r(
2083             PerlIO_printf(Perl_debug_log, "%*sStatecount:%"UVxf" Lasttrans:%"UVxf"\n",
2084                 (int)depth * 2 + 2, "",
2085                 (UV)trie->statecount,
2086                 (UV)trie->lasttrans)
2087     );
2088     /* resize the trans array to remove unused space */
2089     trie->trans = (reg_trie_trans *)
2090         PerlMemShared_realloc( trie->trans, trie->lasttrans
2091                                * sizeof(reg_trie_trans) );
2092
2093     {   /* Modify the program and insert the new TRIE node */ 
2094         U8 nodetype =(U8)(flags & 0xFF);
2095         char *str=NULL;
2096         
2097 #ifdef DEBUGGING
2098         regnode *optimize = NULL;
2099 #ifdef RE_TRACK_PATTERN_OFFSETS
2100
2101         U32 mjd_offset = 0;
2102         U32 mjd_nodelen = 0;
2103 #endif /* RE_TRACK_PATTERN_OFFSETS */
2104 #endif /* DEBUGGING */
2105         /*
2106            This means we convert either the first branch or the first Exact,
2107            depending on whether the thing following (in 'last') is a branch
2108            or not and whther first is the startbranch (ie is it a sub part of
2109            the alternation or is it the whole thing.)
2110            Assuming its a sub part we convert the EXACT otherwise we convert
2111            the whole branch sequence, including the first.
2112          */
2113         /* Find the node we are going to overwrite */
2114         if ( first != startbranch || OP( last ) == BRANCH ) {
2115             /* branch sub-chain */
2116             NEXT_OFF( first ) = (U16)(last - first);
2117 #ifdef RE_TRACK_PATTERN_OFFSETS
2118             DEBUG_r({
2119                 mjd_offset= Node_Offset((convert));
2120                 mjd_nodelen= Node_Length((convert));
2121             });
2122 #endif
2123             /* whole branch chain */
2124         }
2125 #ifdef RE_TRACK_PATTERN_OFFSETS
2126         else {
2127             DEBUG_r({
2128                 const  regnode *nop = NEXTOPER( convert );
2129                 mjd_offset= Node_Offset((nop));
2130                 mjd_nodelen= Node_Length((nop));
2131             });
2132         }
2133         DEBUG_OPTIMISE_r(
2134             PerlIO_printf(Perl_debug_log, "%*sMJD offset:%"UVuf" MJD length:%"UVuf"\n",
2135                 (int)depth * 2 + 2, "",
2136                 (UV)mjd_offset, (UV)mjd_nodelen)
2137         );
2138 #endif
2139         /* But first we check to see if there is a common prefix we can 
2140            split out as an EXACT and put in front of the TRIE node.  */
2141         trie->startstate= 1;
2142         if ( trie->bitmap && !widecharmap && !trie->jump  ) {
2143             U32 state;
2144             for ( state = 1 ; state < trie->statecount-1 ; state++ ) {
2145                 U32 ofs = 0;
2146                 I32 idx = -1;
2147                 U32 count = 0;
2148                 const U32 base = trie->states[ state ].trans.base;
2149
2150                 if ( trie->states[state].wordnum )
2151                         count = 1;
2152
2153                 for ( ofs = 0 ; ofs < trie->uniquecharcount ; ofs++ ) {
2154                     if ( ( base + ofs >= trie->uniquecharcount ) &&
2155                          ( base + ofs - trie->uniquecharcount < trie->lasttrans ) &&
2156                          trie->trans[ base + ofs - trie->uniquecharcount ].check == state )
2157                     {
2158                         if ( ++count > 1 ) {
2159                             SV **tmp = av_fetch( revcharmap, ofs, 0);
2160                             const U8 *ch = (U8*)SvPV_nolen_const( *tmp );
2161                             if ( state == 1 ) break;
2162                             if ( count == 2 ) {
2163                                 Zero(trie->bitmap, ANYOF_BITMAP_SIZE, char);
2164                                 DEBUG_OPTIMISE_r(
2165                                     PerlIO_printf(Perl_debug_log,
2166                                         "%*sNew Start State=%"UVuf" Class: [",
2167                                         (int)depth * 2 + 2, "",
2168                                         (UV)state));
2169                                 if (idx >= 0) {
2170                                     SV ** const tmp = av_fetch( revcharmap, idx, 0);
2171                                     const U8 * const ch = (U8*)SvPV_nolen_const( *tmp );
2172
2173                                     TRIE_BITMAP_SET(trie,*ch);
2174                                     if ( folder )
2175                                         TRIE_BITMAP_SET(trie, folder[ *ch ]);
2176                                     DEBUG_OPTIMISE_r(
2177                                         PerlIO_printf(Perl_debug_log, "%s", (char*)ch)
2178                                     );
2179                                 }
2180                             }
2181                             TRIE_BITMAP_SET(trie,*ch);
2182                             if ( folder )
2183                                 TRIE_BITMAP_SET(trie,folder[ *ch ]);
2184                             DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"%s", ch));
2185                         }
2186                         idx = ofs;
2187                     }
2188                 }
2189                 if ( count == 1 ) {
2190                     SV **tmp = av_fetch( revcharmap, idx, 0);
2191                     STRLEN len;
2192                     char *ch = SvPV( *tmp, len );
2193                     DEBUG_OPTIMISE_r({
2194                         SV *sv=sv_newmortal();
2195                         PerlIO_printf( Perl_debug_log,
2196                             "%*sPrefix State: %"UVuf" Idx:%"UVuf" Char='%s'\n",
2197                             (int)depth * 2 + 2, "",
2198                             (UV)state, (UV)idx, 
2199                             pv_pretty(sv, SvPV_nolen_const(*tmp), SvCUR(*tmp), 6, 
2200                                 PL_colors[0], PL_colors[1],
2201                                 (SvUTF8(*tmp) ? PERL_PV_ESCAPE_UNI : 0) |
2202                                 PERL_PV_ESCAPE_FIRSTCHAR 
2203                             )
2204                         );
2205                     });
2206                     if ( state==1 ) {
2207                         OP( convert ) = nodetype;
2208                         str=STRING(convert);
2209                         STR_LEN(convert)=0;
2210                     }
2211                     STR_LEN(convert) += len;
2212                     while (len--)
2213                         *str++ = *ch++;
2214                 } else {
2215 #ifdef DEBUGGING            
2216                     if (state>1)
2217                         DEBUG_OPTIMISE_r(PerlIO_printf( Perl_debug_log,"]\n"));
2218 #endif
2219                     break;
2220                 }
2221             }
2222             trie->prefixlen = (state-1);
2223             if (str) {
2224                 regnode *n = convert+NODE_SZ_STR(convert);
2225                 NEXT_OFF(convert) = NODE_SZ_STR(convert);
2226                 trie->startstate = state;
2227                 trie->minlen -= (state - 1);
2228                 trie->maxlen -= (state - 1);
2229 #ifdef DEBUGGING
2230                /* At least the UNICOS C compiler choked on this
2231                 * being argument to DEBUG_r(), so let's just have
2232                 * it right here. */
2233                if (
2234 #ifdef PERL_EXT_RE_BUILD
2235                    1
2236 #else
2237                    DEBUG_r_TEST
2238 #endif
2239                    ) {
2240                    regnode *fix = convert;
2241                    U32 word = trie->wordcount;
2242                    mjd_nodelen++;
2243                    Set_Node_Offset_Length(convert, mjd_offset, state - 1);
2244                    while( ++fix < n ) {
2245                        Set_Node_Offset_Length(fix, 0, 0);
2246                    }
2247                    while (word--) {
2248                        SV ** const tmp = av_fetch( trie_words, word, 0 );
2249                        if (tmp) {
2250                            if ( STR_LEN(convert) <= SvCUR(*tmp) )
2251                                sv_chop(*tmp, SvPV_nolen(*tmp) + STR_LEN(convert));
2252                            else
2253                                sv_chop(*tmp, SvPV_nolen(*tmp) + SvCUR(*tmp));
2254                        }
2255                    }
2256                }
2257 #endif
2258                 if (trie->maxlen) {
2259                     convert = n;
2260                 } else {
2261                     NEXT_OFF(convert) = (U16)(tail - convert);
2262                     DEBUG_r(optimize= n);
2263                 }
2264             }
2265         }
2266         if (!jumper) 
2267             jumper = last; 
2268         if ( trie->maxlen ) {
2269             NEXT_OFF( convert ) = (U16)(tail - convert);
2270             ARG_SET( convert, data_slot );
2271             /* Store the offset to the first unabsorbed branch in 
2272                jump[0], which is otherwise unused by the jump logic. 
2273                We use this when dumping a trie and during optimisation. */
2274             if (trie->jump) 
2275                 trie->jump[0] = (U16)(nextbranch - convert);
2276             
2277             /* If the start state is not accepting (meaning there is no empty string/NOTHING)
2278              *   and there is a bitmap
2279              *   and the first "jump target" node we found leaves enough room
2280              * then convert the TRIE node into a TRIEC node, with the bitmap
2281              * embedded inline in the opcode - this is hypothetically faster.
2282              */
2283             if ( !trie->states[trie->startstate].wordnum
2284                  && trie->bitmap
2285                  && ( (char *)jumper - (char *)convert) >= (int)sizeof(struct regnode_charclass) )
2286             {
2287                 OP( convert ) = TRIEC;
2288                 Copy(trie->bitmap, ((struct regnode_charclass *)convert)->bitmap, ANYOF_BITMAP_SIZE, char);
2289                 PerlMemShared_free(trie->bitmap);
2290                 trie->bitmap= NULL;
2291             } else 
2292                 OP( convert ) = TRIE;
2293
2294             /* store the type in the flags */
2295             convert->flags = nodetype;
2296             DEBUG_r({
2297             optimize = convert 
2298                       + NODE_STEP_REGNODE 
2299                       + regarglen[ OP( convert ) ];
2300             });
2301             /* XXX We really should free up the resource in trie now, 
2302                    as we won't use them - (which resources?) dmq */
2303         }
2304         /* needed for dumping*/
2305         DEBUG_r(if (optimize) {
2306             regnode *opt = convert;
2307
2308             while ( ++opt < optimize) {
2309                 Set_Node_Offset_Length(opt,0,0);
2310             }
2311             /* 
2312                 Try to clean up some of the debris left after the 
2313                 optimisation.
2314              */
2315             while( optimize < jumper ) {
2316                 mjd_nodelen += Node_Length((optimize));
2317                 OP( optimize ) = OPTIMIZED;
2318                 Set_Node_Offset_Length(optimize,0,0);
2319                 optimize++;
2320             }
2321             Set_Node_Offset_Length(convert,mjd_offset,mjd_nodelen);
2322         });
2323     } /* end node insert */
2324     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, convert);
2325
2326     /*  Finish populating the prev field of the wordinfo array.  Walk back
2327      *  from each accept state until we find another accept state, and if
2328      *  so, point the first word's .prev field at the second word. If the
2329      *  second already has a .prev field set, stop now. This will be the
2330      *  case either if we've already processed that word's accept state,
2331      *  or that state had multiple words, and the overspill words were
2332      *  already linked up earlier.
2333      */
2334     {
2335         U16 word;
2336         U32 state;
2337         U16 prev;
2338
2339         for (word=1; word <= trie->wordcount; word++) {
2340             prev = 0;
2341             if (trie->wordinfo[word].prev)
2342                 continue;
2343             state = trie->wordinfo[word].accept;
2344             while (state) {
2345                 state = prev_states[state];
2346                 if (!state)
2347                     break;
2348                 prev = trie->states[state].wordnum;
2349                 if (prev)
2350                     break;
2351             }
2352             trie->wordinfo[word].prev = prev;
2353         }
2354         Safefree(prev_states);
2355     }
2356
2357
2358     /* and now dump out the compressed format */
2359     DEBUG_TRIE_COMPILE_r(dump_trie(trie, widecharmap, revcharmap, depth+1));
2360
2361     RExC_rxi->data->data[ data_slot + 1 ] = (void*)widecharmap;
2362 #ifdef DEBUGGING
2363     RExC_rxi->data->data[ data_slot + TRIE_WORDS_OFFSET ] = (void*)trie_words;
2364     RExC_rxi->data->data[ data_slot + 3 ] = (void*)revcharmap;
2365 #else
2366     SvREFCNT_dec(revcharmap);
2367 #endif
2368     return trie->jump 
2369            ? MADE_JUMP_TRIE 
2370            : trie->startstate>1 
2371              ? MADE_EXACT_TRIE 
2372              : MADE_TRIE;
2373 }
2374
2375 STATIC void
2376 S_make_trie_failtable(pTHX_ RExC_state_t *pRExC_state, regnode *source,  regnode *stclass, U32 depth)
2377 {
2378 /* The Trie is constructed and compressed now so we can build a fail array if it's needed
2379
2380    This is basically the Aho-Corasick algorithm. Its from exercise 3.31 and 3.32 in the
2381    "Red Dragon" -- Compilers, principles, techniques, and tools. Aho, Sethi, Ullman 1985/88
2382    ISBN 0-201-10088-6
2383
2384    We find the fail state for each state in the trie, this state is the longest proper
2385    suffix of the current state's 'word' that is also a proper prefix of another word in our
2386    trie. State 1 represents the word '' and is thus the default fail state. This allows
2387    the DFA not to have to restart after its tried and failed a word at a given point, it
2388    simply continues as though it had been matching the other word in the first place.
2389    Consider
2390       'abcdgu'=~/abcdefg|cdgu/
2391    When we get to 'd' we are still matching the first word, we would encounter 'g' which would
2392    fail, which would bring us to the state representing 'd' in the second word where we would
2393    try 'g' and succeed, proceeding to match 'cdgu'.
2394  */
2395  /* add a fail transition */
2396     const U32 trie_offset = ARG(source);
2397     reg_trie_data *trie=(reg_trie_data *)RExC_rxi->data->data[trie_offset];
2398     U32 *q;
2399     const U32 ucharcount = trie->uniquecharcount;
2400     const U32 numstates = trie->statecount;
2401     const U32 ubound = trie->lasttrans + ucharcount;
2402     U32 q_read = 0;
2403     U32 q_write = 0;
2404     U32 charid;
2405     U32 base = trie->states[ 1 ].trans.base;
2406     U32 *fail;
2407     reg_ac_data *aho;
2408     const U32 data_slot = add_data( pRExC_state, 1, "T" );
2409     GET_RE_DEBUG_FLAGS_DECL;
2410
2411     PERL_ARGS_ASSERT_MAKE_TRIE_FAILTABLE;
2412 #ifndef DEBUGGING
2413     PERL_UNUSED_ARG(depth);
2414 #endif
2415
2416
2417     ARG_SET( stclass, data_slot );
2418     aho = (reg_ac_data *) PerlMemShared_calloc( 1, sizeof(reg_ac_data) );
2419     RExC_rxi->data->data[ data_slot ] = (void*)aho;
2420     aho->trie=trie_offset;
2421     aho->states=(reg_trie_state *)PerlMemShared_malloc( numstates * sizeof(reg_trie_state) );
2422     Copy( trie->states, aho->states, numstates, reg_trie_state );
2423     Newxz( q, numstates, U32);
2424     aho->fail = (U32 *) PerlMemShared_calloc( numstates, sizeof(U32) );
2425     aho->refcount = 1;
2426     fail = aho->fail;
2427     /* initialize fail[0..1] to be 1 so that we always have
2428        a valid final fail state */
2429     fail[ 0 ] = fail[ 1 ] = 1;
2430
2431     for ( charid = 0; charid < ucharcount ; charid++ ) {
2432         const U32 newstate = TRIE_TRANS_STATE( 1, base, ucharcount, charid, 0 );
2433         if ( newstate ) {
2434             q[ q_write ] = newstate;
2435             /* set to point at the root */
2436             fail[ q[ q_write++ ] ]=1;
2437         }
2438     }
2439     while ( q_read < q_write) {
2440         const U32 cur = q[ q_read++ % numstates ];
2441         base = trie->states[ cur ].trans.base;
2442
2443         for ( charid = 0 ; charid < ucharcount ; charid++ ) {
2444             const U32 ch_state = TRIE_TRANS_STATE( cur, base, ucharcount, charid, 1 );
2445             if (ch_state) {
2446                 U32 fail_state = cur;
2447                 U32 fail_base;
2448                 do {
2449                     fail_state = fail[ fail_state ];
2450                     fail_base = aho->states[ fail_state ].trans.base;
2451                 } while ( !TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 ) );
2452
2453                 fail_state = TRIE_TRANS_STATE( fail_state, fail_base, ucharcount, charid, 1 );
2454                 fail[ ch_state ] = fail_state;
2455                 if ( !aho->states[ ch_state ].wordnum && aho->states[ fail_state ].wordnum )
2456                 {
2457                         aho->states[ ch_state ].wordnum =  aho->states[ fail_state ].wordnum;
2458                 }
2459                 q[ q_write++ % numstates] = ch_state;
2460             }
2461         }
2462     }
2463     /* restore fail[0..1] to 0 so that we "fall out" of the AC loop
2464        when we fail in state 1, this allows us to use the
2465        charclass scan to find a valid start char. This is based on the principle
2466        that theres a good chance the string being searched contains lots of stuff
2467        that cant be a start char.
2468      */
2469     fail[ 0 ] = fail[ 1 ] = 0;
2470     DEBUG_TRIE_COMPILE_r({
2471         PerlIO_printf(Perl_debug_log,
2472                       "%*sStclass Failtable (%"UVuf" states): 0", 
2473                       (int)(depth * 2), "", (UV)numstates
2474         );
2475         for( q_read=1; q_read<numstates; q_read++ ) {
2476             PerlIO_printf(Perl_debug_log, ", %"UVuf, (UV)fail[q_read]);
2477         }
2478         PerlIO_printf(Perl_debug_log, "\n");
2479     });
2480     Safefree(q);
2481     /*RExC_seen |= REG_SEEN_TRIEDFA;*/
2482 }
2483
2484
2485 /*
2486  * There are strange code-generation bugs caused on sparc64 by gcc-2.95.2.
2487  * These need to be revisited when a newer toolchain becomes available.
2488  */
2489 #if defined(__sparc64__) && defined(__GNUC__)
2490 #   if __GNUC__ < 2 || (__GNUC__ == 2 && __GNUC_MINOR__ < 96)
2491 #       undef  SPARC64_GCC_WORKAROUND
2492 #       define SPARC64_GCC_WORKAROUND 1
2493 #   endif
2494 #endif
2495
2496 #define DEBUG_PEEP(str,scan,depth) \
2497     DEBUG_OPTIMISE_r({if (scan){ \
2498        SV * const mysv=sv_newmortal(); \
2499        regnode *Next = regnext(scan); \
2500        regprop(RExC_rx, mysv, scan); \
2501        PerlIO_printf(Perl_debug_log, "%*s" str ">%3d: %s (%d)\n", \
2502        (int)depth*2, "", REG_NODE_NUM(scan), SvPV_nolen_const(mysv),\
2503        Next ? (REG_NODE_NUM(Next)) : 0 ); \
2504    }});
2505
2506
2507
2508
2509
2510 #define JOIN_EXACT(scan,min,flags) \
2511     if (PL_regkind[OP(scan)] == EXACT) \
2512         join_exact(pRExC_state,(scan),(min),(flags),NULL,depth+1)
2513
2514 STATIC U32
2515 S_join_exact(pTHX_ RExC_state_t *pRExC_state, regnode *scan, I32 *min, U32 flags,regnode *val, U32 depth) {
2516     /* Merge several consecutive EXACTish nodes into one. */
2517     regnode *n = regnext(scan);
2518     U32 stringok = 1;
2519     regnode *next = scan + NODE_SZ_STR(scan);
2520     U32 merged = 0;
2521     U32 stopnow = 0;
2522 #ifdef DEBUGGING
2523     regnode *stop = scan;
2524     GET_RE_DEBUG_FLAGS_DECL;
2525 #else
2526     PERL_UNUSED_ARG(depth);
2527 #endif
2528
2529     PERL_ARGS_ASSERT_JOIN_EXACT;
2530 #ifndef EXPERIMENTAL_INPLACESCAN
2531     PERL_UNUSED_ARG(flags);
2532     PERL_UNUSED_ARG(val);
2533 #endif
2534     DEBUG_PEEP("join",scan,depth);
2535     
2536     /* Skip NOTHING, merge EXACT*. */
2537     while (n &&
2538            ( PL_regkind[OP(n)] == NOTHING ||
2539              (stringok && (OP(n) == OP(scan))))
2540            && NEXT_OFF(n)
2541            && NEXT_OFF(scan) + NEXT_OFF(n) < I16_MAX) {
2542         
2543         if (OP(n) == TAIL || n > next)
2544             stringok = 0;
2545         if (PL_regkind[OP(n)] == NOTHING) {
2546             DEBUG_PEEP("skip:",n,depth);
2547             NEXT_OFF(scan) += NEXT_OFF(n);
2548             next = n + NODE_STEP_REGNODE;
2549 #ifdef DEBUGGING
2550             if (stringok)
2551                 stop = n;
2552 #endif
2553             n = regnext(n);
2554         }
2555         else if (stringok) {
2556             const unsigned int oldl = STR_LEN(scan);
2557             regnode * const nnext = regnext(n);
2558             
2559             DEBUG_PEEP("merg",n,depth);
2560             
2561             merged++;
2562             if (oldl + STR_LEN(n) > U8_MAX)
2563                 break;
2564             NEXT_OFF(scan) += NEXT_OFF(n);
2565             STR_LEN(scan) += STR_LEN(n);
2566             next = n + NODE_SZ_STR(n);
2567             /* Now we can overwrite *n : */
2568             Move(STRING(n), STRING(scan) + oldl, STR_LEN(n), char);
2569 #ifdef DEBUGGING
2570             stop = next - 1;
2571 #endif
2572             n = nnext;
2573             if (stopnow) break;
2574         }
2575
2576 #ifdef EXPERIMENTAL_INPLACESCAN
2577         if (flags && !NEXT_OFF(n)) {
2578             DEBUG_PEEP("atch", val, depth);
2579             if (reg_off_by_arg[OP(n)]) {
2580                 ARG_SET(n, val - n);
2581             }
2582             else {
2583                 NEXT_OFF(n) = val - n;
2584             }
2585             stopnow = 1;
2586         }
2587 #endif
2588     }
2589 #define GREEK_SMALL_LETTER_IOTA_WITH_DIALYTIKA_AND_TONOS   0x0390
2590 #define IOTA_D_T        GREEK_SMALL_LETTER_IOTA_WITH_DIALYTIKA_AND_TONOS
2591 #define GREEK_SMALL_LETTER_UPSILON_WITH_DIALYTIKA_AND_TONOS     0x03B0
2592 #define UPSILON_D_T     GREEK_SMALL_LETTER_UPSILON_WITH_DIALYTIKA_AND_TONOS
2593
2594     if (UTF
2595         && ( OP(scan) == EXACTF || OP(scan) == EXACTFU || OP(scan) == EXACTFA)
2596         && ( STR_LEN(scan) >= 6 ) )
2597     {
2598     /*
2599     Two problematic code points in Unicode casefolding of EXACT nodes:
2600     
2601     U+0390 - GREEK SMALL LETTER IOTA WITH DIALYTIKA AND TONOS
2602     U+03B0 - GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND TONOS
2603     
2604     which casefold to
2605     
2606     Unicode                      UTF-8
2607     
2608     U+03B9 U+0308 U+0301         0xCE 0xB9 0xCC 0x88 0xCC 0x81
2609     U+03C5 U+0308 U+0301         0xCF 0x85 0xCC 0x88 0xCC 0x81
2610     
2611     This means that in case-insensitive matching (or "loose matching",
2612     as Unicode calls it), an EXACTF of length six (the UTF-8 encoded byte
2613     length of the above casefolded versions) can match a target string
2614     of length two (the byte length of UTF-8 encoded U+0390 or U+03B0).
2615     This would rather mess up the minimum length computation.
2616     
2617     What we'll do is to look for the tail four bytes, and then peek
2618     at the preceding two bytes to see whether we need to decrease
2619     the minimum length by four (six minus two).
2620     
2621     Thanks to the design of UTF-8, there cannot be false matches:
2622     A sequence of valid UTF-8 bytes cannot be a subsequence of
2623     another valid sequence of UTF-8 bytes.
2624     
2625     */
2626          char * const s0 = STRING(scan), *s, *t;
2627          char * const s1 = s0 + STR_LEN(scan) - 1;
2628          char * const s2 = s1 - 4;
2629 #ifdef EBCDIC /* RD tunifold greek 0390 and 03B0 */
2630          const char t0[] = "\xaf\x49\xaf\x42";
2631 #else
2632          const char t0[] = "\xcc\x88\xcc\x81";
2633 #endif
2634          const char * const t1 = t0 + 3;
2635     
2636          for (s = s0 + 2;
2637               s < s2 && (t = ninstr(s, s1, t0, t1));
2638               s = t + 4) {
2639 #ifdef EBCDIC
2640               if (((U8)t[-1] == 0x68 && (U8)t[-2] == 0xB4) ||
2641                   ((U8)t[-1] == 0x46 && (U8)t[-2] == 0xB5))
2642 #else
2643               if (((U8)t[-1] == 0xB9 && (U8)t[-2] == 0xCE) ||
2644                   ((U8)t[-1] == 0x85 && (U8)t[-2] == 0xCF))
2645 #endif
2646                    *min -= 4;
2647          }
2648     }
2649     
2650 #ifdef DEBUGGING
2651     /* Allow dumping but overwriting the collection of skipped
2652      * ops and/or strings with fake optimized ops */
2653     n = scan + NODE_SZ_STR(scan);
2654     while (n <= stop) {
2655         OP(n) = OPTIMIZED;
2656         FLAGS(n) = 0;
2657         NEXT_OFF(n) = 0;
2658         n++;
2659     }
2660 #endif
2661     DEBUG_OPTIMISE_r(if (merged){DEBUG_PEEP("finl",scan,depth)});
2662     return stopnow;
2663 }
2664
2665 /* REx optimizer.  Converts nodes into quicker variants "in place".
2666    Finds fixed substrings.  */
2667
2668 /* Stops at toplevel WHILEM as well as at "last". At end *scanp is set
2669    to the position after last scanned or to NULL. */
2670
2671 #define INIT_AND_WITHP \
2672     assert(!and_withp); \
2673     Newx(and_withp,1,struct regnode_charclass_class); \
2674     SAVEFREEPV(and_withp)
2675
2676 /* this is a chain of data about sub patterns we are processing that
2677    need to be handled separately/specially in study_chunk. Its so
2678    we can simulate recursion without losing state.  */
2679 struct scan_frame;
2680 typedef struct scan_frame {
2681     regnode *last;  /* last node to process in this frame */
2682     regnode *next;  /* next node to process when last is reached */
2683     struct scan_frame *prev; /*previous frame*/
2684     I32 stop; /* what stopparen do we use */
2685 } scan_frame;
2686
2687
2688 #define SCAN_COMMIT(s, data, m) scan_commit(s, data, m, is_inf)
2689
2690 #define CASE_SYNST_FNC(nAmE)                                       \
2691 case nAmE:                                                         \
2692     if (flags & SCF_DO_STCLASS_AND) {                              \
2693             for (value = 0; value < 256; value++)                  \
2694                 if (!is_ ## nAmE ## _cp(value))                       \
2695                     ANYOF_BITMAP_CLEAR(data->start_class, value);  \
2696     }                                                              \
2697     else {                                                         \
2698             for (value = 0; value < 256; value++)                  \
2699                 if (is_ ## nAmE ## _cp(value))                        \
2700                     ANYOF_BITMAP_SET(data->start_class, value);    \
2701     }                                                              \
2702     break;                                                         \
2703 case N ## nAmE:                                                    \
2704     if (flags & SCF_DO_STCLASS_AND) {                              \
2705             for (value = 0; value < 256; value++)                   \
2706                 if (is_ ## nAmE ## _cp(value))                         \
2707                     ANYOF_BITMAP_CLEAR(data->start_class, value);   \
2708     }                                                               \
2709     else {                                                          \
2710             for (value = 0; value < 256; value++)                   \
2711                 if (!is_ ## nAmE ## _cp(value))                        \
2712                     ANYOF_BITMAP_SET(data->start_class, value);     \
2713     }                                                               \
2714     break
2715
2716
2717
2718 STATIC I32
2719 S_study_chunk(pTHX_ RExC_state_t *pRExC_state, regnode **scanp,
2720                         I32 *minlenp, I32 *deltap,
2721                         regnode *last,
2722                         scan_data_t *data,
2723                         I32 stopparen,
2724                         U8* recursed,
2725                         struct regnode_charclass_class *and_withp,
2726                         U32 flags, U32 depth)
2727                         /* scanp: Start here (read-write). */
2728                         /* deltap: Write maxlen-minlen here. */
2729                         /* last: Stop before this one. */
2730                         /* data: string data about the pattern */
2731                         /* stopparen: treat close N as END */
2732                         /* recursed: which subroutines have we recursed into */
2733                         /* and_withp: Valid if flags & SCF_DO_STCLASS_OR */
2734 {
2735     dVAR;
2736     I32 min = 0, pars = 0, code;
2737     regnode *scan = *scanp, *next;
2738     I32 delta = 0;
2739     int is_inf = (flags & SCF_DO_SUBSTR) && (data->flags & SF_IS_INF);
2740     int is_inf_internal = 0;            /* The studied chunk is infinite */
2741     I32 is_par = OP(scan) == OPEN ? ARG(scan) : 0;
2742     scan_data_t data_fake;
2743     SV *re_trie_maxbuff = NULL;
2744     regnode *first_non_open = scan;
2745     I32 stopmin = I32_MAX;
2746     scan_frame *frame = NULL;
2747     GET_RE_DEBUG_FLAGS_DECL;
2748
2749     PERL_ARGS_ASSERT_STUDY_CHUNK;
2750
2751 #ifdef DEBUGGING
2752     StructCopy(&zero_scan_data, &data_fake, scan_data_t);
2753 #endif
2754
2755     if ( depth == 0 ) {
2756         while (first_non_open && OP(first_non_open) == OPEN)
2757             first_non_open=regnext(first_non_open);
2758     }
2759
2760
2761   fake_study_recurse:
2762     while ( scan && OP(scan) != END && scan < last ){
2763         /* Peephole optimizer: */
2764         DEBUG_STUDYDATA("Peep:", data,depth);
2765         DEBUG_PEEP("Peep",scan,depth);
2766         JOIN_EXACT(scan,&min,0);
2767
2768         /* Follow the next-chain of the current node and optimize
2769            away all the NOTHINGs from it.  */
2770         if (OP(scan) != CURLYX) {
2771             const int max = (reg_off_by_arg[OP(scan)]
2772                        ? I32_MAX
2773                        /* I32 may be smaller than U16 on CRAYs! */
2774                        : (I32_MAX < U16_MAX ? I32_MAX : U16_MAX));
2775             int off = (reg_off_by_arg[OP(scan)] ? ARG(scan) : NEXT_OFF(scan));
2776             int noff;
2777             regnode *n = scan;
2778         
2779             /* Skip NOTHING and LONGJMP. */
2780             while ((n = regnext(n))
2781                    && ((PL_regkind[OP(n)] == NOTHING && (noff = NEXT_OFF(n)))
2782                        || ((OP(n) == LONGJMP) && (noff = ARG(n))))
2783                    && off + noff < max)
2784                 off += noff;
2785             if (reg_off_by_arg[OP(scan)])
2786                 ARG(scan) = off;
2787             else
2788                 NEXT_OFF(scan) = off;
2789         }
2790
2791
2792
2793         /* The principal pseudo-switch.  Cannot be a switch, since we
2794            look into several different things.  */
2795         if (OP(scan) == BRANCH || OP(scan) == BRANCHJ
2796                    || OP(scan) == IFTHEN) {
2797             next = regnext(scan);
2798             code = OP(scan);
2799             /* demq: the op(next)==code check is to see if we have "branch-branch" AFAICT */
2800         
2801             if (OP(next) == code || code == IFTHEN) {
2802                 /* NOTE - There is similar code to this block below for handling
2803                    TRIE nodes on a re-study.  If you change stuff here check there
2804                    too. */
2805                 I32 max1 = 0, min1 = I32_MAX, num = 0;
2806                 struct regnode_charclass_class accum;
2807                 regnode * const startbranch=scan;
2808                 
2809                 if (flags & SCF_DO_SUBSTR)
2810                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot merge strings after this. */
2811                 if (flags & SCF_DO_STCLASS)
2812                     cl_init_zero(pRExC_state, &accum);
2813
2814                 while (OP(scan) == code) {
2815                     I32 deltanext, minnext, f = 0, fake;
2816                     struct regnode_charclass_class this_class;
2817
2818                     num++;
2819                     data_fake.flags = 0;
2820                     if (data) {
2821                         data_fake.whilem_c = data->whilem_c;
2822                         data_fake.last_closep = data->last_closep;
2823                     }
2824                     else
2825                         data_fake.last_closep = &fake;
2826
2827                     data_fake.pos_delta = delta;
2828                     next = regnext(scan);
2829                     scan = NEXTOPER(scan);
2830                     if (code != BRANCH)
2831                         scan = NEXTOPER(scan);
2832                     if (flags & SCF_DO_STCLASS) {
2833                         cl_init(pRExC_state, &this_class);
2834                         data_fake.start_class = &this_class;
2835                         f = SCF_DO_STCLASS_AND;
2836                     }
2837                     if (flags & SCF_WHILEM_VISITED_POS)
2838                         f |= SCF_WHILEM_VISITED_POS;
2839
2840                     /* we suppose the run is continuous, last=next...*/
2841                     minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext,
2842                                           next, &data_fake,
2843                                           stopparen, recursed, NULL, f,depth+1);
2844                     if (min1 > minnext)
2845                         min1 = minnext;
2846                     if (max1 < minnext + deltanext)
2847                         max1 = minnext + deltanext;
2848                     if (deltanext == I32_MAX)
2849                         is_inf = is_inf_internal = 1;
2850                     scan = next;
2851                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
2852                         pars++;
2853                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
2854                         if ( stopmin > minnext) 
2855                             stopmin = min + min1;
2856                         flags &= ~SCF_DO_SUBSTR;
2857                         if (data)
2858                             data->flags |= SCF_SEEN_ACCEPT;
2859                     }
2860                     if (data) {
2861                         if (data_fake.flags & SF_HAS_EVAL)
2862                             data->flags |= SF_HAS_EVAL;
2863                         data->whilem_c = data_fake.whilem_c;
2864                     }
2865                     if (flags & SCF_DO_STCLASS)
2866                         cl_or(pRExC_state, &accum, &this_class);
2867                 }
2868                 if (code == IFTHEN && num < 2) /* Empty ELSE branch */
2869                     min1 = 0;
2870                 if (flags & SCF_DO_SUBSTR) {
2871                     data->pos_min += min1;
2872                     data->pos_delta += max1 - min1;
2873                     if (max1 != min1 || is_inf)
2874                         data->longest = &(data->longest_float);
2875                 }
2876                 min += min1;
2877                 delta += max1 - min1;
2878                 if (flags & SCF_DO_STCLASS_OR) {
2879                     cl_or(pRExC_state, data->start_class, &accum);
2880                     if (min1) {
2881                         cl_and(data->start_class, and_withp);
2882                         flags &= ~SCF_DO_STCLASS;
2883                     }
2884                 }
2885                 else if (flags & SCF_DO_STCLASS_AND) {
2886                     if (min1) {
2887                         cl_and(data->start_class, &accum);
2888                         flags &= ~SCF_DO_STCLASS;
2889                     }
2890                     else {
2891                         /* Switch to OR mode: cache the old value of
2892                          * data->start_class */
2893                         INIT_AND_WITHP;
2894                         StructCopy(data->start_class, and_withp,
2895                                    struct regnode_charclass_class);
2896                         flags &= ~SCF_DO_STCLASS_AND;
2897                         StructCopy(&accum, data->start_class,
2898                                    struct regnode_charclass_class);
2899                         flags |= SCF_DO_STCLASS_OR;
2900                         data->start_class->flags |= ANYOF_EOS;
2901                     }
2902                 }
2903
2904                 if (PERL_ENABLE_TRIE_OPTIMISATION && OP( startbranch ) == BRANCH ) {
2905                 /* demq.
2906
2907                    Assuming this was/is a branch we are dealing with: 'scan' now
2908                    points at the item that follows the branch sequence, whatever
2909                    it is. We now start at the beginning of the sequence and look
2910                    for subsequences of
2911
2912                    BRANCH->EXACT=>x1
2913                    BRANCH->EXACT=>x2
2914                    tail
2915
2916                    which would be constructed from a pattern like /A|LIST|OF|WORDS/
2917
2918                    If we can find such a subsequence we need to turn the first
2919                    element into a trie and then add the subsequent branch exact
2920                    strings to the trie.
2921
2922                    We have two cases
2923
2924                      1. patterns where the whole set of branches can be converted. 
2925
2926                      2. patterns where only a subset can be converted.
2927
2928                    In case 1 we can replace the whole set with a single regop
2929                    for the trie. In case 2 we need to keep the start and end
2930                    branches so
2931
2932                      'BRANCH EXACT; BRANCH EXACT; BRANCH X'
2933                      becomes BRANCH TRIE; BRANCH X;
2934
2935                   There is an additional case, that being where there is a 
2936                   common prefix, which gets split out into an EXACT like node
2937                   preceding the TRIE node.
2938
2939                   If x(1..n)==tail then we can do a simple trie, if not we make
2940                   a "jump" trie, such that when we match the appropriate word
2941                   we "jump" to the appropriate tail node. Essentially we turn
2942                   a nested if into a case structure of sorts.
2943
2944                 */
2945                 
2946                     int made=0;
2947                     if (!re_trie_maxbuff) {
2948                         re_trie_maxbuff = get_sv(RE_TRIE_MAXBUF_NAME, 1);
2949                         if (!SvIOK(re_trie_maxbuff))
2950                             sv_setiv(re_trie_maxbuff, RE_TRIE_MAXBUF_INIT);
2951                     }
2952                     if ( SvIV(re_trie_maxbuff)>=0  ) {
2953                         regnode *cur;
2954                         regnode *first = (regnode *)NULL;
2955                         regnode *last = (regnode *)NULL;
2956                         regnode *tail = scan;
2957                         U8 optype = 0;
2958                         U32 count=0;
2959
2960 #ifdef DEBUGGING
2961                         SV * const mysv = sv_newmortal();       /* for dumping */
2962 #endif
2963                         /* var tail is used because there may be a TAIL
2964                            regop in the way. Ie, the exacts will point to the
2965                            thing following the TAIL, but the last branch will
2966                            point at the TAIL. So we advance tail. If we
2967                            have nested (?:) we may have to move through several
2968                            tails.
2969                          */
2970
2971                         while ( OP( tail ) == TAIL ) {
2972                             /* this is the TAIL generated by (?:) */
2973                             tail = regnext( tail );
2974                         }
2975
2976                         
2977                         DEBUG_OPTIMISE_r({
2978                             regprop(RExC_rx, mysv, tail );
2979                             PerlIO_printf( Perl_debug_log, "%*s%s%s\n",
2980                                 (int)depth * 2 + 2, "", 
2981                                 "Looking for TRIE'able sequences. Tail node is: ", 
2982                                 SvPV_nolen_const( mysv )
2983                             );
2984                         });
2985                         
2986                         /*
2987
2988                            step through the branches, cur represents each
2989                            branch, noper is the first thing to be matched
2990                            as part of that branch and noper_next is the
2991                            regnext() of that node. if noper is an EXACT
2992                            and noper_next is the same as scan (our current
2993                            position in the regex) then the EXACT branch is
2994                            a possible optimization target. Once we have
2995                            two or more consecutive such branches we can
2996                            create a trie of the EXACT's contents and stich
2997                            it in place. If the sequence represents all of
2998                            the branches we eliminate the whole thing and
2999                            replace it with a single TRIE. If it is a
3000                            subsequence then we need to stitch it in. This
3001                            means the first branch has to remain, and needs
3002                            to be repointed at the item on the branch chain
3003                            following the last branch optimized. This could
3004                            be either a BRANCH, in which case the
3005                            subsequence is internal, or it could be the
3006                            item following the branch sequence in which
3007                            case the subsequence is at the end.
3008
3009                         */
3010
3011                         /* dont use tail as the end marker for this traverse */
3012                         for ( cur = startbranch ; cur != scan ; cur = regnext( cur ) ) {
3013                             regnode * const noper = NEXTOPER( cur );
3014 #if defined(DEBUGGING) || defined(NOJUMPTRIE)
3015                             regnode * const noper_next = regnext( noper );
3016 #endif
3017
3018                             DEBUG_OPTIMISE_r({
3019                                 regprop(RExC_rx, mysv, cur);
3020                                 PerlIO_printf( Perl_debug_log, "%*s- %s (%d)",
3021                                    (int)depth * 2 + 2,"", SvPV_nolen_const( mysv ), REG_NODE_NUM(cur) );
3022
3023                                 regprop(RExC_rx, mysv, noper);
3024                                 PerlIO_printf( Perl_debug_log, " -> %s",
3025                                     SvPV_nolen_const(mysv));
3026
3027                                 if ( noper_next ) {
3028                                   regprop(RExC_rx, mysv, noper_next );
3029                                   PerlIO_printf( Perl_debug_log,"\t=> %s\t",
3030                                     SvPV_nolen_const(mysv));
3031                                 }
3032                                 PerlIO_printf( Perl_debug_log, "(First==%d,Last==%d,Cur==%d)\n",
3033                                    REG_NODE_NUM(first), REG_NODE_NUM(last), REG_NODE_NUM(cur) );
3034                             });
3035                             if ( (((first && optype!=NOTHING) ? OP( noper ) == optype
3036                                          : PL_regkind[ OP( noper ) ] == EXACT )
3037                                   || OP(noper) == NOTHING )
3038 #ifdef NOJUMPTRIE
3039                                   && noper_next == tail
3040 #endif
3041                                   && count < U16_MAX)
3042                             {
3043                                 count++;
3044                                 if ( !first || optype == NOTHING ) {
3045                                     if (!first) first = cur;
3046                                     optype = OP( noper );
3047                                 } else {
3048                                     last = cur;
3049                                 }
3050                             } else {
3051 /* 
3052     Currently the trie logic handles case insensitive matching properly only
3053     when the pattern is UTF-8 and the node is EXACTFU (thus forcing unicode
3054     semantics).
3055
3056     If/when this is fixed the following define can be swapped
3057     in below to fully enable trie logic.
3058
3059 #define TRIE_TYPE_IS_SAFE 1
3060
3061 */
3062 #define TRIE_TYPE_IS_SAFE ((UTF && optype == EXACTFU) || optype==EXACT)
3063
3064                                 if ( last && TRIE_TYPE_IS_SAFE ) {
3065                                     make_trie( pRExC_state, 
3066                                             startbranch, first, cur, tail, count, 
3067                                             optype, depth+1 );
3068                                 }
3069                                 if ( PL_regkind[ OP( noper ) ] == EXACT
3070 #ifdef NOJUMPTRIE
3071                                      && noper_next == tail
3072 #endif
3073                                 ){
3074                                     count = 1;
3075                                     first = cur;
3076                                     optype = OP( noper );
3077                                 } else {
3078                                     count = 0;
3079                                     first = NULL;
3080                                     optype = 0;
3081                                 }
3082                                 last = NULL;
3083                             }
3084                         }
3085                         DEBUG_OPTIMISE_r({
3086                             regprop(RExC_rx, mysv, cur);
3087                             PerlIO_printf( Perl_debug_log,
3088                               "%*s- %s (%d) <SCAN FINISHED>\n", (int)depth * 2 + 2,
3089                               "", SvPV_nolen_const( mysv ),REG_NODE_NUM(cur));
3090
3091                         });
3092                         
3093                         if ( last && TRIE_TYPE_IS_SAFE ) {
3094                             made= make_trie( pRExC_state, startbranch, first, scan, tail, count, optype, depth+1 );
3095 #ifdef TRIE_STUDY_OPT   
3096                             if ( ((made == MADE_EXACT_TRIE && 
3097                                  startbranch == first) 
3098                                  || ( first_non_open == first )) && 
3099                                  depth==0 ) {
3100                                 flags |= SCF_TRIE_RESTUDY;
3101                                 if ( startbranch == first 
3102                                      && scan == tail ) 
3103                                 {
3104                                     RExC_seen &=~REG_TOP_LEVEL_BRANCHES;
3105                                 }
3106                             }
3107 #endif
3108                         }
3109                     }
3110                     
3111                 } /* do trie */
3112                 
3113             }
3114             else if ( code == BRANCHJ ) {  /* single branch is optimized. */
3115                 scan = NEXTOPER(NEXTOPER(scan));
3116             } else                      /* single branch is optimized. */
3117                 scan = NEXTOPER(scan);
3118             continue;
3119         } else if (OP(scan) == SUSPEND || OP(scan) == GOSUB || OP(scan) == GOSTART) {
3120             scan_frame *newframe = NULL;
3121             I32 paren;
3122             regnode *start;
3123             regnode *end;
3124
3125             if (OP(scan) != SUSPEND) {
3126             /* set the pointer */
3127                 if (OP(scan) == GOSUB) {
3128                     paren = ARG(scan);
3129                     RExC_recurse[ARG2L(scan)] = scan;
3130                     start = RExC_open_parens[paren-1];
3131                     end   = RExC_close_parens[paren-1];
3132                 } else {
3133                     paren = 0;
3134                     start = RExC_rxi->program + 1;
3135                     end   = RExC_opend;
3136                 }
3137                 if (!recursed) {
3138                     Newxz(recursed, (((RExC_npar)>>3) +1), U8);
3139                     SAVEFREEPV(recursed);
3140                 }
3141                 if (!PAREN_TEST(recursed,paren+1)) {
3142                     PAREN_SET(recursed,paren+1);
3143                     Newx(newframe,1,scan_frame);
3144                 } else {
3145                     if (flags & SCF_DO_SUBSTR) {
3146                         SCAN_COMMIT(pRExC_state,data,minlenp);
3147                         data->longest = &(data->longest_float);
3148                     }
3149                     is_inf = is_inf_internal = 1;
3150                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3151                         cl_anything(pRExC_state, data->start_class);
3152                     flags &= ~SCF_DO_STCLASS;
3153                 }
3154             } else {
3155                 Newx(newframe,1,scan_frame);
3156                 paren = stopparen;
3157                 start = scan+2;
3158                 end = regnext(scan);
3159             }
3160             if (newframe) {
3161                 assert(start);
3162                 assert(end);
3163                 SAVEFREEPV(newframe);
3164                 newframe->next = regnext(scan);
3165                 newframe->last = last;
3166                 newframe->stop = stopparen;
3167                 newframe->prev = frame;
3168
3169                 frame = newframe;
3170                 scan =  start;
3171                 stopparen = paren;
3172                 last = end;
3173
3174                 continue;
3175             }
3176         }
3177         else if (OP(scan) == EXACT) {
3178             I32 l = STR_LEN(scan);
3179             UV uc;
3180             if (UTF) {
3181                 const U8 * const s = (U8*)STRING(scan);
3182                 l = utf8_length(s, s + l);
3183                 uc = utf8_to_uvchr(s, NULL);
3184             } else {
3185                 uc = *((U8*)STRING(scan));
3186             }
3187             min += l;
3188             if (flags & SCF_DO_SUBSTR) { /* Update longest substr. */
3189                 /* The code below prefers earlier match for fixed
3190                    offset, later match for variable offset.  */
3191                 if (data->last_end == -1) { /* Update the start info. */
3192                     data->last_start_min = data->pos_min;
3193                     data->last_start_max = is_inf
3194                         ? I32_MAX : data->pos_min + data->pos_delta;
3195                 }
3196                 sv_catpvn(data->last_found, STRING(scan), STR_LEN(scan));
3197                 if (UTF)
3198                     SvUTF8_on(data->last_found);
3199                 {
3200                     SV * const sv = data->last_found;
3201                     MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3202                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3203                     if (mg && mg->mg_len >= 0)
3204                         mg->mg_len += utf8_length((U8*)STRING(scan),
3205                                                   (U8*)STRING(scan)+STR_LEN(scan));
3206                 }
3207                 data->last_end = data->pos_min + l;
3208                 data->pos_min += l; /* As in the first entry. */
3209                 data->flags &= ~SF_BEFORE_EOL;
3210             }
3211             if (flags & SCF_DO_STCLASS_AND) {
3212                 /* Check whether it is compatible with what we know already! */
3213                 int compat = 1;
3214
3215
3216                 /* If compatible, we or it in below.  It is compatible if is
3217                  * in the bitmp and either 1) its bit or its fold is set, or 2)
3218                  * it's for a locale.  Even if there isn't unicode semantics
3219                  * here, at runtime there may be because of matching against a
3220                  * utf8 string, so accept a possible false positive for
3221                  * latin1-range folds */
3222                 if (uc >= 0x100 ||
3223                     (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3224                     && !ANYOF_BITMAP_TEST(data->start_class, uc)
3225                     && (!(data->start_class->flags & ANYOF_LOC_NONBITMAP_FOLD)
3226                         || !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3227                     )
3228                 {
3229                     compat = 0;
3230                 }
3231                 ANYOF_CLASS_ZERO(data->start_class);
3232                 ANYOF_BITMAP_ZERO(data->start_class);
3233                 if (compat)
3234                     ANYOF_BITMAP_SET(data->start_class, uc);
3235                 else if (uc >= 0x100) {
3236                     int i;
3237
3238                     /* Some Unicode code points fold to the Latin1 range; as
3239                      * XXX temporary code, instead of figuring out if this is
3240                      * one, just assume it is and set all the start class bits
3241                      * that could be some such above 255 code point's fold
3242                      * which will generate fals positives.  As the code
3243                      * elsewhere that does compute the fold settles down, it
3244                      * can be extracted out and re-used here */
3245                     for (i = 0; i < 256; i++){
3246                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3247                             ANYOF_BITMAP_SET(data->start_class, i);
3248                         }
3249                     }
3250                 }
3251                 data->start_class->flags &= ~ANYOF_EOS;
3252                 if (uc < 0x100)
3253                   data->start_class->flags &= ~ANYOF_UNICODE_ALL;
3254             }
3255             else if (flags & SCF_DO_STCLASS_OR) {
3256                 /* false positive possible if the class is case-folded */
3257                 if (uc < 0x100)
3258                     ANYOF_BITMAP_SET(data->start_class, uc);
3259                 else
3260                     data->start_class->flags |= ANYOF_UNICODE_ALL;
3261                 data->start_class->flags &= ~ANYOF_EOS;
3262                 cl_and(data->start_class, and_withp);
3263             }
3264             flags &= ~SCF_DO_STCLASS;
3265         }
3266         else if (PL_regkind[OP(scan)] == EXACT) { /* But OP != EXACT! */
3267             I32 l = STR_LEN(scan);
3268             UV uc = *((U8*)STRING(scan));
3269
3270             /* Search for fixed substrings supports EXACT only. */
3271             if (flags & SCF_DO_SUBSTR) {
3272                 assert(data);
3273                 SCAN_COMMIT(pRExC_state, data, minlenp);
3274             }
3275             if (UTF) {
3276                 const U8 * const s = (U8 *)STRING(scan);
3277                 l = utf8_length(s, s + l);
3278                 uc = utf8_to_uvchr(s, NULL);
3279             }
3280             min += l;
3281             if (flags & SCF_DO_SUBSTR)
3282                 data->pos_min += l;
3283             if (flags & SCF_DO_STCLASS_AND) {
3284                 /* Check whether it is compatible with what we know already! */
3285                 int compat = 1;
3286                 if (uc >= 0x100 ||
3287                  (!(data->start_class->flags & (ANYOF_CLASS | ANYOF_LOCALE))
3288                   && !ANYOF_BITMAP_TEST(data->start_class, uc)
3289                   && !ANYOF_BITMAP_TEST(data->start_class, PL_fold_latin1[uc])))
3290                 {
3291                     compat = 0;
3292                 }
3293                 ANYOF_CLASS_ZERO(data->start_class);
3294                 ANYOF_BITMAP_ZERO(data->start_class);
3295                 if (compat) {
3296                     ANYOF_BITMAP_SET(data->start_class, uc);
3297                     data->start_class->flags &= ~ANYOF_EOS;
3298                     data->start_class->flags |= ANYOF_LOC_NONBITMAP_FOLD;
3299                     if (OP(scan) == EXACTFL) {
3300                         /* XXX This set is probably no longer necessary, and
3301                          * probably wrong as LOCALE now is on in the initial
3302                          * state */
3303                         data->start_class->flags |= ANYOF_LOCALE;
3304                     }
3305                     else {
3306
3307                         /* Also set the other member of the fold pair.  In case
3308                          * that unicode semantics is called for at runtime, use
3309                          * the full latin1 fold.  (Can't do this for locale,
3310                          * because not known until runtime */
3311                         ANYOF_BITMAP_SET(data->start_class, PL_fold_latin1[uc]);
3312                     }
3313                 }
3314                 else if (uc >= 0x100) {
3315                     int i;
3316                     for (i = 0; i < 256; i++){
3317                         if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(i)) {
3318                             ANYOF_BITMAP_SET(data->start_class, i);
3319                         }
3320                     }
3321                 }
3322             }
3323             else if (flags & SCF_DO_STCLASS_OR) {
3324                 if (data->start_class->flags & ANYOF_LOC_NONBITMAP_FOLD) {
3325                     /* false positive possible if the class is case-folded.
3326                        Assume that the locale settings are the same... */
3327                     if (uc < 0x100) {
3328                         ANYOF_BITMAP_SET(data->start_class, uc);
3329                         if (OP(scan) != EXACTFL) {
3330
3331                             /* And set the other member of the fold pair, but
3332                              * can't do that in locale because not known until
3333                              * run-time */
3334                             ANYOF_BITMAP_SET(data->start_class,
3335                                              PL_fold_latin1[uc]);
3336                         }
3337                     }
3338                     data->start_class->flags &= ~ANYOF_EOS;
3339                 }
3340                 cl_and(data->start_class, and_withp);
3341             }
3342             flags &= ~SCF_DO_STCLASS;
3343         }
3344         else if (REGNODE_VARIES(OP(scan))) {
3345             I32 mincount, maxcount, minnext, deltanext, fl = 0;
3346             I32 f = flags, pos_before = 0;
3347             regnode * const oscan = scan;
3348             struct regnode_charclass_class this_class;
3349             struct regnode_charclass_class *oclass = NULL;
3350             I32 next_is_eval = 0;
3351
3352             switch (PL_regkind[OP(scan)]) {
3353             case WHILEM:                /* End of (?:...)* . */
3354                 scan = NEXTOPER(scan);
3355                 goto finish;
3356             case PLUS:
3357                 if (flags & (SCF_DO_SUBSTR | SCF_DO_STCLASS)) {
3358                     next = NEXTOPER(scan);
3359                     if (OP(next) == EXACT || (flags & SCF_DO_STCLASS)) {
3360                         mincount = 1;
3361                         maxcount = REG_INFTY;
3362                         next = regnext(scan);
3363                         scan = NEXTOPER(scan);
3364                         goto do_curly;
3365                     }
3366                 }
3367                 if (flags & SCF_DO_SUBSTR)
3368                     data->pos_min++;
3369                 min++;
3370                 /* Fall through. */
3371             case STAR:
3372                 if (flags & SCF_DO_STCLASS) {
3373                     mincount = 0;
3374                     maxcount = REG_INFTY;
3375                     next = regnext(scan);
3376                     scan = NEXTOPER(scan);
3377                     goto do_curly;
3378                 }
3379                 is_inf = is_inf_internal = 1;
3380                 scan = regnext(scan);
3381                 if (flags & SCF_DO_SUBSTR) {
3382                     SCAN_COMMIT(pRExC_state, data, minlenp); /* Cannot extend fixed substrings */
3383                     data->longest = &(data->longest_float);
3384                 }
3385                 goto optimize_curly_tail;
3386             case CURLY:
3387                 if (stopparen>0 && (OP(scan)==CURLYN || OP(scan)==CURLYM)
3388                     && (scan->flags == stopparen))
3389                 {
3390                     mincount = 1;
3391                     maxcount = 1;
3392                 } else {
3393                     mincount = ARG1(scan);
3394                     maxcount = ARG2(scan);
3395                 }
3396                 next = regnext(scan);
3397                 if (OP(scan) == CURLYX) {
3398                     I32 lp = (data ? *(data->last_closep) : 0);
3399                     scan->flags = ((lp <= (I32)U8_MAX) ? (U8)lp : U8_MAX);
3400                 }
3401                 scan = NEXTOPER(scan) + EXTRA_STEP_2ARGS;
3402                 next_is_eval = (OP(scan) == EVAL);
3403               do_curly:
3404                 if (flags & SCF_DO_SUBSTR) {
3405                     if (mincount == 0) SCAN_COMMIT(pRExC_state,data,minlenp); /* Cannot extend fixed substrings */
3406                     pos_before = data->pos_min;
3407                 }
3408                 if (data) {
3409                     fl = data->flags;
3410                     data->flags &= ~(SF_HAS_PAR|SF_IN_PAR|SF_HAS_EVAL);
3411                     if (is_inf)
3412                         data->flags |= SF_IS_INF;
3413                 }
3414                 if (flags & SCF_DO_STCLASS) {
3415                     cl_init(pRExC_state, &this_class);
3416                     oclass = data->start_class;
3417                     data->start_class = &this_class;
3418                     f |= SCF_DO_STCLASS_AND;
3419                     f &= ~SCF_DO_STCLASS_OR;
3420                 }
3421                 /* Exclude from super-linear cache processing any {n,m}
3422                    regops for which the combination of input pos and regex
3423                    pos is not enough information to determine if a match
3424                    will be possible.
3425
3426                    For example, in the regex /foo(bar\s*){4,8}baz/ with the
3427                    regex pos at the \s*, the prospects for a match depend not
3428                    only on the input position but also on how many (bar\s*)
3429                    repeats into the {4,8} we are. */
3430                if ((mincount > 1) || (maxcount > 1 && maxcount != REG_INFTY))
3431                     f &= ~SCF_WHILEM_VISITED_POS;
3432
3433                 /* This will finish on WHILEM, setting scan, or on NULL: */
3434                 minnext = study_chunk(pRExC_state, &scan, minlenp, &deltanext, 
3435                                       last, data, stopparen, recursed, NULL,
3436                                       (mincount == 0
3437                                         ? (f & ~SCF_DO_SUBSTR) : f),depth+1);
3438
3439                 if (flags & SCF_DO_STCLASS)
3440                     data->start_class = oclass;
3441                 if (mincount == 0 || minnext == 0) {
3442                     if (flags & SCF_DO_STCLASS_OR) {
3443                         cl_or(pRExC_state, data->start_class, &this_class);
3444                     }
3445                     else if (flags & SCF_DO_STCLASS_AND) {
3446                         /* Switch to OR mode: cache the old value of
3447                          * data->start_class */
3448                         INIT_AND_WITHP;
3449                         StructCopy(data->start_class, and_withp,
3450                                    struct regnode_charclass_class);
3451                         flags &= ~SCF_DO_STCLASS_AND;
3452                         StructCopy(&this_class, data->start_class,
3453                                    struct regnode_charclass_class);
3454                         flags |= SCF_DO_STCLASS_OR;
3455                         data->start_class->flags |= ANYOF_EOS;
3456                     }
3457                 } else {                /* Non-zero len */
3458                     if (flags & SCF_DO_STCLASS_OR) {
3459                         cl_or(pRExC_state, data->start_class, &this_class);
3460                         cl_and(data->start_class, and_withp);
3461                     }
3462                     else if (flags & SCF_DO_STCLASS_AND)
3463                         cl_and(data->start_class, &this_class);
3464                     flags &= ~SCF_DO_STCLASS;
3465                 }
3466                 if (!scan)              /* It was not CURLYX, but CURLY. */
3467                     scan = next;
3468                 if ( /* ? quantifier ok, except for (?{ ... }) */
3469                     (next_is_eval || !(mincount == 0 && maxcount == 1))
3470                     && (minnext == 0) && (deltanext == 0)
3471                     && data && !(data->flags & (SF_HAS_PAR|SF_IN_PAR))
3472                     && maxcount <= REG_INFTY/3) /* Complement check for big count */
3473                 {
3474                     ckWARNreg(RExC_parse,
3475                               "Quantifier unexpected on zero-length expression");
3476                 }
3477
3478                 min += minnext * mincount;
3479                 is_inf_internal |= ((maxcount == REG_INFTY
3480                                      && (minnext + deltanext) > 0)
3481                                     || deltanext == I32_MAX);
3482                 is_inf |= is_inf_internal;
3483                 delta += (minnext + deltanext) * maxcount - minnext * mincount;
3484
3485                 /* Try powerful optimization CURLYX => CURLYN. */
3486                 if (  OP(oscan) == CURLYX && data
3487                       && data->flags & SF_IN_PAR
3488                       && !(data->flags & SF_HAS_EVAL)
3489                       && !deltanext && minnext == 1 ) {
3490                     /* Try to optimize to CURLYN.  */
3491                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS;
3492                     regnode * const nxt1 = nxt;
3493 #ifdef DEBUGGING
3494                     regnode *nxt2;
3495 #endif
3496
3497                     /* Skip open. */
3498                     nxt = regnext(nxt);
3499                     if (!REGNODE_SIMPLE(OP(nxt))
3500                         && !(PL_regkind[OP(nxt)] == EXACT
3501                              && STR_LEN(nxt) == 1))
3502                         goto nogo;
3503 #ifdef DEBUGGING
3504                     nxt2 = nxt;
3505 #endif
3506                     nxt = regnext(nxt);
3507                     if (OP(nxt) != CLOSE)
3508                         goto nogo;
3509                     if (RExC_open_parens) {
3510                         RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3511                         RExC_close_parens[ARG(nxt1)-1]=nxt+2; /*close->while*/
3512                     }
3513                     /* Now we know that nxt2 is the only contents: */
3514                     oscan->flags = (U8)ARG(nxt);
3515                     OP(oscan) = CURLYN;
3516                     OP(nxt1) = NOTHING; /* was OPEN. */
3517
3518 #ifdef DEBUGGING
3519                     OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3520                     NEXT_OFF(nxt1+ 1) = 0; /* just for consistency. */
3521                     NEXT_OFF(nxt2) = 0; /* just for consistency with CURLY. */
3522                     OP(nxt) = OPTIMIZED;        /* was CLOSE. */
3523                     OP(nxt + 1) = OPTIMIZED; /* was count. */
3524                     NEXT_OFF(nxt+ 1) = 0; /* just for consistency. */
3525 #endif
3526                 }
3527               nogo:
3528
3529                 /* Try optimization CURLYX => CURLYM. */
3530                 if (  OP(oscan) == CURLYX && data
3531                       && !(data->flags & SF_HAS_PAR)
3532                       && !(data->flags & SF_HAS_EVAL)
3533                       && !deltanext     /* atom is fixed width */
3534                       && minnext != 0   /* CURLYM can't handle zero width */
3535                 ) {
3536                     /* XXXX How to optimize if data == 0? */
3537                     /* Optimize to a simpler form.  */
3538                     regnode *nxt = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN */
3539                     regnode *nxt2;
3540
3541                     OP(oscan) = CURLYM;
3542                     while ( (nxt2 = regnext(nxt)) /* skip over embedded stuff*/
3543                             && (OP(nxt2) != WHILEM))
3544                         nxt = nxt2;
3545                     OP(nxt2)  = SUCCEED; /* Whas WHILEM */
3546                     /* Need to optimize away parenths. */
3547                     if ((data->flags & SF_IN_PAR) && OP(nxt) == CLOSE) {
3548                         /* Set the parenth number.  */
3549                         regnode *nxt1 = NEXTOPER(oscan) + EXTRA_STEP_2ARGS; /* OPEN*/
3550
3551                         oscan->flags = (U8)ARG(nxt);
3552                         if (RExC_open_parens) {
3553                             RExC_open_parens[ARG(nxt1)-1]=oscan; /*open->CURLYM*/
3554                             RExC_close_parens[ARG(nxt1)-1]=nxt2+1; /*close->NOTHING*/
3555                         }
3556                         OP(nxt1) = OPTIMIZED;   /* was OPEN. */
3557                         OP(nxt) = OPTIMIZED;    /* was CLOSE. */
3558
3559 #ifdef DEBUGGING
3560                         OP(nxt1 + 1) = OPTIMIZED; /* was count. */
3561                         OP(nxt + 1) = OPTIMIZED; /* was count. */
3562                         NEXT_OFF(nxt1 + 1) = 0; /* just for consistency. */
3563                         NEXT_OFF(nxt + 1) = 0; /* just for consistency. */
3564 #endif
3565 #if 0
3566                         while ( nxt1 && (OP(nxt1) != WHILEM)) {
3567                             regnode *nnxt = regnext(nxt1);
3568                             if (nnxt == nxt) {
3569                                 if (reg_off_by_arg[OP(nxt1)])
3570                                     ARG_SET(nxt1, nxt2 - nxt1);
3571                                 else if (nxt2 - nxt1 < U16_MAX)
3572                                     NEXT_OFF(nxt1) = nxt2 - nxt1;
3573                                 else
3574                                     OP(nxt) = NOTHING;  /* Cannot beautify */
3575                             }
3576                             nxt1 = nnxt;
3577                         }
3578 #endif
3579                         /* Optimize again: */
3580                         study_chunk(pRExC_state, &nxt1, minlenp, &deltanext, nxt,
3581                                     NULL, stopparen, recursed, NULL, 0,depth+1);
3582                     }
3583                     else
3584                         oscan->flags = 0;
3585                 }
3586                 else if ((OP(oscan) == CURLYX)
3587                          && (flags & SCF_WHILEM_VISITED_POS)
3588                          /* See the comment on a similar expression above.
3589                             However, this time it's not a subexpression
3590                             we care about, but the expression itself. */
3591                          && (maxcount == REG_INFTY)
3592                          && data && ++data->whilem_c < 16) {
3593                     /* This stays as CURLYX, we can put the count/of pair. */
3594                     /* Find WHILEM (as in regexec.c) */
3595                     regnode *nxt = oscan + NEXT_OFF(oscan);
3596
3597                     if (OP(PREVOPER(nxt)) == NOTHING) /* LONGJMP */
3598                         nxt += ARG(nxt);
3599                     PREVOPER(nxt)->flags = (U8)(data->whilem_c
3600                         | (RExC_whilem_seen << 4)); /* On WHILEM */
3601                 }
3602                 if (data && fl & (SF_HAS_PAR|SF_IN_PAR))
3603                     pars++;
3604                 if (flags & SCF_DO_SUBSTR) {
3605                     SV *last_str = NULL;
3606                     int counted = mincount != 0;
3607
3608                     if (data->last_end > 0 && mincount != 0) { /* Ends with a string. */
3609 #if defined(SPARC64_GCC_WORKAROUND)
3610                         I32 b = 0;
3611                         STRLEN l = 0;
3612                         const char *s = NULL;
3613                         I32 old = 0;
3614
3615                         if (pos_before >= data->last_start_min)
3616                             b = pos_before;
3617                         else
3618                             b = data->last_start_min;
3619
3620                         l = 0;
3621                         s = SvPV_const(data->last_found, l);
3622                         old = b - data->last_start_min;
3623
3624 #else
3625                         I32 b = pos_before >= data->last_start_min
3626                             ? pos_before : data->last_start_min;
3627                         STRLEN l;
3628                         const char * const s = SvPV_const(data->last_found, l);
3629                         I32 old = b - data->last_start_min;
3630 #endif
3631
3632                         if (UTF)
3633                             old = utf8_hop((U8*)s, old) - (U8*)s;
3634                         l -= old;
3635                         /* Get the added string: */
3636                         last_str = newSVpvn_utf8(s  + old, l, UTF);
3637                         if (deltanext == 0 && pos_before == b) {
3638                             /* What was added is a constant string */
3639                             if (mincount > 1) {
3640                                 SvGROW(last_str, (mincount * l) + 1);
3641                                 repeatcpy(SvPVX(last_str) + l,
3642                                           SvPVX_const(last_str), l, mincount - 1);
3643                                 SvCUR_set(last_str, SvCUR(last_str) * mincount);
3644                                 /* Add additional parts. */
3645                                 SvCUR_set(data->last_found,
3646                                           SvCUR(data->last_found) - l);
3647                                 sv_catsv(data->last_found, last_str);
3648                                 {
3649                                     SV * sv = data->last_found;
3650                                     MAGIC *mg =
3651                                         SvUTF8(sv) && SvMAGICAL(sv) ?
3652                                         mg_find(sv, PERL_MAGIC_utf8) : NULL;
3653                                     if (mg && mg->mg_len >= 0)
3654                                         mg->mg_len += CHR_SVLEN(last_str) - l;
3655                                 }
3656                                 data->last_end += l * (mincount - 1);
3657                             }
3658                         } else {
3659                             /* start offset must point into the last copy */
3660                             data->last_start_min += minnext * (mincount - 1);
3661                             data->last_start_max += is_inf ? I32_MAX
3662                                 : (maxcount - 1) * (minnext + data->pos_delta);
3663                         }
3664                     }
3665                     /* It is counted once already... */
3666                     data->pos_min += minnext * (mincount - counted);
3667                     data->pos_delta += - counted * deltanext +
3668                         (minnext + deltanext) * maxcount - minnext * mincount;
3669                     if (mincount != maxcount) {
3670                          /* Cannot extend fixed substrings found inside
3671                             the group.  */
3672                         SCAN_COMMIT(pRExC_state,data,minlenp);
3673                         if (mincount && last_str) {
3674                             SV * const sv = data->last_found;
3675                             MAGIC * const mg = SvUTF8(sv) && SvMAGICAL(sv) ?
3676                                 mg_find(sv, PERL_MAGIC_utf8) : NULL;
3677
3678                             if (mg)
3679                                 mg->mg_len = -1;
3680                             sv_setsv(sv, last_str);
3681                             data->last_end = data->pos_min;
3682                             data->last_start_min =
3683                                 data->pos_min - CHR_SVLEN(last_str);
3684                             data->last_start_max = is_inf
3685                                 ? I32_MAX
3686                                 : data->pos_min + data->pos_delta
3687                                 - CHR_SVLEN(last_str);
3688                         }
3689                         data->longest = &(data->longest_float);
3690                     }
3691                     SvREFCNT_dec(last_str);
3692                 }
3693                 if (data && (fl & SF_HAS_EVAL))
3694                     data->flags |= SF_HAS_EVAL;
3695               optimize_curly_tail:
3696                 if (OP(oscan) != CURLYX) {
3697                     while (PL_regkind[OP(next = regnext(oscan))] == NOTHING
3698                            && NEXT_OFF(next))
3699                         NEXT_OFF(oscan) += NEXT_OFF(next);
3700                 }
3701                 continue;
3702             default:                    /* REF, ANYOFV, and CLUMP only? */
3703                 if (flags & SCF_DO_SUBSTR) {
3704                     SCAN_COMMIT(pRExC_state,data,minlenp);      /* Cannot expect anything... */
3705                     data->longest = &(data->longest_float);
3706                 }
3707                 is_inf = is_inf_internal = 1;
3708                 if (flags & SCF_DO_STCLASS_OR)
3709                     cl_anything(pRExC_state, data->start_class);
3710                 flags &= ~SCF_DO_STCLASS;
3711                 break;
3712             }
3713         }
3714         else if (OP(scan) == LNBREAK) {
3715             if (flags & SCF_DO_STCLASS) {
3716                 int value = 0;
3717                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
3718                 if (flags & SCF_DO_STCLASS_AND) {
3719                     for (value = 0; value < 256; value++)
3720                         if (!is_VERTWS_cp(value))
3721                             ANYOF_BITMAP_CLEAR(data->start_class, value);
3722                 }
3723                 else {
3724                     for (value = 0; value < 256; value++)
3725                         if (is_VERTWS_cp(value))
3726                             ANYOF_BITMAP_SET(data->start_class, value);
3727                 }
3728                 if (flags & SCF_DO_STCLASS_OR)
3729                     cl_and(data->start_class, and_withp);
3730                 flags &= ~SCF_DO_STCLASS;
3731             }
3732             min += 1;
3733             delta += 1;
3734             if (flags & SCF_DO_SUBSTR) {
3735                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
3736                 data->pos_min += 1;
3737                 data->pos_delta += 1;
3738                 data->longest = &(data->longest_float);
3739             }
3740         }
3741         else if (OP(scan) == FOLDCHAR) {
3742             int d = ARG(scan) == LATIN_SMALL_LETTER_SHARP_S ? 1 : 2;
3743             flags &= ~SCF_DO_STCLASS;
3744             min += 1;
3745             delta += d;
3746             if (flags & SCF_DO_SUBSTR) {
3747                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
3748                 data->pos_min += 1;
3749                 data->pos_delta += d;
3750                 data->longest = &(data->longest_float);
3751             }
3752         }
3753         else if (REGNODE_SIMPLE(OP(scan))) {
3754             int value = 0;
3755
3756             if (flags & SCF_DO_SUBSTR) {
3757                 SCAN_COMMIT(pRExC_state,data,minlenp);
3758                 data->pos_min++;
3759             }
3760             min++;
3761             if (flags & SCF_DO_STCLASS) {
3762                 data->start_class->flags &= ~ANYOF_EOS; /* No match on empty */
3763
3764                 /* Some of the logic below assumes that switching
3765                    locale on will only add false positives. */
3766                 switch (PL_regkind[OP(scan)]) {
3767                 case SANY:
3768                 default:
3769                   do_default:
3770                     /* Perl_croak(aTHX_ "panic: unexpected simple REx opcode %d", OP(scan)); */
3771                     if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
3772                         cl_anything(pRExC_state, data->start_class);
3773                     break;
3774                 case REG_ANY:
3775                     if (OP(scan) == SANY)
3776                         goto do_default;
3777                     if (flags & SCF_DO_STCLASS_OR) { /* Everything but \n */
3778                         value = (ANYOF_BITMAP_TEST(data->start_class,'\n')
3779                                  || ANYOF_CLASS_TEST_ANY_SET(data->start_class));
3780                         cl_anything(pRExC_state, data->start_class);
3781                     }
3782                     if (flags & SCF_DO_STCLASS_AND || !value)
3783                         ANYOF_BITMAP_CLEAR(data->start_class,'\n');
3784                     break;
3785                 case ANYOF:
3786                     if (flags & SCF_DO_STCLASS_AND)
3787                         cl_and(data->start_class,
3788                                (struct regnode_charclass_class*)scan);
3789                     else
3790                         cl_or(pRExC_state, data->start_class,
3791                               (struct regnode_charclass_class*)scan);
3792                     break;
3793                 case ALNUM:
3794                     if (flags & SCF_DO_STCLASS_AND) {
3795                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3796                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NALNUM);
3797                             if (OP(scan) == ALNUMU) {
3798                                 for (value = 0; value < 256; value++) {
3799                                     if (!isWORDCHAR_L1(value)) {
3800                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3801                                     }
3802                                 }
3803                             } else {
3804                                 for (value = 0; value < 256; value++) {
3805                                     if (!isALNUM(value)) {
3806                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3807                                     }
3808                                 }
3809                             }
3810                         }
3811                     }
3812                     else {
3813                         if (data->start_class->flags & ANYOF_LOCALE)
3814                             ANYOF_CLASS_SET(data->start_class,ANYOF_ALNUM);
3815
3816                         /* Even if under locale, set the bits for non-locale
3817                          * in case it isn't a true locale-node.  This will
3818                          * create false positives if it truly is locale */
3819                         if (OP(scan) == ALNUMU) {
3820                             for (value = 0; value < 256; value++) {
3821                                 if (isWORDCHAR_L1(value)) {
3822                                     ANYOF_BITMAP_SET(data->start_class, value);
3823                                 }
3824                             }
3825                         } else {
3826                             for (value = 0; value < 256; value++) {
3827                                 if (isALNUM(value)) {
3828                                     ANYOF_BITMAP_SET(data->start_class, value);
3829                                 }
3830                             }
3831                         }
3832                     }
3833                     break;
3834                 case NALNUM:
3835                     if (flags & SCF_DO_STCLASS_AND) {
3836                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3837                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_ALNUM);
3838                             if (OP(scan) == NALNUMU) {
3839                                 for (value = 0; value < 256; value++) {
3840                                     if (isWORDCHAR_L1(value)) {
3841                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3842                                     }
3843                                 }
3844                             } else {
3845                                 for (value = 0; value < 256; value++) {
3846                                     if (isALNUM(value)) {
3847                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3848                                     }
3849                                 }
3850                             }
3851                         }
3852                     }
3853                     else {
3854                         if (data->start_class->flags & ANYOF_LOCALE)
3855                             ANYOF_CLASS_SET(data->start_class,ANYOF_NALNUM);
3856
3857                         /* Even if under locale, set the bits for non-locale in
3858                          * case it isn't a true locale-node.  This will create
3859                          * false positives if it truly is locale */
3860                         if (OP(scan) == NALNUMU) {
3861                             for (value = 0; value < 256; value++) {
3862                                 if (! isWORDCHAR_L1(value)) {
3863                                     ANYOF_BITMAP_SET(data->start_class, value);
3864                                 }
3865                             }
3866                         } else {
3867                             for (value = 0; value < 256; value++) {
3868                                 if (! isALNUM(value)) {
3869                                     ANYOF_BITMAP_SET(data->start_class, value);
3870                                 }
3871                             }
3872                         }
3873                     }
3874                     break;
3875                 case SPACE:
3876                     if (flags & SCF_DO_STCLASS_AND) {
3877                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3878                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NSPACE);
3879                             if (OP(scan) == SPACEU) {
3880                                 for (value = 0; value < 256; value++) {
3881                                     if (!isSPACE_L1(value)) {
3882                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3883                                     }
3884                                 }
3885                             } else {
3886                                 for (value = 0; value < 256; value++) {
3887                                     if (!isSPACE(value)) {
3888                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3889                                     }
3890                                 }
3891                             }
3892                         }
3893                     }
3894                     else {
3895                         if (data->start_class->flags & ANYOF_LOCALE) {
3896                             ANYOF_CLASS_SET(data->start_class,ANYOF_SPACE);
3897                         }
3898                         if (OP(scan) == SPACEU) {
3899                             for (value = 0; value < 256; value++) {
3900                                 if (isSPACE_L1(value)) {
3901                                     ANYOF_BITMAP_SET(data->start_class, value);
3902                                 }
3903                             }
3904                         } else {
3905                             for (value = 0; value < 256; value++) {
3906                                 if (isSPACE(value)) {
3907                                     ANYOF_BITMAP_SET(data->start_class, value);
3908                                 }
3909                             }
3910                         }
3911                     }
3912                     break;
3913                 case NSPACE:
3914                     if (flags & SCF_DO_STCLASS_AND) {
3915                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3916                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_SPACE);
3917                             if (OP(scan) == NSPACEU) {
3918                                 for (value = 0; value < 256; value++) {
3919                                     if (isSPACE_L1(value)) {
3920                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3921                                     }
3922                                 }
3923                             } else {
3924                                 for (value = 0; value < 256; value++) {
3925                                     if (isSPACE(value)) {
3926                                         ANYOF_BITMAP_CLEAR(data->start_class, value);
3927                                     }
3928                                 }
3929                             }
3930                         }
3931                     }
3932                     else {
3933                         if (data->start_class->flags & ANYOF_LOCALE)
3934                             ANYOF_CLASS_SET(data->start_class,ANYOF_NSPACE);
3935                         if (OP(scan) == NSPACEU) {
3936                             for (value = 0; value < 256; value++) {
3937                                 if (!isSPACE_L1(value)) {
3938                                     ANYOF_BITMAP_SET(data->start_class, value);
3939                                 }
3940                             }
3941                         }
3942                         else {
3943                             for (value = 0; value < 256; value++) {
3944                                 if (!isSPACE(value)) {
3945                                     ANYOF_BITMAP_SET(data->start_class, value);
3946                                 }
3947                             }
3948                         }
3949                     }
3950                     break;
3951                 case DIGIT:
3952                     if (flags & SCF_DO_STCLASS_AND) {
3953                         if (!(data->start_class->flags & ANYOF_LOCALE)) {
3954                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_NDIGIT);
3955                             for (value = 0; value < 256; value++)
3956                                 if (!isDIGIT(value))
3957                                     ANYOF_BITMAP_CLEAR(data->start_class, value);
3958                         }
3959                     }
3960                     else {
3961                         if (data->start_class->flags & ANYOF_LOCALE)
3962                             ANYOF_CLASS_SET(data->start_class,ANYOF_DIGIT);
3963                         for (value = 0; value < 256; value++)
3964                             if (isDIGIT(value))
3965                                 ANYOF_BITMAP_SET(data->start_class, value);
3966                     }
3967                     break;
3968                 case NDIGIT:
3969                     if (flags & SCF_DO_STCLASS_AND) {
3970                         if (!(data->start_class->flags & ANYOF_LOCALE))
3971                             ANYOF_CLASS_CLEAR(data->start_class,ANYOF_DIGIT);
3972                         for (value = 0; value < 256; value++)
3973                             if (isDIGIT(value))
3974                                 ANYOF_BITMAP_CLEAR(data->start_class, value);
3975                     }
3976                     else {
3977                         if (data->start_class->flags & ANYOF_LOCALE)
3978                             ANYOF_CLASS_SET(data->start_class,ANYOF_NDIGIT);
3979                         for (value = 0; value < 256; value++)
3980                             if (!isDIGIT(value))
3981                                 ANYOF_BITMAP_SET(data->start_class, value);
3982                     }
3983                     break;
3984                 CASE_SYNST_FNC(VERTWS);
3985                 CASE_SYNST_FNC(HORIZWS);
3986                 
3987                 }
3988                 if (flags & SCF_DO_STCLASS_OR)
3989                     cl_and(data->start_class, and_withp);
3990                 flags &= ~SCF_DO_STCLASS;
3991             }
3992         }
3993         else if (PL_regkind[OP(scan)] == EOL && flags & SCF_DO_SUBSTR) {
3994             data->flags |= (OP(scan) == MEOL
3995                             ? SF_BEFORE_MEOL
3996                             : SF_BEFORE_SEOL);
3997         }
3998         else if (  PL_regkind[OP(scan)] == BRANCHJ
3999                  /* Lookbehind, or need to calculate parens/evals/stclass: */
4000                    && (scan->flags || data || (flags & SCF_DO_STCLASS))
4001                    && (OP(scan) == IFMATCH || OP(scan) == UNLESSM)) {
4002             if ( !PERL_ENABLE_POSITIVE_ASSERTION_STUDY 
4003                 || OP(scan) == UNLESSM )
4004             {
4005                 /* Negative Lookahead/lookbehind
4006                    In this case we can't do fixed string optimisation.
4007                 */
4008
4009                 I32 deltanext, minnext, fake = 0;
4010                 regnode *nscan;
4011                 struct regnode_charclass_class intrnl;
4012                 int f = 0;
4013
4014                 data_fake.flags = 0;
4015                 if (data) {
4016                     data_fake.whilem_c = data->whilem_c;
4017                     data_fake.last_closep = data->last_closep;
4018                 }
4019                 else
4020                     data_fake.last_closep = &fake;
4021                 data_fake.pos_delta = delta;
4022                 if ( flags & SCF_DO_STCLASS && !scan->flags
4023                      && OP(scan) == IFMATCH ) { /* Lookahead */
4024                     cl_init(pRExC_state, &intrnl);
4025                     data_fake.start_class = &intrnl;
4026                     f |= SCF_DO_STCLASS_AND;
4027                 }
4028                 if (flags & SCF_WHILEM_VISITED_POS)
4029                     f |= SCF_WHILEM_VISITED_POS;
4030                 next = regnext(scan);
4031                 nscan = NEXTOPER(NEXTOPER(scan));
4032                 minnext = study_chunk(pRExC_state, &nscan, minlenp, &deltanext, 
4033                     last, &data_fake, stopparen, recursed, NULL, f, depth+1);
4034                 if (scan->flags) {
4035                     if (deltanext) {
4036                         FAIL("Variable length lookbehind not implemented");
4037                     }
4038                     else if (minnext > (I32)U8_MAX) {
4039                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4040                     }
4041                     scan->flags = (U8)minnext;
4042                 }
4043                 if (data) {
4044                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4045                         pars++;
4046                     if (data_fake.flags & SF_HAS_EVAL)
4047                         data->flags |= SF_HAS_EVAL;
4048                     data->whilem_c = data_fake.whilem_c;
4049                 }
4050                 if (f & SCF_DO_STCLASS_AND) {
4051                     if (flags & SCF_DO_STCLASS_OR) {
4052                         /* OR before, AND after: ideally we would recurse with
4053                          * data_fake to get the AND applied by study of the
4054                          * remainder of the pattern, and then derecurse;
4055                          * *** HACK *** for now just treat as "no information".
4056                          * See [perl #56690].
4057                          */
4058                         cl_init(pRExC_state, data->start_class);
4059                     }  else {
4060                         /* AND before and after: combine and continue */
4061                         const int was = (data->start_class->flags & ANYOF_EOS);
4062
4063                         cl_and(data->start_class, &intrnl);
4064                         if (was)
4065                             data->start_class->flags |= ANYOF_EOS;
4066                     }
4067                 }
4068             }
4069 #if PERL_ENABLE_POSITIVE_ASSERTION_STUDY
4070             else {
4071                 /* Positive Lookahead/lookbehind
4072                    In this case we can do fixed string optimisation,
4073                    but we must be careful about it. Note in the case of
4074                    lookbehind the positions will be offset by the minimum
4075                    length of the pattern, something we won't know about
4076                    until after the recurse.
4077                 */
4078                 I32 deltanext, fake = 0;
4079                 regnode *nscan;
4080                 struct regnode_charclass_class intrnl;
4081                 int f = 0;
4082                 /* We use SAVEFREEPV so that when the full compile 
4083                     is finished perl will clean up the allocated 
4084                     minlens when it's all done. This way we don't
4085                     have to worry about freeing them when we know
4086                     they wont be used, which would be a pain.
4087                  */
4088                 I32 *minnextp;
4089                 Newx( minnextp, 1, I32 );
4090                 SAVEFREEPV(minnextp);
4091
4092                 if (data) {
4093                     StructCopy(data, &data_fake, scan_data_t);
4094                     if ((flags & SCF_DO_SUBSTR) && data->last_found) {
4095                         f |= SCF_DO_SUBSTR;
4096                         if (scan->flags) 
4097                             SCAN_COMMIT(pRExC_state, &data_fake,minlenp);
4098                         data_fake.last_found=newSVsv(data->last_found);
4099                     }
4100                 }
4101                 else
4102                     data_fake.last_closep = &fake;
4103                 data_fake.flags = 0;
4104                 data_fake.pos_delta = delta;
4105                 if (is_inf)
4106                     data_fake.flags |= SF_IS_INF;
4107                 if ( flags & SCF_DO_STCLASS && !scan->flags
4108                      && OP(scan) == IFMATCH ) { /* Lookahead */
4109                     cl_init(pRExC_state, &intrnl);
4110                     data_fake.start_class = &intrnl;
4111                     f |= SCF_DO_STCLASS_AND;
4112                 }
4113                 if (flags & SCF_WHILEM_VISITED_POS)
4114                     f |= SCF_WHILEM_VISITED_POS;
4115                 next = regnext(scan);
4116                 nscan = NEXTOPER(NEXTOPER(scan));
4117
4118                 *minnextp = study_chunk(pRExC_state, &nscan, minnextp, &deltanext, 
4119                     last, &data_fake, stopparen, recursed, NULL, f,depth+1);
4120                 if (scan->flags) {
4121                     if (deltanext) {
4122                         FAIL("Variable length lookbehind not implemented");
4123                     }
4124                     else if (*minnextp > (I32)U8_MAX) {
4125                         FAIL2("Lookbehind longer than %"UVuf" not implemented", (UV)U8_MAX);
4126                     }
4127                     scan->flags = (U8)*minnextp;
4128                 }
4129
4130                 *minnextp += min;
4131
4132                 if (f & SCF_DO_STCLASS_AND) {
4133                     const int was = (data->start_class->flags & ANYOF_EOS);
4134
4135                     cl_and(data->start_class, &intrnl);
4136                     if (was)
4137                         data->start_class->flags |= ANYOF_EOS;
4138                 }
4139                 if (data) {
4140                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4141                         pars++;
4142                     if (data_fake.flags & SF_HAS_EVAL)
4143                         data->flags |= SF_HAS_EVAL;
4144                     data->whilem_c = data_fake.whilem_c;
4145                     if ((flags & SCF_DO_SUBSTR) && data_fake.last_found) {
4146                         if (RExC_rx->minlen<*minnextp)
4147                             RExC_rx->minlen=*minnextp;
4148                         SCAN_COMMIT(pRExC_state, &data_fake, minnextp);
4149                         SvREFCNT_dec(data_fake.last_found);
4150                         
4151                         if ( data_fake.minlen_fixed != minlenp ) 
4152                         {
4153                             data->offset_fixed= data_fake.offset_fixed;
4154                             data->minlen_fixed= data_fake.minlen_fixed;
4155                             data->lookbehind_fixed+= scan->flags;
4156                         }
4157                         if ( data_fake.minlen_float != minlenp )
4158                         {
4159                             data->minlen_float= data_fake.minlen_float;
4160                             data->offset_float_min=data_fake.offset_float_min;
4161                             data->offset_float_max=data_fake.offset_float_max;
4162                             data->lookbehind_float+= scan->flags;
4163                         }
4164                     }
4165                 }
4166
4167
4168             }
4169 #endif
4170         }
4171         else if (OP(scan) == OPEN) {
4172             if (stopparen != (I32)ARG(scan))
4173                 pars++;
4174         }
4175         else if (OP(scan) == CLOSE) {
4176             if (stopparen == (I32)ARG(scan)) {
4177                 break;
4178             }
4179             if ((I32)ARG(scan) == is_par) {
4180                 next = regnext(scan);
4181
4182                 if ( next && (OP(next) != WHILEM) && next < last)
4183                     is_par = 0;         /* Disable optimization */
4184             }
4185             if (data)
4186                 *(data->last_closep) = ARG(scan);
4187         }
4188         else if (OP(scan) == EVAL) {
4189                 if (data)
4190                     data->flags |= SF_HAS_EVAL;
4191         }
4192         else if ( PL_regkind[OP(scan)] == ENDLIKE ) {
4193             if (flags & SCF_DO_SUBSTR) {
4194                 SCAN_COMMIT(pRExC_state,data,minlenp);
4195                 flags &= ~SCF_DO_SUBSTR;
4196             }
4197             if (data && OP(scan)==ACCEPT) {
4198                 data->flags |= SCF_SEEN_ACCEPT;
4199                 if (stopmin > min)
4200                     stopmin = min;
4201             }
4202         }
4203         else if (OP(scan) == LOGICAL && scan->flags == 2) /* Embedded follows */
4204         {
4205                 if (flags & SCF_DO_SUBSTR) {
4206                     SCAN_COMMIT(pRExC_state,data,minlenp);
4207                     data->longest = &(data->longest_float);
4208                 }
4209                 is_inf = is_inf_internal = 1;
4210                 if (flags & SCF_DO_STCLASS_OR) /* Allow everything */
4211                     cl_anything(pRExC_state, data->start_class);
4212                 flags &= ~SCF_DO_STCLASS;
4213         }
4214         else if (OP(scan) == GPOS) {
4215             if (!(RExC_rx->extflags & RXf_GPOS_FLOAT) &&
4216                 !(delta || is_inf || (data && data->pos_delta))) 
4217             {
4218                 if (!(RExC_rx->extflags & RXf_ANCH) && (flags & SCF_DO_SUBSTR))
4219                     RExC_rx->extflags |= RXf_ANCH_GPOS;
4220                 if (RExC_rx->gofs < (U32)min)
4221                     RExC_rx->gofs = min;
4222             } else {
4223                 RExC_rx->extflags |= RXf_GPOS_FLOAT;
4224                 RExC_rx->gofs = 0;
4225             }       
4226         }
4227 #ifdef TRIE_STUDY_OPT
4228 #ifdef FULL_TRIE_STUDY
4229         else if (PL_regkind[OP(scan)] == TRIE) {
4230             /* NOTE - There is similar code to this block above for handling
4231                BRANCH nodes on the initial study.  If you change stuff here
4232                check there too. */
4233             regnode *trie_node= scan;
4234             regnode *tail= regnext(scan);
4235             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4236             I32 max1 = 0, min1 = I32_MAX;
4237             struct regnode_charclass_class accum;
4238
4239             if (flags & SCF_DO_SUBSTR) /* XXXX Add !SUSPEND? */
4240                 SCAN_COMMIT(pRExC_state, data,minlenp); /* Cannot merge strings after this. */
4241             if (flags & SCF_DO_STCLASS)
4242                 cl_init_zero(pRExC_state, &accum);
4243                 
4244             if (!trie->jump) {
4245                 min1= trie->minlen;
4246                 max1= trie->maxlen;
4247             } else {
4248                 const regnode *nextbranch= NULL;
4249                 U32 word;
4250                 
4251                 for ( word=1 ; word <= trie->wordcount ; word++) 
4252                 {
4253                     I32 deltanext=0, minnext=0, f = 0, fake;
4254                     struct regnode_charclass_class this_class;
4255                     
4256                     data_fake.flags = 0;
4257                     if (data) {
4258                         data_fake.whilem_c = data->whilem_c;
4259                         data_fake.last_closep = data->last_closep;
4260                     }
4261                     else
4262                         data_fake.last_closep = &fake;
4263                     data_fake.pos_delta = delta;
4264                     if (flags & SCF_DO_STCLASS) {
4265                         cl_init(pRExC_state, &this_class);
4266                         data_fake.start_class = &this_class;
4267                         f = SCF_DO_STCLASS_AND;
4268                     }
4269                     if (flags & SCF_WHILEM_VISITED_POS)
4270                         f |= SCF_WHILEM_VISITED_POS;
4271     
4272                     if (trie->jump[word]) {
4273                         if (!nextbranch)
4274                             nextbranch = trie_node + trie->jump[0];
4275                         scan= trie_node + trie->jump[word];
4276                         /* We go from the jump point to the branch that follows
4277                            it. Note this means we need the vestigal unused branches
4278                            even though they arent otherwise used.
4279                          */
4280                         minnext = study_chunk(pRExC_state, &scan, minlenp, 
4281                             &deltanext, (regnode *)nextbranch, &data_fake, 
4282                             stopparen, recursed, NULL, f,depth+1);
4283                     }
4284                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
4285                         nextbranch= regnext((regnode*)nextbranch);
4286                     
4287                     if (min1 > (I32)(minnext + trie->minlen))
4288                         min1 = minnext + trie->minlen;
4289                     if (max1 < (I32)(minnext + deltanext + trie->maxlen))
4290                         max1 = minnext + deltanext + trie->maxlen;
4291                     if (deltanext == I32_MAX)
4292                         is_inf = is_inf_internal = 1;
4293                     
4294                     if (data_fake.flags & (SF_HAS_PAR|SF_IN_PAR))
4295                         pars++;
4296                     if (data_fake.flags & SCF_SEEN_ACCEPT) {
4297                         if ( stopmin > min + min1) 
4298                             stopmin = min + min1;
4299                         flags &= ~SCF_DO_SUBSTR;
4300                         if (data)
4301                             data->flags |= SCF_SEEN_ACCEPT;
4302                     }
4303                     if (data) {
4304                         if (data_fake.flags & SF_HAS_EVAL)
4305                             data->flags |= SF_HAS_EVAL;
4306                         data->whilem_c = data_fake.whilem_c;
4307                     }
4308                     if (flags & SCF_DO_STCLASS)
4309                         cl_or(pRExC_state, &accum, &this_class);
4310                 }
4311             }
4312             if (flags & SCF_DO_SUBSTR) {
4313                 data->pos_min += min1;
4314                 data->pos_delta += max1 - min1;
4315                 if (max1 != min1 || is_inf)
4316                     data->longest = &(data->longest_float);
4317             }
4318             min += min1;
4319             delta += max1 - min1;
4320             if (flags & SCF_DO_STCLASS_OR) {
4321                 cl_or(pRExC_state, data->start_class, &accum);
4322                 if (min1) {
4323                     cl_and(data->start_class, and_withp);
4324                     flags &= ~SCF_DO_STCLASS;
4325                 }
4326             }
4327             else if (flags & SCF_DO_STCLASS_AND) {
4328                 if (min1) {
4329                     cl_and(data->start_class, &accum);
4330                     flags &= ~SCF_DO_STCLASS;
4331                 }
4332                 else {
4333                     /* Switch to OR mode: cache the old value of
4334                      * data->start_class */
4335                     INIT_AND_WITHP;
4336                     StructCopy(data->start_class, and_withp,
4337                                struct regnode_charclass_class);
4338                     flags &= ~SCF_DO_STCLASS_AND;
4339                     StructCopy(&accum, data->start_class,
4340                                struct regnode_charclass_class);
4341                     flags |= SCF_DO_STCLASS_OR;
4342                     data->start_class->flags |= ANYOF_EOS;
4343                 }
4344             }
4345             scan= tail;
4346             continue;
4347         }
4348 #else
4349         else if (PL_regkind[OP(scan)] == TRIE) {
4350             reg_trie_data *trie = (reg_trie_data*)RExC_rxi->data->data[ ARG(scan) ];
4351             U8*bang=NULL;
4352             
4353             min += trie->minlen;
4354             delta += (trie->maxlen - trie->minlen);
4355             flags &= ~SCF_DO_STCLASS; /* xxx */
4356             if (flags & SCF_DO_SUBSTR) {
4357                 SCAN_COMMIT(pRExC_state,data,minlenp);  /* Cannot expect anything... */
4358                 data->pos_min += trie->minlen;
4359                 data->pos_delta += (trie->maxlen - trie->minlen);
4360                 if (trie->maxlen != trie->minlen)
4361                     data->longest = &(data->longest_float);
4362             }
4363             if (trie->jump) /* no more substrings -- for now /grr*/
4364                 flags &= ~SCF_DO_SUBSTR; 
4365         }
4366 #endif /* old or new */
4367 #endif /* TRIE_STUDY_OPT */     
4368
4369         /* Else: zero-length, ignore. */
4370         scan = regnext(scan);
4371     }
4372     if (frame) {
4373         last = frame->last;
4374         scan = frame->next;
4375         stopparen = frame->stop;
4376         frame = frame->prev;
4377         goto fake_study_recurse;
4378     }
4379
4380   finish:
4381     assert(!frame);
4382     DEBUG_STUDYDATA("pre-fin:",data,depth);
4383
4384     *scanp = scan;
4385     *deltap = is_inf_internal ? I32_MAX : delta;
4386     if (flags & SCF_DO_SUBSTR && is_inf)
4387         data->pos_delta = I32_MAX - data->pos_min;
4388     if (is_par > (I32)U8_MAX)
4389         is_par = 0;
4390     if (is_par && pars==1 && data) {
4391         data->flags |= SF_IN_PAR;
4392         data->flags &= ~SF_HAS_PAR;
4393     }
4394     else if (pars && data) {
4395         data->flags |= SF_HAS_PAR;
4396         data->flags &= ~SF_IN_PAR;
4397     }
4398     if (flags & SCF_DO_STCLASS_OR)
4399         cl_and(data->start_class, and_withp);
4400     if (flags & SCF_TRIE_RESTUDY)
4401         data->flags |=  SCF_TRIE_RESTUDY;
4402     
4403     DEBUG_STUDYDATA("post-fin:",data,depth);
4404     
4405     return min < stopmin ? min : stopmin;
4406 }
4407
4408 STATIC U32
4409 S_add_data(RExC_state_t *pRExC_state, U32 n, const char *s)
4410 {
4411     U32 count = RExC_rxi->data ? RExC_rxi->data->count : 0;
4412
4413     PERL_ARGS_ASSERT_ADD_DATA;
4414
4415     Renewc(RExC_rxi->data,
4416            sizeof(*RExC_rxi->data) + sizeof(void*) * (count + n - 1),
4417            char, struct reg_data);
4418     if(count)
4419         Renew(RExC_rxi->data->what, count + n, U8);
4420     else
4421         Newx(RExC_rxi->data->what, n, U8);
4422     RExC_rxi->data->count = count + n;
4423     Copy(s, RExC_rxi->data->what + count, n, U8);
4424     return count;
4425 }
4426
4427 /*XXX: todo make this not included in a non debugging perl */
4428 #ifndef PERL_IN_XSUB_RE
4429 void
4430 Perl_reginitcolors(pTHX)
4431 {
4432     dVAR;
4433     const char * const s = PerlEnv_getenv("PERL_RE_COLORS");
4434     if (s) {
4435         char *t = savepv(s);
4436         int i = 0;
4437         PL_colors[0] = t;
4438         while (++i < 6) {
4439             t = strchr(t, '\t');
4440             if (t) {
4441                 *t = '\0';
4442                 PL_colors[i] = ++t;
4443             }
4444             else
4445                 PL_colors[i] = t = (char *)"";
4446         }
4447     } else {
4448         int i = 0;
4449         while (i < 6)
4450             PL_colors[i++] = (char *)"";
4451     }
4452     PL_colorset = 1;
4453 }
4454 #endif
4455
4456
4457 #ifdef TRIE_STUDY_OPT
4458 #define CHECK_RESTUDY_GOTO                                  \
4459         if (                                                \
4460               (data.flags & SCF_TRIE_RESTUDY)               \
4461               && ! restudied++                              \
4462         )     goto reStudy
4463 #else
4464 #define CHECK_RESTUDY_GOTO
4465 #endif        
4466
4467 /*
4468  - pregcomp - compile a regular expression into internal code
4469  *
4470  * We can't allocate space until we know how big the compiled form will be,
4471  * but we can't compile it (and thus know how big it is) until we've got a
4472  * place to put the code.  So we cheat:  we compile it twice, once with code
4473  * generation turned off and size counting turned on, and once "for real".
4474  * This also means that we don't allocate space until we are sure that the
4475  * thing really will compile successfully, and we never have to move the
4476  * code and thus invalidate pointers into it.  (Note that it has to be in
4477  * one piece because free() must be able to free it all.) [NB: not true in perl]
4478  *
4479  * Beware that the optimization-preparation code in here knows about some
4480  * of the structure of the compiled regexp.  [I'll say.]
4481  */
4482
4483
4484
4485 #ifndef PERL_IN_XSUB_RE
4486 #define RE_ENGINE_PTR &reh_regexp_engine
4487 #else
4488 extern const struct regexp_engine my_reg_engine;
4489 #define RE_ENGINE_PTR &my_reg_engine
4490 #endif
4491
4492 #ifndef PERL_IN_XSUB_RE 
4493 REGEXP *
4494 Perl_pregcomp(pTHX_ SV * const pattern, const U32 flags)
4495 {
4496     dVAR;
4497     HV * const table = GvHV(PL_hintgv);
4498
4499     PERL_ARGS_ASSERT_PREGCOMP;
4500
4501     /* Dispatch a request to compile a regexp to correct 
4502        regexp engine. */
4503     if (table) {
4504         SV **ptr= hv_fetchs(table, "regcomp", FALSE);
4505         GET_RE_DEBUG_FLAGS_DECL;
4506         if (ptr && SvIOK(*ptr) && SvIV(*ptr)) {
4507             const regexp_engine *eng=INT2PTR(regexp_engine*,SvIV(*ptr));
4508             DEBUG_COMPILE_r({
4509                 PerlIO_printf(Perl_debug_log, "Using engine %"UVxf"\n",
4510                     SvIV(*ptr));
4511             });            
4512             return CALLREGCOMP_ENG(eng, pattern, flags);
4513         } 
4514     }
4515     return Perl_re_compile(aTHX_ pattern, flags);
4516 }
4517 #endif
4518
4519 REGEXP *
4520 Perl_re_compile(pTHX_ SV * const pattern, U32 orig_pm_flags)
4521 {
4522     dVAR;
4523     REGEXP *rx;
4524     struct regexp *r;
4525     register regexp_internal *ri;
4526     STRLEN plen;
4527     char  *exp;
4528     char* xend;
4529     regnode *scan;
4530     I32 flags;
4531     I32 minlen = 0;
4532     U32 pm_flags;
4533
4534     /* these are all flags - maybe they should be turned
4535      * into a single int with different bit masks */
4536     I32 sawlookahead = 0;
4537     I32 sawplus = 0;
4538     I32 sawopen = 0;
4539     bool used_setjump = FALSE;
4540     regex_charset initial_charset = get_regex_charset(orig_pm_flags);
4541
4542     U8 jump_ret = 0;
4543     dJMPENV;
4544     scan_data_t data;
4545     RExC_state_t RExC_state;
4546     RExC_state_t * const pRExC_state = &RExC_state;
4547 #ifdef TRIE_STUDY_OPT    
4548     int restudied;
4549     RExC_state_t copyRExC_state;
4550 #endif    
4551     GET_RE_DEBUG_FLAGS_DECL;
4552
4553     PERL_ARGS_ASSERT_RE_COMPILE;
4554
4555     DEBUG_r(if (!PL_colorset) reginitcolors());
4556
4557     RExC_utf8 = RExC_orig_utf8 = SvUTF8(pattern);
4558     RExC_uni_semantics = 0;
4559     RExC_contains_locale = 0;
4560
4561     /****************** LONG JUMP TARGET HERE***********************/
4562     /* Longjmp back to here if have to switch in midstream to utf8 */
4563     if (! RExC_orig_utf8) {
4564         JMPENV_PUSH(jump_ret);
4565         used_setjump = TRUE;
4566     }
4567
4568     if (jump_ret == 0) {    /* First time through */
4569         exp = SvPV(pattern, plen);
4570         xend = exp + plen;
4571         /* ignore the utf8ness if the pattern is 0 length */
4572         if (plen == 0) {
4573             RExC_utf8 = RExC_orig_utf8 = 0;
4574         }
4575
4576         DEBUG_COMPILE_r({
4577             SV *dsv= sv_newmortal();
4578             RE_PV_QUOTED_DECL(s, RExC_utf8,
4579                 dsv, exp, plen, 60);
4580             PerlIO_printf(Perl_debug_log, "%sCompiling REx%s %s\n",
4581                            PL_colors[4],PL_colors[5],s);
4582         });
4583     }
4584     else {  /* longjumped back */
4585         STRLEN len = plen;
4586
4587         /* If the cause for the longjmp was other than changing to utf8, pop
4588          * our own setjmp, and longjmp to the correct handler */
4589         if (jump_ret != UTF8_LONGJMP) {
4590             JMPENV_POP;
4591             JMPENV_JUMP(jump_ret);
4592         }
4593
4594         GET_RE_DEBUG_FLAGS;
4595
4596         /* It's possible to write a regexp in ascii that represents Unicode
4597         codepoints outside of the byte range, such as via \x{100}. If we
4598         detect such a sequence we have to convert the entire pattern to utf8
4599         and then recompile, as our sizing calculation will have been based
4600         on 1 byte == 1 character, but we will need to use utf8 to encode
4601         at least some part of the pattern, and therefore must convert the whole
4602         thing.
4603         -- dmq */
4604         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log,
4605             "UTF8 mismatch! Converting to utf8 for resizing and compile\n"));
4606         exp = (char*)Perl_bytes_to_utf8(aTHX_ (U8*)SvPV(pattern, plen), &len);
4607         xend = exp + len;
4608         RExC_orig_utf8 = RExC_utf8 = 1;
4609         SAVEFREEPV(exp);
4610     }
4611
4612 #ifdef TRIE_STUDY_OPT
4613     restudied = 0;
4614 #endif
4615
4616     pm_flags = orig_pm_flags;
4617
4618     if (initial_charset == REGEX_LOCALE_CHARSET) {
4619         RExC_contains_locale = 1;
4620     }
4621     else if (RExC_utf8 && initial_charset == REGEX_DEPENDS_CHARSET) {
4622
4623         /* Set to use unicode semantics if the pattern is in utf8 and has the
4624          * 'depends' charset specified, as it means unicode when utf8  */
4625         set_regex_charset(&pm_flags, REGEX_UNICODE_CHARSET);
4626     }
4627
4628     RExC_precomp = exp;
4629     RExC_flags = pm_flags;
4630     RExC_sawback = 0;
4631
4632     RExC_seen = 0;
4633     RExC_in_lookbehind = 0;
4634     RExC_seen_zerolen = *exp == '^' ? -1 : 0;
4635     RExC_seen_evals = 0;
4636     RExC_extralen = 0;
4637     RExC_override_recoding = 0;
4638
4639     /* First pass: determine size, legality. */
4640     RExC_parse = exp;
4641     RExC_start = exp;
4642     RExC_end = xend;
4643     RExC_naughty = 0;
4644     RExC_npar = 1;
4645     RExC_nestroot = 0;
4646     RExC_size = 0L;
4647     RExC_emit = &PL_regdummy;
4648     RExC_whilem_seen = 0;
4649     RExC_open_parens = NULL;
4650     RExC_close_parens = NULL;
4651     RExC_opend = NULL;
4652     RExC_paren_names = NULL;
4653 #ifdef DEBUGGING
4654     RExC_paren_name_list = NULL;
4655 #endif
4656     RExC_recurse = NULL;
4657     RExC_recurse_count = 0;
4658
4659 #if 0 /* REGC() is (currently) a NOP at the first pass.
4660        * Clever compilers notice this and complain. --jhi */
4661     REGC((U8)REG_MAGIC, (char*)RExC_emit);
4662 #endif
4663     DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "Starting first pass (sizing)\n"));
4664     if (reg(pRExC_state, 0, &flags,1) == NULL) {
4665         RExC_precomp = NULL;
4666         return(NULL);
4667     }
4668
4669     /* Here, finished first pass.  Get rid of any added setjmp */
4670     if (used_setjump) {
4671         JMPENV_POP;
4672     }
4673
4674     DEBUG_PARSE_r({
4675         PerlIO_printf(Perl_debug_log, 
4676             "Required size %"IVdf" nodes\n"
4677             "Starting second pass (creation)\n", 
4678             (IV)RExC_size);
4679         RExC_lastnum=0; 
4680         RExC_lastparse=NULL; 
4681     });
4682
4683     /* The first pass could have found things that force Unicode semantics */
4684     if ((RExC_utf8 || RExC_uni_semantics)
4685          && get_regex_charset(pm_flags) == REGEX_DEPENDS_CHARSET)
4686     {
4687         set_regex_charset(&pm_flags, REGEX_UNICODE_CHARSET);
4688     }
4689
4690     /* Small enough for pointer-storage convention?
4691        If extralen==0, this means that we will not need long jumps. */
4692     if (RExC_size >= 0x10000L && RExC_extralen)
4693         RExC_size += RExC_extralen;
4694     else
4695         RExC_extralen = 0;
4696     if (RExC_whilem_seen > 15)
4697         RExC_whilem_seen = 15;
4698
4699     /* Allocate space and zero-initialize. Note, the two step process 
4700        of zeroing when in debug mode, thus anything assigned has to 
4701        happen after that */
4702     rx = (REGEXP*) newSV_type(SVt_REGEXP);
4703     r = (struct regexp*)SvANY(rx);
4704     Newxc(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode),
4705          char, regexp_internal);
4706     if ( r == NULL || ri == NULL )
4707         FAIL("Regexp out of space");
4708 #ifdef DEBUGGING
4709     /* avoid reading uninitialized memory in DEBUGGING code in study_chunk() */
4710     Zero(ri, sizeof(regexp_internal) + (unsigned)RExC_size * sizeof(regnode), char);
4711 #else 
4712     /* bulk initialize base fields with 0. */
4713     Zero(ri, sizeof(regexp_internal), char);        
4714 #endif
4715
4716     /* non-zero initialization begins here */
4717     RXi_SET( r, ri );
4718     r->engine= RE_ENGINE_PTR;
4719     r->extflags = pm_flags;
4720     {
4721         bool has_p     = ((r->extflags & RXf_PMf_KEEPCOPY) == RXf_PMf_KEEPCOPY);
4722         bool has_charset = (get_regex_charset(r->extflags) != REGEX_DEPENDS_CHARSET);
4723
4724         /* The caret is output if there are any defaults: if not all the STD
4725          * flags are set, or if no character set specifier is needed */
4726         bool has_default =
4727                     (((r->extflags & RXf_PMf_STD_PMMOD) != RXf_PMf_STD_PMMOD)
4728                     || ! has_charset);
4729         bool has_runon = ((RExC_seen & REG_SEEN_RUN_ON_COMMENT)==REG_SEEN_RUN_ON_COMMENT);
4730         U16 reganch = (U16)((r->extflags & RXf_PMf_STD_PMMOD)
4731                             >> RXf_PMf_STD_PMMOD_SHIFT);
4732         const char *fptr = STD_PAT_MODS;        /*"msix"*/
4733         char *p;
4734         /* Allocate for the worst case, which is all the std flags are turned
4735          * on.  If more precision is desired, we could do a population count of
4736          * the flags set.  This could be done with a small lookup table, or by
4737          * shifting, masking and adding, or even, when available, assembly
4738          * language for a machine-language population count.
4739          * We never output a minus, as all those are defaults, so are
4740          * covered by the caret */
4741         const STRLEN wraplen = plen + has_p + has_runon
4742             + has_default       /* If needs a caret */
4743
4744                 /* If needs a character set specifier */
4745             + ((has_charset) ? MAX_CHARSET_NAME_LENGTH : 0)
4746             + (sizeof(STD_PAT_MODS) - 1)
4747             + (sizeof("(?:)") - 1);
4748
4749         p = sv_grow(MUTABLE_SV(rx), wraplen + 1); /* +1 for the ending NUL */
4750         SvPOK_on(rx);
4751         SvFLAGS(rx) |= SvUTF8(pattern);
4752         *p++='('; *p++='?';
4753
4754         /* If a default, cover it using the caret */
4755         if (has_default) {
4756             *p++= DEFAULT_PAT_MOD;
4757         }
4758         if (has_charset) {
4759             STRLEN len;
4760             const char* const name = get_regex_charset_name(r->extflags, &len);
4761             Copy(name, p, len, char);
4762             p += len;
4763         }
4764         if (has_p)
4765             *p++ = KEEPCOPY_PAT_MOD; /*'p'*/
4766         {
4767             char ch;
4768             while((ch = *fptr++)) {
4769                 if(reganch & 1)
4770                     *p++ = ch;
4771                 reganch >>= 1;
4772             }
4773         }
4774
4775         *p++ = ':';
4776         Copy(RExC_precomp, p, plen, char);
4777         assert ((RX_WRAPPED(rx) - p) < 16);
4778         r->pre_prefix = p - RX_WRAPPED(rx);
4779         p += plen;
4780         if (has_runon)
4781             *p++ = '\n';
4782         *p++ = ')';
4783         *p = 0;
4784         SvCUR_set(rx, p - SvPVX_const(rx));
4785     }
4786
4787     r->intflags = 0;
4788     r->nparens = RExC_npar - 1; /* set early to validate backrefs */
4789     
4790     if (RExC_seen & REG_SEEN_RECURSE) {
4791         Newxz(RExC_open_parens, RExC_npar,regnode *);
4792         SAVEFREEPV(RExC_open_parens);
4793         Newxz(RExC_close_parens,RExC_npar,regnode *);
4794         SAVEFREEPV(RExC_close_parens);
4795     }
4796
4797     /* Useful during FAIL. */
4798 #ifdef RE_TRACK_PATTERN_OFFSETS
4799     Newxz(ri->u.offsets, 2*RExC_size+1, U32); /* MJD 20001228 */
4800     DEBUG_OFFSETS_r(PerlIO_printf(Perl_debug_log,
4801                           "%s %"UVuf" bytes for offset annotations.\n",
4802                           ri->u.offsets ? "Got" : "Couldn't get",
4803                           (UV)((2*RExC_size+1) * sizeof(U32))));
4804 #endif
4805     SetProgLen(ri,RExC_size);
4806     RExC_rx_sv = rx;
4807     RExC_rx = r;
4808     RExC_rxi = ri;
4809     REH_CALL_COMP_BEGIN_HOOK(pRExC_state->rx);
4810
4811     /* Second pass: emit code. */
4812     RExC_flags = pm_flags;      /* don't let top level (?i) bleed */
4813     RExC_parse = exp;
4814     RExC_end = xend;
4815     RExC_naughty = 0;
4816     RExC_npar = 1;
4817     RExC_emit_start = ri->program;
4818     RExC_emit = ri->program;
4819     RExC_emit_bound = ri->program + RExC_size + 1;
4820
4821     /* Store the count of eval-groups for security checks: */
4822     RExC_rx->seen_evals = RExC_seen_evals;
4823     REGC((U8)REG_MAGIC, (char*) RExC_emit++);
4824     if (reg(pRExC_state, 0, &flags,1) == NULL) {
4825         ReREFCNT_dec(rx);   
4826         return(NULL);
4827     }
4828     /* XXXX To minimize changes to RE engine we always allocate
4829        3-units-long substrs field. */
4830     Newx(r->substrs, 1, struct reg_substr_data);
4831     if (RExC_recurse_count) {
4832         Newxz(RExC_recurse,RExC_recurse_count,regnode *);
4833         SAVEFREEPV(RExC_recurse);
4834     }
4835
4836 reStudy:
4837     r->minlen = minlen = sawlookahead = sawplus = sawopen = 0;
4838     Zero(r->substrs, 1, struct reg_substr_data);
4839
4840 #ifdef TRIE_STUDY_OPT
4841     if (!restudied) {
4842         StructCopy(&zero_scan_data, &data, scan_data_t);
4843         copyRExC_state = RExC_state;
4844     } else {
4845         U32 seen=RExC_seen;
4846         DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log,"Restudying\n"));
4847         
4848         RExC_state = copyRExC_state;
4849         if (seen & REG_TOP_LEVEL_BRANCHES) 
4850             RExC_seen |= REG_TOP_LEVEL_BRANCHES;
4851         else
4852             RExC_seen &= ~REG_TOP_LEVEL_BRANCHES;
4853         if (data.last_found) {
4854             SvREFCNT_dec(data.longest_fixed);
4855             SvREFCNT_dec(data.longest_float);
4856             SvREFCNT_dec(data.last_found);
4857         }
4858         StructCopy(&zero_scan_data, &data, scan_data_t);
4859     }
4860 #else
4861     StructCopy(&zero_scan_data, &data, scan_data_t);
4862 #endif    
4863
4864     /* Dig out information for optimizations. */
4865     r->extflags = RExC_flags; /* was pm_op */
4866     /*dmq: removed as part of de-PMOP: pm->op_pmflags = RExC_flags; */
4867  
4868     if (UTF)
4869         SvUTF8_on(rx);  /* Unicode in it? */
4870     ri->regstclass = NULL;
4871     if (RExC_naughty >= 10)     /* Probably an expensive pattern. */
4872         r->intflags |= PREGf_NAUGHTY;
4873     scan = ri->program + 1;             /* First BRANCH. */
4874
4875     /* testing for BRANCH here tells us whether there is "must appear"
4876        data in the pattern. If there is then we can use it for optimisations */
4877     if (!(RExC_seen & REG_TOP_LEVEL_BRANCHES)) { /*  Only one top-level choice. */
4878         I32 fake;
4879         STRLEN longest_float_length, longest_fixed_length;
4880         struct regnode_charclass_class ch_class; /* pointed to by data */
4881         int stclass_flag;
4882         I32 last_close = 0; /* pointed to by data */
4883         regnode *first= scan;
4884         regnode *first_next= regnext(first);
4885         /*
4886          * Skip introductions and multiplicators >= 1
4887          * so that we can extract the 'meat' of the pattern that must 
4888          * match in the large if() sequence following.
4889          * NOTE that EXACT is NOT covered here, as it is normally
4890          * picked up by the optimiser separately. 
4891          *
4892          * This is unfortunate as the optimiser isnt handling lookahead
4893          * properly currently.
4894          *
4895          */
4896         while ((OP(first) == OPEN && (sawopen = 1)) ||
4897                /* An OR of *one* alternative - should not happen now. */
4898             (OP(first) == BRANCH && OP(first_next) != BRANCH) ||
4899             /* for now we can't handle lookbehind IFMATCH*/
4900             (OP(first) == IFMATCH && !first->flags && (sawlookahead = 1)) ||
4901             (OP(first) == PLUS) ||
4902             (OP(first) == MINMOD) ||
4903                /* An {n,m} with n>0 */
4904             (PL_regkind[OP(first)] == CURLY && ARG1(first) > 0) ||
4905             (OP(first) == NOTHING && PL_regkind[OP(first_next)] != END ))
4906         {
4907                 /* 
4908                  * the only op that could be a regnode is PLUS, all the rest
4909                  * will be regnode_1 or regnode_2.
4910                  *
4911                  */
4912                 if (OP(first) == PLUS)
4913                     sawplus = 1;
4914                 else
4915                     first += regarglen[OP(first)];
4916                 
4917                 first = NEXTOPER(first);
4918                 first_next= regnext(first);
4919         }
4920
4921         /* Starting-point info. */
4922       again:
4923         DEBUG_PEEP("first:",first,0);
4924         /* Ignore EXACT as we deal with it later. */
4925         if (PL_regkind[OP(first)] == EXACT) {
4926             if (OP(first) == EXACT)
4927                 NOOP;   /* Empty, get anchored substr later. */
4928             else
4929                 ri->regstclass = first;
4930         }
4931 #ifdef TRIE_STCLASS     
4932         else if (PL_regkind[OP(first)] == TRIE &&
4933                 ((reg_trie_data *)ri->data->data[ ARG(first) ])->minlen>0) 
4934         {
4935             regnode *trie_op;
4936             /* this can happen only on restudy */
4937             if ( OP(first) == TRIE ) {
4938                 struct regnode_1 *trieop = (struct regnode_1 *)
4939                     PerlMemShared_calloc(1, sizeof(struct regnode_1));
4940                 StructCopy(first,trieop,struct regnode_1);
4941                 trie_op=(regnode *)trieop;
4942             } else {
4943                 struct regnode_charclass *trieop = (struct regnode_charclass *)
4944                     PerlMemShared_calloc(1, sizeof(struct regnode_charclass));
4945                 StructCopy(first,trieop,struct regnode_charclass);
4946                 trie_op=(regnode *)trieop;
4947             }
4948             OP(trie_op)+=2;
4949             make_trie_failtable(pRExC_state, (regnode *)first, trie_op, 0);
4950             ri->regstclass = trie_op;
4951         }
4952 #endif  
4953         else if (REGNODE_SIMPLE(OP(first)))
4954             ri->regstclass = first;
4955         else if (PL_regkind[OP(first)] == BOUND ||
4956                  PL_regkind[OP(first)] == NBOUND)
4957             ri->regstclass = first;
4958         else if (PL_regkind[OP(first)] == BOL) {
4959             r->extflags |= (OP(first) == MBOL
4960                            ? RXf_ANCH_MBOL
4961                            : (OP(first) == SBOL
4962                               ? RXf_ANCH_SBOL
4963                               : RXf_ANCH_BOL));
4964             first = NEXTOPER(first);
4965             goto again;
4966         }
4967         else if (OP(first) == GPOS) {
4968             r->extflags |= RXf_ANCH_GPOS;
4969             first = NEXTOPER(first);
4970             goto again;
4971         }
4972         else if ((!sawopen || !RExC_sawback) &&
4973             (OP(first) == STAR &&
4974             PL_regkind[OP(NEXTOPER(first))] == REG_ANY) &&
4975             !(r->extflags & RXf_ANCH) && !(RExC_seen & REG_SEEN_EVAL))
4976         {
4977             /* turn .* into ^.* with an implied $*=1 */
4978             const int type =
4979                 (OP(NEXTOPER(first)) == REG_ANY)
4980                     ? RXf_ANCH_MBOL
4981                     : RXf_ANCH_SBOL;
4982             r->extflags |= type;
4983             r->intflags |= PREGf_IMPLICIT;
4984             first = NEXTOPER(first);
4985             goto again;
4986         }
4987         if (sawplus && !sawlookahead && (!sawopen || !RExC_sawback)
4988             && !(RExC_seen & REG_SEEN_EVAL)) /* May examine pos and $& */
4989             /* x+ must match at the 1st pos of run of x's */
4990             r->intflags |= PREGf_SKIP;
4991
4992         /* Scan is after the zeroth branch, first is atomic matcher. */
4993 #ifdef TRIE_STUDY_OPT
4994         DEBUG_PARSE_r(
4995             if (!restudied)
4996                 PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
4997                               (IV)(first - scan + 1))
4998         );
4999 #else
5000         DEBUG_PARSE_r(
5001             PerlIO_printf(Perl_debug_log, "first at %"IVdf"\n",
5002                 (IV)(first - scan + 1))
5003         );
5004 #endif
5005
5006
5007         /*
5008         * If there's something expensive in the r.e., find the
5009         * longest literal string that must appear and make it the
5010         * regmust.  Resolve ties in favor of later strings, since
5011         * the regstart check works with the beginning of the r.e.
5012         * and avoiding duplication strengthens checking.  Not a
5013         * strong reason, but sufficient in the absence of others.
5014         * [Now we resolve ties in favor of the earlier string if
5015         * it happens that c_offset_min has been invalidated, since the
5016         * earlier string may buy us something the later one won't.]
5017         */
5018         
5019         data.longest_fixed = newSVpvs("");
5020         data.longest_float = newSVpvs("");
5021         data.last_found = newSVpvs("");
5022         data.longest = &(data.longest_fixed);
5023         first = scan;
5024         if (!ri->regstclass) {
5025             cl_init(pRExC_state, &ch_class);
5026             data.start_class = &ch_class;
5027             stclass_flag = SCF_DO_STCLASS_AND;
5028         } else                          /* XXXX Check for BOUND? */
5029             stclass_flag = 0;
5030         data.last_closep = &last_close;
5031         
5032         minlen = study_chunk(pRExC_state, &first, &minlen, &fake, scan + RExC_size, /* Up to end */
5033             &data, -1, NULL, NULL,
5034             SCF_DO_SUBSTR | SCF_WHILEM_VISITED_POS | stclass_flag,0);
5035
5036         
5037         CHECK_RESTUDY_GOTO;
5038
5039
5040         if ( RExC_npar == 1 && data.longest == &(data.longest_fixed)
5041              && data.last_start_min == 0 && data.last_end > 0
5042              && !RExC_seen_zerolen
5043              && !(RExC_seen & REG_SEEN_VERBARG)
5044              && (!(RExC_seen & REG_SEEN_GPOS) || (r->extflags & RXf_ANCH_GPOS)))
5045             r->extflags |= RXf_CHECK_ALL;
5046         scan_commit(pRExC_state, &data,&minlen,0);
5047         SvREFCNT_dec(data.last_found);
5048
5049         /* Note that code very similar to this but for anchored string 
5050            follows immediately below, changes may need to be made to both. 
5051            Be careful. 
5052          */
5053         longest_float_length = CHR_SVLEN(data.longest_float);
5054         if (longest_float_length
5055             || (data.flags & SF_FL_BEFORE_EOL
5056                 && (!(data.flags & SF_FL_BEFORE_MEOL)
5057                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
5058         {
5059             I32 t,ml;
5060
5061             if (SvCUR(data.longest_fixed)  /* ok to leave SvCUR */
5062                 && data.offset_fixed == data.offset_float_min
5063                 && SvCUR(data.longest_fixed) == SvCUR(data.longest_float))
5064                     goto remove_float;          /* As in (a)+. */
5065
5066             /* copy the information about the longest float from the reg_scan_data
5067                over to the program. */
5068             if (SvUTF8(data.longest_float)) {
5069                 r->float_utf8 = data.longest_float;
5070                 r->float_substr = NULL;
5071             } else {
5072                 r->float_substr = data.longest_float;
5073                 r->float_utf8 = NULL;
5074             }
5075             /* float_end_shift is how many chars that must be matched that 
5076                follow this item. We calculate it ahead of time as once the
5077                lookbehind offset is added in we lose the ability to correctly
5078                calculate it.*/
5079             ml = data.minlen_float ? *(data.minlen_float) 
5080                                    : (I32)longest_float_length;
5081             r->float_end_shift = ml - data.offset_float_min
5082                 - longest_float_length + (SvTAIL(data.longest_float) != 0)
5083                 + data.lookbehind_float;
5084             r->float_min_offset = data.offset_float_min - data.lookbehind_float;
5085             r->float_max_offset = data.offset_float_max;
5086             if (data.offset_float_max < I32_MAX) /* Don't offset infinity */
5087                 r->float_max_offset -= data.lookbehind_float;
5088             
5089             t = (data.flags & SF_FL_BEFORE_EOL /* Can't have SEOL and MULTI */
5090                        && (!(data.flags & SF_FL_BEFORE_MEOL)
5091                            || (RExC_flags & RXf_PMf_MULTILINE)));
5092             fbm_compile(data.longest_float, t ? FBMcf_TAIL : 0);
5093         }
5094         else {
5095           remove_float:
5096             r->float_substr = r->float_utf8 = NULL;
5097             SvREFCNT_dec(data.longest_float);
5098             longest_float_length = 0;
5099         }
5100
5101         /* Note that code very similar to this but for floating string 
5102            is immediately above, changes may need to be made to both. 
5103            Be careful. 
5104          */
5105         longest_fixed_length = CHR_SVLEN(data.longest_fixed);
5106         if (longest_fixed_length
5107             || (data.flags & SF_FIX_BEFORE_EOL /* Cannot have SEOL and MULTI */
5108                 && (!(data.flags & SF_FIX_BEFORE_MEOL)
5109                     || (RExC_flags & RXf_PMf_MULTILINE)))) 
5110         {
5111             I32 t,ml;
5112
5113             /* copy the information about the longest fixed 
5114                from the reg_scan_data over to the program. */
5115             if (SvUTF8(data.longest_fixed)) {
5116                 r->anchored_utf8 = data.longest_fixed;
5117                 r->anchored_substr = NULL;
5118             } else {
5119                 r->anchored_substr = data.longest_fixed;
5120                 r->anchored_utf8 = NULL;
5121             }
5122             /* fixed_end_shift is how many chars that must be matched that 
5123                follow this item. We calculate it ahead of time as once the
5124                lookbehind offset is added in we lose the ability to correctly
5125                calculate it.*/
5126             ml = data.minlen_fixed ? *(data.minlen_fixed) 
5127                                    : (I32)longest_fixed_length;
5128             r->anchored_end_shift = ml - data.offset_fixed
5129                 - longest_fixed_length + (SvTAIL(data.longest_fixed) != 0)
5130                 + data.lookbehind_fixed;
5131             r->anchored_offset = data.offset_fixed - data.lookbehind_fixed;
5132
5133             t = (data.flags & SF_FIX_BEFORE_EOL /* Can't have SEOL and MULTI */
5134                  && (!(data.flags & SF_FIX_BEFORE_MEOL)
5135                      || (RExC_flags & RXf_PMf_MULTILINE)));
5136             fbm_compile(data.longest_fixed, t ? FBMcf_TAIL : 0);
5137         }
5138         else {
5139             r->anchored_substr = r->anchored_utf8 = NULL;
5140             SvREFCNT_dec(data.longest_fixed);
5141             longest_fixed_length = 0;
5142         }
5143         if (ri->regstclass
5144             && (OP(ri->regstclass) == REG_ANY || OP(ri->regstclass) == SANY))
5145             ri->regstclass = NULL;
5146
5147         if ((!(r->anchored_substr || r->anchored_utf8) || r->anchored_offset)
5148             && stclass_flag
5149             && !(data.start_class->flags & ANYOF_EOS)
5150             && !cl_is_anything(data.start_class))
5151         {
5152             const U32 n = add_data(pRExC_state, 1, "f");
5153             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5154
5155             Newx(RExC_rxi->data->data[n], 1,
5156                 struct regnode_charclass_class);
5157             StructCopy(data.start_class,
5158                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5159                        struct regnode_charclass_class);
5160             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5161             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5162             DEBUG_COMPILE_r({ SV *sv = sv_newmortal();
5163                       regprop(r, sv, (regnode*)data.start_class);
5164                       PerlIO_printf(Perl_debug_log,
5165                                     "synthetic stclass \"%s\".\n",
5166                                     SvPVX_const(sv));});
5167         }
5168
5169         /* A temporary algorithm prefers floated substr to fixed one to dig more info. */
5170         if (longest_fixed_length > longest_float_length) {
5171             r->check_end_shift = r->anchored_end_shift;
5172             r->check_substr = r->anchored_substr;
5173             r->check_utf8 = r->anchored_utf8;
5174             r->check_offset_min = r->check_offset_max = r->anchored_offset;
5175             if (r->extflags & RXf_ANCH_SINGLE)
5176                 r->extflags |= RXf_NOSCAN;
5177         }
5178         else {
5179             r->check_end_shift = r->float_end_shift;
5180             r->check_substr = r->float_substr;
5181             r->check_utf8 = r->float_utf8;
5182             r->check_offset_min = r->float_min_offset;
5183             r->check_offset_max = r->float_max_offset;
5184         }
5185         /* XXXX Currently intuiting is not compatible with ANCH_GPOS.
5186            This should be changed ASAP!  */
5187         if ((r->check_substr || r->check_utf8) && !(r->extflags & RXf_ANCH_GPOS)) {
5188             r->extflags |= RXf_USE_INTUIT;
5189             if (SvTAIL(r->check_substr ? r->check_substr : r->check_utf8))
5190                 r->extflags |= RXf_INTUIT_TAIL;
5191         }
5192         /* XXX Unneeded? dmq (shouldn't as this is handled elsewhere)
5193         if ( (STRLEN)minlen < longest_float_length )
5194             minlen= longest_float_length;
5195         if ( (STRLEN)minlen < longest_fixed_length )
5196             minlen= longest_fixed_length;     
5197         */
5198     }
5199     else {
5200         /* Several toplevels. Best we can is to set minlen. */
5201         I32 fake;
5202         struct regnode_charclass_class ch_class;
5203         I32 last_close = 0;
5204         
5205         DEBUG_PARSE_r(PerlIO_printf(Perl_debug_log, "\nMulti Top Level\n"));
5206
5207         scan = ri->program + 1;
5208         cl_init(pRExC_state, &ch_class);
5209         data.start_class = &ch_class;
5210         data.last_closep = &last_close;
5211
5212         
5213         minlen = study_chunk(pRExC_state, &scan, &minlen, &fake, scan + RExC_size,
5214             &data, -1, NULL, NULL, SCF_DO_STCLASS_AND|SCF_WHILEM_VISITED_POS,0);
5215         
5216         CHECK_RESTUDY_GOTO;
5217
5218         r->check_substr = r->check_utf8 = r->anchored_substr = r->anchored_utf8
5219                 = r->float_substr = r->float_utf8 = NULL;
5220
5221         if (!(data.start_class->flags & ANYOF_EOS)
5222             && !cl_is_anything(data.start_class))
5223         {
5224             const U32 n = add_data(pRExC_state, 1, "f");
5225             data.start_class->flags |= ANYOF_IS_SYNTHETIC;
5226
5227             Newx(RExC_rxi->data->data[n], 1,
5228                 struct regnode_charclass_class);
5229             StructCopy(data.start_class,
5230                        (struct regnode_charclass_class*)RExC_rxi->data->data[n],
5231                        struct regnode_charclass_class);
5232             ri->regstclass = (regnode*)RExC_rxi->data->data[n];
5233             r->intflags &= ~PREGf_SKIP; /* Used in find_byclass(). */
5234             DEBUG_COMPILE_r({ SV* sv = sv_newmortal();
5235                       regprop(r, sv, (regnode*)data.start_class);
5236                       PerlIO_printf(Perl_debug_log,
5237                                     "synthetic stclass \"%s\".\n",
5238                                     SvPVX_const(sv));});
5239         }
5240     }
5241
5242     /* Guard against an embedded (?=) or (?<=) with a longer minlen than
5243        the "real" pattern. */
5244     DEBUG_OPTIMISE_r({
5245         PerlIO_printf(Perl_debug_log,"minlen: %"IVdf" r->minlen:%"IVdf"\n",
5246                       (IV)minlen, (IV)r->minlen);
5247     });
5248     r->minlenret = minlen;
5249     if (r->minlen < minlen) 
5250         r->minlen = minlen;
5251     
5252     if (RExC_seen & REG_SEEN_GPOS)
5253         r->extflags |= RXf_GPOS_SEEN;
5254     if (RExC_seen & REG_SEEN_LOOKBEHIND)
5255         r->extflags |= RXf_LOOKBEHIND_SEEN;
5256     if (RExC_seen & REG_SEEN_EVAL)
5257         r->extflags |= RXf_EVAL_SEEN;
5258     if (RExC_seen & REG_SEEN_CANY)
5259         r->extflags |= RXf_CANY_SEEN;
5260     if (RExC_seen & REG_SEEN_VERBARG)
5261         r->intflags |= PREGf_VERBARG_SEEN;
5262     if (RExC_seen & REG_SEEN_CUTGROUP)
5263         r->intflags |= PREGf_CUTGROUP_SEEN;
5264     if (RExC_paren_names)
5265         RXp_PAREN_NAMES(r) = MUTABLE_HV(SvREFCNT_inc(RExC_paren_names));
5266     else
5267         RXp_PAREN_NAMES(r) = NULL;
5268
5269 #ifdef STUPID_PATTERN_CHECKS            
5270     if (RX_PRELEN(rx) == 0)
5271         r->extflags |= RXf_NULL;
5272     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5273         /* XXX: this should happen BEFORE we compile */
5274         r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5275     else if (RX_PRELEN(rx) == 3 && memEQ("\\s+", RX_PRECOMP(rx), 3))
5276         r->extflags |= RXf_WHITE;
5277     else if (RX_PRELEN(rx) == 1 && RXp_PRECOMP(rx)[0] == '^')
5278         r->extflags |= RXf_START_ONLY;
5279 #else
5280     if (r->extflags & RXf_SPLIT && RX_PRELEN(rx) == 1 && RX_PRECOMP(rx)[0] == ' ')
5281             /* XXX: this should happen BEFORE we compile */
5282             r->extflags |= (RXf_SKIPWHITE|RXf_WHITE); 
5283     else {
5284         regnode *first = ri->program + 1;
5285         U8 fop = OP(first);
5286
5287         if (PL_regkind[fop] == NOTHING && OP(NEXTOPER(first)) == END)
5288             r->extflags |= RXf_NULL;
5289         else if (PL_regkind[fop] == BOL && OP(NEXTOPER(first)) == END)
5290             r->extflags |= RXf_START_ONLY;
5291         else if (fop == PLUS && OP(NEXTOPER(first)) == SPACE
5292                              && OP(regnext(first)) == END)
5293             r->extflags |= RXf_WHITE;    
5294     }
5295 #endif
5296 #ifdef DEBUGGING
5297     if (RExC_paren_names) {
5298         ri->name_list_idx = add_data( pRExC_state, 1, "a" );
5299         ri->data->data[ri->name_list_idx] = (void*)SvREFCNT_inc(RExC_paren_name_list);
5300     } else
5301 #endif
5302         ri->name_list_idx = 0;
5303
5304     if (RExC_recurse_count) {
5305         for ( ; RExC_recurse_count ; RExC_recurse_count-- ) {
5306             const regnode *scan = RExC_recurse[RExC_recurse_count-1];
5307             ARG2L_SET( scan, RExC_open_parens[ARG(scan)-1] - scan );
5308         }
5309     }
5310     Newxz(r->offs, RExC_npar, regexp_paren_pair);
5311     /* assume we don't need to swap parens around before we match */
5312
5313     DEBUG_DUMP_r({
5314         PerlIO_printf(Perl_debug_log,"Final program:\n");
5315         regdump(r);
5316     });
5317 #ifdef RE_TRACK_PATTERN_OFFSETS
5318     DEBUG_OFFSETS_r(if (ri->u.offsets) {
5319         const U32 len = ri->u.offsets[0];
5320         U32 i;
5321         GET_RE_DEBUG_FLAGS_DECL;
5322         PerlIO_printf(Perl_debug_log, "Offsets: [%"UVuf"]\n\t", (UV)ri->u.offsets[0]);
5323         for (i = 1; i <= len; i++) {
5324             if (ri->u.offsets[i*2-1] || ri->u.offsets[i*2])
5325                 PerlIO_printf(Perl_debug_log, "%"UVuf":%"UVuf"[%"UVuf"] ",
5326                 (UV)i, (UV)ri->u.offsets[i*2-1], (UV)ri->u.offsets[i*2]);
5327             }
5328         PerlIO_printf(Perl_debug_log, "\n");
5329     });
5330 #endif
5331     return rx;
5332 }
5333
5334 #undef RE_ENGINE_PTR
5335
5336
5337 SV*
5338 Perl_reg_named_buff(pTHX_ REGEXP * const rx, SV * const key, SV * const value,
5339                     const U32 flags)
5340 {
5341     PERL_ARGS_ASSERT_REG_NAMED_BUFF;
5342
5343     PERL_UNUSED_ARG(value);
5344
5345     if (flags & RXapif_FETCH) {
5346         return reg_named_buff_fetch(rx, key, flags);
5347     } else if (flags & (RXapif_STORE | RXapif_DELETE | RXapif_CLEAR)) {
5348         Perl_croak_no_modify(aTHX);
5349         return NULL;
5350     } else if (flags & RXapif_EXISTS) {
5351         return reg_named_buff_exists(rx, key, flags)
5352             ? &PL_sv_yes
5353             : &PL_sv_no;
5354     } else if (flags & RXapif_REGNAMES) {
5355         return reg_named_buff_all(rx, flags);
5356     } else if (flags & (RXapif_SCALAR | RXapif_REGNAMES_COUNT)) {
5357         return reg_named_buff_scalar(rx, flags);
5358     } else {
5359         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff", (int)flags);
5360         return NULL;
5361     }
5362 }
5363
5364 SV*
5365 Perl_reg_named_buff_iter(pTHX_ REGEXP * const rx, const SV * const lastkey,
5366                          const U32 flags)
5367 {
5368     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ITER;
5369     PERL_UNUSED_ARG(lastkey);
5370
5371     if (flags & RXapif_FIRSTKEY)
5372         return reg_named_buff_firstkey(rx, flags);
5373     else if (flags & RXapif_NEXTKEY)
5374         return reg_named_buff_nextkey(rx, flags);
5375     else {
5376         Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_iter", (int)flags);
5377         return NULL;
5378     }
5379 }
5380
5381 SV*
5382 Perl_reg_named_buff_fetch(pTHX_ REGEXP * const r, SV * const namesv,
5383                           const U32 flags)
5384 {
5385     AV *retarray = NULL;
5386     SV *ret;
5387     struct regexp *const rx = (struct regexp *)SvANY(r);
5388
5389     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FETCH;
5390
5391     if (flags & RXapif_ALL)
5392         retarray=newAV();
5393
5394     if (rx && RXp_PAREN_NAMES(rx)) {
5395         HE *he_str = hv_fetch_ent( RXp_PAREN_NAMES(rx), namesv, 0, 0 );
5396         if (he_str) {
5397             IV i;
5398             SV* sv_dat=HeVAL(he_str);
5399             I32 *nums=(I32*)SvPVX(sv_dat);
5400             for ( i=0; i<SvIVX(sv_dat); i++ ) {
5401                 if ((I32)(rx->nparens) >= nums[i]
5402                     && rx->offs[nums[i]].start != -1
5403                     && rx->offs[nums[i]].end != -1)
5404                 {
5405                     ret = newSVpvs("");
5406                     CALLREG_NUMBUF_FETCH(r,nums[i],ret);
5407                     if (!retarray)
5408                         return ret;
5409                 } else {
5410                     ret = newSVsv(&PL_sv_undef);
5411                 }
5412                 if (retarray)
5413                     av_push(retarray, ret);
5414             }
5415             if (retarray)
5416                 return newRV_noinc(MUTABLE_SV(retarray));
5417         }
5418     }
5419     return NULL;
5420 }
5421
5422 bool
5423 Perl_reg_named_buff_exists(pTHX_ REGEXP * const r, SV * const key,
5424                            const U32 flags)
5425 {
5426     struct regexp *const rx = (struct regexp *)SvANY(r);
5427
5428     PERL_ARGS_ASSERT_REG_NAMED_BUFF_EXISTS;
5429
5430     if (rx && RXp_PAREN_NAMES(rx)) {
5431         if (flags & RXapif_ALL) {
5432             return hv_exists_ent(RXp_PAREN_NAMES(rx), key, 0);
5433         } else {
5434             SV *sv = CALLREG_NAMED_BUFF_FETCH(r, key, flags);
5435             if (sv) {
5436                 SvREFCNT_dec(sv);
5437                 return TRUE;
5438             } else {
5439                 return FALSE;
5440             }
5441         }
5442     } else {
5443         return FALSE;
5444     }
5445 }
5446
5447 SV*
5448 Perl_reg_named_buff_firstkey(pTHX_ REGEXP * const r, const U32 flags)
5449 {
5450     struct regexp *const rx = (struct regexp *)SvANY(r);
5451
5452     PERL_ARGS_ASSERT_REG_NAMED_BUFF_FIRSTKEY;
5453
5454     if ( rx && RXp_PAREN_NAMES(rx) ) {
5455         (void)hv_iterinit(RXp_PAREN_NAMES(rx));
5456
5457         return CALLREG_NAMED_BUFF_NEXTKEY(r, NULL, flags & ~RXapif_FIRSTKEY);
5458     } else {
5459         return FALSE;
5460     }
5461 }
5462
5463 SV*
5464 Perl_reg_named_buff_nextkey(pTHX_ REGEXP * const r, const U32 flags)
5465 {
5466     struct regexp *const rx = (struct regexp *)SvANY(r);
5467     GET_RE_DEBUG_FLAGS_DECL;
5468
5469     PERL_ARGS_ASSERT_REG_NAMED_BUFF_NEXTKEY;
5470
5471     if (rx && RXp_PAREN_NAMES(rx)) {
5472         HV *hv = RXp_PAREN_NAMES(rx);
5473         HE *temphe;
5474         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5475             IV i;
5476             IV parno = 0;
5477             SV* sv_dat = HeVAL(temphe);
5478             I32 *nums = (I32*)SvPVX(sv_dat);
5479             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5480                 if ((I32)(rx->lastparen) >= nums[i] &&
5481                     rx->offs[nums[i]].start != -1 &&
5482                     rx->offs[nums[i]].end != -1)
5483                 {
5484                     parno = nums[i];
5485                     break;
5486                 }
5487             }
5488             if (parno || flags & RXapif_ALL) {
5489                 return newSVhek(HeKEY_hek(temphe));
5490             }
5491         }
5492     }
5493     return NULL;
5494 }
5495
5496 SV*
5497 Perl_reg_named_buff_scalar(pTHX_ REGEXP * const r, const U32 flags)
5498 {
5499     SV *ret;
5500     AV *av;
5501     I32 length;
5502     struct regexp *const rx = (struct regexp *)SvANY(r);
5503
5504     PERL_ARGS_ASSERT_REG_NAMED_BUFF_SCALAR;
5505
5506     if (rx && RXp_PAREN_NAMES(rx)) {
5507         if (flags & (RXapif_ALL | RXapif_REGNAMES_COUNT)) {
5508             return newSViv(HvTOTALKEYS(RXp_PAREN_NAMES(rx)));
5509         } else if (flags & RXapif_ONE) {
5510             ret = CALLREG_NAMED_BUFF_ALL(r, (flags | RXapif_REGNAMES));
5511             av = MUTABLE_AV(SvRV(ret));
5512             length = av_len(av);
5513             SvREFCNT_dec(ret);
5514             return newSViv(length + 1);
5515         } else {
5516             Perl_croak(aTHX_ "panic: Unknown flags %d in named_buff_scalar", (int)flags);
5517             return NULL;
5518         }
5519     }
5520     return &PL_sv_undef;
5521 }
5522
5523 SV*
5524 Perl_reg_named_buff_all(pTHX_ REGEXP * const r, const U32 flags)
5525 {
5526     struct regexp *const rx = (struct regexp *)SvANY(r);
5527     AV *av = newAV();
5528
5529     PERL_ARGS_ASSERT_REG_NAMED_BUFF_ALL;
5530
5531     if (rx && RXp_PAREN_NAMES(rx)) {
5532         HV *hv= RXp_PAREN_NAMES(rx);
5533         HE *temphe;
5534         (void)hv_iterinit(hv);
5535         while ( (temphe = hv_iternext_flags(hv,0)) ) {
5536             IV i;
5537             IV parno = 0;
5538             SV* sv_dat = HeVAL(temphe);
5539             I32 *nums = (I32*)SvPVX(sv_dat);
5540             for ( i = 0; i < SvIVX(sv_dat); i++ ) {
5541                 if ((I32)(rx->lastparen) >= nums[i] &&
5542                     rx->offs[nums[i]].start != -1 &&
5543                     rx->offs[nums[i]].end != -1)
5544                 {
5545                     parno = nums[i];
5546                     break;
5547                 }
5548             }
5549             if (parno || flags & RXapif_ALL) {
5550                 av_push(av, newSVhek(HeKEY_hek(temphe)));
5551             }
5552         }
5553     }
5554
5555     return newRV_noinc(MUTABLE_SV(av));
5556 }
5557
5558 void
5559 Perl_reg_numbered_buff_fetch(pTHX_ REGEXP * const r, const I32 paren,
5560                              SV * const sv)
5561 {
5562     struct regexp *const rx = (struct regexp *)SvANY(r);
5563     char *s = NULL;
5564     I32 i = 0;
5565     I32 s1, t1;
5566
5567     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_FETCH;
5568         
5569     if (!rx->subbeg) {
5570         sv_setsv(sv,&PL_sv_undef);
5571         return;
5572     } 
5573     else               
5574     if (paren == RX_BUFF_IDX_PREMATCH && rx->offs[0].start != -1) {
5575         /* $` */
5576         i = rx->offs[0].start;
5577         s = rx->subbeg;
5578     }
5579     else 
5580     if (paren == RX_BUFF_IDX_POSTMATCH && rx->offs[0].end != -1) {
5581         /* $' */
5582         s = rx->subbeg + rx->offs[0].end;
5583         i = rx->sublen - rx->offs[0].end;
5584     } 
5585     else
5586     if ( 0 <= paren && paren <= (I32)rx->nparens &&
5587         (s1 = rx->offs[paren].start) != -1 &&
5588         (t1 = rx->offs[paren].end) != -1)
5589     {
5590         /* $& $1 ... */
5591         i = t1 - s1;
5592         s = rx->subbeg + s1;
5593     } else {
5594         sv_setsv(sv,&PL_sv_undef);
5595         return;
5596     }          
5597     assert(rx->sublen >= (s - rx->subbeg) + i );
5598     if (i >= 0) {
5599         const int oldtainted = PL_tainted;
5600         TAINT_NOT;
5601         sv_setpvn(sv, s, i);
5602         PL_tainted = oldtainted;
5603         if ( (rx->extflags & RXf_CANY_SEEN)
5604             ? (RXp_MATCH_UTF8(rx)
5605                         && (!i || is_utf8_string((U8*)s, i)))
5606             : (RXp_MATCH_UTF8(rx)) )
5607         {
5608             SvUTF8_on(sv);
5609         }
5610         else
5611             SvUTF8_off(sv);
5612         if (PL_tainting) {
5613             if (RXp_MATCH_TAINTED(rx)) {
5614                 if (SvTYPE(sv) >= SVt_PVMG) {
5615                     MAGIC* const mg = SvMAGIC(sv);
5616                     MAGIC* mgt;
5617                     PL_tainted = 1;
5618                     SvMAGIC_set(sv, mg->mg_moremagic);
5619                     SvTAINT(sv);
5620                     if ((mgt = SvMAGIC(sv))) {
5621                         mg->mg_moremagic = mgt;
5622                         SvMAGIC_set(sv, mg);
5623                     }
5624                 } else {
5625                     PL_tainted = 1;
5626                     SvTAINT(sv);
5627                 }
5628             } else 
5629                 SvTAINTED_off(sv);
5630         }
5631     } else {
5632         sv_setsv(sv,&PL_sv_undef);
5633         return;
5634     }
5635 }
5636
5637 void
5638 Perl_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
5639                                                          SV const * const value)
5640 {
5641     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_STORE;
5642
5643     PERL_UNUSED_ARG(rx);
5644     PERL_UNUSED_ARG(paren);
5645     PERL_UNUSED_ARG(value);
5646
5647     if (!PL_localizing)
5648         Perl_croak_no_modify(aTHX);
5649 }
5650
5651 I32
5652 Perl_reg_numbered_buff_length(pTHX_ REGEXP * const r, const SV * const sv,
5653                               const I32 paren)
5654 {
5655     struct regexp *const rx = (struct regexp *)SvANY(r);
5656     I32 i;
5657     I32 s1, t1;
5658
5659     PERL_ARGS_ASSERT_REG_NUMBERED_BUFF_LENGTH;
5660
5661     /* Some of this code was originally in C<Perl_magic_len> in F<mg.c> */
5662         switch (paren) {
5663       /* $` / ${^PREMATCH} */
5664       case RX_BUFF_IDX_PREMATCH:
5665         if (rx->offs[0].start != -1) {
5666                         i = rx->offs[0].start;
5667                         if (i > 0) {
5668                                 s1 = 0;
5669                                 t1 = i;
5670                                 goto getlen;
5671                         }
5672             }
5673         return 0;
5674       /* $' / ${^POSTMATCH} */
5675       case RX_BUFF_IDX_POSTMATCH:
5676             if (rx->offs[0].end != -1) {
5677                         i = rx->sublen - rx->offs[0].end;
5678                         if (i > 0) {
5679                                 s1 = rx->offs[0].end;
5680                                 t1 = rx->sublen;
5681                                 goto getlen;
5682                         }
5683             }
5684         return 0;
5685       /* $& / ${^MATCH}, $1, $2, ... */
5686       default:
5687             if (paren <= (I32)rx->nparens &&
5688             (s1 = rx->offs[paren].start) != -1 &&
5689             (t1 = rx->offs[paren].end) != -1)
5690             {
5691             i = t1 - s1;
5692             goto getlen;
5693         } else {
5694             if (ckWARN(WARN_UNINITIALIZED))
5695                 report_uninit((const SV *)sv);
5696             return 0;
5697         }
5698     }
5699   getlen:
5700     if (i > 0 && RXp_MATCH_UTF8(rx)) {
5701         const char * const s = rx->subbeg + s1;
5702         const U8 *ep;
5703         STRLEN el;
5704
5705         i = t1 - s1;
5706         if (is_utf8_string_loclen((U8*)s, i, &ep, &el))
5707                         i = el;
5708     }
5709     return i;
5710 }
5711
5712 SV*
5713 Perl_reg_qr_package(pTHX_ REGEXP * const rx)
5714 {
5715     PERL_ARGS_ASSERT_REG_QR_PACKAGE;
5716         PERL_UNUSED_ARG(rx);
5717         if (0)
5718             return NULL;
5719         else
5720             return newSVpvs("Regexp");
5721 }
5722
5723 /* Scans the name of a named buffer from the pattern.
5724  * If flags is REG_RSN_RETURN_NULL returns null.
5725  * If flags is REG_RSN_RETURN_NAME returns an SV* containing the name
5726  * If flags is REG_RSN_RETURN_DATA returns the data SV* corresponding
5727  * to the parsed name as looked up in the RExC_paren_names hash.
5728  * If there is an error throws a vFAIL().. type exception.
5729  */
5730
5731 #define REG_RSN_RETURN_NULL    0
5732 #define REG_RSN_RETURN_NAME    1
5733 #define REG_RSN_RETURN_DATA    2
5734
5735 STATIC SV*
5736 S_reg_scan_name(pTHX_ RExC_state_t *pRExC_state, U32 flags)
5737 {
5738     char *name_start = RExC_parse;
5739
5740     PERL_ARGS_ASSERT_REG_SCAN_NAME;
5741
5742     if (isIDFIRST_lazy_if(RExC_parse, UTF)) {
5743          /* skip IDFIRST by using do...while */
5744         if (UTF)
5745             do {
5746                 RExC_parse += UTF8SKIP(RExC_parse);
5747             } while (isALNUM_utf8((U8*)RExC_parse));
5748         else
5749             do {
5750                 RExC_parse++;
5751             } while (isALNUM(*RExC_parse));
5752     }
5753
5754     if ( flags ) {
5755         SV* sv_name
5756             = newSVpvn_flags(name_start, (int)(RExC_parse - name_start),
5757                              SVs_TEMP | (UTF ? SVf_UTF8 : 0));
5758         if ( flags == REG_RSN_RETURN_NAME)
5759             return sv_name;
5760         else if (flags==REG_RSN_RETURN_DATA) {
5761             HE *he_str = NULL;
5762             SV *sv_dat = NULL;
5763             if ( ! sv_name )      /* should not happen*/
5764                 Perl_croak(aTHX_ "panic: no svname in reg_scan_name");
5765             if (RExC_paren_names)
5766                 he_str = hv_fetch_ent( RExC_paren_names, sv_name, 0, 0 );
5767             if ( he_str )
5768                 sv_dat = HeVAL(he_str);
5769             if ( ! sv_dat )
5770                 vFAIL("Reference to nonexistent named group");
5771             return sv_dat;
5772         }
5773         else {
5774             Perl_croak(aTHX_ "panic: bad flag in reg_scan_name");
5775         }
5776         /* NOT REACHED */
5777     }
5778     return NULL;
5779 }
5780
5781 #define DEBUG_PARSE_MSG(funcname)     DEBUG_PARSE_r({           \
5782     int rem=(int)(RExC_end - RExC_parse);                       \
5783     int cut;                                                    \
5784     int num;                                                    \
5785     int iscut=0;                                                \
5786     if (rem>10) {                                               \
5787         rem=10;                                                 \
5788         iscut=1;                                                \
5789     }                                                           \
5790     cut=10-rem;                                                 \
5791     if (RExC_lastparse!=RExC_parse)                             \
5792         PerlIO_printf(Perl_debug_log," >%.*s%-*s",              \
5793             rem, RExC_parse,                                    \
5794             cut + 4,                                            \
5795             iscut ? "..." : "<"                                 \
5796         );                                                      \
5797     else                                                        \
5798         PerlIO_printf(Perl_debug_log,"%16s","");                \
5799                                                                 \
5800     if (SIZE_ONLY)                                              \
5801        num = RExC_size + 1;                                     \
5802     else                                                        \
5803        num=REG_NODE_NUM(RExC_emit);                             \
5804     if (RExC_lastnum!=num)                                      \
5805        PerlIO_printf(Perl_debug_log,"|%4d",num);                \
5806     else                                                        \
5807        PerlIO_printf(Perl_debug_log,"|%4s","");                 \
5808     PerlIO_printf(Perl_debug_log,"|%*s%-4s",                    \
5809         (int)((depth*2)), "",                                   \
5810         (funcname)                                              \
5811     );                                                          \
5812     RExC_lastnum=num;                                           \
5813     RExC_lastparse=RExC_parse;                                  \
5814 })
5815
5816
5817
5818 #define DEBUG_PARSE(funcname)     DEBUG_PARSE_r({           \
5819     DEBUG_PARSE_MSG((funcname));                            \
5820     PerlIO_printf(Perl_debug_log,"%4s","\n");               \
5821 })
5822 #define DEBUG_PARSE_FMT(funcname,fmt,args)     DEBUG_PARSE_r({           \
5823     DEBUG_PARSE_MSG((funcname));                            \
5824     PerlIO_printf(Perl_debug_log,fmt "\n",args);               \
5825 })
5826
5827 /* This section of code defines the inversion list object and its methods.  The
5828  * interfaces are highly subject to change, so as much as possible is static to
5829  * this file.  An inversion list is here implemented as a malloc'd C UV array
5830  * with some added info that is placed as UVs at the beginning in a header
5831  * portion.  An inversion list for Unicode is an array of code points, sorted
5832  * by ordinal number.  The zeroth element is the first code point in the list.
5833  * The 1th element is the first element beyond that not in the list.  In other
5834  * words, the first range is
5835  *  invlist[0]..(invlist[1]-1)
5836  * The other ranges follow.  Thus every element that is divisible by two marks
5837  * the beginning of a range that is in the list, and every element not
5838  * divisible by two marks the beginning of a range not in the list.  A single
5839  * element inversion list that contains the single code point N generally
5840  * consists of two elements
5841  *  invlist[0] == N
5842  *  invlist[1] == N+1
5843  * (The exception is when N is the highest representable value on the
5844  * machine, in which case the list containing just it would be a single
5845  * element, itself.  By extension, if the last range in the list extends to
5846  * infinity, then the first element of that range will be in the inversion list
5847  * at a position that is divisible by two, and is the final element in the
5848  * list.)
5849  * Taking the complement (inverting) an inversion list is quite simple, if the
5850  * first element is 0, remove it; otherwise add a 0 element at the beginning.
5851  * This implementation reserves an element at the beginning of each inversion list
5852  * to contain 0 when the list contains 0, and contains 1 otherwise.  The actual
5853  * beginning of the list is either that element if 0, or the next one if 1.
5854  *
5855  * More about inversion lists can be found in "Unicode Demystified"
5856  * Chapter 13 by Richard Gillam, published by Addison-Wesley.
5857  * More will be coming when functionality is added later.
5858  *
5859  * The inversion list data structure is currently implemented as an SV pointing
5860  * to an array of UVs that the SV thinks are bytes.  This allows us to have an
5861  * array of UV whose memory management is automatically handled by the existing
5862  * facilities for SV's.
5863  *
5864  * Some of the methods should always be private to the implementation, and some
5865  * should eventually be made public */
5866
5867 #define INVLIST_LEN_OFFSET 0    /* Number of elements in the inversion list */
5868 #define INVLIST_ITER_OFFSET 1   /* Current iteration position */
5869
5870 #define INVLIST_ZERO_OFFSET 2   /* 0 or 1; must be last element in header */
5871 /* The UV at position ZERO contains either 0 or 1.  If 0, the inversion list
5872  * contains the code point U+00000, and begins here.  If 1, the inversion list
5873  * doesn't contain U+0000, and it begins at the next UV in the array.
5874  * Inverting an inversion list consists of adding or removing the 0 at the
5875  * beginning of it.  By reserving a space for that 0, inversion can be made
5876  * very fast */
5877
5878 #define HEADER_LENGTH (INVLIST_ZERO_OFFSET + 1)
5879
5880 /* Internally things are UVs */
5881 #define TO_INTERNAL_SIZE(x) ((x + HEADER_LENGTH) * sizeof(UV))
5882 #define FROM_INTERNAL_SIZE(x) ((x / sizeof(UV)) - HEADER_LENGTH)
5883
5884 #define INVLIST_INITIAL_LEN 10
5885
5886 PERL_STATIC_INLINE UV*
5887 S__invlist_array_init(pTHX_ SV* const invlist, const bool will_have_0)
5888 {
5889     /* Returns a pointer to the first element in the inversion list's array.
5890      * This is called upon initialization of an inversion list.  Where the
5891      * array begins depends on whether the list has the code point U+0000
5892      * in it or not.  The other parameter tells it whether the code that
5893      * follows this call is about to put a 0 in the inversion list or not.
5894      * The first element is either the element with 0, if 0, or the next one,
5895      * if 1 */
5896
5897     UV* zero = get_invlist_zero_addr(invlist);
5898
5899     PERL_ARGS_ASSERT__INVLIST_ARRAY_INIT;
5900
5901     /* Must be empty */
5902     assert(! *get_invlist_len_addr(invlist));
5903
5904     /* 1^1 = 0; 1^0 = 1 */
5905     *zero = 1 ^ will_have_0;
5906     return zero + *zero;
5907 }
5908
5909 PERL_STATIC_INLINE UV*
5910 S_invlist_array(pTHX_ SV* const invlist)
5911 {
5912     /* Returns the pointer to the inversion list's array.  Every time the
5913      * length changes, this needs to be called in case malloc or realloc moved
5914      * it */
5915
5916     PERL_ARGS_ASSERT_INVLIST_ARRAY;
5917
5918     /* Must not be empty */
5919     assert(*get_invlist_len_addr(invlist));
5920     assert(*get_invlist_zero_addr(invlist) == 0
5921            || *get_invlist_zero_addr(invlist) == 1);
5922
5923     /* The array begins either at the element reserved for zero if the
5924      * list contains 0 (that element will be set to 0), or otherwise the next
5925      * element (in which case the reserved element will be set to 1). */
5926     return (UV *) (get_invlist_zero_addr(invlist)
5927                    + *get_invlist_zero_addr(invlist));
5928 }
5929
5930 PERL_STATIC_INLINE UV*
5931 S_get_invlist_len_addr(pTHX_ SV* invlist)
5932 {
5933     /* Return the address of the UV that contains the current number
5934      * of used elements in the inversion list */
5935
5936     PERL_ARGS_ASSERT_GET_INVLIST_LEN_ADDR;
5937
5938     return (UV *) (SvPVX(invlist) + (INVLIST_LEN_OFFSET * sizeof (UV)));
5939 }
5940
5941 PERL_STATIC_INLINE UV
5942 S_invlist_len(pTHX_ SV* const invlist)
5943 {
5944     /* Returns the current number of elements in the inversion list's array */
5945
5946     PERL_ARGS_ASSERT_INVLIST_LEN;
5947
5948     return *get_invlist_len_addr(invlist);
5949 }
5950
5951 PERL_STATIC_INLINE void
5952 S_invlist_set_len(pTHX_ SV* const invlist, const UV len)
5953 {
5954     /* Sets the current number of elements stored in the inversion list */
5955
5956     PERL_ARGS_ASSERT_INVLIST_SET_LEN;
5957
5958     *get_invlist_len_addr(invlist) = len;
5959
5960     SvCUR_set(invlist, TO_INTERNAL_SIZE(len));
5961     /* If the list contains U+0000, that element is part of the header,
5962      * and should not be counted as part of the array.  It will contain
5963      * 0 in that case, and 1 otherwise.  So we could flop 0=>1, 1=>0 and
5964      * subtract:
5965      *  SvCUR_set(invlist,
5966      *            TO_INTERNAL_SIZE(len
5967      *                             - (*get_invlist_zero_addr(inv_list) ^ 1)));
5968      * But, this is only valid if len is not 0.  The consequences of not doing
5969      * this is that the memory allocation code may think that the 1 more UV
5970      * is being used than actually is, and so might do an unnecessary grow.
5971      * That seems worth not bothering to make this the precise amount.
5972      *
5973      * Note that when inverting, SvCUR shouldn't change */
5974 }
5975
5976 PERL_STATIC_INLINE UV
5977 S_invlist_max(pTHX_ SV* const invlist)
5978 {
5979     /* Returns the maximum number of elements storable in the inversion list's
5980      * array, without having to realloc() */
5981
5982     PERL_ARGS_ASSERT_INVLIST_MAX;
5983
5984     return FROM_INTERNAL_SIZE(SvLEN(invlist));
5985 }
5986
5987 PERL_STATIC_INLINE UV*
5988 S_get_invlist_zero_addr(pTHX_ SV* invlist)
5989 {
5990     /* Return the address of the UV that is reserved to hold 0 if the inversion
5991      * list contains 0.  This has to be the last element of the heading, as the
5992      * list proper starts with either it if 0, or the next element if not.
5993      * (But we force it to contain either 0 or 1) */
5994
5995     PERL_ARGS_ASSERT_GET_INVLIST_ZERO_ADDR;
5996
5997     return (UV *) (SvPVX(invlist) + (INVLIST_ZERO_OFFSET * sizeof (UV)));
5998 }
5999
6000 #ifndef PERL_IN_XSUB_RE
6001 SV*
6002 Perl__new_invlist(pTHX_ IV initial_size)
6003 {
6004
6005     /* Return a pointer to a newly constructed inversion list, with enough
6006      * space to store 'initial_size' elements.  If that number is negative, a
6007      * system default is used instead */
6008
6009     SV* new_list;
6010
6011     if (initial_size < 0) {
6012         initial_size = INVLIST_INITIAL_LEN;
6013     }
6014
6015     /* Allocate the initial space */
6016     new_list = newSV(TO_INTERNAL_SIZE(initial_size));
6017     invlist_set_len(new_list, 0);
6018
6019     /* Force iterinit() to be used to get iteration to work */
6020     *get_invlist_iter_addr(new_list) = UV_MAX;
6021
6022     /* This should force a segfault if a method doesn't initialize this
6023      * properly */
6024     *get_invlist_zero_addr(new_list) = UV_MAX;
6025
6026     return new_list;
6027 }
6028 #endif
6029
6030 STATIC void
6031 S_invlist_extend(pTHX_ SV* const invlist, const UV new_max)
6032 {
6033     /* Grow the maximum size of an inversion list */
6034
6035     PERL_ARGS_ASSERT_INVLIST_EXTEND;
6036
6037     SvGROW((SV *)invlist, TO_INTERNAL_SIZE(new_max));
6038 }
6039
6040 PERL_STATIC_INLINE void
6041 S_invlist_trim(pTHX_ SV* const invlist)
6042 {
6043     PERL_ARGS_ASSERT_INVLIST_TRIM;
6044
6045     /* Change the length of the inversion list to how many entries it currently
6046      * has */
6047
6048     SvPV_shrink_to_cur((SV *) invlist);
6049 }
6050
6051 /* An element is in an inversion list iff its index is even numbered: 0, 2, 4,
6052  * etc */
6053
6054 #define ELEMENT_IN_INVLIST_SET(i) (! ((i) & 1))
6055 #define PREV_ELEMENT_IN_INVLIST_SET(i) (! ELEMENT_IN_INVLIST_SET(i))
6056
6057 #ifndef PERL_IN_XSUB_RE
6058 void
6059 Perl__append_range_to_invlist(pTHX_ SV* const invlist, const UV start, const UV end)
6060 {
6061    /* Subject to change or removal.  Append the range from 'start' to 'end' at
6062     * the end of the inversion list.  The range must be above any existing
6063     * ones. */
6064
6065     UV* array;
6066     UV max = invlist_max(invlist);
6067     UV len = invlist_len(invlist);
6068
6069     PERL_ARGS_ASSERT__APPEND_RANGE_TO_INVLIST;
6070
6071     if (len == 0) { /* Empty lists must be initialized */
6072         array = _invlist_array_init(invlist, start == 0);
6073     }
6074     else {
6075         /* Here, the existing list is non-empty. The current max entry in the
6076          * list is generally the first value not in the set, except when the
6077          * set extends to the end of permissible values, in which case it is
6078          * the first entry in that final set, and so this call is an attempt to
6079          * append out-of-order */
6080
6081         UV final_element = len - 1;
6082         array = invlist_array(invlist);
6083         if (array[final_element] > start
6084             || ELEMENT_IN_INVLIST_SET(final_element))
6085         {
6086             Perl_croak(aTHX_ "panic: attempting to append to an inversion list, but wasn't at the end of the list");
6087         }
6088
6089         /* Here, it is a legal append.  If the new range begins with the first
6090          * value not in the set, it is extending the set, so the new first
6091          * value not in the set is one greater than the newly extended range.
6092          * */
6093         if (array[final_element] == start) {
6094             if (end != UV_MAX) {
6095                 array[final_element] = end + 1;
6096             }
6097             else {
6098                 /* But if the end is the maximum representable on the machine,
6099                  * just let the range that this would extend have no end */
6100                 invlist_set_len(invlist, len - 1);
6101             }
6102             return;
6103         }
6104     }
6105
6106     /* Here the new range doesn't extend any existing set.  Add it */
6107
6108     len += 2;   /* Includes an element each for the start and end of range */
6109
6110     /* If overflows the existing space, extend, which may cause the array to be
6111      * moved */
6112     if (max < len) {
6113         invlist_extend(invlist, len);
6114         invlist_set_len(invlist, len);  /* Have to set len here to avoid assert
6115                                            failure in invlist_array() */
6116         array = invlist_array(invlist);
6117     }
6118     else {
6119         invlist_set_len(invlist, len);
6120     }
6121
6122     /* The next item on the list starts the range, the one after that is
6123      * one past the new range.  */
6124     array[len - 2] = start;
6125     if (end != UV_MAX) {
6126         array[len - 1] = end + 1;
6127     }
6128     else {
6129         /* But if the end is the maximum representable on the machine, just let
6130          * the range have no end */
6131         invlist_set_len(invlist, len - 1);
6132     }
6133 }
6134 #endif
6135
6136 void
6137 Perl__invlist_union(pTHX_ SV* const a, SV* const b, SV** output)
6138 {
6139     /* Take the union of two inversion lists and point 'result' to it.  If
6140      * 'result' on input points to one of the two lists, the reference count to
6141      * that list will be decremented.
6142      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6143      * Richard Gillam, published by Addison-Wesley, and explained at some
6144      * length there.  The preface says to incorporate its examples into your
6145      * code at your own risk.
6146      *
6147      * The algorithm is like a merge sort.
6148      *
6149      * XXX A potential performance improvement is to keep track as we go along
6150      * if only one of the inputs contributes to the result, meaning the other
6151      * is a subset of that one.  In that case, we can skip the final copy and
6152      * return the larger of the input lists, but then outside code might need
6153      * to keep track of whether to free the input list or not */
6154
6155     UV* array_a;    /* a's array */
6156     UV* array_b;
6157     UV len_a;       /* length of a's array */
6158     UV len_b;
6159
6160     SV* u;                      /* the resulting union */
6161     UV* array_u;
6162     UV len_u;
6163
6164     UV i_a = 0;             /* current index into a's array */
6165     UV i_b = 0;
6166     UV i_u = 0;
6167
6168     /* running count, as explained in the algorithm source book; items are
6169      * stopped accumulating and are output when the count changes to/from 0.
6170      * The count is incremented when we start a range that's in the set, and
6171      * decremented when we start a range that's not in the set.  So its range
6172      * is 0 to 2.  Only when the count is zero is something not in the set.
6173      */
6174     UV count = 0;
6175
6176     PERL_ARGS_ASSERT__INVLIST_UNION;
6177
6178     /* If either one is empty, the union is the other one */
6179     len_a = invlist_len(a);
6180     if (len_a == 0) {
6181         if (output == &a) {
6182             SvREFCNT_dec(a);
6183         }
6184         else if (output != &b) {
6185             *output = invlist_clone(b);
6186         }
6187         /* else *output already = b; */
6188         return;
6189     }
6190     else if ((len_b = invlist_len(b)) == 0) {
6191         if (output == &b) {
6192             SvREFCNT_dec(b);
6193         }
6194         else if (output != &a) {
6195             *output = invlist_clone(a);
6196         }
6197         /* else *output already = a; */
6198         return;
6199     }
6200
6201     /* Here both lists exist and are non-empty */
6202     array_a = invlist_array(a);
6203     array_b = invlist_array(b);
6204
6205     /* Size the union for the worst case: that the sets are completely
6206      * disjoint */
6207     u = _new_invlist(len_a + len_b);
6208
6209     /* Will contain U+0000 if either component does */
6210     array_u = _invlist_array_init(u, (len_a > 0 && array_a[0] == 0)
6211                                       || (len_b > 0 && array_b[0] == 0));
6212
6213     /* Go through each list item by item, stopping when exhausted one of
6214      * them */
6215     while (i_a < len_a && i_b < len_b) {
6216         UV cp;      /* The element to potentially add to the union's array */
6217         bool cp_in_set;   /* is it in the the input list's set or not */
6218
6219         /* We need to take one or the other of the two inputs for the union.
6220          * Since we are merging two sorted lists, we take the smaller of the
6221          * next items.  In case of a tie, we take the one that is in its set
6222          * first.  If we took one not in the set first, it would decrement the
6223          * count, possibly to 0 which would cause it to be output as ending the
6224          * range, and the next time through we would take the same number, and
6225          * output it again as beginning the next range.  By doing it the
6226          * opposite way, there is no possibility that the count will be
6227          * momentarily decremented to 0, and thus the two adjoining ranges will
6228          * be seamlessly merged.  (In a tie and both are in the set or both not
6229          * in the set, it doesn't matter which we take first.) */
6230         if (array_a[i_a] < array_b[i_b]
6231             || (array_a[i_a] == array_b[i_b] && ELEMENT_IN_INVLIST_SET(i_a)))
6232         {
6233             cp_in_set = ELEMENT_IN_INVLIST_SET(i_a);
6234             cp= array_a[i_a++];
6235         }
6236         else {
6237             cp_in_set = ELEMENT_IN_INVLIST_SET(i_b);
6238             cp= array_b[i_b++];
6239         }
6240
6241         /* Here, have chosen which of the two inputs to look at.  Only output
6242          * if the running count changes to/from 0, which marks the
6243          * beginning/end of a range in that's in the set */
6244         if (cp_in_set) {
6245             if (count == 0) {
6246                 array_u[i_u++] = cp;
6247             }
6248             count++;
6249         }
6250         else {
6251             count--;
6252             if (count == 0) {
6253                 array_u[i_u++] = cp;
6254             }
6255         }
6256     }
6257
6258     /* Here, we are finished going through at least one of the lists, which
6259      * means there is something remaining in at most one.  We check if the list
6260      * that hasn't been exhausted is positioned such that we are in the middle
6261      * of a range in its set or not.  (i_a and i_b point to the element beyond
6262      * the one we care about.) If in the set, we decrement 'count'; if 0, there
6263      * is potentially more to output.
6264      * There are four cases:
6265      *  1) Both weren't in their sets, count is 0, and remains 0.  What's left
6266      *     in the union is entirely from the non-exhausted set.
6267      *  2) Both were in their sets, count is 2.  Nothing further should
6268      *     be output, as everything that remains will be in the exhausted
6269      *     list's set, hence in the union; decrementing to 1 but not 0 insures
6270      *     that
6271      *  3) the exhausted was in its set, non-exhausted isn't, count is 1.
6272      *     Nothing further should be output because the union includes
6273      *     everything from the exhausted set.  Not decrementing ensures that.
6274      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1;
6275      *     decrementing to 0 insures that we look at the remainder of the
6276      *     non-exhausted set */
6277     if ((i_a != len_a && PREV_ELEMENT_IN_INVLIST_SET(i_a))
6278         || (i_b != len_b && PREV_ELEMENT_IN_INVLIST_SET(i_b)))
6279     {
6280         count--;
6281     }
6282
6283     /* The final length is what we've output so far, plus what else is about to
6284      * be output.  (If 'count' is non-zero, then the input list we exhausted
6285      * has everything remaining up to the machine's limit in its set, and hence
6286      * in the union, so there will be no further output. */
6287     len_u = i_u;
6288     if (count == 0) {
6289         /* At most one of the subexpressions will be non-zero */
6290         len_u += (len_a - i_a) + (len_b - i_b);
6291     }
6292
6293     /* Set result to final length, which can change the pointer to array_u, so
6294      * re-find it */
6295     if (len_u != invlist_len(u)) {
6296         invlist_set_len(u, len_u);
6297         invlist_trim(u);
6298         array_u = invlist_array(u);
6299     }
6300
6301     /* When 'count' is 0, the list that was exhausted (if one was shorter than
6302      * the other) ended with everything above it not in its set.  That means
6303      * that the remaining part of the union is precisely the same as the
6304      * non-exhausted list, so can just copy it unchanged.  (If both list were
6305      * exhausted at the same time, then the operations below will be both 0.)
6306      */
6307     if (count == 0) {
6308         IV copy_count; /* At most one will have a non-zero copy count */
6309         if ((copy_count = len_a - i_a) > 0) {
6310             Copy(array_a + i_a, array_u + i_u, copy_count, UV);
6311         }
6312         else if ((copy_count = len_b - i_b) > 0) {
6313             Copy(array_b + i_b, array_u + i_u, copy_count, UV);
6314         }
6315     }
6316
6317     /*  We may be removing a reference to one of the inputs */
6318     if (&a == output || &b == output) {
6319         SvREFCNT_dec(*output);
6320     }
6321
6322     *output = u;
6323     return;
6324 }
6325
6326 void
6327 Perl__invlist_intersection(pTHX_ SV* const a, SV* const b, SV** i)
6328 {
6329     /* Take the intersection of two inversion lists and point 'i' to it.  If
6330      * 'i' on input points to one of the two lists, the reference count to that
6331      * list will be decremented.
6332      * The basis for this comes from "Unicode Demystified" Chapter 13 by
6333      * Richard Gillam, published by Addison-Wesley, and explained at some
6334      * length there.  The preface says to incorporate its examples into your
6335      * code at your own risk.  In fact, it had bugs
6336      *
6337      * The algorithm is like a merge sort, and is essentially the same as the
6338      * union above
6339      */
6340
6341     UV* array_a;                /* a's array */
6342     UV* array_b;
6343     UV len_a;   /* length of a's array */
6344     UV len_b;
6345
6346     SV* r;                   /* the resulting intersection */
6347     UV* array_r;
6348     UV len_r;
6349
6350     UV i_a = 0;             /* current index into a's array */
6351     UV i_b = 0;
6352     UV i_r = 0;
6353
6354     /* running count, as explained in the algorithm source book; items are
6355      * stopped accumulating and are output when the count changes to/from 2.
6356      * The count is incremented when we start a range that's in the set, and
6357      * decremented when we start a range that's not in the set.  So its range
6358      * is 0 to 2.  Only when the count is 2 is something in the intersection.
6359      */
6360     UV count = 0;
6361
6362     PERL_ARGS_ASSERT__INVLIST_INTERSECTION;
6363
6364     /* If either one is empty, the intersection is null */
6365     len_a = invlist_len(a);
6366     if ((len_a == 0) || ((len_b = invlist_len(b)) == 0)) {
6367         *i = _new_invlist(0);
6368
6369         /* If the result is the same as one of the inputs, the input is being
6370          * overwritten */
6371         if (i == &a) {
6372             SvREFCNT_dec(a);
6373         }
6374         else if (i == &b) {
6375             SvREFCNT_dec(b);
6376         }
6377         return;
6378     }
6379
6380     /* Here both lists exist and are non-empty */
6381     array_a = invlist_array(a);
6382     array_b = invlist_array(b);
6383
6384     /* Size the intersection for the worst case: that the intersection ends up
6385      * fragmenting everything to be completely disjoint */
6386     r= _new_invlist(len_a + len_b);
6387
6388     /* Will contain U+0000 iff both components do */
6389     array_r = _invlist_array_init(r, len_a > 0 && array_a[0] == 0
6390                                      && len_b > 0 && array_b[0] == 0);
6391
6392     /* Go through each list item by item, stopping when exhausted one of
6393      * them */
6394     while (i_a < len_a && i_b < len_b) {
6395         UV cp;      /* The element to potentially add to the intersection's
6396                        array */
6397         bool cp_in_set; /* Is it in the input list's set or not */
6398
6399         /* We need to take one or the other of the two inputs for the
6400          * intersection.  Since we are merging two sorted lists, we take the
6401          * smaller of the next items.  In case of a tie, we take the one that
6402          * is not in its set first (a difference from the union algorithm).  If
6403          * we took one in the set first, it would increment the count, possibly
6404          * to 2 which would cause it to be output as starting a range in the
6405          * intersection, and the next time through we would take that same
6406          * number, and output it again as ending the set.  By doing it the
6407          * opposite of this, there is no possibility that the count will be
6408          * momentarily incremented to 2.  (In a tie and both are in the set or
6409          * both not in the set, it doesn't matter which we take first.) */
6410         if (array_a[i_a] < array_b[i_b]
6411             || (array_a[i_a] == array_b[i_b] && ! ELEMENT_IN_INVLIST_SET(i_a)))
6412         {
6413             cp_in_set = ELEMENT_IN_INVLIST_SET(i_a);
6414             cp= array_a[i_a++];
6415         }
6416         else {
6417             cp_in_set = ELEMENT_IN_INVLIST_SET(i_b);
6418             cp= array_b[i_b++];
6419         }
6420
6421         /* Here, have chosen which of the two inputs to look at.  Only output
6422          * if the running count changes to/from 2, which marks the
6423          * beginning/end of a range that's in the intersection */
6424         if (cp_in_set) {
6425             count++;
6426             if (count == 2) {
6427                 array_r[i_r++] = cp;
6428             }
6429         }
6430         else {
6431             if (count == 2) {
6432                 array_r[i_r++] = cp;
6433             }
6434             count--;
6435         }
6436     }
6437
6438     /* Here, we are finished going through at least one of the lists, which
6439      * means there is something remaining in at most one.  We check if the list
6440      * that has been exhausted is positioned such that we are in the middle
6441      * of a range in its set or not.  (i_a and i_b point to elements 1 beyond
6442      * the ones we care about.)  There are four cases:
6443      *  1) Both weren't in their sets, count is 0, and remains 0.  There's
6444      *     nothing left in the intersection.
6445      *  2) Both were in their sets, count is 2 and perhaps is incremented to
6446      *     above 2.  What should be output is exactly that which is in the
6447      *     non-exhausted set, as everything it has is also in the intersection
6448      *     set, and everything it doesn't have can't be in the intersection
6449      *  3) The exhausted was in its set, non-exhausted isn't, count is 1, and
6450      *     gets incremented to 2.  Like the previous case, the intersection is
6451      *     everything that remains in the non-exhausted set.
6452      *  4) the exhausted wasn't in its set, non-exhausted is, count is 1, and
6453      *     remains 1.  And the intersection has nothing more. */
6454     if ((i_a == len_a && PREV_ELEMENT_IN_INVLIST_SET(i_a))
6455         || (i_b == len_b && PREV_ELEMENT_IN_INVLIST_SET(i_b)))
6456     {
6457         count++;
6458     }
6459
6460     /* The final length is what we've output so far plus what else is in the
6461      * intersection.  At most one of the subexpressions below will be non-zero */
6462     len_r = i_r;
6463     if (count >= 2) {
6464         len_r += (len_a - i_a) + (len_b - i_b);
6465     }
6466
6467     /* Set result to final length, which can change the pointer to array_r, so
6468      * re-find it */
6469     if (len_r != invlist_len(r)) {
6470         invlist_set_len(r, len_r);
6471         invlist_trim(r);
6472         array_r = invlist_array(r);
6473     }
6474
6475     /* Finish outputting any remaining */
6476     if (count >= 2) { /* At most one will have a non-zero copy count */
6477         IV copy_count;
6478         if ((copy_count = len_a - i_a) > 0) {
6479             Copy(array_a + i_a, array_r + i_r, copy_count, UV);
6480         }
6481         else if ((copy_count = len_b - i_b) > 0) {
6482             Copy(array_b + i_b, array_r + i_r, copy_count, UV);
6483         }
6484     }
6485
6486     /*  We may be removing a reference to one of the inputs */
6487     if (&a == i || &b == i) {
6488         SvREFCNT_dec(*i);
6489     }
6490
6491     *i = r;
6492     return;
6493 }
6494
6495 STATIC SV*
6496 S_add_range_to_invlist(pTHX_ SV* invlist, const UV start, const UV end)
6497 {
6498     /* Add the range from 'start' to 'end' inclusive to the inversion list's
6499      * set.  A pointer to the inversion list is returned.  This may actually be
6500      * a new list, in which case the passed in one has been destroyed.  The
6501      * passed in inversion list can be NULL, in which case a new one is created
6502      * with just the one range in it */
6503
6504     SV* range_invlist;
6505     UV len;
6506
6507     if (invlist == NULL) {
6508         invlist = _new_invlist(2);
6509         len = 0;
6510     }
6511     else {
6512         len = invlist_len(invlist);
6513     }
6514
6515     /* If comes after the final entry, can just append it to the end */
6516     if (len == 0
6517         || start >= invlist_array(invlist)
6518                                     [invlist_len(invlist) - 1])
6519     {
6520         _append_range_to_invlist(invlist, start, end);
6521         return invlist;
6522     }
6523
6524     /* Here, can't just append things, create and return a new inversion list
6525      * which is the union of this range and the existing inversion list */
6526     range_invlist = _new_invlist(2);
6527     _append_range_to_invlist(range_invlist, start, end);
6528
6529     _invlist_union(invlist, range_invlist, &invlist);
6530
6531     /* The temporary can be freed */
6532     SvREFCNT_dec(range_invlist);
6533
6534     return invlist;
6535 }
6536
6537 PERL_STATIC_INLINE SV*
6538 S_add_cp_to_invlist(pTHX_ SV* invlist, const UV cp) {
6539     return add_range_to_invlist(invlist, cp, cp);
6540 }
6541
6542 void
6543 Perl__invlist_invert(pTHX_ SV* const invlist)
6544 {
6545     /* Complement the input inversion list.  This adds a 0 if the list didn't
6546      * have a zero; removes it otherwise.  As described above, the data
6547      * structure is set up so that this is very efficient */
6548
6549     UV* len_pos = get_invlist_len_addr(invlist);
6550
6551     PERL_ARGS_ASSERT__INVLIST_INVERT;
6552
6553     /* The inverse of matching nothing is matching everything */
6554     if (*len_pos == 0) {
6555         _append_range_to_invlist(invlist, 0, UV_MAX);
6556         return;
6557     }
6558
6559     /* The exclusive or complents 0 to 1; and 1 to 0.  If the result is 1, the
6560      * zero element was a 0, so it is being removed, so the length decrements
6561      * by 1; and vice-versa.  SvCUR is unaffected */
6562     if (*get_invlist_zero_addr(invlist) ^= 1) {
6563         (*len_pos)--;
6564     }
6565     else {
6566         (*len_pos)++;
6567     }
6568 }
6569
6570 PERL_STATIC_INLINE SV*
6571 S_invlist_clone(pTHX_ SV* const invlist)
6572 {
6573
6574     /* Return a new inversion list that is a copy of the input one, which is
6575      * unchanged */
6576
6577     SV* new_invlist = _new_invlist(SvCUR(invlist));
6578
6579     PERL_ARGS_ASSERT_INVLIST_CLONE;
6580
6581     Copy(SvPVX(invlist), SvPVX(new_invlist), SvCUR(invlist), char);
6582     return new_invlist;
6583 }
6584
6585 void
6586 Perl__invlist_subtract(pTHX_ SV* const a, SV* const b, SV** result)
6587 {
6588     /* Point result to an inversion list which consists of all elements in 'a'
6589      * that aren't also in 'b' */
6590
6591     PERL_ARGS_ASSERT__INVLIST_SUBTRACT;
6592
6593     /* Subtracting nothing retains the original */
6594     if (invlist_len(b) == 0) {
6595
6596         /* If the result is not to be the same variable as the original, create
6597          * a copy */
6598         if (result != &a) {
6599             *result = invlist_clone(a);
6600         }
6601     } else {
6602         SV *b_copy = invlist_clone(b);
6603         _invlist_invert(b_copy);        /* Everything not in 'b' */
6604         _invlist_intersection(a, b_copy, result);    /* Everything in 'a' not in
6605                                                        'b' */
6606         SvREFCNT_dec(b_copy);
6607     }
6608
6609     if (result == &b) {
6610         SvREFCNT_dec(b);
6611     }
6612
6613     return;
6614 }
6615
6616 PERL_STATIC_INLINE UV*
6617 S_get_invlist_iter_addr(pTHX_ SV* invlist)
6618 {
6619     /* Return the address of the UV that contains the current iteration
6620      * position */
6621
6622     PERL_ARGS_ASSERT_GET_INVLIST_ITER_ADDR;
6623
6624     return (UV *) (SvPVX(invlist) + (INVLIST_ITER_OFFSET * sizeof (UV)));
6625 }
6626
6627 PERL_STATIC_INLINE void
6628 S_invlist_iterinit(pTHX_ SV* invlist)   /* Initialize iterator for invlist */
6629 {
6630     PERL_ARGS_ASSERT_INVLIST_ITERINIT;
6631
6632     *get_invlist_iter_addr(invlist) = 0;
6633 }
6634
6635 STATIC bool
6636 S_invlist_iternext(pTHX_ SV* invlist, UV* start, UV* end)
6637 {
6638     UV* pos = get_invlist_iter_addr(invlist);
6639     UV len = invlist_len(invlist);
6640     UV *array;
6641
6642     PERL_ARGS_ASSERT_INVLIST_ITERNEXT;
6643
6644     if (*pos >= len) {
6645         *pos = UV_MAX;  /* Force iternit() to be required next time */
6646         return FALSE;
6647     }
6648
6649     array = invlist_array(invlist);
6650
6651     *start = array[(*pos)++];
6652
6653     if (*pos >= len) {
6654         *end = UV_MAX;
6655     }
6656     else {
6657         *end = array[(*pos)++] - 1;
6658     }
6659
6660     return TRUE;
6661 }
6662
6663 #if 0
6664 void
6665 S_invlist_dump(pTHX_ SV* const invlist, const char * const header)
6666 {
6667     /* Dumps out the ranges in an inversion list.  The string 'header'
6668      * if present is output on a line before the first range */
6669
6670     UV start, end;
6671
6672     if (header && strlen(header)) {
6673         PerlIO_printf(Perl_debug_log, "%s\n", header);
6674     }
6675     invlist_iterinit(invlist);
6676     while (invlist_iternext(invlist, &start, &end)) {
6677         if (end == UV_MAX) {
6678             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. INFINITY\n", start);
6679         }
6680         else {
6681             PerlIO_printf(Perl_debug_log, "0x%04"UVXf" .. 0x%04"UVXf"\n", start, end);
6682         }
6683     }
6684 }
6685 #endif
6686
6687 #undef HEADER_LENGTH
6688 #undef INVLIST_INITIAL_LENGTH
6689 #undef TO_INTERNAL_SIZE
6690 #undef FROM_INTERNAL_SIZE
6691 #undef INVLIST_LEN_OFFSET
6692 #undef INVLIST_ZERO_OFFSET
6693 #undef INVLIST_ITER_OFFSET
6694
6695 /* End of inversion list object */
6696
6697 /*
6698  - reg - regular expression, i.e. main body or parenthesized thing
6699  *
6700  * Caller must absorb opening parenthesis.
6701  *
6702  * Combining parenthesis handling with the base level of regular expression
6703  * is a trifle forced, but the need to tie the tails of the branches to what
6704  * follows makes it hard to avoid.
6705  */
6706 #define REGTAIL(x,y,z) regtail((x),(y),(z),depth+1)
6707 #ifdef DEBUGGING
6708 #define REGTAIL_STUDY(x,y,z) regtail_study((x),(y),(z),depth+1)
6709 #else
6710 #define REGTAIL_STUDY(x,y,z) regtail((x),(y),(z),depth+1)
6711 #endif
6712
6713 STATIC regnode *
6714 S_reg(pTHX_ RExC_state_t *pRExC_state, I32 paren, I32 *flagp,U32 depth)
6715     /* paren: Parenthesized? 0=top, 1=(, inside: changed to letter. */
6716 {
6717     dVAR;
6718     register regnode *ret;              /* Will be the head of the group. */
6719     register regnode *br;
6720     register regnode *lastbr;
6721     register regnode *ender = NULL;
6722     register I32 parno = 0;
6723     I32 flags;
6724     U32 oregflags = RExC_flags;
6725     bool have_branch = 0;
6726     bool is_open = 0;
6727     I32 freeze_paren = 0;
6728     I32 after_freeze = 0;
6729
6730     /* for (?g), (?gc), and (?o) warnings; warning
6731        about (?c) will warn about (?g) -- japhy    */
6732
6733 #define WASTED_O  0x01
6734 #define WASTED_G  0x02
6735 #define WASTED_C  0x04
6736 #define WASTED_GC (0x02|0x04)
6737     I32 wastedflags = 0x00;
6738
6739     char * parse_start = RExC_parse; /* MJD */
6740     char * const oregcomp_parse = RExC_parse;
6741
6742     GET_RE_DEBUG_FLAGS_DECL;
6743
6744     PERL_ARGS_ASSERT_REG;
6745     DEBUG_PARSE("reg ");
6746
6747     *flagp = 0;                         /* Tentatively. */
6748
6749
6750     /* Make an OPEN node, if parenthesized. */
6751     if (paren) {
6752         if ( *RExC_parse == '*') { /* (*VERB:ARG) */
6753             char *start_verb = RExC_parse;
6754             STRLEN verb_len = 0;
6755             char *start_arg = NULL;
6756             unsigned char op = 0;
6757             int argok = 1;
6758             int internal_argval = 0; /* internal_argval is only useful if !argok */
6759             while ( *RExC_parse && *RExC_parse != ')' ) {
6760                 if ( *RExC_parse == ':' ) {
6761                     start_arg = RExC_parse + 1;
6762                     break;
6763                 }
6764                 RExC_parse++;
6765             }
6766             ++start_verb;
6767             verb_len = RExC_parse - start_verb;
6768             if ( start_arg ) {
6769                 RExC_parse++;
6770                 while ( *RExC_parse && *RExC_parse != ')' ) 
6771                     RExC_parse++;
6772                 if ( *RExC_parse != ')' ) 
6773                     vFAIL("Unterminated verb pattern argument");
6774                 if ( RExC_parse == start_arg )
6775                     start_arg = NULL;
6776             } else {
6777                 if ( *RExC_parse != ')' )
6778                     vFAIL("Unterminated verb pattern");
6779             }
6780             
6781             switch ( *start_verb ) {
6782             case 'A':  /* (*ACCEPT) */
6783                 if ( memEQs(start_verb,verb_len,"ACCEPT") ) {
6784                     op = ACCEPT;
6785                     internal_argval = RExC_nestroot;
6786                 }
6787                 break;
6788             case 'C':  /* (*COMMIT) */
6789                 if ( memEQs(start_verb,verb_len,"COMMIT") )
6790                     op = COMMIT;
6791                 break;
6792             case 'F':  /* (*FAIL) */
6793                 if ( verb_len==1 || memEQs(start_verb,verb_len,"FAIL") ) {
6794                     op = OPFAIL;
6795                     argok = 0;
6796                 }
6797                 break;
6798             case ':':  /* (*:NAME) */
6799             case 'M':  /* (*MARK:NAME) */
6800                 if ( verb_len==0 || memEQs(start_verb,verb_len,"MARK") ) {
6801                     op = MARKPOINT;
6802                     argok = -1;
6803                 }
6804                 break;
6805             case 'P':  /* (*PRUNE) */
6806                 if ( memEQs(start_verb,verb_len,"PRUNE") )
6807                     op = PRUNE;
6808                 break;
6809             case 'S':   /* (*SKIP) */  
6810                 if ( memEQs(start_verb,verb_len,"SKIP") ) 
6811                     op = SKIP;
6812                 break;
6813             case 'T':  /* (*THEN) */
6814                 /* [19:06] <TimToady> :: is then */
6815                 if ( memEQs(start_verb,verb_len,"THEN") ) {
6816                     op = CUTGROUP;
6817                     RExC_seen |= REG_SEEN_CUTGROUP;
6818                 }
6819                 break;
6820             }
6821             if ( ! op ) {
6822                 RExC_parse++;
6823                 vFAIL3("Unknown verb pattern '%.*s'",
6824                     verb_len, start_verb);
6825             }
6826             if ( argok ) {
6827                 if ( start_arg && internal_argval ) {
6828                     vFAIL3("Verb pattern '%.*s' may not have an argument",
6829                         verb_len, start_verb); 
6830                 } else if ( argok < 0 && !start_arg ) {
6831                     vFAIL3("Verb pattern '%.*s' has a mandatory argument",
6832                         verb_len, start_verb);    
6833                 } else {
6834                     ret = reganode(pRExC_state, op, internal_argval);
6835                     if ( ! internal_argval && ! SIZE_ONLY ) {
6836                         if (start_arg) {
6837                             SV *sv = newSVpvn( start_arg, RExC_parse - start_arg);
6838                             ARG(ret) = add_data( pRExC_state, 1, "S" );
6839                             RExC_rxi->data->data[ARG(ret)]=(void*)sv;
6840                             ret->flags = 0;
6841                         } else {
6842                             ret->flags = 1; 
6843                         }
6844                     }               
6845                 }
6846                 if (!internal_argval)
6847                     RExC_seen |= REG_SEEN_VERBARG;
6848             } else if ( start_arg ) {
6849                 vFAIL3("Verb pattern '%.*s' may not have an argument",
6850                         verb_len, start_verb);    
6851             } else {
6852                 ret = reg_node(pRExC_state, op);
6853             }
6854             nextchar(pRExC_state);
6855             return ret;
6856         } else 
6857         if (*RExC_parse == '?') { /* (?...) */
6858             bool is_logical = 0;
6859             const char * const seqstart = RExC_parse;
6860             bool has_use_defaults = FALSE;
6861
6862             RExC_parse++;
6863             paren = *RExC_parse++;
6864             ret = NULL;                 /* For look-ahead/behind. */
6865             switch (paren) {
6866
6867             case 'P':   /* (?P...) variants for those used to PCRE/Python */
6868                 paren = *RExC_parse++;
6869                 if ( paren == '<')         /* (?P<...>) named capture */
6870                     goto named_capture;
6871                 else if (paren == '>') {   /* (?P>name) named recursion */
6872                     goto named_recursion;
6873                 }
6874                 else if (paren == '=') {   /* (?P=...)  named backref */
6875                     /* this pretty much dupes the code for \k<NAME> in regatom(), if
6876                        you change this make sure you change that */
6877                     char* name_start = RExC_parse;
6878                     U32 num = 0;
6879                     SV *sv_dat = reg_scan_name(pRExC_state,
6880                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
6881                     if (RExC_parse == name_start || *RExC_parse != ')')
6882                         vFAIL2("Sequence %.3s... not terminated",parse_start);
6883
6884                     if (!SIZE_ONLY) {
6885                         num = add_data( pRExC_state, 1, "S" );
6886                         RExC_rxi->data->data[num]=(void*)sv_dat;
6887                         SvREFCNT_inc_simple_void(sv_dat);
6888                     }
6889                     RExC_sawback = 1;
6890                     ret = reganode(pRExC_state,
6891                                    ((! FOLD)
6892                                      ? NREF
6893                                      : (MORE_ASCII_RESTRICTED)
6894                                        ? NREFFA
6895                                        : (AT_LEAST_UNI_SEMANTICS)
6896                                          ? NREFFU
6897                                          : (LOC)
6898                                            ? NREFFL
6899                                            : NREFF),
6900                                     num);
6901                     *flagp |= HASWIDTH;
6902
6903                     Set_Node_Offset(ret, parse_start+1);
6904                     Set_Node_Cur_Length(ret); /* MJD */
6905
6906                     nextchar(pRExC_state);
6907                     return ret;
6908                 }
6909                 RExC_parse++;
6910                 vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
6911                 /*NOTREACHED*/
6912             case '<':           /* (?<...) */
6913                 if (*RExC_parse == '!')
6914                     paren = ',';
6915                 else if (*RExC_parse != '=') 
6916               named_capture:
6917                 {               /* (?<...>) */
6918                     char *name_start;
6919                     SV *svname;
6920                     paren= '>';
6921             case '\'':          /* (?'...') */
6922                     name_start= RExC_parse;
6923                     svname = reg_scan_name(pRExC_state,
6924                         SIZE_ONLY ?  /* reverse test from the others */
6925                         REG_RSN_RETURN_NAME : 
6926                         REG_RSN_RETURN_NULL);
6927                     if (RExC_parse == name_start) {
6928                         RExC_parse++;
6929                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
6930                         /*NOTREACHED*/
6931                     }
6932                     if (*RExC_parse != paren)
6933                         vFAIL2("Sequence (?%c... not terminated",
6934                             paren=='>' ? '<' : paren);
6935                     if (SIZE_ONLY) {
6936                         HE *he_str;
6937                         SV *sv_dat = NULL;
6938                         if (!svname) /* shouldn't happen */
6939                             Perl_croak(aTHX_
6940                                 "panic: reg_scan_name returned NULL");
6941                         if (!RExC_paren_names) {
6942                             RExC_paren_names= newHV();
6943                             sv_2mortal(MUTABLE_SV(RExC_paren_names));
6944 #ifdef DEBUGGING
6945                             RExC_paren_name_list= newAV();
6946                             sv_2mortal(MUTABLE_SV(RExC_paren_name_list));
6947 #endif
6948                         }
6949                         he_str = hv_fetch_ent( RExC_paren_names, svname, 1, 0 );
6950                         if ( he_str )
6951                             sv_dat = HeVAL(he_str);
6952                         if ( ! sv_dat ) {
6953                             /* croak baby croak */
6954                             Perl_croak(aTHX_
6955                                 "panic: paren_name hash element allocation failed");
6956                         } else if ( SvPOK(sv_dat) ) {
6957                             /* (?|...) can mean we have dupes so scan to check
6958                                its already been stored. Maybe a flag indicating
6959                                we are inside such a construct would be useful,
6960                                but the arrays are likely to be quite small, so
6961                                for now we punt -- dmq */
6962                             IV count = SvIV(sv_dat);
6963                             I32 *pv = (I32*)SvPVX(sv_dat);
6964                             IV i;
6965                             for ( i = 0 ; i < count ; i++ ) {
6966                                 if ( pv[i] == RExC_npar ) {
6967                                     count = 0;
6968                                     break;
6969                                 }
6970                             }
6971                             if ( count ) {
6972                                 pv = (I32*)SvGROW(sv_dat, SvCUR(sv_dat) + sizeof(I32)+1);
6973                                 SvCUR_set(sv_dat, SvCUR(sv_dat) + sizeof(I32));
6974                                 pv[count] = RExC_npar;
6975                                 SvIV_set(sv_dat, SvIVX(sv_dat) + 1);
6976                             }
6977                         } else {
6978                             (void)SvUPGRADE(sv_dat,SVt_PVNV);
6979                             sv_setpvn(sv_dat, (char *)&(RExC_npar), sizeof(I32));
6980                             SvIOK_on(sv_dat);
6981                             SvIV_set(sv_dat, 1);
6982                         }
6983 #ifdef DEBUGGING
6984                         /* Yes this does cause a memory leak in debugging Perls */
6985                         if (!av_store(RExC_paren_name_list, RExC_npar, SvREFCNT_inc(svname)))
6986                             SvREFCNT_dec(svname);
6987 #endif
6988
6989                         /*sv_dump(sv_dat);*/
6990                     }
6991                     nextchar(pRExC_state);
6992                     paren = 1;
6993                     goto capturing_parens;
6994                 }
6995                 RExC_seen |= REG_SEEN_LOOKBEHIND;
6996                 RExC_in_lookbehind++;
6997                 RExC_parse++;
6998             case '=':           /* (?=...) */
6999                 RExC_seen_zerolen++;
7000                 break;
7001             case '!':           /* (?!...) */
7002                 RExC_seen_zerolen++;
7003                 if (*RExC_parse == ')') {
7004                     ret=reg_node(pRExC_state, OPFAIL);
7005                     nextchar(pRExC_state);
7006                     return ret;
7007                 }
7008                 break;
7009             case '|':           /* (?|...) */
7010                 /* branch reset, behave like a (?:...) except that
7011                    buffers in alternations share the same numbers */
7012                 paren = ':'; 
7013                 after_freeze = freeze_paren = RExC_npar;
7014                 break;
7015             case ':':           /* (?:...) */
7016             case '>':           /* (?>...) */
7017                 break;
7018             case '$':           /* (?$...) */
7019             case '@':           /* (?@...) */
7020                 vFAIL2("Sequence (?%c...) not implemented", (int)paren);
7021                 break;
7022             case '#':           /* (?#...) */
7023                 while (*RExC_parse && *RExC_parse != ')')
7024                     RExC_parse++;
7025                 if (*RExC_parse != ')')
7026                     FAIL("Sequence (?#... not terminated");
7027                 nextchar(pRExC_state);
7028                 *flagp = TRYAGAIN;
7029                 return NULL;
7030             case '0' :           /* (?0) */
7031             case 'R' :           /* (?R) */
7032                 if (*RExC_parse != ')')
7033                     FAIL("Sequence (?R) not terminated");
7034                 ret = reg_node(pRExC_state, GOSTART);
7035                 *flagp |= POSTPONED;
7036                 nextchar(pRExC_state);
7037                 return ret;
7038                 /*notreached*/
7039             { /* named and numeric backreferences */
7040                 I32 num;
7041             case '&':            /* (?&NAME) */
7042                 parse_start = RExC_parse - 1;
7043               named_recursion:
7044                 {
7045                     SV *sv_dat = reg_scan_name(pRExC_state,
7046                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7047                      num = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
7048                 }
7049                 goto gen_recurse_regop;
7050                 /* NOT REACHED */
7051             case '+':
7052                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7053                     RExC_parse++;
7054                     vFAIL("Illegal pattern");
7055                 }
7056                 goto parse_recursion;
7057                 /* NOT REACHED*/
7058             case '-': /* (?-1) */
7059                 if (!(RExC_parse[0] >= '1' && RExC_parse[0] <= '9')) {
7060                     RExC_parse--; /* rewind to let it be handled later */
7061                     goto parse_flags;
7062                 } 
7063                 /*FALLTHROUGH */
7064             case '1': case '2': case '3': case '4': /* (?1) */
7065             case '5': case '6': case '7': case '8': case '9':
7066                 RExC_parse--;
7067               parse_recursion:
7068                 num = atoi(RExC_parse);
7069                 parse_start = RExC_parse - 1; /* MJD */
7070                 if (*RExC_parse == '-')
7071                     RExC_parse++;
7072                 while (isDIGIT(*RExC_parse))
7073                         RExC_parse++;
7074                 if (*RExC_parse!=')') 
7075                     vFAIL("Expecting close bracket");
7076                         
7077               gen_recurse_regop:
7078                 if ( paren == '-' ) {
7079                     /*
7080                     Diagram of capture buffer numbering.
7081                     Top line is the normal capture buffer numbers
7082                     Bottom line is the negative indexing as from
7083                     the X (the (?-2))
7084
7085                     +   1 2    3 4 5 X          6 7
7086                        /(a(x)y)(a(b(c(?-2)d)e)f)(g(h))/
7087                     -   5 4    3 2 1 X          x x
7088
7089                     */
7090                     num = RExC_npar + num;
7091                     if (num < 1)  {
7092                         RExC_parse++;
7093                         vFAIL("Reference to nonexistent group");
7094                     }
7095                 } else if ( paren == '+' ) {
7096                     num = RExC_npar + num - 1;
7097                 }
7098
7099                 ret = reganode(pRExC_state, GOSUB, num);
7100                 if (!SIZE_ONLY) {
7101                     if (num > (I32)RExC_rx->nparens) {
7102                         RExC_parse++;
7103                         vFAIL("Reference to nonexistent group");
7104                     }
7105                     ARG2L_SET( ret, RExC_recurse_count++);
7106                     RExC_emit++;
7107                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
7108                         "Recurse #%"UVuf" to %"IVdf"\n", (UV)ARG(ret), (IV)ARG2L(ret)));
7109                 } else {
7110                     RExC_size++;
7111                 }
7112                 RExC_seen |= REG_SEEN_RECURSE;
7113                 Set_Node_Length(ret, 1 + regarglen[OP(ret)]); /* MJD */
7114                 Set_Node_Offset(ret, parse_start); /* MJD */
7115
7116                 *flagp |= POSTPONED;
7117                 nextchar(pRExC_state);
7118                 return ret;
7119             } /* named and numeric backreferences */
7120             /* NOT REACHED */
7121
7122             case '?':           /* (??...) */
7123                 is_logical = 1;
7124                 if (*RExC_parse != '{') {
7125                     RExC_parse++;
7126                     vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7127                     /*NOTREACHED*/
7128                 }
7129                 *flagp |= POSTPONED;
7130                 paren = *RExC_parse++;
7131                 /* FALL THROUGH */
7132             case '{':           /* (?{...}) */
7133             {
7134                 I32 count = 1;
7135                 U32 n = 0;
7136                 char c;
7137                 char *s = RExC_parse;
7138
7139                 RExC_seen_zerolen++;
7140                 RExC_seen |= REG_SEEN_EVAL;
7141                 while (count && (c = *RExC_parse)) {
7142                     if (c == '\\') {
7143                         if (RExC_parse[1])
7144                             RExC_parse++;
7145                     }
7146                     else if (c == '{')
7147                         count++;
7148                     else if (c == '}')
7149                         count--;
7150                     RExC_parse++;
7151                 }
7152                 if (*RExC_parse != ')') {
7153                     RExC_parse = s;             
7154                     vFAIL("Sequence (?{...}) not terminated or not {}-balanced");
7155                 }
7156                 if (!SIZE_ONLY) {
7157                     PAD *pad;
7158                     OP_4tree *sop, *rop;
7159                     SV * const sv = newSVpvn(s, RExC_parse - 1 - s);
7160
7161                     ENTER;
7162                     Perl_save_re_context(aTHX);
7163                     rop = Perl_sv_compile_2op_is_broken(aTHX_ sv, &sop, "re", &pad);
7164                     sop->op_private |= OPpREFCOUNTED;
7165                     /* re_dup will OpREFCNT_inc */
7166                     OpREFCNT_set(sop, 1);
7167                     LEAVE;
7168
7169                     n = add_data(pRExC_state, 3, "nop");
7170                     RExC_rxi->data->data[n] = (void*)rop;
7171                     RExC_rxi->data->data[n+1] = (void*)sop;
7172                     RExC_rxi->data->data[n+2] = (void*)pad;
7173                     SvREFCNT_dec(sv);
7174                 }
7175                 else {                                          /* First pass */
7176                     if (PL_reginterp_cnt < ++RExC_seen_evals
7177                         && IN_PERL_RUNTIME)
7178                         /* No compiled RE interpolated, has runtime
7179                            components ===> unsafe.  */
7180                         FAIL("Eval-group not allowed at runtime, use re 'eval'");
7181                     if (PL_tainting && PL_tainted)
7182                         FAIL("Eval-group in insecure regular expression");
7183 #if PERL_VERSION > 8
7184                     if (IN_PERL_COMPILETIME)
7185                         PL_cv_has_eval = 1;
7186 #endif
7187                 }
7188
7189                 nextchar(pRExC_state);
7190                 if (is_logical) {
7191                     ret = reg_node(pRExC_state, LOGICAL);
7192                     if (!SIZE_ONLY)
7193                         ret->flags = 2;
7194                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, EVAL, n));
7195                     /* deal with the length of this later - MJD */
7196                     return ret;
7197                 }
7198                 ret = reganode(pRExC_state, EVAL, n);
7199                 Set_Node_Length(ret, RExC_parse - parse_start + 1);
7200                 Set_Node_Offset(ret, parse_start);
7201                 return ret;
7202             }
7203             case '(':           /* (?(?{...})...) and (?(?=...)...) */
7204             {
7205                 int is_define= 0;
7206                 if (RExC_parse[0] == '?') {        /* (?(?...)) */
7207                     if (RExC_parse[1] == '=' || RExC_parse[1] == '!'
7208                         || RExC_parse[1] == '<'
7209                         || RExC_parse[1] == '{') { /* Lookahead or eval. */
7210                         I32 flag;
7211                         
7212                         ret = reg_node(pRExC_state, LOGICAL);
7213                         if (!SIZE_ONLY)
7214                             ret->flags = 1;
7215                         REGTAIL(pRExC_state, ret, reg(pRExC_state, 1, &flag,depth+1));
7216                         goto insert_if;
7217                     }
7218                 }
7219                 else if ( RExC_parse[0] == '<'     /* (?(<NAME>)...) */
7220                          || RExC_parse[0] == '\'' ) /* (?('NAME')...) */
7221                 {
7222                     char ch = RExC_parse[0] == '<' ? '>' : '\'';
7223                     char *name_start= RExC_parse++;
7224                     U32 num = 0;
7225                     SV *sv_dat=reg_scan_name(pRExC_state,
7226                         SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7227                     if (RExC_parse == name_start || *RExC_parse != ch)
7228                         vFAIL2("Sequence (?(%c... not terminated",
7229                             (ch == '>' ? '<' : ch));
7230                     RExC_parse++;
7231                     if (!SIZE_ONLY) {
7232                         num = add_data( pRExC_state, 1, "S" );
7233                         RExC_rxi->data->data[num]=(void*)sv_dat;
7234                         SvREFCNT_inc_simple_void(sv_dat);
7235                     }
7236                     ret = reganode(pRExC_state,NGROUPP,num);
7237                     goto insert_if_check_paren;
7238                 }
7239                 else if (RExC_parse[0] == 'D' &&
7240                          RExC_parse[1] == 'E' &&
7241                          RExC_parse[2] == 'F' &&
7242                          RExC_parse[3] == 'I' &&
7243                          RExC_parse[4] == 'N' &&
7244                          RExC_parse[5] == 'E')
7245                 {
7246                     ret = reganode(pRExC_state,DEFINEP,0);
7247                     RExC_parse +=6 ;
7248                     is_define = 1;
7249                     goto insert_if_check_paren;
7250                 }
7251                 else if (RExC_parse[0] == 'R') {
7252                     RExC_parse++;
7253                     parno = 0;
7254                     if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
7255                         parno = atoi(RExC_parse++);
7256                         while (isDIGIT(*RExC_parse))
7257                             RExC_parse++;
7258                     } else if (RExC_parse[0] == '&') {
7259                         SV *sv_dat;
7260                         RExC_parse++;
7261                         sv_dat = reg_scan_name(pRExC_state,
7262                             SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
7263                         parno = sv_dat ? *((I32 *)SvPVX(sv_dat)) : 0;
7264                     }
7265                     ret = reganode(pRExC_state,INSUBP,parno); 
7266                     goto insert_if_check_paren;
7267                 }
7268                 else if (RExC_parse[0] >= '1' && RExC_parse[0] <= '9' ) {
7269                     /* (?(1)...) */
7270                     char c;
7271                     parno = atoi(RExC_parse++);
7272
7273                     while (isDIGIT(*RExC_parse))
7274                         RExC_parse++;
7275                     ret = reganode(pRExC_state, GROUPP, parno);
7276
7277                  insert_if_check_paren:
7278                     if ((c = *nextchar(pRExC_state)) != ')')
7279                         vFAIL("Switch condition not recognized");
7280                   insert_if:
7281                     REGTAIL(pRExC_state, ret, reganode(pRExC_state, IFTHEN, 0));
7282                     br = regbranch(pRExC_state, &flags, 1,depth+1);
7283                     if (br == NULL)
7284                         br = reganode(pRExC_state, LONGJMP, 0);
7285                     else
7286                         REGTAIL(pRExC_state, br, reganode(pRExC_state, LONGJMP, 0));
7287                     c = *nextchar(pRExC_state);
7288                     if (flags&HASWIDTH)
7289                         *flagp |= HASWIDTH;
7290                     if (c == '|') {
7291                         if (is_define) 
7292                             vFAIL("(?(DEFINE)....) does not allow branches");
7293                         lastbr = reganode(pRExC_state, IFTHEN, 0); /* Fake one for optimizer. */
7294                         regbranch(pRExC_state, &flags, 1,depth+1);
7295                         REGTAIL(pRExC_state, ret, lastbr);
7296                         if (flags&HASWIDTH)
7297                             *flagp |= HASWIDTH;
7298                         c = *nextchar(pRExC_state);
7299                     }
7300                     else
7301                         lastbr = NULL;
7302                     if (c != ')')
7303                         vFAIL("Switch (?(condition)... contains too many branches");
7304                     ender = reg_node(pRExC_state, TAIL);
7305                     REGTAIL(pRExC_state, br, ender);
7306                     if (lastbr) {
7307                         REGTAIL(pRExC_state, lastbr, ender);
7308                         REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender);
7309                     }
7310                     else
7311                         REGTAIL(pRExC_state, ret, ender);
7312                     RExC_size++; /* XXX WHY do we need this?!!
7313                                     For large programs it seems to be required
7314                                     but I can't figure out why. -- dmq*/
7315                     return ret;
7316                 }
7317                 else {
7318                     vFAIL2("Unknown switch condition (?(%.2s", RExC_parse);
7319                 }
7320             }
7321             case 0:
7322                 RExC_parse--; /* for vFAIL to print correctly */
7323                 vFAIL("Sequence (? incomplete");
7324                 break;
7325             case DEFAULT_PAT_MOD:   /* Use default flags with the exceptions
7326                                        that follow */
7327                 has_use_defaults = TRUE;
7328                 STD_PMMOD_FLAGS_CLEAR(&RExC_flags);
7329                 set_regex_charset(&RExC_flags, (RExC_utf8 || RExC_uni_semantics)
7330                                                 ? REGEX_UNICODE_CHARSET
7331                                                 : REGEX_DEPENDS_CHARSET);
7332                 goto parse_flags;
7333             default:
7334                 --RExC_parse;
7335                 parse_flags:      /* (?i) */  
7336             {
7337                 U32 posflags = 0, negflags = 0;
7338                 U32 *flagsp = &posflags;
7339                 char has_charset_modifier = '\0';
7340                 regex_charset cs = (RExC_utf8 || RExC_uni_semantics)
7341                                     ? REGEX_UNICODE_CHARSET
7342                                     : REGEX_DEPENDS_CHARSET;
7343
7344                 while (*RExC_parse) {
7345                     /* && strchr("iogcmsx", *RExC_parse) */
7346                     /* (?g), (?gc) and (?o) are useless here
7347                        and must be globally applied -- japhy */
7348                     switch (*RExC_parse) {
7349                     CASE_STD_PMMOD_FLAGS_PARSE_SET(flagsp);
7350                     case LOCALE_PAT_MOD:
7351                         if (has_charset_modifier) {
7352                             goto excess_modifier;
7353                         }
7354                         else if (flagsp == &negflags) {
7355                             goto neg_modifier;
7356                         }
7357                         cs = REGEX_LOCALE_CHARSET;
7358                         has_charset_modifier = LOCALE_PAT_MOD;
7359                         RExC_contains_locale = 1;
7360                         break;
7361                     case UNICODE_PAT_MOD:
7362                         if (has_charset_modifier) {
7363                             goto excess_modifier;
7364                         }
7365                         else if (flagsp == &negflags) {
7366                             goto neg_modifier;
7367                         }
7368                         cs = REGEX_UNICODE_CHARSET;
7369                         has_charset_modifier = UNICODE_PAT_MOD;
7370                         break;
7371                     case ASCII_RESTRICT_PAT_MOD:
7372                         if (flagsp == &negflags) {
7373                             goto neg_modifier;
7374                         }
7375                         if (has_charset_modifier) {
7376                             if (cs != REGEX_ASCII_RESTRICTED_CHARSET) {
7377                                 goto excess_modifier;
7378                             }
7379                             /* Doubled modifier implies more restricted */
7380                             cs = REGEX_ASCII_MORE_RESTRICTED_CHARSET;
7381                         }
7382                         else {
7383                             cs = REGEX_ASCII_RESTRICTED_CHARSET;
7384                         }
7385                         has_charset_modifier = ASCII_RESTRICT_PAT_MOD;
7386                         break;
7387                     case DEPENDS_PAT_MOD:
7388                         if (has_use_defaults) {
7389                             goto fail_modifiers;
7390                         }
7391                         else if (flagsp == &negflags) {
7392                             goto neg_modifier;
7393                         }
7394                         else if (has_charset_modifier) {
7395                             goto excess_modifier;
7396                         }
7397
7398                         /* The dual charset means unicode semantics if the
7399                          * pattern (or target, not known until runtime) are
7400                          * utf8, or something in the pattern indicates unicode
7401                          * semantics */
7402                         cs = (RExC_utf8 || RExC_uni_semantics)
7403                              ? REGEX_UNICODE_CHARSET
7404                              : REGEX_DEPENDS_CHARSET;
7405                         has_charset_modifier = DEPENDS_PAT_MOD;
7406                         break;
7407                     excess_modifier:
7408                         RExC_parse++;
7409                         if (has_charset_modifier == ASCII_RESTRICT_PAT_MOD) {
7410                             vFAIL2("Regexp modifier \"%c\" may appear a maximum of twice", ASCII_RESTRICT_PAT_MOD);
7411                         }
7412                         else if (has_charset_modifier == *(RExC_parse - 1)) {
7413                             vFAIL2("Regexp modifier \"%c\" may not appear twice", *(RExC_parse - 1));
7414                         }
7415                         else {
7416                             vFAIL3("Regexp modifiers \"%c\" and \"%c\" are mutually exclusive", has_charset_modifier, *(RExC_parse - 1));
7417                         }
7418                         /*NOTREACHED*/
7419                     neg_modifier:
7420                         RExC_parse++;
7421                         vFAIL2("Regexp modifier \"%c\" may not appear after the \"-\"", *(RExC_parse - 1));
7422                         /*NOTREACHED*/
7423                     case ONCE_PAT_MOD: /* 'o' */
7424                     case GLOBAL_PAT_MOD: /* 'g' */
7425                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
7426                             const I32 wflagbit = *RExC_parse == 'o' ? WASTED_O : WASTED_G;
7427                             if (! (wastedflags & wflagbit) ) {
7428                                 wastedflags |= wflagbit;
7429                                 vWARN5(
7430                                     RExC_parse + 1,
7431                                     "Useless (%s%c) - %suse /%c modifier",
7432                                     flagsp == &negflags ? "?-" : "?",
7433                                     *RExC_parse,
7434                                     flagsp == &negflags ? "don't " : "",
7435                                     *RExC_parse
7436                                 );
7437                             }
7438                         }
7439                         break;
7440                         
7441                     case CONTINUE_PAT_MOD: /* 'c' */
7442                         if (SIZE_ONLY && ckWARN(WARN_REGEXP)) {
7443                             if (! (wastedflags & WASTED_C) ) {
7444                                 wastedflags |= WASTED_GC;
7445                                 vWARN3(
7446                                     RExC_parse + 1,
7447                                     "Useless (%sc) - %suse /gc modifier",
7448                                     flagsp == &negflags ? "?-" : "?",
7449                                     flagsp == &negflags ? "don't " : ""
7450                                 );
7451                             }
7452                         }
7453                         break;
7454                     case KEEPCOPY_PAT_MOD: /* 'p' */
7455                         if (flagsp == &negflags) {
7456                             if (SIZE_ONLY)
7457                                 ckWARNreg(RExC_parse + 1,"Useless use of (?-p)");
7458                         } else {
7459                             *flagsp |= RXf_PMf_KEEPCOPY;
7460                         }
7461                         break;
7462                     case '-':
7463                         /* A flag is a default iff it is following a minus, so
7464                          * if there is a minus, it means will be trying to
7465                          * re-specify a default which is an error */
7466                         if (has_use_defaults || flagsp == &negflags) {
7467             fail_modifiers:
7468                             RExC_parse++;
7469                             vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7470                             /*NOTREACHED*/
7471                         }
7472                         flagsp = &negflags;
7473                         wastedflags = 0;  /* reset so (?g-c) warns twice */
7474                         break;
7475                     case ':':
7476                         paren = ':';
7477                         /*FALLTHROUGH*/
7478                     case ')':
7479                         RExC_flags |= posflags;
7480                         RExC_flags &= ~negflags;
7481                         set_regex_charset(&RExC_flags, cs);
7482                         if (paren != ':') {
7483                             oregflags |= posflags;
7484                             oregflags &= ~negflags;
7485                             set_regex_charset(&oregflags, cs);
7486                         }
7487                         nextchar(pRExC_state);
7488                         if (paren != ':') {
7489                             *flagp = TRYAGAIN;
7490                             return NULL;
7491                         } else {
7492                             ret = NULL;
7493                             goto parse_rest;
7494                         }
7495                         /*NOTREACHED*/
7496                     default:
7497                         RExC_parse++;
7498                         vFAIL3("Sequence (%.*s...) not recognized", RExC_parse-seqstart, seqstart);
7499                         /*NOTREACHED*/
7500                     }                           
7501                     ++RExC_parse;
7502                 }
7503             }} /* one for the default block, one for the switch */
7504         }
7505         else {                  /* (...) */
7506           capturing_parens:
7507             parno = RExC_npar;
7508             RExC_npar++;
7509             
7510             ret = reganode(pRExC_state, OPEN, parno);
7511             if (!SIZE_ONLY ){
7512                 if (!RExC_nestroot) 
7513                     RExC_nestroot = parno;
7514                 if (RExC_seen & REG_SEEN_RECURSE
7515                     && !RExC_open_parens[parno-1])
7516                 {
7517                     DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
7518                         "Setting open paren #%"IVdf" to %d\n", 
7519                         (IV)parno, REG_NODE_NUM(ret)));
7520                     RExC_open_parens[parno-1]= ret;
7521                 }
7522             }
7523             Set_Node_Length(ret, 1); /* MJD */
7524             Set_Node_Offset(ret, RExC_parse); /* MJD */
7525             is_open = 1;
7526         }
7527     }
7528     else                        /* ! paren */
7529         ret = NULL;
7530    
7531    parse_rest:
7532     /* Pick up the branches, linking them together. */
7533     parse_start = RExC_parse;   /* MJD */
7534     br = regbranch(pRExC_state, &flags, 1,depth+1);
7535
7536     /*     branch_len = (paren != 0); */
7537
7538     if (br == NULL)
7539         return(NULL);
7540     if (*RExC_parse == '|') {
7541         if (!SIZE_ONLY && RExC_extralen) {
7542             reginsert(pRExC_state, BRANCHJ, br, depth+1);
7543         }
7544         else {                  /* MJD */
7545             reginsert(pRExC_state, BRANCH, br, depth+1);
7546             Set_Node_Length(br, paren != 0);
7547             Set_Node_Offset_To_R(br-RExC_emit_start, parse_start-RExC_start);
7548         }
7549         have_branch = 1;
7550         if (SIZE_ONLY)
7551             RExC_extralen += 1;         /* For BRANCHJ-BRANCH. */
7552     }
7553     else if (paren == ':') {
7554         *flagp |= flags&SIMPLE;
7555     }
7556     if (is_open) {                              /* Starts with OPEN. */
7557         REGTAIL(pRExC_state, ret, br);          /* OPEN -> first. */
7558     }
7559     else if (paren != '?')              /* Not Conditional */
7560         ret = br;
7561     *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
7562     lastbr = br;
7563     while (*RExC_parse == '|') {
7564         if (!SIZE_ONLY && RExC_extralen) {
7565             ender = reganode(pRExC_state, LONGJMP,0);
7566             REGTAIL(pRExC_state, NEXTOPER(NEXTOPER(lastbr)), ender); /* Append to the previous. */
7567         }
7568         if (SIZE_ONLY)
7569             RExC_extralen += 2;         /* Account for LONGJMP. */
7570         nextchar(pRExC_state);
7571         if (freeze_paren) {
7572             if (RExC_npar > after_freeze)
7573                 after_freeze = RExC_npar;
7574             RExC_npar = freeze_paren;       
7575         }
7576         br = regbranch(pRExC_state, &flags, 0, depth+1);
7577
7578         if (br == NULL)
7579             return(NULL);
7580         REGTAIL(pRExC_state, lastbr, br);               /* BRANCH -> BRANCH. */
7581         lastbr = br;
7582         *flagp |= flags & (SPSTART | HASWIDTH | POSTPONED);
7583     }
7584
7585     if (have_branch || paren != ':') {
7586         /* Make a closing node, and hook it on the end. */
7587         switch (paren) {
7588         case ':':
7589             ender = reg_node(pRExC_state, TAIL);
7590             break;
7591         case 1:
7592             ender = reganode(pRExC_state, CLOSE, parno);
7593             if (!SIZE_ONLY && RExC_seen & REG_SEEN_RECURSE) {
7594                 DEBUG_OPTIMISE_MORE_r(PerlIO_printf(Perl_debug_log,
7595                         "Setting close paren #%"IVdf" to %d\n", 
7596                         (IV)parno, REG_NODE_NUM(ender)));
7597                 RExC_close_parens[parno-1]= ender;
7598                 if (RExC_nestroot == parno) 
7599                     RExC_nestroot = 0;
7600             }       
7601             Set_Node_Offset(ender,RExC_parse+1); /* MJD */
7602             Set_Node_Length(ender,1); /* MJD */
7603             break;
7604         case '<':
7605         case ',':
7606         case '=':
7607         case '!':
7608             *flagp &= ~HASWIDTH;
7609             /* FALL THROUGH */
7610         case '>':
7611             ender = reg_node(pRExC_state, SUCCEED);
7612             break;
7613         case 0:
7614             ender = reg_node(pRExC_state, END);
7615             if (!SIZE_ONLY) {
7616                 assert(!RExC_opend); /* there can only be one! */
7617                 RExC_opend = ender;
7618             }
7619             break;
7620         }
7621         REGTAIL(pRExC_state, lastbr, ender);
7622
7623         if (have_branch && !SIZE_ONLY) {
7624             if (depth==1)
7625                 RExC_seen |= REG_TOP_LEVEL_BRANCHES;
7626
7627             /* Hook the tails of the branches to the closing node. */
7628             for (br = ret; br; br = regnext(br)) {
7629                 const U8 op = PL_regkind[OP(br)];
7630                 if (op == BRANCH) {
7631                     REGTAIL_STUDY(pRExC_state, NEXTOPER(br), ender);
7632                 }
7633                 else if (op == BRANCHJ) {
7634                     REGTAIL_STUDY(pRExC_state, NEXTOPER(NEXTOPER(br)), ender);
7635                 }
7636             }
7637         }
7638     }
7639
7640     {
7641         const char *p;
7642         static const char parens[] = "=!<,>";
7643
7644         if (paren && (p = strchr(parens, paren))) {
7645             U8 node = ((p - parens) % 2) ? UNLESSM : IFMATCH;
7646             int flag = (p - parens) > 1;
7647
7648             if (paren == '>')
7649                 node = SUSPEND, flag = 0;
7650             reginsert(pRExC_state, node,ret, depth+1);
7651             Set_Node_Cur_Length(ret);
7652             Set_Node_Offset(ret, parse_start + 1);
7653             ret->flags = flag;
7654             REGTAIL_STUDY(pRExC_state, ret, reg_node(pRExC_state, TAIL));
7655         }
7656     }
7657
7658     /* Check for proper termination. */
7659     if (paren) {
7660         RExC_flags = oregflags;
7661         if (RExC_parse >= RExC_end || *nextchar(pRExC_state) != ')') {
7662             RExC_parse = oregcomp_parse;
7663             vFAIL("Unmatched (");
7664         }
7665     }
7666     else if (!paren && RExC_parse < RExC_end) {
7667         if (*RExC_parse == ')') {
7668             RExC_parse++;
7669             vFAIL("Unmatched )");
7670         }
7671         else
7672             FAIL("Junk on end of regexp");      /* "Can't happen". */
7673         /* NOTREACHED */
7674     }
7675
7676     if (RExC_in_lookbehind) {
7677         RExC_in_lookbehind--;
7678     }
7679     if (after_freeze > RExC_npar)
7680         RExC_npar = after_freeze;
7681     return(ret);
7682 }
7683
7684 /*
7685  - regbranch - one alternative of an | operator
7686  *
7687  * Implements the concatenation operator.
7688  */
7689 STATIC regnode *
7690 S_regbranch(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, I32 first, U32 depth)
7691 {
7692     dVAR;
7693     register regnode *ret;
7694     register regnode *chain = NULL;
7695     register regnode *latest;
7696     I32 flags = 0, c = 0;
7697     GET_RE_DEBUG_FLAGS_DECL;
7698
7699     PERL_ARGS_ASSERT_REGBRANCH;
7700
7701     DEBUG_PARSE("brnc");
7702
7703     if (first)
7704         ret = NULL;
7705     else {
7706         if (!SIZE_ONLY && RExC_extralen)
7707             ret = reganode(pRExC_state, BRANCHJ,0);
7708         else {
7709             ret = reg_node(pRExC_state, BRANCH);
7710             Set_Node_Length(ret, 1);
7711         }
7712     }
7713         
7714     if (!first && SIZE_ONLY)
7715         RExC_extralen += 1;                     /* BRANCHJ */
7716
7717     *flagp = WORST;                     /* Tentatively. */
7718
7719     RExC_parse--;
7720     nextchar(pRExC_state);
7721     while (RExC_parse < RExC_end && *RExC_parse != '|' && *RExC_parse != ')') {
7722         flags &= ~TRYAGAIN;
7723         latest = regpiece(pRExC_state, &flags,depth+1);
7724         if (latest == NULL) {
7725             if (flags & TRYAGAIN)
7726                 continue;
7727             return(NULL);
7728         }
7729         else if (ret == NULL)
7730             ret = latest;
7731         *flagp |= flags&(HASWIDTH|POSTPONED);
7732         if (chain == NULL)      /* First piece. */
7733             *flagp |= flags&SPSTART;
7734         else {
7735             RExC_naughty++;
7736             REGTAIL(pRExC_state, chain, latest);
7737         }
7738         chain = latest;
7739         c++;
7740     }
7741     if (chain == NULL) {        /* Loop ran zero times. */
7742         chain = reg_node(pRExC_state, NOTHING);
7743         if (ret == NULL)
7744             ret = chain;
7745     }
7746     if (c == 1) {
7747         *flagp |= flags&SIMPLE;
7748     }
7749
7750     return ret;
7751 }
7752
7753 /*
7754  - regpiece - something followed by possible [*+?]
7755  *
7756  * Note that the branching code sequences used for ? and the general cases
7757  * of * and + are somewhat optimized:  they use the same NOTHING node as
7758  * both the endmarker for their branch list and the body of the last branch.
7759  * It might seem that this node could be dispensed with entirely, but the
7760  * endmarker role is not redundant.
7761  */
7762 STATIC regnode *
7763 S_regpiece(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
7764 {
7765     dVAR;
7766     register regnode *ret;
7767     register char op;
7768     register char *next;
7769     I32 flags;
7770     const char * const origparse = RExC_parse;
7771     I32 min;
7772     I32 max = REG_INFTY;
7773 #ifdef RE_TRACK_PATTERN_OFFSETS
7774     char *parse_start;
7775 #endif
7776     const char *maxpos = NULL;
7777     GET_RE_DEBUG_FLAGS_DECL;
7778
7779     PERL_ARGS_ASSERT_REGPIECE;
7780
7781     DEBUG_PARSE("piec");
7782
7783     ret = regatom(pRExC_state, &flags,depth+1);
7784     if (ret == NULL) {
7785         if (flags & TRYAGAIN)
7786             *flagp |= TRYAGAIN;
7787         return(NULL);
7788     }
7789
7790     op = *RExC_parse;
7791
7792     if (op == '{' && regcurly(RExC_parse)) {
7793         maxpos = NULL;
7794 #ifdef RE_TRACK_PATTERN_OFFSETS
7795         parse_start = RExC_parse; /* MJD */
7796 #endif
7797         next = RExC_parse + 1;
7798         while (isDIGIT(*next) || *next == ',') {
7799             if (*next == ',') {
7800                 if (maxpos)
7801                     break;
7802                 else
7803                     maxpos = next;
7804             }
7805             next++;
7806         }
7807         if (*next == '}') {             /* got one */
7808             if (!maxpos)
7809                 maxpos = next;
7810             RExC_parse++;
7811             min = atoi(RExC_parse);
7812             if (*maxpos == ',')
7813                 maxpos++;
7814             else
7815                 maxpos = RExC_parse;
7816             max = atoi(maxpos);
7817             if (!max && *maxpos != '0')
7818                 max = REG_INFTY;                /* meaning "infinity" */
7819             else if (max >= REG_INFTY)
7820                 vFAIL2("Quantifier in {,} bigger than %d", REG_INFTY - 1);
7821             RExC_parse = next;
7822             nextchar(pRExC_state);
7823
7824         do_curly:
7825             if ((flags&SIMPLE)) {
7826                 RExC_naughty += 2 + RExC_naughty / 2;
7827                 reginsert(pRExC_state, CURLY, ret, depth+1);
7828                 Set_Node_Offset(ret, parse_start+1); /* MJD */
7829                 Set_Node_Cur_Length(ret);
7830             }
7831             else {
7832                 regnode * const w = reg_node(pRExC_state, WHILEM);
7833
7834                 w->flags = 0;
7835                 REGTAIL(pRExC_state, ret, w);
7836                 if (!SIZE_ONLY && RExC_extralen) {
7837                     reginsert(pRExC_state, LONGJMP,ret, depth+1);
7838                     reginsert(pRExC_state, NOTHING,ret, depth+1);
7839                     NEXT_OFF(ret) = 3;  /* Go over LONGJMP. */
7840                 }
7841                 reginsert(pRExC_state, CURLYX,ret, depth+1);
7842                                 /* MJD hk */
7843                 Set_Node_Offset(ret, parse_start+1);
7844                 Set_Node_Length(ret,
7845                                 op == '{' ? (RExC_parse - parse_start) : 1);
7846
7847                 if (!SIZE_ONLY && RExC_extralen)
7848                     NEXT_OFF(ret) = 3;  /* Go over NOTHING to LONGJMP. */
7849                 REGTAIL(pRExC_state, ret, reg_node(pRExC_state, NOTHING));
7850                 if (SIZE_ONLY)
7851                     RExC_whilem_seen++, RExC_extralen += 3;
7852                 RExC_naughty += 4 + RExC_naughty;       /* compound interest */
7853             }
7854             ret->flags = 0;
7855
7856             if (min > 0)
7857                 *flagp = WORST;
7858             if (max > 0)
7859                 *flagp |= HASWIDTH;
7860             if (max < min)
7861                 vFAIL("Can't do {n,m} with n > m");
7862             if (!SIZE_ONLY) {
7863                 ARG1_SET(ret, (U16)min);
7864                 ARG2_SET(ret, (U16)max);
7865             }
7866
7867             goto nest_check;
7868         }
7869     }
7870
7871     if (!ISMULT1(op)) {
7872         *flagp = flags;
7873         return(ret);
7874     }
7875
7876 #if 0                           /* Now runtime fix should be reliable. */
7877
7878     /* if this is reinstated, don't forget to put this back into perldiag:
7879
7880             =item Regexp *+ operand could be empty at {#} in regex m/%s/
7881
7882            (F) The part of the regexp subject to either the * or + quantifier
7883            could match an empty string. The {#} shows in the regular
7884            expression about where the problem was discovered.
7885
7886     */
7887
7888     if (!(flags&HASWIDTH) && op != '?')
7889       vFAIL("Regexp *+ operand could be empty");
7890 #endif
7891
7892 #ifdef RE_TRACK_PATTERN_OFFSETS
7893     parse_start = RExC_parse;
7894 #endif
7895     nextchar(pRExC_state);
7896
7897     *flagp = (op != '+') ? (WORST|SPSTART|HASWIDTH) : (WORST|HASWIDTH);
7898
7899     if (op == '*' && (flags&SIMPLE)) {
7900         reginsert(pRExC_state, STAR, ret, depth+1);
7901         ret->flags = 0;
7902         RExC_naughty += 4;
7903     }
7904     else if (op == '*') {
7905         min = 0;
7906         goto do_curly;
7907     }
7908     else if (op == '+' && (flags&SIMPLE)) {
7909         reginsert(pRExC_state, PLUS, ret, depth+1);
7910         ret->flags = 0;
7911         RExC_naughty += 3;
7912     }
7913     else if (op == '+') {
7914         min = 1;
7915         goto do_curly;
7916     }
7917     else if (op == '?') {
7918         min = 0; max = 1;
7919         goto do_curly;
7920     }
7921   nest_check:
7922     if (!SIZE_ONLY && !(flags&(HASWIDTH|POSTPONED)) && max > REG_INFTY/3) {
7923         ckWARN3reg(RExC_parse,
7924                    "%.*s matches null string many times",
7925                    (int)(RExC_parse >= origparse ? RExC_parse - origparse : 0),
7926                    origparse);
7927     }
7928
7929     if (RExC_parse < RExC_end && *RExC_parse == '?') {
7930         nextchar(pRExC_state);
7931         reginsert(pRExC_state, MINMOD, ret, depth+1);
7932         REGTAIL(pRExC_state, ret, ret + NODE_STEP_REGNODE);
7933     }
7934 #ifndef REG_ALLOW_MINMOD_SUSPEND
7935     else
7936 #endif
7937     if (RExC_parse < RExC_end && *RExC_parse == '+') {
7938         regnode *ender;
7939         nextchar(pRExC_state);
7940         ender = reg_node(pRExC_state, SUCCEED);
7941         REGTAIL(pRExC_state, ret, ender);
7942         reginsert(pRExC_state, SUSPEND, ret, depth+1);
7943         ret->flags = 0;
7944         ender = reg_node(pRExC_state, TAIL);
7945         REGTAIL(pRExC_state, ret, ender);
7946         /*ret= ender;*/
7947     }
7948
7949     if (RExC_parse < RExC_end && ISMULT2(RExC_parse)) {
7950         RExC_parse++;
7951         vFAIL("Nested quantifiers");
7952     }
7953
7954     return(ret);
7955 }
7956
7957
7958 /* reg_namedseq(pRExC_state,UVp, UV depth)
7959    
7960    This is expected to be called by a parser routine that has 
7961    recognized '\N' and needs to handle the rest. RExC_parse is
7962    expected to point at the first char following the N at the time
7963    of the call.
7964
7965    The \N may be inside (indicated by valuep not being NULL) or outside a
7966    character class.
7967
7968    \N may begin either a named sequence, or if outside a character class, mean
7969    to match a non-newline.  For non single-quoted regexes, the tokenizer has
7970    attempted to decide which, and in the case of a named sequence converted it
7971    into one of the forms: \N{} (if the sequence is null), or \N{U+c1.c2...},
7972    where c1... are the characters in the sequence.  For single-quoted regexes,
7973    the tokenizer passes the \N sequence through unchanged; this code will not
7974    attempt to determine this nor expand those.  The net effect is that if the
7975    beginning of the passed-in pattern isn't '{U+' or there is no '}', it
7976    signals that this \N occurrence means to match a non-newline.
7977    
7978    Only the \N{U+...} form should occur in a character class, for the same
7979    reason that '.' inside a character class means to just match a period: it
7980    just doesn't make sense.
7981    
7982    If valuep is non-null then it is assumed that we are parsing inside 
7983    of a charclass definition and the first codepoint in the resolved
7984    string is returned via *valuep and the routine will return NULL. 
7985    In this mode if a multichar string is returned from the charnames 
7986    handler, a warning will be issued, and only the first char in the 
7987    sequence will be examined. If the string returned is zero length
7988    then the value of *valuep is undefined and NON-NULL will 
7989    be returned to indicate failure. (This will NOT be a valid pointer 
7990    to a regnode.)
7991    
7992    If valuep is null then it is assumed that we are parsing normal text and a
7993    new EXACT node is inserted into the program containing the resolved string,
7994    and a pointer to the new node is returned.  But if the string is zero length
7995    a NOTHING node is emitted instead.
7996
7997    On success RExC_parse is set to the char following the endbrace.
7998    Parsing failures will generate a fatal error via vFAIL(...)
7999  */
8000 STATIC regnode *
8001 S_reg_namedseq(pTHX_ RExC_state_t *pRExC_state, UV *valuep, I32 *flagp, U32 depth)
8002 {
8003     char * endbrace;    /* '}' following the name */
8004     regnode *ret = NULL;
8005     char* p;
8006
8007     GET_RE_DEBUG_FLAGS_DECL;
8008  
8009     PERL_ARGS_ASSERT_REG_NAMEDSEQ;
8010
8011     GET_RE_DEBUG_FLAGS;
8012
8013     /* The [^\n] meaning of \N ignores spaces and comments under the /x
8014      * modifier.  The other meaning does not */
8015     p = (RExC_flags & RXf_PMf_EXTENDED)
8016         ? regwhite( pRExC_state, RExC_parse )
8017         : RExC_parse;
8018    
8019     /* Disambiguate between \N meaning a named character versus \N meaning
8020      * [^\n].  The former is assumed when it can't be the latter. */
8021     if (*p != '{' || regcurly(p)) {
8022         RExC_parse = p;
8023         if (valuep) {
8024             /* no bare \N in a charclass */
8025             vFAIL("\\N in a character class must be a named character: \\N{...}");
8026         }
8027         nextchar(pRExC_state);
8028         ret = reg_node(pRExC_state, REG_ANY);
8029         *flagp |= HASWIDTH|SIMPLE;
8030         RExC_naughty++;
8031         RExC_parse--;
8032         Set_Node_Length(ret, 1); /* MJD */
8033         return ret;
8034     }
8035
8036     /* Here, we have decided it should be a named sequence */
8037
8038     /* The test above made sure that the next real character is a '{', but
8039      * under the /x modifier, it could be separated by space (or a comment and
8040      * \n) and this is not allowed (for consistency with \x{...} and the
8041      * tokenizer handling of \N{NAME}). */
8042     if (*RExC_parse != '{') {
8043         vFAIL("Missing braces on \\N{}");
8044     }
8045
8046     RExC_parse++;       /* Skip past the '{' */
8047
8048     if (! (endbrace = strchr(RExC_parse, '}')) /* no trailing brace */
8049         || ! (endbrace == RExC_parse            /* nothing between the {} */
8050               || (endbrace - RExC_parse >= 2    /* U+ (bad hex is checked below */
8051                   && strnEQ(RExC_parse, "U+", 2)))) /* for a better error msg) */
8052     {
8053         if (endbrace) RExC_parse = endbrace;    /* position msg's '<--HERE' */
8054         vFAIL("\\N{NAME} must be resolved by the lexer");
8055     }
8056
8057     if (endbrace == RExC_parse) {   /* empty: \N{} */
8058         if (! valuep) {
8059             RExC_parse = endbrace + 1;  
8060             return reg_node(pRExC_state,NOTHING);
8061         }
8062
8063         if (SIZE_ONLY) {
8064             ckWARNreg(RExC_parse,
8065                     "Ignoring zero length \\N{} in character class"
8066             );
8067             RExC_parse = endbrace + 1;  
8068         }
8069         *valuep = 0;
8070         return (regnode *) &RExC_parse; /* Invalid regnode pointer */
8071     }
8072
8073     REQUIRE_UTF8;       /* named sequences imply Unicode semantics */
8074     RExC_parse += 2;    /* Skip past the 'U+' */
8075
8076     if (valuep) {   /* In a bracketed char class */
8077         /* We only pay attention to the first char of 
8078         multichar strings being returned. I kinda wonder
8079         if this makes sense as it does change the behaviour
8080         from earlier versions, OTOH that behaviour was broken
8081         as well. XXX Solution is to recharacterize as
8082         [rest-of-class]|multi1|multi2... */
8083
8084         STRLEN length_of_hex;
8085         I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
8086             | PERL_SCAN_DISALLOW_PREFIX
8087             | (SIZE_ONLY ? PERL_SCAN_SILENT_ILLDIGIT : 0);
8088     
8089         char * endchar = RExC_parse + strcspn(RExC_parse, ".}");
8090         if (endchar < endbrace) {
8091             ckWARNreg(endchar, "Using just the first character returned by \\N{} in character class");
8092         }
8093
8094         length_of_hex = (STRLEN)(endchar - RExC_parse);
8095         *valuep = grok_hex(RExC_parse, &length_of_hex, &flags, NULL);
8096
8097         /* The tokenizer should have guaranteed validity, but it's possible to
8098          * bypass it by using single quoting, so check */
8099         if (length_of_hex == 0
8100             || length_of_hex != (STRLEN)(endchar - RExC_parse) )
8101         {
8102             RExC_parse += length_of_hex;        /* Includes all the valid */
8103             RExC_parse += (RExC_orig_utf8)      /* point to after 1st invalid */
8104                             ? UTF8SKIP(RExC_parse)
8105                             : 1;
8106             /* Guard against malformed utf8 */
8107             if (RExC_parse >= endchar) RExC_parse = endchar;
8108             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8109         }    
8110
8111         RExC_parse = endbrace + 1;
8112         if (endchar == endbrace) return NULL;
8113
8114         ret = (regnode *) &RExC_parse;  /* Invalid regnode pointer */
8115     }
8116     else {      /* Not a char class */
8117
8118         /* What is done here is to convert this to a sub-pattern of the form
8119          * (?:\x{char1}\x{char2}...)
8120          * and then call reg recursively.  That way, it retains its atomicness,
8121          * while not having to worry about special handling that some code
8122          * points may have.  toke.c has converted the original Unicode values
8123          * to native, so that we can just pass on the hex values unchanged.  We
8124          * do have to set a flag to keep recoding from happening in the
8125          * recursion */
8126
8127         SV * substitute_parse = newSVpvn_flags("?:", 2, SVf_UTF8|SVs_TEMP);
8128         STRLEN len;
8129         char *endchar;      /* Points to '.' or '}' ending cur char in the input
8130                                stream */
8131         char *orig_end = RExC_end;
8132
8133         while (RExC_parse < endbrace) {
8134
8135             /* Code points are separated by dots.  If none, there is only one
8136              * code point, and is terminated by the brace */
8137             endchar = RExC_parse + strcspn(RExC_parse, ".}");
8138
8139             /* Convert to notation the rest of the code understands */
8140             sv_catpv(substitute_parse, "\\x{");
8141             sv_catpvn(substitute_parse, RExC_parse, endchar - RExC_parse);
8142             sv_catpv(substitute_parse, "}");
8143
8144             /* Point to the beginning of the next character in the sequence. */
8145             RExC_parse = endchar + 1;
8146         }
8147         sv_catpv(substitute_parse, ")");
8148
8149         RExC_parse = SvPV(substitute_parse, len);
8150
8151         /* Don't allow empty number */
8152         if (len < 8) {
8153             vFAIL("Invalid hexadecimal number in \\N{U+...}");
8154         }
8155         RExC_end = RExC_parse + len;
8156
8157         /* The values are Unicode, and therefore not subject to recoding */
8158         RExC_override_recoding = 1;
8159
8160         ret = reg(pRExC_state, 1, flagp, depth+1);
8161
8162         RExC_parse = endbrace;
8163         RExC_end = orig_end;
8164         RExC_override_recoding = 0;
8165
8166         nextchar(pRExC_state);
8167     }
8168
8169     return ret;
8170 }
8171
8172
8173 /*
8174  * reg_recode
8175  *
8176  * It returns the code point in utf8 for the value in *encp.
8177  *    value: a code value in the source encoding
8178  *    encp:  a pointer to an Encode object
8179  *
8180  * If the result from Encode is not a single character,
8181  * it returns U+FFFD (Replacement character) and sets *encp to NULL.
8182  */
8183 STATIC UV
8184 S_reg_recode(pTHX_ const char value, SV **encp)
8185 {
8186     STRLEN numlen = 1;
8187     SV * const sv = newSVpvn_flags(&value, numlen, SVs_TEMP);
8188     const char * const s = *encp ? sv_recode_to_utf8(sv, *encp) : SvPVX(sv);
8189     const STRLEN newlen = SvCUR(sv);
8190     UV uv = UNICODE_REPLACEMENT;
8191
8192     PERL_ARGS_ASSERT_REG_RECODE;
8193
8194     if (newlen)
8195         uv = SvUTF8(sv)
8196              ? utf8n_to_uvchr((U8*)s, newlen, &numlen, UTF8_ALLOW_DEFAULT)
8197              : *(U8*)s;
8198
8199     if (!newlen || numlen != newlen) {
8200         uv = UNICODE_REPLACEMENT;
8201         *encp = NULL;
8202     }
8203     return uv;
8204 }
8205
8206
8207 /*
8208  - regatom - the lowest level
8209
8210    Try to identify anything special at the start of the pattern. If there
8211    is, then handle it as required. This may involve generating a single regop,
8212    such as for an assertion; or it may involve recursing, such as to
8213    handle a () structure.
8214
8215    If the string doesn't start with something special then we gobble up
8216    as much literal text as we can.
8217
8218    Once we have been able to handle whatever type of thing started the
8219    sequence, we return.
8220
8221    Note: we have to be careful with escapes, as they can be both literal
8222    and special, and in the case of \10 and friends can either, depending
8223    on context. Specifically there are two separate switches for handling
8224    escape sequences, with the one for handling literal escapes requiring
8225    a dummy entry for all of the special escapes that are actually handled
8226    by the other.
8227 */
8228
8229 STATIC regnode *
8230 S_regatom(pTHX_ RExC_state_t *pRExC_state, I32 *flagp, U32 depth)
8231 {
8232     dVAR;
8233     register regnode *ret = NULL;
8234     I32 flags;
8235     char *parse_start = RExC_parse;
8236     U8 op;
8237     GET_RE_DEBUG_FLAGS_DECL;
8238     DEBUG_PARSE("atom");
8239     *flagp = WORST;             /* Tentatively. */
8240
8241     PERL_ARGS_ASSERT_REGATOM;
8242
8243 tryagain:
8244     switch ((U8)*RExC_parse) {
8245     case '^':
8246         RExC_seen_zerolen++;
8247         nextchar(pRExC_state);
8248         if (RExC_flags & RXf_PMf_MULTILINE)
8249             ret = reg_node(pRExC_state, MBOL);
8250         else if (RExC_flags & RXf_PMf_SINGLELINE)
8251             ret = reg_node(pRExC_state, SBOL);
8252         else
8253             ret = reg_node(pRExC_state, BOL);
8254         Set_Node_Length(ret, 1); /* MJD */
8255         break;
8256     case '$':
8257         nextchar(pRExC_state);
8258         if (*RExC_parse)
8259             RExC_seen_zerolen++;
8260         if (RExC_flags & RXf_PMf_MULTILINE)
8261             ret = reg_node(pRExC_state, MEOL);
8262         else if (RExC_flags & RXf_PMf_SINGLELINE)
8263             ret = reg_node(pRExC_state, SEOL);
8264         else
8265             ret = reg_node(pRExC_state, EOL);
8266         Set_Node_Length(ret, 1); /* MJD */
8267         break;
8268     case '.':
8269         nextchar(pRExC_state);
8270         if (RExC_flags & RXf_PMf_SINGLELINE)
8271             ret = reg_node(pRExC_state, SANY);
8272         else
8273             ret = reg_node(pRExC_state, REG_ANY);
8274         *flagp |= HASWIDTH|SIMPLE;
8275         RExC_naughty++;
8276         Set_Node_Length(ret, 1); /* MJD */
8277         break;
8278     case '[':
8279     {
8280         char * const oregcomp_parse = ++RExC_parse;
8281         ret = regclass(pRExC_state,depth+1);
8282         if (*RExC_parse != ']') {
8283             RExC_parse = oregcomp_parse;
8284             vFAIL("Unmatched [");
8285         }
8286         nextchar(pRExC_state);
8287         *flagp |= HASWIDTH|SIMPLE;
8288         Set_Node_Length(ret, RExC_parse - oregcomp_parse + 1); /* MJD */
8289         break;
8290     }
8291     case '(':
8292         nextchar(pRExC_state);
8293         ret = reg(pRExC_state, 1, &flags,depth+1);
8294         if (ret == NULL) {
8295                 if (flags & TRYAGAIN) {
8296                     if (RExC_parse == RExC_end) {
8297                          /* Make parent create an empty node if needed. */
8298                         *flagp |= TRYAGAIN;
8299                         return(NULL);
8300                     }
8301                     goto tryagain;
8302                 }
8303                 return(NULL);
8304         }
8305         *flagp |= flags&(HASWIDTH|SPSTART|SIMPLE|POSTPONED);
8306         break;
8307     case '|':
8308     case ')':
8309         if (flags & TRYAGAIN) {
8310             *flagp |= TRYAGAIN;
8311             return NULL;
8312         }
8313         vFAIL("Internal urp");
8314                                 /* Supposed to be caught earlier. */
8315         break;
8316     case '{':
8317         if (!regcurly(RExC_parse)) {
8318             RExC_parse++;
8319             goto defchar;
8320         }
8321         /* FALL THROUGH */
8322     case '?':
8323     case '+':
8324     case '*':
8325         RExC_parse++;
8326         vFAIL("Quantifier follows nothing");
8327         break;
8328     case '\\':
8329         /* Special Escapes
8330
8331            This switch handles escape sequences that resolve to some kind
8332            of special regop and not to literal text. Escape sequnces that
8333            resolve to literal text are handled below in the switch marked
8334            "Literal Escapes".
8335
8336            Every entry in this switch *must* have a corresponding entry
8337            in the literal escape switch. However, the opposite is not
8338            required, as the default for this switch is to jump to the
8339            literal text handling code.
8340         */
8341         switch ((U8)*++RExC_parse) {
8342         /* Special Escapes */
8343         case 'A':
8344             RExC_seen_zerolen++;
8345             ret = reg_node(pRExC_state, SBOL);
8346             *flagp |= SIMPLE;
8347             goto finish_meta_pat;
8348         case 'G':
8349             ret = reg_node(pRExC_state, GPOS);
8350             RExC_seen |= REG_SEEN_GPOS;
8351             *flagp |= SIMPLE;
8352             goto finish_meta_pat;
8353         case 'K':
8354             RExC_seen_zerolen++;
8355             ret = reg_node(pRExC_state, KEEPS);
8356             *flagp |= SIMPLE;
8357             /* XXX:dmq : disabling in-place substitution seems to
8358              * be necessary here to avoid cases of memory corruption, as
8359              * with: C<$_="x" x 80; s/x\K/y/> -- rgs
8360              */
8361             RExC_seen |= REG_SEEN_LOOKBEHIND;
8362             goto finish_meta_pat;
8363         case 'Z':
8364             ret = reg_node(pRExC_state, SEOL);
8365             *flagp |= SIMPLE;
8366             RExC_seen_zerolen++;                /* Do not optimize RE away */
8367             goto finish_meta_pat;
8368         case 'z':
8369             ret = reg_node(pRExC_state, EOS);
8370             *flagp |= SIMPLE;
8371             RExC_seen_zerolen++;                /* Do not optimize RE away */
8372             goto finish_meta_pat;
8373         case 'C':
8374             ret = reg_node(pRExC_state, CANY);
8375             RExC_seen |= REG_SEEN_CANY;
8376             *flagp |= HASWIDTH|SIMPLE;
8377             goto finish_meta_pat;
8378         case 'X':
8379             ret = reg_node(pRExC_state, CLUMP);
8380             *flagp |= HASWIDTH;
8381             goto finish_meta_pat;
8382         case 'w':
8383             switch (get_regex_charset(RExC_flags)) {
8384                 case REGEX_LOCALE_CHARSET:
8385                     op = ALNUML;
8386                     break;
8387                 case REGEX_UNICODE_CHARSET:
8388                     op = ALNUMU;
8389                     break;
8390                 case REGEX_ASCII_RESTRICTED_CHARSET:
8391                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8392                     op = ALNUMA;
8393                     break;
8394                 case REGEX_DEPENDS_CHARSET:
8395                     op = ALNUM;
8396                     break;
8397                 default:
8398                     goto bad_charset;
8399             }
8400             ret = reg_node(pRExC_state, op);
8401             *flagp |= HASWIDTH|SIMPLE;
8402             goto finish_meta_pat;
8403         case 'W':
8404             switch (get_regex_charset(RExC_flags)) {
8405                 case REGEX_LOCALE_CHARSET:
8406                     op = NALNUML;
8407                     break;
8408                 case REGEX_UNICODE_CHARSET:
8409                     op = NALNUMU;
8410                     break;
8411                 case REGEX_ASCII_RESTRICTED_CHARSET:
8412                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8413                     op = NALNUMA;
8414                     break;
8415                 case REGEX_DEPENDS_CHARSET:
8416                     op = NALNUM;
8417                     break;
8418                 default:
8419                     goto bad_charset;
8420             }
8421             ret = reg_node(pRExC_state, op);
8422             *flagp |= HASWIDTH|SIMPLE;
8423             goto finish_meta_pat;
8424         case 'b':
8425             RExC_seen_zerolen++;
8426             RExC_seen |= REG_SEEN_LOOKBEHIND;
8427             switch (get_regex_charset(RExC_flags)) {
8428                 case REGEX_LOCALE_CHARSET:
8429                     op = BOUNDL;
8430                     break;
8431                 case REGEX_UNICODE_CHARSET:
8432                     op = BOUNDU;
8433                     break;
8434                 case REGEX_ASCII_RESTRICTED_CHARSET:
8435                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8436                     op = BOUNDA;
8437                     break;
8438                 case REGEX_DEPENDS_CHARSET:
8439                     op = BOUND;
8440                     break;
8441                 default:
8442                     goto bad_charset;
8443             }
8444             ret = reg_node(pRExC_state, op);
8445             FLAGS(ret) = get_regex_charset(RExC_flags);
8446             *flagp |= SIMPLE;
8447             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
8448                 ckWARNregdep(RExC_parse, "\"\\b{\" is deprecated; use \"\\b\\{\" instead");
8449             }
8450             goto finish_meta_pat;
8451         case 'B':
8452             RExC_seen_zerolen++;
8453             RExC_seen |= REG_SEEN_LOOKBEHIND;
8454             switch (get_regex_charset(RExC_flags)) {
8455                 case REGEX_LOCALE_CHARSET:
8456                     op = NBOUNDL;
8457                     break;
8458                 case REGEX_UNICODE_CHARSET:
8459                     op = NBOUNDU;
8460                     break;
8461                 case REGEX_ASCII_RESTRICTED_CHARSET:
8462                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8463                     op = NBOUNDA;
8464                     break;
8465                 case REGEX_DEPENDS_CHARSET:
8466                     op = NBOUND;
8467                     break;
8468                 default:
8469                     goto bad_charset;
8470             }
8471             ret = reg_node(pRExC_state, op);
8472             FLAGS(ret) = get_regex_charset(RExC_flags);
8473             *flagp |= SIMPLE;
8474             if (! SIZE_ONLY && (U8) *(RExC_parse + 1) == '{') {
8475                 ckWARNregdep(RExC_parse, "\"\\B{\" is deprecated; use \"\\B\\{\" instead");
8476             }
8477             goto finish_meta_pat;
8478         case 's':
8479             switch (get_regex_charset(RExC_flags)) {
8480                 case REGEX_LOCALE_CHARSET:
8481                     op = SPACEL;
8482                     break;
8483                 case REGEX_UNICODE_CHARSET:
8484                     op = SPACEU;
8485                     break;
8486                 case REGEX_ASCII_RESTRICTED_CHARSET:
8487                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8488                     op = SPACEA;
8489                     break;
8490                 case REGEX_DEPENDS_CHARSET:
8491                     op = SPACE;
8492                     break;
8493                 default:
8494                     goto bad_charset;
8495             }
8496             ret = reg_node(pRExC_state, op);
8497             *flagp |= HASWIDTH|SIMPLE;
8498             goto finish_meta_pat;
8499         case 'S':
8500             switch (get_regex_charset(RExC_flags)) {
8501                 case REGEX_LOCALE_CHARSET:
8502                     op = NSPACEL;
8503                     break;
8504                 case REGEX_UNICODE_CHARSET:
8505                     op = NSPACEU;
8506                     break;
8507                 case REGEX_ASCII_RESTRICTED_CHARSET:
8508                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8509                     op = NSPACEA;
8510                     break;
8511                 case REGEX_DEPENDS_CHARSET:
8512                     op = NSPACE;
8513                     break;
8514                 default:
8515                     goto bad_charset;
8516             }
8517             ret = reg_node(pRExC_state, op);
8518             *flagp |= HASWIDTH|SIMPLE;
8519             goto finish_meta_pat;
8520         case 'd':
8521             switch (get_regex_charset(RExC_flags)) {
8522                 case REGEX_LOCALE_CHARSET:
8523                     op = DIGITL;
8524                     break;
8525                 case REGEX_ASCII_RESTRICTED_CHARSET:
8526                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8527                     op = DIGITA;
8528                     break;
8529                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
8530                 case REGEX_UNICODE_CHARSET:
8531                     op = DIGIT;
8532                     break;
8533                 default:
8534                     goto bad_charset;
8535             }
8536             ret = reg_node(pRExC_state, op);
8537             *flagp |= HASWIDTH|SIMPLE;
8538             goto finish_meta_pat;
8539         case 'D':
8540             switch (get_regex_charset(RExC_flags)) {
8541                 case REGEX_LOCALE_CHARSET:
8542                     op = NDIGITL;
8543                     break;
8544                 case REGEX_ASCII_RESTRICTED_CHARSET:
8545                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
8546                     op = NDIGITA;
8547                     break;
8548                 case REGEX_DEPENDS_CHARSET: /* No difference between these */
8549                 case REGEX_UNICODE_CHARSET:
8550                     op = NDIGIT;
8551                     break;
8552                 default:
8553                     goto bad_charset;
8554             }
8555             ret = reg_node(pRExC_state, op);
8556             *flagp |= HASWIDTH|SIMPLE;
8557             goto finish_meta_pat;
8558         case 'R':
8559             ret = reg_node(pRExC_state, LNBREAK);
8560             *flagp |= HASWIDTH|SIMPLE;
8561             goto finish_meta_pat;
8562         case 'h':
8563             ret = reg_node(pRExC_state, HORIZWS);
8564             *flagp |= HASWIDTH|SIMPLE;
8565             goto finish_meta_pat;
8566         case 'H':
8567             ret = reg_node(pRExC_state, NHORIZWS);
8568             *flagp |= HASWIDTH|SIMPLE;
8569             goto finish_meta_pat;
8570         case 'v':
8571             ret = reg_node(pRExC_state, VERTWS);
8572             *flagp |= HASWIDTH|SIMPLE;
8573             goto finish_meta_pat;
8574         case 'V':
8575             ret = reg_node(pRExC_state, NVERTWS);
8576             *flagp |= HASWIDTH|SIMPLE;
8577          finish_meta_pat:           
8578             nextchar(pRExC_state);
8579             Set_Node_Length(ret, 2); /* MJD */
8580             break;          
8581         case 'p':
8582         case 'P':
8583             {   
8584                 char* const oldregxend = RExC_end;
8585 #ifdef DEBUGGING
8586                 char* parse_start = RExC_parse - 2;
8587 #endif
8588
8589                 if (RExC_parse[1] == '{') {
8590                   /* a lovely hack--pretend we saw [\pX] instead */
8591                     RExC_end = strchr(RExC_parse, '}');
8592                     if (!RExC_end) {
8593                         const U8 c = (U8)*RExC_parse;
8594                         RExC_parse += 2;
8595                         RExC_end = oldregxend;
8596                         vFAIL2("Missing right brace on \\%c{}", c);
8597                     }
8598                     RExC_end++;
8599                 }
8600                 else {
8601                     RExC_end = RExC_parse + 2;
8602                     if (RExC_end > oldregxend)
8603                         RExC_end = oldregxend;
8604                 }
8605                 RExC_parse--;
8606
8607                 ret = regclass(pRExC_state,depth+1);
8608
8609                 RExC_end = oldregxend;
8610                 RExC_parse--;
8611
8612                 Set_Node_Offset(ret, parse_start + 2);
8613                 Set_Node_Cur_Length(ret);
8614                 nextchar(pRExC_state);
8615                 *flagp |= HASWIDTH|SIMPLE;
8616             }
8617             break;
8618         case 'N': 
8619             /* Handle \N and \N{NAME} here and not below because it can be
8620             multicharacter. join_exact() will join them up later on. 
8621             Also this makes sure that things like /\N{BLAH}+/ and 
8622             \N{BLAH} being multi char Just Happen. dmq*/
8623             ++RExC_parse;
8624             ret= reg_namedseq(pRExC_state, NULL, flagp, depth);
8625             break;
8626         case 'k':    /* Handle \k<NAME> and \k'NAME' */
8627         parse_named_seq:
8628         {   
8629             char ch= RExC_parse[1];         
8630             if (ch != '<' && ch != '\'' && ch != '{') {
8631                 RExC_parse++;
8632                 vFAIL2("Sequence %.2s... not terminated",parse_start);
8633             } else {
8634                 /* this pretty much dupes the code for (?P=...) in reg(), if
8635                    you change this make sure you change that */
8636                 char* name_start = (RExC_parse += 2);
8637                 U32 num = 0;
8638                 SV *sv_dat = reg_scan_name(pRExC_state,
8639                     SIZE_ONLY ? REG_RSN_RETURN_NULL : REG_RSN_RETURN_DATA);
8640                 ch= (ch == '<') ? '>' : (ch == '{') ? '}' : '\'';
8641                 if (RExC_parse == name_start || *RExC_parse != ch)
8642                     vFAIL2("Sequence %.3s... not terminated",parse_start);
8643
8644                 if (!SIZE_ONLY) {
8645                     num = add_data( pRExC_state, 1, "S" );
8646                     RExC_rxi->data->data[num]=(void*)sv_dat;
8647                     SvREFCNT_inc_simple_void(sv_dat);
8648                 }
8649
8650                 RExC_sawback = 1;
8651                 ret = reganode(pRExC_state,
8652                                ((! FOLD)
8653                                  ? NREF
8654                                  : (MORE_ASCII_RESTRICTED)
8655                                    ? NREFFA
8656                                    : (AT_LEAST_UNI_SEMANTICS)
8657                                      ? NREFFU
8658                                      : (LOC)
8659                                        ? NREFFL
8660                                        : NREFF),
8661                                 num);
8662                 *flagp |= HASWIDTH;
8663
8664                 /* override incorrect value set in reganode MJD */
8665                 Set_Node_Offset(ret, parse_start+1);
8666                 Set_Node_Cur_Length(ret); /* MJD */
8667                 nextchar(pRExC_state);
8668
8669             }
8670             break;
8671         }
8672         case 'g': 
8673         case '1': case '2': case '3': case '4':
8674         case '5': case '6': case '7': case '8': case '9':
8675             {
8676                 I32 num;
8677                 bool isg = *RExC_parse == 'g';
8678                 bool isrel = 0; 
8679                 bool hasbrace = 0;
8680                 if (isg) {
8681                     RExC_parse++;
8682                     if (*RExC_parse == '{') {
8683                         RExC_parse++;
8684                         hasbrace = 1;
8685                     }
8686                     if (*RExC_parse == '-') {
8687                         RExC_parse++;
8688                         isrel = 1;
8689                     }
8690                     if (hasbrace && !isDIGIT(*RExC_parse)) {
8691                         if (isrel) RExC_parse--;
8692                         RExC_parse -= 2;                            
8693                         goto parse_named_seq;
8694                 }   }
8695                 num = atoi(RExC_parse);
8696                 if (isg && num == 0)
8697                     vFAIL("Reference to invalid group 0");
8698                 if (isrel) {
8699                     num = RExC_npar - num;
8700                     if (num < 1)
8701                         vFAIL("Reference to nonexistent or unclosed group");
8702                 }
8703                 if (!isg && num > 9 && num >= RExC_npar)
8704                     goto defchar;
8705                 else {
8706                     char * const parse_start = RExC_parse - 1; /* MJD */
8707                     while (isDIGIT(*RExC_parse))
8708                         RExC_parse++;
8709                     if (parse_start == RExC_parse - 1) 
8710                         vFAIL("Unterminated \\g... pattern");
8711                     if (hasbrace) {
8712                         if (*RExC_parse != '}') 
8713                             vFAIL("Unterminated \\g{...} pattern");
8714                         RExC_parse++;
8715                     }    
8716                     if (!SIZE_ONLY) {
8717                         if (num > (I32)RExC_rx->nparens)
8718                             vFAIL("Reference to nonexistent group");
8719                     }
8720                     RExC_sawback = 1;
8721                     ret = reganode(pRExC_state,
8722                                    ((! FOLD)
8723                                      ? REF
8724                                      : (MORE_ASCII_RESTRICTED)
8725                                        ? REFFA
8726                                        : (AT_LEAST_UNI_SEMANTICS)
8727                                          ? REFFU
8728                                          : (LOC)
8729                                            ? REFFL
8730                                            : REFF),
8731                                     num);
8732                     *flagp |= HASWIDTH;
8733
8734                     /* override incorrect value set in reganode MJD */
8735                     Set_Node_Offset(ret, parse_start+1);
8736                     Set_Node_Cur_Length(ret); /* MJD */
8737                     RExC_parse--;
8738                     nextchar(pRExC_state);
8739                 }
8740             }
8741             break;
8742         case '\0':
8743             if (RExC_parse >= RExC_end)
8744                 FAIL("Trailing \\");
8745             /* FALL THROUGH */
8746         default:
8747             /* Do not generate "unrecognized" warnings here, we fall
8748                back into the quick-grab loop below */
8749             parse_start--;
8750             goto defchar;
8751         }
8752         break;
8753
8754     case '#':
8755         if (RExC_flags & RXf_PMf_EXTENDED) {
8756             if ( reg_skipcomment( pRExC_state ) )
8757                 goto tryagain;
8758         }
8759         /* FALL THROUGH */
8760
8761     default:
8762
8763             parse_start = RExC_parse - 1;
8764
8765             RExC_parse++;
8766
8767         defchar: {
8768             typedef enum {
8769                 generic_char = 0,
8770                 char_s,
8771                 upsilon_1,
8772                 upsilon_2,
8773                 iota_1,
8774                 iota_2,
8775             } char_state;
8776             char_state latest_char_state = generic_char;
8777             register STRLEN len;
8778             register UV ender;
8779             register char *p;
8780             char *s;
8781             STRLEN foldlen;
8782             U8 tmpbuf[UTF8_MAXBYTES_CASE+1], *foldbuf;
8783             regnode * orig_emit;
8784
8785             ender = 0;
8786             orig_emit = RExC_emit; /* Save the original output node position in
8787                                       case we need to output a different node
8788                                       type */
8789             ret = reg_node(pRExC_state,
8790                            (U8) ((! FOLD) ? EXACT
8791                                           : (LOC)
8792                                              ? EXACTFL
8793                                              : (MORE_ASCII_RESTRICTED)
8794                                                ? EXACTFA
8795                                                : (AT_LEAST_UNI_SEMANTICS)
8796                                                  ? EXACTFU
8797                                                  : EXACTF)
8798                     );
8799             s = STRING(ret);
8800             for (len = 0, p = RExC_parse - 1;
8801               len < 127 && p < RExC_end;
8802               len++)
8803             {
8804                 char * const oldp = p;
8805
8806                 if (RExC_flags & RXf_PMf_EXTENDED)
8807                     p = regwhite( pRExC_state, p );
8808                 switch ((U8)*p) {
8809                 case '^':
8810                 case '$':
8811                 case '.':
8812                 case '[':
8813                 case '(':
8814                 case ')':
8815                 case '|':
8816                     goto loopdone;
8817                 case '\\':
8818                     /* Literal Escapes Switch
8819
8820                        This switch is meant to handle escape sequences that
8821                        resolve to a literal character.
8822
8823                        Every escape sequence that represents something
8824                        else, like an assertion or a char class, is handled
8825                        in the switch marked 'Special Escapes' above in this
8826                        routine, but also has an entry here as anything that
8827                        isn't explicitly mentioned here will be treated as
8828                        an unescaped equivalent literal.
8829                     */
8830
8831                     switch ((U8)*++p) {
8832                     /* These are all the special escapes. */
8833                     case 'A':             /* Start assertion */
8834                     case 'b': case 'B':   /* Word-boundary assertion*/
8835                     case 'C':             /* Single char !DANGEROUS! */
8836                     case 'd': case 'D':   /* digit class */
8837                     case 'g': case 'G':   /* generic-backref, pos assertion */
8838                     case 'h': case 'H':   /* HORIZWS */
8839                     case 'k': case 'K':   /* named backref, keep marker */
8840                     case 'N':             /* named char sequence */
8841                     case 'p': case 'P':   /* Unicode property */
8842                               case 'R':   /* LNBREAK */
8843                     case 's': case 'S':   /* space class */
8844                     case 'v': case 'V':   /* VERTWS */
8845                     case 'w': case 'W':   /* word class */
8846                     case 'X':             /* eXtended Unicode "combining character sequence" */
8847                     case 'z': case 'Z':   /* End of line/string assertion */
8848                         --p;
8849                         goto loopdone;
8850
8851                     /* Anything after here is an escape that resolves to a
8852                        literal. (Except digits, which may or may not)
8853                      */
8854                     case 'n':
8855                         ender = '\n';
8856                         p++;
8857                         break;
8858                     case 'r':
8859                         ender = '\r';
8860                         p++;
8861                         break;
8862                     case 't':
8863                         ender = '\t';
8864                         p++;
8865                         break;
8866                     case 'f':
8867                         ender = '\f';
8868                         p++;
8869                         break;
8870                     case 'e':
8871                           ender = ASCII_TO_NATIVE('\033');
8872                         p++;
8873                         break;
8874                     case 'a':
8875                           ender = ASCII_TO_NATIVE('\007');
8876                         p++;
8877                         break;
8878                     case 'o':
8879                         {
8880                             STRLEN brace_len = len;
8881                             UV result;
8882                             const char* error_msg;
8883
8884                             bool valid = grok_bslash_o(p,
8885                                                        &result,
8886                                                        &brace_len,
8887                                                        &error_msg,
8888                                                        1);
8889                             p += brace_len;
8890                             if (! valid) {
8891                                 RExC_parse = p; /* going to die anyway; point
8892                                                    to exact spot of failure */
8893                                 vFAIL(error_msg);
8894                             }
8895                             else
8896                             {
8897                                 ender = result;
8898                             }
8899                             if (PL_encoding && ender < 0x100) {
8900                                 goto recode_encoding;
8901                             }
8902                             if (ender > 0xff) {
8903                                 REQUIRE_UTF8;
8904                             }
8905                             break;
8906                         }
8907                     case 'x':
8908                         if (*++p == '{') {
8909                             char* const e = strchr(p, '}');
8910         
8911                             if (!e) {
8912                                 RExC_parse = p + 1;
8913                                 vFAIL("Missing right brace on \\x{}");
8914                             }
8915                             else {
8916                                 I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
8917                                     | PERL_SCAN_DISALLOW_PREFIX;
8918                                 STRLEN numlen = e - p - 1;
8919                                 ender = grok_hex(p + 1, &numlen, &flags, NULL);
8920                                 if (ender > 0xff)
8921                                     REQUIRE_UTF8;
8922                                 p = e + 1;
8923                             }
8924                         }
8925                         else {
8926                             I32 flags = PERL_SCAN_DISALLOW_PREFIX;
8927                             STRLEN numlen = 2;
8928                             ender = grok_hex(p, &numlen, &flags, NULL);
8929                             p += numlen;
8930                         }
8931                         if (PL_encoding && ender < 0x100)
8932                             goto recode_encoding;
8933                         break;
8934                     case 'c':
8935                         p++;
8936                         ender = grok_bslash_c(*p++, UTF, SIZE_ONLY);
8937                         break;
8938                     case '0': case '1': case '2': case '3':case '4':
8939                     case '5': case '6': case '7': case '8':case '9':
8940                         if (*p == '0' ||
8941                             (isDIGIT(p[1]) && atoi(p) >= RExC_npar))
8942                         {
8943                             I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
8944                             STRLEN numlen = 3;
8945                             ender = grok_oct(p, &numlen, &flags, NULL);
8946                             if (ender > 0xff) {
8947                                 REQUIRE_UTF8;
8948                             }
8949                             p += numlen;
8950                         }
8951                         else {
8952                             --p;
8953                             goto loopdone;
8954                         }
8955                         if (PL_encoding && ender < 0x100)
8956                             goto recode_encoding;
8957                         break;
8958                     recode_encoding:
8959                         if (! RExC_override_recoding) {
8960                             SV* enc = PL_encoding;
8961                             ender = reg_recode((const char)(U8)ender, &enc);
8962                             if (!enc && SIZE_ONLY)
8963                                 ckWARNreg(p, "Invalid escape in the specified encoding");
8964                             REQUIRE_UTF8;
8965                         }
8966                         break;
8967                     case '\0':
8968                         if (p >= RExC_end)
8969                             FAIL("Trailing \\");
8970                         /* FALL THROUGH */
8971                     default:
8972                         if (!SIZE_ONLY&& isALPHA(*p)) {
8973                             /* Include any { following the alpha to emphasize
8974                              * that it could be part of an escape at some point
8975                              * in the future */
8976                             int len = (*(p + 1) == '{') ? 2 : 1;
8977                             ckWARN3reg(p + len, "Unrecognized escape \\%.*s passed through", len, p);
8978                         }
8979                         goto normal_default;
8980                     }
8981                     break;
8982                 default:
8983                   normal_default:
8984                     if (UTF8_IS_START(*p) && UTF) {
8985                         STRLEN numlen;
8986                         ender = utf8n_to_uvchr((U8*)p, RExC_end - p,
8987                                                &numlen, UTF8_ALLOW_DEFAULT);
8988                         p += numlen;
8989                     }
8990                     else
8991                         ender = (U8) *p++;
8992                     break;
8993                 } /* End of switch on the literal */
8994
8995                 /* Certain characters are problematic because their folded
8996                  * length is so different from their original length that it
8997                  * isn't handleable by the optimizer.  They are therefore not
8998                  * placed in an EXACTish node; and are here handled specially.
8999                  * (Even if the optimizer handled LATIN_SMALL_LETTER_SHARP_S,
9000                  * putting it in a special node keeps regexec from having to
9001                  * deal with a non-utf8 multi-char fold */
9002                 if (FOLD
9003                     && (ender > 255 || (! MORE_ASCII_RESTRICTED && ! LOC)))
9004                 {
9005                     /* We look for either side of the fold.  For example \xDF
9006                      * folds to 'ss'.  We look for both the single character
9007                      * \xDF and the sequence 'ss'.  When we find something that
9008                      * could be one of those, we stop and flush whatever we
9009                      * have output so far into the EXACTish node that was being
9010                      * built.  Then restore the input pointer to what it was.
9011                      * regatom will return that EXACT node, and will be called
9012                      * again, positioned so the first character is the one in
9013                      * question, which we return in a different node type.
9014                      * The multi-char folds are a sequence, so the occurrence
9015                      * of the first character in that sequence doesn't
9016                      * necessarily mean that what follows is the rest of the
9017                      * sequence.  We keep track of that with a state machine,
9018                      * with the state being set to the latest character
9019                      * processed before the current one.  Most characters will
9020                      * set the state to 0, but if one occurs that is part of a
9021                      * potential tricky fold sequence, the state is set to that
9022                      * character, and the next loop iteration sees if the state
9023                      * should progress towards the final folded-from character,
9024                      * or if it was a false alarm.  If it turns out to be a
9025                      * false alarm, the character(s) will be output in a new
9026                      * EXACTish node, and join_exact() will later combine them.
9027                      * In the case of the 'ss' sequence, which is more common
9028                      * and more easily checked, some look-ahead is done to
9029                      * save time by ruling-out some false alarms */
9030                     switch (ender) {
9031                         default:
9032                             latest_char_state = generic_char;
9033                             break;
9034                         case 's':
9035                         case 'S':
9036                         case 0x17F: /* LATIN SMALL LETTER LONG S */
9037                              if (AT_LEAST_UNI_SEMANTICS) {
9038                                 if (latest_char_state == char_s) {  /* 'ss' */
9039                                     ender = LATIN_SMALL_LETTER_SHARP_S;
9040                                     goto do_tricky;
9041                                 }
9042                                 else if (p < RExC_end) {
9043
9044                                     /* Look-ahead at the next character.  If it
9045                                      * is also an s, we handle as a sharp s
9046                                      * tricky regnode.  */
9047                                     if (*p == 's' || *p == 'S') {
9048
9049                                         /* But first flush anything in the
9050                                          * EXACTish buffer */
9051                                         if (len != 0) {
9052                                             p = oldp;
9053                                             goto loopdone;
9054                                         }
9055                                         p++;    /* Account for swallowing this
9056                                                    's' up */
9057                                         ender = LATIN_SMALL_LETTER_SHARP_S;
9058                                         goto do_tricky;
9059                                     }
9060                                         /* Here, the next character is not a
9061                                          * literal 's', but still could
9062                                          * evaluate to one if part of a \o{},
9063                                          * \x or \OCTAL-DIGIT.  The minimum
9064                                          * length required for that is 4, eg
9065                                          * \x53 or \123 */
9066                                     else if (*p == '\\'
9067                                              && p < RExC_end - 4
9068                                              && (isDIGIT(*(p + 1))
9069                                                  || *(p + 1) == 'x'
9070                                                  || *(p + 1) == 'o' ))
9071                                     {
9072
9073                                         /* Here, it could be an 's', too much
9074                                          * bother to figure it out here.  Flush
9075                                          * the buffer if any; when come back
9076                                          * here, set the state so know that the
9077                                          * previous char was an 's' */
9078                                         if (len != 0) {
9079                                             latest_char_state = generic_char;
9080                                             p = oldp;
9081                                             goto loopdone;
9082                                         }
9083                                         latest_char_state = char_s;
9084                                         break;
9085                                     }
9086                                 }
9087                             }
9088
9089                             /* Here, can't be an 'ss' sequence, or at least not
9090                              * one that could fold to/from the sharp ss */
9091                             latest_char_state = generic_char;
9092                             break;
9093                         case 0x03C5:    /* First char in upsilon series */
9094                         case 0x03A5:    /* Also capital UPSILON, which folds to
9095                                            03C5, and hence exhibits the same
9096                                            problem */
9097                             if (p < RExC_end - 4) { /* Need >= 4 bytes left */
9098                                 latest_char_state = upsilon_1;
9099                                 if (len != 0) {
9100                                     p = oldp;
9101                                     goto loopdone;
9102                                 }
9103                             }
9104                             else {
9105                                 latest_char_state = generic_char;
9106                             }
9107                             break;
9108                         case 0x03B9:    /* First char in iota series */
9109                         case 0x0399:    /* Also capital IOTA */
9110                         case 0x1FBE:    /* GREEK PROSGEGRAMMENI folds to 3B9 */
9111                         case 0x0345:    /* COMBINING GREEK YPOGEGRAMMENI folds
9112                                            to 3B9 */
9113                             if (p < RExC_end - 4) {
9114                                 latest_char_state = iota_1;
9115                                 if (len != 0) {
9116                                     p = oldp;
9117                                     goto loopdone;
9118                                 }
9119                             }
9120                             else {
9121                                 latest_char_state = generic_char;
9122                             }
9123                             break;
9124                         case 0x0308:
9125                             if (latest_char_state == upsilon_1) {
9126                                 latest_char_state = upsilon_2;
9127                             }
9128                             else if (latest_char_state == iota_1) {
9129                                 latest_char_state = iota_2;
9130                             }
9131                             else {
9132                                 latest_char_state = generic_char;
9133                             }
9134                             break;
9135                         case 0x301:
9136                             if (latest_char_state == upsilon_2) {
9137                                 ender = GREEK_SMALL_LETTER_UPSILON_WITH_DIALYTIKA_AND_TONOS;
9138                                 goto do_tricky;
9139                             }
9140                             else if (latest_char_state == iota_2) {
9141                                 ender = GREEK_SMALL_LETTER_IOTA_WITH_DIALYTIKA_AND_TONOS;
9142                                 goto do_tricky;
9143                             }
9144                             latest_char_state = generic_char;
9145                             break;
9146
9147                         /* These are the tricky fold characters.  Flush any
9148                          * buffer first. (When adding to this list, also should
9149                          * add them to fold_grind.t to make sure get tested) */
9150                         case GREEK_SMALL_LETTER_UPSILON_WITH_DIALYTIKA_AND_TONOS:
9151                         case GREEK_SMALL_LETTER_IOTA_WITH_DIALYTIKA_AND_TONOS:
9152                         case LATIN_SMALL_LETTER_SHARP_S:
9153                         case LATIN_CAPITAL_LETTER_SHARP_S:
9154                         case 0x1FD3: /* GREEK SMALL LETTER IOTA WITH DIALYTIKA AND OXIA */
9155                         case 0x1FE3: /* GREEK SMALL LETTER UPSILON WITH DIALYTIKA AND OXIA */
9156                             if (len != 0) {
9157                                 p = oldp;
9158                                 goto loopdone;
9159                             }
9160                             /* FALL THROUGH */
9161                         do_tricky: {
9162                             char* const oldregxend = RExC_end;
9163                             U8 tmpbuf[UTF8_MAXBYTES+1];
9164
9165                             /* Here, we know we need to generate a special
9166                              * regnode, and 'ender' contains the tricky
9167                              * character.  What's done is to pretend it's in a
9168                              * [bracketed] class, and let the code that deals
9169                              * with those handle it, as that code has all the
9170                              * intelligence necessary.  First save the current
9171                              * parse state, get rid of the already allocated
9172                              * but empty EXACT node that the ANYOFV node will
9173                              * replace, and point the parse to a buffer which
9174                              * we fill with the character we want the regclass
9175                              * code to think is being parsed */
9176                             RExC_emit = orig_emit;
9177                             RExC_parse = (char *) tmpbuf;
9178                             if (UTF) {
9179                                 U8 *d = uvchr_to_utf8(tmpbuf, ender);
9180                                 *d = '\0';
9181                                 RExC_end = (char *) d;
9182                             }
9183                             else {  /* ender above 255 already excluded */
9184                                 tmpbuf[0] = (U8) ender;
9185                                 tmpbuf[1] = '\0';
9186                                 RExC_end = RExC_parse + 1;
9187                             }
9188
9189                             ret = regclass(pRExC_state,depth+1);
9190
9191                             /* Here, have parsed the buffer.  Reset the parse to
9192                              * the actual input, and return */
9193                             RExC_end = oldregxend;
9194                             RExC_parse = p - 1;
9195
9196                             Set_Node_Offset(ret, RExC_parse);
9197                             Set_Node_Cur_Length(ret);
9198                             nextchar(pRExC_state);
9199                             *flagp |= HASWIDTH|SIMPLE;
9200                             return ret;
9201                         }
9202                     }
9203                 }
9204
9205                 if ( RExC_flags & RXf_PMf_EXTENDED)
9206                     p = regwhite( pRExC_state, p );
9207                 if (UTF && FOLD) {
9208                     /* Prime the casefolded buffer.  Locale rules, which apply
9209                      * only to code points < 256, aren't known until execution,
9210                      * so for them, just output the original character using
9211                      * utf8 */
9212                     if (LOC && ender < 256) {
9213                         if (UNI_IS_INVARIANT(ender)) {
9214                             *tmpbuf = (U8) ender;
9215                             foldlen = 1;
9216                         } else {
9217                             *tmpbuf = UTF8_TWO_BYTE_HI(ender);
9218                             *(tmpbuf + 1) = UTF8_TWO_BYTE_LO(ender);
9219                             foldlen = 2;
9220                         }
9221                     }
9222                     else if (isASCII(ender)) {  /* Note: Here can't also be LOC
9223                                                  */
9224                         ender = toLOWER(ender);
9225                         *tmpbuf = (U8) ender;
9226                         foldlen = 1;
9227                     }
9228                     else if (! MORE_ASCII_RESTRICTED && ! LOC) {
9229
9230                         /* Locale and /aa require more selectivity about the
9231                          * fold, so are handled below.  Otherwise, here, just
9232                          * use the fold */
9233                         ender = toFOLD_uni(ender, tmpbuf, &foldlen);
9234                     }
9235                     else {
9236                         /* Under locale rules or /aa we are not to mix,
9237                          * respectively, ords < 256 or ASCII with non-.  So
9238                          * reject folds that mix them, using only the
9239                          * non-folded code point.  So do the fold to a
9240                          * temporary, and inspect each character in it. */
9241                         U8 trialbuf[UTF8_MAXBYTES_CASE+1];
9242                         U8* s = trialbuf;
9243                         UV tmpender = toFOLD_uni(ender, trialbuf, &foldlen);
9244                         U8* e = s + foldlen;
9245                         bool fold_ok = TRUE;
9246
9247                         while (s < e) {
9248                             if (isASCII(*s)
9249                                 || (LOC && (UTF8_IS_INVARIANT(*s)
9250                                            || UTF8_IS_DOWNGRADEABLE_START(*s))))
9251                             {
9252                                 fold_ok = FALSE;
9253                                 break;
9254                             }
9255                             s += UTF8SKIP(s);
9256                         }
9257                         if (fold_ok) {
9258                             Copy(trialbuf, tmpbuf, foldlen, U8);
9259                             ender = tmpender;
9260                         }
9261                         else {
9262                             uvuni_to_utf8(tmpbuf, ender);
9263                             foldlen = UNISKIP(ender);
9264                         }
9265                     }
9266                 }
9267                 if (p < RExC_end && ISMULT2(p)) { /* Back off on ?+*. */
9268                     if (len)
9269                         p = oldp;
9270                     else if (UTF) {
9271                          if (FOLD) {
9272                               /* Emit all the Unicode characters. */
9273                               STRLEN numlen;
9274                               for (foldbuf = tmpbuf;
9275                                    foldlen;
9276                                    foldlen -= numlen) {
9277                                    ender = utf8_to_uvchr(foldbuf, &numlen);
9278                                    if (numlen > 0) {
9279                                         const STRLEN unilen = reguni(pRExC_state, ender, s);
9280                                         s       += unilen;
9281                                         len     += unilen;
9282                                         /* In EBCDIC the numlen
9283                                          * and unilen can differ. */
9284                                         foldbuf += numlen;
9285                                         if (numlen >= foldlen)
9286                                              break;
9287                                    }
9288                                    else
9289                                         break; /* "Can't happen." */
9290                               }
9291                          }
9292                          else {
9293                               const STRLEN unilen = reguni(pRExC_state, ender, s);
9294                               if (unilen > 0) {
9295                                    s   += unilen;
9296                                    len += unilen;
9297                               }
9298                          }
9299                     }
9300                     else {
9301                         len++;
9302                         REGC((char)ender, s++);
9303                     }
9304                     break;
9305                 }
9306                 if (UTF) {
9307                      if (FOLD) {
9308                           /* Emit all the Unicode characters. */
9309                           STRLEN numlen;
9310                           for (foldbuf = tmpbuf;
9311                                foldlen;
9312                                foldlen -= numlen) {
9313                                ender = utf8_to_uvchr(foldbuf, &numlen);
9314                                if (numlen > 0) {
9315                                     const STRLEN unilen = reguni(pRExC_state, ender, s);
9316                                     len     += unilen;
9317                                     s       += unilen;
9318                                     /* In EBCDIC the numlen
9319                                      * and unilen can differ. */
9320                                     foldbuf += numlen;
9321                                     if (numlen >= foldlen)
9322                                          break;
9323                                }
9324                                else
9325                                     break;
9326                           }
9327                      }
9328                      else {
9329                           const STRLEN unilen = reguni(pRExC_state, ender, s);
9330                           if (unilen > 0) {
9331                                s   += unilen;
9332                                len += unilen;
9333                           }
9334                      }
9335                      len--;
9336                 }
9337                 else {
9338                     REGC((char)ender, s++);
9339                 }
9340             }
9341         loopdone:   /* Jumped to when encounters something that shouldn't be in
9342                        the node */
9343             RExC_parse = p - 1;
9344             Set_Node_Cur_Length(ret); /* MJD */
9345             nextchar(pRExC_state);
9346             {
9347                 /* len is STRLEN which is unsigned, need to copy to signed */
9348                 IV iv = len;
9349                 if (iv < 0)
9350                     vFAIL("Internal disaster");
9351             }
9352             if (len > 0)
9353                 *flagp |= HASWIDTH;
9354             if (len == 1 && UNI_IS_INVARIANT(ender))
9355                 *flagp |= SIMPLE;
9356                 
9357             if (SIZE_ONLY)
9358                 RExC_size += STR_SZ(len);
9359             else {
9360                 STR_LEN(ret) = len;
9361                 RExC_emit += STR_SZ(len);
9362             }
9363         }
9364         break;
9365     }
9366
9367     return(ret);
9368
9369 /* Jumped to when an unrecognized character set is encountered */
9370 bad_charset:
9371     Perl_croak(aTHX_ "panic: Unknown regex character set encoding: %u", get_regex_charset(RExC_flags));
9372     return(NULL);
9373 }
9374
9375 STATIC char *
9376 S_regwhite( RExC_state_t *pRExC_state, char *p )
9377 {
9378     const char *e = RExC_end;
9379
9380     PERL_ARGS_ASSERT_REGWHITE;
9381
9382     while (p < e) {
9383         if (isSPACE(*p))
9384             ++p;
9385         else if (*p == '#') {
9386             bool ended = 0;
9387             do {
9388                 if (*p++ == '\n') {
9389                     ended = 1;
9390                     break;
9391                 }
9392             } while (p < e);
9393             if (!ended)
9394                 RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
9395         }
9396         else
9397             break;
9398     }
9399     return p;
9400 }
9401
9402 /* Parse POSIX character classes: [[:foo:]], [[=foo=]], [[.foo.]].
9403    Character classes ([:foo:]) can also be negated ([:^foo:]).
9404    Returns a named class id (ANYOF_XXX) if successful, -1 otherwise.
9405    Equivalence classes ([=foo=]) and composites ([.foo.]) are parsed,
9406    but trigger failures because they are currently unimplemented. */
9407
9408 #define POSIXCC_DONE(c)   ((c) == ':')
9409 #define POSIXCC_NOTYET(c) ((c) == '=' || (c) == '.')
9410 #define POSIXCC(c) (POSIXCC_DONE(c) || POSIXCC_NOTYET(c))
9411
9412 STATIC I32
9413 S_regpposixcc(pTHX_ RExC_state_t *pRExC_state, I32 value)
9414 {
9415     dVAR;
9416     I32 namedclass = OOB_NAMEDCLASS;
9417
9418     PERL_ARGS_ASSERT_REGPPOSIXCC;
9419
9420     if (value == '[' && RExC_parse + 1 < RExC_end &&
9421         /* I smell either [: or [= or [. -- POSIX has been here, right? */
9422         POSIXCC(UCHARAT(RExC_parse))) {
9423         const char c = UCHARAT(RExC_parse);
9424         char* const s = RExC_parse++;
9425         
9426         while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != c)
9427             RExC_parse++;
9428         if (RExC_parse == RExC_end)
9429             /* Grandfather lone [:, [=, [. */
9430             RExC_parse = s;
9431         else {
9432             const char* const t = RExC_parse++; /* skip over the c */
9433             assert(*t == c);
9434
9435             if (UCHARAT(RExC_parse) == ']') {
9436                 const char *posixcc = s + 1;
9437                 RExC_parse++; /* skip over the ending ] */
9438
9439                 if (*s == ':') {
9440                     const I32 complement = *posixcc == '^' ? *posixcc++ : 0;
9441                     const I32 skip = t - posixcc;
9442
9443                     /* Initially switch on the length of the name.  */
9444                     switch (skip) {
9445                     case 4:
9446                         if (memEQ(posixcc, "word", 4)) /* this is not POSIX, this is the Perl \w */
9447                             namedclass = complement ? ANYOF_NALNUM : ANYOF_ALNUM;
9448                         break;
9449                     case 5:
9450                         /* Names all of length 5.  */
9451                         /* alnum alpha ascii blank cntrl digit graph lower
9452                            print punct space upper  */
9453                         /* Offset 4 gives the best switch position.  */
9454                         switch (posixcc[4]) {
9455                         case 'a':
9456                             if (memEQ(posixcc, "alph", 4)) /* alpha */
9457                                 namedclass = complement ? ANYOF_NALPHA : ANYOF_ALPHA;
9458                             break;
9459                         case 'e':
9460                             if (memEQ(posixcc, "spac", 4)) /* space */
9461                                 namedclass = complement ? ANYOF_NPSXSPC : ANYOF_PSXSPC;
9462                             break;
9463                         case 'h':
9464                             if (memEQ(posixcc, "grap", 4)) /* graph */
9465                                 namedclass = complement ? ANYOF_NGRAPH : ANYOF_GRAPH;
9466                             break;
9467                         case 'i':
9468                             if (memEQ(posixcc, "asci", 4)) /* ascii */
9469                                 namedclass = complement ? ANYOF_NASCII : ANYOF_ASCII;
9470                             break;
9471                         case 'k':
9472                             if (memEQ(posixcc, "blan", 4)) /* blank */
9473                                 namedclass = complement ? ANYOF_NBLANK : ANYOF_BLANK;
9474                             break;
9475                         case 'l':
9476                             if (memEQ(posixcc, "cntr", 4)) /* cntrl */
9477                                 namedclass = complement ? ANYOF_NCNTRL : ANYOF_CNTRL;
9478                             break;
9479                         case 'm':
9480                             if (memEQ(posixcc, "alnu", 4)) /* alnum */
9481                                 namedclass = complement ? ANYOF_NALNUMC : ANYOF_ALNUMC;
9482                             break;
9483                         case 'r':
9484                             if (memEQ(posixcc, "lowe", 4)) /* lower */
9485                                 namedclass = complement ? ANYOF_NLOWER : ANYOF_LOWER;
9486                             else if (memEQ(posixcc, "uppe", 4)) /* upper */
9487                                 namedclass = complement ? ANYOF_NUPPER : ANYOF_UPPER;
9488                             break;
9489                         case 't':
9490                             if (memEQ(posixcc, "digi", 4)) /* digit */
9491                                 namedclass = complement ? ANYOF_NDIGIT : ANYOF_DIGIT;
9492                             else if (memEQ(posixcc, "prin", 4)) /* print */
9493                                 namedclass = complement ? ANYOF_NPRINT : ANYOF_PRINT;
9494                             else if (memEQ(posixcc, "punc", 4)) /* punct */
9495                                 namedclass = complement ? ANYOF_NPUNCT : ANYOF_PUNCT;
9496                             break;
9497                         }
9498                         break;
9499                     case 6:
9500                         if (memEQ(posixcc, "xdigit", 6))
9501                             namedclass = complement ? ANYOF_NXDIGIT : ANYOF_XDIGIT;
9502                         break;
9503                     }
9504
9505                     if (namedclass == OOB_NAMEDCLASS)
9506                         Simple_vFAIL3("POSIX class [:%.*s:] unknown",
9507                                       t - s - 1, s + 1);
9508                     assert (posixcc[skip] == ':');
9509                     assert (posixcc[skip+1] == ']');
9510                 } else if (!SIZE_ONLY) {
9511                     /* [[=foo=]] and [[.foo.]] are still future. */
9512
9513                     /* adjust RExC_parse so the warning shows after
9514                        the class closes */
9515                     while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse) != ']')
9516                         RExC_parse++;
9517                     Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
9518                 }
9519             } else {
9520                 /* Maternal grandfather:
9521                  * "[:" ending in ":" but not in ":]" */
9522                 RExC_parse = s;
9523             }
9524         }
9525     }
9526
9527     return namedclass;
9528 }
9529
9530 STATIC void
9531 S_checkposixcc(pTHX_ RExC_state_t *pRExC_state)
9532 {
9533     dVAR;
9534
9535     PERL_ARGS_ASSERT_CHECKPOSIXCC;
9536
9537     if (POSIXCC(UCHARAT(RExC_parse))) {
9538         const char *s = RExC_parse;
9539         const char  c = *s++;
9540
9541         while (isALNUM(*s))
9542             s++;
9543         if (*s && c == *s && s[1] == ']') {
9544             ckWARN3reg(s+2,
9545                        "POSIX syntax [%c %c] belongs inside character classes",
9546                        c, c);
9547
9548             /* [[=foo=]] and [[.foo.]] are still future. */
9549             if (POSIXCC_NOTYET(c)) {
9550                 /* adjust RExC_parse so the error shows after
9551                    the class closes */
9552                 while (UCHARAT(RExC_parse) && UCHARAT(RExC_parse++) != ']')
9553                     NOOP;
9554                 Simple_vFAIL3("POSIX syntax [%c %c] is reserved for future extensions", c, c);
9555             }
9556         }
9557     }
9558 }
9559
9560 /* No locale test, and always Unicode semantics */
9561 #define _C_C_T_NOLOC_(NAME,TEST,WORD)                                          \
9562 ANYOF_##NAME:                                                                  \
9563         for (value = 0; value < 256; value++)                                  \
9564             if (TEST)                                                          \
9565             stored += set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);  \
9566     yesno = '+';                                                               \
9567     what = WORD;                                                               \
9568     break;                                                                     \
9569 case ANYOF_N##NAME:                                                            \
9570         for (value = 0; value < 256; value++)                                  \
9571             if (!TEST)                                                         \
9572             stored += set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);  \
9573     yesno = '!';                                                               \
9574     what = WORD;                                                               \
9575     break
9576
9577 /* Like the above, but there are differences if we are in uni-8-bit or not, so
9578  * there are two tests passed in, to use depending on that. There aren't any
9579  * cases where the label is different from the name, so no need for that
9580  * parameter */
9581 #define _C_C_T_(NAME, TEST_8, TEST_7, WORD)                                    \
9582 ANYOF_##NAME:                                                                  \
9583     if (LOC) ANYOF_CLASS_SET(ret, ANYOF_##NAME);                               \
9584     else if (UNI_SEMANTICS) {                                                  \
9585         for (value = 0; value < 256; value++) {                                \
9586             if (TEST_8(value)) stored +=                                       \
9587                       set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);  \
9588         }                                                                      \
9589     }                                                                          \
9590     else {                                                                     \
9591         for (value = 0; value < 128; value++) {                                \
9592             if (TEST_7(UNI_TO_NATIVE(value))) stored +=                        \
9593                 set_regclass_bit(pRExC_state, ret,                     \
9594                                    (U8) UNI_TO_NATIVE(value), &l1_fold_invlist, &unicode_alternate);                 \
9595         }                                                                      \
9596     }                                                                          \
9597     yesno = '+';                                                               \
9598     what = WORD;                                                               \
9599     break;                                                                     \
9600 case ANYOF_N##NAME:                                                            \
9601     if (LOC) ANYOF_CLASS_SET(ret, ANYOF_N##NAME);                              \
9602     else if (UNI_SEMANTICS) {                                                  \
9603         for (value = 0; value < 256; value++) {                                \
9604             if (! TEST_8(value)) stored +=                                     \
9605                     set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);    \
9606         }                                                                      \
9607     }                                                                          \
9608     else {                                                                     \
9609         for (value = 0; value < 128; value++) {                                \
9610             if (! TEST_7(UNI_TO_NATIVE(value))) stored += set_regclass_bit(  \
9611                         pRExC_state, ret, (U8) UNI_TO_NATIVE(value), &l1_fold_invlist, &unicode_alternate);    \
9612         }                                                                      \
9613         if (AT_LEAST_ASCII_RESTRICTED) {                                       \
9614             for (value = 128; value < 256; value++) {                          \
9615              stored += set_regclass_bit(                                     \
9616                            pRExC_state, ret, (U8) UNI_TO_NATIVE(value), &l1_fold_invlist, &unicode_alternate); \
9617             }                                                                  \
9618             ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;                             \
9619         }                                                                      \
9620         else {                                                                 \
9621             /* For a non-ut8 target string with DEPENDS semantics, all above   \
9622              * ASCII Latin1 code points match the complement of any of the     \
9623              * classes.  But in utf8, they have their Unicode semantics, so    \
9624              * can't just set them in the bitmap, or else regexec.c will think \
9625              * they matched when they shouldn't. */                            \
9626             ANYOF_FLAGS(ret) |= ANYOF_NON_UTF8_LATIN1_ALL;                     \
9627         }                                                                      \
9628     }                                                                          \
9629     yesno = '!';                                                               \
9630     what = WORD;                                                               \
9631     break
9632
9633 STATIC U8
9634 S_set_regclass_bit_fold(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
9635 {
9636
9637     /* Handle the setting of folds in the bitmap for non-locale ANYOF nodes.
9638      * Locale folding is done at run-time, so this function should not be
9639      * called for nodes that are for locales.
9640      *
9641      * This function sets the bit corresponding to the fold of the input
9642      * 'value', if not already set.  The fold of 'f' is 'F', and the fold of
9643      * 'F' is 'f'.
9644      *
9645      * It also knows about the characters that are in the bitmap that have
9646      * folds that are matchable only outside it, and sets the appropriate lists
9647      * and flags.
9648      *
9649      * It returns the number of bits that actually changed from 0 to 1 */
9650
9651     U8 stored = 0;
9652     U8 fold;
9653
9654     PERL_ARGS_ASSERT_SET_REGCLASS_BIT_FOLD;
9655
9656     fold = (AT_LEAST_UNI_SEMANTICS) ? PL_fold_latin1[value]
9657                                     : PL_fold[value];
9658
9659     /* It assumes the bit for 'value' has already been set */
9660     if (fold != value && ! ANYOF_BITMAP_TEST(node, fold)) {
9661         ANYOF_BITMAP_SET(node, fold);
9662         stored++;
9663     }
9664     if (_HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value) && (! isASCII(value) || ! MORE_ASCII_RESTRICTED)) {
9665         /* Certain Latin1 characters have matches outside the bitmap.  To get
9666          * here, 'value' is one of those characters.   None of these matches is
9667          * valid for ASCII characters under /aa, which have been excluded by
9668          * the 'if' above.  The matches fall into three categories:
9669          * 1) They are singly folded-to or -from an above 255 character, as
9670          *    LATIN SMALL LETTER Y WITH DIAERESIS and LATIN CAPITAL LETTER Y
9671          *    WITH DIAERESIS;
9672          * 2) They are part of a multi-char fold with another character in the
9673          *    bitmap, only LATIN SMALL LETTER SHARP S => "ss" fits that bill;
9674          * 3) They are part of a multi-char fold with a character not in the
9675          *    bitmap, such as various ligatures.
9676          * We aren't dealing fully with multi-char folds, except we do deal
9677          * with the pattern containing a character that has a multi-char fold
9678          * (not so much the inverse).
9679          * For types 1) and 3), the matches only happen when the target string
9680          * is utf8; that's not true for 2), and we set a flag for it.
9681          *
9682          * The code below adds to the passed in inversion list the single fold
9683          * closures for 'value'.  The values are hard-coded here so that an
9684          * innocent-looking character class, like /[ks]/i won't have to go out
9685          * to disk to find the possible matches.  XXX It would be better to
9686          * generate these via regen, in case a new version of the Unicode
9687          * standard adds new mappings, though that is not really likely. */
9688         switch (value) {
9689             case 'k':
9690             case 'K':
9691                 /* KELVIN SIGN */
9692                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212A);
9693                 break;
9694             case 's':
9695             case 'S':
9696                 /* LATIN SMALL LETTER LONG S */
9697                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x017F);
9698                 break;
9699             case MICRO_SIGN:
9700                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
9701                                                  GREEK_SMALL_LETTER_MU);
9702                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
9703                                                  GREEK_CAPITAL_LETTER_MU);
9704                 break;
9705             case LATIN_CAPITAL_LETTER_A_WITH_RING_ABOVE:
9706             case LATIN_SMALL_LETTER_A_WITH_RING_ABOVE:
9707                 /* ANGSTROM SIGN */
9708                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr, 0x212B);
9709                 if (DEPENDS_SEMANTICS) {    /* See DEPENDS comment below */
9710                     *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
9711                                                      PL_fold_latin1[value]);
9712                 }
9713                 break;
9714             case LATIN_SMALL_LETTER_Y_WITH_DIAERESIS:
9715                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
9716                                         LATIN_CAPITAL_LETTER_Y_WITH_DIAERESIS);
9717                 break;
9718             case LATIN_SMALL_LETTER_SHARP_S:
9719                 *invlist_ptr = add_cp_to_invlist(*invlist_ptr,
9720                                         LATIN_CAPITAL_LETTER_SHARP_S);
9721
9722                 /* Under /a, /d, and /u, this can match the two chars "ss" */
9723                 if (! MORE_ASCII_RESTRICTED) {
9724                     add_alternate(alternate_ptr, (U8 *) "ss", 2);
9725
9726                     /* And under /u or /a, it can match even if the target is
9727                      * not utf8 */
9728                     if (AT_LEAST_UNI_SEMANTICS) {
9729                         ANYOF_FLAGS(node) |= ANYOF_NONBITMAP_NON_UTF8;
9730                     }
9731                 }
9732                 break;
9733             case 'F': case 'f':
9734             case 'I': case 'i':
9735             case 'L': case 'l':
9736             case 'T': case 't':
9737             case 'A': case 'a':
9738             case 'H': case 'h':
9739             case 'J': case 'j':
9740             case 'N': case 'n':
9741             case 'W': case 'w':
9742             case 'Y': case 'y':
9743                 /* These all are targets of multi-character folds from code
9744                  * points that require UTF8 to express, so they can't match
9745                  * unless the target string is in UTF-8, so no action here is
9746                  * necessary, as regexec.c properly handles the general case
9747                  * for UTF-8 matching */
9748                 break;
9749             default:
9750                 /* Use deprecated warning to increase the chances of this
9751                  * being output */
9752                 ckWARN2regdep(RExC_parse, "Perl folding rules are not up-to-date for 0x%x; please use the perlbug utility to report;", value);
9753                 break;
9754         }
9755     }
9756     else if (DEPENDS_SEMANTICS
9757             && ! isASCII(value)
9758             && PL_fold_latin1[value] != value)
9759     {
9760            /* Under DEPENDS rules, non-ASCII Latin1 characters match their
9761             * folds only when the target string is in UTF-8.  We add the fold
9762             * here to the list of things to match outside the bitmap, which
9763             * won't be looked at unless it is UTF8 (or else if something else
9764             * says to look even if not utf8, but those things better not happen
9765             * under DEPENDS semantics. */
9766         *invlist_ptr = add_cp_to_invlist(*invlist_ptr, PL_fold_latin1[value]);
9767     }
9768
9769     return stored;
9770 }
9771
9772
9773 PERL_STATIC_INLINE U8
9774 S_set_regclass_bit(pTHX_ RExC_state_t *pRExC_state, regnode* node, const U8 value, SV** invlist_ptr, AV** alternate_ptr)
9775 {
9776     /* This inline function sets a bit in the bitmap if not already set, and if
9777      * appropriate, its fold, returning the number of bits that actually
9778      * changed from 0 to 1 */
9779
9780     U8 stored;
9781
9782     PERL_ARGS_ASSERT_SET_REGCLASS_BIT;
9783
9784     if (ANYOF_BITMAP_TEST(node, value)) {   /* Already set */
9785         return 0;
9786     }
9787
9788     ANYOF_BITMAP_SET(node, value);
9789     stored = 1;
9790
9791     if (FOLD && ! LOC) {        /* Locale folds aren't known until runtime */
9792         stored += set_regclass_bit_fold(pRExC_state, node, value, invlist_ptr, alternate_ptr);
9793     }
9794
9795     return stored;
9796 }
9797
9798 STATIC void
9799 S_add_alternate(pTHX_ AV** alternate_ptr, U8* string, STRLEN len)
9800 {
9801     /* Adds input 'string' with length 'len' to the ANYOF node's unicode
9802      * alternate list, pointed to by 'alternate_ptr'.  This is an array of
9803      * the multi-character folds of characters in the node */
9804     SV *sv;
9805
9806     PERL_ARGS_ASSERT_ADD_ALTERNATE;
9807
9808     if (! *alternate_ptr) {
9809         *alternate_ptr = newAV();
9810     }
9811     sv = newSVpvn_utf8((char*)string, len, TRUE);
9812     av_push(*alternate_ptr, sv);
9813     return;
9814 }
9815
9816 /*
9817    parse a class specification and produce either an ANYOF node that
9818    matches the pattern or perhaps will be optimized into an EXACTish node
9819    instead. The node contains a bit map for the first 256 characters, with the
9820    corresponding bit set if that character is in the list.  For characters
9821    above 255, a range list is used */
9822
9823 STATIC regnode *
9824 S_regclass(pTHX_ RExC_state_t *pRExC_state, U32 depth)
9825 {
9826     dVAR;
9827     register UV nextvalue;
9828     register IV prevvalue = OOB_UNICODE;
9829     register IV range = 0;
9830     UV value = 0; /* XXX:dmq: needs to be referenceable (unfortunately) */
9831     register regnode *ret;
9832     STRLEN numlen;
9833     IV namedclass;
9834     char *rangebegin = NULL;
9835     bool need_class = 0;
9836     bool allow_full_fold = TRUE;   /* Assume wants multi-char folding */
9837     SV *listsv = NULL;
9838     STRLEN initial_listsv_len = 0; /* Kind of a kludge to see if it is more
9839                                       than just initialized.  */
9840     UV n;
9841
9842     /* code points this node matches that can't be stored in the bitmap */
9843     SV* nonbitmap = NULL;
9844
9845     /* The items that are to match that aren't stored in the bitmap, but are a
9846      * result of things that are stored there.  This is the fold closure of
9847      * such a character, either because it has DEPENDS semantics and shouldn't
9848      * be matched unless the target string is utf8, or is a code point that is
9849      * too large for the bit map, as for example, the fold of the MICRO SIGN is
9850      * above 255.  This all is solely for performance reasons.  By having this
9851      * code know the outside-the-bitmap folds that the bitmapped characters are
9852      * involved with, we don't have to go out to disk to find the list of
9853      * matches, unless the character class includes code points that aren't
9854      * storable in the bit map.  That means that a character class with an 's'
9855      * in it, for example, doesn't need to go out to disk to find everything
9856      * that matches.  A 2nd list is used so that the 'nonbitmap' list is kept
9857      * empty unless there is something whose fold we don't know about, and will
9858      * have to go out to the disk to find. */
9859     SV* l1_fold_invlist = NULL;
9860
9861     /* List of multi-character folds that are matched by this node */
9862     AV* unicode_alternate  = NULL;
9863 #ifdef EBCDIC
9864     UV literal_endpoint = 0;
9865 #endif
9866     UV stored = 0;  /* how many chars stored in the bitmap */
9867
9868     regnode * const orig_emit = RExC_emit; /* Save the original RExC_emit in
9869         case we need to change the emitted regop to an EXACT. */
9870     const char * orig_parse = RExC_parse;
9871     GET_RE_DEBUG_FLAGS_DECL;
9872
9873     PERL_ARGS_ASSERT_REGCLASS;
9874 #ifndef DEBUGGING
9875     PERL_UNUSED_ARG(depth);
9876 #endif
9877
9878     DEBUG_PARSE("clas");
9879
9880     /* Assume we are going to generate an ANYOF node. */
9881     ret = reganode(pRExC_state, ANYOF, 0);
9882
9883
9884     if (!SIZE_ONLY) {
9885         ANYOF_FLAGS(ret) = 0;
9886     }
9887
9888     if (UCHARAT(RExC_parse) == '^') {   /* Complement of range. */
9889         RExC_naughty++;
9890         RExC_parse++;
9891         if (!SIZE_ONLY)
9892             ANYOF_FLAGS(ret) |= ANYOF_INVERT;
9893
9894         /* We have decided to not allow multi-char folds in inverted character
9895          * classes, due to the confusion that can happen, especially with
9896          * classes that are designed for a non-Unicode world:  You have the
9897          * peculiar case that:
9898             "s s" =~ /^[^\xDF]+$/i => Y
9899             "ss"  =~ /^[^\xDF]+$/i => N
9900          *
9901          * See [perl #89750] */
9902         allow_full_fold = FALSE;
9903     }
9904
9905     if (SIZE_ONLY) {
9906         RExC_size += ANYOF_SKIP;
9907         listsv = &PL_sv_undef; /* For code scanners: listsv always non-NULL. */
9908     }
9909     else {
9910         RExC_emit += ANYOF_SKIP;
9911         if (LOC) {
9912             ANYOF_FLAGS(ret) |= ANYOF_LOCALE;
9913         }
9914         ANYOF_BITMAP_ZERO(ret);
9915         listsv = newSVpvs("# comment\n");
9916         initial_listsv_len = SvCUR(listsv);
9917     }
9918
9919     nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
9920
9921     if (!SIZE_ONLY && POSIXCC(nextvalue))
9922         checkposixcc(pRExC_state);
9923
9924     /* allow 1st char to be ] (allowing it to be - is dealt with later) */
9925     if (UCHARAT(RExC_parse) == ']')
9926         goto charclassloop;
9927
9928 parseit:
9929     while (RExC_parse < RExC_end && UCHARAT(RExC_parse) != ']') {
9930
9931     charclassloop:
9932
9933         namedclass = OOB_NAMEDCLASS; /* initialize as illegal */
9934
9935         if (!range)
9936             rangebegin = RExC_parse;
9937         if (UTF) {
9938             value = utf8n_to_uvchr((U8*)RExC_parse,
9939                                    RExC_end - RExC_parse,
9940                                    &numlen, UTF8_ALLOW_DEFAULT);
9941             RExC_parse += numlen;
9942         }
9943         else
9944             value = UCHARAT(RExC_parse++);
9945
9946         nextvalue = RExC_parse < RExC_end ? UCHARAT(RExC_parse) : 0;
9947         if (value == '[' && POSIXCC(nextvalue))
9948             namedclass = regpposixcc(pRExC_state, value);
9949         else if (value == '\\') {
9950             if (UTF) {
9951                 value = utf8n_to_uvchr((U8*)RExC_parse,
9952                                    RExC_end - RExC_parse,
9953                                    &numlen, UTF8_ALLOW_DEFAULT);
9954                 RExC_parse += numlen;
9955             }
9956             else
9957                 value = UCHARAT(RExC_parse++);
9958             /* Some compilers cannot handle switching on 64-bit integer
9959              * values, therefore value cannot be an UV.  Yes, this will
9960              * be a problem later if we want switch on Unicode.
9961              * A similar issue a little bit later when switching on
9962              * namedclass. --jhi */
9963             switch ((I32)value) {
9964             case 'w':   namedclass = ANYOF_ALNUM;       break;
9965             case 'W':   namedclass = ANYOF_NALNUM;      break;
9966             case 's':   namedclass = ANYOF_SPACE;       break;
9967             case 'S':   namedclass = ANYOF_NSPACE;      break;
9968             case 'd':   namedclass = ANYOF_DIGIT;       break;
9969             case 'D':   namedclass = ANYOF_NDIGIT;      break;
9970             case 'v':   namedclass = ANYOF_VERTWS;      break;
9971             case 'V':   namedclass = ANYOF_NVERTWS;     break;
9972             case 'h':   namedclass = ANYOF_HORIZWS;     break;
9973             case 'H':   namedclass = ANYOF_NHORIZWS;    break;
9974             case 'N':  /* Handle \N{NAME} in class */
9975                 {
9976                     /* We only pay attention to the first char of 
9977                     multichar strings being returned. I kinda wonder
9978                     if this makes sense as it does change the behaviour
9979                     from earlier versions, OTOH that behaviour was broken
9980                     as well. */
9981                     UV v; /* value is register so we cant & it /grrr */
9982                     if (reg_namedseq(pRExC_state, &v, NULL, depth)) {
9983                         goto parseit;
9984                     }
9985                     value= v; 
9986                 }
9987                 break;
9988             case 'p':
9989             case 'P':
9990                 {
9991                 char *e;
9992                 if (RExC_parse >= RExC_end)
9993                     vFAIL2("Empty \\%c{}", (U8)value);
9994                 if (*RExC_parse == '{') {
9995                     const U8 c = (U8)value;
9996                     e = strchr(RExC_parse++, '}');
9997                     if (!e)
9998                         vFAIL2("Missing right brace on \\%c{}", c);
9999                     while (isSPACE(UCHARAT(RExC_parse)))
10000                         RExC_parse++;
10001                     if (e == RExC_parse)
10002                         vFAIL2("Empty \\%c{}", c);
10003                     n = e - RExC_parse;
10004                     while (isSPACE(UCHARAT(RExC_parse + n - 1)))
10005                         n--;
10006                 }
10007                 else {
10008                     e = RExC_parse;
10009                     n = 1;
10010                 }
10011                 if (!SIZE_ONLY) {
10012                     if (UCHARAT(RExC_parse) == '^') {
10013                          RExC_parse++;
10014                          n--;
10015                          value = value == 'p' ? 'P' : 'p'; /* toggle */
10016                          while (isSPACE(UCHARAT(RExC_parse))) {
10017                               RExC_parse++;
10018                               n--;
10019                          }
10020                     }
10021
10022                     /* Add the property name to the list.  If /i matching, give
10023                      * a different name which consists of the normal name
10024                      * sandwiched between two underscores and '_i'.  The design
10025                      * is discussed in the commit message for this. */
10026                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::%s%.*s%s\n",
10027                                         (value=='p' ? '+' : '!'),
10028                                         (FOLD) ? "__" : "",
10029                                         (int)n,
10030                                         RExC_parse,
10031                                         (FOLD) ? "_i" : ""
10032                                     );
10033                 }
10034                 RExC_parse = e + 1;
10035
10036                 /* The \p could match something in the Latin1 range, hence
10037                  * something that isn't utf8 */
10038                 ANYOF_FLAGS(ret) |= ANYOF_NONBITMAP_NON_UTF8;
10039                 namedclass = ANYOF_MAX;  /* no official name, but it's named */
10040
10041                 /* \p means they want Unicode semantics */
10042                 RExC_uni_semantics = 1;
10043                 }
10044                 break;
10045             case 'n':   value = '\n';                   break;
10046             case 'r':   value = '\r';                   break;
10047             case 't':   value = '\t';                   break;
10048             case 'f':   value = '\f';                   break;
10049             case 'b':   value = '\b';                   break;
10050             case 'e':   value = ASCII_TO_NATIVE('\033');break;
10051             case 'a':   value = ASCII_TO_NATIVE('\007');break;
10052             case 'o':
10053                 RExC_parse--;   /* function expects to be pointed at the 'o' */
10054                 {
10055                     const char* error_msg;
10056                     bool valid = grok_bslash_o(RExC_parse,
10057                                                &value,
10058                                                &numlen,
10059                                                &error_msg,
10060                                                SIZE_ONLY);
10061                     RExC_parse += numlen;
10062                     if (! valid) {
10063                         vFAIL(error_msg);
10064                     }
10065                 }
10066                 if (PL_encoding && value < 0x100) {
10067                     goto recode_encoding;
10068                 }
10069                 break;
10070             case 'x':
10071                 if (*RExC_parse == '{') {
10072                     I32 flags = PERL_SCAN_ALLOW_UNDERSCORES
10073                         | PERL_SCAN_DISALLOW_PREFIX;
10074                     char * const e = strchr(RExC_parse++, '}');
10075                     if (!e)
10076                         vFAIL("Missing right brace on \\x{}");
10077
10078                     numlen = e - RExC_parse;
10079                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10080                     RExC_parse = e + 1;
10081                 }
10082                 else {
10083                     I32 flags = PERL_SCAN_DISALLOW_PREFIX;
10084                     numlen = 2;
10085                     value = grok_hex(RExC_parse, &numlen, &flags, NULL);
10086                     RExC_parse += numlen;
10087                 }
10088                 if (PL_encoding && value < 0x100)
10089                     goto recode_encoding;
10090                 break;
10091             case 'c':
10092                 value = grok_bslash_c(*RExC_parse++, UTF, SIZE_ONLY);
10093                 break;
10094             case '0': case '1': case '2': case '3': case '4':
10095             case '5': case '6': case '7':
10096                 {
10097                     /* Take 1-3 octal digits */
10098                     I32 flags = PERL_SCAN_SILENT_ILLDIGIT;
10099                     numlen = 3;
10100                     value = grok_oct(--RExC_parse, &numlen, &flags, NULL);
10101                     RExC_parse += numlen;
10102                     if (PL_encoding && value < 0x100)
10103                         goto recode_encoding;
10104                     break;
10105                 }
10106             recode_encoding:
10107                 if (! RExC_override_recoding) {
10108                     SV* enc = PL_encoding;
10109                     value = reg_recode((const char)(U8)value, &enc);
10110                     if (!enc && SIZE_ONLY)
10111                         ckWARNreg(RExC_parse,
10112                                   "Invalid escape in the specified encoding");
10113                     break;
10114                 }
10115             default:
10116                 /* Allow \_ to not give an error */
10117                 if (!SIZE_ONLY && isALNUM(value) && value != '_') {
10118                     ckWARN2reg(RExC_parse,
10119                                "Unrecognized escape \\%c in character class passed through",
10120                                (int)value);
10121                 }
10122                 break;
10123             }
10124         } /* end of \blah */
10125 #ifdef EBCDIC
10126         else
10127             literal_endpoint++;
10128 #endif
10129
10130         if (namedclass > OOB_NAMEDCLASS) { /* this is a named class \blah */
10131
10132             /* What matches in a locale is not known until runtime, so need to
10133              * (one time per class) allocate extra space to pass to regexec.
10134              * The space will contain a bit for each named class that is to be
10135              * matched against.  This isn't needed for \p{} and pseudo-classes,
10136              * as they are not affected by locale, and hence are dealt with
10137              * separately */
10138             if (LOC && namedclass < ANYOF_MAX && ! need_class) {
10139                 need_class = 1;
10140                 if (SIZE_ONLY) {
10141                     RExC_size += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10142                 }
10143                 else {
10144                     RExC_emit += ANYOF_CLASS_SKIP - ANYOF_SKIP;
10145                     ANYOF_CLASS_ZERO(ret);
10146                 }
10147                 ANYOF_FLAGS(ret) |= ANYOF_CLASS;
10148             }
10149
10150             /* a bad range like a-\d, a-[:digit:].  The '-' is taken as a
10151              * literal, as is the character that began the false range, i.e.
10152              * the 'a' in the examples */
10153             if (range) {
10154                 if (!SIZE_ONLY) {
10155                     const int w =
10156                         RExC_parse >= rangebegin ?
10157                         RExC_parse - rangebegin : 0;
10158                     ckWARN4reg(RExC_parse,
10159                                "False [] range \"%*.*s\"",
10160                                w, w, rangebegin);
10161
10162                     stored +=
10163                          set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
10164                     if (prevvalue < 256) {
10165                         stored +=
10166                          set_regclass_bit(pRExC_state, ret, (U8) prevvalue, &l1_fold_invlist, &unicode_alternate);
10167                     }
10168                     else {
10169                         nonbitmap = add_cp_to_invlist(nonbitmap, prevvalue);
10170                     }
10171                 }
10172
10173                 range = 0; /* this was not a true range */
10174             }
10175
10176
10177     
10178             if (!SIZE_ONLY) {
10179                 const char *what = NULL;
10180                 char yesno = 0;
10181
10182                 /* Possible truncation here but in some 64-bit environments
10183                  * the compiler gets heartburn about switch on 64-bit values.
10184                  * A similar issue a little earlier when switching on value.
10185                  * --jhi */
10186                 switch ((I32)namedclass) {
10187                 
10188                 case _C_C_T_(ALNUMC, isALNUMC_L1, isALNUMC, "XPosixAlnum");
10189                 case _C_C_T_(ALPHA, isALPHA_L1, isALPHA, "XPosixAlpha");
10190                 case _C_C_T_(BLANK, isBLANK_L1, isBLANK, "XPosixBlank");
10191                 case _C_C_T_(CNTRL, isCNTRL_L1, isCNTRL, "XPosixCntrl");
10192                 case _C_C_T_(GRAPH, isGRAPH_L1, isGRAPH, "XPosixGraph");
10193                 case _C_C_T_(LOWER, isLOWER_L1, isLOWER, "XPosixLower");
10194                 case _C_C_T_(PRINT, isPRINT_L1, isPRINT, "XPosixPrint");
10195                 case _C_C_T_(PSXSPC, isPSXSPC_L1, isPSXSPC, "XPosixSpace");
10196                 case _C_C_T_(PUNCT, isPUNCT_L1, isPUNCT, "XPosixPunct");
10197                 case _C_C_T_(UPPER, isUPPER_L1, isUPPER, "XPosixUpper");
10198                 /* \s, \w match all unicode if utf8. */
10199                 case _C_C_T_(SPACE, isSPACE_L1, isSPACE, "SpacePerl");
10200                 case _C_C_T_(ALNUM, isWORDCHAR_L1, isALNUM, "Word");
10201                 case _C_C_T_(XDIGIT, isXDIGIT_L1, isXDIGIT, "XPosixXDigit");
10202                 case _C_C_T_NOLOC_(VERTWS, is_VERTWS_latin1(&value), "VertSpace");
10203                 case _C_C_T_NOLOC_(HORIZWS, is_HORIZWS_latin1(&value), "HorizSpace");
10204                 case ANYOF_ASCII:
10205                     if (LOC)
10206                         ANYOF_CLASS_SET(ret, ANYOF_ASCII);
10207                     else {
10208                         for (value = 0; value < 128; value++)
10209                             stored +=
10210                               set_regclass_bit(pRExC_state, ret, (U8) ASCII_TO_NATIVE(value), &l1_fold_invlist, &unicode_alternate);
10211                     }
10212                     yesno = '+';
10213                     what = NULL;        /* Doesn't match outside ascii, so
10214                                            don't want to add +utf8:: */
10215                     break;
10216                 case ANYOF_NASCII:
10217                     if (LOC)
10218                         ANYOF_CLASS_SET(ret, ANYOF_NASCII);
10219                     else {
10220                         for (value = 128; value < 256; value++)
10221                             stored +=
10222                               set_regclass_bit(pRExC_state, ret, (U8) ASCII_TO_NATIVE(value), &l1_fold_invlist, &unicode_alternate);
10223                     }
10224                     ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
10225                     yesno = '!';
10226                     what = "ASCII";
10227                     break;              
10228                 case ANYOF_DIGIT:
10229                     if (LOC)
10230                         ANYOF_CLASS_SET(ret, ANYOF_DIGIT);
10231                     else {
10232                         /* consecutive digits assumed */
10233                         for (value = '0'; value <= '9'; value++)
10234                             stored +=
10235                               set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);
10236                     }
10237                     yesno = '+';
10238                     what = "Digit";
10239                     break;
10240                 case ANYOF_NDIGIT:
10241                     if (LOC)
10242                         ANYOF_CLASS_SET(ret, ANYOF_NDIGIT);
10243                     else {
10244                         /* consecutive digits assumed */
10245                         for (value = 0; value < '0'; value++)
10246                             stored +=
10247                               set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);
10248                         for (value = '9' + 1; value < 256; value++)
10249                             stored +=
10250                               set_regclass_bit(pRExC_state, ret, (U8) value, &l1_fold_invlist, &unicode_alternate);
10251                     }
10252                     yesno = '!';
10253                     what = "Digit";
10254                     if (AT_LEAST_ASCII_RESTRICTED ) {
10255                         ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
10256                     }
10257                     break;              
10258                 case ANYOF_MAX:
10259                     /* this is to handle \p and \P */
10260                     break;
10261                 default:
10262                     vFAIL("Invalid [::] class");
10263                     break;
10264                 }
10265                 if (what && ! (AT_LEAST_ASCII_RESTRICTED)) {
10266                     /* Strings such as "+utf8::isWord\n" */
10267                     Perl_sv_catpvf(aTHX_ listsv, "%cutf8::Is%s\n", yesno, what);
10268                 }
10269
10270                 continue;
10271             }
10272         } /* end of namedclass \blah */
10273
10274         if (range) {
10275             if (prevvalue > (IV)value) /* b-a */ {
10276                 const int w = RExC_parse - rangebegin;
10277                 Simple_vFAIL4("Invalid [] range \"%*.*s\"", w, w, rangebegin);
10278                 range = 0; /* not a valid range */
10279             }
10280         }
10281         else {
10282             prevvalue = value; /* save the beginning of the range */
10283             if (RExC_parse+1 < RExC_end
10284                 && *RExC_parse == '-'
10285                 && RExC_parse[1] != ']')
10286             {
10287                 RExC_parse++;
10288
10289                 /* a bad range like \w-, [:word:]- ? */
10290                 if (namedclass > OOB_NAMEDCLASS) {
10291                     if (ckWARN(WARN_REGEXP)) {
10292                         const int w =
10293                             RExC_parse >= rangebegin ?
10294                             RExC_parse - rangebegin : 0;
10295                         vWARN4(RExC_parse,
10296                                "False [] range \"%*.*s\"",
10297                                w, w, rangebegin);
10298                     }
10299                     if (!SIZE_ONLY)
10300                         stored +=
10301                             set_regclass_bit(pRExC_state, ret, '-', &l1_fold_invlist, &unicode_alternate);
10302                 } else
10303                     range = 1;  /* yeah, it's a range! */
10304                 continue;       /* but do it the next time */
10305             }
10306         }
10307
10308         /* non-Latin1 code point implies unicode semantics.  Must be set in
10309          * pass1 so is there for the whole of pass 2 */
10310         if (value > 255) {
10311             RExC_uni_semantics = 1;
10312         }
10313
10314         /* now is the next time */
10315         if (!SIZE_ONLY) {
10316             if (prevvalue < 256) {
10317                 const IV ceilvalue = value < 256 ? value : 255;
10318                 IV i;
10319 #ifdef EBCDIC
10320                 /* In EBCDIC [\x89-\x91] should include
10321                  * the \x8e but [i-j] should not. */
10322                 if (literal_endpoint == 2 &&
10323                     ((isLOWER(prevvalue) && isLOWER(ceilvalue)) ||
10324                      (isUPPER(prevvalue) && isUPPER(ceilvalue))))
10325                 {
10326                     if (isLOWER(prevvalue)) {
10327                         for (i = prevvalue; i <= ceilvalue; i++)
10328                             if (isLOWER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
10329                                 stored +=
10330                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
10331                             }
10332                     } else {
10333                         for (i = prevvalue; i <= ceilvalue; i++)
10334                             if (isUPPER(i) && !ANYOF_BITMAP_TEST(ret,i)) {
10335                                 stored +=
10336                                   set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
10337                             }
10338                     }
10339                 }
10340                 else
10341 #endif
10342                       for (i = prevvalue; i <= ceilvalue; i++) {
10343                         stored += set_regclass_bit(pRExC_state, ret, (U8) i, &l1_fold_invlist, &unicode_alternate);
10344                       }
10345           }
10346           if (value > 255) {
10347             const UV prevnatvalue  = NATIVE_TO_UNI(prevvalue);
10348             const UV natvalue      = NATIVE_TO_UNI(value);
10349             nonbitmap = add_range_to_invlist(nonbitmap, prevnatvalue, natvalue);
10350         }
10351 #ifdef EBCDIC
10352             literal_endpoint = 0;
10353 #endif
10354         }
10355
10356         range = 0; /* this range (if it was one) is done now */
10357     }
10358
10359
10360
10361     if (SIZE_ONLY)
10362         return ret;
10363     /****** !SIZE_ONLY AFTER HERE *********/
10364
10365     /* If folding and there are code points above 255, we calculate all
10366      * characters that could fold to or from the ones already on the list */
10367     if (FOLD && nonbitmap) {
10368         UV start, end;  /* End points of code point ranges */
10369
10370         SV* fold_intersection;
10371
10372         /* This is a list of all the characters that participate in folds
10373             * (except marks, etc in multi-char folds */
10374         if (! PL_utf8_foldable) {
10375             SV* swash = swash_init("utf8", "Cased", &PL_sv_undef, 1, 0);
10376             PL_utf8_foldable = _swash_to_invlist(swash);
10377         }
10378
10379         /* This is a hash that for a particular fold gives all characters
10380             * that are involved in it */
10381         if (! PL_utf8_foldclosures) {
10382
10383             /* If we were unable to find any folds, then we likely won't be
10384              * able to find the closures.  So just create an empty list.
10385              * Folding will effectively be restricted to the non-Unicode rules
10386              * hard-coded into Perl.  (This case happens legitimately during
10387              * compilation of Perl itself before the Unicode tables are
10388              * generated) */
10389             if (invlist_len(PL_utf8_foldable) == 0) {
10390                 PL_utf8_foldclosures = newHV();
10391             } else {
10392                 /* If the folds haven't been read in, call a fold function
10393                     * to force that */
10394                 if (! PL_utf8_tofold) {
10395                     U8 dummy[UTF8_MAXBYTES+1];
10396                     STRLEN dummy_len;
10397                     to_utf8_fold((U8*) "A", dummy, &dummy_len);
10398                 }
10399                 PL_utf8_foldclosures = _swash_inversion_hash(PL_utf8_tofold);
10400             }
10401         }
10402
10403         /* Only the characters in this class that participate in folds need
10404             * be checked.  Get the intersection of this class and all the
10405             * possible characters that are foldable.  This can quickly narrow
10406             * down a large class */
10407         _invlist_intersection(PL_utf8_foldable, nonbitmap, &fold_intersection);
10408
10409         /* Now look at the foldable characters in this class individually */
10410         invlist_iterinit(fold_intersection);
10411         while (invlist_iternext(fold_intersection, &start, &end)) {
10412             UV j;
10413
10414             /* Look at every character in the range */
10415             for (j = start; j <= end; j++) {
10416
10417                 /* Get its fold */
10418                 U8 foldbuf[UTF8_MAXBYTES_CASE+1];
10419                 STRLEN foldlen;
10420                 const UV f =
10421                     _to_uni_fold_flags(j, foldbuf, &foldlen, allow_full_fold);
10422
10423                 if (foldlen > (STRLEN)UNISKIP(f)) {
10424
10425                     /* Any multicharacter foldings (disallowed in
10426                         * lookbehind patterns) require the following
10427                         * transform: [ABCDEF] -> (?:[ABCabcDEFd]|pq|rst) where
10428                         * E folds into "pq" and F folds into "rst", all other
10429                         * characters fold to single characters.  We save away
10430                         * these multicharacter foldings, to be later saved as
10431                         * part of the additional "s" data. */
10432                     if (! RExC_in_lookbehind) {
10433                         U8* loc = foldbuf;
10434                         U8* e = foldbuf + foldlen;
10435
10436                         /* If any of the folded characters of this are in
10437                             * the Latin1 range, tell the regex engine that
10438                             * this can match a non-utf8 target string.  The
10439                             * only multi-byte fold whose source is in the
10440                             * Latin1 range (U+00DF) applies only when the
10441                             * target string is utf8, or under unicode rules */
10442                         if (j > 255 || AT_LEAST_UNI_SEMANTICS) {
10443                             while (loc < e) {
10444
10445                                 /* Can't mix ascii with non- under /aa */
10446                                 if (MORE_ASCII_RESTRICTED
10447                                     && (isASCII(*loc) != isASCII(j)))
10448                                 {
10449                                     goto end_multi_fold;
10450                                 }
10451                                 if (UTF8_IS_INVARIANT(*loc)
10452                                     || UTF8_IS_DOWNGRADEABLE_START(*loc))
10453                                 {
10454                                     /* Can't mix above and below 256 under
10455                                         * LOC */
10456                                     if (LOC) {
10457                                         goto end_multi_fold;
10458                                     }
10459                                     ANYOF_FLAGS(ret)
10460                                             |= ANYOF_NONBITMAP_NON_UTF8;
10461                                     break;
10462                                 }
10463                                 loc += UTF8SKIP(loc);
10464                             }
10465                         }
10466
10467                         add_alternate(&unicode_alternate, foldbuf, foldlen);
10468                     end_multi_fold: ;
10469                     }
10470
10471                     /* This is special-cased, as it is the only letter which
10472                      * has both a multi-fold and single-fold in Latin1.  All
10473                      * the other chars that have single and multi-folds are
10474                      * always in utf8, and the utf8 folding algorithm catches
10475                      * them */
10476                     if (! LOC && j == LATIN_CAPITAL_LETTER_SHARP_S) {
10477                         stored += set_regclass_bit(pRExC_state,
10478                                         ret,
10479                                         LATIN_SMALL_LETTER_SHARP_S,
10480                                         &l1_fold_invlist, &unicode_alternate);
10481                     }
10482                 }
10483                 else {
10484                     /* Single character fold.  Add everything in its fold
10485                         * closure to the list that this node should match */
10486                     SV** listp;
10487
10488                     /* The fold closures data structure is a hash with the
10489                         * keys being every character that is folded to, like
10490                         * 'k', and the values each an array of everything that
10491                         * folds to its key.  e.g. [ 'k', 'K', KELVIN_SIGN ] */
10492                     if ((listp = hv_fetch(PL_utf8_foldclosures,
10493                                     (char *) foldbuf, foldlen, FALSE)))
10494                     {
10495                         AV* list = (AV*) *listp;
10496                         IV k;
10497                         for (k = 0; k <= av_len(list); k++) {
10498                             SV** c_p = av_fetch(list, k, FALSE);
10499                             UV c;
10500                             if (c_p == NULL) {
10501                                 Perl_croak(aTHX_ "panic: invalid PL_utf8_foldclosures structure");
10502                             }
10503                             c = SvUV(*c_p);
10504
10505                             /* /aa doesn't allow folds between ASCII and
10506                                 * non-; /l doesn't allow them between above
10507                                 * and below 256 */
10508                             if ((MORE_ASCII_RESTRICTED
10509                                  && (isASCII(c) != isASCII(j)))
10510                                     || (LOC && ((c < 256) != (j < 256))))
10511                             {
10512                                 continue;
10513                             }
10514
10515                             if (c < 256 && AT_LEAST_UNI_SEMANTICS) {
10516                                 stored += set_regclass_bit(pRExC_state,
10517                                         ret,
10518                                         (U8) c,
10519                                         &l1_fold_invlist, &unicode_alternate);
10520                             }
10521                                 /* It may be that the code point is already
10522                                     * in this range or already in the bitmap,
10523                                     * in which case we need do nothing */
10524                             else if ((c < start || c > end)
10525                                         && (c > 255
10526                                             || ! ANYOF_BITMAP_TEST(ret, c)))
10527                             {
10528                                 nonbitmap = add_cp_to_invlist(nonbitmap, c);
10529                             }
10530                         }
10531                     }
10532                 }
10533             }
10534         }
10535         SvREFCNT_dec(fold_intersection);
10536     }
10537
10538     /* Combine the two lists into one. */
10539     if (l1_fold_invlist) {
10540         if (nonbitmap) {
10541             _invlist_union(nonbitmap, l1_fold_invlist, &nonbitmap);
10542             SvREFCNT_dec(l1_fold_invlist);
10543         }
10544         else {
10545             nonbitmap = l1_fold_invlist;
10546         }
10547     }
10548
10549     /* Here, we have calculated what code points should be in the character
10550      * class.   Now we can see about various optimizations.  Fold calculation
10551      * needs to take place before inversion.  Otherwise /[^k]/i would invert to
10552      * include K, which under /i would match k. */
10553
10554     /* Optimize inverted simple patterns (e.g. [^a-z]).  Note that we haven't
10555      * set the FOLD flag yet, so this this does optimize those.  It doesn't
10556      * optimize locale.  Doing so perhaps could be done as long as there is
10557      * nothing like \w in it; some thought also would have to be given to the
10558      * interaction with above 0x100 chars */
10559     if (! LOC
10560         && (ANYOF_FLAGS(ret) & ANYOF_INVERT)
10561         && ! unicode_alternate
10562         /* In case of /d, there are some things that should match only when in
10563          * not in the bitmap, i.e., they require UTF8 to match.  These are
10564          * listed in nonbitmap. */
10565         && (! nonbitmap
10566             || ! DEPENDS_SEMANTICS
10567             || (ANYOF_FLAGS(ret) & ANYOF_NONBITMAP_NON_UTF8))
10568         && SvCUR(listsv) == initial_listsv_len)
10569     {
10570         if (! nonbitmap) {
10571             for (value = 0; value < ANYOF_BITMAP_SIZE; ++value)
10572                 ANYOF_BITMAP(ret)[value] ^= 0xFF;
10573             /* The inversion means that everything above 255 is matched */
10574             ANYOF_FLAGS(ret) |= ANYOF_UNICODE_ALL;
10575         }
10576         else {
10577             /* Here, also has things outside the bitmap.  Go through each bit
10578              * individually and add it to the list to get rid of from those
10579              * things not in the bitmap */
10580             SV *remove_list = _new_invlist(2);
10581             _invlist_invert(nonbitmap);
10582             for (value = 0; value < 256; ++value) {
10583                 if (ANYOF_BITMAP_TEST(ret, value)) {
10584                     ANYOF_BITMAP_CLEAR(ret, value);
10585                     remove_list = add_cp_to_invlist(remove_list, value);
10586                 }
10587                 else {
10588                     ANYOF_BITMAP_SET(ret, value);
10589                 }
10590             }
10591             _invlist_subtract(nonbitmap, remove_list, &nonbitmap);
10592             SvREFCNT_dec(remove_list);
10593         }
10594
10595         stored = 256 - stored;
10596
10597         /* Clear the invert flag since have just done it here */
10598         ANYOF_FLAGS(ret) &= ~ANYOF_INVERT;
10599     }
10600
10601     /* Folding in the bitmap is taken care of above, but not for locale (for
10602      * which we have to wait to see what folding is in effect at runtime), and
10603      * for things not in the bitmap.  Set run-time fold flag for these */
10604     if (FOLD && (LOC || nonbitmap || unicode_alternate)) {
10605         ANYOF_FLAGS(ret) |= ANYOF_LOC_NONBITMAP_FOLD;
10606     }
10607
10608     /* A single character class can be "optimized" into an EXACTish node.
10609      * Note that since we don't currently count how many characters there are
10610      * outside the bitmap, we are XXX missing optimization possibilities for
10611      * them.  This optimization can't happen unless this is a truly single
10612      * character class, which means that it can't be an inversion into a
10613      * many-character class, and there must be no possibility of there being
10614      * things outside the bitmap.  'stored' (only) for locales doesn't include
10615      * \w, etc, so have to make a special test that they aren't present
10616      *
10617      * Similarly A 2-character class of the very special form like [bB] can be
10618      * optimized into an EXACTFish node, but only for non-locales, and for
10619      * characters which only have the two folds; so things like 'fF' and 'Ii'
10620      * wouldn't work because they are part of the fold of 'LATIN SMALL LIGATURE
10621      * FI'. */
10622     if (! nonbitmap
10623         && ! unicode_alternate
10624         && SvCUR(listsv) == initial_listsv_len
10625         && ! (ANYOF_FLAGS(ret) & (ANYOF_INVERT|ANYOF_UNICODE_ALL))
10626         && (((stored == 1 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
10627                               || (! ANYOF_CLASS_TEST_ANY_SET(ret)))))
10628             || (stored == 2 && ((! (ANYOF_FLAGS(ret) & ANYOF_LOCALE))
10629                                  && (! _HAS_NONLATIN1_FOLD_CLOSURE_ONLY_FOR_USE_BY_REGCOMP_DOT_C_AND_REGEXEC_DOT_C(value))
10630                                  /* If the latest code point has a fold whose
10631                                   * bit is set, it must be the only other one */
10632                                 && ((prevvalue = PL_fold_latin1[value]) != (IV)value)
10633                                  && ANYOF_BITMAP_TEST(ret, prevvalue)))))
10634     {
10635         /* Note that the information needed to decide to do this optimization
10636          * is not currently available until the 2nd pass, and that the actually
10637          * used EXACTish node takes less space than the calculated ANYOF node,
10638          * and hence the amount of space calculated in the first pass is larger
10639          * than actually used, so this optimization doesn't gain us any space.
10640          * But an EXACT node is faster than an ANYOF node, and can be combined
10641          * with any adjacent EXACT nodes later by the optimizer for further
10642          * gains.  The speed of executing an EXACTF is similar to an ANYOF
10643          * node, so the optimization advantage comes from the ability to join
10644          * it to adjacent EXACT nodes */
10645
10646         const char * cur_parse= RExC_parse;
10647         U8 op;
10648         RExC_emit = (regnode *)orig_emit;
10649         RExC_parse = (char *)orig_parse;
10650
10651         if (stored == 1) {
10652
10653             /* A locale node with one point can be folded; all the other cases
10654              * with folding will have two points, since we calculate them above
10655              */
10656             if (ANYOF_FLAGS(ret) & ANYOF_LOC_NONBITMAP_FOLD) {
10657                  op = EXACTFL;
10658             }
10659             else {
10660                 op = EXACT;
10661             }
10662         }   /* else 2 chars in the bit map: the folds of each other */
10663         else if (AT_LEAST_UNI_SEMANTICS || !isASCII(value)) {
10664
10665             /* To join adjacent nodes, they must be the exact EXACTish type.
10666              * Try to use the most likely type, by using EXACTFU if the regex
10667              * calls for them, or is required because the character is
10668              * non-ASCII */
10669             op = EXACTFU;
10670         }
10671         else {    /* Otherwise, more likely to be EXACTF type */
10672             op = EXACTF;
10673         }
10674
10675         ret = reg_node(pRExC_state, op);
10676         RExC_parse = (char *)cur_parse;
10677         if (UTF && ! NATIVE_IS_INVARIANT(value)) {
10678             *STRING(ret)= UTF8_EIGHT_BIT_HI((U8) value);
10679             *(STRING(ret) + 1)= UTF8_EIGHT_BIT_LO((U8) value);
10680             STR_LEN(ret)= 2;
10681             RExC_emit += STR_SZ(2);
10682         }
10683         else {
10684             *STRING(ret)= (char)value;
10685             STR_LEN(ret)= 1;
10686             RExC_emit += STR_SZ(1);
10687         }
10688         SvREFCNT_dec(listsv);
10689         return ret;
10690     }
10691
10692     if (nonbitmap) {
10693         UV start, end;
10694         invlist_iterinit(nonbitmap);
10695         while (invlist_iternext(nonbitmap, &start, &end)) {
10696             if (start == end) {
10697                 Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\n", start);
10698             }
10699             else {
10700                 /* The \t sets the whole range */
10701                 Perl_sv_catpvf(aTHX_ listsv, "%04"UVxf"\t%04"UVxf"\n",
10702                         /* XXX EBCDIC */
10703                                    start, end);
10704             }
10705         }
10706         SvREFCNT_dec(nonbitmap);
10707     }
10708
10709     if (SvCUR(listsv) == initial_listsv_len && ! unicode_alternate) {
10710         ARG_SET(ret, ANYOF_NONBITMAP_EMPTY);
10711         SvREFCNT_dec(listsv);
10712         SvREFCNT_dec(unicode_alternate);
10713     }
10714     else {
10715
10716         AV * const av = newAV();
10717         SV *rv;
10718         /* The 0th element stores the character class description
10719          * in its textual form: used later (regexec.c:Perl_regclass_swash())
10720          * to initialize the appropriate swash (which gets stored in
10721          * the 1st element), and also useful for dumping the regnode.
10722          * The 2nd element stores the multicharacter foldings,
10723          * used later (regexec.c:S_reginclass()). */
10724         av_store(av, 0, listsv);
10725         av_store(av, 1, NULL);
10726
10727         /* Store any computed multi-char folds only if we are allowing
10728          * them */
10729         if (allow_full_fold) {
10730             av_store(av, 2, MUTABLE_SV(unicode_alternate));
10731             if (unicode_alternate) { /* This node is variable length */
10732                 OP(ret) = ANYOFV;
10733             }
10734         }
10735         else {
10736             av_store(av, 2, NULL);
10737         }
10738         rv = newRV_noinc(MUTABLE_SV(av));
10739         n = add_data(pRExC_state, 1, "s");
10740         RExC_rxi->data->data[n] = (void*)rv;
10741         ARG_SET(ret, n);
10742     }
10743     return ret;
10744 }
10745 #undef _C_C_T_
10746
10747
10748 /* reg_skipcomment()
10749
10750    Absorbs an /x style # comments from the input stream.
10751    Returns true if there is more text remaining in the stream.
10752    Will set the REG_SEEN_RUN_ON_COMMENT flag if the comment
10753    terminates the pattern without including a newline.
10754
10755    Note its the callers responsibility to ensure that we are
10756    actually in /x mode
10757
10758 */
10759
10760 STATIC bool
10761 S_reg_skipcomment(pTHX_ RExC_state_t *pRExC_state)
10762 {
10763     bool ended = 0;
10764
10765     PERL_ARGS_ASSERT_REG_SKIPCOMMENT;
10766
10767     while (RExC_parse < RExC_end)
10768         if (*RExC_parse++ == '\n') {
10769             ended = 1;
10770             break;
10771         }
10772     if (!ended) {
10773         /* we ran off the end of the pattern without ending
10774            the comment, so we have to add an \n when wrapping */
10775         RExC_seen |= REG_SEEN_RUN_ON_COMMENT;
10776         return 0;
10777     } else
10778         return 1;
10779 }
10780
10781 /* nextchar()
10782
10783    Advances the parse position, and optionally absorbs
10784    "whitespace" from the inputstream.
10785
10786    Without /x "whitespace" means (?#...) style comments only,
10787    with /x this means (?#...) and # comments and whitespace proper.
10788
10789    Returns the RExC_parse point from BEFORE the scan occurs.
10790
10791    This is the /x friendly way of saying RExC_parse++.
10792 */
10793
10794 STATIC char*
10795 S_nextchar(pTHX_ RExC_state_t *pRExC_state)
10796 {
10797     char* const retval = RExC_parse++;
10798
10799     PERL_ARGS_ASSERT_NEXTCHAR;
10800
10801     for (;;) {
10802         if (*RExC_parse == '(' && RExC_parse[1] == '?' &&
10803                 RExC_parse[2] == '#') {
10804             while (*RExC_parse != ')') {
10805                 if (RExC_parse == RExC_end)
10806                     FAIL("Sequence (?#... not terminated");
10807                 RExC_parse++;
10808             }
10809             RExC_parse++;
10810             continue;
10811         }
10812         if (RExC_flags & RXf_PMf_EXTENDED) {
10813             if (isSPACE(*RExC_parse)) {
10814                 RExC_parse++;
10815                 continue;
10816             }
10817             else if (*RExC_parse == '#') {
10818                 if ( reg_skipcomment( pRExC_state ) )
10819                     continue;
10820             }
10821         }
10822         return retval;
10823     }
10824 }
10825
10826 /*
10827 - reg_node - emit a node
10828 */
10829 STATIC regnode *                        /* Location. */
10830 S_reg_node(pTHX_ RExC_state_t *pRExC_state, U8 op)
10831 {
10832     dVAR;
10833     register regnode *ptr;
10834     regnode * const ret = RExC_emit;
10835     GET_RE_DEBUG_FLAGS_DECL;
10836
10837     PERL_ARGS_ASSERT_REG_NODE;
10838
10839     if (SIZE_ONLY) {
10840         SIZE_ALIGN(RExC_size);
10841         RExC_size += 1;
10842         return(ret);
10843     }
10844     if (RExC_emit >= RExC_emit_bound)
10845         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d", op);
10846
10847     NODE_ALIGN_FILL(ret);
10848     ptr = ret;
10849     FILL_ADVANCE_NODE(ptr, op);
10850     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 1);
10851 #ifdef RE_TRACK_PATTERN_OFFSETS
10852     if (RExC_offsets) {         /* MJD */
10853         MJD_OFFSET_DEBUG(("%s:%d: (op %s) %s %"UVuf" (len %"UVuf") (max %"UVuf").\n", 
10854               "reg_node", __LINE__, 
10855               PL_reg_name[op],
10856               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] 
10857                 ? "Overwriting end of array!\n" : "OK",
10858               (UV)(RExC_emit - RExC_emit_start),
10859               (UV)(RExC_parse - RExC_start),
10860               (UV)RExC_offsets[0])); 
10861         Set_Node_Offset(RExC_emit, RExC_parse + (op == END));
10862     }
10863 #endif
10864     RExC_emit = ptr;
10865     return(ret);
10866 }
10867
10868 /*
10869 - reganode - emit a node with an argument
10870 */
10871 STATIC regnode *                        /* Location. */
10872 S_reganode(pTHX_ RExC_state_t *pRExC_state, U8 op, U32 arg)
10873 {
10874     dVAR;
10875     register regnode *ptr;
10876     regnode * const ret = RExC_emit;
10877     GET_RE_DEBUG_FLAGS_DECL;
10878
10879     PERL_ARGS_ASSERT_REGANODE;
10880
10881     if (SIZE_ONLY) {
10882         SIZE_ALIGN(RExC_size);
10883         RExC_size += 2;
10884         /* 
10885            We can't do this:
10886            
10887            assert(2==regarglen[op]+1); 
10888         
10889            Anything larger than this has to allocate the extra amount.
10890            If we changed this to be:
10891            
10892            RExC_size += (1 + regarglen[op]);
10893            
10894            then it wouldn't matter. Its not clear what side effect
10895            might come from that so its not done so far.
10896            -- dmq
10897         */
10898         return(ret);
10899     }
10900     if (RExC_emit >= RExC_emit_bound)
10901         Perl_croak(aTHX_ "panic: reg_node overrun trying to emit %d", op);
10902
10903     NODE_ALIGN_FILL(ret);
10904     ptr = ret;
10905     FILL_ADVANCE_NODE_ARG(ptr, op, arg);
10906     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (ptr) - 2);
10907 #ifdef RE_TRACK_PATTERN_OFFSETS
10908     if (RExC_offsets) {         /* MJD */
10909         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
10910               "reganode",
10911               __LINE__,
10912               PL_reg_name[op],
10913               (UV)(RExC_emit - RExC_emit_start) > RExC_offsets[0] ? 
10914               "Overwriting end of array!\n" : "OK",
10915               (UV)(RExC_emit - RExC_emit_start),
10916               (UV)(RExC_parse - RExC_start),
10917               (UV)RExC_offsets[0])); 
10918         Set_Cur_Node_Offset;
10919     }
10920 #endif            
10921     RExC_emit = ptr;
10922     return(ret);
10923 }
10924
10925 /*
10926 - reguni - emit (if appropriate) a Unicode character
10927 */
10928 STATIC STRLEN
10929 S_reguni(pTHX_ const RExC_state_t *pRExC_state, UV uv, char* s)
10930 {
10931     dVAR;
10932
10933     PERL_ARGS_ASSERT_REGUNI;
10934
10935     return SIZE_ONLY ? UNISKIP(uv) : (uvchr_to_utf8((U8*)s, uv) - (U8*)s);
10936 }
10937
10938 /*
10939 - reginsert - insert an operator in front of already-emitted operand
10940 *
10941 * Means relocating the operand.
10942 */
10943 STATIC void
10944 S_reginsert(pTHX_ RExC_state_t *pRExC_state, U8 op, regnode *opnd, U32 depth)
10945 {
10946     dVAR;
10947     register regnode *src;
10948     register regnode *dst;
10949     register regnode *place;
10950     const int offset = regarglen[(U8)op];
10951     const int size = NODE_STEP_REGNODE + offset;
10952     GET_RE_DEBUG_FLAGS_DECL;
10953
10954     PERL_ARGS_ASSERT_REGINSERT;
10955     PERL_UNUSED_ARG(depth);
10956 /* (PL_regkind[(U8)op] == CURLY ? EXTRA_STEP_2ARGS : 0); */
10957     DEBUG_PARSE_FMT("inst"," - %s",PL_reg_name[op]);
10958     if (SIZE_ONLY) {
10959         RExC_size += size;
10960         return;
10961     }
10962
10963     src = RExC_emit;
10964     RExC_emit += size;
10965     dst = RExC_emit;
10966     if (RExC_open_parens) {
10967         int paren;
10968         /*DEBUG_PARSE_FMT("inst"," - %"IVdf, (IV)RExC_npar);*/
10969         for ( paren=0 ; paren < RExC_npar ; paren++ ) {
10970             if ( RExC_open_parens[paren] >= opnd ) {
10971                 /*DEBUG_PARSE_FMT("open"," - %d",size);*/
10972                 RExC_open_parens[paren] += size;
10973             } else {
10974                 /*DEBUG_PARSE_FMT("open"," - %s","ok");*/
10975             }
10976             if ( RExC_close_parens[paren] >= opnd ) {
10977                 /*DEBUG_PARSE_FMT("close"," - %d",size);*/
10978                 RExC_close_parens[paren] += size;
10979             } else {
10980                 /*DEBUG_PARSE_FMT("close"," - %s","ok");*/
10981             }
10982         }
10983     }
10984
10985     while (src > opnd) {
10986         StructCopy(--src, --dst, regnode);
10987 #ifdef RE_TRACK_PATTERN_OFFSETS
10988         if (RExC_offsets) {     /* MJD 20010112 */
10989             MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s copy %"UVuf" -> %"UVuf" (max %"UVuf").\n",
10990                   "reg_insert",
10991                   __LINE__,
10992                   PL_reg_name[op],
10993                   (UV)(dst - RExC_emit_start) > RExC_offsets[0] 
10994                     ? "Overwriting end of array!\n" : "OK",
10995                   (UV)(src - RExC_emit_start),
10996                   (UV)(dst - RExC_emit_start),
10997                   (UV)RExC_offsets[0])); 
10998             Set_Node_Offset_To_R(dst-RExC_emit_start, Node_Offset(src));
10999             Set_Node_Length_To_R(dst-RExC_emit_start, Node_Length(src));
11000         }
11001 #endif
11002     }
11003     
11004
11005     place = opnd;               /* Op node, where operand used to be. */
11006 #ifdef RE_TRACK_PATTERN_OFFSETS
11007     if (RExC_offsets) {         /* MJD */
11008         MJD_OFFSET_DEBUG(("%s(%d): (op %s) %s %"UVuf" <- %"UVuf" (max %"UVuf").\n", 
11009               "reginsert",
11010               __LINE__,
11011               PL_reg_name[op],
11012               (UV)(place - RExC_emit_start) > RExC_offsets[0] 
11013               ? "Overwriting end of array!\n" : "OK",
11014               (UV)(place - RExC_emit_start),
11015               (UV)(RExC_parse - RExC_start),
11016               (UV)RExC_offsets[0]));
11017         Set_Node_Offset(place, RExC_parse);
11018         Set_Node_Length(place, 1);
11019     }
11020 #endif    
11021     src = NEXTOPER(place);
11022     FILL_ADVANCE_NODE(place, op);
11023     REH_CALL_COMP_NODE_HOOK(pRExC_state->rx, (place) - 1);
11024     Zero(src, offset, regnode);
11025 }
11026
11027 /*
11028 - regtail - set the next-pointer at the end of a node chain of p to val.
11029 - SEE ALSO: regtail_study
11030 */
11031 /* TODO: All three parms should be const */
11032 STATIC void
11033 S_regtail(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
11034 {
11035     dVAR;
11036     register regnode *scan;
11037     GET_RE_DEBUG_FLAGS_DECL;
11038
11039     PERL_ARGS_ASSERT_REGTAIL;
11040 #ifndef DEBUGGING
11041     PERL_UNUSED_ARG(depth);
11042 #endif
11043
11044     if (SIZE_ONLY)
11045         return;
11046
11047     /* Find last node. */
11048     scan = p;
11049     for (;;) {
11050         regnode * const temp = regnext(scan);
11051         DEBUG_PARSE_r({
11052             SV * const mysv=sv_newmortal();
11053             DEBUG_PARSE_MSG((scan==p ? "tail" : ""));
11054             regprop(RExC_rx, mysv, scan);
11055             PerlIO_printf(Perl_debug_log, "~ %s (%d) %s %s\n",
11056                 SvPV_nolen_const(mysv), REG_NODE_NUM(scan),
11057                     (temp == NULL ? "->" : ""),
11058                     (temp == NULL ? PL_reg_name[OP(val)] : "")
11059             );
11060         });
11061         if (temp == NULL)
11062             break;
11063         scan = temp;
11064     }
11065
11066     if (reg_off_by_arg[OP(scan)]) {
11067         ARG_SET(scan, val - scan);
11068     }
11069     else {
11070         NEXT_OFF(scan) = val - scan;
11071     }
11072 }
11073
11074 #ifdef DEBUGGING
11075 /*
11076 - regtail_study - set the next-pointer at the end of a node chain of p to val.
11077 - Look for optimizable sequences at the same time.
11078 - currently only looks for EXACT chains.
11079
11080 This is experimental code. The idea is to use this routine to perform 
11081 in place optimizations on branches and groups as they are constructed,
11082 with the long term intention of removing optimization from study_chunk so
11083 that it is purely analytical.
11084
11085 Currently only used when in DEBUG mode. The macro REGTAIL_STUDY() is used
11086 to control which is which.
11087
11088 */
11089 /* TODO: All four parms should be const */
11090
11091 STATIC U8
11092 S_regtail_study(pTHX_ RExC_state_t *pRExC_state, regnode *p, const regnode *val,U32 depth)
11093 {
11094     dVAR;
11095     register regnode *scan;
11096     U8 exact = PSEUDO;
11097 #ifdef EXPERIMENTAL_INPLACESCAN
11098     I32 min = 0;
11099 #endif
11100     GET_RE_DEBUG_FLAGS_DECL;
11101
11102     PERL_ARGS_ASSERT_REGTAIL_STUDY;
11103
11104
11105     if (SIZE_ONLY)
11106         return exact;
11107
11108     /* Find last node. */
11109
11110     scan = p;
11111     for (;;) {
11112         regnode * const temp = regnext(scan);
11113 #ifdef EXPERIMENTAL_INPLACESCAN
11114         if (PL_regkind[OP(scan)] == EXACT)
11115             if (join_exact(pRExC_state,scan,&min,1,val,depth+1))
11116                 return EXACT;
11117 #endif
11118         if ( exact ) {
11119             switch (OP(scan)) {
11120                 case EXACT:
11121                 case EXACTF:
11122                 case EXACTFA:
11123                 case EXACTFU:
11124                 case EXACTFL:
11125                         if( exact == PSEUDO )
11126                             exact= OP(scan);
11127                         else if ( exact != OP(scan) )
11128                             exact= 0;
11129                 case NOTHING:
11130                     break;
11131                 default:
11132                     exact= 0;
11133             }
11134         }
11135         DEBUG_PARSE_r({
11136             SV * const mysv=sv_newmortal();
11137             DEBUG_PARSE_MSG((scan==p ? "tsdy" : ""));
11138             regprop(RExC_rx, mysv, scan);
11139             PerlIO_printf(Perl_debug_log, "~ %s (%d) -> %s\n",
11140                 SvPV_nolen_const(mysv),
11141                 REG_NODE_NUM(scan),
11142                 PL_reg_name[exact]);
11143         });
11144         if (temp == NULL)
11145             break;
11146         scan = temp;
11147     }
11148     DEBUG_PARSE_r({
11149         SV * const mysv_val=sv_newmortal();
11150         DEBUG_PARSE_MSG("");
11151         regprop(RExC_rx, mysv_val, val);
11152         PerlIO_printf(Perl_debug_log, "~ attach to %s (%"IVdf") offset to %"IVdf"\n",
11153                       SvPV_nolen_const(mysv_val),
11154                       (IV)REG_NODE_NUM(val),
11155                       (IV)(val - scan)
11156         );
11157     });
11158     if (reg_off_by_arg[OP(scan)]) {
11159         ARG_SET(scan, val - scan);
11160     }
11161     else {
11162         NEXT_OFF(scan) = val - scan;
11163     }
11164
11165     return exact;
11166 }
11167 #endif
11168
11169 /*
11170  - regdump - dump a regexp onto Perl_debug_log in vaguely comprehensible form
11171  */
11172 #ifdef DEBUGGING
11173 static void 
11174 S_regdump_extflags(pTHX_ const char *lead, const U32 flags)
11175 {
11176     int bit;
11177     int set=0;
11178     regex_charset cs;
11179
11180     for (bit=0; bit<32; bit++) {
11181         if (flags & (1<<bit)) {
11182             if ((1<<bit) & RXf_PMf_CHARSET) {   /* Output separately, below */
11183                 continue;
11184             }
11185             if (!set++ && lead) 
11186                 PerlIO_printf(Perl_debug_log, "%s",lead);
11187             PerlIO_printf(Perl_debug_log, "%s ",PL_reg_extflags_name[bit]);
11188         }               
11189     }      
11190     if ((cs = get_regex_charset(flags)) != REGEX_DEPENDS_CHARSET) {
11191             if (!set++ && lead) {
11192                 PerlIO_printf(Perl_debug_log, "%s",lead);
11193             }
11194             switch (cs) {
11195                 case REGEX_UNICODE_CHARSET:
11196                     PerlIO_printf(Perl_debug_log, "UNICODE");
11197                     break;
11198                 case REGEX_LOCALE_CHARSET:
11199                     PerlIO_printf(Perl_debug_log, "LOCALE");
11200                     break;
11201                 case REGEX_ASCII_RESTRICTED_CHARSET:
11202                     PerlIO_printf(Perl_debug_log, "ASCII-RESTRICTED");
11203                     break;
11204                 case REGEX_ASCII_MORE_RESTRICTED_CHARSET:
11205                     PerlIO_printf(Perl_debug_log, "ASCII-MORE_RESTRICTED");
11206                     break;
11207                 default:
11208                     PerlIO_printf(Perl_debug_log, "UNKNOWN CHARACTER SET");
11209                     break;
11210             }
11211     }
11212     if (lead)  {
11213         if (set) 
11214             PerlIO_printf(Perl_debug_log, "\n");
11215         else 
11216             PerlIO_printf(Perl_debug_log, "%s[none-set]\n",lead);
11217     }            
11218 }   
11219 #endif
11220
11221 void
11222 Perl_regdump(pTHX_ const regexp *r)
11223 {
11224 #ifdef DEBUGGING
11225     dVAR;
11226     SV * const sv = sv_newmortal();
11227     SV *dsv= sv_newmortal();
11228     RXi_GET_DECL(r,ri);
11229     GET_RE_DEBUG_FLAGS_DECL;
11230
11231     PERL_ARGS_ASSERT_REGDUMP;
11232
11233     (void)dumpuntil(r, ri->program, ri->program + 1, NULL, NULL, sv, 0, 0);
11234
11235     /* Header fields of interest. */
11236     if (r->anchored_substr) {
11237         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->anchored_substr), 
11238             RE_SV_DUMPLEN(r->anchored_substr), 30);
11239         PerlIO_printf(Perl_debug_log,
11240                       "anchored %s%s at %"IVdf" ",
11241                       s, RE_SV_TAIL(r->anchored_substr),
11242                       (IV)r->anchored_offset);
11243     } else if (r->anchored_utf8) {
11244         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->anchored_utf8), 
11245             RE_SV_DUMPLEN(r->anchored_utf8), 30);
11246         PerlIO_printf(Perl_debug_log,
11247                       "anchored utf8 %s%s at %"IVdf" ",
11248                       s, RE_SV_TAIL(r->anchored_utf8),
11249                       (IV)r->anchored_offset);
11250     }                 
11251     if (r->float_substr) {
11252         RE_PV_QUOTED_DECL(s, 0, dsv, SvPVX_const(r->float_substr), 
11253             RE_SV_DUMPLEN(r->float_substr), 30);
11254         PerlIO_printf(Perl_debug_log,
11255                       "floating %s%s at %"IVdf"..%"UVuf" ",
11256                       s, RE_SV_TAIL(r->float_substr),
11257                       (IV)r->float_min_offset, (UV)r->float_max_offset);
11258     } else if (r->float_utf8) {
11259         RE_PV_QUOTED_DECL(s, 1, dsv, SvPVX_const(r->float_utf8), 
11260             RE_SV_DUMPLEN(r->float_utf8), 30);
11261         PerlIO_printf(Perl_debug_log,
11262                       "floating utf8 %s%s at %"IVdf"..%"UVuf" ",
11263                       s, RE_SV_TAIL(r->float_utf8),
11264                       (IV)r->float_min_offset, (UV)r->float_max_offset);
11265     }
11266     if (r->check_substr || r->check_utf8)
11267         PerlIO_printf(Perl_debug_log,
11268                       (const char *)
11269                       (r->check_substr == r->float_substr
11270                        && r->check_utf8 == r->float_utf8
11271                        ? "(checking floating" : "(checking anchored"));
11272     if (r->extflags & RXf_NOSCAN)
11273         PerlIO_printf(Perl_debug_log, " noscan");
11274     if (r->extflags & RXf_CHECK_ALL)
11275         PerlIO_printf(Perl_debug_log, " isall");
11276     if (r->check_substr || r->check_utf8)
11277         PerlIO_printf(Perl_debug_log, ") ");
11278
11279     if (ri->regstclass) {
11280         regprop(r, sv, ri->regstclass);
11281         PerlIO_printf(Perl_debug_log, "stclass %s ", SvPVX_const(sv));
11282     }
11283     if (r->extflags & RXf_ANCH) {
11284         PerlIO_printf(Perl_debug_log, "anchored");
11285         if (r->extflags & RXf_ANCH_BOL)
11286             PerlIO_printf(Perl_debug_log, "(BOL)");
11287         if (r->extflags & RXf_ANCH_MBOL)
11288             PerlIO_printf(Perl_debug_log, "(MBOL)");
11289         if (r->extflags & RXf_ANCH_SBOL)
11290             PerlIO_printf(Perl_debug_log, "(SBOL)");
11291         if (r->extflags & RXf_ANCH_GPOS)
11292             PerlIO_printf(Perl_debug_log, "(GPOS)");
11293         PerlIO_putc(Perl_debug_log, ' ');
11294     }
11295     if (r->extflags & RXf_GPOS_SEEN)
11296         PerlIO_printf(Perl_debug_log, "GPOS:%"UVuf" ", (UV)r->gofs);
11297     if (r->intflags & PREGf_SKIP)
11298         PerlIO_printf(Perl_debug_log, "plus ");
11299     if (r->intflags & PREGf_IMPLICIT)
11300         PerlIO_printf(Perl_debug_log, "implicit ");
11301     PerlIO_printf(Perl_debug_log, "minlen %"IVdf" ", (IV)r->minlen);
11302     if (r->extflags & RXf_EVAL_SEEN)
11303         PerlIO_printf(Perl_debug_log, "with eval ");
11304     PerlIO_printf(Perl_debug_log, "\n");
11305     DEBUG_FLAGS_r(regdump_extflags("r->extflags: ",r->extflags));            
11306 #else
11307     PERL_ARGS_ASSERT_REGDUMP;
11308     PERL_UNUSED_CONTEXT;
11309     PERL_UNUSED_ARG(r);
11310 #endif  /* DEBUGGING */
11311 }
11312
11313 /*
11314 - regprop - printable representation of opcode
11315 */
11316 #define EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags) \
11317 STMT_START { \
11318         if (do_sep) {                           \
11319             Perl_sv_catpvf(aTHX_ sv,"%s][%s",PL_colors[1],PL_colors[0]); \
11320             if (flags & ANYOF_INVERT)           \
11321                 /*make sure the invert info is in each */ \
11322                 sv_catpvs(sv, "^");             \
11323             do_sep = 0;                         \
11324         }                                       \
11325 } STMT_END
11326
11327 void
11328 Perl_regprop(pTHX_ const regexp *prog, SV *sv, const regnode *o)
11329 {
11330 #ifdef DEBUGGING
11331     dVAR;
11332     register int k;
11333     RXi_GET_DECL(prog,progi);
11334     GET_RE_DEBUG_FLAGS_DECL;
11335     
11336     PERL_ARGS_ASSERT_REGPROP;
11337
11338     sv_setpvs(sv, "");
11339
11340     if (OP(o) > REGNODE_MAX)            /* regnode.type is unsigned */
11341         /* It would be nice to FAIL() here, but this may be called from
11342            regexec.c, and it would be hard to supply pRExC_state. */
11343         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(o), (int)REGNODE_MAX);
11344     sv_catpv(sv, PL_reg_name[OP(o)]); /* Take off const! */
11345
11346     k = PL_regkind[OP(o)];
11347
11348     if (k == EXACT) {
11349         sv_catpvs(sv, " ");
11350         /* Using is_utf8_string() (via PERL_PV_UNI_DETECT) 
11351          * is a crude hack but it may be the best for now since 
11352          * we have no flag "this EXACTish node was UTF-8" 
11353          * --jhi */
11354         pv_pretty(sv, STRING(o), STR_LEN(o), 60, PL_colors[0], PL_colors[1],
11355                   PERL_PV_ESCAPE_UNI_DETECT |
11356                   PERL_PV_ESCAPE_NONASCII   |
11357                   PERL_PV_PRETTY_ELLIPSES   |
11358                   PERL_PV_PRETTY_LTGT       |
11359                   PERL_PV_PRETTY_NOCLEAR
11360                   );
11361     } else if (k == TRIE) {
11362         /* print the details of the trie in dumpuntil instead, as
11363          * progi->data isn't available here */
11364         const char op = OP(o);
11365         const U32 n = ARG(o);
11366         const reg_ac_data * const ac = IS_TRIE_AC(op) ?
11367                (reg_ac_data *)progi->data->data[n] :
11368                NULL;
11369         const reg_trie_data * const trie
11370             = (reg_trie_data*)progi->data->data[!IS_TRIE_AC(op) ? n : ac->trie];
11371         
11372         Perl_sv_catpvf(aTHX_ sv, "-%s",PL_reg_name[o->flags]);
11373         DEBUG_TRIE_COMPILE_r(
11374             Perl_sv_catpvf(aTHX_ sv,
11375                 "<S:%"UVuf"/%"IVdf" W:%"UVuf" L:%"UVuf"/%"UVuf" C:%"UVuf"/%"UVuf">",
11376                 (UV)trie->startstate,
11377                 (IV)trie->statecount-1, /* -1 because of the unused 0 element */
11378                 (UV)trie->wordcount,
11379                 (UV)trie->minlen,
11380                 (UV)trie->maxlen,
11381                 (UV)TRIE_CHARCOUNT(trie),
11382                 (UV)trie->uniquecharcount
11383             )
11384         );
11385         if ( IS_ANYOF_TRIE(op) || trie->bitmap ) {
11386             int i;
11387             int rangestart = -1;
11388             U8* bitmap = IS_ANYOF_TRIE(op) ? (U8*)ANYOF_BITMAP(o) : (U8*)TRIE_BITMAP(trie);
11389             sv_catpvs(sv, "[");
11390             for (i = 0; i <= 256; i++) {
11391                 if (i < 256 && BITMAP_TEST(bitmap,i)) {
11392                     if (rangestart == -1)
11393                         rangestart = i;
11394                 } else if (rangestart != -1) {
11395                     if (i <= rangestart + 3)
11396                         for (; rangestart < i; rangestart++)
11397                             put_byte(sv, rangestart);
11398                     else {
11399                         put_byte(sv, rangestart);
11400                         sv_catpvs(sv, "-");
11401                         put_byte(sv, i - 1);
11402                     }
11403                     rangestart = -1;
11404                 }
11405             }
11406             sv_catpvs(sv, "]");
11407         } 
11408          
11409     } else if (k == CURLY) {
11410         if (OP(o) == CURLYM || OP(o) == CURLYN || OP(o) == CURLYX)
11411             Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags); /* Parenth number */
11412         Perl_sv_catpvf(aTHX_ sv, " {%d,%d}", ARG1(o), ARG2(o));
11413     }
11414     else if (k == WHILEM && o->flags)                   /* Ordinal/of */
11415         Perl_sv_catpvf(aTHX_ sv, "[%d/%d]", o->flags & 0xf, o->flags>>4);
11416     else if (k == REF || k == OPEN || k == CLOSE || k == GROUPP || OP(o)==ACCEPT) {
11417         Perl_sv_catpvf(aTHX_ sv, "%d", (int)ARG(o));    /* Parenth number */
11418         if ( RXp_PAREN_NAMES(prog) ) {
11419             if ( k != REF || (OP(o) < NREF)) {
11420                 AV *list= MUTABLE_AV(progi->data->data[progi->name_list_idx]);
11421                 SV **name= av_fetch(list, ARG(o), 0 );
11422                 if (name)
11423                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
11424             }       
11425             else {
11426                 AV *list= MUTABLE_AV(progi->data->data[ progi->name_list_idx ]);
11427                 SV *sv_dat= MUTABLE_SV(progi->data->data[ ARG( o ) ]);
11428                 I32 *nums=(I32*)SvPVX(sv_dat);
11429                 SV **name= av_fetch(list, nums[0], 0 );
11430                 I32 n;
11431                 if (name) {
11432                     for ( n=0; n<SvIVX(sv_dat); n++ ) {
11433                         Perl_sv_catpvf(aTHX_ sv, "%s%"IVdf,
11434                                     (n ? "," : ""), (IV)nums[n]);
11435                     }
11436                     Perl_sv_catpvf(aTHX_ sv, " '%"SVf"'", SVfARG(*name));
11437                 }
11438             }
11439         }            
11440     } else if (k == GOSUB) 
11441         Perl_sv_catpvf(aTHX_ sv, "%d[%+d]", (int)ARG(o),(int)ARG2L(o)); /* Paren and offset */
11442     else if (k == VERB) {
11443         if (!o->flags) 
11444             Perl_sv_catpvf(aTHX_ sv, ":%"SVf, 
11445                            SVfARG((MUTABLE_SV(progi->data->data[ ARG( o ) ]))));
11446     } else if (k == LOGICAL)
11447         Perl_sv_catpvf(aTHX_ sv, "[%d]", o->flags);     /* 2: embedded, otherwise 1 */
11448     else if (k == FOLDCHAR)
11449         Perl_sv_catpvf(aTHX_ sv, "[0x%"UVXf"]", PTR2UV(ARG(o)) );
11450     else if (k == ANYOF) {
11451         int i, rangestart = -1;
11452         const U8 flags = ANYOF_FLAGS(o);
11453         int do_sep = 0;
11454
11455         /* Should be synchronized with * ANYOF_ #xdefines in regcomp.h */
11456         static const char * const anyofs[] = {
11457             "\\w",
11458             "\\W",
11459             "\\s",
11460             "\\S",
11461             "\\d",
11462             "\\D",
11463             "[:alnum:]",
11464             "[:^alnum:]",
11465             "[:alpha:]",
11466             "[:^alpha:]",
11467             "[:ascii:]",
11468             "[:^ascii:]",
11469             "[:cntrl:]",
11470             "[:^cntrl:]",
11471             "[:graph:]",
11472             "[:^graph:]",
11473             "[:lower:]",
11474             "[:^lower:]",
11475             "[:print:]",
11476             "[:^print:]",
11477             "[:punct:]",
11478             "[:^punct:]",
11479             "[:upper:]",
11480             "[:^upper:]",
11481             "[:xdigit:]",
11482             "[:^xdigit:]",
11483             "[:space:]",
11484             "[:^space:]",
11485             "[:blank:]",
11486             "[:^blank:]"
11487         };
11488
11489         if (flags & ANYOF_LOCALE)
11490             sv_catpvs(sv, "{loc}");
11491         if (flags & ANYOF_LOC_NONBITMAP_FOLD)
11492             sv_catpvs(sv, "{i}");
11493         Perl_sv_catpvf(aTHX_ sv, "[%s", PL_colors[0]);
11494         if (flags & ANYOF_INVERT)
11495             sv_catpvs(sv, "^");
11496         
11497         /* output what the standard cp 0-255 bitmap matches */
11498         for (i = 0; i <= 256; i++) {
11499             if (i < 256 && ANYOF_BITMAP_TEST(o,i)) {
11500                 if (rangestart == -1)
11501                     rangestart = i;
11502             } else if (rangestart != -1) {
11503                 if (i <= rangestart + 3)
11504                     for (; rangestart < i; rangestart++)
11505                         put_byte(sv, rangestart);
11506                 else {
11507                     put_byte(sv, rangestart);
11508                     sv_catpvs(sv, "-");
11509                     put_byte(sv, i - 1);
11510                 }
11511                 do_sep = 1;
11512                 rangestart = -1;
11513             }
11514         }
11515         
11516         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
11517         /* output any special charclass tests (used entirely under use locale) */
11518         if (ANYOF_CLASS_TEST_ANY_SET(o))
11519             for (i = 0; i < (int)(sizeof(anyofs)/sizeof(char*)); i++)
11520                 if (ANYOF_CLASS_TEST(o,i)) {
11521                     sv_catpv(sv, anyofs[i]);
11522                     do_sep = 1;
11523                 }
11524         
11525         EMIT_ANYOF_TEST_SEPARATOR(do_sep,sv,flags);
11526         
11527         if (flags & ANYOF_NON_UTF8_LATIN1_ALL) {
11528             sv_catpvs(sv, "{non-utf8-latin1-all}");
11529         }
11530
11531         /* output information about the unicode matching */
11532         if (flags & ANYOF_UNICODE_ALL)
11533             sv_catpvs(sv, "{unicode_all}");
11534         else if (ANYOF_NONBITMAP(o))
11535             sv_catpvs(sv, "{unicode}");
11536         if (flags & ANYOF_NONBITMAP_NON_UTF8)
11537             sv_catpvs(sv, "{outside bitmap}");
11538
11539         if (ANYOF_NONBITMAP(o)) {
11540             SV *lv;
11541             SV * const sw = regclass_swash(prog, o, FALSE, &lv, 0);
11542         
11543             if (lv) {
11544                 if (sw) {
11545                     U8 s[UTF8_MAXBYTES_CASE+1];
11546
11547                     for (i = 0; i <= 256; i++) { /* just the first 256 */
11548                         uvchr_to_utf8(s, i);
11549                         
11550                         if (i < 256 && swash_fetch(sw, s, TRUE)) {
11551                             if (rangestart == -1)
11552                                 rangestart = i;
11553                         } else if (rangestart != -1) {
11554                             if (i <= rangestart + 3)
11555                                 for (; rangestart < i; rangestart++) {
11556                                     const U8 * const e = uvchr_to_utf8(s,rangestart);
11557                                     U8 *p;
11558                                     for(p = s; p < e; p++)
11559                                         put_byte(sv, *p);
11560                                 }
11561                             else {
11562                                 const U8 *e = uvchr_to_utf8(s,rangestart);
11563                                 U8 *p;
11564                                 for (p = s; p < e; p++)
11565                                     put_byte(sv, *p);
11566                                 sv_catpvs(sv, "-");
11567                                 e = uvchr_to_utf8(s, i-1);
11568                                 for (p = s; p < e; p++)
11569                                     put_byte(sv, *p);
11570                                 }
11571                                 rangestart = -1;
11572                             }
11573                         }
11574                         
11575                     sv_catpvs(sv, "..."); /* et cetera */
11576                 }
11577
11578                 {
11579                     char *s = savesvpv(lv);
11580                     char * const origs = s;
11581                 
11582                     while (*s && *s != '\n')
11583                         s++;
11584                 
11585                     if (*s == '\n') {
11586                         const char * const t = ++s;
11587                         
11588                         while (*s) {
11589                             if (*s == '\n')
11590                                 *s = ' ';
11591                             s++;
11592                         }
11593                         if (s[-1] == ' ')
11594                             s[-1] = 0;
11595                         
11596                         sv_catpv(sv, t);
11597                     }
11598                 
11599                     Safefree(origs);
11600                 }
11601             }
11602         }
11603
11604         Perl_sv_catpvf(aTHX_ sv, "%s]", PL_colors[1]);
11605     }
11606     else if (k == BRANCHJ && (OP(o) == UNLESSM || OP(o) == IFMATCH))
11607         Perl_sv_catpvf(aTHX_ sv, "[%d]", -(o->flags));
11608 #else
11609     PERL_UNUSED_CONTEXT;
11610     PERL_UNUSED_ARG(sv);
11611     PERL_UNUSED_ARG(o);
11612     PERL_UNUSED_ARG(prog);
11613 #endif  /* DEBUGGING */
11614 }
11615
11616 SV *
11617 Perl_re_intuit_string(pTHX_ REGEXP * const r)
11618 {                               /* Assume that RE_INTUIT is set */
11619     dVAR;
11620     struct regexp *const prog = (struct regexp *)SvANY(r);
11621     GET_RE_DEBUG_FLAGS_DECL;
11622
11623     PERL_ARGS_ASSERT_RE_INTUIT_STRING;
11624     PERL_UNUSED_CONTEXT;
11625
11626     DEBUG_COMPILE_r(
11627         {
11628             const char * const s = SvPV_nolen_const(prog->check_substr
11629                       ? prog->check_substr : prog->check_utf8);
11630
11631             if (!PL_colorset) reginitcolors();
11632             PerlIO_printf(Perl_debug_log,
11633                       "%sUsing REx %ssubstr:%s \"%s%.60s%s%s\"\n",
11634                       PL_colors[4],
11635                       prog->check_substr ? "" : "utf8 ",
11636                       PL_colors[5],PL_colors[0],
11637                       s,
11638                       PL_colors[1],
11639                       (strlen(s) > 60 ? "..." : ""));
11640         } );
11641
11642     return prog->check_substr ? prog->check_substr : prog->check_utf8;
11643 }
11644
11645 /* 
11646    pregfree() 
11647    
11648    handles refcounting and freeing the perl core regexp structure. When 
11649    it is necessary to actually free the structure the first thing it 
11650    does is call the 'free' method of the regexp_engine associated to
11651    the regexp, allowing the handling of the void *pprivate; member 
11652    first. (This routine is not overridable by extensions, which is why 
11653    the extensions free is called first.)
11654    
11655    See regdupe and regdupe_internal if you change anything here. 
11656 */
11657 #ifndef PERL_IN_XSUB_RE
11658 void
11659 Perl_pregfree(pTHX_ REGEXP *r)
11660 {
11661     SvREFCNT_dec(r);
11662 }
11663
11664 void
11665 Perl_pregfree2(pTHX_ REGEXP *rx)
11666 {
11667     dVAR;
11668     struct regexp *const r = (struct regexp *)SvANY(rx);
11669     GET_RE_DEBUG_FLAGS_DECL;
11670
11671     PERL_ARGS_ASSERT_PREGFREE2;
11672
11673     if (r->mother_re) {
11674         ReREFCNT_dec(r->mother_re);
11675     } else {
11676         CALLREGFREE_PVT(rx); /* free the private data */
11677         SvREFCNT_dec(RXp_PAREN_NAMES(r));
11678     }        
11679     if (r->substrs) {
11680         SvREFCNT_dec(r->anchored_substr);
11681         SvREFCNT_dec(r->anchored_utf8);
11682         SvREFCNT_dec(r->float_substr);
11683         SvREFCNT_dec(r->float_utf8);
11684         Safefree(r->substrs);
11685     }
11686     RX_MATCH_COPY_FREE(rx);
11687 #ifdef PERL_OLD_COPY_ON_WRITE
11688     SvREFCNT_dec(r->saved_copy);
11689 #endif
11690     Safefree(r->offs);
11691 }
11692
11693 /*  reg_temp_copy()
11694     
11695     This is a hacky workaround to the structural issue of match results
11696     being stored in the regexp structure which is in turn stored in
11697     PL_curpm/PL_reg_curpm. The problem is that due to qr// the pattern
11698     could be PL_curpm in multiple contexts, and could require multiple
11699     result sets being associated with the pattern simultaneously, such
11700     as when doing a recursive match with (??{$qr})
11701     
11702     The solution is to make a lightweight copy of the regexp structure 
11703     when a qr// is returned from the code executed by (??{$qr}) this
11704     lightweight copy doesn't actually own any of its data except for
11705     the starp/end and the actual regexp structure itself. 
11706     
11707 */    
11708     
11709     
11710 REGEXP *
11711 Perl_reg_temp_copy (pTHX_ REGEXP *ret_x, REGEXP *rx)
11712 {
11713     struct regexp *ret;
11714     struct regexp *const r = (struct regexp *)SvANY(rx);
11715     register const I32 npar = r->nparens+1;
11716
11717     PERL_ARGS_ASSERT_REG_TEMP_COPY;
11718
11719     if (!ret_x)
11720         ret_x = (REGEXP*) newSV_type(SVt_REGEXP);
11721     ret = (struct regexp *)SvANY(ret_x);
11722     
11723     (void)ReREFCNT_inc(rx);
11724     /* We can take advantage of the existing "copied buffer" mechanism in SVs
11725        by pointing directly at the buffer, but flagging that the allocated
11726        space in the copy is zero. As we've just done a struct copy, it's now
11727        a case of zero-ing that, rather than copying the current length.  */
11728     SvPV_set(ret_x, RX_WRAPPED(rx));
11729     SvFLAGS(ret_x) |= SvFLAGS(rx) & (SVf_POK|SVp_POK|SVf_UTF8);
11730     memcpy(&(ret->xpv_cur), &(r->xpv_cur),
11731            sizeof(regexp) - STRUCT_OFFSET(regexp, xpv_cur));
11732     SvLEN_set(ret_x, 0);
11733     SvSTASH_set(ret_x, NULL);
11734     SvMAGIC_set(ret_x, NULL);
11735     Newx(ret->offs, npar, regexp_paren_pair);
11736     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
11737     if (r->substrs) {
11738         Newx(ret->substrs, 1, struct reg_substr_data);
11739         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
11740
11741         SvREFCNT_inc_void(ret->anchored_substr);
11742         SvREFCNT_inc_void(ret->anchored_utf8);
11743         SvREFCNT_inc_void(ret->float_substr);
11744         SvREFCNT_inc_void(ret->float_utf8);
11745
11746         /* check_substr and check_utf8, if non-NULL, point to either their
11747            anchored or float namesakes, and don't hold a second reference.  */
11748     }
11749     RX_MATCH_COPIED_off(ret_x);
11750 #ifdef PERL_OLD_COPY_ON_WRITE
11751     ret->saved_copy = NULL;
11752 #endif
11753     ret->mother_re = rx;
11754     
11755     return ret_x;
11756 }
11757 #endif
11758
11759 /* regfree_internal() 
11760
11761    Free the private data in a regexp. This is overloadable by 
11762    extensions. Perl takes care of the regexp structure in pregfree(), 
11763    this covers the *pprivate pointer which technically perl doesn't 
11764    know about, however of course we have to handle the 
11765    regexp_internal structure when no extension is in use. 
11766    
11767    Note this is called before freeing anything in the regexp 
11768    structure. 
11769  */
11770  
11771 void
11772 Perl_regfree_internal(pTHX_ REGEXP * const rx)
11773 {
11774     dVAR;
11775     struct regexp *const r = (struct regexp *)SvANY(rx);
11776     RXi_GET_DECL(r,ri);
11777     GET_RE_DEBUG_FLAGS_DECL;
11778
11779     PERL_ARGS_ASSERT_REGFREE_INTERNAL;
11780
11781     DEBUG_COMPILE_r({
11782         if (!PL_colorset)
11783             reginitcolors();
11784         {
11785             SV *dsv= sv_newmortal();
11786             RE_PV_QUOTED_DECL(s, RX_UTF8(rx),
11787                 dsv, RX_PRECOMP(rx), RX_PRELEN(rx), 60);
11788             PerlIO_printf(Perl_debug_log,"%sFreeing REx:%s %s\n", 
11789                 PL_colors[4],PL_colors[5],s);
11790         }
11791     });
11792 #ifdef RE_TRACK_PATTERN_OFFSETS
11793     if (ri->u.offsets)
11794         Safefree(ri->u.offsets);             /* 20010421 MJD */
11795 #endif
11796     if (ri->data) {
11797         int n = ri->data->count;
11798         PAD* new_comppad = NULL;
11799         PAD* old_comppad;
11800         PADOFFSET refcnt;
11801
11802         while (--n >= 0) {
11803           /* If you add a ->what type here, update the comment in regcomp.h */
11804             switch (ri->data->what[n]) {
11805             case 'a':
11806             case 's':
11807             case 'S':
11808             case 'u':
11809                 SvREFCNT_dec(MUTABLE_SV(ri->data->data[n]));
11810                 break;
11811             case 'f':
11812                 Safefree(ri->data->data[n]);
11813                 break;
11814             case 'p':
11815                 new_comppad = MUTABLE_AV(ri->data->data[n]);
11816                 break;
11817             case 'o':
11818                 if (new_comppad == NULL)
11819                     Perl_croak(aTHX_ "panic: pregfree comppad");
11820                 PAD_SAVE_LOCAL(old_comppad,
11821                     /* Watch out for global destruction's random ordering. */
11822                     (SvTYPE(new_comppad) == SVt_PVAV) ? new_comppad : NULL
11823                 );
11824                 OP_REFCNT_LOCK;
11825                 refcnt = OpREFCNT_dec((OP_4tree*)ri->data->data[n]);
11826                 OP_REFCNT_UNLOCK;
11827                 if (!refcnt)
11828                     op_free((OP_4tree*)ri->data->data[n]);
11829
11830                 PAD_RESTORE_LOCAL(old_comppad);
11831                 SvREFCNT_dec(MUTABLE_SV(new_comppad));
11832                 new_comppad = NULL;
11833                 break;
11834             case 'n':
11835                 break;
11836             case 'T':           
11837                 { /* Aho Corasick add-on structure for a trie node.
11838                      Used in stclass optimization only */
11839                     U32 refcount;
11840                     reg_ac_data *aho=(reg_ac_data*)ri->data->data[n];
11841                     OP_REFCNT_LOCK;
11842                     refcount = --aho->refcount;
11843                     OP_REFCNT_UNLOCK;
11844                     if ( !refcount ) {
11845                         PerlMemShared_free(aho->states);
11846                         PerlMemShared_free(aho->fail);
11847                          /* do this last!!!! */
11848                         PerlMemShared_free(ri->data->data[n]);
11849                         PerlMemShared_free(ri->regstclass);
11850                     }
11851                 }
11852                 break;
11853             case 't':
11854                 {
11855                     /* trie structure. */
11856                     U32 refcount;
11857                     reg_trie_data *trie=(reg_trie_data*)ri->data->data[n];
11858                     OP_REFCNT_LOCK;
11859                     refcount = --trie->refcount;
11860                     OP_REFCNT_UNLOCK;
11861                     if ( !refcount ) {
11862                         PerlMemShared_free(trie->charmap);
11863                         PerlMemShared_free(trie->states);
11864                         PerlMemShared_free(trie->trans);
11865                         if (trie->bitmap)
11866                             PerlMemShared_free(trie->bitmap);
11867                         if (trie->jump)
11868                             PerlMemShared_free(trie->jump);
11869                         PerlMemShared_free(trie->wordinfo);
11870                         /* do this last!!!! */
11871                         PerlMemShared_free(ri->data->data[n]);
11872                     }
11873                 }
11874                 break;
11875             default:
11876                 Perl_croak(aTHX_ "panic: regfree data code '%c'", ri->data->what[n]);
11877             }
11878         }
11879         Safefree(ri->data->what);
11880         Safefree(ri->data);
11881     }
11882
11883     Safefree(ri);
11884 }
11885
11886 #define av_dup_inc(s,t) MUTABLE_AV(sv_dup_inc((const SV *)s,t))
11887 #define hv_dup_inc(s,t) MUTABLE_HV(sv_dup_inc((const SV *)s,t))
11888 #define SAVEPVN(p,n)    ((p) ? savepvn(p,n) : NULL)
11889
11890 /* 
11891    re_dup - duplicate a regexp. 
11892    
11893    This routine is expected to clone a given regexp structure. It is only
11894    compiled under USE_ITHREADS.
11895
11896    After all of the core data stored in struct regexp is duplicated
11897    the regexp_engine.dupe method is used to copy any private data
11898    stored in the *pprivate pointer. This allows extensions to handle
11899    any duplication it needs to do.
11900
11901    See pregfree() and regfree_internal() if you change anything here. 
11902 */
11903 #if defined(USE_ITHREADS)
11904 #ifndef PERL_IN_XSUB_RE
11905 void
11906 Perl_re_dup_guts(pTHX_ const REGEXP *sstr, REGEXP *dstr, CLONE_PARAMS *param)
11907 {
11908     dVAR;
11909     I32 npar;
11910     const struct regexp *r = (const struct regexp *)SvANY(sstr);
11911     struct regexp *ret = (struct regexp *)SvANY(dstr);
11912     
11913     PERL_ARGS_ASSERT_RE_DUP_GUTS;
11914
11915     npar = r->nparens+1;
11916     Newx(ret->offs, npar, regexp_paren_pair);
11917     Copy(r->offs, ret->offs, npar, regexp_paren_pair);
11918     if(ret->swap) {
11919         /* no need to copy these */
11920         Newx(ret->swap, npar, regexp_paren_pair);
11921     }
11922
11923     if (ret->substrs) {
11924         /* Do it this way to avoid reading from *r after the StructCopy().
11925            That way, if any of the sv_dup_inc()s dislodge *r from the L1
11926            cache, it doesn't matter.  */
11927         const bool anchored = r->check_substr
11928             ? r->check_substr == r->anchored_substr
11929             : r->check_utf8 == r->anchored_utf8;
11930         Newx(ret->substrs, 1, struct reg_substr_data);
11931         StructCopy(r->substrs, ret->substrs, struct reg_substr_data);
11932
11933         ret->anchored_substr = sv_dup_inc(ret->anchored_substr, param);
11934         ret->anchored_utf8 = sv_dup_inc(ret->anchored_utf8, param);
11935         ret->float_substr = sv_dup_inc(ret->float_substr, param);
11936         ret->float_utf8 = sv_dup_inc(ret->float_utf8, param);
11937
11938         /* check_substr and check_utf8, if non-NULL, point to either their
11939            anchored or float namesakes, and don't hold a second reference.  */
11940
11941         if (ret->check_substr) {
11942             if (anchored) {
11943                 assert(r->check_utf8 == r->anchored_utf8);
11944                 ret->check_substr = ret->anchored_substr;
11945                 ret->check_utf8 = ret->anchored_utf8;
11946             } else {
11947                 assert(r->check_substr == r->float_substr);
11948                 assert(r->check_utf8 == r->float_utf8);
11949                 ret->check_substr = ret->float_substr;
11950                 ret->check_utf8 = ret->float_utf8;
11951             }
11952         } else if (ret->check_utf8) {
11953             if (anchored) {
11954                 ret->check_utf8 = ret->anchored_utf8;
11955             } else {
11956                 ret->check_utf8 = ret->float_utf8;
11957             }
11958         }
11959     }
11960
11961     RXp_PAREN_NAMES(ret) = hv_dup_inc(RXp_PAREN_NAMES(ret), param);
11962
11963     if (ret->pprivate)
11964         RXi_SET(ret,CALLREGDUPE_PVT(dstr,param));
11965
11966     if (RX_MATCH_COPIED(dstr))
11967         ret->subbeg  = SAVEPVN(ret->subbeg, ret->sublen);
11968     else
11969         ret->subbeg = NULL;
11970 #ifdef PERL_OLD_COPY_ON_WRITE
11971     ret->saved_copy = NULL;
11972 #endif
11973
11974     if (ret->mother_re) {
11975         if (SvPVX_const(dstr) == SvPVX_const(ret->mother_re)) {
11976             /* Our storage points directly to our mother regexp, but that's
11977                1: a buffer in a different thread
11978                2: something we no longer hold a reference on
11979                so we need to copy it locally.  */
11980             /* Note we need to sue SvCUR() on our mother_re, because it, in
11981                turn, may well be pointing to its own mother_re.  */
11982             SvPV_set(dstr, SAVEPVN(SvPVX_const(ret->mother_re),
11983                                    SvCUR(ret->mother_re)+1));
11984             SvLEN_set(dstr, SvCUR(ret->mother_re)+1);
11985         }
11986         ret->mother_re      = NULL;
11987     }
11988     ret->gofs = 0;
11989 }
11990 #endif /* PERL_IN_XSUB_RE */
11991
11992 /*
11993    regdupe_internal()
11994    
11995    This is the internal complement to regdupe() which is used to copy
11996    the structure pointed to by the *pprivate pointer in the regexp.
11997    This is the core version of the extension overridable cloning hook.
11998    The regexp structure being duplicated will be copied by perl prior
11999    to this and will be provided as the regexp *r argument, however 
12000    with the /old/ structures pprivate pointer value. Thus this routine
12001    may override any copying normally done by perl.
12002    
12003    It returns a pointer to the new regexp_internal structure.
12004 */
12005
12006 void *
12007 Perl_regdupe_internal(pTHX_ REGEXP * const rx, CLONE_PARAMS *param)
12008 {
12009     dVAR;
12010     struct regexp *const r = (struct regexp *)SvANY(rx);
12011     regexp_internal *reti;
12012     int len;
12013     RXi_GET_DECL(r,ri);
12014
12015     PERL_ARGS_ASSERT_REGDUPE_INTERNAL;
12016     
12017     len = ProgLen(ri);
12018     
12019     Newxc(reti, sizeof(regexp_internal) + len*sizeof(regnode), char, regexp_internal);
12020     Copy(ri->program, reti->program, len+1, regnode);
12021     
12022
12023     reti->regstclass = NULL;
12024
12025     if (ri->data) {
12026         struct reg_data *d;
12027         const int count = ri->data->count;
12028         int i;
12029
12030         Newxc(d, sizeof(struct reg_data) + count*sizeof(void *),
12031                 char, struct reg_data);
12032         Newx(d->what, count, U8);
12033
12034         d->count = count;
12035         for (i = 0; i < count; i++) {
12036             d->what[i] = ri->data->what[i];
12037             switch (d->what[i]) {
12038                 /* legal options are one of: sSfpontTua
12039                    see also regcomp.h and pregfree() */
12040             case 'a': /* actually an AV, but the dup function is identical.  */
12041             case 's':
12042             case 'S':
12043             case 'p': /* actually an AV, but the dup function is identical.  */
12044             case 'u': /* actually an HV, but the dup function is identical.  */
12045                 d->data[i] = sv_dup_inc((const SV *)ri->data->data[i], param);
12046                 break;
12047             case 'f':
12048                 /* This is cheating. */
12049                 Newx(d->data[i], 1, struct regnode_charclass_class);
12050                 StructCopy(ri->data->data[i], d->data[i],
12051                             struct regnode_charclass_class);
12052                 reti->regstclass = (regnode*)d->data[i];
12053                 break;
12054             case 'o':
12055                 /* Compiled op trees are readonly and in shared memory,
12056                    and can thus be shared without duplication. */
12057                 OP_REFCNT_LOCK;
12058                 d->data[i] = (void*)OpREFCNT_inc((OP*)ri->data->data[i]);
12059                 OP_REFCNT_UNLOCK;
12060                 break;
12061             case 'T':
12062                 /* Trie stclasses are readonly and can thus be shared
12063                  * without duplication. We free the stclass in pregfree
12064                  * when the corresponding reg_ac_data struct is freed.
12065                  */
12066                 reti->regstclass= ri->regstclass;
12067                 /* Fall through */
12068             case 't':
12069                 OP_REFCNT_LOCK;
12070                 ((reg_trie_data*)ri->data->data[i])->refcount++;
12071                 OP_REFCNT_UNLOCK;
12072                 /* Fall through */
12073             case 'n':
12074                 d->data[i] = ri->data->data[i];
12075                 break;
12076             default:
12077                 Perl_croak(aTHX_ "panic: re_dup unknown data code '%c'", ri->data->what[i]);
12078             }
12079         }
12080
12081         reti->data = d;
12082     }
12083     else
12084         reti->data = NULL;
12085
12086     reti->name_list_idx = ri->name_list_idx;
12087
12088 #ifdef RE_TRACK_PATTERN_OFFSETS
12089     if (ri->u.offsets) {
12090         Newx(reti->u.offsets, 2*len+1, U32);
12091         Copy(ri->u.offsets, reti->u.offsets, 2*len+1, U32);
12092     }
12093 #else
12094     SetProgLen(reti,len);
12095 #endif
12096
12097     return (void*)reti;
12098 }
12099
12100 #endif    /* USE_ITHREADS */
12101
12102 #ifndef PERL_IN_XSUB_RE
12103
12104 /*
12105  - regnext - dig the "next" pointer out of a node
12106  */
12107 regnode *
12108 Perl_regnext(pTHX_ register regnode *p)
12109 {
12110     dVAR;
12111     register I32 offset;
12112
12113     if (!p)
12114         return(NULL);
12115
12116     if (OP(p) > REGNODE_MAX) {          /* regnode.type is unsigned */
12117         Perl_croak(aTHX_ "Corrupted regexp opcode %d > %d", (int)OP(p), (int)REGNODE_MAX);
12118     }
12119
12120     offset = (reg_off_by_arg[OP(p)] ? ARG(p) : NEXT_OFF(p));
12121     if (offset == 0)
12122         return(NULL);
12123
12124     return(p+offset);
12125 }
12126 #endif
12127
12128 STATIC void     
12129 S_re_croak2(pTHX_ const char* pat1,const char* pat2,...)
12130 {
12131     va_list args;
12132     STRLEN l1 = strlen(pat1);
12133     STRLEN l2 = strlen(pat2);
12134     char buf[512];
12135     SV *msv;
12136     const char *message;
12137
12138     PERL_ARGS_ASSERT_RE_CROAK2;
12139
12140     if (l1 > 510)
12141         l1 = 510;
12142     if (l1 + l2 > 510)
12143         l2 = 510 - l1;
12144     Copy(pat1, buf, l1 , char);
12145     Copy(pat2, buf + l1, l2 , char);
12146     buf[l1 + l2] = '\n';
12147     buf[l1 + l2 + 1] = '\0';
12148 #ifdef I_STDARG
12149     /* ANSI variant takes additional second argument */
12150     va_start(args, pat2);
12151 #else
12152     va_start(args);
12153 #endif
12154     msv = vmess(buf, &args);
12155     va_end(args);
12156     message = SvPV_const(msv,l1);
12157     if (l1 > 512)
12158         l1 = 512;
12159     Copy(message, buf, l1 , char);
12160     buf[l1-1] = '\0';                   /* Overwrite \n */
12161     Perl_croak(aTHX_ "%s", buf);
12162 }
12163
12164 /* XXX Here's a total kludge.  But we need to re-enter for swash routines. */
12165
12166 #ifndef PERL_IN_XSUB_RE
12167 void
12168 Perl_save_re_context(pTHX)
12169 {
12170     dVAR;
12171
12172     struct re_save_state *state;
12173
12174     SAVEVPTR(PL_curcop);
12175     SSGROW(SAVESTACK_ALLOC_FOR_RE_SAVE_STATE + 1);
12176
12177     state = (struct re_save_state *)(PL_savestack + PL_savestack_ix);
12178     PL_savestack_ix += SAVESTACK_ALLOC_FOR_RE_SAVE_STATE;
12179     SSPUSHUV(SAVEt_RE_STATE);
12180
12181     Copy(&PL_reg_state, state, 1, struct re_save_state);
12182
12183     PL_reg_start_tmp = 0;
12184     PL_reg_start_tmpl = 0;
12185     PL_reg_oldsaved = NULL;
12186     PL_reg_oldsavedlen = 0;
12187     PL_reg_maxiter = 0;
12188     PL_reg_leftiter = 0;
12189     PL_reg_poscache = NULL;
12190     PL_reg_poscache_size = 0;
12191 #ifdef PERL_OLD_COPY_ON_WRITE
12192     PL_nrs = NULL;
12193 #endif
12194
12195     /* Save $1..$n (#18107: UTF-8 s/(\w+)/uc($1)/e); AMS 20021106. */
12196     if (PL_curpm) {
12197         const REGEXP * const rx = PM_GETRE(PL_curpm);
12198         if (rx) {
12199             U32 i;
12200             for (i = 1; i <= RX_NPARENS(rx); i++) {
12201                 char digits[TYPE_CHARS(long)];
12202                 const STRLEN len = my_snprintf(digits, sizeof(digits), "%lu", (long)i);
12203                 GV *const *const gvp
12204                     = (GV**)hv_fetch(PL_defstash, digits, len, 0);
12205
12206                 if (gvp) {
12207                     GV * const gv = *gvp;
12208                     if (SvTYPE(gv) == SVt_PVGV && GvSV(gv))
12209                         save_scalar(gv);
12210                 }
12211             }
12212         }
12213     }
12214 }
12215 #endif
12216
12217 static void
12218 clear_re(pTHX_ void *r)
12219 {
12220     dVAR;
12221     ReREFCNT_dec((REGEXP *)r);
12222 }
12223
12224 #ifdef DEBUGGING
12225
12226 STATIC void
12227 S_put_byte(pTHX_ SV *sv, int c)
12228 {
12229     PERL_ARGS_ASSERT_PUT_BYTE;
12230
12231     /* Our definition of isPRINT() ignores locales, so only bytes that are
12232        not part of UTF-8 are considered printable. I assume that the same
12233        holds for UTF-EBCDIC.
12234        Also, code point 255 is not printable in either (it's E0 in EBCDIC,
12235        which Wikipedia says:
12236
12237        EO, or Eight Ones, is an 8-bit EBCDIC character code represented as all
12238        ones (binary 1111 1111, hexadecimal FF). It is similar, but not
12239        identical, to the ASCII delete (DEL) or rubout control character.
12240        ) So the old condition can be simplified to !isPRINT(c)  */
12241     if (!isPRINT(c)) {
12242         if (c < 256) {
12243             Perl_sv_catpvf(aTHX_ sv, "\\x%02x", c);
12244         }
12245         else {
12246             Perl_sv_catpvf(aTHX_ sv, "\\x{%x}", c);
12247         }
12248     }
12249     else {
12250         const char string = c;
12251         if (c == '-' || c == ']' || c == '\\' || c == '^')
12252             sv_catpvs(sv, "\\");
12253         sv_catpvn(sv, &string, 1);
12254     }
12255 }
12256
12257
12258 #define CLEAR_OPTSTART \
12259     if (optstart) STMT_START { \
12260             DEBUG_OPTIMISE_r(PerlIO_printf(Perl_debug_log, " (%"IVdf" nodes)\n", (IV)(node - optstart))); \
12261             optstart=NULL; \
12262     } STMT_END
12263
12264 #define DUMPUNTIL(b,e) CLEAR_OPTSTART; node=dumpuntil(r,start,(b),(e),last,sv,indent+1,depth+1);
12265
12266 STATIC const regnode *
12267 S_dumpuntil(pTHX_ const regexp *r, const regnode *start, const regnode *node,
12268             const regnode *last, const regnode *plast, 
12269             SV* sv, I32 indent, U32 depth)
12270 {
12271     dVAR;
12272     register U8 op = PSEUDO;    /* Arbitrary non-END op. */
12273     register const regnode *next;
12274     const regnode *optstart= NULL;
12275     
12276     RXi_GET_DECL(r,ri);
12277     GET_RE_DEBUG_FLAGS_DECL;
12278
12279     PERL_ARGS_ASSERT_DUMPUNTIL;
12280
12281 #ifdef DEBUG_DUMPUNTIL
12282     PerlIO_printf(Perl_debug_log, "--- %d : %d - %d - %d\n",indent,node-start,
12283         last ? last-start : 0,plast ? plast-start : 0);
12284 #endif
12285             
12286     if (plast && plast < last) 
12287         last= plast;
12288
12289     while (PL_regkind[op] != END && (!last || node < last)) {
12290         /* While that wasn't END last time... */
12291         NODE_ALIGN(node);
12292         op = OP(node);
12293         if (op == CLOSE || op == WHILEM)
12294             indent--;
12295         next = regnext((regnode *)node);
12296
12297         /* Where, what. */
12298         if (OP(node) == OPTIMIZED) {
12299             if (!optstart && RE_DEBUG_FLAG(RE_DEBUG_COMPILE_OPTIMISE))
12300                 optstart = node;
12301             else
12302                 goto after_print;
12303         } else
12304             CLEAR_OPTSTART;
12305         
12306         regprop(r, sv, node);
12307         PerlIO_printf(Perl_debug_log, "%4"IVdf":%*s%s", (IV)(node - start),
12308                       (int)(2*indent + 1), "", SvPVX_const(sv));
12309         
12310         if (OP(node) != OPTIMIZED) {                  
12311             if (next == NULL)           /* Next ptr. */
12312                 PerlIO_printf(Perl_debug_log, " (0)");
12313             else if (PL_regkind[(U8)op] == BRANCH && PL_regkind[OP(next)] != BRANCH )
12314                 PerlIO_printf(Perl_debug_log, " (FAIL)");
12315             else 
12316                 PerlIO_printf(Perl_debug_log, " (%"IVdf")", (IV)(next - start));
12317             (void)PerlIO_putc(Perl_debug_log, '\n'); 
12318         }
12319         
12320       after_print:
12321         if (PL_regkind[(U8)op] == BRANCHJ) {
12322             assert(next);
12323             {
12324                 register const regnode *nnode = (OP(next) == LONGJMP
12325                                              ? regnext((regnode *)next)
12326                                              : next);
12327                 if (last && nnode > last)
12328                     nnode = last;
12329                 DUMPUNTIL(NEXTOPER(NEXTOPER(node)), nnode);
12330             }
12331         }
12332         else if (PL_regkind[(U8)op] == BRANCH) {
12333             assert(next);
12334             DUMPUNTIL(NEXTOPER(node), next);
12335         }
12336         else if ( PL_regkind[(U8)op]  == TRIE ) {
12337             const regnode *this_trie = node;
12338             const char op = OP(node);
12339             const U32 n = ARG(node);
12340             const reg_ac_data * const ac = op>=AHOCORASICK ?
12341                (reg_ac_data *)ri->data->data[n] :
12342                NULL;
12343             const reg_trie_data * const trie =
12344                 (reg_trie_data*)ri->data->data[op<AHOCORASICK ? n : ac->trie];
12345 #ifdef DEBUGGING
12346             AV *const trie_words = MUTABLE_AV(ri->data->data[n + TRIE_WORDS_OFFSET]);
12347 #endif
12348             const regnode *nextbranch= NULL;
12349             I32 word_idx;
12350             sv_setpvs(sv, "");
12351             for (word_idx= 0; word_idx < (I32)trie->wordcount; word_idx++) {
12352                 SV ** const elem_ptr = av_fetch(trie_words,word_idx,0);
12353                 
12354                 PerlIO_printf(Perl_debug_log, "%*s%s ",
12355                    (int)(2*(indent+3)), "",
12356                     elem_ptr ? pv_pretty(sv, SvPV_nolen_const(*elem_ptr), SvCUR(*elem_ptr), 60,
12357                             PL_colors[0], PL_colors[1],
12358                             (SvUTF8(*elem_ptr) ? PERL_PV_ESCAPE_UNI : 0) |
12359                             PERL_PV_PRETTY_ELLIPSES    |
12360                             PERL_PV_PRETTY_LTGT
12361                             )
12362                             : "???"
12363                 );
12364                 if (trie->jump) {
12365                     U16 dist= trie->jump[word_idx+1];
12366                     PerlIO_printf(Perl_debug_log, "(%"UVuf")\n",
12367                                   (UV)((dist ? this_trie + dist : next) - start));
12368                     if (dist) {
12369                         if (!nextbranch)
12370                             nextbranch= this_trie + trie->jump[0];    
12371                         DUMPUNTIL(this_trie + dist, nextbranch);
12372                     }
12373                     if (nextbranch && PL_regkind[OP(nextbranch)]==BRANCH)
12374                         nextbranch= regnext((regnode *)nextbranch);
12375                 } else {
12376                     PerlIO_printf(Perl_debug_log, "\n");
12377                 }
12378             }
12379             if (last && next > last)
12380                 node= last;
12381             else
12382                 node= next;
12383         }
12384         else if ( op == CURLY ) {   /* "next" might be very big: optimizer */
12385             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS,
12386                     NEXTOPER(node) + EXTRA_STEP_2ARGS + 1);
12387         }
12388         else if (PL_regkind[(U8)op] == CURLY && op != CURLYX) {
12389             assert(next);
12390             DUMPUNTIL(NEXTOPER(node) + EXTRA_STEP_2ARGS, next);
12391         }
12392         else if ( op == PLUS || op == STAR) {
12393             DUMPUNTIL(NEXTOPER(node), NEXTOPER(node) + 1);
12394         }
12395         else if (PL_regkind[(U8)op] == ANYOF) {
12396             /* arglen 1 + class block */
12397             node += 1 + ((ANYOF_FLAGS(node) & ANYOF_CLASS)
12398                     ? ANYOF_CLASS_SKIP : ANYOF_SKIP);
12399             node = NEXTOPER(node);
12400         }
12401         else if (PL_regkind[(U8)op] == EXACT) {
12402             /* Literal string, where present. */
12403             node += NODE_SZ_STR(node) - 1;
12404             node = NEXTOPER(node);
12405         }
12406         else {
12407             node = NEXTOPER(node);
12408             node += regarglen[(U8)op];
12409         }
12410         if (op == CURLYX || op == OPEN)
12411             indent++;
12412     }
12413     CLEAR_OPTSTART;
12414 #ifdef DEBUG_DUMPUNTIL    
12415     PerlIO_printf(Perl_debug_log, "--- %d\n", (int)indent);
12416 #endif
12417     return node;
12418 }
12419
12420 #endif  /* DEBUGGING */
12421
12422 /*
12423  * Local variables:
12424  * c-indentation-style: bsd
12425  * c-basic-offset: 4
12426  * indent-tabs-mode: t
12427  * End:
12428  *
12429  * ex: set ts=8 sts=4 sw=4 noet:
12430  */